ghc/includes/RtsAPI.h

   1 /* ----------------------------------------------------------------------------
   2  * $Id: RtsAPI.h,v 1.17 2000/08/29 13:34:21 qrczak 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 /*
  14  * Running the scheduler
  15  */
  16 typedef enum {
  17     NoStatus,    /* not finished yet */
  18     Success,     /* completed successfully */
  19     Killed,      /* uncaught exception */
  20     Interrupted, /* stopped in response to a call to interruptStgRts */
  21     Deadlock     /* no threads to run, but main thread hasn't finished */
  22 } SchedulerStatus;
  23
  24 typedef StgClosure *HaskellObj;
  25
  26
  27 /* Make this compilable with Visual C++.  We can't just use StgInt64 here,
  28  * because this file should be compilable without reference to the rest
  29  * of the RTS machinery.  These are absolutely non-standard types, but
  30  * I don't know what alternatives are safe if we don't #include anything
  31  * here.
  32  */
  33 #if defined(__MSVC__)
  34 typedef __int64            HsInt64_;
  35 typedef unsigned __int64   HsWord64_;
  36 #else
  37 typedef long long          HsInt64_;
  38 typedef unsigned long long HsWord64_;
  39 #endif
  40
  41 /* ----------------------------------------------------------------------------
  42    Starting up and shutting down the Haskell RTS.
  43    ------------------------------------------------------------------------- */
  44 extern void startupHaskell         ( int argc, char *argv[], void *init_root );
  45 extern void shutdownHaskell        ( void );
  46 extern void shutdownHaskellAndExit ( int exitCode );
  47 extern void setProgArgv            ( int argc, char *argv[] );
  48 extern void getProgArgv            ( int *argc, char **argv[] );
  49
  50 /* ----------------------------------------------------------------------------
  51    Building Haskell objects from C datatypes.
  52    ------------------------------------------------------------------------- */
  53 HaskellObj   rts_mkChar       ( unsigned int c );
  54 HaskellObj   rts_mkInt        ( int i );
  55 HaskellObj   rts_mkInt8       ( int i );
  56 HaskellObj   rts_mkInt16      ( int i );
  57 HaskellObj   rts_mkInt32      ( int i );
  58 HaskellObj   rts_mkWord       ( unsigned int w );
  59 HaskellObj   rts_mkWord8      ( unsigned int w );
  60 HaskellObj   rts_mkWord16     ( unsigned int w );
  61 HaskellObj   rts_mkWord32     ( unsigned int w );
  62 HaskellObj   rts_mkInt64      ( HsInt64_ i );
  63 HaskellObj   rts_mkWord64     ( HsWord64_ w );
  64 HaskellObj   rts_mkFloat      ( float f );
  65 HaskellObj   rts_mkDouble     ( double f );
  66 HaskellObj   rts_mkStablePtr  ( StgStablePtr s );
  67 HaskellObj   rts_mkAddr       ( void *a );
  68 HaskellObj   rts_mkBool       ( int b );
  69 HaskellObj   rts_mkString     ( char *s );
  70
  71 HaskellObj   rts_apply        ( HaskellObj, HaskellObj );
  72
  73 /* ----------------------------------------------------------------------------
  74    Deconstructing Haskell objects
  75    ------------------------------------------------------------------------- */
  76 unsigned int rts_getChar      ( HaskellObj );
  77 int          rts_getInt       ( HaskellObj );
  78 int          rts_getInt32     ( HaskellObj );
  79 unsigned int rts_getWord      ( HaskellObj );
  80 unsigned int rts_getWord32    ( HaskellObj );
  81 float        rts_getFloat     ( HaskellObj );
  82 double       rts_getDouble    ( HaskellObj );
  83 StgStablePtr rts_getStablePtr ( HaskellObj );
  84 void *       rts_getAddr      ( HaskellObj );
  85 int          rts_getBool      ( 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 #if defined(PAR) || defined(SMP)
 105 SchedulerStatus
 106 rts_evalNothing(unsigned int stack_size);
 107 #endif
 108
 109 void
 110 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
 111
 112 #endif /* RTSAPI_H */