lib/Support/SpecialCaseList.cpp

   1 //===-- SpecialCaseList.cpp - special case list for sanitizers ------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  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.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  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"
  25 #include <string>
  26 #include <system_error>
  27 #include <utility>
  28
  29 namespace llvm {
  30
  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 {
  37   StringSet<> Strings;
  38   Regex *RegEx;
  39
  40   Entry() : RegEx(nullptr) {}
  41
  42   bool match(StringRef Query) const {
  43     return Strings.count(Query) || (RegEx && RegEx->match(Query));
  44   }
  45 };
  46
  47 SpecialCaseList::SpecialCaseList() : Entries() {}
  48
  49 SpecialCaseList *SpecialCaseList::create(
  50     const StringRef Path, std::string &Error) {
  51   if (Path.empty())
  52     return new SpecialCaseList();
  53   ErrorOr<std::unique_ptr<MemoryBuffer>> FileOrErr =
  54       MemoryBuffer::getFile(Path);
  55   if (std::error_code EC = FileOrErr.getError()) {
  56     Error = (Twine("Can't open file '") + Path + "': " + EC.message()).str();
  57     return nullptr;
  58   }
  59   return create(FileOrErr.get().get(), Error);
  60 }
  61
  62 SpecialCaseList *SpecialCaseList::create(
  63     const MemoryBuffer *MB, std::string &Error) {
  64   std::unique_ptr<SpecialCaseList> SCL(new SpecialCaseList());
  65   if (!SCL->parse(MB, Error))
  66     return nullptr;
  67   return SCL.release();
  68 }
  69
  70 SpecialCaseList *SpecialCaseList::createOrDie(const StringRef Path) {
  71   std::string Error;
  72   if (SpecialCaseList *SCL = create(Path, Error))
  73     return SCL;
  74   report_fatal_error(Error);
  75 }
  76
  77 bool SpecialCaseList::parse(const MemoryBuffer *MB, std::string &Error) {
  78   // Iterate through each line in the blacklist file.
  79   SmallVector<StringRef, 16> Lines;
  80   SplitString(MB->getBuffer(), Lines, "\n\r");
  81   StringMap<StringMap<std::string> > Regexps;
  82   assert(Entries.empty() &&
  83          "parse() should be called on an empty SpecialCaseList");
  84   int LineNo = 1;
  85   for (SmallVectorImpl<StringRef>::iterator I = Lines.begin(), E = Lines.end();
  86        I != E; ++I, ++LineNo) {
  87     // Ignore empty lines and lines starting with "#"
  88     if (I->empty() || I->startswith("#"))
  89       continue;
  90     // Get our prefix and unparsed regexp.
  91     std::pair<StringRef, StringRef> SplitLine = I->split(":");
  92     StringRef Prefix = SplitLine.first;
  93     if (SplitLine.second.empty()) {
  94       // Missing ':' in the line.
  95       Error = (Twine("Malformed line ") + Twine(LineNo) + ": '" +
  96                SplitLine.first + "'").str();
  97       return false;
  98     }
  99
 100     std::pair<StringRef, StringRef> SplitRegexp = SplitLine.second.split("=");
 101     std::string Regexp = SplitRegexp.first;
 102     StringRef Category = SplitRegexp.second;
 103
 104     // Backwards compatibility.
 105     if (Prefix == "global-init") {
 106       Prefix = "global";
 107       Category = "init";
 108     } else if (Prefix == "global-init-type") {
 109       Prefix = "type";
 110       Category = "init";
 111     } else if (Prefix == "global-init-src") {
 112       Prefix = "src";
 113       Category = "init";
 114     }
 115
 116     // See if we can store Regexp in Strings.
 117     if (Regex::isLiteralERE(Regexp)) {
 118       Entries[Prefix][Category].Strings.insert(Regexp);
 119       continue;
 120     }
 121
 122     // Replace * with .*
 123     for (size_t pos = 0; (pos = Regexp.find("*", pos)) != std::string::npos;
 124          pos += strlen(".*")) {
 125       Regexp.replace(pos, strlen("*"), ".*");
 126     }
 127
 128     // Check that the regexp is valid.
 129     Regex CheckRE(Regexp);
 130     std::string REError;
 131     if (!CheckRE.isValid(REError)) {
 132       Error = (Twine("Malformed regex in line ") + Twine(LineNo) + ": '" +
 133                SplitLine.second + "': " + REError).str();
 134       return false;
 135     }
 136
 137     // Add this regexp into the proper group by its prefix.
 138     if (!Regexps[Prefix][Category].empty())
 139       Regexps[Prefix][Category] += "|";
 140     Regexps[Prefix][Category] += "^" + Regexp + "$";
 141   }
 142
 143   // Iterate through each of the prefixes, and create Regexs for them.
 144   for (StringMap<StringMap<std::string> >::const_iterator I = Regexps.begin(),
 145                                                           E = Regexps.end();
 146        I != E; ++I) {
 147     for (StringMap<std::string>::const_iterator II = I->second.begin(),
 148                                                 IE = I->second.end();
 149          II != IE; ++II) {
 150       Entries[I->getKey()][II->getKey()].RegEx = new Regex(II->getValue());
 151     }
 152   }
 153   return true;
 154 }
 155
 156 SpecialCaseList::~SpecialCaseList() {
 157   for (StringMap<StringMap<Entry> >::iterator I = Entries.begin(),
 158                                               E = Entries.end();
 159        I != E; ++I) {
 160     for (StringMap<Entry>::const_iterator II = I->second.begin(),
 161                                           IE = I->second.end();
 162          II != IE; ++II) {
 163       delete II->second.RegEx;
 164     }
 165   }
 166 }
 167
 168 bool SpecialCaseList::inSection(const StringRef Section, const StringRef Query,
 169                                 const StringRef Category) const {
 170   StringMap<StringMap<Entry> >::const_iterator I = Entries.find(Section);
 171   if (I == Entries.end()) return false;
 172   StringMap<Entry>::const_iterator II = I->second.find(Category);
 173   if (II == I->second.end()) return false;
 174
 175   return II->getValue().match(Query);
 176 }
 177
 178 }  // namespace llvm