blob: 098b9c7a17b7efa01b0dd7b8ba55db9aead599ad [file] [log] [blame]
//===-- SpecialCaseList.h - special case list for sanitizers ----*- C++ -*-===//
// 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 used to parse user-provided text files with
// "special case lists" for code sanitizers. Such files are used to
// define "ABI list" for DataFlowSanitizer and blacklists for another sanitizers
// like AddressSanitizer or UndefinedBehaviorSanitizer.
// Empty lines and lines starting with "#" are ignored. All the rest lines
// should have the form:
// section:wildcard_expression[=category]
// If category is not specified, it is assumed to be empty string.
// Definitions of "section" and "category" are sanitizer-specific. For example,
// sanitizer blacklists support sections "src", "fun" and "global".
// Wildcard expressions define, respectively, source files, functions or
// globals which shouldn't be instrumented.
// Examples of categories:
// "functional": used in DFSan to list functions with pure functional
// semantics.
// "init": used in ASan blacklist to disable initialization-order bugs
// detection for certain globals or source files.
// Full special case list file example:
// ---
// # Blacklisted items:
// fun:*_ZN4base6subtle*
// global:*global_with_bad_access_or_initialization*
// global:*global_with_initialization_issues*=init
// type:*Namespace::ClassName*=init
// # Functions with pure functional semantics:
// fun:cos=functional
// fun:sin=functional
// ---
// Note that the wild card is in fact an llvm::Regex, but * is automatically
// replaced with .*
// This is similar to the "ignore" feature of ThreadSanitizer.
#include "llvm/ADT/StringMap.h"
namespace llvm {
class MemoryBuffer;
class Regex;
class StringRef;
class SpecialCaseList {
/// Parses the special case list from a file. If Path is empty, returns
/// an empty special case list. On failure, returns 0 and writes an error
/// message to string.
static SpecialCaseList *create(const StringRef Path, std::string &Error);
/// Parses the special case list from a memory buffer. On failure, returns
/// 0 and writes an error message to string.
static SpecialCaseList *create(const MemoryBuffer *MB, std::string &Error);
/// Parses the special case list from a file. On failure, reports a fatal
/// error.
static SpecialCaseList *createOrDie(const StringRef Path);
/// Returns true, if special case list contains a line
/// \code
/// @Section:<E>=@Category
/// \endcode
/// and @Query satisfies a wildcard expression <E>.
bool inSection(const StringRef Section, const StringRef Query,
const StringRef Category = StringRef()) const;
SpecialCaseList(SpecialCaseList const &) LLVM_DELETED_FUNCTION;
SpecialCaseList &operator=(SpecialCaseList const &) LLVM_DELETED_FUNCTION;
struct Entry;
StringMap<StringMap<Entry> > Entries;
/// Parses just-constructed SpecialCaseList entries from a memory buffer.
bool parse(const MemoryBuffer *MB, std::string &Error);
} // namespace llvm