ghc/includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: RtsAPI.h,v 1.19 2001/01/11 17:25:56 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 #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[], void *init_root );
  32 extern void shutdownHaskell        ( void );
  33 extern void shutdownHaskellAndExit ( int exitCode );
  34 extern void setProgArgv            ( int argc, char *argv[] );
  35 extern void getProgArgv            ( int *argc, char **argv[] );
  36
  37 /* ----------------------------------------------------------------------------
  38    Building Haskell objects from C datatypes.
  39    ------------------------------------------------------------------------- */
  40 HaskellObj   rts_mkChar       ( HsChar   c );
  41 HaskellObj   rts_mkInt        ( HsInt    i );
  42 HaskellObj   rts_mkInt8       ( HsInt8   i );
  43 HaskellObj   rts_mkInt16      ( HsInt16  i );
  44 HaskellObj   rts_mkInt32      ( HsInt32  i );
  45 HaskellObj   rts_mkInt64      ( HsInt64  i );
  46 HaskellObj   rts_mkWord       ( HsWord   w );
  47 HaskellObj   rts_mkWord8      ( HsWord8  w );
  48 HaskellObj   rts_mkWord16     ( HsWord16 w );
  49 HaskellObj   rts_mkWord32     ( HsWord32 w );
  50 HaskellObj   rts_mkWord64     ( HsWord64 w );
  51 HaskellObj   rts_mkPtr        ( HsPtr    a );
  52 HaskellObj   rts_mkFloat      ( HsFloat  f );
  53 HaskellObj   rts_mkDouble     ( HsDouble f );
  54 HaskellObj   rts_mkStablePtr  ( HsStablePtr s );
  55 HaskellObj   rts_mkBool       ( HsBool   b );
  56 HaskellObj   rts_mkString     ( char    *s );
  57
  58 HaskellObj   rts_apply        ( HaskellObj, HaskellObj );
  59
  60 /* DEPRECATED (use rts_mkPtr): */
  61 HaskellObj   rts_mkAddr       ( HsAddr   a );
  62
  63 /* ----------------------------------------------------------------------------
  64    Deconstructing Haskell objects
  65    ------------------------------------------------------------------------- */
  66 HsChar       rts_getChar      ( HaskellObj );
  67 HsInt        rts_getInt       ( HaskellObj );
  68 HsInt32      rts_getInt32     ( HaskellObj );
  69 HsWord       rts_getWord      ( HaskellObj );
  70 HsWord32     rts_getWord32    ( HaskellObj );
  71 HsPtr        rts_getPtr       ( HaskellObj );
  72 HsFloat      rts_getFloat     ( HaskellObj );
  73 HsDouble     rts_getDouble    ( HaskellObj );
  74 HsStablePtr  rts_getStablePtr ( HaskellObj );
  75 HsBool       rts_getBool      ( HaskellObj );
  76
  77 /* DEPRECATED (use rts_getPtr): */
  78 HsAddr       rts_getAddr      ( HaskellObj );
  79
  80 /* ----------------------------------------------------------------------------
  81    Evaluating Haskell expressions
  82
  83    The versions ending in '_' allow you to specify an initial stack size.
  84    ------------------------------------------------------------------------- */
  85 SchedulerStatus
  86 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
  87
  88 SchedulerStatus
  89 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
  90
  91 SchedulerStatus
  92 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
  93
  94 SchedulerStatus
  95 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
  96
  97 #if defined(PAR) || defined(SMP)
  98 SchedulerStatus
  99 rts_evalNothing(unsigned int stack_size);
 100 #endif
 101
 102 void
 103 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 104
 105 #endif /* RTSAPI_H */