ghc/rts/Capability.h

   1 /* ---------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 2001-2003
   4  *
   5  * Capabilities
   6  *
   7  * The notion of a capability is used when operating in multi-threaded
   8  * environments (which the SMP and Threads builds of the RTS do), 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 SMP build will there be multiple capabilities, the threaded
  15  * RTS and other non-threaded builds, there is one global capability,
  16  * namely MainRegTable.
  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 // Initialised the available capabilities.
  27 //
  28 extern void initCapabilities( void );
  29
  30 // Releases a capability
  31 //
  32 extern void releaseCapability( Capability* cap );
  33
  34 #ifdef RTS_SUPPORTS_THREADS
  35 // Gives up the current capability IFF there is a higher-priority
  36 // thread waiting for it.  This happens in one of two ways:
  37 //
  38 //   (a) we are passing the capability to another OS thread, so
  39 //       that it can run a bound Haskell thread, or
  40 //
  41 //   (b) there is an OS thread waiting to return from a foreign call
  42 //
  43 // On return: *pCap is NULL if the capability was released.  The
  44 // current worker thread should then re-acquire it using
  45 // waitForCapability().
  46 //
  47 extern void yieldCapability( Capability **pCap );
  48
  49 // Acquires a capability for doing some work.
  50 //
  51 // If the current OS thread is bound to a particular Haskell thread,
  52 // then pThreadCond points to a condition variable for waking up this
  53 // OS thread when its Haskell thread is ready to run.
  54 //
  55 // On return: pCap points to the capability.
  56 extern void waitForCapability( Mutex* pMutex, Capability** pCap,
  57                                Condition *pThreadCond );
  58
  59 // Acquires a capability at a return point.
  60 //
  61 // OS threads waiting in this function get priority over those waiting
  62 // in waitForWorkCapability().
  63 //
  64 // On return: pCap points to the capability.
  65 extern void waitForReturnCapability(Mutex* pMutex, Capability** pCap);
  66
  67 // Signals that the next time a capability becomes free, it should
  68 // be transfered to a particular OS thread, identified by the
  69 // condition variable pTargetThreadCond.
  70 //
  71 extern void passCapability(Condition *pTargetThreadCond);
  72
  73 // Signals that the next time a capability becomes free, it should
  74 // be transfered to an ordinary worker thread.
  75 //
  76 extern void passCapabilityToWorker( void );
  77
  78 extern nat rts_n_free_capabilities;
  79 /* number of worker threads waiting for a return capability
  80  */
  81 extern nat rts_n_waiting_workers;
  82
  83 static inline rtsBool needToYieldToReturningWorker(void)
  84 {
  85         return rts_n_waiting_workers > 0;
  86 }
  87
  88 static inline nat getFreeCapabilities (void)
  89 {
  90   return rts_n_free_capabilities;
  91 }
  92
  93 static inline rtsBool noCapabilities (void)
  94 {
  95   return (rts_n_free_capabilities == 0);
  96 }
  97
  98 static inline rtsBool allFreeCapabilities (void)
  99 {
 100   return (rts_n_free_capabilities == 1);
 101 }
 102
 103 #else // !RTS_SUPPORTS_THREADS
 104
 105 // Grab a capability.  (Only in the non-threaded RTS; in the threaded
 106 // RTS one of the waitFor*Capability() functions must be used).
 107 //
 108 extern void grabCapability( Capability **pCap );
 109
 110 #endif // !RTS_SUPPORTS_THREADS
 111
 112 #endif /* __CAPABILITY_H__ */