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