asan_flags.h revision b750c4c8af128bdd63543f3715f2c147fc3e95bf 
1//===-- asan_flags.h -------------------------------------------*- 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// This file is a part of AddressSanitizer, an address sanity checker.
11//
12// ASan runtime flags.
13//===----------------------------------------------------------------------===//
14
15#ifndef ASAN_FLAGS_H
16#define ASAN_FLAGS_H
17
18#include "sanitizer_common/sanitizer_interface_defs.h"
19
20// ASan flag values can be defined in three ways:
21// 1) initialized with default values at startup.
22// 2) overriden from string returned by user-specified function
23//    __asan_default_options().
24// 3) overriden from env variable ASAN_OPTIONS.
25
26extern "C" {
27// Can be overriden by user.
28const char *__asan_default_options() SANITIZER_WEAK_ATTRIBUTE;
29}  // extern "C"
30
31namespace __asan {
32
33struct Flags {
34  // Size (in bytes) of quarantine used to detect use-after-free errors.
35  // Lower value may reduce memory usage but increase the chance of
36  // false negatives.
37  int  quarantine_size;
38  // If set, uses in-process symbolizer from common sanitizer runtime.
39  bool symbolize;
40  // Verbosity level (0 - silent, 1 - a bit of output, 2+ - more output).
41  int  verbosity;
42  // Size (in bytes) of redzones around heap objects.
43  // Requirement: redzone >= 32, is a power of two.
44  int  redzone;
45  // If set, prints some debugging information and does additional checks.
46  bool debug;
47  // Controls the way to handle globals (0 - don't detect buffer overflow
48  // on globals, 1 - detect buffer overflow, 2 - print data about registered
49  // globals).
50  int  report_globals;
51  // Max number of stack frames kept for each allocation.
52  int  malloc_context_size;
53  // If set, uses custom wrappers and replacements for libc string functions
54  // to find more errors.
55  bool replace_str;
56  // If set, uses custom wrappers for memset/memcpy/memmove intinsics.
57  bool replace_intrin;
58  // Used on Mac only. See comments in asan_mac.cc and asan_malloc_mac.cc.
59  bool replace_cfallocator;
60  // Used on Mac only.
61  bool mac_ignore_invalid_free;
62  // ASan allocator flag. See asan_allocator.cc.
63  bool use_fake_stack;
64  // ASan allocator flag. Sets the maximal size of allocation request
65  // that would return memory filled with zero bytes.
66  int  max_malloc_fill_size;
67  // Override exit status if something was reported.
68  int  exitcode;
69  // If set, user may manually mark memory regions as poisoned or unpoisoned.
70  bool allow_user_poisoning;
71  // Number of seconds to sleep between printing an error report and
72  // terminating application. Useful for debug purposes (when one needs
73  // to attach gdb, for example).
74  int  sleep_before_dying;
75  // If set, registers ASan custom segv handler.
76  bool handle_segv;
77  // If set, uses alternate stack for signal handling.
78  bool use_sigaltstack;
79  // Allow the users to work around the bug in Nvidia drivers prior to 295.*.
80  bool check_malloc_usable_size;
81  // If set, explicitly unmaps (huge) shadow at exit.
82  bool unmap_shadow_on_exit;
83  // If set, calls abort() instead of _exit() after printing an error report.
84  bool abort_on_error;
85  // If set, prints ASan exit stats even after program terminates successfully.
86  bool atexit;
87  // By default, disable core dumper on 64-bit - it makes little sense
88  // to dump 16T+ core.
89  bool disable_core;
90};
91
92Flags *flags();
93void InitializeFlags(Flags *f, const char *env);
94
95}  // namespace __asan
96
97#endif  // ASAN_FLAGS_H
98