1 //===--- Sanitizers.def - Runtime sanitizer options -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
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.
15 //===----------------------------------------------------------------------===//
18 #error "Define SANITIZER prior to including this file!"
21 // SANITIZER(NAME, ID)
23 // The first value is the name of the sanitizer as a string. The sanitizer can
24 // be enabled by specifying -fsanitize=NAME.
26 // The second value is an identifier which can be used to refer to the
30 // SANITIZER_GROUP(NAME, ID, ALIAS)
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.
36 #ifndef SANITIZER_GROUP
37 #define SANITIZER_GROUP(NAME, ID, ALIAS)
42 SANITIZER("address", Address)
44 // Kernel AddressSanitizer (KASan)
45 SANITIZER("kernel-address", KernelAddress)
48 SANITIZER("memory", Memory)
51 SANITIZER("fuzzer", Fuzzer)
54 SANITIZER("thread", Thread)
57 SANITIZER("leak", Leak)
59 // UndefinedBehaviorSanitizer
60 SANITIZER("alignment", Alignment)
61 SANITIZER("array-bounds", ArrayBounds)
62 SANITIZER("bool", Bool)
63 SANITIZER("enum", Enum)
64 SANITIZER("float-cast-overflow", FloatCastOverflow)
65 SANITIZER("float-divide-by-zero", FloatDivideByZero)
66 SANITIZER("function", Function)
67 SANITIZER("integer-divide-by-zero", IntegerDivideByZero)
68 SANITIZER("nonnull-attribute", NonnullAttribute)
69 SANITIZER("null", Null)
70 SANITIZER("nullability-arg", NullabilityArg)
71 SANITIZER("nullability-assign", NullabilityAssign)
72 SANITIZER("nullability-return", NullabilityReturn)
73 SANITIZER_GROUP("nullability", Nullability,
74 NullabilityArg | NullabilityAssign | NullabilityReturn)
75 SANITIZER("object-size", ObjectSize)
76 SANITIZER("pointer-overflow", PointerOverflow)
77 SANITIZER("return", Return)
78 SANITIZER("returns-nonnull-attribute", ReturnsNonnullAttribute)
79 SANITIZER("shift-base", ShiftBase)
80 SANITIZER("shift-exponent", ShiftExponent)
81 SANITIZER_GROUP("shift", Shift, ShiftBase | ShiftExponent)
82 SANITIZER("signed-integer-overflow", SignedIntegerOverflow)
83 SANITIZER("unreachable", Unreachable)
84 SANITIZER("vla-bound", VLABound)
85 SANITIZER("vptr", Vptr)
88 SANITIZER("unsigned-integer-overflow", UnsignedIntegerOverflow)
91 SANITIZER("dataflow", DataFlow)
93 // Control Flow Integrity
94 SANITIZER("cfi-cast-strict", CFICastStrict)
95 SANITIZER("cfi-derived-cast", CFIDerivedCast)
96 SANITIZER("cfi-icall", CFIICall)
97 SANITIZER("cfi-unrelated-cast", CFIUnrelatedCast)
98 SANITIZER("cfi-nvcall", CFINVCall)
99 SANITIZER("cfi-vcall", CFIVCall)
100 SANITIZER_GROUP("cfi", CFI,
101 CFIDerivedCast | CFIICall | CFIUnrelatedCast | CFINVCall |
105 SANITIZER("safe-stack", SafeStack)
107 // -fsanitize=undefined includes all the sanitizers which have low overhead, no
108 // ABI or address space layout implications, and only catch undefined behavior.
109 SANITIZER_GROUP("undefined", Undefined,
110 Alignment | Bool | ArrayBounds | Enum | FloatCastOverflow |
111 FloatDivideByZero | IntegerDivideByZero | NonnullAttribute |
112 Null | ObjectSize | PointerOverflow | Return |
113 ReturnsNonnullAttribute | Shift | SignedIntegerOverflow |
114 Unreachable | VLABound | Function | Vptr)
116 // -fsanitize=undefined-trap is an alias for -fsanitize=undefined.
117 SANITIZER_GROUP("undefined-trap", UndefinedTrap, Undefined)
119 SANITIZER_GROUP("integer", Integer,
120 SignedIntegerOverflow | UnsignedIntegerOverflow | Shift |
123 SANITIZER("local-bounds", LocalBounds)
124 SANITIZER_GROUP("bounds", Bounds, ArrayBounds | LocalBounds)
126 // EfficiencySanitizer
127 SANITIZER("efficiency-cache-frag", EfficiencyCacheFrag)
128 SANITIZER("efficiency-working-set", EfficiencyWorkingSet)
129 // Meta-group only used internally.
130 SANITIZER_GROUP("efficiency-all", Efficiency,
131 EfficiencyCacheFrag | EfficiencyWorkingSet)
133 // Magic group, containing all sanitizers. For example, "-fno-sanitize=all"
134 // can be used to disable all the sanitizers.
135 SANITIZER_GROUP("all", All, ~0ULL)
138 #undef SANITIZER_GROUP