1 //===-- asan_flags.inc ------------------------------------------*- 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 // ASan runtime flags.
12 //===----------------------------------------------------------------------===//
14 # error "Define ASAN_FLAG prior to including this file!"
17 // ASAN_FLAG(Type, Name, DefaultValue, Description)
18 // See COMMON_FLAG in sanitizer_flags.inc for more details.
20 ASAN_FLAG(int, quarantine_size, -1,
21 "Deprecated, please use quarantine_size_mb.")
22 ASAN_FLAG(int, quarantine_size_mb, -1,
23 "Size (in Mb) of quarantine used to detect use-after-free "
24 "errors. Lower value may reduce memory usage but increase the "
25 "chance of false negatives.")
26 ASAN_FLAG(int, thread_local_quarantine_size_kb, -1,
27 "Size (in Kb) of thread local quarantine used to detect "
28 "use-after-free errors. Lower value may reduce memory usage but "
29 "increase the chance of false negatives. It is not advised to go "
30 "lower than 64Kb, otherwise frequent transfers to global quarantine "
31 "might affect performance.")
32 ASAN_FLAG(int, redzone, 16,
33 "Minimal size (in bytes) of redzones around heap objects. "
34 "Requirement: redzone >= 16, is a power of two.")
35 ASAN_FLAG(int, max_redzone, 2048,
36 "Maximal size (in bytes) of redzones around heap objects.")
39 "If set, prints some debugging information and does additional checks.")
41 int, report_globals, 1,
42 "Controls the way to handle globals (0 - don't detect buffer overflow on "
43 "globals, 1 - detect buffer overflow, 2 - print data about registered "
45 ASAN_FLAG(bool, check_initialization_order, false,
46 "If set, attempts to catch initialization order issues.")
48 bool, replace_str, true,
49 "If set, uses custom wrappers and replacements for libc string functions "
50 "to find more errors.")
51 ASAN_FLAG(bool, replace_intrin, true,
52 "If set, uses custom wrappers for memset/memcpy/memmove intrinsics.")
53 ASAN_FLAG(bool, detect_stack_use_after_return, false,
54 "Enables stack-use-after-return checking at run-time.")
55 ASAN_FLAG(int, min_uar_stack_size_log, 16, // We can't do smaller anyway.
56 "Minimum fake stack size log.")
57 ASAN_FLAG(int, max_uar_stack_size_log,
58 20, // 1Mb per size class, i.e. ~11Mb per thread
59 "Maximum fake stack size log.")
60 ASAN_FLAG(bool, uar_noreserve, false,
61 "Use mmap with 'noreserve' flag to allocate fake stack.")
63 int, max_malloc_fill_size, 0x1000, // By default, fill only the first 4K.
64 "ASan allocator flag. max_malloc_fill_size is the maximal amount of "
65 "bytes that will be filled with malloc_fill_byte on malloc.")
67 int, max_free_fill_size, 0,
68 "ASan allocator flag. max_free_fill_size is the maximal amount of "
69 "bytes that will be filled with free_fill_byte during free.")
70 ASAN_FLAG(int, malloc_fill_byte, 0xbe,
71 "Value used to fill the newly allocated memory.")
72 ASAN_FLAG(int, free_fill_byte, 0x55,
73 "Value used to fill deallocated memory.")
74 ASAN_FLAG(bool, allow_user_poisoning, true,
75 "If set, user may manually mark memory regions as poisoned or "
78 int, sleep_before_dying, 0,
79 "Number of seconds to sleep between printing an error report and "
80 "terminating the program. Useful for debugging purposes (e.g. when one "
81 "needs to attach gdb).")
83 int, sleep_after_init, 0,
84 "Number of seconds to sleep after AddressSanitizer is initialized. "
85 "Useful for debugging purposes (e.g. when one needs to attach gdb).")
86 ASAN_FLAG(bool, check_malloc_usable_size, true,
87 "Allows the users to work around the bug in Nvidia drivers prior to "
89 ASAN_FLAG(bool, unmap_shadow_on_exit, false,
90 "If set, explicitly unmaps the (huge) shadow at exit.")
91 ASAN_FLAG(bool, protect_shadow_gap, !SANITIZER_RTEMS,
92 "If set, mprotect the shadow gap")
93 ASAN_FLAG(bool, print_stats, false,
94 "Print various statistics after printing an error message or if "
96 ASAN_FLAG(bool, print_legend, true, "Print the legend for the shadow bytes.")
97 ASAN_FLAG(bool, print_scariness, false,
98 "Print the scariness score. Experimental.")
99 ASAN_FLAG(bool, atexit, false,
100 "If set, prints ASan exit stats even after program terminates "
103 bool, print_full_thread_history, true,
104 "If set, prints thread creation stacks for the threads involved in the "
105 "report and their ancestors up to the main thread.")
107 bool, poison_heap, true,
108 "Poison (or not) the heap memory on [de]allocation. Zero value is useful "
109 "for benchmarking the allocator or instrumentator.")
110 ASAN_FLAG(bool, poison_partial, true,
111 "If true, poison partially addressable 8-byte aligned words "
112 "(default=true). This flag affects heap and global buffers, but not "
114 ASAN_FLAG(bool, poison_array_cookie, true,
115 "Poison (or not) the array cookie after operator new[].")
117 // Turn off alloc/dealloc mismatch checker on Mac and Windows for now.
118 // https://github.com/google/sanitizers/issues/131
119 // https://github.com/google/sanitizers/issues/309
120 // TODO(glider,timurrrr): Fix known issues and enable this back.
121 ASAN_FLAG(bool, alloc_dealloc_mismatch,
122 !SANITIZER_MAC && !SANITIZER_WINDOWS && !SANITIZER_ANDROID,
123 "Report errors on malloc/delete, new/free, new/delete[], etc.")
125 ASAN_FLAG(bool, new_delete_type_mismatch, true,
126 "Report errors on mismatch between size of new and delete.")
128 bool, strict_init_order, false,
129 "If true, assume that dynamic initializers can never access globals from "
130 "other modules, even if the latter are already initialized.")
132 bool, start_deactivated, false,
133 "If true, ASan tweaks a bunch of other flags (quarantine, redzone, heap "
134 "poisoning) to reduce memory consumption as much as possible, and "
135 "restores them to original values when the first instrumented module is "
136 "loaded into the process. This is mainly intended to be used on "
139 int, detect_invalid_pointer_pairs, 0,
140 "If >= 2, detect operations like <, <=, >, >= and - on invalid pointer "
141 "pairs (e.g. when pointers belong to different objects); "
142 "If == 1, detect invalid operations only when both pointers are non-null.")
144 bool, detect_container_overflow, true,
145 "If true, honor the container overflow annotations. See "
146 "https://github.com/google/sanitizers/wiki/AddressSanitizerContainerOverflow")
147 ASAN_FLAG(int, detect_odr_violation, 2,
148 "If >=2, detect violation of One-Definition-Rule (ODR); "
149 "If ==1, detect ODR-violation only if the two variables "
150 "have different sizes")
151 ASAN_FLAG(const char *, suppressions, "", "Suppressions file name.")
152 ASAN_FLAG(bool, halt_on_error, true,
153 "Crash the program after printing the first error report "
154 "(WARNING: USE AT YOUR OWN RISK!)")
155 ASAN_FLAG(bool, use_odr_indicator, false,
156 "Use special ODR indicator symbol for ODR violation detection")
157 ASAN_FLAG(bool, allocator_frees_and_returns_null_on_realloc_zero, true,
158 "realloc(p, 0) is equivalent to free(p) by default (Same as the "
159 "POSIX standard). If set to false, realloc(p, 0) will return a "
160 "pointer to an allocated space which can not be used.")
161 ASAN_FLAG(bool, verify_asan_link_order, true,
162 "Check position of ASan runtime in library list (needs to be disabled"
163 " when other library has to be preloaded system-wide)")