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)
47 SANITIZER("hwaddress", HWAddress)
50 SANITIZER("memory", Memory)
53 SANITIZER("fuzzer", Fuzzer)
55 // libFuzzer-required instrumentation, no linking.
56 SANITIZER("fuzzer-no-link", FuzzerNoLink)
59 SANITIZER("thread", Thread)
62 SANITIZER("leak", Leak)
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)
94 SANITIZER("unsigned-integer-overflow", UnsignedIntegerOverflow)
97 SANITIZER("dataflow", DataFlow)
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 |
111 SANITIZER("safe-stack", SafeStack)
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 |
123 // -fsanitize=undefined-trap is an alias for -fsanitize=undefined.
124 SANITIZER_GROUP("undefined-trap", UndefinedTrap, Undefined)
126 SANITIZER_GROUP("integer", Integer,
127 SignedIntegerOverflow | UnsignedIntegerOverflow | Shift |
130 SANITIZER("local-bounds", LocalBounds)
131 SANITIZER_GROUP("bounds", Bounds, ArrayBounds | LocalBounds)
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)
140 // Scudo hardened allocator
141 SANITIZER("scudo", Scudo)
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)
148 #undef SANITIZER_GROUP