Home | History | Annotate | Line # | Download | only in tsan
tsan_rtl.h revision 1.1
      1  1.1  mrg //===-- tsan_rtl.h ----------------------------------------------*- C++ -*-===//
      2  1.1  mrg //
      3  1.1  mrg // This file is distributed under the University of Illinois Open Source
      4  1.1  mrg // License. See LICENSE.TXT for details.
      5  1.1  mrg //
      6  1.1  mrg //===----------------------------------------------------------------------===//
      7  1.1  mrg //
      8  1.1  mrg // This file is a part of ThreadSanitizer (TSan), a race detector.
      9  1.1  mrg //
     10  1.1  mrg // Main internal TSan header file.
     11  1.1  mrg //
     12  1.1  mrg // Ground rules:
     13  1.1  mrg //   - C++ run-time should not be used (static CTORs, RTTI, exceptions, static
     14  1.1  mrg //     function-scope locals)
     15  1.1  mrg //   - All functions/classes/etc reside in namespace __tsan, except for those
     16  1.1  mrg //     declared in tsan_interface.h.
     17  1.1  mrg //   - Platform-specific files should be used instead of ifdefs (*).
     18  1.1  mrg //   - No system headers included in header files (*).
     19  1.1  mrg //   - Platform specific headres included only into platform-specific files (*).
     20  1.1  mrg //
     21  1.1  mrg //  (*) Except when inlining is critical for performance.
     22  1.1  mrg //===----------------------------------------------------------------------===//
     23  1.1  mrg 
     24  1.1  mrg #ifndef TSAN_RTL_H
     25  1.1  mrg #define TSAN_RTL_H
     26  1.1  mrg 
     27  1.1  mrg #include "sanitizer_common/sanitizer_common.h"
     28  1.1  mrg #include "sanitizer_common/sanitizer_allocator.h"
     29  1.1  mrg #include "tsan_clock.h"
     30  1.1  mrg #include "tsan_defs.h"
     31  1.1  mrg #include "tsan_flags.h"
     32  1.1  mrg #include "tsan_sync.h"
     33  1.1  mrg #include "tsan_trace.h"
     34  1.1  mrg #include "tsan_vector.h"
     35  1.1  mrg #include "tsan_report.h"
     36  1.1  mrg #include "tsan_platform.h"
     37  1.1  mrg #include "tsan_mutexset.h"
     38  1.1  mrg 
     39  1.1  mrg #if SANITIZER_WORDSIZE != 64
     40  1.1  mrg # error "ThreadSanitizer is supported only on 64-bit platforms"
     41  1.1  mrg #endif
     42  1.1  mrg 
     43  1.1  mrg namespace __tsan {
     44  1.1  mrg 
     45  1.1  mrg // Descriptor of user's memory block.
     46  1.1  mrg struct MBlock {
     47  1.1  mrg   Mutex mtx;
     48  1.1  mrg   uptr size;
     49  1.1  mrg   u32 alloc_tid;
     50  1.1  mrg   u32 alloc_stack_id;
     51  1.1  mrg   SyncVar *head;
     52  1.1  mrg 
     53  1.1  mrg   MBlock()
     54  1.1  mrg     : mtx(MutexTypeMBlock, StatMtxMBlock) {
     55  1.1  mrg   }
     56  1.1  mrg };
     57  1.1  mrg 
     58  1.1  mrg #ifndef TSAN_GO
     59  1.1  mrg #if defined(TSAN_COMPAT_SHADOW) && TSAN_COMPAT_SHADOW
     60  1.1  mrg const uptr kAllocatorSpace = 0x7d0000000000ULL;
     61  1.1  mrg #else
     62  1.1  mrg const uptr kAllocatorSpace = 0x7d0000000000ULL;
     63  1.1  mrg #endif
     64  1.1  mrg const uptr kAllocatorSize  =  0x10000000000ULL;  // 1T.
     65  1.1  mrg 
     66  1.1  mrg struct TsanMapUnmapCallback {
     67  1.1  mrg   void OnMap(uptr p, uptr size) const { }
     68  1.1  mrg   void OnUnmap(uptr p, uptr size) const {
     69  1.1  mrg     // We are about to unmap a chunk of user memory.
     70  1.1  mrg     // Mark the corresponding shadow memory as not needed.
     71  1.1  mrg     uptr shadow_beg = MemToShadow(p);
     72  1.1  mrg     uptr shadow_end = MemToShadow(p + size);
     73  1.1  mrg     CHECK(IsAligned(shadow_end|shadow_beg, GetPageSizeCached()));
     74  1.1  mrg     FlushUnneededShadowMemory(shadow_beg, shadow_end - shadow_beg);
     75  1.1  mrg   }
     76  1.1  mrg };
     77  1.1  mrg 
     78  1.1  mrg typedef SizeClassAllocator64<kAllocatorSpace, kAllocatorSize, sizeof(MBlock),
     79  1.1  mrg     DefaultSizeClassMap> PrimaryAllocator;
     80  1.1  mrg typedef SizeClassAllocatorLocalCache<PrimaryAllocator> AllocatorCache;
     81  1.1  mrg typedef LargeMmapAllocator<TsanMapUnmapCallback> SecondaryAllocator;
     82  1.1  mrg typedef CombinedAllocator<PrimaryAllocator, AllocatorCache,
     83  1.1  mrg     SecondaryAllocator> Allocator;
     84  1.1  mrg Allocator *allocator();
     85  1.1  mrg #endif
     86  1.1  mrg 
     87  1.1  mrg void TsanCheckFailed(const char *file, int line, const char *cond,
     88  1.1  mrg                      u64 v1, u64 v2);
     89  1.1  mrg 
     90  1.1  mrg // FastState (from most significant bit):
     91  1.1  mrg //   ignore          : 1
     92  1.1  mrg //   tid             : kTidBits
     93  1.1  mrg //   epoch           : kClkBits
     94  1.1  mrg //   unused          : -
     95  1.1  mrg //   history_size    : 3
     96  1.1  mrg class FastState {
     97  1.1  mrg  public:
     98  1.1  mrg   FastState(u64 tid, u64 epoch) {
     99  1.1  mrg     x_ = tid << kTidShift;
    100  1.1  mrg     x_ |= epoch << kClkShift;
    101  1.1  mrg     DCHECK_EQ(tid, this->tid());
    102  1.1  mrg     DCHECK_EQ(epoch, this->epoch());
    103  1.1  mrg     DCHECK_EQ(GetIgnoreBit(), false);
    104  1.1  mrg   }
    105  1.1  mrg 
    106  1.1  mrg   explicit FastState(u64 x)
    107  1.1  mrg       : x_(x) {
    108  1.1  mrg   }
    109  1.1  mrg 
    110  1.1  mrg   u64 raw() const {
    111  1.1  mrg     return x_;
    112  1.1  mrg   }
    113  1.1  mrg 
    114  1.1  mrg   u64 tid() const {
    115  1.1  mrg     u64 res = (x_ & ~kIgnoreBit) >> kTidShift;
    116  1.1  mrg     return res;
    117  1.1  mrg   }
    118  1.1  mrg 
    119  1.1  mrg   u64 TidWithIgnore() const {
    120  1.1  mrg     u64 res = x_ >> kTidShift;
    121  1.1  mrg     return res;
    122  1.1  mrg   }
    123  1.1  mrg 
    124  1.1  mrg   u64 epoch() const {
    125  1.1  mrg     u64 res = (x_ << (kTidBits + 1)) >> (64 - kClkBits);
    126  1.1  mrg     return res;
    127  1.1  mrg   }
    128  1.1  mrg 
    129  1.1  mrg   void IncrementEpoch() {
    130  1.1  mrg     u64 old_epoch = epoch();
    131  1.1  mrg     x_ += 1 << kClkShift;
    132  1.1  mrg     DCHECK_EQ(old_epoch + 1, epoch());
    133  1.1  mrg     (void)old_epoch;
    134  1.1  mrg   }
    135  1.1  mrg 
    136  1.1  mrg   void SetIgnoreBit() { x_ |= kIgnoreBit; }
    137  1.1  mrg   void ClearIgnoreBit() { x_ &= ~kIgnoreBit; }
    138  1.1  mrg   bool GetIgnoreBit() const { return (s64)x_ < 0; }
    139  1.1  mrg 
    140  1.1  mrg   void SetHistorySize(int hs) {
    141  1.1  mrg     CHECK_GE(hs, 0);
    142  1.1  mrg     CHECK_LE(hs, 7);
    143  1.1  mrg     x_ = (x_ & ~7) | hs;
    144  1.1  mrg   }
    145  1.1  mrg 
    146  1.1  mrg   int GetHistorySize() const {
    147  1.1  mrg     return (int)(x_ & 7);
    148  1.1  mrg   }
    149  1.1  mrg 
    150  1.1  mrg   void ClearHistorySize() {
    151  1.1  mrg     x_ &= ~7;
    152  1.1  mrg   }
    153  1.1  mrg 
    154  1.1  mrg   u64 GetTracePos() const {
    155  1.1  mrg     const int hs = GetHistorySize();
    156  1.1  mrg     // When hs == 0, the trace consists of 2 parts.
    157  1.1  mrg     const u64 mask = (1ull << (kTracePartSizeBits + hs + 1)) - 1;
    158  1.1  mrg     return epoch() & mask;
    159  1.1  mrg   }
    160  1.1  mrg 
    161  1.1  mrg  private:
    162  1.1  mrg   friend class Shadow;
    163  1.1  mrg   static const int kTidShift = 64 - kTidBits - 1;
    164  1.1  mrg   static const int kClkShift = kTidShift - kClkBits;
    165  1.1  mrg   static const u64 kIgnoreBit = 1ull << 63;
    166  1.1  mrg   static const u64 kFreedBit = 1ull << 63;
    167  1.1  mrg   u64 x_;
    168  1.1  mrg };
    169  1.1  mrg 
    170  1.1  mrg // Shadow (from most significant bit):
    171  1.1  mrg //   freed           : 1
    172  1.1  mrg //   tid             : kTidBits
    173  1.1  mrg //   epoch           : kClkBits
    174  1.1  mrg //   is_atomic       : 1
    175  1.1  mrg //   is_read         : 1
    176  1.1  mrg //   size_log        : 2
    177  1.1  mrg //   addr0           : 3
    178  1.1  mrg class Shadow : public FastState {
    179  1.1  mrg  public:
    180  1.1  mrg   explicit Shadow(u64 x)
    181  1.1  mrg       : FastState(x) {
    182  1.1  mrg   }
    183  1.1  mrg 
    184  1.1  mrg   explicit Shadow(const FastState &s)
    185  1.1  mrg       : FastState(s.x_) {
    186  1.1  mrg     ClearHistorySize();
    187  1.1  mrg   }
    188  1.1  mrg 
    189  1.1  mrg   void SetAddr0AndSizeLog(u64 addr0, unsigned kAccessSizeLog) {
    190  1.1  mrg     DCHECK_EQ(x_ & 31, 0);
    191  1.1  mrg     DCHECK_LE(addr0, 7);
    192  1.1  mrg     DCHECK_LE(kAccessSizeLog, 3);
    193  1.1  mrg     x_ |= (kAccessSizeLog << 3) | addr0;
    194  1.1  mrg     DCHECK_EQ(kAccessSizeLog, size_log());
    195  1.1  mrg     DCHECK_EQ(addr0, this->addr0());
    196  1.1  mrg   }
    197  1.1  mrg 
    198  1.1  mrg   void SetWrite(unsigned kAccessIsWrite) {
    199  1.1  mrg     DCHECK_EQ(x_ & kReadBit, 0);
    200  1.1  mrg     if (!kAccessIsWrite)
    201  1.1  mrg       x_ |= kReadBit;
    202  1.1  mrg     DCHECK_EQ(kAccessIsWrite, IsWrite());
    203  1.1  mrg   }
    204  1.1  mrg 
    205  1.1  mrg   void SetAtomic(bool kIsAtomic) {
    206  1.1  mrg     DCHECK(!IsAtomic());
    207  1.1  mrg     if (kIsAtomic)
    208  1.1  mrg       x_ |= kAtomicBit;
    209  1.1  mrg     DCHECK_EQ(IsAtomic(), kIsAtomic);
    210  1.1  mrg   }
    211  1.1  mrg 
    212  1.1  mrg   bool IsAtomic() const {
    213  1.1  mrg     return x_ & kAtomicBit;
    214  1.1  mrg   }
    215  1.1  mrg 
    216  1.1  mrg   bool IsZero() const {
    217  1.1  mrg     return x_ == 0;
    218  1.1  mrg   }
    219  1.1  mrg 
    220  1.1  mrg   static inline bool TidsAreEqual(const Shadow s1, const Shadow s2) {
    221  1.1  mrg     u64 shifted_xor = (s1.x_ ^ s2.x_) >> kTidShift;
    222  1.1  mrg     DCHECK_EQ(shifted_xor == 0, s1.TidWithIgnore() == s2.TidWithIgnore());
    223  1.1  mrg     return shifted_xor == 0;
    224  1.1  mrg   }
    225  1.1  mrg 
    226  1.1  mrg   static inline bool Addr0AndSizeAreEqual(const Shadow s1, const Shadow s2) {
    227  1.1  mrg     u64 masked_xor = (s1.x_ ^ s2.x_) & 31;
    228  1.1  mrg     return masked_xor == 0;
    229  1.1  mrg   }
    230  1.1  mrg 
    231  1.1  mrg   static inline bool TwoRangesIntersect(Shadow s1, Shadow s2,
    232  1.1  mrg       unsigned kS2AccessSize) {
    233  1.1  mrg     bool res = false;
    234  1.1  mrg     u64 diff = s1.addr0() - s2.addr0();
    235  1.1  mrg     if ((s64)diff < 0) {  // s1.addr0 < s2.addr0  // NOLINT
    236  1.1  mrg       // if (s1.addr0() + size1) > s2.addr0()) return true;
    237  1.1  mrg       if (s1.size() > -diff)  res = true;
    238  1.1  mrg     } else {
    239  1.1  mrg       // if (s2.addr0() + kS2AccessSize > s1.addr0()) return true;
    240  1.1  mrg       if (kS2AccessSize > diff) res = true;
    241  1.1  mrg     }
    242  1.1  mrg     DCHECK_EQ(res, TwoRangesIntersectSLOW(s1, s2));
    243  1.1  mrg     DCHECK_EQ(res, TwoRangesIntersectSLOW(s2, s1));
    244  1.1  mrg     return res;
    245  1.1  mrg   }
    246  1.1  mrg 
    247  1.1  mrg   // The idea behind the offset is as follows.
    248  1.1  mrg   // Consider that we have 8 bool's contained within a single 8-byte block
    249  1.1  mrg   // (mapped to a single shadow "cell"). Now consider that we write to the bools
    250  1.1  mrg   // from a single thread (which we consider the common case).
    251  1.1  mrg   // W/o offsetting each access will have to scan 4 shadow values at average
    252  1.1  mrg   // to find the corresponding shadow value for the bool.
    253  1.1  mrg   // With offsetting we start scanning shadow with the offset so that
    254  1.1  mrg   // each access hits necessary shadow straight off (at least in an expected
    255  1.1  mrg   // optimistic case).
    256  1.1  mrg   // This logic works seamlessly for any layout of user data. For example,
    257  1.1  mrg   // if user data is {int, short, char, char}, then accesses to the int are
    258  1.1  mrg   // offsetted to 0, short - 4, 1st char - 6, 2nd char - 7. Hopefully, accesses
    259  1.1  mrg   // from a single thread won't need to scan all 8 shadow values.
    260  1.1  mrg   unsigned ComputeSearchOffset() {
    261  1.1  mrg     return x_ & 7;
    262  1.1  mrg   }
    263  1.1  mrg   u64 addr0() const { return x_ & 7; }
    264  1.1  mrg   u64 size() const { return 1ull << size_log(); }
    265  1.1  mrg   bool IsWrite() const { return !IsRead(); }
    266  1.1  mrg   bool IsRead() const { return x_ & kReadBit; }
    267  1.1  mrg 
    268  1.1  mrg   // The idea behind the freed bit is as follows.
    269  1.1  mrg   // When the memory is freed (or otherwise unaccessible) we write to the shadow
    270  1.1  mrg   // values with tid/epoch related to the free and the freed bit set.
    271  1.1  mrg   // During memory accesses processing the freed bit is considered
    272  1.1  mrg   // as msb of tid. So any access races with shadow with freed bit set
    273  1.1  mrg   // (it is as if write from a thread with which we never synchronized before).
    274  1.1  mrg   // This allows us to detect accesses to freed memory w/o additional
    275  1.1  mrg   // overheads in memory access processing and at the same time restore
    276  1.1  mrg   // tid/epoch of free.
    277  1.1  mrg   void MarkAsFreed() {
    278  1.1  mrg      x_ |= kFreedBit;
    279  1.1  mrg   }
    280  1.1  mrg 
    281  1.1  mrg   bool IsFreed() const {
    282  1.1  mrg     return x_ & kFreedBit;
    283  1.1  mrg   }
    284  1.1  mrg 
    285  1.1  mrg   bool GetFreedAndReset() {
    286  1.1  mrg     bool res = x_ & kFreedBit;
    287  1.1  mrg     x_ &= ~kFreedBit;
    288  1.1  mrg     return res;
    289  1.1  mrg   }
    290  1.1  mrg 
    291  1.1  mrg   bool IsBothReadsOrAtomic(bool kIsWrite, bool kIsAtomic) const {
    292  1.1  mrg     // analyzes 5-th bit (is_read) and 6-th bit (is_atomic)
    293  1.1  mrg     bool v = x_ & u64(((kIsWrite ^ 1) << kReadShift)
    294  1.1  mrg         | (kIsAtomic << kAtomicShift));
    295  1.1  mrg     DCHECK_EQ(v, (!IsWrite() && !kIsWrite) || (IsAtomic() && kIsAtomic));
    296  1.1  mrg     return v;
    297  1.1  mrg   }
    298  1.1  mrg 
    299  1.1  mrg   bool IsRWNotWeaker(bool kIsWrite, bool kIsAtomic) const {
    300  1.1  mrg     bool v = ((x_ >> kReadShift) & 3)
    301  1.1  mrg         <= u64((kIsWrite ^ 1) | (kIsAtomic << 1));
    302  1.1  mrg     DCHECK_EQ(v, (IsAtomic() < kIsAtomic) ||
    303  1.1  mrg         (IsAtomic() == kIsAtomic && !IsWrite() <= !kIsWrite));
    304  1.1  mrg     return v;
    305  1.1  mrg   }
    306  1.1  mrg 
    307  1.1  mrg   bool IsRWWeakerOrEqual(bool kIsWrite, bool kIsAtomic) const {
    308  1.1  mrg     bool v = ((x_ >> kReadShift) & 3)
    309  1.1  mrg         >= u64((kIsWrite ^ 1) | (kIsAtomic << 1));
    310  1.1  mrg     DCHECK_EQ(v, (IsAtomic() > kIsAtomic) ||
    311  1.1  mrg         (IsAtomic() == kIsAtomic && !IsWrite() >= !kIsWrite));
    312  1.1  mrg     return v;
    313  1.1  mrg   }
    314  1.1  mrg 
    315  1.1  mrg  private:
    316  1.1  mrg   static const u64 kReadShift   = 5;
    317  1.1  mrg   static const u64 kReadBit     = 1ull << kReadShift;
    318  1.1  mrg   static const u64 kAtomicShift = 6;
    319  1.1  mrg   static const u64 kAtomicBit   = 1ull << kAtomicShift;
    320  1.1  mrg 
    321  1.1  mrg   u64 size_log() const { return (x_ >> 3) & 3; }
    322  1.1  mrg 
    323  1.1  mrg   static bool TwoRangesIntersectSLOW(const Shadow s1, const Shadow s2) {
    324  1.1  mrg     if (s1.addr0() == s2.addr0()) return true;
    325  1.1  mrg     if (s1.addr0() < s2.addr0() && s1.addr0() + s1.size() > s2.addr0())
    326  1.1  mrg       return true;
    327  1.1  mrg     if (s2.addr0() < s1.addr0() && s2.addr0() + s2.size() > s1.addr0())
    328  1.1  mrg       return true;
    329  1.1  mrg     return false;
    330  1.1  mrg   }
    331  1.1  mrg };
    332  1.1  mrg 
    333  1.1  mrg struct SignalContext;
    334  1.1  mrg 
    335  1.1  mrg // This struct is stored in TLS.
    336  1.1  mrg struct ThreadState {
    337  1.1  mrg   FastState fast_state;
    338  1.1  mrg   // Synch epoch represents the threads's epoch before the last synchronization
    339  1.1  mrg   // action. It allows to reduce number of shadow state updates.
    340  1.1  mrg   // For example, fast_synch_epoch=100, last write to addr X was at epoch=150,
    341  1.1  mrg   // if we are processing write to X from the same thread at epoch=200,
    342  1.1  mrg   // we do nothing, because both writes happen in the same 'synch epoch'.
    343  1.1  mrg   // That is, if another memory access does not race with the former write,
    344  1.1  mrg   // it does not race with the latter as well.
    345  1.1  mrg   // QUESTION: can we can squeeze this into ThreadState::Fast?
    346  1.1  mrg   // E.g. ThreadState::Fast is a 44-bit, 32 are taken by synch_epoch and 12 are
    347  1.1  mrg   // taken by epoch between synchs.
    348  1.1  mrg   // This way we can save one load from tls.
    349  1.1  mrg   u64 fast_synch_epoch;
    350  1.1  mrg   // This is a slow path flag. On fast path, fast_state.GetIgnoreBit() is read.
    351  1.1  mrg   // We do not distinguish beteween ignoring reads and writes
    352  1.1  mrg   // for better performance.
    353  1.1  mrg   int ignore_reads_and_writes;
    354  1.1  mrg   uptr *shadow_stack_pos;
    355  1.1  mrg   u64 *racy_shadow_addr;
    356  1.1  mrg   u64 racy_state[2];
    357  1.1  mrg   Trace trace;
    358  1.1  mrg #ifndef TSAN_GO
    359  1.1  mrg   // C/C++ uses embed shadow stack of fixed size.
    360  1.1  mrg   uptr shadow_stack[kShadowStackSize];
    361  1.1  mrg #else
    362  1.1  mrg   // Go uses satellite shadow stack with dynamic size.
    363  1.1  mrg   uptr *shadow_stack;
    364  1.1  mrg   uptr *shadow_stack_end;
    365  1.1  mrg #endif
    366  1.1  mrg   MutexSet mset;
    367  1.1  mrg   ThreadClock clock;
    368  1.1  mrg #ifndef TSAN_GO
    369  1.1  mrg   AllocatorCache alloc_cache;
    370  1.1  mrg #endif
    371  1.1  mrg   u64 stat[StatCnt];
    372  1.1  mrg   const int tid;
    373  1.1  mrg   const int unique_id;
    374  1.1  mrg   int in_rtl;
    375  1.1  mrg   bool in_symbolizer;
    376  1.1  mrg   bool is_alive;
    377  1.1  mrg   bool is_freeing;
    378  1.1  mrg   const uptr stk_addr;
    379  1.1  mrg   const uptr stk_size;
    380  1.1  mrg   const uptr tls_addr;
    381  1.1  mrg   const uptr tls_size;
    382  1.1  mrg 
    383  1.1  mrg   DeadlockDetector deadlock_detector;
    384  1.1  mrg 
    385  1.1  mrg   bool in_signal_handler;
    386  1.1  mrg   SignalContext *signal_ctx;
    387  1.1  mrg 
    388  1.1  mrg #ifndef TSAN_GO
    389  1.1  mrg   u32 last_sleep_stack_id;
    390  1.1  mrg   ThreadClock last_sleep_clock;
    391  1.1  mrg #endif
    392  1.1  mrg 
    393  1.1  mrg   // Set in regions of runtime that must be signal-safe and fork-safe.
    394  1.1  mrg   // If set, malloc must not be called.
    395  1.1  mrg   int nomalloc;
    396  1.1  mrg 
    397  1.1  mrg   explicit ThreadState(Context *ctx, int tid, int unique_id, u64 epoch,
    398  1.1  mrg                        uptr stk_addr, uptr stk_size,
    399  1.1  mrg                        uptr tls_addr, uptr tls_size);
    400  1.1  mrg };
    401  1.1  mrg 
    402  1.1  mrg Context *CTX();
    403  1.1  mrg 
    404  1.1  mrg #ifndef TSAN_GO
    405  1.1  mrg extern THREADLOCAL char cur_thread_placeholder[];
    406  1.1  mrg INLINE ThreadState *cur_thread() {
    407  1.1  mrg   return reinterpret_cast<ThreadState *>(&cur_thread_placeholder);
    408  1.1  mrg }
    409  1.1  mrg #endif
    410  1.1  mrg 
    411  1.1  mrg enum ThreadStatus {
    412  1.1  mrg   ThreadStatusInvalid,   // Non-existent thread, data is invalid.
    413  1.1  mrg   ThreadStatusCreated,   // Created but not yet running.
    414  1.1  mrg   ThreadStatusRunning,   // The thread is currently running.
    415  1.1  mrg   ThreadStatusFinished,  // Joinable thread is finished but not yet joined.
    416  1.1  mrg   ThreadStatusDead       // Joined, but some info (trace) is still alive.
    417  1.1  mrg };
    418  1.1  mrg 
    419  1.1  mrg // An info about a thread that is hold for some time after its termination.
    420  1.1  mrg struct ThreadDeadInfo {
    421  1.1  mrg   Trace trace;
    422  1.1  mrg };
    423  1.1  mrg 
    424  1.1  mrg struct ThreadContext {
    425  1.1  mrg   const int tid;
    426  1.1  mrg   int unique_id;  // Non-rolling thread id.
    427  1.1  mrg   uptr os_id;  // pid
    428  1.1  mrg   uptr user_id;  // Some opaque user thread id (e.g. pthread_t).
    429  1.1  mrg   ThreadState *thr;
    430  1.1  mrg   ThreadStatus status;
    431  1.1  mrg   bool detached;
    432  1.1  mrg   int reuse_count;
    433  1.1  mrg   SyncClock sync;
    434  1.1  mrg   // Epoch at which the thread had started.
    435  1.1  mrg   // If we see an event from the thread stamped by an older epoch,
    436  1.1  mrg   // the event is from a dead thread that shared tid with this thread.
    437  1.1  mrg   u64 epoch0;
    438  1.1  mrg   u64 epoch1;
    439  1.1  mrg   StackTrace creation_stack;
    440  1.1  mrg   int creation_tid;
    441  1.1  mrg   ThreadDeadInfo *dead_info;
    442  1.1  mrg   ThreadContext *dead_next;  // In dead thread list.
    443  1.1  mrg   char *name;  // As annotated by user.
    444  1.1  mrg 
    445  1.1  mrg   explicit ThreadContext(int tid);
    446  1.1  mrg };
    447  1.1  mrg 
    448  1.1  mrg struct RacyStacks {
    449  1.1  mrg   MD5Hash hash[2];
    450  1.1  mrg   bool operator==(const RacyStacks &other) const {
    451  1.1  mrg     if (hash[0] == other.hash[0] && hash[1] == other.hash[1])
    452  1.1  mrg       return true;
    453  1.1  mrg     if (hash[0] == other.hash[1] && hash[1] == other.hash[0])
    454  1.1  mrg       return true;
    455  1.1  mrg     return false;
    456  1.1  mrg   }
    457  1.1  mrg };
    458  1.1  mrg 
    459  1.1  mrg struct RacyAddress {
    460  1.1  mrg   uptr addr_min;
    461  1.1  mrg   uptr addr_max;
    462  1.1  mrg };
    463  1.1  mrg 
    464  1.1  mrg struct FiredSuppression {
    465  1.1  mrg   ReportType type;
    466  1.1  mrg   uptr pc;
    467  1.1  mrg };
    468  1.1  mrg 
    469  1.1  mrg struct Context {
    470  1.1  mrg   Context();
    471  1.1  mrg 
    472  1.1  mrg   bool initialized;
    473  1.1  mrg 
    474  1.1  mrg   SyncTab synctab;
    475  1.1  mrg 
    476  1.1  mrg   Mutex report_mtx;
    477  1.1  mrg   int nreported;
    478  1.1  mrg   int nmissed_expected;
    479  1.1  mrg 
    480  1.1  mrg   Mutex thread_mtx;
    481  1.1  mrg   unsigned thread_seq;
    482  1.1  mrg   unsigned unique_thread_seq;
    483  1.1  mrg   int alive_threads;
    484  1.1  mrg   int max_alive_threads;
    485  1.1  mrg   ThreadContext *threads[kMaxTid];
    486  1.1  mrg   int dead_list_size;
    487  1.1  mrg   ThreadContext* dead_list_head;
    488  1.1  mrg   ThreadContext* dead_list_tail;
    489  1.1  mrg 
    490  1.1  mrg   Vector<RacyStacks> racy_stacks;
    491  1.1  mrg   Vector<RacyAddress> racy_addresses;
    492  1.1  mrg   Vector<FiredSuppression> fired_suppressions;
    493  1.1  mrg 
    494  1.1  mrg   Flags flags;
    495  1.1  mrg 
    496  1.1  mrg   u64 stat[StatCnt];
    497  1.1  mrg   u64 int_alloc_cnt[MBlockTypeCount];
    498  1.1  mrg   u64 int_alloc_siz[MBlockTypeCount];
    499  1.1  mrg };
    500  1.1  mrg 
    501  1.1  mrg class ScopedInRtl {
    502  1.1  mrg  public:
    503  1.1  mrg   ScopedInRtl();
    504  1.1  mrg   ~ScopedInRtl();
    505  1.1  mrg  private:
    506  1.1  mrg   ThreadState*thr_;
    507  1.1  mrg   int in_rtl_;
    508  1.1  mrg   int errno_;
    509  1.1  mrg };
    510  1.1  mrg 
    511  1.1  mrg class ScopedReport {
    512  1.1  mrg  public:
    513  1.1  mrg   explicit ScopedReport(ReportType typ);
    514  1.1  mrg   ~ScopedReport();
    515  1.1  mrg 
    516  1.1  mrg   void AddStack(const StackTrace *stack);
    517  1.1  mrg   void AddMemoryAccess(uptr addr, Shadow s, const StackTrace *stack,
    518  1.1  mrg                        const MutexSet *mset);
    519  1.1  mrg   void AddThread(const ThreadContext *tctx);
    520  1.1  mrg   void AddMutex(const SyncVar *s);
    521  1.1  mrg   void AddLocation(uptr addr, uptr size);
    522  1.1  mrg   void AddSleep(u32 stack_id);
    523  1.1  mrg 
    524  1.1  mrg   const ReportDesc *GetReport() const;
    525  1.1  mrg 
    526  1.1  mrg  private:
    527  1.1  mrg   Context *ctx_;
    528  1.1  mrg   ReportDesc *rep_;
    529  1.1  mrg 
    530  1.1  mrg   void AddMutex(u64 id);
    531  1.1  mrg 
    532  1.1  mrg   ScopedReport(const ScopedReport&);
    533  1.1  mrg   void operator = (const ScopedReport&);
    534  1.1  mrg };
    535  1.1  mrg 
    536  1.1  mrg void RestoreStack(int tid, const u64 epoch, StackTrace *stk, MutexSet *mset);
    537  1.1  mrg 
    538  1.1  mrg void StatAggregate(u64 *dst, u64 *src);
    539  1.1  mrg void StatOutput(u64 *stat);
    540  1.1  mrg void ALWAYS_INLINE INLINE StatInc(ThreadState *thr, StatType typ, u64 n = 1) {
    541  1.1  mrg   if (kCollectStats)
    542  1.1  mrg     thr->stat[typ] += n;
    543  1.1  mrg }
    544  1.1  mrg 
    545  1.1  mrg void MapShadow(uptr addr, uptr size);
    546  1.1  mrg void MapThreadTrace(uptr addr, uptr size);
    547  1.1  mrg void InitializeShadowMemory();
    548  1.1  mrg void InitializeInterceptors();
    549  1.1  mrg void InitializeDynamicAnnotations();
    550  1.1  mrg 
    551  1.1  mrg void ReportRace(ThreadState *thr);
    552  1.1  mrg bool OutputReport(Context *ctx,
    553  1.1  mrg                   const ScopedReport &srep,
    554  1.1  mrg                   const ReportStack *suppress_stack1 = 0,
    555  1.1  mrg                   const ReportStack *suppress_stack2 = 0);
    556  1.1  mrg bool IsFiredSuppression(Context *ctx,
    557  1.1  mrg                         const ScopedReport &srep,
    558  1.1  mrg                         const StackTrace &trace);
    559  1.1  mrg bool IsExpectedReport(uptr addr, uptr size);
    560  1.1  mrg bool FrameIsInternal(const ReportStack *frame);
    561  1.1  mrg ReportStack *SkipTsanInternalFrames(ReportStack *ent);
    562  1.1  mrg 
    563  1.1  mrg #if defined(TSAN_DEBUG_OUTPUT) && TSAN_DEBUG_OUTPUT >= 1
    564  1.1  mrg # define DPrintf Printf
    565  1.1  mrg #else
    566  1.1  mrg # define DPrintf(...)
    567  1.1  mrg #endif
    568  1.1  mrg 
    569  1.1  mrg #if defined(TSAN_DEBUG_OUTPUT) && TSAN_DEBUG_OUTPUT >= 2
    570  1.1  mrg # define DPrintf2 Printf
    571  1.1  mrg #else
    572  1.1  mrg # define DPrintf2(...)
    573  1.1  mrg #endif
    574  1.1  mrg 
    575  1.1  mrg u32 CurrentStackId(ThreadState *thr, uptr pc);
    576  1.1  mrg void PrintCurrentStack(ThreadState *thr, uptr pc);
    577  1.1  mrg void PrintCurrentStackSlow();  // uses libunwind
    578  1.1  mrg 
    579  1.1  mrg void Initialize(ThreadState *thr);
    580  1.1  mrg int Finalize(ThreadState *thr);
    581  1.1  mrg 
    582  1.1  mrg SyncVar* GetJavaSync(ThreadState *thr, uptr pc, uptr addr,
    583  1.1  mrg                      bool write_lock, bool create);
    584  1.1  mrg SyncVar* GetAndRemoveJavaSync(ThreadState *thr, uptr pc, uptr addr);
    585  1.1  mrg 
    586  1.1  mrg void MemoryAccess(ThreadState *thr, uptr pc, uptr addr,
    587  1.1  mrg     int kAccessSizeLog, bool kAccessIsWrite, bool kIsAtomic);
    588  1.1  mrg void MemoryAccessImpl(ThreadState *thr, uptr addr,
    589  1.1  mrg     int kAccessSizeLog, bool kAccessIsWrite, bool kIsAtomic,
    590  1.1  mrg     u64 *shadow_mem, Shadow cur);
    591  1.1  mrg void MemoryAccessRange(ThreadState *thr, uptr pc, uptr addr,
    592  1.1  mrg     uptr size, bool is_write);
    593  1.1  mrg void MemoryAccessRangeStep(ThreadState *thr, uptr pc, uptr addr,
    594  1.1  mrg     uptr size, uptr step, bool is_write);
    595  1.1  mrg 
    596  1.1  mrg const int kSizeLog1 = 0;
    597  1.1  mrg const int kSizeLog2 = 1;
    598  1.1  mrg const int kSizeLog4 = 2;
    599  1.1  mrg const int kSizeLog8 = 3;
    600  1.1  mrg 
    601  1.1  mrg void ALWAYS_INLINE INLINE MemoryRead(ThreadState *thr, uptr pc,
    602  1.1  mrg                                      uptr addr, int kAccessSizeLog) {
    603  1.1  mrg   MemoryAccess(thr, pc, addr, kAccessSizeLog, false, false);
    604  1.1  mrg }
    605  1.1  mrg 
    606  1.1  mrg void ALWAYS_INLINE INLINE MemoryWrite(ThreadState *thr, uptr pc,
    607  1.1  mrg                                       uptr addr, int kAccessSizeLog) {
    608  1.1  mrg   MemoryAccess(thr, pc, addr, kAccessSizeLog, true, false);
    609  1.1  mrg }
    610  1.1  mrg 
    611  1.1  mrg void ALWAYS_INLINE INLINE MemoryReadAtomic(ThreadState *thr, uptr pc,
    612  1.1  mrg                                            uptr addr, int kAccessSizeLog) {
    613  1.1  mrg   MemoryAccess(thr, pc, addr, kAccessSizeLog, false, true);
    614  1.1  mrg }
    615  1.1  mrg 
    616  1.1  mrg void ALWAYS_INLINE INLINE MemoryWriteAtomic(ThreadState *thr, uptr pc,
    617  1.1  mrg                                             uptr addr, int kAccessSizeLog) {
    618  1.1  mrg   MemoryAccess(thr, pc, addr, kAccessSizeLog, true, true);
    619  1.1  mrg }
    620  1.1  mrg 
    621  1.1  mrg void MemoryResetRange(ThreadState *thr, uptr pc, uptr addr, uptr size);
    622  1.1  mrg void MemoryRangeFreed(ThreadState *thr, uptr pc, uptr addr, uptr size);
    623  1.1  mrg void MemoryRangeImitateWrite(ThreadState *thr, uptr pc, uptr addr, uptr size);
    624  1.1  mrg void IgnoreCtl(ThreadState *thr, bool write, bool begin);
    625  1.1  mrg 
    626  1.1  mrg void FuncEntry(ThreadState *thr, uptr pc);
    627  1.1  mrg void FuncExit(ThreadState *thr);
    628  1.1  mrg 
    629  1.1  mrg int ThreadCreate(ThreadState *thr, uptr pc, uptr uid, bool detached);
    630  1.1  mrg void ThreadStart(ThreadState *thr, int tid, uptr os_id);
    631  1.1  mrg void ThreadFinish(ThreadState *thr);
    632  1.1  mrg int ThreadTid(ThreadState *thr, uptr pc, uptr uid);
    633  1.1  mrg void ThreadJoin(ThreadState *thr, uptr pc, int tid);
    634  1.1  mrg void ThreadDetach(ThreadState *thr, uptr pc, int tid);
    635  1.1  mrg void ThreadFinalize(ThreadState *thr);
    636  1.1  mrg void ThreadSetName(ThreadState *thr, const char *name);
    637  1.1  mrg int ThreadCount(ThreadState *thr);
    638  1.1  mrg void ProcessPendingSignals(ThreadState *thr);
    639  1.1  mrg 
    640  1.1  mrg void MutexCreate(ThreadState *thr, uptr pc, uptr addr,
    641  1.1  mrg                  bool rw, bool recursive, bool linker_init);
    642  1.1  mrg void MutexDestroy(ThreadState *thr, uptr pc, uptr addr);
    643  1.1  mrg void MutexLock(ThreadState *thr, uptr pc, uptr addr);
    644  1.1  mrg void MutexUnlock(ThreadState *thr, uptr pc, uptr addr);
    645  1.1  mrg void MutexReadLock(ThreadState *thr, uptr pc, uptr addr);
    646  1.1  mrg void MutexReadUnlock(ThreadState *thr, uptr pc, uptr addr);
    647  1.1  mrg void MutexReadOrWriteUnlock(ThreadState *thr, uptr pc, uptr addr);
    648  1.1  mrg 
    649  1.1  mrg void Acquire(ThreadState *thr, uptr pc, uptr addr);
    650  1.1  mrg void AcquireGlobal(ThreadState *thr, uptr pc);
    651  1.1  mrg void Release(ThreadState *thr, uptr pc, uptr addr);
    652  1.1  mrg void ReleaseStore(ThreadState *thr, uptr pc, uptr addr);
    653  1.1  mrg void AfterSleep(ThreadState *thr, uptr pc);
    654  1.1  mrg 
    655  1.1  mrg // The hacky call uses custom calling convention and an assembly thunk.
    656  1.1  mrg // It is considerably faster that a normal call for the caller
    657  1.1  mrg // if it is not executed (it is intended for slow paths from hot functions).
    658  1.1  mrg // The trick is that the call preserves all registers and the compiler
    659  1.1  mrg // does not treat it as a call.
    660  1.1  mrg // If it does not work for you, use normal call.
    661  1.1  mrg #if TSAN_DEBUG == 0
    662  1.1  mrg // The caller may not create the stack frame for itself at all,
    663  1.1  mrg // so we create a reserve stack frame for it (1024b must be enough).
    664  1.1  mrg #define HACKY_CALL(f) \
    665  1.1  mrg   __asm__ __volatile__("sub $1024, %%rsp;" \
    666  1.1  mrg                        "/*.cfi_adjust_cfa_offset 1024;*/" \
    667  1.1  mrg                        ".hidden " #f "_thunk;" \
    668  1.1  mrg                        "call " #f "_thunk;" \
    669  1.1  mrg                        "add $1024, %%rsp;" \
    670  1.1  mrg                        "/*.cfi_adjust_cfa_offset -1024;*/" \
    671  1.1  mrg                        ::: "memory", "cc");
    672  1.1  mrg #else
    673  1.1  mrg #define HACKY_CALL(f) f()
    674  1.1  mrg #endif
    675  1.1  mrg 
    676  1.1  mrg void TraceSwitch(ThreadState *thr);
    677  1.1  mrg uptr TraceTopPC(ThreadState *thr);
    678  1.1  mrg uptr TraceSize();
    679  1.1  mrg uptr TraceParts();
    680  1.1  mrg 
    681  1.1  mrg extern "C" void __tsan_trace_switch();
    682  1.1  mrg void ALWAYS_INLINE INLINE TraceAddEvent(ThreadState *thr, FastState fs,
    683  1.1  mrg                                         EventType typ, u64 addr) {
    684  1.1  mrg   DCHECK_GE((int)typ, 0);
    685  1.1  mrg   DCHECK_LE((int)typ, 7);
    686  1.1  mrg   DCHECK_EQ(GetLsb(addr, 61), addr);
    687  1.1  mrg   StatInc(thr, StatEvents);
    688  1.1  mrg   u64 pos = fs.GetTracePos();
    689  1.1  mrg   if (UNLIKELY((pos % kTracePartSize) == 0)) {
    690  1.1  mrg #ifndef TSAN_GO
    691  1.1  mrg     HACKY_CALL(__tsan_trace_switch);
    692  1.1  mrg #else
    693  1.1  mrg     TraceSwitch(thr);
    694  1.1  mrg #endif
    695  1.1  mrg   }
    696  1.1  mrg   Event *trace = (Event*)GetThreadTrace(fs.tid());
    697  1.1  mrg   Event *evp = &trace[pos];
    698  1.1  mrg   Event ev = (u64)addr | ((u64)typ << 61);
    699  1.1  mrg   *evp = ev;
    700  1.1  mrg }
    701  1.1  mrg 
    702  1.1  mrg }  // namespace __tsan
    703  1.1  mrg 
    704  1.1  mrg #endif  // TSAN_RTL_H
    705