1 %/****************************************************************
3 %* Basic Continuations required by the STG Machine runtime *
5 %****************************************************************/
8 First continuation called by the mini-interpreter is
9 evaluateTopClosure. It has to set up return and jump to the user's
10 @main@ closure. If @errorIO@ is called, we will be back here, doing
11 the same thing for the specified continuation.
14 #define MAIN_REG_MAP /* STG world */
19 #include "Statistics.h"
23 /* ptr to the user's "main" closure (or "errorIO" arg closure),
24 to which we hope to be linked
28 EXTFUN(stopThreadDirectReturn);
29 UNVECTBL(,vtbl_stopStgWorld,stopThreadDirectReturn)
31 /* Well, we have to put the ArrayOfData and ArrayOfPtrs info tables
35 /* Array of data -- mutable */
36 STATICFUN(ArrayOfData_entry)
39 /* Don't wrap the calls; we're done with STG land */
41 fprintf(stderr, "Entered a primitive array (of data)---this shouldn't happen!\n");
46 DATA_ITBL(ArrayOfData_info,ArrayOfData_entry,UpdErr,0,INFO_OTHER_TAG,,,const,IF_,ARR_K,"DATA-ARRAY","ARRAY");
47 /* ToDo: could put a useful tag in there!!! */
49 /* Array of pointers -- mutable */
50 STATICFUN(ArrayOfPtrs_entry)
53 /* Don't wrap the calls; we're done with STG land */
55 fprintf(stderr, "Entered a primitive array (of pointers)---this shouldn't happen!\n");
60 MUTUPLE_ITBL(ArrayOfPtrs_info,ArrayOfPtrs_entry,UpdErr,0,INFO_OTHER_TAG,,,const,IF_,ARR_K,"PTR-ARRAY(mut)","ARRAY");
61 /* ToDo: could put a useful tag in there!!! */
63 STATICFUN(FullSVar_entry)
66 /* Don't wrap the calls; we're done with STG land */
68 fprintf(stderr, "Entered a full SVar---this shouldn't happen!\n");
73 MUTUPLE_ITBL(FullSVar_info,FullSVar_entry,UpdErr,0,INFO_OTHER_TAG,,,const,IF_,ARR_K,"FullSVar","ARRAY");
74 /* ToDo: could put a useful tag in there!!! */
76 STATICFUN(EmptySVar_entry)
79 /* Don't wrap the calls; we're done with STG land */
81 fprintf(stderr, "Entered an empty SVar---this shouldn't happen!\n");
86 MUTUPLE_ITBL(EmptySVar_info,EmptySVar_entry,UpdErr,0,INFO_OTHER_TAG,,,const,IF_,ARR_K,"EmptySVar","ARRAY");
87 /* ToDo: could put a useful tag in there!!! */
89 /* Array of pointers -- immutable */
90 STATICFUN(ImMutArrayOfPtrs_entry)
93 /* Don't wrap the calls; we're done with STG land */
95 fprintf(stderr, "Entered a primitive array (immutable, pointers)---this shouldn't happen!\n");
100 IMMUTUPLE_ITBL(ImMutArrayOfPtrs_info,ImMutArrayOfPtrs_entry,UpdErr,0,INFO_OTHER_TAG,,,const,IF_,ARR_K,"PTR-ARRAY(immut)","ARRAY");
101 /* ToDo: could put a useful tag in there!!! */
103 /* (end of Array whatnot) */
105 /* Question for Will: There seem to be a lot of these static things
106 now - worth putting them in a file by themselves?? [ADR] */
111 /* Ditto for Malloc Pointer entry point and info tables. [ADR]
113 BTW Will, I copied most of this blindly from above - what's with
114 this TAG stuff? And what kind of description/ type is wanted here?
117 STATICFUN(MallocPtr_entry)
120 /* Don't wrap the calls; we're done with STG land */
122 fprintf(stderr, "Compiler bug: Entered a Malloc Pointer---this shouldn't happen!\n");
127 MallocPtr_ITBL(MallocPtr_info,MallocPtr_entry,UpdErr,0,INFO_OTHER_TAG,,,const,EF_,MallocPtr_K,"MALLOC PTR","MallocPtr");
129 /* End of MallocPtr stuff */
131 /* Ditto for the unused Stable Pointer info table. [ADR]
134 void raiseError PROTO((StgStablePtr));
135 extern StgStablePtr errorHandler; /* NB: prone to magic-value-ery (WDP 95/12) */
137 /* Unused Stable Pointer (ie unused slot in a stable pointer table) */
138 STATICFUN(UnusedSP_entry)
141 (void) SAFESTGCALL1(I_,(void *, FILE *),fflush,stdout);
142 (void) SAFESTGCALL2(I_,(void *, FILE *, char *),fprintf,stderr, "Entered an unused Stable Pointer---this shouldn't happen!\n(This could be program error (using stable pointer after freeing) or compiler bug.)\n");
144 (void) STGCALL1(void,(void *, StgStablePtr), raiseError, errorHandler);
148 STATIC_ITBL(UnusedSP_info,UnusedSP_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,IF_,CON_K,"UNUSED STABLE PTR","USP");
150 SET_STATIC_HDR(UnusedSP_closure,UnusedSP_info,CC_SUBSUMED,,ED_RO_)
153 /* Entry point and Info table for Stable Pointer Table. */
155 STATICFUN(EmptyStablePointerTable_entry)
158 /* Don't wrap the calls; we're done with STG land */
160 fprintf(stderr, "Entered *empty* stable pointer table---this shouldn't happen!\n");
165 STATICFUN(StablePointerTable_entry)
168 /* Don't wrap the calls; we're done with STG land */
170 fprintf(stderr, "Entered the stable pointer table---this shouldn't happen!\n");
175 STATIC_ITBL(EmptyStablePointerTable_info,EmptyStablePointerTable_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,IF_,SPT_K,"SP_TABLE","SP_TABLE");
176 /* ToDo: could put a useful tag in there!!! */
178 DYN_ITBL(StablePointerTable_info,StablePointerTable_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,IF_,SPT_K,"SP_TABLE","SP_TABLE");
179 /* ToDo: could put a useful tag in there!!! */
182 /* To ease initialisation of the heap, we start with an empty stable
183 pointer table. When we try to create the first stable pointer, the
184 overflow will trigger creation of a table of useful size.
187 SET_STATIC_HDR(EmptySPTable_closure,EmptyStablePointerTable_info,CC_SUBSUMED,,ED_RO_)
188 , (W_) DYN_VHS + 0 + 1 + 0 /* size = DYN_VHS + n + 1 + n with n = 0 */
189 , (W_) 0 /* number of ptrs */
190 , (W_) 0 /* top of stack */
193 /* End of SP stuff */
197 /* the IoWorld token to start the whole thing off */
198 /* Question: this is just an amusing hex code isn't it
199 -- or does it mean something? ADR */
200 P_ realWorldZh_closure = (P_) 0xbadbadbaL;
202 SET_STATIC_HDR(WorldStateToken_closure,SZh_static_info,CC_SUBSUMED/*harmless*/,,ED_RO_)
208 STGFUN(startStgWorld)
211 /* At this point we are in the threaded-code world.
213 TopClosure points to a closure of type PrimIO (), which should be
214 performed (by applying it to the state of the world).
216 The smInfo storage-management info block is assumed to be
217 up to date, and is used to load the STG registers.
220 RestoreAllStgRegs(); /* inline! */
222 /* ------- STG registers are now valid! -------------------------*/
224 /* Put a suitable return address on the B stack */
225 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
227 /* Put an IoWorld token on the A stack */
229 *SpA = (P_) WorldStateToken_closure;
231 Node = (P_) TopClosure; /* Point to the closure for main/errorIO-arg */
233 InfoPtr=(D_)(INFO_PTR(Node));
234 JMP_(ENTRY_CODE(InfoPtr));
237 #endif /* ! CONCURRENT */
241 %************************************************************************
243 \subsection[thread-return]{Polymorphic end-of-thread code}
245 %************************************************************************
250 Here's the polymorphic return for the end of a thread.
252 NB: For direct returns to work properly, the name of the routine must be
253 the same as the name of the vector table with vtbl_ removed and DirectReturn
254 appended. This is all the mangler understands.
258 vtbl_stopThread[] = {
259 /* at least "MAX_VECTORED_RTN" elements (see GhcConstants.lh) */
260 (W_) stopThreadDirectReturn,
261 (W_) stopThreadDirectReturn,
262 (W_) stopThreadDirectReturn,
263 (W_) stopThreadDirectReturn,
264 (W_) stopThreadDirectReturn,
265 (W_) stopThreadDirectReturn,
266 (W_) stopThreadDirectReturn,
267 (W_) stopThreadDirectReturn
270 STGFUN(stopThreadDirectReturn)
275 The top-top-level closures (e.g., "main") are of type "IO ()".
276 When entered, they perform an IO action and return a () --
277 essentially, TagReg is set to 1. Here, we don't need to do
280 We just tidy up the register stuff (real regs in *_SAVE, then
281 *_SAVE -> smInfo locs).
285 SET_TASK_ACTIVITY(ST_OVERHEAD);
288 SaveAllStgRegs(); /* inline! */
293 RESUME_(miniInterpretEnd);
301 I_ ErrorIO_call_count = 0;
304 EXTFUN(EnterNodeCode);
306 STGFUN(ErrorIO_innards)
307 /* Assumes that "TopClosure" has been set already */
310 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
311 /* Don't wrap the calls; we're done with STG land */
313 fprintf(stderr, "too many nested calls to `error'\n");
316 ErrorIO_call_count++; /* NB: undo later if decide to let someone else handle it */
318 /* Unlock all global closures held by this thread! (ToDo) --JSM */
320 switch(TSO_TYPE(CurrentTSO)) {
322 /* Re-initialize stack pointers (cf. NewThread) */
324 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
325 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
327 SuA = stackInfo.botA + AREL(1);
328 SuB = stackInfo.botB + BREL(1);
333 /* Re-initialize stack pointers (cf. NewThread) */
334 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
335 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
339 ErrorIO_call_count--; /* undo the damage, as someone else will deal with it */
340 /* Let the main thread eventually handle it */
341 JMP_(stopThreadDirectReturn);
347 /* Don't wrap the calls; we're done with STG land */
349 fprintf(stderr,"ErrorIO: %lx unknown\n", TSO_TYPE(CurrentTSO));
353 /* Finish stack setup as if for a top-level task and enter the error node */
357 *SpA = (P_) WorldStateToken_closure;
359 STKO_LINK(StkOReg) = Nil_closure;
360 STKO_RETURN(StkOReg) = NULL;
363 STKO_ADEP(StkOReg) = STKO_BDEP(StkOReg) = 0;
367 Node = (P_) TopClosure;
368 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
375 We cannot afford to call @error@ too many times
376 (e.g., \tr{error x where x = error x}), so we keep count.
379 #else /* !CONCURRENT */
382 ErrorIO_innards(STG_NO_ARGS)
383 /* Assumes that "TopClosure" has been set already */
386 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
387 /* Don't wrap the calls; we're done with STG land */
389 fprintf(stderr, "too many nested calls to `error'\n");
392 ErrorIO_call_count++;
394 /* Copy the heap-related registers into smInfo. (Other registers get
395 saved in this process, but we aren't interested in them.)
397 Get a new stack (which re-initialises the smInfo stack stuff),
398 and start the world again.
400 /* ToDo: chk this has been handled in parallel world */
402 SaveAllStgRegs(); /* inline! */
404 if (! initStacks( &StorageMgrInfo )) {
405 /* Don't wrap the calls; we're done with STG land */
407 fprintf(stderr, "initStacks failed!\n");
411 JMP_( startStgWorld );
415 #endif /* !CONCURRENT */
421 STATICFUN(RBH_Save_0_entry)
424 fprintf(stderr,"Oops, entered an RBH save\n");
429 STATICFUN(RBH_Save_1_entry)
432 fprintf(stderr,"Oops, entered an RBH save\n");
437 STATICFUN(RBH_Save_2_entry)
440 fprintf(stderr,"Oops, entered an RBH save\n");
445 SPEC_N_ITBL(RBH_Save_0_info,RBH_Save_0_entry,UpdErr,0,INFO_OTHER_TAG,2,0,,IF_,INTERNAL_KIND,"RBH-SAVE","RBH_Save_0");
446 SPEC_N_ITBL(RBH_Save_1_info,RBH_Save_1_entry,UpdErr,0,INFO_OTHER_TAG,2,1,,IF_,INTERNAL_KIND,"RBH-SAVE","RBH_Save_1");
447 SPEC_N_ITBL(RBH_Save_2_info,RBH_Save_2_entry,UpdErr,0,INFO_OTHER_TAG,2,2,,IF_,INTERNAL_KIND,"RBH-SAVE","RBH_Save_2");
453 %/****************************************************************
455 %* Other Bits and Pieces *
457 %****************************************************************/
460 /* If we don't need the slow entry code for a closure, we put in a
461 pointer to this in the closure's slow entry code pointer instead.
464 STGFUN(__std_entry_error__) {
466 /* Don't wrap the calls; we're done with STG land */
468 fprintf(stderr, "Called non-existent slow-entry code!!!\n");
475 STGFUN(STK_STUB_entry) {
477 /* Don't wrap the calls; we're done with STG land */
479 fprintf(stderr, "Entered from a stubbed stack slot!\n");
486 STATIC_ITBL(STK_STUB_info,STK_STUB_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,EF_,INTERNAL_KIND,"STK_STUB","STK_STUB");
489 SET_STATIC_HDR(STK_STUB_closure,STK_STUB_info,CC_SUBSUMED,,EXTDATA_RO)
497 STGFUN(Event_Queue_entry) {
499 /* Don't wrap the calls; we're done with STG land */
501 fprintf(stderr, "Entered from an event queue!\n");
507 GEN_N_ITBL(Event_Queue_info,Event_Queue_entry,UpdErr,0,INFO_OTHER_TAG,5,2,const,EF_,INTERNAL_KIND,"EventQ","EventQ");
514 %/****************************************************************
516 %* Some GC info tables *
518 %****************************************************************/
520 These have to be in a .lhc file, so they will be reversed correctly.
523 #include "../storage/SMinternal.h"
525 #if defined(_INFO_COPYING)
527 STGFUN(Caf_Evac_Upd_entry) {
529 /* Don't wrap the calls; we're done with STG land */
531 fprintf(stderr,"Entered Caf_Evac_Upd %lx: Should never occur!\n", (W_) Node);
536 CAF_EVAC_UPD_ITBL(Caf_Evac_Upd_info,Caf_Evac_Upd_entry,const/*not static*/);
540 STGFUN(Forward_Ref_New_entry) {
542 /* Don't wrap the calls; we're done with STG land */
544 fprintf(stderr,"Entered Forward_Ref_New %lx: Should never occur!\n", (W_) Node);
548 FORWARDREF_ITBL(Forward_Ref_New_info,Forward_Ref_New_entry,const/*not static*/,_Evacuate_Old_Forward_Ref);
550 STGFUN(Forward_Ref_Old_entry) {
552 /* Don't wrap the calls; we're done with STG land */
554 fprintf(stderr,"Entered Forward_Ref_Old %lx: Should never occur!\n", (W_) Node);
558 FORWARDREF_ITBL(Forward_Ref_Old_info,Forward_Ref_Old_entry,const/*not static*/,_Evacuate_New_Forward_Ref);
560 STGFUN(OldRoot_Forward_Ref_entry) {
562 /* Don't wrap the calls; we're done with STG land */
564 fprintf(stderr,"Entered OldRoot_Forward_Ref %lx: Should never occur!\n", (W_) Node);
568 FORWARDREF_ITBL(OldRoot_Forward_Ref_info,OldRoot_Forward_Ref_entry,const/*not static*/,_Evacuate_OldRoot_Forward);
571 STGFUN(Forward_Ref_entry) {
573 /* Don't wrap the calls; we're done with STG land */
575 fprintf(stderr,"Entered Forward_Ref %lx: Should never occur!\n", (W_) Node);
579 FORWARDREF_ITBL(Forward_Ref_info,Forward_Ref_entry,const/*not static*/,_Evacuate_Forward_Ref);
582 #endif /* _INFO_COPYING */
585 OLDROOT_ITBL(OldRoot_info,Ind_Entry,const,EF_);
590 %/***************************************************************
592 %* Cost Centre stuff ... *
594 %****************************************************************/
596 For cost centres we need prelude cost centres and register routine.
598 N.B. ALL prelude cost centres should be declared here as none will
599 be declared when the prelude is compiled.
601 ToDo: Explicit cost centres in prelude for Input and Output costs.
604 #if defined(PROFILING)
606 STGFUN(startCcRegisteringWorld)
610 * We used to push miniInterpretEnd on the register stack, but
611 * miniInterpretEnd must only be entered with the RESUME_ macro,
612 * whereas the other addresses on the register stack must only be
613 * entered with the JMP_ macro. Now, we push NULL and test for
614 * it explicitly at each pop.
616 PUSH_REGISTER_STACK(NULL);
621 CC_DECLARE(CC_CAFs, "CAFs_in_...", "PRELUDE", "PRELUDE", CC_IS_CAF,/*not static*/);
622 CC_DECLARE(CC_DICTs, "DICTs_in_...", "PRELUDE", "PRELUDE", CC_IS_DICT,/*not static*/);
624 START_REGISTER_PRELUDE(_regPrelude);
625 REGISTER_CC(CC_CAFs);
626 REGISTER_CC(CC_DICTs);
630 We also need cost centre declarations and registering routines for other
631 built-in prelude-like modules.
633 ToDo: What built-in prelude-like modules exist ?
636 START_REGISTER_PRELUDE(_regByteOps); /* used in Glasgow tests only? */
639 /* _regPrelude is above */
641 START_REGISTER_PRELUDE(_regPreludeArray);
644 START_REGISTER_PRELUDE(_regPreludeCore);
647 START_REGISTER_PRELUDE(_regPreludeDialogueIO);
650 START_REGISTER_PRELUDE(_regPreludeGlaMisc);
653 START_REGISTER_PRELUDE(_regPreludeGlaST);
656 START_REGISTER_PRELUDE(_regPreludeIOError);
659 START_REGISTER_PRELUDE(_regPreludePS);
662 START_REGISTER_PRELUDE(_regPreludePrimIO);
665 START_REGISTER_PRELUDE(_regPreludeStdIO);