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 Object 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_ GHC_void_closure = (P_) 0xbadbadbaL;
205 STGFUN(startStgWorld)
208 /* At this point we are in the threaded-code world.
210 TopClosure points to a closure of type PrimIO (), which should be
211 performed (by applying it to the state of the world).
213 The smInfo storage-management info block is assumed to be
214 up to date, and is used to load the STG registers.
217 RestoreAllStgRegs(); /* inline! */
219 /* ------- STG registers are now valid! -------------------------*/
221 /* Put a suitable return address on the B stack */
222 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
224 /* Put an IoWorld token on the A stack */
226 *SpB = (P_) realWorldZh_closure;
228 Node = (P_) TopClosure; /* Point to the closure for main/errorIO-arg */
230 InfoPtr=(D_)(INFO_PTR(Node));
231 JMP_(ENTRY_CODE(InfoPtr));
234 #endif /* ! CONCURRENT */
238 %************************************************************************
240 \subsection[thread-return]{Polymorphic end-of-thread code}
242 %************************************************************************
247 Here's the polymorphic return for the end of a thread.
249 NB: For direct returns to work properly, the name of the routine must be
250 the same as the name of the vector table with vtbl_ removed and DirectReturn
251 appended. This is all the mangler understands.
255 vtbl_stopThread[] = {
256 /* at least "MAX_VECTORED_RTN" elements (see GhcConstants.lh) */
257 (W_) stopThreadDirectReturn,
258 (W_) stopThreadDirectReturn,
259 (W_) stopThreadDirectReturn,
260 (W_) stopThreadDirectReturn,
261 (W_) stopThreadDirectReturn,
262 (W_) stopThreadDirectReturn,
263 (W_) stopThreadDirectReturn,
264 (W_) stopThreadDirectReturn
267 STGFUN(stopThreadDirectReturn)
272 The top-top-level closures (e.g., "main") are of type "IO ()".
273 When entered, they perform an IO action and return a () --
274 essentially, TagReg is set to 1. Here, we don't need to do
277 We just tidy up the register stuff (real regs in *_SAVE, then
278 *_SAVE -> smInfo locs).
282 SET_TASK_ACTIVITY(ST_OVERHEAD);
285 SaveAllStgRegs(); /* inline! */
290 RESUME_(miniInterpretEnd);
298 I_ ErrorIO_call_count = 0;
301 EXTFUN(EnterNodeCode);
303 STGFUN(ErrorIO_innards)
304 /* Assumes that "TopClosure" has been set already */
307 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
308 /* Don't wrap the calls; we're done with STG land */
310 fprintf(stderr, "too many nested calls to `error'\n");
313 ErrorIO_call_count++; /* NB: undo later if decide to let someone else handle it */
315 /* Unlock all global closures held by this thread! (ToDo) --JSM */
317 switch(TSO_TYPE(CurrentTSO)) {
319 /* Re-initialize stack pointers (cf. NewThread) */
321 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
322 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
324 SuA = stackInfo.botA + AREL(1);
325 SuB = stackInfo.botB + BREL(1);
328 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
329 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
336 /* Re-initialize stack pointers (cf. NewThread) */
337 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
338 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
342 ErrorIO_call_count--; /* undo the damage, as someone else will deal with it */
343 /* Let the main thread eventually handle it */
344 JMP_(stopThreadDirectReturn);
350 /* Don't wrap the calls; we're done with STG land */
352 fprintf(stderr,"ErrorIO: %lx unknown\n", TSO_TYPE(CurrentTSO));
356 /* Finish stack setup as if for a top-level task and enter the error node */
358 /* Put an IoWorld token on the B stack */
360 *SpB = (P_) realWorldZh_closure;
363 *SpA = (P_) realWorldZh_closure;
365 STKO_LINK(StkOReg) = PrelBase_Z91Z93_closure;
366 STKO_RETURN(StkOReg) = NULL;
369 STKO_ADEP(StkOReg) = STKO_BDEP(StkOReg) = 0;
373 Node = (P_) TopClosure;
374 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
381 We cannot afford to call @error@ too many times
382 (e.g., \tr{error x where x = error x}), so we keep count.
385 #else /* !CONCURRENT */
388 ErrorIO_innards(STG_NO_ARGS)
389 /* Assumes that "TopClosure" has been set already */
392 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
393 /* Don't wrap the calls; we're done with STG land */
395 fprintf(stderr, "too many nested calls to `error'\n");
398 ErrorIO_call_count++;
400 /* Copy the heap-related registers into smInfo. (Other registers get
401 saved in this process, but we aren't interested in them.)
403 Get a new stack (which re-initialises the smInfo stack stuff),
404 and start the world again.
406 /* ToDo: chk this has been handled in parallel world */
408 SaveAllStgRegs(); /* inline! */
410 if (! initStacks( &StorageMgrInfo )) {
411 /* Don't wrap the calls; we're done with STG land */
413 fprintf(stderr, "initStacks failed!\n");
417 JMP_( startStgWorld );
421 #endif /* !CONCURRENT */
425 #if defined(PAR) || defined(GRAN)
427 STATICFUN(RBH_Save_0_entry)
430 fprintf(stderr,"Oops, entered an RBH save\n");
435 STATICFUN(RBH_Save_1_entry)
438 fprintf(stderr,"Oops, entered an RBH save\n");
443 STATICFUN(RBH_Save_2_entry)
446 fprintf(stderr,"Oops, entered an RBH save\n");
451 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");
452 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");
453 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");
455 #endif /* PAR || GRAN */
459 %/****************************************************************
461 %* Other Bits and Pieces *
463 %****************************************************************/
466 /* If we don't need the slow entry code for a closure, we put in a
467 pointer to this in the closure's slow entry code pointer instead.
470 STGFUN(__std_entry_error__) {
472 /* Don't wrap the calls; we're done with STG land */
474 fprintf(stderr, "Called non-existent slow-entry code!!!\n");
481 STGFUN(STK_STUB_entry) {
483 /* Don't wrap the calls; we're done with STG land */
485 fprintf(stderr, "Entered from a stubbed stack slot!\n");
492 STATIC_ITBL(STK_STUB_info,STK_STUB_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,EF_,INTERNAL_KIND,"STK_STUB","STK_STUB");
495 SET_STATIC_HDR(STK_STUB_closure,STK_STUB_info,CC_SUBSUMED,,EXTDATA_RO)
500 %/****************************************************************
502 %* Some GC info tables *
504 %****************************************************************/
506 These have to be in a .lhc file, so they will be reversed correctly.
509 #include "../storage/SMinternal.h"
511 #if defined(_INFO_COPYING)
513 STGFUN(Caf_Evac_Upd_entry) {
515 /* Don't wrap the calls; we're done with STG land */
517 fprintf(stderr,"Entered Caf_Evac_Upd %lx: Should never occur!\n", (W_) Node);
522 CAF_EVAC_UPD_ITBL(Caf_Evac_Upd_info,Caf_Evac_Upd_entry,const/*not static*/);
526 STGFUN(Forward_Ref_New_entry) {
528 /* Don't wrap the calls; we're done with STG land */
530 fprintf(stderr,"Entered Forward_Ref_New %lx: Should never occur!\n", (W_) Node);
531 EXIT(EXIT_FAILURE); /* abort(); */
534 FORWARDREF_ITBL(Forward_Ref_New_info,Forward_Ref_New_entry,const/*not static*/,_Evacuate_Old_Forward_Ref);
536 STGFUN(Forward_Ref_Old_entry) {
538 /* Don't wrap the calls; we're done with STG land */
540 fprintf(stderr,"Entered Forward_Ref_Old %lx: Should never occur!\n", (W_) Node);
541 EXIT(EXIT_FAILURE); /* abort(); */
544 FORWARDREF_ITBL(Forward_Ref_Old_info,Forward_Ref_Old_entry,const/*not static*/,_Evacuate_New_Forward_Ref);
546 STGFUN(OldRoot_Forward_Ref_entry) {
548 /* Don't wrap the calls; we're done with STG land */
550 fprintf(stderr,"Entered OldRoot_Forward_Ref %lx: Should never occur!\n", (W_) Node);
551 EXIT(EXIT_FAILURE); /* abort(); */
554 FORWARDREF_ITBL(OldRoot_Forward_Ref_info,OldRoot_Forward_Ref_entry,const/*not static*/,_Evacuate_OldRoot_Forward);
557 STGFUN(Forward_Ref_entry) {
559 /* Don't wrap the calls; we're done with STG land */
561 fprintf(stderr,"Entered Forward_Ref %lx: Should never occur!\n", (W_) Node);
562 EXIT(EXIT_FAILURE); /* abort(); */
565 FORWARDREF_ITBL(Forward_Ref_info,Forward_Ref_entry,const/*not static*/,_Evacuate_Forward_Ref);
568 #endif /* _INFO_COPYING */
571 OLDROOT_ITBL(OldRoot_info,Ind_Entry,const,EF_);
576 %/***************************************************************
578 %* Cost Centre stuff ... *
580 %****************************************************************/
582 For cost centres we need prelude cost centres and register routine.
584 N.B. ALL prelude cost centres should be declared here as none will
585 be declared when the prelude is compiled.
587 ToDo: Explicit cost centres in prelude for Input and Output costs.
590 #if defined(PROFILING)
592 STGFUN(startCcRegisteringWorld)
596 * We used to push miniInterpretEnd on the register stack, but
597 * miniInterpretEnd must only be entered with the RESUME_ macro,
598 * whereas the other addresses on the register stack must only be
599 * entered with the JMP_ macro. Now, we push NULL and test for
600 * it explicitly at each pop.
602 PUSH_REGISTER_STACK(NULL);
607 CC_DECLARE(CC_CAFs, "CAFs_in_...", "PRELUDE", "PRELUDE", CC_IS_CAF,/*not static*/);
608 CC_DECLARE(CC_DICTs, "DICTs_in_...", "PRELUDE", "PRELUDE", CC_IS_DICT,/*not static*/);
610 START_REGISTER_PRELUDE(_regPrel);
611 REGISTER_CC(CC_CAFs);
612 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(_regGHCbase);
631 /* OLD: START_REGISTER_PRELUDE(_regGHCerr); */
632 START_REGISTER_PRELUDE(_regGHC);
635 START_REGISTER_PRELUDE(_regPreludeGlaST);