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"
20 #include "ubsan/ubsan_platform.h"
22 // Setup defaults for compile definitions.
23 #ifndef TSAN_NO_HISTORY
24 # define TSAN_NO_HISTORY 0
27 #ifndef TSAN_COLLECT_STATS
28 # define TSAN_COLLECT_STATS 0
31 #ifndef TSAN_CONTAINS_UBSAN
32 # define TSAN_CONTAINS_UBSAN (CAN_SANITIZE_UB && !defined(SANITIZER_GO))
38 const bool kGoMode = true;
39 const bool kCppMode = false;
40 const char *const kTsanOptionsEnv = "GORACE";
42 const bool kGoMode = false;
43 const bool kCppMode = true;
44 const char *const kTsanOptionsEnv = "TSAN_OPTIONS";
47 const int kTidBits = 13;
48 const unsigned kMaxTid = 1 << kTidBits;
50 const unsigned kMaxTidInClock = kMaxTid * 2; // This includes msb 'freed' bit.
52 const unsigned kMaxTidInClock = kMaxTid; // Go does not track freed memory.
54 const int kClkBits = 42;
55 const unsigned kMaxTidReuse = (1 << (64 - kClkBits)) - 1;
56 const uptr kShadowStackSize = 64 * 1024;
58 // Count of shadow values in a shadow cell.
59 const uptr kShadowCnt = 4;
61 // That many user bytes are mapped onto a single shadow cell.
62 const uptr kShadowCell = 8;
64 // Size of a single shadow value (u64).
65 const uptr kShadowSize = 8;
67 // Shadow memory is kShadowMultiplier times larger than user memory.
68 const uptr kShadowMultiplier = kShadowSize * kShadowCnt / kShadowCell;
70 // That many user bytes are mapped onto a single meta shadow cell.
71 // Must be less or equal to minimal memory allocator alignment.
72 const uptr kMetaShadowCell = 8;
74 // Size of a single meta shadow value (u32).
75 const uptr kMetaShadowSize = 4;
78 const bool kCollectHistory = false;
80 const bool kCollectHistory = true;
83 const unsigned kInvalidTid = (unsigned)-1;
85 // The following "build consistency" machinery ensures that all source files
86 // are built in the same configuration. Inconsistent builds lead to
87 // hard to debug crashes.
89 void build_consistency_debug();
91 void build_consistency_release();
94 #if TSAN_COLLECT_STATS
95 void build_consistency_stats();
97 void build_consistency_nostats();
100 static inline void USED build_consistency() {
102 build_consistency_debug();
104 build_consistency_release();
106 #if TSAN_COLLECT_STATS
107 build_consistency_stats();
109 build_consistency_nostats();
115 return a < b ? a : b;
120 return a > b ? a : b;
124 T RoundUp(T p, u64 align) {
125 DCHECK_EQ(align & (align - 1), 0);
126 return (T)(((u64)p + align - 1) & ~(align - 1));
130 T RoundDown(T p, u64 align) {
131 DCHECK_EQ(align & (align - 1), 0);
132 return (T)((u64)p & ~(align - 1));
135 // Zeroizes high part, returns 'bits' lsb bits.
137 T GetLsb(T v, int bits) {
138 return (T)((u64)v & ((1ull << bits) - 1));
143 bool operator==(const MD5Hash &other) const;
146 MD5Hash md5_hash(const void *data, uptr size);
155 // Descriptor of user's memory block.
162 COMPILER_CHECK(sizeof(MBlock) == 16);
164 } // namespace __tsan
166 #endif // TSAN_DEFS_H