blob: 0ee19e922652254f2414ce11c1cb3723cd87b85f [file] [log] [blame]
Kostya Serebryany4ad375f2012-05-10 13:48:04 +00001//===-- 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 Samsonov5bbf8292012-06-05 14:25:27 +000017#include "sanitizer_common/sanitizer_internal_defs.h"
Alexey Samsonov91e1a7e2012-06-07 11:54:08 +000018#include "sanitizer_common/sanitizer_libc.h"
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000019#include "tsan_stat.h"
20
21#ifndef TSAN_DEBUG
22#define TSAN_DEBUG 0
23#endif // TSAN_DEBUG
24
Alexey Samsonovef2e2cf2012-06-05 13:50:57 +000025namespace __tsan {
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000026
Dmitry Vyukov9952b672012-11-08 11:32:40 +000027#ifdef TSAN_GO
Dmitry Vyukoveb3d36e2012-11-28 13:01:32 +000028const bool kGoMode = true;
29const bool kCppMode = false;
Dmitry Vyukov9952b672012-11-08 11:32:40 +000030const char *const kTsanOptionsEnv = "GORACE";
Dmitry Vyukov087efd22013-01-30 14:38:44 +000031// Go linker does not support weak symbols.
32#define CPP_WEAK
Dmitry Vyukov9952b672012-11-08 11:32:40 +000033#else
Dmitry Vyukoveb3d36e2012-11-28 13:01:32 +000034const bool kGoMode = false;
35const bool kCppMode = true;
Dmitry Vyukov9952b672012-11-08 11:32:40 +000036const char *const kTsanOptionsEnv = "TSAN_OPTIONS";
Dmitry Vyukov087efd22013-01-30 14:38:44 +000037#define CPP_WEAK WEAK
Dmitry Vyukov9952b672012-11-08 11:32:40 +000038#endif
39
Dmitry Vyukovf6985e32012-05-22 14:34:43 +000040const int kTidBits = 13;
Kostya Serebryany07c48052012-05-11 14:42:24 +000041const unsigned kMaxTid = 1 << kTidBits;
Dmitry Vyukovfee5b7d2012-05-17 14:17:51 +000042const unsigned kMaxTidInClock = kMaxTid * 2; // This includes msb 'freed' bit.
Dmitry Vyukovba429142013-02-01 09:42:06 +000043const int kClkBits = 42;
Dmitry Vyukovb5eb8f02014-04-11 15:38:03 +000044const unsigned kMaxTidReuse = (1 << (64 - kClkBits)) - 1;
Dmitry Vyukov464ebbd2013-10-16 15:35:12 +000045const uptr kShadowStackSize = 64 * 1024;
46const uptr kTraceStackSize = 256;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000047
48#ifdef TSAN_SHADOW_COUNT
49# if TSAN_SHADOW_COUNT == 2 \
50 || TSAN_SHADOW_COUNT == 4 || TSAN_SHADOW_COUNT == 8
Dmitry Vyukov1d4120b2012-11-06 13:21:06 +000051const uptr kShadowCnt = TSAN_SHADOW_COUNT;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000052# 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 Vyukovf34db582012-11-15 18:44:22 +000057const uptr kShadowCnt = 4;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000058#endif
59
60// That many user bytes are mapped onto a single shadow cell.
Dmitry Vyukov1d4120b2012-11-06 13:21:06 +000061const uptr kShadowCell = 8;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000062
63// Size of a single shadow value (u64).
Dmitry Vyukov1d4120b2012-11-06 13:21:06 +000064const uptr kShadowSize = 8;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000065
Dmitry Vyukovc0157122012-11-06 16:00:16 +000066// Shadow memory is kShadowMultiplier times larger than user memory.
67const uptr kShadowMultiplier = kShadowSize * kShadowCnt / kShadowCell;
68
Dmitry Vyukov547089e2014-05-15 12:51:48 +000069#if defined(TSAN_NO_HISTORY) && TSAN_NO_HISTORY
70const bool kCollectHistory = false;
71#else
72const bool kCollectHistory = true;
73#endif
74
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000075#if defined(TSAN_COLLECT_STATS) && TSAN_COLLECT_STATS
76const bool kCollectStats = true;
77#else
78const bool kCollectStats = false;
79#endif
80
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000081// 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.
84#if TSAN_DEBUG
85void build_consistency_debug();
86#else
87void build_consistency_release();
88#endif
89
90#if TSAN_COLLECT_STATS
91void build_consistency_stats();
92#else
93void build_consistency_nostats();
94#endif
95
96#if TSAN_SHADOW_COUNT == 1
97void build_consistency_shadow1();
98#elif TSAN_SHADOW_COUNT == 2
99void build_consistency_shadow2();
100#elif TSAN_SHADOW_COUNT == 4
101void build_consistency_shadow4();
102#else
103void build_consistency_shadow8();
104#endif
105
106static inline void USED build_consistency() {
107#if TSAN_DEBUG
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000108 build_consistency_debug();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000109#else
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000110 build_consistency_release();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000111#endif
112#if TSAN_COLLECT_STATS
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000113 build_consistency_stats();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000114#else
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000115 build_consistency_nostats();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000116#endif
117#if TSAN_SHADOW_COUNT == 1
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000118 build_consistency_shadow1();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000119#elif TSAN_SHADOW_COUNT == 2
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000120 build_consistency_shadow2();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000121#elif TSAN_SHADOW_COUNT == 4
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000122 build_consistency_shadow4();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000123#else
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000124 build_consistency_shadow8();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000125#endif
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000126}
127
128template<typename T>
129T min(T a, T b) {
130 return a < b ? a : b;
131}
132
133template<typename T>
134T max(T a, T b) {
135 return a > b ? a : b;
136}
137
138template<typename T>
Dmitry Vyukov55b47ca2012-12-04 12:19:53 +0000139T RoundUp(T p, u64 align) {
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000140 DCHECK_EQ(align & (align - 1), 0);
141 return (T)(((u64)p + align - 1) & ~(align - 1));
142}
143
Dmitry Vyukov55b47ca2012-12-04 12:19:53 +0000144template<typename T>
145T RoundDown(T p, u64 align) {
146 DCHECK_EQ(align & (align - 1), 0);
147 return (T)((u64)p & ~(align - 1));
148}
149
Dmitry Vyukovfd5ebcd2012-12-06 12:16:15 +0000150// Zeroizes high part, returns 'bits' lsb bits.
151template<typename T>
152T GetLsb(T v, int bits) {
153 return (T)((u64)v & ((1ull << bits) - 1));
154}
155
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000156struct MD5Hash {
157 u64 hash[2];
Dmitry Vyukov03d32ec2012-07-05 16:18:28 +0000158 bool operator==(const MD5Hash &other) const;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000159};
160
161MD5Hash md5_hash(const void *data, uptr size);
162
163struct ThreadState;
Dmitry Vyukov3238e1c2013-11-27 11:30:28 +0000164class ThreadContext;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000165struct Context;
166struct ReportStack;
167class ReportDesc;
168class RegionAlloc;
169class StackTrace;
Dmitry Vyukov954fc8c2012-08-15 15:35:15 +0000170struct MBlock;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000171
172} // namespace __tsan
173
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000174#endif // TSAN_DEFS_H