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