1 /* ----------------------------------------------------------------------------
2 * $Id: RtsAPI.h,v 1.32 2003/01/28 16:30:07 simonmar Exp $
4 * (c) The GHC Team, 1998-1999
6 * API for invoking Haskell functions via the RTS
8 * --------------------------------------------------------------------------*/
20 * Running the scheduler
23 NoStatus, /* not finished yet */
24 Success, /* completed successfully */
25 Killed, /* uncaught exception */
26 Interrupted /* stopped in response to a call to interruptStgRts */
29 typedef StgClosure *HaskellObj;
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 getProgArgv ( int *argc, char **argv[] );
41 /* ----------------------------------------------------------------------------
44 In a multithreaded environments, you have to surround all access to the
45 RtsAPI with these calls.
46 ------------------------------------------------------------------------- */
54 /* ----------------------------------------------------------------------------
55 Building Haskell objects from C datatypes.
56 ------------------------------------------------------------------------- */
57 HaskellObj rts_mkChar ( HsChar c );
58 HaskellObj rts_mkInt ( HsInt i );
59 HaskellObj rts_mkInt8 ( HsInt8 i );
60 HaskellObj rts_mkInt16 ( HsInt16 i );
61 HaskellObj rts_mkInt32 ( HsInt32 i );
62 HaskellObj rts_mkInt64 ( HsInt64 i );
63 HaskellObj rts_mkWord ( HsWord w );
64 HaskellObj rts_mkWord8 ( HsWord8 w );
65 HaskellObj rts_mkWord16 ( HsWord16 w );
66 HaskellObj rts_mkWord32 ( HsWord32 w );
67 HaskellObj rts_mkWord64 ( HsWord64 w );
68 HaskellObj rts_mkPtr ( HsPtr a );
69 HaskellObj rts_mkFloat ( HsFloat f );
70 HaskellObj rts_mkDouble ( HsDouble f );
71 HaskellObj rts_mkStablePtr ( HsStablePtr s );
72 HaskellObj rts_mkBool ( HsBool b );
73 HaskellObj rts_mkString ( char *s );
75 HaskellObj rts_apply ( HaskellObj, HaskellObj );
77 /* ----------------------------------------------------------------------------
78 Deconstructing Haskell objects
79 ------------------------------------------------------------------------- */
80 HsChar rts_getChar ( HaskellObj );
81 HsInt rts_getInt ( HaskellObj );
82 HsInt8 rts_getInt8 ( HaskellObj );
83 HsInt16 rts_getInt16 ( HaskellObj );
84 HsInt32 rts_getInt32 ( HaskellObj );
85 HsInt64 rts_getInt64 ( HaskellObj );
86 HsWord rts_getWord ( HaskellObj );
87 HsWord8 rts_getWord8 ( HaskellObj );
88 HsWord16 rts_getWord16 ( HaskellObj );
89 HsWord32 rts_getWord32 ( HaskellObj );
90 HsWord64 rts_getWord64 ( HaskellObj );
91 HsPtr rts_getPtr ( HaskellObj );
92 HsFloat rts_getFloat ( HaskellObj );
93 HsDouble rts_getDouble ( HaskellObj );
94 HsStablePtr rts_getStablePtr ( HaskellObj );
95 HsBool rts_getBool ( HaskellObj );
97 /* ----------------------------------------------------------------------------
98 Evaluating Haskell expressions
100 The versions ending in '_' allow you to specify an initial stack size.
101 Note that these calls may cause Garbage Collection, so all HaskellObj
102 references are rendered invalid by these calls.
103 ------------------------------------------------------------------------- */
105 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
108 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
111 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
113 #if defined(COMPILING_RTS_MAIN)
114 /* Used by the RTS' main() only */
116 rts_mainEvalIO ( HaskellObj p, /*out*/HaskellObj *ret );
120 rts_evalStableIO ( HsStablePtr s, /*out*/HsStablePtr *ret );
123 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
126 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
128 /* --------------------------------------------------------------------------
131 These are used by foreign export and foreign import "wrapper" stubs.
132 ----------------------------------------------------------------------- */
134 extern StgClosure GHCziTopHandler_runIO_closure;
135 extern StgClosure GHCziTopHandler_runNonIO_closure;
136 #define runIO_closure (&GHCziTopHandler_runIO_closure)
137 #define runNonIO_closure (&GHCziTopHandler_runNonIO_closure)
139 /* ------------------------------------------------------------------------ */
145 #endif /* RTSAPI_H */