ghc/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 } SchedulerStatus;
  27
  28 typedef StgClosure *HaskellObj;
  29
  30 /* ----------------------------------------------------------------------------
  31    Starting up and shutting down the Haskell RTS.
  32    ------------------------------------------------------------------------- */
  33 extern void startupHaskell         ( int argc, char *argv[],
  34                                      void (*init_root)(void) );
  35 extern void shutdownHaskell        ( void );
  36 extern void shutdownHaskellAndExit ( int exitCode );
  37 extern void getProgArgv            ( int *argc, char **argv[] );
  38 extern void setProgArgv            ( int argc, char *argv[] );
  39
  40
  41 /* ----------------------------------------------------------------------------
  42    Locking.
  43
  44    In a multithreaded environments, you have to surround all access to the
  45    RtsAPI with these calls.
  46    ------------------------------------------------------------------------- */
  47
  48 void
  49 rts_lock ( void );
  50
  51 void
  52 rts_unlock ( void );
  53
  54 /* ----------------------------------------------------------------------------
  55    Building Haskell objects from C datatypes.
  56    ------------------------------------------------------------------------- */
  57 HaskellObj   rts_mkChar       ( HsChar   c );
  58 HaskellObj   rts_mkInt        ( HsInt    i );
  59 HaskellObj   rts_mkInt8       ( HsInt8   i );
  60 HaskellObj   rts_mkInt16      ( HsInt16  i );
  61 HaskellObj   rts_mkInt32      ( HsInt32  i );
  62 HaskellObj   rts_mkInt64      ( HsInt64  i );
  63 HaskellObj   rts_mkWord       ( HsWord   w );
  64 HaskellObj   rts_mkWord8      ( HsWord8  w );
  65 HaskellObj   rts_mkWord16     ( HsWord16 w );
  66 HaskellObj   rts_mkWord32     ( HsWord32 w );
  67 HaskellObj   rts_mkWord64     ( HsWord64 w );
  68 HaskellObj   rts_mkPtr        ( HsPtr    a );
  69 HaskellObj   rts_mkFunPtr     ( HsFunPtr a );
  70 HaskellObj   rts_mkFloat      ( HsFloat  f );
  71 HaskellObj   rts_mkDouble     ( HsDouble f );
  72 HaskellObj   rts_mkStablePtr  ( HsStablePtr s );
  73 HaskellObj   rts_mkBool       ( HsBool   b );
  74 HaskellObj   rts_mkString     ( char    *s );
  75
  76 HaskellObj   rts_apply        ( HaskellObj, HaskellObj );
  77
  78 /* ----------------------------------------------------------------------------
  79    Deconstructing Haskell objects
  80    ------------------------------------------------------------------------- */
  81 HsChar       rts_getChar      ( HaskellObj );
  82 HsInt        rts_getInt       ( HaskellObj );
  83 HsInt8       rts_getInt8      ( HaskellObj );
  84 HsInt16      rts_getInt16     ( HaskellObj );
  85 HsInt32      rts_getInt32     ( HaskellObj );
  86 HsInt64      rts_getInt64     ( HaskellObj );
  87 HsWord       rts_getWord      ( HaskellObj );
  88 HsWord8      rts_getWord8     ( HaskellObj );
  89 HsWord16     rts_getWord16    ( HaskellObj );
  90 HsWord32     rts_getWord32    ( HaskellObj );
  91 HsWord64     rts_getWord64    ( HaskellObj );
  92 HsPtr        rts_getPtr       ( HaskellObj );
  93 HsFunPtr     rts_getFunPtr    ( HaskellObj );
  94 HsFloat      rts_getFloat     ( HaskellObj );
  95 HsDouble     rts_getDouble    ( HaskellObj );
  96 HsStablePtr  rts_getStablePtr ( HaskellObj );
  97 HsBool       rts_getBool      ( HaskellObj );
  98
  99 /* ----------------------------------------------------------------------------
 100    Evaluating Haskell expressions
 101
 102    The versions ending in '_' allow you to specify an initial stack size.
 103    Note that these calls may cause Garbage Collection, so all HaskellObj
 104    references are rendered invalid by these calls.
 105    ------------------------------------------------------------------------- */
 106 SchedulerStatus
 107 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
 108
 109 SchedulerStatus
 110 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 111
 112 SchedulerStatus
 113 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
 114
 115 SchedulerStatus
 116 rts_evalStableIO ( HsStablePtr s, /*out*/HsStablePtr *ret );
 117
 118 SchedulerStatus
 119 rts_evalLazyIO ( HaskellObj p, /*out*/HaskellObj *ret );
 120
 121 SchedulerStatus
 122 rts_evalLazyIO_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 123
 124 void
 125 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 126
 127 /* --------------------------------------------------------------------------
 128    Wrapper closures
 129
 130    These are used by foreign export and foreign import "wrapper" stubs.
 131    ----------------------------------------------------------------------- */
 132
 133 extern StgWord GHCziTopHandler_runIO_closure[];
 134 extern StgWord GHCziTopHandler_runNonIO_closure[];
 135 #define runIO_closure             GHCziTopHandler_runIO_closure
 136 #define runNonIO_closure          GHCziTopHandler_runNonIO_closure
 137
 138 /* ------------------------------------------------------------------------ */
 139
 140 #ifdef __cplusplus
 141 }
 142 #endif
 143
 144 #endif /* RTSAPI_H */