473e21a69eef9cb3241873d5f2875b04cd5ce152
[ghc-hetmet.git] / ghc / includes / RtsExternal.h
1 /* -----------------------------------------------------------------------------
2  *
3  * (c) The GHC Team, 1998-2004
4  *
5  * Things visible externally to the RTS
6  *
7  * -------------------------------------------------------------------------- */
8
9 #ifndef RTSEXTERNAL_H
10 #define RTSEXTERNAL_H
11
12 /* The RTS public interface. */
13 #include "RtsAPI.h"
14
15 /* The standard FFI interface */
16 #include "HsFFI.h"
17
18 /* -----------------------------------------------------------------------------
19    Functions exported by the RTS for use in Stg code
20    -------------------------------------------------------------------------- */
21
22 #if IN_STG_CODE
23 extern void newCAF(void*);
24 #else
25 extern void newCAF(StgClosure*);
26 #endif
27
28 /* ToDo: remove? */
29 extern I_ genSymZh(void);
30 extern I_ resetGenSymZh(void);
31
32 /* Alternate to raise(3) for threaded rts, for OpenBSD */
33 extern int genericRaise(int sig);
34
35 /* Concurrency/Exception PrimOps. */
36 extern int cmp_thread(StgPtr tso1, StgPtr tso2);
37 extern int rts_getThreadId(StgPtr tso);
38 extern int forkOS_createThread ( HsStablePtr entry );
39 extern StgInt forkProcess(HsStablePtr *entry);
40 extern StgBool rtsSupportsBoundThreads(void);
41
42 /* grimy low-level support functions defined in StgPrimFloat.c */
43 extern StgDouble __encodeDouble (I_ size, StgByteArray arr, I_ e);
44 extern StgDouble __int_encodeDouble (I_ j, I_ e);
45 extern StgFloat  __encodeFloat (I_ size, StgByteArray arr, I_ e);
46 extern StgFloat  __int_encodeFloat (I_ j, I_ e);
47 extern StgInt    isDoubleNaN(StgDouble d);
48 extern StgInt    isDoubleInfinite(StgDouble d);
49 extern StgInt    isDoubleDenormalized(StgDouble d);
50 extern StgInt    isDoubleNegativeZero(StgDouble d);
51 extern StgInt    isFloatNaN(StgFloat f);
52 extern StgInt    isFloatInfinite(StgFloat f);
53 extern StgInt    isFloatDenormalized(StgFloat f);
54 extern StgInt    isFloatNegativeZero(StgFloat f);
55
56 /* Suspending/resuming threads around foreign calls */
57 extern StgInt        suspendThread ( StgRegTable * );
58 extern StgRegTable * resumeThread  ( StgInt );
59
60 /* Creating and destroying an adjustor thunk */
61 extern void*  createAdjustor(int cconv, StgStablePtr hptr, StgFunPtr wptr,
62                              char *typeString);
63 extern void   freeHaskellFunctionPtr(void* ptr);
64
65 #if defined(mingw32_HOST_OS)
66 extern int  rts_InstallConsoleEvent ( int action, StgStablePtr *handler );
67 extern void rts_ConsoleHandlerDone  ( int ev );
68 #else
69 extern int stg_sig_install (int, int, StgStablePtr *, void *);
70 #endif
71
72 extern void startSignalHandler(int sig);
73 extern void setIOManagerPipe (int fd);
74
75 extern void* stgMallocBytesRWX(int len);
76
77 /* -----------------------------------------------------------------------------
78    Storage manager stuff exported
79    -------------------------------------------------------------------------- */
80
81 /* Prototype for an evacuate-like function */
82 typedef void (*evac_fn)(StgClosure **);
83
84 extern void performGC(void);
85 extern void performMajorGC(void);
86 extern void performGCWithRoots(void (*get_roots)(evac_fn));
87 extern HsInt64 getAllocations( void );
88 extern void revertCAFs( void );
89
90 #endif /*  RTSEXTERNAL_H */