Home | History | Annotate | Download | only in Basic 
      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 // MemorySanitizer
     48 SANITIZER("memory", Memory)
     49 
     50 // libFuzzer
     51 SANITIZER("fuzzer", Fuzzer)
     52 
     53 // libFuzzer-required instrumentation, no linking.
     54 SANITIZER("fuzzer-no-link", FuzzerNoLink)
     55 
     56 // ThreadSanitizer
     57 SANITIZER("thread", Thread)
     58 
     59 // LeakSanitizer
     60 SANITIZER("leak", Leak)
     61 
     62 // UndefinedBehaviorSanitizer
     63 SANITIZER("alignment", Alignment)
     64 SANITIZER("array-bounds", ArrayBounds)
     65 SANITIZER("bool", Bool)
     66 SANITIZER("builtin", Builtin)
     67 SANITIZER("enum", Enum)
     68 SANITIZER("float-cast-overflow", FloatCastOverflow)
     69 SANITIZER("float-divide-by-zero", FloatDivideByZero)
     70 SANITIZER("function", Function)
     71 SANITIZER("integer-divide-by-zero", IntegerDivideByZero)
     72 SANITIZER("nonnull-attribute", NonnullAttribute)
     73 SANITIZER("null", Null)
     74 SANITIZER("nullability-arg", NullabilityArg)
     75 SANITIZER("nullability-assign", NullabilityAssign)
     76 SANITIZER("nullability-return", NullabilityReturn)
     77 SANITIZER_GROUP("nullability", Nullability,
     78                 NullabilityArg | NullabilityAssign | NullabilityReturn)
     79 SANITIZER("object-size", ObjectSize)
     80 SANITIZER("pointer-overflow", PointerOverflow)
     81 SANITIZER("return", Return)
     82 SANITIZER("returns-nonnull-attribute", ReturnsNonnullAttribute)
     83 SANITIZER("shift-base", ShiftBase)
     84 SANITIZER("shift-exponent", ShiftExponent)
     85 SANITIZER_GROUP("shift", Shift, ShiftBase | ShiftExponent)
     86 SANITIZER("signed-integer-overflow", SignedIntegerOverflow)
     87 SANITIZER("unreachable", Unreachable)
     88 SANITIZER("vla-bound", VLABound)
     89 SANITIZER("vptr", Vptr)
     90 
     91 // IntegerSanitizer
     92 SANITIZER("unsigned-integer-overflow", UnsignedIntegerOverflow)
     93 
     94 // DataFlowSanitizer
     95 SANITIZER("dataflow", DataFlow)
     96 
     97 // Control Flow Integrity
     98 SANITIZER("cfi-cast-strict", CFICastStrict)
     99 SANITIZER("cfi-derived-cast", CFIDerivedCast)
    100 SANITIZER("cfi-icall", CFIICall)
    101 SANITIZER("cfi-unrelated-cast", CFIUnrelatedCast)
    102 SANITIZER("cfi-nvcall", CFINVCall)
    103 SANITIZER("cfi-vcall", CFIVCall)
    104 SANITIZER_GROUP("cfi", CFI,
    105                 CFIDerivedCast | CFIICall | CFIUnrelatedCast | CFINVCall |
    106                 CFIVCall)
    107 
    108 // Safe Stack
    109 SANITIZER("safe-stack", SafeStack)
    110 
    111 // -fsanitize=undefined includes all the sanitizers which have low overhead, no
    112 // ABI or address space layout implications, and only catch undefined behavior.
    113 SANITIZER_GROUP("undefined", Undefined,
    114                 Alignment | Bool | Builtin | ArrayBounds | Enum |
    115                     FloatCastOverflow | FloatDivideByZero |
    116                     IntegerDivideByZero | NonnullAttribute | Null | ObjectSize |
    117                     PointerOverflow | Return | ReturnsNonnullAttribute | Shift |
    118                     SignedIntegerOverflow | Unreachable | VLABound | Function |
    119                     Vptr)
    120 
    121 // -fsanitize=undefined-trap is an alias for -fsanitize=undefined.
    122 SANITIZER_GROUP("undefined-trap", UndefinedTrap, Undefined)
    123 
    124 SANITIZER_GROUP("integer", Integer,
    125                 SignedIntegerOverflow | UnsignedIntegerOverflow | Shift |
    126                 IntegerDivideByZero)
    127 
    128 SANITIZER("local-bounds", LocalBounds)
    129 SANITIZER_GROUP("bounds", Bounds, ArrayBounds | LocalBounds)
    130 
    131 // EfficiencySanitizer
    132 SANITIZER("efficiency-cache-frag", EfficiencyCacheFrag)
    133 SANITIZER("efficiency-working-set", EfficiencyWorkingSet)
    134 // Meta-group only used internally.
    135 SANITIZER_GROUP("efficiency-all", Efficiency,
    136                 EfficiencyCacheFrag | EfficiencyWorkingSet)
    137 
    138 // Magic group, containing all sanitizers. For example, "-fno-sanitize=all"
    139 // can be used to disable all the sanitizers.
    140 SANITIZER_GROUP("all", All, ~0ULL)
    141 
    142 #undef SANITIZER
    143 #undef SANITIZER_GROUP
    144