includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  *
   3  * (c) The GHC Team, 1998-2004
   4  *
   5  * API for invoking Haskell functions via the RTS
   6  *
   7  * --------------------------------------------------------------------------*/
   8
   9 #ifndef RTSAPI_H
  10 #define RTSAPI_H
  11
  12 #ifdef __cplusplus
  13 extern "C" {
  14 #endif
  15
  16 #include "HsFFI.h"
  17
  18 /*
  19  * Running the scheduler
  20  */
  21 typedef enum {
  22     NoStatus,    /* not finished yet */
  23     Success,     /* completed successfully */
  24     Killed,      /* uncaught exception */
  25     Interrupted, /* stopped in response to a call to interruptStgRts */
  26     HeapExhausted /* out of memory */
  27 } SchedulerStatus;
  28
  29 typedef StgClosure *HaskellObj;
  30
  31 /*
  32  * An abstract type representing the token returned by rts_lock() and
  33  * used when allocating objects and threads in the RTS.
  34  */
  35 typedef struct Capability_ Capability;
  36
  37 /* ----------------------------------------------------------------------------
  38    Starting up and shutting down the Haskell RTS.
  39    ------------------------------------------------------------------------- */
  40 extern void startupHaskell         ( int argc, char *argv[],
  41                                      void (*init_root)(void) );
  42 extern void shutdownHaskell        ( void );
  43 extern void shutdownHaskellAndExit ( int exitCode );
  44 extern void getProgArgv            ( int *argc, char **argv[] );
  45 extern void setProgArgv            ( int argc, char *argv[] );
  46 extern void getFullProgArgv        ( int *argc, char **argv[] );
  47 extern void setFullProgArgv        ( int argc, char *argv[] );
  48
  49 #ifndef mingw32_HOST_OS
  50 extern void shutdownHaskellAndSignal (int sig);
  51 #endif
  52
  53 /* exit() override */
  54 extern void (*exitFn)(int);
  55
  56 /* ----------------------------------------------------------------------------
  57    Locking.
  58
  59    You have to surround all access to the RtsAPI with these calls.
  60    ------------------------------------------------------------------------- */
  61
  62 // acquires a token which may be used to create new objects and
  63 // evaluate them.
  64 Capability *rts_lock (void);
  65
  66 // releases the token acquired with rts_lock().
  67 void rts_unlock (Capability *token);
  68
  69 /* ----------------------------------------------------------------------------
  70    Building Haskell objects from C datatypes.
  71    ------------------------------------------------------------------------- */
  72 HaskellObj   rts_mkChar       ( Capability *, HsChar   c );
  73 HaskellObj   rts_mkInt        ( Capability *, HsInt    i );
  74 HaskellObj   rts_mkInt8       ( Capability *, HsInt8   i );
  75 HaskellObj   rts_mkInt16      ( Capability *, HsInt16  i );
  76 HaskellObj   rts_mkInt32      ( Capability *, HsInt32  i );
  77 HaskellObj   rts_mkInt64      ( Capability *, HsInt64  i );
  78 HaskellObj   rts_mkWord       ( Capability *, HsWord   w );
  79 HaskellObj   rts_mkWord8      ( Capability *, HsWord8  w );
  80 HaskellObj   rts_mkWord16     ( Capability *, HsWord16 w );
  81 HaskellObj   rts_mkWord32     ( Capability *, HsWord32 w );
  82 HaskellObj   rts_mkWord64     ( Capability *, HsWord64 w );
  83 HaskellObj   rts_mkPtr        ( Capability *, HsPtr    a );
  84 HaskellObj   rts_mkFunPtr     ( Capability *, HsFunPtr a );
  85 HaskellObj   rts_mkFloat      ( Capability *, HsFloat  f );
  86 HaskellObj   rts_mkDouble     ( Capability *, HsDouble f );
  87 HaskellObj   rts_mkStablePtr  ( Capability *, HsStablePtr s );
  88 HaskellObj   rts_mkBool       ( Capability *, HsBool   b );
  89 HaskellObj   rts_mkString     ( Capability *, char    *s );
  90
  91 HaskellObj   rts_apply        ( Capability *, HaskellObj, HaskellObj );
  92
  93 /* ----------------------------------------------------------------------------
  94    Deconstructing Haskell objects
  95    ------------------------------------------------------------------------- */
  96 HsChar       rts_getChar      ( HaskellObj );
  97 HsInt        rts_getInt       ( HaskellObj );
  98 HsInt8       rts_getInt8      ( HaskellObj );
  99 HsInt16      rts_getInt16     ( HaskellObj );
 100 HsInt32      rts_getInt32     ( HaskellObj );
 101 HsInt64      rts_getInt64     ( HaskellObj );
 102 HsWord       rts_getWord      ( HaskellObj );
 103 HsWord8      rts_getWord8     ( HaskellObj );
 104 HsWord16     rts_getWord16    ( HaskellObj );
 105 HsWord32     rts_getWord32    ( HaskellObj );
 106 HsWord64     rts_getWord64    ( HaskellObj );
 107 HsPtr        rts_getPtr       ( HaskellObj );
 108 HsFunPtr     rts_getFunPtr    ( HaskellObj );
 109 HsFloat      rts_getFloat     ( HaskellObj );
 110 HsDouble     rts_getDouble    ( HaskellObj );
 111 HsStablePtr  rts_getStablePtr ( HaskellObj );
 112 HsBool       rts_getBool      ( HaskellObj );
 113
 114 /* ----------------------------------------------------------------------------
 115    Evaluating Haskell expressions
 116
 117    The versions ending in '_' allow you to specify an initial stack size.
 118    Note that these calls may cause Garbage Collection, so all HaskellObj
 119    references are rendered invalid by these calls.
 120    ------------------------------------------------------------------------- */
 121 Capability *
 122 rts_eval (Capability *, HaskellObj p, /*out*/HaskellObj *ret);
 123
 124 Capability *
 125 rts_eval_ (Capability *, HaskellObj p, unsigned int stack_size,
 126            /*out*/HaskellObj *ret);
 127
 128 Capability *
 129 rts_evalIO (Capability *, HaskellObj p, /*out*/HaskellObj *ret);
 130
 131 Capability *
 132 rts_evalStableIO (Capability *, HsStablePtr s, /*out*/HsStablePtr *ret);
 133
 134 Capability *
 135 rts_evalLazyIO (Capability *, HaskellObj p, /*out*/HaskellObj *ret);
 136
 137 Capability *
 138 rts_evalLazyIO_ (Capability *, HaskellObj p, unsigned int stack_size,
 139                  /*out*/HaskellObj *ret);
 140
 141 void
 142 rts_checkSchedStatus (char* site, Capability *);
 143
 144 SchedulerStatus
 145 rts_getSchedStatus (Capability *cap);
 146
 147 /* --------------------------------------------------------------------------
 148    Wrapper closures
 149
 150    These are used by foreign export and foreign import "wrapper" stubs.
 151    ----------------------------------------------------------------------- */
 152
 153 extern StgWord base_GHCziTopHandler_runIO_closure[];
 154 extern StgWord base_GHCziTopHandler_runNonIO_closure[];
 155 #define runIO_closure             base_GHCziTopHandler_runIO_closure
 156 #define runNonIO_closure          base_GHCziTopHandler_runNonIO_closure
 157
 158 /* ------------------------------------------------------------------------ */
 159
 160 #ifdef __cplusplus
 161 }
 162 #endif
 163
 164 #endif /* RTSAPI_H */