rts/Capability.h

   1 /* ---------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 2001-2006
   4  *
   5  * Capabilities
   6  *
   7  * A Capability holds all the state an OS thread/task needs to run
   8  * Haskell code: its STG registers, a pointer to its TSO, a nursery
   9  * etc. During STG execution, a pointer to the Capabilitity is kept in
  10  * a register (BaseReg).
  11  *
  12  * Only in a THREADED_RTS build will there be multiple capabilities,
  13  * in the non-threaded RTS there is one global capability, called
  14  * MainCapability.
  15  *
  16  * --------------------------------------------------------------------------*/
  17
  18 #ifndef CAPABILITY_H
  19 #define CAPABILITY_H
  20
  21 #include "sm/GC.h" // for evac_fn
  22 #include "Task.h"
  23 #include "Sparks.h"
  24
  25 BEGIN_RTS_PRIVATE
  26
  27 struct Capability_ {
  28     // State required by the STG virtual machine when running Haskell
  29     // code.  During STG execution, the BaseReg register always points
  30     // to the StgRegTable of the current Capability (&cap->r).
  31     StgFunTable f;
  32     StgRegTable r;
  33
  34     nat no;  // capability number.
  35
  36     // The Task currently holding this Capability.  This task has
  37     // exclusive access to the contents of this Capability (apart from
  38     // returning_tasks_hd/returning_tasks_tl).
  39     // Locks required: cap->lock.
  40     Task *running_task;
  41
  42     // true if this Capability is running Haskell code, used for
  43     // catching unsafe call-ins.
  44     rtsBool in_haskell;
  45
  46     // true if this Capability is currently in the GC
  47     rtsBool in_gc;
  48
  49     // The run queue.  The Task owning this Capability has exclusive
  50     // access to its run queue, so can wake up threads without
  51     // taking a lock, and the common path through the scheduler is
  52     // also lock-free.
  53     StgTSO *run_queue_hd;
  54     StgTSO *run_queue_tl;
  55
  56     // Tasks currently making safe foreign calls.  Doubly-linked.
  57     // When returning, a task first acquires the Capability before
  58     // removing itself from this list, so that the GC can find all
  59     // the suspended TSOs easily.  Hence, when migrating a Task from
  60     // the returning_tasks list, we must also migrate its entry from
  61     // this list.
  62     Task *suspended_ccalling_tasks;
  63
  64     // One mutable list per generation, so we don't need to take any
  65     // locks when updating an old-generation thunk.  This also lets us
  66     // keep track of which closures this CPU has been mutating, so we
  67     // can traverse them using the right thread during GC and avoid
  68     // unnecessarily moving the data from one cache to another.
  69     bdescr **mut_lists;
  70     bdescr **saved_mut_lists; // tmp use during GC
  71
  72     // block for allocating pinned objects into
  73     bdescr *pinned_object_block;
  74
  75     // Context switch flag. We used to have one global flag, now one
  76     // per capability. Locks required  : none (conflicts are harmless)
  77     int context_switch;
  78
  79 #if defined(THREADED_RTS)
  80     // Worker Tasks waiting in the wings.  Singly-linked.
  81     Task *spare_workers;
  82
  83     // This lock protects running_task, returning_tasks_{hd,tl}, wakeup_queue.
  84     Mutex lock;
  85
  86     // Tasks waiting to return from a foreign call, or waiting to make
  87     // a new call-in using this Capability (NULL if empty).
  88     // NB. this field needs to be modified by tasks other than the
  89     // running_task, so it requires cap->lock to modify.  A task can
  90     // check whether it is NULL without taking the lock, however.
  91     Task *returning_tasks_hd; // Singly-linked, with head/tail
  92     Task *returning_tasks_tl;
  93
  94     // A list of threads to append to this Capability's run queue at
  95     // the earliest opportunity.  These are threads that have been
  96     // woken up by another Capability.
  97     StgTSO *wakeup_queue_hd;
  98     StgTSO *wakeup_queue_tl;
  99
 100     SparkPool *sparks;
 101
 102     // Stats on spark creation/conversion
 103     nat sparks_created;
 104     nat sparks_converted;
 105     nat sparks_pruned;
 106 #endif
 107
 108     // Per-capability STM-related data
 109     StgTVarWatchQueue *free_tvar_watch_queues;
 110     StgInvariantCheckQueue *free_invariant_check_queues;
 111     StgTRecChunk *free_trec_chunks;
 112     StgTRecHeader *free_trec_headers;
 113     nat transaction_tokens;
 114 } // typedef Capability is defined in RtsAPI.h
 115   // Capabilities are stored in an array, so make sure that adjacent
 116   // Capabilities don't share any cache-lines:
 117 #ifndef mingw32_HOST_OS
 118   ATTRIBUTE_ALIGNED(64)
 119 #endif
 120   ;
 121
 122
 123 #if defined(THREADED_RTS)
 124 #define ASSERT_TASK_ID(task) ASSERT(task->id == osThreadId())
 125 #else
 126 #define ASSERT_TASK_ID(task) /*empty*/
 127 #endif
 128
 129 // These properties should be true when a Task is holding a Capability
 130 #define ASSERT_FULL_CAPABILITY_INVARIANTS(cap,task)                     \
 131   ASSERT(cap->running_task != NULL && cap->running_task == task);       \
 132   ASSERT(task->cap == cap);                                             \
 133   ASSERT_PARTIAL_CAPABILITY_INVARIANTS(cap,task)
 134
 135 // Sometimes a Task holds a Capability, but the Task is not associated
 136 // with that Capability (ie. task->cap != cap).  This happens when
 137 // (a) a Task holds multiple Capabilities, and (b) when the current
 138 // Task is bound, its thread has just blocked, and it may have been
 139 // moved to another Capability.
 140 #define ASSERT_PARTIAL_CAPABILITY_INVARIANTS(cap,task)  \
 141   ASSERT(cap->run_queue_hd == END_TSO_QUEUE ?           \
 142             cap->run_queue_tl == END_TSO_QUEUE : 1);    \
 143   ASSERT(myTask() == task);                             \
 144   ASSERT_TASK_ID(task);
 145
 146 // Converts a *StgRegTable into a *Capability.
 147 //
 148 INLINE_HEADER Capability *
 149 regTableToCapability (StgRegTable *reg)
 150 {
 151     return (Capability *)((void *)((unsigned char*)reg - STG_FIELD_OFFSET(Capability,r)));
 152 }
 153
 154 // Initialise the available capabilities.
 155 //
 156 void initCapabilities (void);
 157
 158 // Release a capability.  This is called by a Task that is exiting
 159 // Haskell to make a foreign call, or in various other cases when we
 160 // want to relinquish a Capability that we currently hold.
 161 //
 162 // ASSUMES: cap->running_task is the current Task.
 163 //
 164 #if defined(THREADED_RTS)
 165 void releaseCapability           (Capability* cap);
 166 void releaseAndWakeupCapability  (Capability* cap);
 167 void releaseCapability_ (Capability* cap, rtsBool always_wakeup);
 168 // assumes cap->lock is held
 169 #else
 170 // releaseCapability() is empty in non-threaded RTS
 171 INLINE_HEADER void releaseCapability  (Capability* cap STG_UNUSED) {};
 172 INLINE_HEADER void releaseAndWakeupCapability  (Capability* cap STG_UNUSED) {};
 173 INLINE_HEADER void releaseCapability_ (Capability* cap STG_UNUSED,
 174                                        rtsBool always_wakeup STG_UNUSED) {};
 175 #endif
 176
 177 // declared in includes/rts/Threads.h:
 178 // extern Capability MainCapability;
 179
 180 // declared in includes/rts/Threads.h:
 181 // extern nat n_capabilities;
 182
 183 // Array of all the capabilities
 184 //
 185 extern Capability *capabilities;
 186
 187 // The Capability that was last free.  Used as a good guess for where
 188 // to assign new threads.
 189 //
 190 extern Capability *last_free_capability;
 191
 192 // GC indicator, in scope for the scheduler
 193 #define PENDING_GC_SEQ 1
 194 #define PENDING_GC_PAR 2
 195 extern volatile StgWord waiting_for_gc;
 196
 197 // Acquires a capability at a return point.  If *cap is non-NULL, then
 198 // this is taken as a preference for the Capability we wish to
 199 // acquire.
 200 //
 201 // OS threads waiting in this function get priority over those waiting
 202 // in waitForCapability().
 203 //
 204 // On return, *cap is non-NULL, and points to the Capability acquired.
 205 //
 206 void waitForReturnCapability (Capability **cap/*in/out*/, Task *task);
 207
 208 INLINE_HEADER void recordMutableCap (StgClosure *p, Capability *cap, nat gen);
 209
 210 #if defined(THREADED_RTS)
 211
 212 // Gives up the current capability IFF there is a higher-priority
 213 // thread waiting for it.  This happens in one of two ways:
 214 //
 215 //   (a) we are passing the capability to another OS thread, so
 216 //       that it can run a bound Haskell thread, or
 217 //
 218 //   (b) there is an OS thread waiting to return from a foreign call
 219 //
 220 // On return: *pCap is NULL if the capability was released.  The
 221 // current task should then re-acquire it using waitForCapability().
 222 //
 223 void yieldCapability (Capability** pCap, Task *task);
 224
 225 // Acquires a capability for doing some work.
 226 //
 227 // On return: pCap points to the capability.
 228 //
 229 void waitForCapability (Task *task, Mutex *mutex, Capability **pCap);
 230
 231 // Wakes up a thread on a Capability (probably a different Capability
 232 // from the one held by the current Task).
 233 //
 234 void wakeupThreadOnCapability (Capability *my_cap, Capability *other_cap,
 235                                StgTSO *tso);
 236
 237 // Wakes up a worker thread on just one Capability, used when we
 238 // need to service some global event.
 239 //
 240 void prodOneCapability (void);
 241 void prodCapability (Capability *cap, Task *task);
 242
 243 // Similar to prodOneCapability(), but prods all of them.
 244 //
 245 void prodAllCapabilities (void);
 246
 247 // Waits for a capability to drain of runnable threads and workers,
 248 // and then acquires it.  Used at shutdown time.
 249 //
 250 void shutdownCapability (Capability *cap, Task *task, rtsBool wait_foreign);
 251
 252 // Attempt to gain control of a Capability if it is free.
 253 //
 254 rtsBool tryGrabCapability (Capability *cap, Task *task);
 255
 256 // Try to find a spark to run
 257 //
 258 StgClosure *findSpark (Capability *cap);
 259
 260 // True if any capabilities have sparks
 261 //
 262 rtsBool anySparks (void);
 263
 264 INLINE_HEADER rtsBool emptySparkPoolCap (Capability *cap);
 265 INLINE_HEADER nat     sparkPoolSizeCap  (Capability *cap);
 266 INLINE_HEADER void    discardSparksCap  (Capability *cap);
 267
 268 #else // !THREADED_RTS
 269
 270 // Grab a capability.  (Only in the non-threaded RTS; in the threaded
 271 // RTS one of the waitFor*Capability() functions must be used).
 272 //
 273 extern void grabCapability (Capability **pCap);
 274
 275 #endif /* !THREADED_RTS */
 276
 277 // cause all capabilities to context switch as soon as possible.
 278 void setContextSwitches(void);
 279 INLINE_HEADER void contextSwitchCapability(Capability *cap);
 280
 281 // Free all capabilities
 282 void freeCapabilities (void);
 283
 284 // For the GC:
 285 void markSomeCapabilities (evac_fn evac, void *user, nat i0, nat delta,
 286                            rtsBool prune_sparks);
 287 void markCapabilities (evac_fn evac, void *user);
 288 void traverseSparkQueues (evac_fn evac, void *user);
 289
 290 /* -----------------------------------------------------------------------------
 291  * INLINE functions... private below here
 292  * -------------------------------------------------------------------------- */
 293
 294 INLINE_HEADER void
 295 recordMutableCap (StgClosure *p, Capability *cap, nat gen)
 296 {
 297     bdescr *bd;
 298
 299     // We must own this Capability in order to modify its mutable list.
 300     ASSERT(cap->running_task == myTask());
 301     bd = cap->mut_lists[gen];
 302     if (bd->free >= bd->start + BLOCK_SIZE_W) {
 303         bdescr *new_bd;
 304         new_bd = allocBlock_lock();
 305         new_bd->link = bd;
 306         bd = new_bd;
 307         cap->mut_lists[gen] = bd;
 308     }
 309     *bd->free++ = (StgWord)p;
 310 }
 311
 312 #if defined(THREADED_RTS)
 313 INLINE_HEADER rtsBool
 314 emptySparkPoolCap (Capability *cap)
 315 { return looksEmpty(cap->sparks); }
 316
 317 INLINE_HEADER nat
 318 sparkPoolSizeCap (Capability *cap)
 319 { return sparkPoolSize(cap->sparks); }
 320
 321 INLINE_HEADER void
 322 discardSparksCap (Capability *cap)
 323 { return discardSparks(cap->sparks); }
 324 #endif
 325
 326 INLINE_HEADER void
 327 contextSwitchCapability (Capability *cap)
 328 {
 329     // setting HpLim to NULL ensures that the next heap check will
 330     // fail, and the thread will return to the scheduler.
 331     cap->r.rHpLim = NULL;
 332     // But just in case it didn't work (the target thread might be
 333     // modifying HpLim at the same time), we set the end-of-block
 334     // context-switch flag too:
 335     cap->context_switch = 1;
 336 }
 337
 338 END_RTS_PRIVATE
 339
 340 #endif /* CAPABILITY_H */