1 /* ----------------------------------------------------------------------------
2 * $Id: RtsAPI.h,v 1.24 2001/10/29 11:33:37 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 */
27 Deadlock /* no threads to run, but main thread hasn't finished */
30 typedef StgClosure *HaskellObj;
32 /* ----------------------------------------------------------------------------
33 Starting up and shutting down the Haskell RTS.
34 ------------------------------------------------------------------------- */
35 extern void startupHaskell ( int argc, char *argv[],
36 void (*init_root)(void) );
37 extern void shutdownHaskell ( void );
38 extern void shutdownHaskellAndExit ( int exitCode );
39 extern void setProgArgv ( int argc, char *argv[] );
40 extern void getProgArgv ( int *argc, char **argv[] );
42 /* ----------------------------------------------------------------------------
43 Building Haskell objects from C datatypes.
44 ------------------------------------------------------------------------- */
45 HaskellObj rts_mkChar ( HsChar c );
46 HaskellObj rts_mkInt ( HsInt i );
47 HaskellObj rts_mkInt8 ( HsInt8 i );
48 HaskellObj rts_mkInt16 ( HsInt16 i );
49 HaskellObj rts_mkInt32 ( HsInt32 i );
50 HaskellObj rts_mkInt64 ( HsInt64 i );
51 HaskellObj rts_mkWord ( HsWord w );
52 HaskellObj rts_mkWord8 ( HsWord8 w );
53 HaskellObj rts_mkWord16 ( HsWord16 w );
54 HaskellObj rts_mkWord32 ( HsWord32 w );
55 HaskellObj rts_mkWord64 ( HsWord64 w );
56 HaskellObj rts_mkPtr ( HsPtr a );
57 HaskellObj rts_mkFloat ( HsFloat f );
58 HaskellObj rts_mkDouble ( HsDouble f );
59 HaskellObj rts_mkStablePtr ( HsStablePtr s );
60 HaskellObj rts_mkBool ( HsBool b );
61 HaskellObj rts_mkString ( char *s );
63 HaskellObj rts_apply ( HaskellObj, HaskellObj );
65 /* DEPRECATED (use rts_mkPtr): */
66 HaskellObj rts_mkAddr ( HsAddr a );
68 /* ----------------------------------------------------------------------------
69 Deconstructing Haskell objects
70 ------------------------------------------------------------------------- */
71 HsChar rts_getChar ( HaskellObj );
72 HsInt rts_getInt ( HaskellObj );
73 HsInt8 rts_getInt8 ( HaskellObj );
74 HsInt16 rts_getInt16 ( HaskellObj );
75 HsInt32 rts_getInt32 ( HaskellObj );
76 HsInt64 rts_getInt64 ( HaskellObj );
77 HsWord rts_getWord ( HaskellObj );
78 HsWord8 rts_getWord8 ( HaskellObj );
79 HsWord16 rts_getWord16 ( HaskellObj );
80 HsWord32 rts_getWord32 ( HaskellObj );
81 HsWord64 rts_getWord64 ( HaskellObj );
82 HsPtr rts_getPtr ( HaskellObj );
83 HsFloat rts_getFloat ( HaskellObj );
84 HsDouble rts_getDouble ( HaskellObj );
85 HsStablePtr rts_getStablePtr ( HaskellObj );
86 HsBool rts_getBool ( HaskellObj );
88 /* DEPRECATED (use rts_getPtr): */
89 HsAddr rts_getAddr ( HaskellObj );
91 /* ----------------------------------------------------------------------------
92 Evaluating Haskell expressions
94 The versions ending in '_' allow you to specify an initial stack size.
95 ------------------------------------------------------------------------- */
97 rts_eval ( HaskellObj p, /*out*/HaskellObj *ret );
100 rts_eval_ ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
103 rts_evalIO ( HaskellObj p, /*out*/HaskellObj *ret );
106 rts_evalStableIO ( HsStablePtr s, /*out*/HsStablePtr *ret );
109 rts_evalLazyIO ( HaskellObj p, unsigned int stack_size, /*out*/HaskellObj *ret );
112 rts_checkSchedStatus ( char* site, SchedulerStatus rc);
114 /* -------------------------------------------------------------------------- */
120 #endif /* RTSAPI_H */