contrib/llvm/tools/clang/include/clang/Basic/Sanitizers.def

   1 //===--- Sanitizers.def - Runtime sanitizer options -------------*- 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 //
  10 // This file defines the options for specifying which runtime sanitizers to
  11 // enable. Users of this file must define the SANITIZER macro to make use of
  12 // this information. Users of this file can also define the SANITIZER_GROUP
  13 // macro to get information on options which refer to sets of sanitizers.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef SANITIZER
  18 #error "Define SANITIZER prior to including this file!"
  19 #endif
  20
  21 // SANITIZER(NAME, ID)
  22
  23 // The first value is the name of the sanitizer as a string. The sanitizer can
  24 // be enabled by specifying -fsanitize=NAME.
  25
  26 // The second value is an identifier which can be used to refer to the
  27 // sanitizer.
  28
  29
  30 // SANITIZER_GROUP(NAME, ID, ALIAS)
  31
  32 // The first two values have the same semantics as the corresponding SANITIZER
  33 // values. The third value is an expression ORing together the IDs of individual
  34 // sanitizers in this group.
  35
  36 #ifndef SANITIZER_GROUP
  37 #define SANITIZER_GROUP(NAME, ID, ALIAS)
  38 #endif
  39
  40
  41 // AddressSanitizer
  42 SANITIZER("address", Address)
  43
  44 // Kernel AddressSanitizer (KASan)
  45 SANITIZER("kernel-address", KernelAddress)
  46
  47 SANITIZER("hwaddress", HWAddress)
  48
  49 // MemorySanitizer
  50 SANITIZER("memory", Memory)
  51
  52 // libFuzzer
  53 SANITIZER("fuzzer", Fuzzer)
  54
  55 // libFuzzer-required instrumentation, no linking.
  56 SANITIZER("fuzzer-no-link", FuzzerNoLink)
  57
  58 // ThreadSanitizer
  59 SANITIZER("thread", Thread)
  60
  61 // LeakSanitizer
  62 SANITIZER("leak", Leak)
  63
  64 // UndefinedBehaviorSanitizer
  65 SANITIZER("alignment", Alignment)
  66 SANITIZER("array-bounds", ArrayBounds)
  67 SANITIZER("bool", Bool)
  68 SANITIZER("builtin", Builtin)
  69 SANITIZER("enum", Enum)
  70 SANITIZER("float-cast-overflow", FloatCastOverflow)
  71 SANITIZER("float-divide-by-zero", FloatDivideByZero)
  72 SANITIZER("function", Function)
  73 SANITIZER("integer-divide-by-zero", IntegerDivideByZero)
  74 SANITIZER("nonnull-attribute", NonnullAttribute)
  75 SANITIZER("null", Null)
  76 SANITIZER("nullability-arg", NullabilityArg)
  77 SANITIZER("nullability-assign", NullabilityAssign)
  78 SANITIZER("nullability-return", NullabilityReturn)
  79 SANITIZER_GROUP("nullability", Nullability,
  80                 NullabilityArg | NullabilityAssign | NullabilityReturn)
  81 SANITIZER("object-size", ObjectSize)
  82 SANITIZER("pointer-overflow", PointerOverflow)
  83 SANITIZER("return", Return)
  84 SANITIZER("returns-nonnull-attribute", ReturnsNonnullAttribute)
  85 SANITIZER("shift-base", ShiftBase)
  86 SANITIZER("shift-exponent", ShiftExponent)
  87 SANITIZER_GROUP("shift", Shift, ShiftBase | ShiftExponent)
  88 SANITIZER("signed-integer-overflow", SignedIntegerOverflow)
  89 SANITIZER("unreachable", Unreachable)
  90 SANITIZER("vla-bound", VLABound)
  91 SANITIZER("vptr", Vptr)
  92
  93 // IntegerSanitizer
  94 SANITIZER("unsigned-integer-overflow", UnsignedIntegerOverflow)
  95
  96 // DataFlowSanitizer
  97 SANITIZER("dataflow", DataFlow)
  98
  99 // Control Flow Integrity
 100 SANITIZER("cfi-cast-strict", CFICastStrict)
 101 SANITIZER("cfi-derived-cast", CFIDerivedCast)
 102 SANITIZER("cfi-icall", CFIICall)
 103 SANITIZER("cfi-unrelated-cast", CFIUnrelatedCast)
 104 SANITIZER("cfi-nvcall", CFINVCall)
 105 SANITIZER("cfi-vcall", CFIVCall)
 106 SANITIZER_GROUP("cfi", CFI,
 107                 CFIDerivedCast | CFIICall | CFIUnrelatedCast | CFINVCall |
 108                 CFIVCall)
 109
 110 // Safe Stack
 111 SANITIZER("safe-stack", SafeStack)
 112
 113 // -fsanitize=undefined includes all the sanitizers which have low overhead, no
 114 // ABI or address space layout implications, and only catch undefined behavior.
 115 SANITIZER_GROUP("undefined", Undefined,
 116                 Alignment | Bool | Builtin | ArrayBounds | Enum |
 117                     FloatCastOverflow | FloatDivideByZero |
 118                     IntegerDivideByZero | NonnullAttribute | Null | ObjectSize |
 119                     PointerOverflow | Return | ReturnsNonnullAttribute | Shift |
 120                     SignedIntegerOverflow | Unreachable | VLABound | Function |
 121                     Vptr)
 122
 123 // -fsanitize=undefined-trap is an alias for -fsanitize=undefined.
 124 SANITIZER_GROUP("undefined-trap", UndefinedTrap, Undefined)
 125
 126 SANITIZER_GROUP("integer", Integer,
 127                 SignedIntegerOverflow | UnsignedIntegerOverflow | Shift |
 128                 IntegerDivideByZero)
 129
 130 SANITIZER("local-bounds", LocalBounds)
 131 SANITIZER_GROUP("bounds", Bounds, ArrayBounds | LocalBounds)
 132
 133 // EfficiencySanitizer
 134 SANITIZER("efficiency-cache-frag", EfficiencyCacheFrag)
 135 SANITIZER("efficiency-working-set", EfficiencyWorkingSet)
 136 // Meta-group only used internally.
 137 SANITIZER_GROUP("efficiency-all", Efficiency,
 138                 EfficiencyCacheFrag | EfficiencyWorkingSet)
 139
 140 // Scudo hardened allocator
 141 SANITIZER("scudo", Scudo)
 142
 143 // Magic group, containing all sanitizers. For example, "-fno-sanitize=all"
 144 // can be used to disable all the sanitizers.
 145 SANITIZER_GROUP("all", All, ~0ULL)
 146
 147 #undef SANITIZER
 148 #undef SANITIZER_GROUP