libsanitizer/tsan/tsan_flags.cc

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