ghc/includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: RtsAPI.h,v 1.26 2002/02/15 07:23:02 sof 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 /* DEPRECATED (use rts_mkPtr): */
  65 HaskellObj   rts_mkAddr       ( HsAddr   a );
  66
  67 /* ----------------------------------------------------------------------------
  68    Deconstructing Haskell objects
  69    ------------------------------------------------------------------------- */
  70 HsChar       rts_getChar      ( HaskellObj );
  71 HsInt        rts_getInt       ( HaskellObj );
  72 HsInt8       rts_getInt8      ( HaskellObj );
  73 HsInt16      rts_getInt16     ( HaskellObj );
  74 HsInt32      rts_getInt32     ( HaskellObj );
  75 HsInt64      rts_getInt64     ( HaskellObj );
  76 HsWord       rts_getWord      ( HaskellObj );
  77 HsWord8      rts_getWord8     ( HaskellObj );
  78 HsWord16     rts_getWord16    ( HaskellObj );
  79 HsWord32     rts_getWord32    ( HaskellObj );
  80 HsWord64     rts_getWord64    ( HaskellObj );
  81 HsPtr        rts_getPtr       ( HaskellObj );
  82 HsFloat      rts_getFloat     ( HaskellObj );
  83 HsDouble     rts_getDouble    ( HaskellObj );
  84 HsStablePtr  rts_getStablePtr ( HaskellObj );
  85 HsBool       rts_getBool      ( HaskellObj );
  86
  87 /* DEPRECATED (use rts_getPtr): */
  88 HsAddr       rts_getAddr      ( HaskellObj );
  89
  90 /* ----------------------------------------------------------------------------
  91    Evaluating Haskell expressions
  92
  93    The versions ending in '_' allow you to specify an initial stack size.
  94    ------------------------------------------------------------------------- */
  95 SchedulerStatus
  96 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
  97
  98 SchedulerStatus
  99 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 100
 101 SchedulerStatus
 102 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
 103
 104 #if defined(COMPILING_RTS_MAIN)
 105 /* Used by the RTS' main() only */
 106 SchedulerStatus
 107 rts_mainEvalIO ( HaskellObj p, /*out*/HaskellObj *ret );
 108 #endif
 109
 110 SchedulerStatus
 111 rts_evalStableIO ( HsStablePtr s, /*out*/HsStablePtr *ret );
 112
 113 SchedulerStatus
 114 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 115
 116 void
 117 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 118
 119 /* -------------------------------------------------------------------------- */
 120
 121 #ifdef __cplusplus
 122 }
 123 #endif
 124
 125 #endif /* RTSAPI_H */