tsan_flags.cpp revision 360784 
1//===-- tsan_flags.cpp ----------------------------------------------------===//
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// This file is a part of ThreadSanitizer (TSan), a race detector.
10//
11//===----------------------------------------------------------------------===//
12
13#include "sanitizer_common/sanitizer_flags.h"
14#include "sanitizer_common/sanitizer_flag_parser.h"
15#include "sanitizer_common/sanitizer_libc.h"
16#include "tsan_flags.h"
17#include "tsan_rtl.h"
18#include "tsan_mman.h"
19#include "ubsan/ubsan_flags.h"
20
21namespace __tsan {
22
23// Can be overriden in frontend.
24#ifdef TSAN_EXTERNAL_HOOKS
25extern "C" const char* __tsan_default_options();
26#else
27SANITIZER_WEAK_DEFAULT_IMPL
28const char *__tsan_default_options() {
29  return "";
30}
31#endif
32
33void Flags::SetDefaults() {
34#define TSAN_FLAG(Type, Name, DefaultValue, Description) Name = DefaultValue;
35#include "tsan_flags.inc"
36#undef TSAN_FLAG
37  // DDFlags
38  second_deadlock_stack = false;
39}
40
41void RegisterTsanFlags(FlagParser *parser, Flags *f) {
42#define TSAN_FLAG(Type, Name, DefaultValue, Description) \
43  RegisterFlag(parser, #Name, Description, &f->Name);
44#include "tsan_flags.inc"
45#undef TSAN_FLAG
46  // DDFlags
47  RegisterFlag(parser, "second_deadlock_stack",
48      "Report where each mutex is locked in deadlock reports",
49      &f->second_deadlock_stack);
50}
51
52void InitializeFlags(Flags *f, const char *env, const char *env_option_name) {
53  SetCommonFlagsDefaults();
54  {
55    // Override some common flags defaults.
56    CommonFlags cf;
57    cf.CopyFrom(*common_flags());
58    cf.allow_addr2line = true;
59    if (SANITIZER_GO) {
60      // Does not work as expected for Go: runtime handles SIGABRT and crashes.
61      cf.abort_on_error = false;
62      // Go does not have mutexes.
63      cf.detect_deadlocks = false;
64    }
65    cf.print_suppressions = false;
66    cf.stack_trace_format = "    #%n %f %S %M";
67    cf.exitcode = 66;
68    cf.intercept_tls_get_addr = true;
69    OverrideCommonFlags(cf);
70  }
71
72  f->SetDefaults();
73
74  FlagParser parser;
75  RegisterTsanFlags(&parser, f);
76  RegisterCommonFlags(&parser);
77
78#if TSAN_CONTAINS_UBSAN
79  __ubsan::Flags *uf = __ubsan::flags();
80  uf->SetDefaults();
81
82  FlagParser ubsan_parser;
83  __ubsan::RegisterUbsanFlags(&ubsan_parser, uf);
84  RegisterCommonFlags(&ubsan_parser);
85#endif
86
87  // Let a frontend override.
88  parser.ParseString(__tsan_default_options());
89#if TSAN_CONTAINS_UBSAN
90  const char *ubsan_default_options = __ubsan::MaybeCallUbsanDefaultOptions();
91  ubsan_parser.ParseString(ubsan_default_options);
92#endif
93  // Override from command line.
94  parser.ParseString(env, env_option_name);
95#if TSAN_CONTAINS_UBSAN
96  ubsan_parser.ParseStringFromEnv("UBSAN_OPTIONS");
97#endif
98
99  // Sanity check.
100  if (!f->report_bugs) {
101    f->report_thread_leaks = false;
102    f->report_destroy_locked = false;
103    f->report_signal_unsafe = false;
104  }
105
106  InitializeCommonFlags();
107
108  if (Verbosity()) ReportUnrecognizedFlags();
109
110  if (common_flags()->help) parser.PrintFlagDescriptions();
111
112  if (f->history_size < 0 || f->history_size > 7) {
113    Printf("ThreadSanitizer: incorrect value for history_size"
114           " (must be [0..7])\n");
115    Die();
116  }
117
118  if (f->io_sync < 0 || f->io_sync > 2) {
119    Printf("ThreadSanitizer: incorrect value for io_sync"
120           " (must be [0..2])\n");
121    Die();
122  }
123}
124
125}  // namespace __tsan
126