libsanitizer/tsan/tsan_defs.h

   1 //===-- tsan_defs.h ---------------------------------------------*- C++ -*-===//
   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 #ifndef TSAN_DEFS_H
  13 #define TSAN_DEFS_H
  14
  15 #include "sanitizer_common/sanitizer_internal_defs.h"
  16 #include "sanitizer_common/sanitizer_libc.h"
  17 #include "tsan_stat.h"
  18
  19 #ifndef TSAN_DEBUG
  20 #define TSAN_DEBUG 0
  21 #endif  // TSAN_DEBUG
  22
  23 namespace __tsan {
  24
  25 #ifdef TSAN_GO
  26 const bool kGoMode = true;
  27 const bool kCppMode = false;
  28 const char *const kTsanOptionsEnv = "GORACE";
  29 // Go linker does not support weak symbols.
  30 #define CPP_WEAK
  31 #else
  32 const bool kGoMode = false;
  33 const bool kCppMode = true;
  34 const char *const kTsanOptionsEnv = "TSAN_OPTIONS";
  35 #define CPP_WEAK WEAK
  36 #endif
  37
  38 const int kTidBits = 13;
  39 const unsigned kMaxTid = 1 << kTidBits;
  40 const unsigned kMaxTidInClock = kMaxTid * 2;  // This includes msb 'freed' bit.
  41 const int kClkBits = 42;
  42 const unsigned kMaxTidReuse = (1 << (64 - kClkBits)) - 1;
  43 const uptr kShadowStackSize = 64 * 1024;
  44 const uptr kTraceStackSize = 256;
  45
  46 #ifdef TSAN_SHADOW_COUNT
  47 # if TSAN_SHADOW_COUNT == 2 \
  48   || TSAN_SHADOW_COUNT == 4 || TSAN_SHADOW_COUNT == 8
  49 const uptr kShadowCnt = TSAN_SHADOW_COUNT;
  50 # else
  51 #   error "TSAN_SHADOW_COUNT must be one of 2,4,8"
  52 # endif
  53 #else
  54 // Count of shadow values in a shadow cell.
  55 const uptr kShadowCnt = 4;
  56 #endif
  57
  58 // That many user bytes are mapped onto a single shadow cell.
  59 const uptr kShadowCell = 8;
  60
  61 // Size of a single shadow value (u64).
  62 const uptr kShadowSize = 8;
  63
  64 // Shadow memory is kShadowMultiplier times larger than user memory.
  65 const uptr kShadowMultiplier = kShadowSize * kShadowCnt / kShadowCell;
  66
  67 #if defined(TSAN_NO_HISTORY) && TSAN_NO_HISTORY
  68 const bool kCollectHistory = false;
  69 #else
  70 const bool kCollectHistory = true;
  71 #endif
  72
  73 #if defined(TSAN_COLLECT_STATS) && TSAN_COLLECT_STATS
  74 const bool kCollectStats = true;
  75 #else
  76 const bool kCollectStats = false;
  77 #endif
  78
  79 // The following "build consistency" machinery ensures that all source files
  80 // are built in the same configuration. Inconsistent builds lead to
  81 // hard to debug crashes.
  82 #if TSAN_DEBUG
  83 void build_consistency_debug();
  84 #else
  85 void build_consistency_release();
  86 #endif
  87
  88 #if TSAN_COLLECT_STATS
  89 void build_consistency_stats();
  90 #else
  91 void build_consistency_nostats();
  92 #endif
  93
  94 #if TSAN_SHADOW_COUNT == 1
  95 void build_consistency_shadow1();
  96 #elif TSAN_SHADOW_COUNT == 2
  97 void build_consistency_shadow2();
  98 #elif TSAN_SHADOW_COUNT == 4
  99 void build_consistency_shadow4();
 100 #else
 101 void build_consistency_shadow8();
 102 #endif
 103
 104 static inline void USED build_consistency() {
 105 #if TSAN_DEBUG
 106   build_consistency_debug();
 107 #else
 108   build_consistency_release();
 109 #endif
 110 #if TSAN_COLLECT_STATS
 111   build_consistency_stats();
 112 #else
 113   build_consistency_nostats();
 114 #endif
 115 #if TSAN_SHADOW_COUNT == 1
 116   build_consistency_shadow1();
 117 #elif TSAN_SHADOW_COUNT == 2
 118   build_consistency_shadow2();
 119 #elif TSAN_SHADOW_COUNT == 4
 120   build_consistency_shadow4();
 121 #else
 122   build_consistency_shadow8();
 123 #endif
 124 }
 125
 126 template<typename T>
 127 T min(T a, T b) {
 128   return a < b ? a : b;
 129 }
 130
 131 template<typename T>
 132 T max(T a, T b) {
 133   return a > b ? a : b;
 134 }
 135
 136 template<typename T>
 137 T RoundUp(T p, u64 align) {
 138   DCHECK_EQ(align & (align - 1), 0);
 139   return (T)(((u64)p + align - 1) & ~(align - 1));
 140 }
 141
 142 template<typename T>
 143 T RoundDown(T p, u64 align) {
 144   DCHECK_EQ(align & (align - 1), 0);
 145   return (T)((u64)p & ~(align - 1));
 146 }
 147
 148 // Zeroizes high part, returns 'bits' lsb bits.
 149 template<typename T>
 150 T GetLsb(T v, int bits) {
 151   return (T)((u64)v & ((1ull << bits) - 1));
 152 }
 153
 154 struct MD5Hash {
 155   u64 hash[2];
 156   bool operator==(const MD5Hash &other) const;
 157 };
 158
 159 MD5Hash md5_hash(const void *data, uptr size);
 160
 161 struct ThreadState;
 162 class ThreadContext;
 163 struct Context;
 164 struct ReportStack;
 165 class ReportDesc;
 166 class RegionAlloc;
 167 class StackTrace;
 168 struct MBlock;
 169
 170 }  // namespace __tsan
 171
 172 #endif  // TSAN_DEFS_H