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