1 //===-- asan_flags.cc -------------------------------------------*- C++ -*-===//
3 // This file is distributed under the University of Illinois Open Source
4 // License. See LICENSE.TXT for details.
6 //===----------------------------------------------------------------------===//
8 // This file is a part of AddressSanitizer, an address sanity checker.
10 // ASan flag parsing logic.
11 //===----------------------------------------------------------------------===//
13 #include "asan_activation.h"
14 #include "asan_flags.h"
15 #include "asan_interface_internal.h"
16 #include "asan_stack.h"
17 #include "lsan/lsan_common.h"
18 #include "sanitizer_common/sanitizer_common.h"
19 #include "sanitizer_common/sanitizer_flags.h"
20 #include "sanitizer_common/sanitizer_flag_parser.h"
21 #include "ubsan/ubsan_flags.h"
22 #include "ubsan/ubsan_platform.h"
26 Flags asan_flags_dont_use_directly
; // use via flags().
28 static const char *MaybeCallAsanDefaultOptions() {
29 return (&__asan_default_options
) ? __asan_default_options() : "";
32 static const char *MaybeUseAsanDefaultOptionsCompileDefinition() {
33 #ifdef ASAN_DEFAULT_OPTIONS
34 // Stringize the macro value.
35 # define ASAN_STRINGIZE(x) #x
36 # define ASAN_STRINGIZE_OPTIONS(options) ASAN_STRINGIZE(options)
37 return ASAN_STRINGIZE_OPTIONS(ASAN_DEFAULT_OPTIONS
);
43 void Flags::SetDefaults() {
44 #define ASAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue;
45 #include "asan_flags.inc"
49 static void RegisterAsanFlags(FlagParser
*parser
, Flags
*f
) {
50 #define ASAN_FLAG(Type, Name, DefaultValue, Description) \
51 RegisterFlag(parser, #Name, Description, &f->Name);
52 #include "asan_flags.inc"
56 void InitializeFlags() {
57 // Set the default values and prepare for parsing ASan and common flags.
58 SetCommonFlagsDefaults();
61 cf
.CopyFrom(*common_flags());
62 cf
.detect_leaks
= CAN_SANITIZE_LEAKS
;
63 cf
.external_symbolizer_path
= GetEnv("ASAN_SYMBOLIZER_PATH");
64 cf
.malloc_context_size
= kDefaultMallocContextSize
;
65 cf
.intercept_tls_get_addr
= true;
67 OverrideCommonFlags(cf
);
72 FlagParser asan_parser
;
73 RegisterAsanFlags(&asan_parser
, f
);
74 RegisterCommonFlags(&asan_parser
);
76 // Set the default values and prepare for parsing LSan and UBSan flags
77 // (which can also overwrite common flags).
78 #if CAN_SANITIZE_LEAKS
79 __lsan::Flags
*lf
= __lsan::flags();
82 FlagParser lsan_parser
;
83 __lsan::RegisterLsanFlags(&lsan_parser
, lf
);
84 RegisterCommonFlags(&lsan_parser
);
88 __ubsan::Flags
*uf
= __ubsan::flags();
91 FlagParser ubsan_parser
;
92 __ubsan::RegisterUbsanFlags(&ubsan_parser
, uf
);
93 RegisterCommonFlags(&ubsan_parser
);
96 // Override from ASan compile definition.
97 const char *asan_compile_def
= MaybeUseAsanDefaultOptionsCompileDefinition();
98 asan_parser
.ParseString(asan_compile_def
);
100 // Override from user-specified string.
101 const char *asan_default_options
= MaybeCallAsanDefaultOptions();
102 asan_parser
.ParseString(asan_default_options
);
104 const char *ubsan_default_options
= __ubsan::MaybeCallUbsanDefaultOptions();
105 ubsan_parser
.ParseString(ubsan_default_options
);
108 // Override from command line.
109 asan_parser
.ParseString(GetEnv("ASAN_OPTIONS"));
110 #if CAN_SANITIZE_LEAKS
111 lsan_parser
.ParseString(GetEnv("LSAN_OPTIONS"));
114 ubsan_parser
.ParseString(GetEnv("UBSAN_OPTIONS"));
117 InitializeCommonFlags();
119 // TODO(eugenis): dump all flags at verbosity>=2?
120 if (Verbosity()) ReportUnrecognizedFlags();
122 if (common_flags()->help
) {
123 // TODO(samsonov): print all of the flags (ASan, LSan, common).
124 asan_parser
.PrintFlagDescriptions();
128 if (!CAN_SANITIZE_LEAKS
&& common_flags()->detect_leaks
) {
129 Report("%s: detect_leaks is not supported on this platform.\n",
133 // Make "strict_init_order" imply "check_initialization_order".
134 // TODO(samsonov): Use a single runtime flag for an init-order checker.
135 if (f
->strict_init_order
) {
136 f
->check_initialization_order
= true;
138 CHECK_LE((uptr
)common_flags()->malloc_context_size
, kStackTraceMax
);
139 CHECK_LE(f
->min_uar_stack_size_log
, f
->max_uar_stack_size_log
);
140 CHECK_GE(f
->redzone
, 16);
141 CHECK_GE(f
->max_redzone
, f
->redzone
);
142 CHECK_LE(f
->max_redzone
, 2048);
143 CHECK(IsPowerOfTwo(f
->redzone
));
144 CHECK(IsPowerOfTwo(f
->max_redzone
));
146 // quarantine_size is deprecated but we still honor it.
147 // quarantine_size can not be used together with quarantine_size_mb.
148 if (f
->quarantine_size
>= 0 && f
->quarantine_size_mb
>= 0) {
149 Report("%s: please use either 'quarantine_size' (deprecated) or "
150 "quarantine_size_mb, but not both\n", SanitizerToolName
);
153 if (f
->quarantine_size
>= 0)
154 f
->quarantine_size_mb
= f
->quarantine_size
>> 20;
155 if (f
->quarantine_size_mb
< 0) {
156 const int kDefaultQuarantineSizeMb
=
157 (ASAN_LOW_MEMORY
) ? 1UL << 6 : 1UL << 8;
158 f
->quarantine_size_mb
= kDefaultQuarantineSizeMb
;
160 if (!f
->replace_str
&& common_flags()->intercept_strlen
) {
161 Report("WARNING: strlen interceptor is enabled even though replace_str=0. "
162 "Use intercept_strlen=0 to disable it.");
164 if (!f
->replace_str
&& common_flags()->intercept_strchr
) {
165 Report("WARNING: strchr* interceptors are enabled even though "
166 "replace_str=0. Use intercept_strchr=0 to disable them.");
170 } // namespace __asan
172 #if !SANITIZER_SUPPORTS_WEAK_HOOKS
174 SANITIZER_INTERFACE_ATTRIBUTE SANITIZER_WEAK_ATTRIBUTE
175 const char* __asan_default_options() { return ""; }