1 //===-- SpecialCaseList.h - special case list for sanitizers ----*- C++ -*-===// 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 // This is a utility class for instrumentation passes (like AddressSanitizer 10 // or ThreadSanitizer) to avoid instrumenting some functions or global 11 // variables based on a user-supplied list. 12 // 13 // The list can also specify categories for specific globals, which can be used 14 // to instruct an instrumentation pass to treat certain functions or global 15 // variables in a specific way, such as by omitting certain aspects of 16 // instrumentation while keeping others, or informing the instrumentation pass 17 // that a specific uninstrumentable function has certain semantics, thus 18 // allowing the pass to instrument callers according to those semantics. 19 // 20 // For example, AddressSanitizer uses the "init" category for globals whose 21 // initializers should not be instrumented, but which in all other respects 22 // should be instrumented. 23 // 24 // Each line contains a prefix, followed by a colon and a wild card expression, 25 // followed optionally by an equals sign and an instrumentation-specific 26 // category. Empty lines and lines starting with "#" are ignored. 27 // --- 28 // # Blacklisted items: 29 // fun:*_ZN4base6subtle* 30 // global:*global_with_bad_access_or_initialization* 31 // global:*global_with_initialization_issues*=init 32 // type:*Namespace::ClassName*=init 33 // src:file_with_tricky_code.cc 34 // src:ignore-global-initializers-issues.cc=init 35 // 36 // # Functions with pure functional semantics: 37 // fun:cos=functional 38 // fun:sin=functional 39 // --- 40 // Note that the wild card is in fact an llvm::Regex, but * is automatically 41 // replaced with .* 42 // This is similar to the "ignore" feature of ThreadSanitizer. 43 // http://code.google.com/p/data-race-test/wiki/ThreadSanitizerIgnores 44 // 45 //===----------------------------------------------------------------------===// 46 // 47 48 #include "llvm/ADT/StringMap.h" 49 50 namespace llvm { 51 class Function; 52 class GlobalVariable; 53 class MemoryBuffer; 54 class Module; 55 class Regex; 56 class StringRef; 57 58 class SpecialCaseList { 59 public: 60 SpecialCaseList(const StringRef Path); 61 SpecialCaseList(const MemoryBuffer *MB); 62 ~SpecialCaseList(); 63 64 /// Returns whether either this function or its source file are listed in the 65 /// given category, which may be omitted to search the empty category. 66 bool isIn(const Function &F, const StringRef Category = StringRef()) const; 67 68 /// Returns whether this global, its type or its source file are listed in the 69 /// given category, which may be omitted to search the empty category. 70 bool isIn(const GlobalVariable &G, 71 const StringRef Category = StringRef()) const; 72 73 /// Returns whether this module is listed in the given category, which may be 74 /// omitted to search the empty category. 75 bool isIn(const Module &M, const StringRef Category = StringRef()) const; 76 77 /// Returns whether either this function or its source file are listed in any 78 /// category. Category will contain the name of an arbitrary category in 79 /// which this function is listed. 80 bool findCategory(const Function &F, StringRef &Category) const; 81 82 /// Returns whether this global, its type or its source file are listed in any 83 /// category. Category will contain the name of an arbitrary category in 84 /// which this global is listed. 85 bool findCategory(const GlobalVariable &G, StringRef &Category) const; 86 87 /// Returns whether this module is listed in any category. Category will 88 /// contain the name of an arbitrary category in which this module is listed. 89 bool findCategory(const Module &M, StringRef &Category) const; 90 91 private: 92 struct Entry; 93 StringMap<StringMap<Entry> > Entries; 94 95 void init(const MemoryBuffer *MB); 96 bool findCategory(const StringRef Section, const StringRef Query, 97 StringRef &Category) const; 98 bool inSectionCategory(const StringRef Section, const StringRef Query, 99 const StringRef Category) const; 100 }; 101 102 } // namespace llvm 103