Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 1 | //===-- tsan_defs.h ---------------------------------------------*- C++ -*-===// |
| 2 | // |
| 3 | // The LLVM Compiler Infrastructure |
| 4 | // |
| 5 | // This file is distributed under the University of Illinois Open Source |
| 6 | // License. See LICENSE.TXT for details. |
| 7 | // |
| 8 | //===----------------------------------------------------------------------===// |
| 9 | // |
| 10 | // This file is a part of ThreadSanitizer (TSan), a race detector. |
| 11 | // |
| 12 | //===----------------------------------------------------------------------===// |
| 13 | |
| 14 | #ifndef TSAN_DEFS_H |
| 15 | #define TSAN_DEFS_H |
| 16 | |
Alexey Samsonov | 5bbf829 | 2012-06-05 14:25:27 +0000 | [diff] [blame] | 17 | #include "sanitizer_common/sanitizer_internal_defs.h" |
Alexey Samsonov | 91e1a7e | 2012-06-07 11:54:08 +0000 | [diff] [blame] | 18 | #include "sanitizer_common/sanitizer_libc.h" |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 19 | #include "tsan_stat.h" |
| 20 | |
| 21 | #ifndef TSAN_DEBUG |
| 22 | #define TSAN_DEBUG 0 |
| 23 | #endif // TSAN_DEBUG |
| 24 | |
Alexey Samsonov | ef2e2cf | 2012-06-05 13:50:57 +0000 | [diff] [blame] | 25 | namespace __tsan { |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 26 | |
Dmitry Vyukov | 9952b67 | 2012-11-08 11:32:40 +0000 | [diff] [blame] | 27 | #ifdef TSAN_GO |
Dmitry Vyukov | eb3d36e | 2012-11-28 13:01:32 +0000 | [diff] [blame] | 28 | const bool kGoMode = true; |
| 29 | const bool kCppMode = false; |
Dmitry Vyukov | 9952b67 | 2012-11-08 11:32:40 +0000 | [diff] [blame] | 30 | const char *const kTsanOptionsEnv = "GORACE"; |
Dmitry Vyukov | 087efd2 | 2013-01-30 14:38:44 +0000 | [diff] [blame] | 31 | // Go linker does not support weak symbols. |
| 32 | #define CPP_WEAK |
Dmitry Vyukov | 9952b67 | 2012-11-08 11:32:40 +0000 | [diff] [blame] | 33 | #else |
Dmitry Vyukov | eb3d36e | 2012-11-28 13:01:32 +0000 | [diff] [blame] | 34 | const bool kGoMode = false; |
| 35 | const bool kCppMode = true; |
Dmitry Vyukov | 9952b67 | 2012-11-08 11:32:40 +0000 | [diff] [blame] | 36 | const char *const kTsanOptionsEnv = "TSAN_OPTIONS"; |
Dmitry Vyukov | 087efd2 | 2013-01-30 14:38:44 +0000 | [diff] [blame] | 37 | #define CPP_WEAK WEAK |
Dmitry Vyukov | 9952b67 | 2012-11-08 11:32:40 +0000 | [diff] [blame] | 38 | #endif |
| 39 | |
Dmitry Vyukov | f6985e3 | 2012-05-22 14:34:43 +0000 | [diff] [blame] | 40 | const int kTidBits = 13; |
Kostya Serebryany | 07c4805 | 2012-05-11 14:42:24 +0000 | [diff] [blame] | 41 | const unsigned kMaxTid = 1 << kTidBits; |
Dmitry Vyukov | fee5b7d | 2012-05-17 14:17:51 +0000 | [diff] [blame] | 42 | const unsigned kMaxTidInClock = kMaxTid * 2; // This includes msb 'freed' bit. |
Dmitry Vyukov | ba42914 | 2013-02-01 09:42:06 +0000 | [diff] [blame] | 43 | const int kClkBits = 42; |
Dmitry Vyukov | b5eb8f0 | 2014-04-11 15:38:03 +0000 | [diff] [blame] | 44 | const unsigned kMaxTidReuse = (1 << (64 - kClkBits)) - 1; |
Dmitry Vyukov | 464ebbd | 2013-10-16 15:35:12 +0000 | [diff] [blame] | 45 | const uptr kShadowStackSize = 64 * 1024; |
| 46 | const uptr kTraceStackSize = 256; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 47 | |
| 48 | #ifdef TSAN_SHADOW_COUNT |
| 49 | # if TSAN_SHADOW_COUNT == 2 \ |
| 50 | || TSAN_SHADOW_COUNT == 4 || TSAN_SHADOW_COUNT == 8 |
Dmitry Vyukov | 1d4120b | 2012-11-06 13:21:06 +0000 | [diff] [blame] | 51 | const uptr kShadowCnt = TSAN_SHADOW_COUNT; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 52 | # else |
| 53 | # error "TSAN_SHADOW_COUNT must be one of 2,4,8" |
| 54 | # endif |
| 55 | #else |
| 56 | // Count of shadow values in a shadow cell. |
Dmitry Vyukov | f34db58 | 2012-11-15 18:44:22 +0000 | [diff] [blame] | 57 | const uptr kShadowCnt = 4; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 58 | #endif |
| 59 | |
| 60 | // That many user bytes are mapped onto a single shadow cell. |
Dmitry Vyukov | 1d4120b | 2012-11-06 13:21:06 +0000 | [diff] [blame] | 61 | const uptr kShadowCell = 8; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 62 | |
| 63 | // Size of a single shadow value (u64). |
Dmitry Vyukov | 1d4120b | 2012-11-06 13:21:06 +0000 | [diff] [blame] | 64 | const uptr kShadowSize = 8; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 65 | |
Dmitry Vyukov | c015712 | 2012-11-06 16:00:16 +0000 | [diff] [blame] | 66 | // Shadow memory is kShadowMultiplier times larger than user memory. |
| 67 | const uptr kShadowMultiplier = kShadowSize * kShadowCnt / kShadowCell; |
| 68 | |
Dmitry Vyukov | bde4c9c | 2014-05-29 13:50:54 +0000 | [diff] [blame^] | 69 | // That many user bytes are mapped onto a single meta shadow cell. |
| 70 | // Must be less or equal to minimal memory allocator alignment. |
| 71 | const uptr kMetaShadowCell = 8; |
| 72 | |
| 73 | // Size of a single meta shadow value (u32). |
| 74 | const uptr kMetaShadowSize = 4; |
| 75 | |
Dmitry Vyukov | 547089e | 2014-05-15 12:51:48 +0000 | [diff] [blame] | 76 | #if defined(TSAN_NO_HISTORY) && TSAN_NO_HISTORY |
| 77 | const bool kCollectHistory = false; |
| 78 | #else |
| 79 | const bool kCollectHistory = true; |
| 80 | #endif |
| 81 | |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 82 | #if defined(TSAN_COLLECT_STATS) && TSAN_COLLECT_STATS |
| 83 | const bool kCollectStats = true; |
| 84 | #else |
| 85 | const bool kCollectStats = false; |
| 86 | #endif |
| 87 | |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 88 | // The following "build consistency" machinery ensures that all source files |
| 89 | // are built in the same configuration. Inconsistent builds lead to |
| 90 | // hard to debug crashes. |
| 91 | #if TSAN_DEBUG |
| 92 | void build_consistency_debug(); |
| 93 | #else |
| 94 | void build_consistency_release(); |
| 95 | #endif |
| 96 | |
| 97 | #if TSAN_COLLECT_STATS |
| 98 | void build_consistency_stats(); |
| 99 | #else |
| 100 | void build_consistency_nostats(); |
| 101 | #endif |
| 102 | |
| 103 | #if TSAN_SHADOW_COUNT == 1 |
| 104 | void build_consistency_shadow1(); |
| 105 | #elif TSAN_SHADOW_COUNT == 2 |
| 106 | void build_consistency_shadow2(); |
| 107 | #elif TSAN_SHADOW_COUNT == 4 |
| 108 | void build_consistency_shadow4(); |
| 109 | #else |
| 110 | void build_consistency_shadow8(); |
| 111 | #endif |
| 112 | |
| 113 | static inline void USED build_consistency() { |
| 114 | #if TSAN_DEBUG |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 115 | build_consistency_debug(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 116 | #else |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 117 | build_consistency_release(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 118 | #endif |
| 119 | #if TSAN_COLLECT_STATS |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 120 | build_consistency_stats(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 121 | #else |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 122 | build_consistency_nostats(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 123 | #endif |
| 124 | #if TSAN_SHADOW_COUNT == 1 |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 125 | build_consistency_shadow1(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 126 | #elif TSAN_SHADOW_COUNT == 2 |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 127 | build_consistency_shadow2(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 128 | #elif TSAN_SHADOW_COUNT == 4 |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 129 | build_consistency_shadow4(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 130 | #else |
Dmitry Vyukov | 30c32a8 | 2012-05-24 14:50:33 +0000 | [diff] [blame] | 131 | build_consistency_shadow8(); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 132 | #endif |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 133 | } |
| 134 | |
| 135 | template<typename T> |
| 136 | T min(T a, T b) { |
| 137 | return a < b ? a : b; |
| 138 | } |
| 139 | |
| 140 | template<typename T> |
| 141 | T max(T a, T b) { |
| 142 | return a > b ? a : b; |
| 143 | } |
| 144 | |
| 145 | template<typename T> |
Dmitry Vyukov | 55b47ca | 2012-12-04 12:19:53 +0000 | [diff] [blame] | 146 | T RoundUp(T p, u64 align) { |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 147 | DCHECK_EQ(align & (align - 1), 0); |
| 148 | return (T)(((u64)p + align - 1) & ~(align - 1)); |
| 149 | } |
| 150 | |
Dmitry Vyukov | 55b47ca | 2012-12-04 12:19:53 +0000 | [diff] [blame] | 151 | template<typename T> |
| 152 | T RoundDown(T p, u64 align) { |
| 153 | DCHECK_EQ(align & (align - 1), 0); |
| 154 | return (T)((u64)p & ~(align - 1)); |
| 155 | } |
| 156 | |
Dmitry Vyukov | fd5ebcd | 2012-12-06 12:16:15 +0000 | [diff] [blame] | 157 | // Zeroizes high part, returns 'bits' lsb bits. |
| 158 | template<typename T> |
| 159 | T GetLsb(T v, int bits) { |
| 160 | return (T)((u64)v & ((1ull << bits) - 1)); |
| 161 | } |
| 162 | |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 163 | struct MD5Hash { |
| 164 | u64 hash[2]; |
Dmitry Vyukov | 03d32ec | 2012-07-05 16:18:28 +0000 | [diff] [blame] | 165 | bool operator==(const MD5Hash &other) const; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 166 | }; |
| 167 | |
| 168 | MD5Hash md5_hash(const void *data, uptr size); |
| 169 | |
| 170 | struct ThreadState; |
Dmitry Vyukov | 3238e1c | 2013-11-27 11:30:28 +0000 | [diff] [blame] | 171 | class ThreadContext; |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 172 | struct Context; |
| 173 | struct ReportStack; |
| 174 | class ReportDesc; |
| 175 | class RegionAlloc; |
| 176 | class StackTrace; |
Dmitry Vyukov | bde4c9c | 2014-05-29 13:50:54 +0000 | [diff] [blame^] | 177 | |
| 178 | // Descriptor of user's memory block. |
| 179 | struct MBlock { |
| 180 | u64 siz; |
| 181 | u32 stk; |
| 182 | u16 tid; |
| 183 | }; |
| 184 | |
| 185 | COMPILER_CHECK(sizeof(MBlock) == 16); |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 186 | |
| 187 | } // namespace __tsan |
| 188 | |
Kostya Serebryany | 4ad375f | 2012-05-10 13:48:04 +0000 | [diff] [blame] | 189 | #endif // TSAN_DEFS_H |