includes/rts/SpinLock.h

   1 /* ----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 2006-2009
   4  *
   5  * Spin locks
   6  *
   7  * These are simple spin-only locks as opposed to Mutexes which
   8  * probably spin for a while before blocking in the kernel.  We use
   9  * these when we are sure that all our threads are actively running on
  10  * a CPU, eg. in the GC.
  11  *
  12  * TODO: measure whether we really need these, or whether Mutexes
  13  * would do (and be a bit safer if a CPU becomes loaded).
  14  *
  15  * Do not #include this file directly: #include "Rts.h" instead.
  16  *
  17  * To understand the structure of the RTS headers, see the wiki:
  18  *   http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
  19  *
  20  * -------------------------------------------------------------------------- */
  21
  22 #ifndef RTS_SPINLOCK_H
  23 #define RTS_SPINLOCK_H
  24
  25 #if defined(THREADED_RTS)
  26
  27 #if defined(PROF_SPIN)
  28 typedef struct SpinLock_
  29 {
  30     StgWord   lock;
  31     StgWord64 spin; // DEBUG version counts how much it spins
  32 } SpinLock;
  33 #else
  34 typedef StgWord SpinLock;
  35 #endif
  36
  37 typedef lnat SpinLockCount;
  38
  39
  40 #if defined(PROF_SPIN)
  41
  42 // PROF_SPIN enables counting the number of times we spin on a lock
  43
  44 // acquire spin lock
  45 INLINE_HEADER void ACQUIRE_SPIN_LOCK(SpinLock * p)
  46 {
  47     StgWord32 r = 0;
  48 spin:
  49     r = cas((StgVolatilePtr)&(p->lock), 1, 0);
  50     if (r == 0) {
  51         p->spin++;
  52         busy_wait_nop();
  53         goto spin;
  54     }
  55 }
  56
  57 // release spin lock
  58 INLINE_HEADER void RELEASE_SPIN_LOCK(SpinLock * p)
  59 {
  60     write_barrier();
  61     p->lock = 1;
  62 }
  63
  64 // initialise spin lock
  65 INLINE_HEADER void initSpinLock(SpinLock * p)
  66 {
  67     write_barrier();
  68     p->lock = 1;
  69     p->spin = 0;
  70 }
  71
  72 #else
  73
  74 // acquire spin lock
  75 INLINE_HEADER void ACQUIRE_SPIN_LOCK(SpinLock * p)
  76 {
  77     StgWord32 r = 0;
  78     do {
  79         r = cas((StgVolatilePtr)p, 1, 0);
  80         busy_wait_nop();
  81     } while(r == 0);
  82 }
  83
  84 // release spin lock
  85 INLINE_HEADER void RELEASE_SPIN_LOCK(SpinLock * p)
  86 {
  87     write_barrier();
  88     (*p) = 1;
  89 }
  90
  91 // init spin lock
  92 INLINE_HEADER void initSpinLock(SpinLock * p)
  93 {
  94     write_barrier();
  95     (*p) = 1;
  96 }
  97
  98 #endif /* PROF_SPIN */
  99
 100 #else /* !THREADED_RTS */
 101
 102 // Using macros here means we don't have to ensure the argument is in scope
 103 #define ACQUIRE_SPIN_LOCK(p) /* nothing */
 104 #define RELEASE_SPIN_LOCK(p) /* nothing */
 105
 106 INLINE_HEADER void initSpinLock(void * p STG_UNUSED)
 107 { /* nothing */ }
 108
 109 #endif /* THREADED_RTS */
 110
 111 #endif /* RTS_SPINLOCK_H */
 112