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 // MemorySanitizer
     45 SANITIZER("memory", Memory)
     46 
     47 // ThreadSanitizer
     48 SANITIZER("thread", Thread)
     49 
     50 // LeakSanitizer
     51 SANITIZER("leak", Leak)
     52 
     53 // UndefinedBehaviorSanitizer
     54 SANITIZER("alignment", Alignment)
     55 SANITIZER("array-bounds", ArrayBounds)
     56 SANITIZER("bool", Bool)
     57 SANITIZER("enum", Enum)
     58 SANITIZER("float-cast-overflow", FloatCastOverflow)
     59 SANITIZER("float-divide-by-zero", FloatDivideByZero)
     60 SANITIZER("function", Function)
     61 SANITIZER("integer-divide-by-zero", IntegerDivideByZero)
     62 SANITIZER("nonnull-attribute", NonnullAttribute)
     63 SANITIZER("null", Null)
     64 SANITIZER("object-size", ObjectSize)
     65 SANITIZER("return", Return)
     66 SANITIZER("returns-nonnull-attribute", ReturnsNonnullAttribute)
     67 SANITIZER("shift-base", ShiftBase)
     68 SANITIZER("shift-exponent", ShiftExponent)
     69 SANITIZER_GROUP("shift", Shift, ShiftBase | ShiftExponent)
     70 SANITIZER("signed-integer-overflow", SignedIntegerOverflow)
     71 SANITIZER("unreachable", Unreachable)
     72 SANITIZER("vla-bound", VLABound)
     73 SANITIZER("vptr", Vptr)
     74 
     75 // IntegerSanitizer
     76 SANITIZER("unsigned-integer-overflow", UnsignedIntegerOverflow)
     77 
     78 // DataFlowSanitizer
     79 SANITIZER("dataflow", DataFlow)
     80 
     81 // Control Flow Integrity
     82 SANITIZER("cfi-cast-strict", CFICastStrict)
     83 SANITIZER("cfi-derived-cast", CFIDerivedCast)
     84 SANITIZER("cfi-unrelated-cast", CFIUnrelatedCast)
     85 SANITIZER("cfi-nvcall", CFINVCall)
     86 SANITIZER("cfi-vcall", CFIVCall)
     87 SANITIZER_GROUP("cfi", CFI,
     88                 CFIDerivedCast | CFIUnrelatedCast | CFINVCall | CFIVCall)
     89 
     90 // -fsanitize=undefined-trap includes sanitizers from -fsanitize=undefined
     91 // that can be used without runtime support, generally by providing extra
     92 // -fsanitize-undefined-trap-on-error flag.
     93 SANITIZER_GROUP("undefined-trap", UndefinedTrap,
     94                 Alignment | Bool | ArrayBounds | Enum | FloatCastOverflow |
     95                     FloatDivideByZero | IntegerDivideByZero | NonnullAttribute |
     96                     Null | ObjectSize | Return | ReturnsNonnullAttribute |
     97                     Shift | SignedIntegerOverflow | Unreachable | VLABound)
     98 
     99 // -fsanitize=undefined includes all the sanitizers which have low overhead, no
    100 // ABI or address space layout implications, and only catch undefined behavior.
    101 SANITIZER_GROUP("undefined", Undefined, UndefinedTrap | Function | Vptr)
    102 
    103 SANITIZER_GROUP("integer", Integer,
    104                 SignedIntegerOverflow | UnsignedIntegerOverflow | Shift |
    105                 IntegerDivideByZero)
    106 
    107 SANITIZER("local-bounds", LocalBounds)
    108 SANITIZER_GROUP("bounds", Bounds, ArrayBounds | LocalBounds)
    109 
    110 // Magic group, containing all sanitizers. For example, "-fno-sanitize=all"
    111 // can be used to disable all the sanitizers.
    112 SANITIZER_GROUP("all", All, ~0ULL)
    113 
    114 #undef SANITIZER
    115 #undef SANITIZER_GROUP
    116