ghc/includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: RtsAPI.h,v 1.30 2002/09/05 08:58:55 simonmar Exp $
   3  *
   4  * (c) The GHC Team, 1998-1999
   5  *
   6  * API for invoking Haskell functions via the RTS
   7  *
   8  * --------------------------------------------------------------------------*/
   9
  10 #ifndef RTSAPI_H
  11 #define RTSAPI_H
  12
  13 #ifdef __cplusplus
  14 extern "C" {
  15 #endif
  16
  17 #include "HsFFI.h"
  18
  19 /*
  20  * Running the scheduler
  21  */
  22 typedef enum {
  23     NoStatus,    /* not finished yet */
  24     Success,     /* completed successfully */
  25     Killed,      /* uncaught exception */
  26     Interrupted  /* stopped in response to a call to interruptStgRts */
  27 } SchedulerStatus;
  28
  29 typedef StgClosure *HaskellObj;
  30
  31 /* ----------------------------------------------------------------------------
  32    Starting up and shutting down the Haskell RTS.
  33    ------------------------------------------------------------------------- */
  34 extern void startupHaskell         ( int argc, char *argv[],
  35                                      void (*init_root)(void) );
  36 extern void shutdownHaskell        ( void );
  37 extern void shutdownHaskellAndExit ( int exitCode );
  38 extern void setProgArgv            ( int argc, char *argv[] );
  39 extern void getProgArgv            ( int *argc, char **argv[] );
  40
  41 /* ----------------------------------------------------------------------------
  42    Building Haskell objects from C datatypes.
  43    ------------------------------------------------------------------------- */
  44 HaskellObj   rts_mkChar       ( HsChar   c );
  45 HaskellObj   rts_mkInt        ( HsInt    i );
  46 HaskellObj   rts_mkInt8       ( HsInt8   i );
  47 HaskellObj   rts_mkInt16      ( HsInt16  i );
  48 HaskellObj   rts_mkInt32      ( HsInt32  i );
  49 HaskellObj   rts_mkInt64      ( HsInt64  i );
  50 HaskellObj   rts_mkWord       ( HsWord   w );
  51 HaskellObj   rts_mkWord8      ( HsWord8  w );
  52 HaskellObj   rts_mkWord16     ( HsWord16 w );
  53 HaskellObj   rts_mkWord32     ( HsWord32 w );
  54 HaskellObj   rts_mkWord64     ( HsWord64 w );
  55 HaskellObj   rts_mkPtr        ( HsPtr    a );
  56 HaskellObj   rts_mkFloat      ( HsFloat  f );
  57 HaskellObj   rts_mkDouble     ( HsDouble f );
  58 HaskellObj   rts_mkStablePtr  ( HsStablePtr s );
  59 HaskellObj   rts_mkBool       ( HsBool   b );
  60 HaskellObj   rts_mkString     ( char    *s );
  61
  62 HaskellObj   rts_apply        ( HaskellObj, HaskellObj );
  63
  64 /* ----------------------------------------------------------------------------
  65    Deconstructing Haskell objects
  66    ------------------------------------------------------------------------- */
  67 HsChar       rts_getChar      ( HaskellObj );
  68 HsInt        rts_getInt       ( HaskellObj );
  69 HsInt8       rts_getInt8      ( HaskellObj );
  70 HsInt16      rts_getInt16     ( HaskellObj );
  71 HsInt32      rts_getInt32     ( HaskellObj );
  72 HsInt64      rts_getInt64     ( HaskellObj );
  73 HsWord       rts_getWord      ( HaskellObj );
  74 HsWord8      rts_getWord8     ( HaskellObj );
  75 HsWord16     rts_getWord16    ( HaskellObj );
  76 HsWord32     rts_getWord32    ( HaskellObj );
  77 HsWord64     rts_getWord64    ( HaskellObj );
  78 HsPtr        rts_getPtr       ( HaskellObj );
  79 HsFloat      rts_getFloat     ( HaskellObj );
  80 HsDouble     rts_getDouble    ( HaskellObj );
  81 HsStablePtr  rts_getStablePtr ( HaskellObj );
  82 HsBool       rts_getBool      ( HaskellObj );
  83
  84 /* ----------------------------------------------------------------------------
  85    Evaluating Haskell expressions
  86
  87    The versions ending in '_' allow you to specify an initial stack size.
  88    ------------------------------------------------------------------------- */
  89 SchedulerStatus
  90 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
  91
  92 SchedulerStatus
  93 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
  94
  95 SchedulerStatus
  96 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
  97
  98 #if defined(COMPILING_RTS_MAIN)
  99 /* Used by the RTS' main() only */
 100 SchedulerStatus
 101 rts_mainEvalIO ( HaskellObj p, /*out*/HaskellObj *ret );
 102 #endif
 103
 104 SchedulerStatus
 105 rts_evalStableIO ( HsStablePtr s, /*out*/HsStablePtr *ret );
 106
 107 SchedulerStatus
 108 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 109
 110 void
 111 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 112
 113 /* --------------------------------------------------------------------------
 114    Wrapper closures
 115
 116    These are used by foreign export and foreign import "wrapper" stubs.
 117    ----------------------------------------------------------------------- */
 118
 119 extern StgClosure GHCziTopHandler_runIO_closure;
 120 extern StgClosure GHCziTopHandler_runNonIO_closure;
 121 #define runIO_closure             (&GHCziTopHandler_runIO_closure)
 122 #define runNonIO_closure          (&GHCziTopHandler_runNonIO_closure)
 123
 124 /* ------------------------------------------------------------------------ */
 125
 126 #ifdef __cplusplus
 127 }
 128 #endif
 129
 130 #endif /* RTSAPI_H */