lib/Transforms/Instrumentation/BlackList.h

   1 //===-- BlackList.h - blacklist 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 blacklist.
  12 //
  13 // The blacklist disables instrumentation of various functions and global
  14 // variables.  Each line contains a prefix, followed by a wild card expression.
  15 // Empty lines and lines starting with "#" are ignored.
  16 // ---
  17 // # Blacklisted items:
  18 // fun:*_ZN4base6subtle*
  19 // global:*global_with_bad_access_or_initialization*
  20 // global-init:*global_with_initialization_issues*
  21 // global-init-type:*Namespace::ClassName*
  22 // src:file_with_tricky_code.cc
  23 // ---
  24 // Note that the wild card is in fact an llvm::Regex, but * is automatically
  25 // replaced with .*
  26 // This is similar to the "ignore" feature of ThreadSanitizer.
  27 // http://code.google.com/p/data-race-test/wiki/ThreadSanitizerIgnores
  28 //
  29 //===----------------------------------------------------------------------===//
  30 //
  31
  32 #include "llvm/ADT/StringMap.h"
  33
  34 namespace llvm {
  35 class Function;
  36 class GlobalVariable;
  37 class Module;
  38 class Regex;
  39 class StringRef;
  40
  41 class BlackList {
  42  public:
  43   BlackList(const StringRef Path);
  44   // Returns whether either this function or it's source file are blacklisted.
  45   bool isIn(const Function &F);
  46   // Returns whether either this global or it's source file are blacklisted.
  47   bool isIn(const GlobalVariable &G);
  48   // Returns whether this module is blacklisted by filename.
  49   bool isIn(const Module &M);
  50   // Returns whether a global should be excluded from initialization checking.
  51   bool isInInit(const GlobalVariable &G);
  52  private:
  53   StringMap<Regex*> Entries;
  54
  55   bool inSection(const StringRef Section, const StringRef Query);
  56 };
  57
  58 }  // namespace llvm