ghc/rts/Capability.h

   1 /* ---------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 2001
   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 #ifndef __CAPABILITY_H__
  23 #define __CAPABILITY_H__
  24 #include "RtsFlags.h"
  25 /* ToDo: assume that RtsFlags.h has been included at usage sites of Capability.h? */
  26
  27 extern void initCapability(Capability* cap);
  28 #if defined(SMP)
  29 extern nat rts_n_free_capabilities;  /* total number of available capabilities */
  30
  31 static inline nat getFreeCapabilities()
  32 {
  33   return rts_n_free_capabilities;
  34 }
  35
  36 static inline rtsBool noFreeCapabilities()
  37 {
  38   return (rts_n_free_capabilities == 0);
  39 }
  40
  41 static inline rtsBool allFreeCapabilities()
  42 {
  43   return (rts_n_free_capabilities == RtsFlags.ParFlags.nNodes);
  44 }
  45
  46 extern void initCapabilities(nat n);
  47 extern void grabCapability(Capability** cap);
  48 extern void releaseCapability(Capability** cap);
  49 #endif /* SMP */
  50
  51 #endif /* __CAPABILITY_H__ */