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] */
109 #if !defined(PAR) /* && !defined(GRAN) */
111 /* Ditto for Foreign Objectr 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(ForeignObj_entry)
120 /* Don't wrap the calls; we're done with STG land */
122 fprintf(stderr, "Compiler bug: Entered a ForeignObj---this shouldn't happen!\n");
127 ForeignObj_ITBL(ForeignObj_info,ForeignObj_entry,UpdErr,0,INFO_OTHER_TAG,,,const,EF_,ForeignObj_K,"FOREIGN OBJ","ForeignObj");
129 /* End of ForeignObj 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;
201 P_ GHCbuiltins_void_closure = (P_) 0xbadbadbaL;
203 SET_STATIC_HDR(WorldStateToken_closure,GHCbase_SZh_static_info,CC_SUBSUMED/*harmless*/,,ED_RO_)
209 STGFUN(startStgWorld)
212 /* At this point we are in the threaded-code world.
214 TopClosure points to a closure of type PrimIO (), which should be
215 performed (by applying it to the state of the world).
217 The smInfo storage-management info block is assumed to be
218 up to date, and is used to load the STG registers.
221 RestoreAllStgRegs(); /* inline! */
223 /* ------- STG registers are now valid! -------------------------*/
225 /* Put a suitable return address on the B stack */
226 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
228 /* Put an IoWorld token on the A stack */
230 *SpA = (P_) WorldStateToken_closure;
232 Node = (P_) TopClosure; /* Point to the closure for main/errorIO-arg */
234 InfoPtr=(D_)(INFO_PTR(Node));
235 JMP_(ENTRY_CODE(InfoPtr));
238 #endif /* ! CONCURRENT */
242 %************************************************************************
244 \subsection[thread-return]{Polymorphic end-of-thread code}
246 %************************************************************************
251 Here's the polymorphic return for the end of a thread.
253 NB: For direct returns to work properly, the name of the routine must be
254 the same as the name of the vector table with vtbl_ removed and DirectReturn
255 appended. This is all the mangler understands.
259 vtbl_stopThread[] = {
260 /* at least "MAX_VECTORED_RTN" elements (see GhcConstants.lh) */
261 (W_) stopThreadDirectReturn,
262 (W_) stopThreadDirectReturn,
263 (W_) stopThreadDirectReturn,
264 (W_) stopThreadDirectReturn,
265 (W_) stopThreadDirectReturn,
266 (W_) stopThreadDirectReturn,
267 (W_) stopThreadDirectReturn,
268 (W_) stopThreadDirectReturn
271 STGFUN(stopThreadDirectReturn)
276 The top-top-level closures (e.g., "main") are of type "IO ()".
277 When entered, they perform an IO action and return a () --
278 essentially, TagReg is set to 1. Here, we don't need to do
281 We just tidy up the register stuff (real regs in *_SAVE, then
282 *_SAVE -> smInfo locs).
286 SET_TASK_ACTIVITY(ST_OVERHEAD);
289 SaveAllStgRegs(); /* inline! */
294 RESUME_(miniInterpretEnd);
302 I_ ErrorIO_call_count = 0;
305 EXTFUN(EnterNodeCode);
307 STGFUN(ErrorIO_innards)
308 /* Assumes that "TopClosure" has been set already */
311 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
312 /* Don't wrap the calls; we're done with STG land */
314 fprintf(stderr, "too many nested calls to `error'\n");
317 ErrorIO_call_count++; /* NB: undo later if decide to let someone else handle it */
319 /* Unlock all global closures held by this thread! (ToDo) --JSM */
321 switch(TSO_TYPE(CurrentTSO)) {
323 /* Re-initialize stack pointers (cf. NewThread) */
325 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
326 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
328 SuA = stackInfo.botA + AREL(1);
329 SuB = stackInfo.botB + BREL(1);
332 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
333 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
340 /* Re-initialize stack pointers (cf. NewThread) */
341 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
342 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
346 ErrorIO_call_count--; /* undo the damage, as someone else will deal with it */
347 /* Let the main thread eventually handle it */
348 JMP_(stopThreadDirectReturn);
354 /* Don't wrap the calls; we're done with STG land */
356 fprintf(stderr,"ErrorIO: %lx unknown\n", TSO_TYPE(CurrentTSO));
360 /* Finish stack setup as if for a top-level task and enter the error node */
364 *SpA = (P_) WorldStateToken_closure;
366 STKO_LINK(StkOReg) = Prelude_Z91Z93_closure;
367 STKO_RETURN(StkOReg) = NULL;
370 STKO_ADEP(StkOReg) = STKO_BDEP(StkOReg) = 0;
374 Node = (P_) TopClosure;
375 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
382 We cannot afford to call @error@ too many times
383 (e.g., \tr{error x where x = error x}), so we keep count.
386 #else /* !CONCURRENT */
389 ErrorIO_innards(STG_NO_ARGS)
390 /* Assumes that "TopClosure" has been set already */
393 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
394 /* Don't wrap the calls; we're done with STG land */
396 fprintf(stderr, "too many nested calls to `error'\n");
399 ErrorIO_call_count++;
401 /* Copy the heap-related registers into smInfo. (Other registers get
402 saved in this process, but we aren't interested in them.)
404 Get a new stack (which re-initialises the smInfo stack stuff),
405 and start the world again.
407 /* ToDo: chk this has been handled in parallel world */
409 SaveAllStgRegs(); /* inline! */
411 if (! initStacks( &StorageMgrInfo )) {
412 /* Don't wrap the calls; we're done with STG land */
414 fprintf(stderr, "initStacks failed!\n");
418 JMP_( startStgWorld );
422 #endif /* !CONCURRENT */
426 #if defined(PAR) || defined(GRAN)
428 STATICFUN(RBH_Save_0_entry)
431 fprintf(stderr,"Oops, entered an RBH save\n");
436 STATICFUN(RBH_Save_1_entry)
439 fprintf(stderr,"Oops, entered an RBH save\n");
444 STATICFUN(RBH_Save_2_entry)
447 fprintf(stderr,"Oops, entered an RBH save\n");
452 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");
453 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");
454 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");
456 #endif /* PAR || GRAN */
460 %/****************************************************************
462 %* Other Bits and Pieces *
464 %****************************************************************/
467 /* If we don't need the slow entry code for a closure, we put in a
468 pointer to this in the closure's slow entry code pointer instead.
471 STGFUN(__std_entry_error__) {
473 /* Don't wrap the calls; we're done with STG land */
475 fprintf(stderr, "Called non-existent slow-entry code!!!\n");
482 STGFUN(STK_STUB_entry) {
484 /* Don't wrap the calls; we're done with STG land */
486 fprintf(stderr, "Entered from a stubbed stack slot!\n");
493 STATIC_ITBL(STK_STUB_info,STK_STUB_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,EF_,INTERNAL_KIND,"STK_STUB","STK_STUB");
496 SET_STATIC_HDR(STK_STUB_closure,STK_STUB_info,CC_SUBSUMED,,EXTDATA_RO)
501 %/****************************************************************
503 %* Some GC info tables *
505 %****************************************************************/
507 These have to be in a .lhc file, so they will be reversed correctly.
510 #include "../storage/SMinternal.h"
512 #if defined(_INFO_COPYING)
514 STGFUN(Caf_Evac_Upd_entry) {
516 /* Don't wrap the calls; we're done with STG land */
518 fprintf(stderr,"Entered Caf_Evac_Upd %lx: Should never occur!\n", (W_) Node);
523 CAF_EVAC_UPD_ITBL(Caf_Evac_Upd_info,Caf_Evac_Upd_entry,const/*not static*/);
527 STGFUN(Forward_Ref_New_entry) {
529 /* Don't wrap the calls; we're done with STG land */
531 fprintf(stderr,"Entered Forward_Ref_New %lx: Should never occur!\n", (W_) Node);
532 EXIT(EXIT_FAILURE); /* abort(); */
535 FORWARDREF_ITBL(Forward_Ref_New_info,Forward_Ref_New_entry,const/*not static*/,_Evacuate_Old_Forward_Ref);
537 STGFUN(Forward_Ref_Old_entry) {
539 /* Don't wrap the calls; we're done with STG land */
541 fprintf(stderr,"Entered Forward_Ref_Old %lx: Should never occur!\n", (W_) Node);
542 EXIT(EXIT_FAILURE); /* abort(); */
545 FORWARDREF_ITBL(Forward_Ref_Old_info,Forward_Ref_Old_entry,const/*not static*/,_Evacuate_New_Forward_Ref);
547 STGFUN(OldRoot_Forward_Ref_entry) {
549 /* Don't wrap the calls; we're done with STG land */
551 fprintf(stderr,"Entered OldRoot_Forward_Ref %lx: Should never occur!\n", (W_) Node);
552 EXIT(EXIT_FAILURE); /* abort(); */
555 FORWARDREF_ITBL(OldRoot_Forward_Ref_info,OldRoot_Forward_Ref_entry,const/*not static*/,_Evacuate_OldRoot_Forward);
558 STGFUN(Forward_Ref_entry) {
560 /* Don't wrap the calls; we're done with STG land */
562 fprintf(stderr,"Entered Forward_Ref %lx: Should never occur!\n", (W_) Node);
563 EXIT(EXIT_FAILURE); /* abort(); */
566 FORWARDREF_ITBL(Forward_Ref_info,Forward_Ref_entry,const/*not static*/,_Evacuate_Forward_Ref);
569 #endif /* _INFO_COPYING */
572 OLDROOT_ITBL(OldRoot_info,Ind_Entry,const,EF_);
577 %/***************************************************************
579 %* Cost Centre stuff ... *
581 %****************************************************************/
583 For cost centres we need prelude cost centres and register routine.
585 N.B. ALL prelude cost centres should be declared here as none will
586 be declared when the prelude is compiled.
588 ToDo: Explicit cost centres in prelude for Input and Output costs.
591 #if defined(PROFILING)
593 STGFUN(startCcRegisteringWorld)
597 * We used to push miniInterpretEnd on the register stack, but
598 * miniInterpretEnd must only be entered with the RESUME_ macro,
599 * whereas the other addresses on the register stack must only be
600 * entered with the JMP_ macro. Now, we push NULL and test for
601 * it explicitly at each pop.
603 PUSH_REGISTER_STACK(NULL);
608 CC_DECLARE(CC_CAFs, "CAFs_in_...", "PRELUDE", "PRELUDE", CC_IS_CAF,/*not static*/);
609 CC_DECLARE(CC_DICTs, "DICTs_in_...", "PRELUDE", "PRELUDE", CC_IS_DICT,/*not static*/);
611 START_REGISTER_PRELUDE(_regPrelude);
612 REGISTER_CC(CC_CAFs);
613 REGISTER_CC(CC_DICTs);
617 We also need cost centre declarations and registering routines for other
618 built-in prelude-like modules.
620 ToDo: What built-in prelude-like modules exist ?
623 START_REGISTER_PRELUDE(_regByteOps); /* used in Glasgow tests only? */
626 /* _regPrelude is above */
628 START_REGISTER_PRELUDE(_regPreludeArray);
631 START_REGISTER_PRELUDE(_regPreludeCore);
634 START_REGISTER_PRELUDE(_regPreludeDialogueIO);
637 START_REGISTER_PRELUDE(_regPreludeGlaMisc);
640 START_REGISTER_PRELUDE(_regPreludeGlaST);
643 START_REGISTER_PRELUDE(_regPreludeIOError);
646 START_REGISTER_PRELUDE(_regPreludePS);
649 START_REGISTER_PRELUDE(_regPreludePrimIO);
652 START_REGISTER_PRELUDE(_regPreludeStdIO);