1 /* ----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2004
5 * API for invoking Haskell functions via the RTS
7 * --------------------------------------------------------------------------*/
19 * Running the scheduler
22 NoStatus, /* not finished yet */
23 Success, /* completed successfully */
24 Killed, /* uncaught exception */
25 Interrupted /* stopped in response to a call to interruptStgRts */
28 typedef StgClosure *HaskellObj;
31 * An abstract type representing the token returned by rts_lock() and
32 * used when allocating objects and threads in the RTS.
34 typedef struct Capability_ Capability;
36 /* ----------------------------------------------------------------------------
37 Starting up and shutting down the Haskell RTS.
38 ------------------------------------------------------------------------- */
39 extern void startupHaskell ( int argc, char *argv[],
40 void (*init_root)(void) );
41 extern void shutdownHaskell ( void );
42 extern void shutdownHaskellAndExit ( int exitCode );
43 extern void getProgArgv ( int *argc, char **argv[] );
44 extern void setProgArgv ( int argc, char *argv[] );
47 /* ----------------------------------------------------------------------------
50 You have to surround all access to the RtsAPI with these calls.
51 ------------------------------------------------------------------------- */
53 // acquires a token which may be used to create new objects and
55 Capability *rts_lock (void);
57 // releases the token acquired with rts_lock().
58 void rts_unlock (Capability *token);
60 /* ----------------------------------------------------------------------------
61 Building Haskell objects from C datatypes.
62 ------------------------------------------------------------------------- */
63 HaskellObj rts_mkChar ( Capability *, HsChar c );
64 HaskellObj rts_mkInt ( Capability *, HsInt i );
65 HaskellObj rts_mkInt8 ( Capability *, HsInt8 i );
66 HaskellObj rts_mkInt16 ( Capability *, HsInt16 i );
67 HaskellObj rts_mkInt32 ( Capability *, HsInt32 i );
68 HaskellObj rts_mkInt64 ( Capability *, HsInt64 i );
69 HaskellObj rts_mkWord ( Capability *, HsWord w );
70 HaskellObj rts_mkWord8 ( Capability *, HsWord8 w );
71 HaskellObj rts_mkWord16 ( Capability *, HsWord16 w );
72 HaskellObj rts_mkWord32 ( Capability *, HsWord32 w );
73 HaskellObj rts_mkWord64 ( Capability *, HsWord64 w );
74 HaskellObj rts_mkPtr ( Capability *, HsPtr a );
75 HaskellObj rts_mkFunPtr ( Capability *, HsFunPtr a );
76 HaskellObj rts_mkFloat ( Capability *, HsFloat f );
77 HaskellObj rts_mkDouble ( Capability *, HsDouble f );
78 HaskellObj rts_mkStablePtr ( Capability *, HsStablePtr s );
79 HaskellObj rts_mkBool ( Capability *, HsBool b );
80 HaskellObj rts_mkString ( Capability *, char *s );
82 HaskellObj rts_apply ( Capability *, HaskellObj, HaskellObj );
84 /* ----------------------------------------------------------------------------
85 Deconstructing Haskell objects
86 ------------------------------------------------------------------------- */
87 HsChar rts_getChar ( HaskellObj );
88 HsInt rts_getInt ( HaskellObj );
89 HsInt8 rts_getInt8 ( HaskellObj );
90 HsInt16 rts_getInt16 ( HaskellObj );
91 HsInt32 rts_getInt32 ( HaskellObj );
92 HsInt64 rts_getInt64 ( HaskellObj );
93 HsWord rts_getWord ( HaskellObj );
94 HsWord8 rts_getWord8 ( HaskellObj );
95 HsWord16 rts_getWord16 ( HaskellObj );
96 HsWord32 rts_getWord32 ( HaskellObj );
97 HsWord64 rts_getWord64 ( HaskellObj );
98 HsPtr rts_getPtr ( HaskellObj );
99 HsFunPtr rts_getFunPtr ( HaskellObj );
100 HsFloat rts_getFloat ( HaskellObj );
101 HsDouble rts_getDouble ( HaskellObj );
102 HsStablePtr rts_getStablePtr ( HaskellObj );
103 HsBool rts_getBool ( HaskellObj );
105 /* ----------------------------------------------------------------------------
106 Evaluating Haskell expressions
108 The versions ending in '_' allow you to specify an initial stack size.
109 Note that these calls may cause Garbage Collection, so all HaskellObj
110 references are rendered invalid by these calls.
111 ------------------------------------------------------------------------- */
113 rts_eval (Capability *, HaskellObj p, /*out*/HaskellObj *ret);
116 rts_eval_ (Capability *, HaskellObj p, unsigned int stack_size,
117 /*out*/HaskellObj *ret);
120 rts_evalIO (Capability *, HaskellObj p, /*out*/HaskellObj *ret);
123 rts_evalStableIO (Capability *, HsStablePtr s, /*out*/HsStablePtr *ret);
126 rts_evalLazyIO (Capability *, HaskellObj p, /*out*/HaskellObj *ret);
129 rts_evalLazyIO_ (Capability *, HaskellObj p, unsigned int stack_size,
130 /*out*/HaskellObj *ret);
133 rts_checkSchedStatus (char* site, Capability *);
136 rts_getSchedStatus (Capability *cap);
138 /* --------------------------------------------------------------------------
141 These are used by foreign export and foreign import "wrapper" stubs.
142 ----------------------------------------------------------------------- */
144 extern StgWord GHCziTopHandler_runIO_closure[];
145 extern StgWord GHCziTopHandler_runNonIO_closure[];
146 #define runIO_closure GHCziTopHandler_runIO_closure
147 #define runNonIO_closure GHCziTopHandler_runNonIO_closure
149 /* ------------------------------------------------------------------------ */
155 #endif /* RTSAPI_H */