datarace.h

   1 /** @file datarace.h
   2  *  @brief Data race detection code.
   3  */
   4
   5 #ifndef __DATARACE_H__
   6 #define __DATARACE_H__
   7
   8 #include "config.h"
   9 #include <stdint.h>
  10 #include "modeltypes.h"
  11
  12 /* Forward declaration */
  13 class ModelAction;
  14
  15 struct ShadowTable {
  16         void * array[65536];
  17 };
  18
  19 struct ShadowBaseTable {
  20         uint64_t array[65536];
  21 };
  22
  23 struct DataRace {
  24         /* Clock and thread associated with first action.  This won't change in
  25                  response to synchronization. */
  26
  27         thread_id_t oldthread;
  28         modelclock_t oldclock;
  29         /* Record whether this is a write, so we can tell the user. */
  30         bool isoldwrite;
  31
  32         /* Model action associated with second action.  This could change as
  33                  a result of synchronization. */
  34         ModelAction *newaction;
  35         /* Record whether this is a write, so we can tell the user. */
  36         bool isnewwrite;
  37
  38         /* Address of data race. */
  39         const void *address;
  40 };
  41
  42 #define MASK16BIT 0xffff
  43
  44 void initRaceDetector();
  45 void raceCheckWrite(thread_id_t thread, void *location);
  46 void raceCheckRead(thread_id_t thread, const void *location);
  47 bool checkDataRaces();
  48 void assert_race(struct DataRace *race);
  49 bool haveUnrealizedRaces();
  50
  51 /**
  52  * @brief A record of information for detecting data races
  53  */
  54 struct RaceRecord {
  55         modelclock_t *readClock;
  56         thread_id_t *thread;
  57         int capacity;
  58         int numReads;
  59         thread_id_t writeThread;
  60         modelclock_t writeClock;
  61 };
  62
  63 #define INITCAPACITY 4
  64
  65 #define ISSHORTRECORD(x) ((x)&0x1)
  66
  67 #define THREADMASK 0xff
  68 #define RDTHREADID(x) (((x)>>1)&THREADMASK)
  69 #define READMASK 0x07fffff
  70 #define READVECTOR(x) (((x)>>9)&READMASK)
  71
  72 #define WRTHREADID(x) (((x)>>32)&THREADMASK)
  73
  74 #define WRITEMASK READMASK
  75 #define WRITEVECTOR(x) (((x)>>40)&WRITEMASK)
  76
  77 /**
  78  * The basic encoding idea is that (void *) either:
  79  *  -# points to a full record (RaceRecord) or
  80  *  -# encodes the information in a 64 bit word. Encoding is as
  81  *     follows:
  82  *     - lowest bit set to 1
  83  *     - next 8 bits are read thread id
  84  *     - next 23 bits are read clock vector
  85  *     - next 8 bits are write thread id
  86  *     - next 23 bits are write clock vector
  87  */
  88 #define ENCODEOP(rdthread, rdtime, wrthread, wrtime) (0x1ULL | ((rdthread)<<1) | ((rdtime) << 9) | (((uint64_t)wrthread)<<32) | (((uint64_t)wrtime)<<40))
  89
  90 #define MAXTHREADID (THREADMASK-1)
  91 #define MAXREADVECTOR (READMASK-1)
  92 #define MAXWRITEVECTOR (WRITEMASK-1)
  93
  94 #endif /* __DATARACE_H__ */