1 /* ----------------------------------------------------------------------------
3 * (c) The GHC Team, 1998-2009
5 * Declarations for various symbols exported by the RTS.
7 * ToDo: many of the symbols in here don't need to be exported, but
8 * our Cmm code generator doesn't know how to generate local symbols
9 * for the RTS bits (it assumes all RTS symbols are external).
11 * See wiki:Commentary/Compiler/Backends/PprC#Prototypes
13 * Do not #include this file directly: #include "Rts.h" instead.
15 * To understand the structure of the RTS headers, see the wiki:
16 * http://hackage.haskell.org/trac/ghc/wiki/Commentary/SourceTree/Includes
18 * --------------------------------------------------------------------------*/
20 #ifndef STGMISCCLOSURES_H
21 #define STGMISCCLOSURES_H
24 # define RTS_RET_INFO(i) extern W_(i)[]
25 # define RTS_FUN_INFO(i) extern W_(i)[]
26 # define RTS_THUNK_INFO(i) extern W_(i)[]
27 # define RTS_INFO(i) extern W_(i)[]
28 # define RTS_CLOSURE(i) extern W_(i)[]
29 # define RTS_FUN_DECL(f) extern DLL_IMPORT_RTS StgFunPtr f(void)
31 # define RTS_RET_INFO(i) extern DLL_IMPORT_RTS const StgRetInfoTable i
32 # define RTS_FUN_INFO(i) extern DLL_IMPORT_RTS const StgFunInfoTable i
33 # define RTS_THUNK_INFO(i) extern DLL_IMPORT_RTS const StgThunkInfoTable i
34 # define RTS_INFO(i) extern DLL_IMPORT_RTS const StgInfoTable i
35 # define RTS_CLOSURE(i) extern DLL_IMPORT_RTS StgClosure i
36 # define RTS_FUN_DECL(f) extern DLL_IMPORT_RTS StgFunPtr f(void)
39 #ifdef TABLES_NEXT_TO_CODE
40 # define RTS_RET(f) RTS_INFO(f##_info)
41 # define RTS_ENTRY(f) RTS_INFO(f##_info)
42 # define RTS_FUN(f) RTS_FUN_INFO(f##_info)
43 # define RTS_THUNK(f) RTS_THUNK_INFO(f##_info)
45 # define RTS_RET(f) RTS_INFO(f##_info); RTS_FUN_DECL(f##_ret)
46 # define RTS_ENTRY(f) RTS_INFO(f##_info); RTS_FUN_DECL(f##_entry)
47 # define RTS_FUN(f) RTS_FUN_INFO(f##_info); RTS_FUN_DECL(f##_entry)
48 # define RTS_THUNK(f) RTS_THUNK_INFO(f##_info); RTS_FUN_DECL(f##_entry)
52 RTS_RET(stg_upd_frame);
53 RTS_RET(stg_bh_upd_frame);
54 RTS_RET(stg_marked_upd_frame);
55 RTS_RET(stg_noupd_frame);
56 RTS_RET(stg_catch_frame);
57 RTS_RET(stg_catch_retry_frame);
58 RTS_RET(stg_atomically_frame);
59 RTS_RET(stg_atomically_waiting_frame);
60 RTS_RET(stg_catch_stm_frame);
61 RTS_RET(stg_unblockAsyncExceptionszh_ret);
63 // RTS_FUN(stg_interp_constr_entry);
65 // This is referenced using the FFI in the compiler (ByteCodeItbls),
66 // so we can't give it the correct type here because the prototypes
67 // would clash (FFI references are always declared with type StgWord[]
68 // in the generated C code).
70 /* Magic glue code for when compiled code returns a value in R1/F1/D1
71 or a VoidRep to the interpreter. */
72 RTS_RET(stg_ctoi_R1p);
73 RTS_RET(stg_ctoi_R1unpt);
74 RTS_RET(stg_ctoi_R1n);
80 RTS_RET(stg_apply_interp);
83 RTS_ENTRY(stg_IND_direct);
84 RTS_ENTRY(stg_IND_STATIC);
85 RTS_ENTRY(stg_IND_PERM);
86 RTS_ENTRY(stg_BLACKHOLE);
87 RTS_ENTRY(stg_CAF_BLACKHOLE);
88 RTS_ENTRY(__stg_EAGER_BLACKHOLE);
89 RTS_ENTRY(stg_WHITEHOLE);
90 RTS_ENTRY(stg_BLOCKING_QUEUE_CLEAN);
91 RTS_ENTRY(stg_BLOCKING_QUEUE_DIRTY);
94 RTS_ENTRY(stg_EVACUATED);
96 RTS_ENTRY(stg_DEAD_WEAK);
97 RTS_ENTRY(stg_STABLE_NAME);
98 RTS_ENTRY(stg_MVAR_CLEAN);
99 RTS_ENTRY(stg_MVAR_DIRTY);
101 RTS_ENTRY(stg_ARR_WORDS);
102 RTS_ENTRY(stg_MUT_ARR_WORDS);
103 RTS_ENTRY(stg_MUT_ARR_PTRS_CLEAN);
104 RTS_ENTRY(stg_MUT_ARR_PTRS_DIRTY);
105 RTS_ENTRY(stg_MUT_ARR_PTRS_FROZEN);
106 RTS_ENTRY(stg_MUT_ARR_PTRS_FROZEN0);
107 RTS_ENTRY(stg_MUT_VAR_CLEAN);
108 RTS_ENTRY(stg_MUT_VAR_DIRTY);
109 RTS_ENTRY(stg_END_TSO_QUEUE);
110 RTS_ENTRY(stg_MSG_TRY_WAKEUP);
111 RTS_ENTRY(stg_MSG_THROWTO);
112 RTS_ENTRY(stg_MSG_BLACKHOLE);
113 RTS_ENTRY(stg_MSG_NULL);
114 RTS_ENTRY(stg_MVAR_TSO_QUEUE);
115 RTS_ENTRY(stg_catch);
118 RTS_ENTRY(stg_AP_NOUPD);
119 RTS_ENTRY(stg_AP_STACK);
120 RTS_ENTRY(stg_dummy_ret);
121 RTS_ENTRY(stg_raise);
122 RTS_ENTRY(stg_raise_ret);
123 RTS_ENTRY(stg_TVAR_WATCH_QUEUE);
124 RTS_ENTRY(stg_INVARIANT_CHECK_QUEUE);
125 RTS_ENTRY(stg_ATOMIC_INVARIANT);
127 RTS_ENTRY(stg_TREC_CHUNK);
128 RTS_ENTRY(stg_TREC_HEADER);
129 RTS_ENTRY(stg_END_STM_WATCH_QUEUE);
130 RTS_ENTRY(stg_END_INVARIANT_CHECK_QUEUE);
131 RTS_ENTRY(stg_END_STM_CHUNK_LIST);
132 RTS_ENTRY(stg_NO_TREC);
136 RTS_CLOSURE(stg_END_TSO_QUEUE_closure);
137 RTS_CLOSURE(stg_NO_FINALIZER_closure);
138 RTS_CLOSURE(stg_dummy_ret_closure);
139 RTS_CLOSURE(stg_forceIO_closure);
141 RTS_CLOSURE(stg_END_STM_WATCH_QUEUE_closure);
142 RTS_CLOSURE(stg_END_INVARIANT_CHECK_QUEUE_closure);
143 RTS_CLOSURE(stg_END_STM_CHUNK_LIST_closure);
144 RTS_CLOSURE(stg_NO_TREC_closure);
146 RTS_ENTRY(stg_NO_FINALIZER_entry);
149 extern DLL_IMPORT_RTS StgWordArray stg_CHARLIKE_closure;
150 extern DLL_IMPORT_RTS StgWordArray stg_INTLIKE_closure;
152 extern DLL_IMPORT_RTS StgIntCharlikeClosure stg_CHARLIKE_closure[];
153 extern DLL_IMPORT_RTS StgIntCharlikeClosure stg_INTLIKE_closure[];
158 RTS_RET(stg_forceIO);
159 RTS_RET(stg_noforceIO);
161 /* standard entry points */
163 /* standard selector thunks */
165 RTS_RET(stg_sel_ret_0_upd);
166 RTS_RET(stg_sel_ret_1_upd);
167 RTS_RET(stg_sel_ret_2_upd);
168 RTS_RET(stg_sel_ret_3_upd);
169 RTS_RET(stg_sel_ret_4_upd);
170 RTS_RET(stg_sel_ret_5_upd);
171 RTS_RET(stg_sel_ret_6_upd);
172 RTS_RET(stg_sel_ret_7_upd);
173 RTS_RET(stg_sel_ret_8_upd);
174 RTS_RET(stg_sel_ret_9_upd);
175 RTS_RET(stg_sel_ret_10_upd);
176 RTS_RET(stg_sel_ret_11_upd);
177 RTS_RET(stg_sel_ret_12_upd);
178 RTS_RET(stg_sel_ret_13_upd);
179 RTS_RET(stg_sel_ret_14_upd);
180 RTS_RET(stg_sel_ret_15_upd);
182 RTS_ENTRY(stg_sel_0_upd);
183 RTS_ENTRY(stg_sel_1_upd);
184 RTS_ENTRY(stg_sel_2_upd);
185 RTS_ENTRY(stg_sel_3_upd);
186 RTS_ENTRY(stg_sel_4_upd);
187 RTS_ENTRY(stg_sel_5_upd);
188 RTS_ENTRY(stg_sel_6_upd);
189 RTS_ENTRY(stg_sel_7_upd);
190 RTS_ENTRY(stg_sel_8_upd);
191 RTS_ENTRY(stg_sel_9_upd);
192 RTS_ENTRY(stg_sel_10_upd);
193 RTS_ENTRY(stg_sel_11_upd);
194 RTS_ENTRY(stg_sel_12_upd);
195 RTS_ENTRY(stg_sel_13_upd);
196 RTS_ENTRY(stg_sel_14_upd);
197 RTS_ENTRY(stg_sel_15_upd);
199 RTS_ENTRY(stg_sel_0_noupd);
200 RTS_ENTRY(stg_sel_1_noupd);
201 RTS_ENTRY(stg_sel_2_noupd);
202 RTS_ENTRY(stg_sel_3_noupd);
203 RTS_ENTRY(stg_sel_4_noupd);
204 RTS_ENTRY(stg_sel_5_noupd);
205 RTS_ENTRY(stg_sel_6_noupd);
206 RTS_ENTRY(stg_sel_7_noupd);
207 RTS_ENTRY(stg_sel_8_noupd);
208 RTS_ENTRY(stg_sel_9_noupd);
209 RTS_ENTRY(stg_sel_10_noupd);
210 RTS_ENTRY(stg_sel_11_noupd);
211 RTS_ENTRY(stg_sel_12_noupd);
212 RTS_ENTRY(stg_sel_13_noupd);
213 RTS_ENTRY(stg_sel_14_noupd);
214 RTS_ENTRY(stg_sel_15_noupd);
216 /* standard ap thunks */
218 RTS_THUNK(stg_ap_1_upd);
219 RTS_THUNK(stg_ap_2_upd);
220 RTS_THUNK(stg_ap_3_upd);
221 RTS_THUNK(stg_ap_4_upd);
222 RTS_THUNK(stg_ap_5_upd);
223 RTS_THUNK(stg_ap_6_upd);
224 RTS_THUNK(stg_ap_7_upd);
226 /* standard application routines (see also rts/gen_apply.py,
227 * and compiler/codeGen/CgStackery.lhs).
239 RTS_RET(stg_ap_pppv);
240 RTS_RET(stg_ap_pppp);
241 RTS_RET(stg_ap_ppppp);
242 RTS_RET(stg_ap_pppppp);
244 RTS_FUN_DECL(stg_ap_0_fast);
245 RTS_FUN_DECL(stg_ap_v_fast);
246 RTS_FUN_DECL(stg_ap_f_fast);
247 RTS_FUN_DECL(stg_ap_d_fast);
248 RTS_FUN_DECL(stg_ap_l_fast);
249 RTS_FUN_DECL(stg_ap_n_fast);
250 RTS_FUN_DECL(stg_ap_p_fast);
251 RTS_FUN_DECL(stg_ap_pv_fast);
252 RTS_FUN_DECL(stg_ap_pp_fast);
253 RTS_FUN_DECL(stg_ap_ppv_fast);
254 RTS_FUN_DECL(stg_ap_ppp_fast);
255 RTS_FUN_DECL(stg_ap_pppv_fast);
256 RTS_FUN_DECL(stg_ap_pppp_fast);
257 RTS_FUN_DECL(stg_ap_ppppp_fast);
258 RTS_FUN_DECL(stg_ap_pppppp_fast);
259 RTS_FUN_DECL(stg_PAP_apply);
261 /* standard GC & stack check entry points, all defined in HeapStackCheck.hc */
264 RTS_RET(stg_enter_checkbh);
266 RTS_RET(stg_gc_void);
268 RTS_FUN_DECL(__stg_gc_enter_1);
269 RTS_FUN_DECL(stg_gc_noregs);
271 RTS_RET(stg_gc_unpt_r1);
272 RTS_FUN_DECL(stg_gc_unpt_r1);
274 RTS_RET(stg_gc_unbx_r1);
275 RTS_FUN_DECL(stg_gc_unbx_r1);
278 RTS_FUN_DECL(stg_gc_f1);
281 RTS_FUN_DECL(stg_gc_d1);
284 RTS_FUN_DECL(stg_gc_l1);
287 RTS_FUN_DECL(__stg_gc_fun);
290 RTS_FUN_DECL(stg_gc_gen);
292 RTS_RET(stg_ut_1_0_unreg);
294 RTS_FUN_DECL(stg_gc_gen_hp);
295 RTS_FUN_DECL(stg_gc_ut);
296 RTS_FUN_DECL(stg_gen_yield);
297 RTS_FUN_DECL(stg_yield_noregs);
298 RTS_FUN_DECL(stg_yield_to_interpreter);
299 RTS_FUN_DECL(stg_gen_block);
300 RTS_FUN_DECL(stg_block_noregs);
301 RTS_FUN_DECL(stg_block_1);
302 RTS_FUN_DECL(stg_block_blackhole);
303 RTS_FUN_DECL(stg_block_blackhole_finally);
304 RTS_FUN_DECL(stg_block_takemvar);
305 RTS_RET(stg_block_takemvar);
306 RTS_FUN_DECL(stg_block_putmvar);
307 RTS_RET(stg_block_putmvar);
308 #ifdef mingw32_HOST_OS
309 RTS_FUN_DECL(stg_block_async);
310 RTS_RET(stg_block_async);
311 RTS_FUN_DECL(stg_block_async_void);
312 RTS_RET(stg_block_async_void);
314 RTS_FUN_DECL(stg_block_stmwait);
315 RTS_FUN_DECL(stg_block_throwto);
316 RTS_RET(stg_block_throwto);
318 /* Entry/exit points from StgStartup.cmm */
320 RTS_RET(stg_stop_thread);
322 RTS_FUN_DECL(stg_returnToStackTop);
323 RTS_FUN_DECL(stg_returnToSched);
324 RTS_FUN_DECL(stg_returnToSchedNotPaused);
325 RTS_FUN_DECL(stg_returnToSchedButFirst);
326 RTS_FUN_DECL(stg_threadFinished);
328 RTS_FUN_DECL(stg_init_finish);
329 RTS_FUN_DECL(stg_init);
331 RTS_FUN_DECL(StgReturn);
333 /* -----------------------------------------------------------------------------
335 -------------------------------------------------------------------------- */
337 RTS_FUN_DECL(stg_plusIntegerzh);
338 RTS_FUN_DECL(stg_minusIntegerzh);
339 RTS_FUN_DECL(stg_timesIntegerzh);
340 RTS_FUN_DECL(stg_gcdIntegerzh);
341 RTS_FUN_DECL(stg_quotRemIntegerzh);
342 RTS_FUN_DECL(stg_quotIntegerzh);
343 RTS_FUN_DECL(stg_remIntegerzh);
344 RTS_FUN_DECL(stg_divExactIntegerzh);
345 RTS_FUN_DECL(stg_divModIntegerzh);
347 RTS_FUN_DECL(stg_cmpIntegerIntzh);
348 RTS_FUN_DECL(stg_cmpIntegerzh);
349 RTS_FUN_DECL(stg_integer2Intzh);
350 RTS_FUN_DECL(stg_integer2Wordzh);
351 RTS_FUN_DECL(stg_gcdIntegerIntzh);
352 RTS_FUN_DECL(stg_gcdIntzh);
354 RTS_FUN_DECL(stg_int2Integerzh);
355 RTS_FUN_DECL(stg_word2Integerzh);
357 RTS_FUN_DECL(stg_decodeFloatzuIntzh);
358 RTS_FUN_DECL(stg_decodeDoublezh);
359 RTS_FUN_DECL(stg_decodeDoublezu2Intzh);
361 RTS_FUN_DECL(stg_andIntegerzh);
362 RTS_FUN_DECL(stg_orIntegerzh);
363 RTS_FUN_DECL(stg_xorIntegerzh);
364 RTS_FUN_DECL(stg_complementIntegerzh);
366 #if SIZEOF_HSINT == 4
368 RTS_FUN_DECL(stg_int64ToIntegerzh);
369 RTS_FUN_DECL(stg_word64ToIntegerzh);
373 RTS_FUN_DECL(stg_unsafeThawArrayzh);
374 RTS_FUN_DECL(stg_newByteArrayzh);
375 RTS_FUN_DECL(stg_newPinnedByteArrayzh);
376 RTS_FUN_DECL(stg_newAlignedPinnedByteArrayzh);
377 RTS_FUN_DECL(stg_newArrayzh);
379 RTS_FUN_DECL(stg_newMutVarzh);
380 RTS_FUN_DECL(stg_atomicModifyMutVarzh);
382 RTS_FUN_DECL(stg_isEmptyMVarzh);
383 RTS_FUN_DECL(stg_newMVarzh);
384 RTS_FUN_DECL(stg_takeMVarzh);
385 RTS_FUN_DECL(stg_putMVarzh);
386 RTS_FUN_DECL(stg_tryTakeMVarzh);
387 RTS_FUN_DECL(stg_tryPutMVarzh);
389 RTS_FUN_DECL(stg_waitReadzh);
390 RTS_FUN_DECL(stg_waitWritezh);
391 RTS_FUN_DECL(stg_delayzh);
392 #ifdef mingw32_HOST_OS
393 RTS_FUN_DECL(stg_asyncReadzh);
394 RTS_FUN_DECL(stg_asyncWritezh);
395 RTS_FUN_DECL(stg_asyncDoProczh);
398 RTS_FUN_DECL(stg_catchzh);
399 RTS_FUN_DECL(stg_raisezh);
400 RTS_FUN_DECL(stg_raiseIOzh);
402 RTS_FUN_DECL(stg_makeStableNamezh);
403 RTS_FUN_DECL(stg_makeStablePtrzh);
404 RTS_FUN_DECL(stg_deRefStablePtrzh);
406 RTS_FUN_DECL(stg_forkzh);
407 RTS_FUN_DECL(stg_forkOnzh);
408 RTS_FUN_DECL(stg_yieldzh);
409 RTS_FUN_DECL(stg_killThreadzh);
410 RTS_FUN_DECL(stg_asyncExceptionsBlockedzh);
411 RTS_FUN_DECL(stg_blockAsyncExceptionszh);
412 RTS_FUN_DECL(stg_unblockAsyncExceptionszh);
413 RTS_FUN_DECL(stg_myThreadIdzh);
414 RTS_FUN_DECL(stg_labelThreadzh);
415 RTS_FUN_DECL(stg_isCurrentThreadBoundzh);
416 RTS_FUN_DECL(stg_threadStatuszh);
418 RTS_FUN_DECL(stg_mkWeakzh);
419 RTS_FUN_DECL(stg_mkWeakForeignzh);
420 RTS_FUN_DECL(stg_mkWeakForeignEnvzh);
421 RTS_FUN_DECL(stg_finalizzeWeakzh);
422 RTS_FUN_DECL(stg_deRefWeakzh);
424 RTS_FUN_DECL(stg_newBCOzh);
425 RTS_FUN_DECL(stg_mkApUpd0zh);
427 RTS_FUN_DECL(stg_retryzh);
428 RTS_FUN_DECL(stg_catchRetryzh);
429 RTS_FUN_DECL(stg_catchSTMzh);
430 RTS_FUN_DECL(stg_atomicallyzh);
431 RTS_FUN_DECL(stg_newTVarzh);
432 RTS_FUN_DECL(stg_readTVarzh);
433 RTS_FUN_DECL(stg_readTVarIOzh);
434 RTS_FUN_DECL(stg_writeTVarzh);
435 RTS_FUN_DECL(stg_checkzh);
437 RTS_FUN_DECL(stg_unpackClosurezh);
438 RTS_FUN_DECL(stg_getApStackValzh);
439 RTS_FUN_DECL(stg_getSparkzh);
441 RTS_FUN_DECL(stg_noDuplicatezh);
443 RTS_FUN_DECL(stg_traceCcszh);
444 RTS_FUN_DECL(stg_traceEventzh);
446 /* Other misc stuff */
447 // See wiki:Commentary/Compiler/Backends/PprC#Prototypes
449 #if IN_STG_CODE && !IN_STGCRUN
452 extern StgWord rts_stop_next_breakpoint[];
453 extern StgWord rts_stop_on_exception[];
454 extern StgWord rts_breakpoint_io_action[];
457 extern StgWord RTS_VAR(blocked_queue_hd), RTS_VAR(blocked_queue_tl);
458 extern StgWord RTS_VAR(sleeping_queue);
459 extern StgWord RTS_VAR(blackhole_queue);
460 extern StgWord RTS_VAR(sched_mutex);
463 // canned bitmap for each arg type
464 extern StgWord stg_arg_bitmaps[];
465 extern StgWord stg_ap_stack_entries[];
466 extern StgWord stg_stack_save_entries[];
469 extern unsigned int RTS_VAR(g0);
470 extern unsigned int RTS_VAR(alloc_blocks_lim);
471 extern StgWord RTS_VAR(weak_ptr_list);
472 extern StgWord RTS_VAR(atomic_modify_mutvar_mutex);
475 extern StgWord RTS_VAR(RtsFlags); // bogus type
478 extern StgWord RTS_VAR(stable_ptr_table);
481 extern unsigned int RTS_VAR(era);
482 extern StgWord RTS_VAR(CCCS); /* current CCS */
483 extern unsigned int RTS_VAR(entering_PAP);
484 extern StgWord RTS_VAR(CC_LIST); /* registered CC list */
485 extern StgWord RTS_VAR(CCS_LIST); /* registered CCS list */
486 extern unsigned int RTS_VAR(CC_ID); /* global ids */
487 extern unsigned int RTS_VAR(CCS_ID);
491 #endif /* STGMISCCLOSURES_H */