libsanitizer/tsan/tsan_trace.h

   1 //===-- tsan_trace.h --------------------------------------------*- C++ -*-===//
   2 //
   3 // This file is distributed under the University of Illinois Open Source
   4 // License. See LICENSE.TXT for details.
   5 //
   6 //===----------------------------------------------------------------------===//
   7 //
   8 // This file is a part of ThreadSanitizer (TSan), a race detector.
   9 //
  10 //===----------------------------------------------------------------------===//
  11 #ifndef TSAN_TRACE_H
  12 #define TSAN_TRACE_H
  13
  14 #include "tsan_defs.h"
  15 #include "tsan_mutex.h"
  16 #include "tsan_stack_trace.h"
  17 #include "tsan_mutexset.h"
  18
  19 namespace __tsan {
  20
  21 const int kTracePartSizeBits = 14;
  22 const int kTracePartSize = 1 << kTracePartSizeBits;
  23 const int kTraceParts = 4 * 1024 * 1024 / kTracePartSize;
  24 const int kTraceSize = kTracePartSize * kTraceParts;
  25
  26 // Must fit into 3 bits.
  27 enum EventType {
  28   EventTypeMop,
  29   EventTypeFuncEnter,
  30   EventTypeFuncExit,
  31   EventTypeLock,
  32   EventTypeUnlock,
  33   EventTypeRLock,
  34   EventTypeRUnlock
  35 };
  36
  37 // Represents a thread event (from most significant bit):
  38 // u64 typ  : 3;   // EventType.
  39 // u64 addr : 61;  // Associated pc.
  40 typedef u64 Event;
  41
  42 struct TraceHeader {
  43   StackTrace stack0;  // Start stack for the trace.
  44   u64        epoch0;  // Start epoch for the trace.
  45   MutexSet   mset0;
  46 #ifndef TSAN_GO
  47   uptr       stack0buf[kTraceStackSize];
  48 #endif
  49
  50   TraceHeader()
  51 #ifndef TSAN_GO
  52       : stack0(stack0buf, kTraceStackSize)
  53 #else
  54       : stack0()
  55 #endif
  56       , epoch0() {
  57   }
  58 };
  59
  60 struct Trace {
  61   TraceHeader headers[kTraceParts];
  62   Mutex mtx;
  63 #ifndef TSAN_GO
  64   // Must be last to catch overflow as paging fault.
  65   // Go shadow stack is dynamically allocated.
  66   uptr shadow_stack[kShadowStackSize];
  67 #endif
  68
  69   Trace()
  70     : mtx(MutexTypeTrace, StatMtxTrace) {
  71   }
  72 };
  73
  74 }  // namespace __tsan
  75
  76 #endif  // TSAN_TRACE_H