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