libsanitizer/asan/asan_flags.inc

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