1 //===-- SpecialCaseList.cpp - special case list for sanitizers ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is a utility class for instrumentation passes (like AddressSanitizer
11 // or ThreadSanitizer) to avoid instrumenting some functions or global
12 // variables, or to instrument some functions or global variables in a specific
13 // way, based on a user-supplied list.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/Support/SpecialCaseList.h"
18 #include "llvm/ADT/STLExtras.h"
19 #include "llvm/ADT/SmallVector.h"
20 #include "llvm/ADT/StringExtras.h"
21 #include "llvm/ADT/StringSet.h"
22 #include "llvm/Support/MemoryBuffer.h"
23 #include "llvm/Support/Regex.h"
24 #include "llvm/Support/raw_ostream.h"
26 #include <system_error>
31 /// Represents a set of regular expressions. Regular expressions which are
32 /// "literal" (i.e. no regex metacharacters) are stored in Strings, while all
33 /// others are represented as a single pipe-separated regex in RegEx. The
34 /// reason for doing so is efficiency; StringSet is much faster at matching
35 /// literal strings than Regex.
36 struct SpecialCaseList::Entry {
39 : Strings(std::move(Other.Strings)), RegEx(std::move(Other.RegEx)) {}
42 std::unique_ptr<Regex> RegEx;
44 bool match(StringRef Query) const {
45 return Strings.count(Query) || (RegEx && RegEx->match(Query));
49 SpecialCaseList::SpecialCaseList() : Entries() {}
51 SpecialCaseList *SpecialCaseList::create(StringRef Path, std::string &Error) {
53 return new SpecialCaseList();
54 ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
55 MemoryBuffer::getFile(Path);
56 if (std::error_code EC = FileOrErr.getError()) {
57 Error = (Twine("Can't open file '") + Path + "': " + EC.message()).str();
60 return create(FileOrErr.get().get(), Error);
63 SpecialCaseList *SpecialCaseList::create(
64 const MemoryBuffer *MB, std::string &Error) {
65 std::unique_ptr<SpecialCaseList> SCL(new SpecialCaseList());
66 if (!SCL->parse(MB, Error))
71 SpecialCaseList *SpecialCaseList::createOrDie(StringRef Path) {
73 if (SpecialCaseList *SCL = create(Path, Error))
75 report_fatal_error(Error);
78 bool SpecialCaseList::parse(const MemoryBuffer *MB, std::string &Error) {
79 // Iterate through each line in the blacklist file.
80 SmallVector<StringRef, 16> Lines;
81 SplitString(MB->getBuffer(), Lines, "\n\r");
82 StringMap<StringMap<std::string> > Regexps;
83 assert(Entries.empty() &&
84 "parse() should be called on an empty SpecialCaseList");
86 for (SmallVectorImpl<StringRef>::iterator I = Lines.begin(), E = Lines.end();
87 I != E; ++I, ++LineNo) {
88 // Ignore empty lines and lines starting with "#"
89 if (I->empty() || I->startswith("#"))
91 // Get our prefix and unparsed regexp.
92 std::pair<StringRef, StringRef> SplitLine = I->split(":");
93 StringRef Prefix = SplitLine.first;
94 if (SplitLine.second.empty()) {
95 // Missing ':' in the line.
96 Error = (Twine("Malformed line ") + Twine(LineNo) + ": '" +
97 SplitLine.first + "'").str();
101 std::pair<StringRef, StringRef> SplitRegexp = SplitLine.second.split("=");
102 std::string Regexp = SplitRegexp.first;
103 StringRef Category = SplitRegexp.second;
105 // Backwards compatibility.
106 if (Prefix == "global-init") {
109 } else if (Prefix == "global-init-type") {
112 } else if (Prefix == "global-init-src") {
117 // See if we can store Regexp in Strings.
118 if (Regex::isLiteralERE(Regexp)) {
119 Entries[Prefix][Category].Strings.insert(Regexp);
124 for (size_t pos = 0; (pos = Regexp.find("*", pos)) != std::string::npos;
125 pos += strlen(".*")) {
126 Regexp.replace(pos, strlen("*"), ".*");
129 // Check that the regexp is valid.
130 Regex CheckRE(Regexp);
132 if (!CheckRE.isValid(REError)) {
133 Error = (Twine("Malformed regex in line ") + Twine(LineNo) + ": '" +
134 SplitLine.second + "': " + REError).str();
138 // Add this regexp into the proper group by its prefix.
139 if (!Regexps[Prefix][Category].empty())
140 Regexps[Prefix][Category] += "|";
141 Regexps[Prefix][Category] += "^" + Regexp + "$";
144 // Iterate through each of the prefixes, and create Regexs for them.
145 for (StringMap<StringMap<std::string> >::const_iterator I = Regexps.begin(),
148 for (StringMap<std::string>::const_iterator II = I->second.begin(),
149 IE = I->second.end();
151 Entries[I->getKey()][II->getKey()].RegEx.reset(new Regex(II->getValue()));
157 SpecialCaseList::~SpecialCaseList() {}
159 bool SpecialCaseList::inSection(StringRef Section, StringRef Query,
160 StringRef Category) const {
161 StringMap<StringMap<Entry> >::const_iterator I = Entries.find(Section);
162 if (I == Entries.end()) return false;
163 StringMap<Entry>::const_iterator II = I->second.find(Category);
164 if (II == I->second.end()) return false;
166 return II->getValue().match(Query);