1 //===-- tsan_flags.cc -----------------------------------------------------===//
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 ThreadSanitizer (TSan), a race detector.
10 //===----------------------------------------------------------------------===//
12 #include "sanitizer_common/sanitizer_flags.h"
13 #include "sanitizer_common/sanitizer_libc.h"
14 #include "tsan_flags.h"
16 #include "tsan_mman.h"
24 // Can be overriden in frontend.
25 #ifdef TSAN_EXTERNAL_HOOKS
26 extern "C" const char* __tsan_default_options();
28 extern "C" SANITIZER_INTERFACE_ATTRIBUTE
29 const char *WEAK
__tsan_default_options() {
34 static void ParseFlags(Flags
*f
, const char *env
) {
35 ParseFlag(env
, &f
->enable_annotations
, "enable_annotations", "");
36 ParseFlag(env
, &f
->suppress_equal_stacks
, "suppress_equal_stacks", "");
37 ParseFlag(env
, &f
->suppress_equal_addresses
, "suppress_equal_addresses", "");
38 ParseFlag(env
, &f
->report_bugs
, "report_bugs", "");
39 ParseFlag(env
, &f
->report_thread_leaks
, "report_thread_leaks", "");
40 ParseFlag(env
, &f
->report_destroy_locked
, "report_destroy_locked", "");
41 ParseFlag(env
, &f
->report_mutex_bugs
, "report_mutex_bugs", "");
42 ParseFlag(env
, &f
->report_signal_unsafe
, "report_signal_unsafe", "");
43 ParseFlag(env
, &f
->report_atomic_races
, "report_atomic_races", "");
44 ParseFlag(env
, &f
->force_seq_cst_atomics
, "force_seq_cst_atomics", "");
45 ParseFlag(env
, &f
->print_benign
, "print_benign", "");
46 ParseFlag(env
, &f
->exitcode
, "exitcode", "");
47 ParseFlag(env
, &f
->halt_on_error
, "halt_on_error", "");
48 ParseFlag(env
, &f
->atexit_sleep_ms
, "atexit_sleep_ms", "");
49 ParseFlag(env
, &f
->profile_memory
, "profile_memory", "");
50 ParseFlag(env
, &f
->flush_memory_ms
, "flush_memory_ms", "");
51 ParseFlag(env
, &f
->flush_symbolizer_ms
, "flush_symbolizer_ms", "");
52 ParseFlag(env
, &f
->memory_limit_mb
, "memory_limit_mb", "");
53 ParseFlag(env
, &f
->stop_on_start
, "stop_on_start", "");
54 ParseFlag(env
, &f
->running_on_valgrind
, "running_on_valgrind", "");
55 ParseFlag(env
, &f
->history_size
, "history_size", "");
56 ParseFlag(env
, &f
->io_sync
, "io_sync", "");
57 ParseFlag(env
, &f
->die_after_fork
, "die_after_fork", "");
60 ParseFlag(env
, &f
->second_deadlock_stack
, "second_deadlock_stack", "");
63 void InitializeFlags(Flags
*f
, const char *env
) {
64 internal_memset(f
, 0, sizeof(*f
));
67 f
->enable_annotations
= true;
68 f
->suppress_equal_stacks
= true;
69 f
->suppress_equal_addresses
= true;
70 f
->report_bugs
= true;
71 f
->report_thread_leaks
= true;
72 f
->report_destroy_locked
= true;
73 f
->report_mutex_bugs
= true;
74 f
->report_signal_unsafe
= true;
75 f
->report_atomic_races
= true;
76 f
->force_seq_cst_atomics
= false;
77 f
->print_benign
= false;
79 f
->halt_on_error
= false;
80 f
->atexit_sleep_ms
= 1000;
81 f
->profile_memory
= "";
82 f
->flush_memory_ms
= 0;
83 f
->flush_symbolizer_ms
= 5000;
84 f
->memory_limit_mb
= 0;
85 f
->stop_on_start
= false;
86 f
->running_on_valgrind
= false;
87 f
->history_size
= kGoMode
? 1 : 2; // There are a lot of goroutines in Go.
89 f
->die_after_fork
= true;
92 f
->second_deadlock_stack
= false;
94 CommonFlags
*cf
= common_flags();
95 SetCommonFlagsDefaults(cf
);
96 // Override some common flags defaults.
97 cf
->allow_addr2line
= true;
98 cf
->detect_deadlocks
= true;
99 cf
->print_suppressions
= false;
100 cf
->stack_trace_format
= " #%n %f %S %M";
102 // Let a frontend override.
103 ParseFlags(f
, __tsan_default_options());
104 ParseCommonFlagsFromString(cf
, __tsan_default_options());
105 // Override from command line.
107 ParseCommonFlagsFromString(cf
, env
);
110 if (!f
->report_bugs
) {
111 f
->report_thread_leaks
= false;
112 f
->report_destroy_locked
= false;
113 f
->report_signal_unsafe
= false;
116 if (cf
->help
) PrintFlagDescriptions();
118 if (f
->history_size
< 0 || f
->history_size
> 7) {
119 Printf("ThreadSanitizer: incorrect value for history_size"
120 " (must be [0..7])\n");
124 if (f
->io_sync
< 0 || f
->io_sync
> 2) {
125 Printf("ThreadSanitizer: incorrect value for io_sync"
126 " (must be [0..2])\n");
131 } // namespace __tsan