ghc/includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: RtsAPI.h,v 1.14 2000/06/15 13:16:16 daan 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 /* Make this compilable with Visual C++ */
  14 #ifndef HAVE_INT64
  15 #define HAVE_INT64
  16 #ifdef _MSC_VER
  17 typedef __int64            int64;
  18 typedef unsigned __int64   nat64;
  19 #else
  20 typedef long long          int64;
  21 typedef unsigned long long nat64;
  22 #endif
  23 #endif
  24
  25 /*
  26  * Running the scheduler
  27  */
  28 typedef enum {
  29     NoStatus,    /* not finished yet */
  30     Success,     /* completed successfully */
  31     Killed,      /* uncaught exception */
  32     Interrupted, /* stopped in response to a call to interruptStgRts */
  33     Deadlock     /* no threads to run, but main thread hasn't finished */
  34 } SchedulerStatus;
  35
  36 typedef StgClosure *HaskellObj;
  37
  38 /* ----------------------------------------------------------------------------
  39    Starting up and shutting down the Haskell RTS.
  40    ------------------------------------------------------------------------- */
  41 extern void startupHaskell         ( int argc, char *argv[], void *init_root );
  42 extern void shutdownHaskell        ( void );
  43 extern void shutdownHaskellAndExit ( int exitCode );
  44 extern void setProgArgv            ( int argc, char *argv[] );
  45 extern void getProgArgv            ( int *argc, char **argv[] );
  46
  47 /* ----------------------------------------------------------------------------
  48    Building Haskell objects from C datatypes.
  49    ------------------------------------------------------------------------- */
  50 HaskellObj   rts_mkChar       ( char c );
  51 HaskellObj   rts_mkInt        ( int i );
  52 HaskellObj   rts_mkInt8       ( int i );
  53 HaskellObj   rts_mkInt16      ( int i );
  54 HaskellObj   rts_mkInt32      ( int i );
  55 HaskellObj   rts_mkInt64      ( int64 i );
  56 HaskellObj   rts_mkWord       ( unsigned int w );
  57 HaskellObj   rts_mkWord8      ( unsigned int w );
  58 HaskellObj   rts_mkWord16     ( unsigned int w );
  59 HaskellObj   rts_mkWord32     ( unsigned int w );
  60 HaskellObj   rts_mkWord64     ( nat64 w );
  61 HaskellObj   rts_mkFloat      ( float f );
  62 HaskellObj   rts_mkDouble     ( double f );
  63 HaskellObj   rts_mkStablePtr  ( StgStablePtr s );
  64 HaskellObj   rts_mkAddr       ( void *a );
  65 HaskellObj   rts_mkBool       ( int b );
  66 HaskellObj   rts_mkString     ( char *s );
  67
  68 HaskellObj   rts_apply        ( HaskellObj, HaskellObj );
  69
  70 /* ----------------------------------------------------------------------------
  71    Deconstructing Haskell objects
  72    ------------------------------------------------------------------------- */
  73 char         rts_getChar      ( HaskellObj );
  74 int          rts_getInt       ( HaskellObj );
  75 int          rts_getInt32     ( HaskellObj );
  76 unsigned int rts_getWord      ( HaskellObj );
  77 unsigned int rts_getWord32    ( HaskellObj );
  78 float        rts_getFloat     ( HaskellObj );
  79 double       rts_getDouble    ( HaskellObj );
  80 StgStablePtr rts_getStablePtr ( HaskellObj );
  81 void *       rts_getAddr      ( HaskellObj );
  82 int          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 SchedulerStatus
  99 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
 100
 101 #if defined(PAR) || defined(SMP)
 102 SchedulerStatus
 103 rts_evalNothing(unsigned int stack_size);
 104 #endif
 105
 106 void
 107 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 108
 109 #endif /* RTSAPI_H */