ghc/includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: RtsAPI.h,v 1.22 2001/08/03 16:30:13 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 #include "HsFFI.h"
  14
  15 /*
  16  * Running the scheduler
  17  */
  18 typedef enum {
  19     NoStatus,    /* not finished yet */
  20     Success,     /* completed successfully */
  21     Killed,      /* uncaught exception */
  22     Interrupted, /* stopped in response to a call to interruptStgRts */
  23     Deadlock     /* no threads to run, but main thread hasn't finished */
  24 } SchedulerStatus;
  25
  26 typedef StgClosure *HaskellObj;
  27
  28 /* ----------------------------------------------------------------------------
  29    Starting up and shutting down the Haskell RTS.
  30    ------------------------------------------------------------------------- */
  31 extern void startupHaskell         ( int argc, char *argv[],
  32                                      void (*init_root)(void) );
  33 extern void shutdownHaskell        ( void );
  34 extern void shutdownHaskellAndExit ( int exitCode );
  35 extern void setProgArgv            ( int argc, char *argv[] );
  36 extern void getProgArgv            ( int *argc, char **argv[] );
  37
  38 /* ----------------------------------------------------------------------------
  39    Building Haskell objects from C datatypes.
  40    ------------------------------------------------------------------------- */
  41 HaskellObj   rts_mkChar       ( HsChar   c );
  42 HaskellObj   rts_mkInt        ( HsInt    i );
  43 HaskellObj   rts_mkInt8       ( HsInt8   i );
  44 HaskellObj   rts_mkInt16      ( HsInt16  i );
  45 HaskellObj   rts_mkInt32      ( HsInt32  i );
  46 HaskellObj   rts_mkInt64      ( HsInt64  i );
  47 HaskellObj   rts_mkWord       ( HsWord   w );
  48 HaskellObj   rts_mkWord8      ( HsWord8  w );
  49 HaskellObj   rts_mkWord16     ( HsWord16 w );
  50 HaskellObj   rts_mkWord32     ( HsWord32 w );
  51 HaskellObj   rts_mkWord64     ( HsWord64 w );
  52 HaskellObj   rts_mkPtr        ( HsPtr    a );
  53 HaskellObj   rts_mkFloat      ( HsFloat  f );
  54 HaskellObj   rts_mkDouble     ( HsDouble f );
  55 HaskellObj   rts_mkStablePtr  ( HsStablePtr s );
  56 HaskellObj   rts_mkBool       ( HsBool   b );
  57 HaskellObj   rts_mkString     ( char    *s );
  58
  59 HaskellObj   rts_apply        ( HaskellObj, HaskellObj );
  60
  61 /* DEPRECATED (use rts_mkPtr): */
  62 HaskellObj   rts_mkAddr       ( HsAddr   a );
  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 /* DEPRECATED (use rts_getPtr): */
  85 HsAddr       rts_getAddr      ( HaskellObj );
  86
  87 /* ----------------------------------------------------------------------------
  88    Evaluating Haskell expressions
  89
  90    The versions ending in '_' allow you to specify an initial stack size.
  91    ------------------------------------------------------------------------- */
  92 SchedulerStatus
  93 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
  94
  95 SchedulerStatus
  96 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
  97
  98 SchedulerStatus
  99 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
 100
 101 SchedulerStatus
 102 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 103
 104 void
 105 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 106
 107 #endif /* RTSAPI_H */