mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-09-04 09:30:13 +00:00
A special case list can now specify categories for specific globals, which can be used to instruct an instrumentation pass to treat certain functions or global variables in a specific way, such as by omitting certain aspects of instrumentation while keeping others, or informing the instrumentation pass that a specific uninstrumentable function has certain semantics, thus allowing the pass to instrument callers according to those semantics. For example, AddressSanitizer now uses the "init" category instead of global-init prefixes for globals whose initializers should not be instrumented, but which in all other respects should be instrumented. The motivating use case is DataFlowSanitizer, which will have a number of different categories for uninstrumentable functions, such as "functional" which specifies that a function has pure functional semantics, or "discard" which indicates that a function's return value should not be labelled. Differential Revision: http://llvm-reviews.chandlerc.com/D1092 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@185978 91177308-0d34-0410-b5e6-96231b3b80d8
201 lines
6.9 KiB
C++
201 lines
6.9 KiB
C++
//===-- SpecialCaseList.cpp - special case list for sanitizers ------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This is a utility class for instrumentation passes (like AddressSanitizer
|
|
// or ThreadSanitizer) to avoid instrumenting some functions or global
|
|
// variables, or to instrument some functions or global variables in a specific
|
|
// way, based on a user-supplied list.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/Transforms/Utils/SpecialCaseList.h"
|
|
#include "llvm/ADT/OwningPtr.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/STLExtras.h"
|
|
#include "llvm/ADT/StringExtras.h"
|
|
#include "llvm/IR/DerivedTypes.h"
|
|
#include "llvm/IR/Function.h"
|
|
#include "llvm/IR/GlobalVariable.h"
|
|
#include "llvm/IR/Module.h"
|
|
#include "llvm/Support/MemoryBuffer.h"
|
|
#include "llvm/Support/Regex.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
#include "llvm/Support/system_error.h"
|
|
#include <string>
|
|
#include <utility>
|
|
|
|
namespace llvm {
|
|
|
|
SpecialCaseList::SpecialCaseList(const StringRef Path) {
|
|
// Validate and open blacklist file.
|
|
if (Path.empty()) return;
|
|
OwningPtr<MemoryBuffer> File;
|
|
if (error_code EC = MemoryBuffer::getFile(Path, File)) {
|
|
report_fatal_error("Can't open blacklist file: " + Path + ": " +
|
|
EC.message());
|
|
}
|
|
|
|
init(File.get());
|
|
}
|
|
|
|
SpecialCaseList::SpecialCaseList(const MemoryBuffer *MB) {
|
|
init(MB);
|
|
}
|
|
|
|
void SpecialCaseList::init(const MemoryBuffer *MB) {
|
|
// Iterate through each line in the blacklist file.
|
|
SmallVector<StringRef, 16> Lines;
|
|
SplitString(MB->getBuffer(), Lines, "\n\r");
|
|
StringMap<StringMap<std::string> > Regexps;
|
|
for (SmallVectorImpl<StringRef>::iterator I = Lines.begin(), E = Lines.end();
|
|
I != E; ++I) {
|
|
// Ignore empty lines and lines starting with "#"
|
|
if (I->empty() || I->startswith("#"))
|
|
continue;
|
|
// Get our prefix and unparsed regexp.
|
|
std::pair<StringRef, StringRef> SplitLine = I->split(":");
|
|
StringRef Prefix = SplitLine.first;
|
|
if (SplitLine.second.empty()) {
|
|
// Missing ':' in the line.
|
|
report_fatal_error("malformed blacklist line: " + SplitLine.first);
|
|
}
|
|
|
|
std::pair<StringRef, StringRef> SplitRegexp = SplitLine.second.split("=");
|
|
std::string Regexp = SplitRegexp.first;
|
|
StringRef Category = SplitRegexp.second;
|
|
|
|
// Backwards compatibility.
|
|
if (Prefix == "global-init") {
|
|
Prefix = "global";
|
|
Category = "init";
|
|
} else if (Prefix == "global-init-type") {
|
|
Prefix = "type";
|
|
Category = "init";
|
|
} else if (Prefix == "global-init-src") {
|
|
Prefix = "src";
|
|
Category = "init";
|
|
}
|
|
|
|
// Replace * with .*
|
|
for (size_t pos = 0; (pos = Regexp.find("*", pos)) != std::string::npos;
|
|
pos += strlen(".*")) {
|
|
Regexp.replace(pos, strlen("*"), ".*");
|
|
}
|
|
|
|
// Check that the regexp is valid.
|
|
Regex CheckRE(Regexp);
|
|
std::string Error;
|
|
if (!CheckRE.isValid(Error)) {
|
|
report_fatal_error("malformed blacklist regex: " + SplitLine.second +
|
|
": " + Error);
|
|
}
|
|
|
|
// Add this regexp into the proper group by its prefix.
|
|
if (!Regexps[Prefix][Category].empty())
|
|
Regexps[Prefix][Category] += "|";
|
|
Regexps[Prefix][Category] += Regexp;
|
|
}
|
|
|
|
// Iterate through each of the prefixes, and create Regexs for them.
|
|
for (StringMap<StringMap<std::string> >::const_iterator I = Regexps.begin(),
|
|
E = Regexps.end();
|
|
I != E; ++I) {
|
|
for (StringMap<std::string>::const_iterator II = I->second.begin(),
|
|
IE = I->second.end();
|
|
II != IE; ++II) {
|
|
Entries[I->getKey()][II->getKey()] = new Regex(II->getValue());
|
|
}
|
|
}
|
|
}
|
|
|
|
SpecialCaseList::~SpecialCaseList() {
|
|
for (StringMap<StringMap<Regex*> >::iterator I = Entries.begin(),
|
|
E = Entries.end();
|
|
I != E; ++I) {
|
|
DeleteContainerSeconds(I->second);
|
|
}
|
|
}
|
|
|
|
bool SpecialCaseList::findCategory(const Function &F,
|
|
StringRef &Category) const {
|
|
return findCategory(*F.getParent(), Category) ||
|
|
findCategory("fun", F.getName(), Category);
|
|
}
|
|
|
|
bool SpecialCaseList::isIn(const Function& F, const StringRef Category) const {
|
|
return isIn(*F.getParent(), Category) ||
|
|
inSectionCategory("fun", F.getName(), Category);
|
|
}
|
|
|
|
static StringRef GetGVTypeString(const GlobalVariable &G) {
|
|
// Types of GlobalVariables are always pointer types.
|
|
Type *GType = G.getType()->getElementType();
|
|
// For now we support blacklisting struct types only.
|
|
if (StructType *SGType = dyn_cast<StructType>(GType)) {
|
|
if (!SGType->isLiteral())
|
|
return SGType->getName();
|
|
}
|
|
return "<unknown type>";
|
|
}
|
|
|
|
bool SpecialCaseList::findCategory(const GlobalVariable &G,
|
|
StringRef &Category) const {
|
|
return findCategory(*G.getParent(), Category) ||
|
|
findCategory("global", G.getName(), Category) ||
|
|
findCategory("type", GetGVTypeString(G), Category);
|
|
}
|
|
|
|
bool SpecialCaseList::isIn(const GlobalVariable &G,
|
|
const StringRef Category) const {
|
|
return isIn(*G.getParent(), Category) ||
|
|
inSectionCategory("global", G.getName(), Category) ||
|
|
inSectionCategory("type", GetGVTypeString(G), Category);
|
|
}
|
|
|
|
bool SpecialCaseList::findCategory(const Module &M, StringRef &Category) const {
|
|
return findCategory("src", M.getModuleIdentifier(), Category);
|
|
}
|
|
|
|
bool SpecialCaseList::isIn(const Module &M, const StringRef Category) const {
|
|
return inSectionCategory("src", M.getModuleIdentifier(), Category);
|
|
}
|
|
|
|
bool SpecialCaseList::findCategory(const StringRef Section,
|
|
const StringRef Query,
|
|
StringRef &Category) const {
|
|
StringMap<StringMap<Regex *> >::const_iterator I = Entries.find(Section);
|
|
if (I == Entries.end()) return false;
|
|
|
|
for (StringMap<Regex *>::const_iterator II = I->second.begin(),
|
|
IE = I->second.end();
|
|
II != IE; ++II) {
|
|
Regex *FunctionRegex = II->getValue();
|
|
if (FunctionRegex->match(Query)) {
|
|
Category = II->first();
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
bool SpecialCaseList::inSectionCategory(const StringRef Section,
|
|
const StringRef Query,
|
|
const StringRef Category) const {
|
|
StringMap<StringMap<Regex *> >::const_iterator I = Entries.find(Section);
|
|
if (I == Entries.end()) return false;
|
|
StringMap<Regex *>::const_iterator II = I->second.find(Category);
|
|
if (II == I->second.end()) return false;
|
|
|
|
Regex *FunctionRegex = II->getValue();
|
|
return FunctionRegex->match(Query);
|
|
}
|
|
|
|
} // namespace llvm
|