rts/Capability.h

   1 /* ---------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 2001-2006
   4  *
   5  * Capabilities
   6  *
   7  * The notion of a capability is used when operating in multi-threaded
   8  * environments (which the THREADED_RTS build of the RTS does), to
   9  * hold all the state an OS thread/task needs to run Haskell code:
  10  * its STG registers, a pointer to its  TSO, a nursery etc. During
  11  * STG execution, a pointer to the capabilitity is kept in a
  12  * register (BaseReg).
  13  *
  14  * Only in an THREADED_RTS build will there be multiple capabilities,
  15  * in the non-threaded builds there is one global capability, namely
  16  * MainCapability.
  17  *
  18  * This header file contains the functions for working with capabilities.
  19  * (the main, and only, consumer of this interface is the scheduler).
  20  *
  21  * --------------------------------------------------------------------------*/
  22
  23 #ifndef CAPABILITY_H
  24 #define CAPABILITY_H
  25
  26 #include "RtsFlags.h"
  27 #include "Task.h"
  28
  29 struct Capability_ {
  30     // State required by the STG virtual machine when running Haskell
  31     // code.  During STG execution, the BaseReg register always points
  32     // to the StgRegTable of the current Capability (&cap->r).
  33     StgFunTable f;
  34     StgRegTable r;
  35
  36     nat no;  // capability number.
  37
  38     // The Task currently holding this Capability.  This task has
  39     // exclusive access to the contents of this Capability (apart from
  40     // returning_tasks_hd/returning_tasks_tl).
  41     // Locks required: cap->lock.
  42     Task *running_task;
  43
  44     // true if this Capability is running Haskell code, used for
  45     // catching unsafe call-ins.
  46     rtsBool in_haskell;
  47
  48     // The run queue.  The Task owning this Capability has exclusive
  49     // access to its run queue, so can wake up threads without
  50     // taking a lock, and the common path through the scheduler is
  51     // also lock-free.
  52     StgTSO *run_queue_hd;
  53     StgTSO *run_queue_tl;
  54
  55     // Tasks currently making safe foreign calls.  Doubly-linked.
  56     // When returning, a task first acquires the Capability before
  57     // removing itself from this list, so that the GC can find all
  58     // the suspended TSOs easily.  Hence, when migrating a Task from
  59     // the returning_tasks list, we must also migrate its entry from
  60     // this list.
  61     Task *suspended_ccalling_tasks;
  62
  63     // One mutable list per generation, so we don't need to take any
  64     // locks when updating an old-generation thunk.  These
  65     // mini-mut-lists are moved onto the respective gen->mut_list at
  66     // each GC.
  67     bdescr **mut_lists;
  68
  69 #if defined(THREADED_RTS)
  70     // Worker Tasks waiting in the wings.  Singly-linked.
  71     Task *spare_workers;
  72
  73     // This lock protects running_task, returning_tasks_{hd,tl}, wakeup_queue.
  74     Mutex lock;
  75
  76     // Tasks waiting to return from a foreign call, or waiting to make
  77     // a new call-in using this Capability (NULL if empty).
  78     // NB. this field needs to be modified by tasks other than the
  79     // running_task, so it requires cap->lock to modify.  A task can
  80     // check whether it is NULL without taking the lock, however.
  81     Task *returning_tasks_hd; // Singly-linked, with head/tail
  82     Task *returning_tasks_tl;
  83
  84     // A list of threads to append to this Capability's run queue at
  85     // the earliest opportunity.  These are threads that have been
  86     // woken up by another Capability.
  87     StgTSO *wakeup_queue_hd;
  88     StgTSO *wakeup_queue_tl;
  89 #endif
  90
  91     // Per-capability STM-related data
  92     StgTVarWaitQueue *free_tvar_wait_queues;
  93     StgTRecChunk *free_trec_chunks;
  94     StgTRecHeader *free_trec_headers;
  95     nat transaction_tokens;
  96 }; // typedef Capability, defined in RtsAPI.h
  97
  98
  99 #if defined(THREADED_RTS)
 100 #define ASSERT_TASK_ID(task) ASSERT(task->id == osThreadId())
 101 #else
 102 #define ASSERT_TASK_ID(task) /*empty*/
 103 #endif
 104
 105 // These properties should be true when a Task is holding a Capability
 106 #define ASSERT_FULL_CAPABILITY_INVARIANTS(cap,task)                     \
 107   ASSERT(cap->running_task != NULL && cap->running_task == task);       \
 108   ASSERT(task->cap == cap);                                             \
 109   ASSERT_PARTIAL_CAPABILITY_INVARIANTS(cap,task)
 110
 111 // Sometimes a Task holds a Capability, but the Task is not associated
 112 // with that Capability (ie. task->cap != cap).  This happens when
 113 // (a) a Task holds multiple Capabilities, and (b) when the current
 114 // Task is bound, its thread has just blocked, and it may have been
 115 // moved to another Capability.
 116 #define ASSERT_PARTIAL_CAPABILITY_INVARIANTS(cap,task)  \
 117   ASSERT(cap->run_queue_hd == END_TSO_QUEUE ?           \
 118             cap->run_queue_tl == END_TSO_QUEUE : 1);    \
 119   ASSERT(myTask() == task);                             \
 120   ASSERT_TASK_ID(task);
 121
 122 // Converts a *StgRegTable into a *Capability.
 123 //
 124 INLINE_HEADER Capability *
 125 regTableToCapability (StgRegTable *reg)
 126 {
 127     return (Capability *)((void *)((unsigned char*)reg - sizeof(StgFunTable)));
 128 }
 129
 130 // Initialise the available capabilities.
 131 //
 132 void initCapabilities (void);
 133
 134 // Release a capability.  This is called by a Task that is exiting
 135 // Haskell to make a foreign call, or in various other cases when we
 136 // want to relinquish a Capability that we currently hold.
 137 //
 138 // ASSUMES: cap->running_task is the current Task.
 139 //
 140 #if defined(THREADED_RTS)
 141 void releaseCapability  (Capability* cap);
 142 void releaseCapability_ (Capability* cap); // assumes cap->lock is held
 143 #else
 144 // releaseCapability() is empty in non-threaded RTS
 145 INLINE_HEADER void releaseCapability  (Capability* cap STG_UNUSED) {};
 146 INLINE_HEADER void releaseCapability_ (Capability* cap STG_UNUSED) {};
 147 #endif
 148
 149 #if !IN_STG_CODE
 150 // one global capability
 151 extern Capability MainCapability;
 152 #endif
 153
 154 // Array of all the capabilities
 155 //
 156 extern nat n_capabilities;
 157 extern Capability *capabilities;
 158
 159 // The Capability that was last free.  Used as a good guess for where
 160 // to assign new threads.
 161 //
 162 extern Capability *last_free_capability;
 163
 164 // Acquires a capability at a return point.  If *cap is non-NULL, then
 165 // this is taken as a preference for the Capability we wish to
 166 // acquire.
 167 //
 168 // OS threads waiting in this function get priority over those waiting
 169 // in waitForCapability().
 170 //
 171 // On return, *cap is non-NULL, and points to the Capability acquired.
 172 //
 173 void waitForReturnCapability (Capability **cap/*in/out*/, Task *task);
 174
 175 INLINE_HEADER void recordMutableCap (StgClosure *p, Capability *cap, nat gen);
 176
 177 #if defined(THREADED_RTS)
 178
 179 // Gives up the current capability IFF there is a higher-priority
 180 // thread waiting for it.  This happens in one of two ways:
 181 //
 182 //   (a) we are passing the capability to another OS thread, so
 183 //       that it can run a bound Haskell thread, or
 184 //
 185 //   (b) there is an OS thread waiting to return from a foreign call
 186 //
 187 // On return: *pCap is NULL if the capability was released.  The
 188 // current task should then re-acquire it using waitForCapability().
 189 //
 190 void yieldCapability (Capability** pCap, Task *task);
 191
 192 // Acquires a capability for doing some work.
 193 //
 194 // On return: pCap points to the capability.
 195 //
 196 void waitForCapability (Task *task, Mutex *mutex, Capability **pCap);
 197
 198 // Wakes up a thread on a Capability (probably a different Capability
 199 // from the one held by the current Task).
 200 //
 201 void wakeupThreadOnCapability (Capability *cap, StgTSO *tso);
 202 void wakeupThreadOnCapability_lock (Capability *cap, StgTSO *tso);
 203
 204 void migrateThreadToCapability (Capability *cap, StgTSO *tso);
 205 void migrateThreadToCapability_lock (Capability *cap, StgTSO *tso);
 206
 207 // Wakes up a worker thread on just one Capability, used when we
 208 // need to service some global event.
 209 //
 210 void prodOneCapability (void);
 211
 212 // Similar to prodOneCapability(), but prods all of them.
 213 //
 214 void prodAllCapabilities (void);
 215
 216 // Waits for a capability to drain of runnable threads and workers,
 217 // and then acquires it.  Used at shutdown time.
 218 //
 219 void shutdownCapability (Capability *cap, Task *task);
 220
 221 // Attempt to gain control of a Capability if it is free.
 222 //
 223 rtsBool tryGrabCapability (Capability *cap, Task *task);
 224
 225 #else // !THREADED_RTS
 226
 227 // Grab a capability.  (Only in the non-threaded RTS; in the threaded
 228 // RTS one of the waitFor*Capability() functions must be used).
 229 //
 230 extern void grabCapability (Capability **pCap);
 231
 232 #endif /* !THREADED_RTS */
 233
 234 /* -----------------------------------------------------------------------------
 235  * INLINE functions... private below here
 236  * -------------------------------------------------------------------------- */
 237
 238 INLINE_HEADER void
 239 recordMutableCap (StgClosure *p, Capability *cap, nat gen)
 240 {
 241     bdescr *bd;
 242
 243     bd = cap->mut_lists[gen];
 244     if (bd->free >= bd->start + BLOCK_SIZE_W) {
 245         bdescr *new_bd;
 246         new_bd = allocBlock_lock();
 247         new_bd->link = bd;
 248         bd = new_bd;
 249         cap->mut_lists[gen] = bd;
 250     }
 251     *bd->free++ = (StgWord)p;
 252 }
 253
 254 #endif /* CAPABILITY_H */