1 //===-- tsan_defs.h ---------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file is a part of ThreadSanitizer (TSan), a race detector.
12 //===----------------------------------------------------------------------===//
17 #include "sanitizer_common/sanitizer_internal_defs.h"
18 #include "sanitizer_common/sanitizer_libc.h"
19 #include "tsan_stat.h"
21 // Setup defaults for compile definitions.
22 #ifndef TSAN_NO_HISTORY
23 # define TSAN_NO_HISTORY 0
26 #ifndef TSAN_COLLECT_STATS
27 # define TSAN_COLLECT_STATS 0
33 const bool kGoMode = true;
34 const bool kCppMode = false;
35 const char *const kTsanOptionsEnv = "GORACE";
36 // Go linker does not support weak symbols.
39 const bool kGoMode = false;
40 const bool kCppMode = true;
41 const char *const kTsanOptionsEnv = "TSAN_OPTIONS";
45 const int kTidBits = 13;
46 const unsigned kMaxTid = 1 << kTidBits;
48 const unsigned kMaxTidInClock = kMaxTid * 2; // This includes msb 'freed' bit.
50 const unsigned kMaxTidInClock = kMaxTid; // Go does not track freed memory.
52 const int kClkBits = 42;
53 const unsigned kMaxTidReuse = (1 << (64 - kClkBits)) - 1;
54 const uptr kShadowStackSize = 64 * 1024;
56 // Count of shadow values in a shadow cell.
57 const uptr kShadowCnt = 4;
59 // That many user bytes are mapped onto a single shadow cell.
60 const uptr kShadowCell = 8;
62 // Size of a single shadow value (u64).
63 const uptr kShadowSize = 8;
65 // Shadow memory is kShadowMultiplier times larger than user memory.
66 const uptr kShadowMultiplier = kShadowSize * kShadowCnt / kShadowCell;
68 // That many user bytes are mapped onto a single meta shadow cell.
69 // Must be less or equal to minimal memory allocator alignment.
70 const uptr kMetaShadowCell = 8;
72 // Size of a single meta shadow value (u32).
73 const uptr kMetaShadowSize = 4;
76 const bool kCollectHistory = false;
78 const bool kCollectHistory = true;
81 // The following "build consistency" machinery ensures that all source files
82 // are built in the same configuration. Inconsistent builds lead to
83 // hard to debug crashes.
85 void build_consistency_debug();
87 void build_consistency_release();
90 #if TSAN_COLLECT_STATS
91 void build_consistency_stats();
93 void build_consistency_nostats();
96 static inline void USED build_consistency() {
98 build_consistency_debug();
100 build_consistency_release();
102 #if TSAN_COLLECT_STATS
103 build_consistency_stats();
105 build_consistency_nostats();
111 return a < b ? a : b;
116 return a > b ? a : b;
120 T RoundUp(T p, u64 align) {
121 DCHECK_EQ(align & (align - 1), 0);
122 return (T)(((u64)p + align - 1) & ~(align - 1));
126 T RoundDown(T p, u64 align) {
127 DCHECK_EQ(align & (align - 1), 0);
128 return (T)((u64)p & ~(align - 1));
131 // Zeroizes high part, returns 'bits' lsb bits.
133 T GetLsb(T v, int bits) {
134 return (T)((u64)v & ((1ull << bits) - 1));
139 bool operator==(const MD5Hash &other) const;
142 MD5Hash md5_hash(const void *data, uptr size);
151 // Descriptor of user's memory block.
158 COMPILER_CHECK(sizeof(MBlock) == 16);
160 } // namespace __tsan
162 #endif // TSAN_DEFS_H