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 #include "classlist.h"
  12 #include "hashset.h"
  13
  14 struct ShadowTable {
  15         void * array[65536];
  16 };
  17
  18 struct ShadowBaseTable {
  19         uint64_t array[65536];
  20 };
  21
  22 struct DataRace {
  23         /* Clock and thread associated with first action.  This won't change in
  24                  response to synchronization. */
  25
  26         thread_id_t oldthread;
  27         modelclock_t oldclock;
  28         /* Record whether this is a write, so we can tell the user. */
  29         bool isoldwrite;
  30
  31         /* Model action associated with second action.  This could change as
  32                  a result of synchronization. */
  33         ModelAction *newaction;
  34         /* Record whether this is a write, so we can tell the user. */
  35         bool isnewwrite;
  36
  37         /* Address of data race. */
  38         const void *address;
  39         void * backtrace[64];
  40         int numframes;
  41 };
  42
  43 #define MASK16BIT 0xffff
  44
  45 void initRaceDetector();
  46 void raceCheckWrite(thread_id_t thread, void *location);
  47 void raceCheckRead(thread_id_t thread, const void *location);
  48 void recordWrite(thread_id_t thread, void *location);
  49 bool checkDataRaces();
  50 void assert_race(struct DataRace *race);
  51
  52 /**
  53  * @brief A record of information for detecting data races
  54  */
  55 struct RaceRecord {
  56         modelclock_t *readClock;
  57         thread_id_t *thread;
  58         int numReads : 31;
  59         int isAtomic : 1;
  60         thread_id_t writeThread;
  61         modelclock_t writeClock;
  62 };
  63
  64 unsigned int race_hash(struct DataRace *race);
  65 bool race_equals(struct DataRace *r1, struct DataRace *r2);
  66
  67 #define INITCAPACITY 4
  68
  69 #define ISSHORTRECORD(x) ((x)&0x1)
  70
  71 #define THREADMASK 0x3f
  72 #define RDTHREADID(x) (((x)>>1)&THREADMASK)
  73 #define READMASK 0x1ffffff
  74 #define READVECTOR(x) (((x)>>7)&READMASK)
  75
  76 #define WRTHREADID(x) (((x)>>32)&THREADMASK)
  77
  78 #define WRITEMASK READMASK
  79 #define WRITEVECTOR(x) (((x)>>38)&WRITEMASK)
  80
  81 #define ATOMICMASK (0x1ULL << 63)
  82 #define NONATOMICMASK ~(0x1ULL << 63)
  83
  84 /**
  85  * The basic encoding idea is that (void *) either:
  86  *  -# points to a full record (RaceRecord) or
  87  *  -# encodes the information in a 64 bit word. Encoding is as
  88  *     follows:
  89  *     - lowest bit set to 1
  90  *     - next 6 bits are read thread id
  91  *     - next 25 bits are read clock vector
  92  *     - next 6 bits are write thread id
  93  *     - next 25 bits are write clock vector
  94  *     - highest bit is 1 if the write is from an atomic
  95  */
  96 #define ENCODEOP(rdthread, rdtime, wrthread, wrtime) (0x1ULL | ((rdthread)<<1) | ((rdtime) << 7) | (((uint64_t)wrthread)<<32) | (((uint64_t)wrtime)<<38))
  97
  98 #define MAXTHREADID (THREADMASK-1)
  99 #define MAXREADVECTOR (READMASK-1)
 100 #define MAXWRITEVECTOR (WRITEMASK-1)
 101
 102 typedef HashSet<struct DataRace *, uintptr_t, 0, model_malloc, model_calloc, model_free, race_hash, race_equals> RaceSet;
 103
 104 #endif  /* __DATARACE_H__ */