blob: 13f7ece1c563b798025984dc97e2d23d23b53678 [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 Vyukov464ebbd2013-10-16 15:35:12 +000044const uptr kShadowStackSize = 64 * 1024;
45const uptr kTraceStackSize = 256;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000046
47#ifdef TSAN_SHADOW_COUNT
48# if TSAN_SHADOW_COUNT == 2 \
49 || TSAN_SHADOW_COUNT == 4 || TSAN_SHADOW_COUNT == 8
Dmitry Vyukov1d4120b2012-11-06 13:21:06 +000050const uptr kShadowCnt = TSAN_SHADOW_COUNT;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000051# 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.
Dmitry Vyukovf34db582012-11-15 18:44:22 +000056const uptr kShadowCnt = 4;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000057#endif
58
59// That many user bytes are mapped onto a single shadow cell.
Dmitry Vyukov1d4120b2012-11-06 13:21:06 +000060const uptr kShadowCell = 8;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000061
62// Size of a single shadow value (u64).
Dmitry Vyukov1d4120b2012-11-06 13:21:06 +000063const uptr kShadowSize = 8;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000064
Dmitry Vyukovc0157122012-11-06 16:00:16 +000065// Shadow memory is kShadowMultiplier times larger than user memory.
66const uptr kShadowMultiplier = kShadowSize * kShadowCnt / kShadowCell;
67
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000068#if defined(TSAN_COLLECT_STATS) && TSAN_COLLECT_STATS
69const bool kCollectStats = true;
70#else
71const bool kCollectStats = false;
72#endif
73
Kostya Serebryany4ad375f2012-05-10 13:48:04 +000074// 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
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000101 build_consistency_debug();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000102#else
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000103 build_consistency_release();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000104#endif
105#if TSAN_COLLECT_STATS
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000106 build_consistency_stats();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000107#else
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000108 build_consistency_nostats();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000109#endif
110#if TSAN_SHADOW_COUNT == 1
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000111 build_consistency_shadow1();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000112#elif TSAN_SHADOW_COUNT == 2
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000113 build_consistency_shadow2();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000114#elif TSAN_SHADOW_COUNT == 4
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000115 build_consistency_shadow4();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000116#else
Dmitry Vyukov30c32a82012-05-24 14:50:33 +0000117 build_consistency_shadow8();
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000118#endif
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000119}
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>
Dmitry Vyukov55b47ca2012-12-04 12:19:53 +0000132T RoundUp(T p, u64 align) {
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000133 DCHECK_EQ(align & (align - 1), 0);
134 return (T)(((u64)p + align - 1) & ~(align - 1));
135}
136
Dmitry Vyukov55b47ca2012-12-04 12:19:53 +0000137template<typename T>
138T RoundDown(T p, u64 align) {
139 DCHECK_EQ(align & (align - 1), 0);
140 return (T)((u64)p & ~(align - 1));
141}
142
Dmitry Vyukovfd5ebcd2012-12-06 12:16:15 +0000143// 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
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000149struct MD5Hash {
150 u64 hash[2];
Dmitry Vyukov03d32ec2012-07-05 16:18:28 +0000151 bool operator==(const MD5Hash &other) const;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000152};
153
154MD5Hash md5_hash(const void *data, uptr size);
155
156struct ThreadState;
Dmitry Vyukov3238e1c2013-11-27 11:30:28 +0000157class ThreadContext;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000158struct Context;
159struct ReportStack;
160class ReportDesc;
161class RegionAlloc;
162class StackTrace;
Dmitry Vyukov954fc8c2012-08-15 15:35:15 +0000163struct MBlock;
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000164
165} // namespace __tsan
166
Kostya Serebryany4ad375f2012-05-10 13:48:04 +0000167#endif // TSAN_DEFS_H