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 */
196 /* Not a natural home for these, but
197 the following symbols may be referenced in
198 an object file, but never entered
200 P_ PrelGHC_void_closure = (P_) 0xbadbadbaL;
201 P_ PrelGHC_ZcCCallable_static_info = (P_) 0xbadbadbaL;
202 P_ PrelGHC_ZcCReturnable_static_info = (P_) 0xbadbadbaL;
204 /* the IoWorld token to start the whole thing off */
205 /* Question: this is just an amusing hex code isn't it
206 -- or does it mean something? ADR */
207 P_ realWorldZh_closure = (P_) 0xbadbadbaL;
211 STGFUN(startStgWorld)
214 /* At this point we are in the threaded-code world.
216 TopClosure points to a closure of type PrimIO (), which should be
217 performed (by applying it to the state of the world).
219 The smInfo storage-management info block is assumed to be
220 up to date, and is used to load the STG registers.
223 RestoreAllStgRegs(); /* inline! */
225 /* ------- STG registers are now valid! -------------------------*/
227 /* Put a suitable return address on the B stack */
228 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
230 /* Put an IoWorld token on the A stack */
232 *SpB = (P_) realWorldZh_closure;
234 Node = (P_) TopClosure; /* Point to the closure for main/errorIO-arg */
236 InfoPtr=(D_)(INFO_PTR(Node));
237 JMP_(ENTRY_CODE(InfoPtr));
240 #endif /* ! CONCURRENT */
244 %************************************************************************
246 \subsection[thread-return]{Polymorphic end-of-thread code}
248 %************************************************************************
253 Here's the polymorphic return for the end of a thread.
255 NB: For direct returns to work properly, the name of the routine must be
256 the same as the name of the vector table with vtbl_ removed and DirectReturn
257 appended. This is all the mangler understands.
261 vtbl_stopThread[] = {
262 /* at least "MAX_VECTORED_RTN" elements (see GhcConstants.lh) */
263 (W_) stopThreadDirectReturn,
264 (W_) stopThreadDirectReturn,
265 (W_) stopThreadDirectReturn,
266 (W_) stopThreadDirectReturn,
267 (W_) stopThreadDirectReturn,
268 (W_) stopThreadDirectReturn,
269 (W_) stopThreadDirectReturn,
270 (W_) stopThreadDirectReturn
273 STGFUN(stopThreadDirectReturn)
278 The top-top-level closures (e.g., "main") are of type "IO ()".
279 When entered, they perform an IO action and return a () --
280 essentially, TagReg is set to 1. Here, we don't need to do
283 We just tidy up the register stuff (real regs in *_SAVE, then
284 *_SAVE -> smInfo locs).
288 SET_TASK_ACTIVITY(ST_OVERHEAD);
291 SaveAllStgRegs(); /* inline! */
296 RESUME_(miniInterpretEnd);
304 I_ ErrorIO_call_count = 0;
307 EXTFUN(EnterNodeCode);
309 STGFUN(ErrorIO_innards)
310 /* Assumes that "TopClosure" has been set already */
313 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
314 /* Don't wrap the calls; we're done with STG land */
316 fprintf(stderr, "too many nested calls to `error'\n");
319 ErrorIO_call_count++; /* NB: undo later if decide to let someone else handle it */
321 /* Unlock all global closures held by this thread! (ToDo) --JSM */
323 switch(TSO_TYPE(CurrentTSO)) {
325 /* Re-initialize stack pointers (cf. NewThread) */
327 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
328 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
330 SuA = stackInfo.botA + AREL(1);
331 SuB = stackInfo.botB + BREL(1);
334 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
335 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
342 /* Re-initialize stack pointers (cf. NewThread) */
343 SpB = SuB = STKO_BSTK_BOT(StkOReg) + BREL(1);
344 SuA = STKO_ASTK_BOT(StkOReg) + AREL(1);
348 ErrorIO_call_count--; /* undo the damage, as someone else will deal with it */
349 /* Let the main thread eventually handle it */
350 JMP_(stopThreadDirectReturn);
356 /* Don't wrap the calls; we're done with STG land */
358 fprintf(stderr,"ErrorIO: %lx unknown\n", TSO_TYPE(CurrentTSO));
362 /* Finish stack setup as if for a top-level task and enter the error node */
364 /* Put an IoWorld token on the B stack */
366 *SpB = (P_) realWorldZh_closure;
369 *SpA = (P_) realWorldZh_closure;
371 STKO_LINK(StkOReg) = PrelBase_Z91Z93_closure;
372 STKO_RETURN(StkOReg) = NULL;
375 STKO_ADEP(StkOReg) = STKO_BDEP(StkOReg) = 0;
379 Node = (P_) TopClosure;
380 RetReg = (StgRetAddr) UNVEC(stopThreadDirectReturn,vtbl_stopStgWorld);
387 We cannot afford to call @error@ too many times
388 (e.g., \tr{error x where x = error x}), so we keep count.
391 #else /* !CONCURRENT */
394 ErrorIO_innards(STG_NO_ARGS)
395 /* Assumes that "TopClosure" has been set already */
398 if (ErrorIO_call_count >= 16 /* MAGIC CONSTANT */ ) {
399 /* Don't wrap the calls; we're done with STG land */
401 fprintf(stderr, "too many nested calls to `error'\n");
404 ErrorIO_call_count++;
406 /* Copy the heap-related registers into smInfo. (Other registers get
407 saved in this process, but we aren't interested in them.)
409 Get a new stack (which re-initialises the smInfo stack stuff),
410 and start the world again.
412 /* ToDo: chk this has been handled in parallel world */
414 SaveAllStgRegs(); /* inline! */
416 if (! initStacks( &StorageMgrInfo )) {
417 /* Don't wrap the calls; we're done with STG land */
419 fprintf(stderr, "initStacks failed!\n");
423 JMP_( startStgWorld );
427 #endif /* !CONCURRENT */
431 #if defined(PAR) || defined(GRAN)
433 STATICFUN(RBH_Save_0_entry)
436 fprintf(stderr,"Oops, entered an RBH save\n");
441 STATICFUN(RBH_Save_1_entry)
444 fprintf(stderr,"Oops, entered an RBH save\n");
449 STATICFUN(RBH_Save_2_entry)
452 fprintf(stderr,"Oops, entered an RBH save\n");
457 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");
458 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");
459 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");
461 #endif /* PAR || GRAN */
465 %/****************************************************************
467 %* Other Bits and Pieces *
469 %****************************************************************/
472 /* If we don't need the slow entry code for a closure, we put in a
473 pointer to this in the closure's slow entry code pointer instead.
476 STGFUN(__std_entry_error__) {
478 /* Don't wrap the calls; we're done with STG land */
480 fprintf(stderr, "Called non-existent slow-entry code!!!\n");
487 STGFUN(STK_STUB_entry) {
489 /* Don't wrap the calls; we're done with STG land */
491 fprintf(stderr, "Entered from a stubbed stack slot!\n");
498 STATIC_ITBL(STK_STUB_info,STK_STUB_entry,UpdErr,0,INFO_OTHER_TAG,0,0,const,EF_,INTERNAL_KIND,"STK_STUB","STK_STUB");
501 SET_STATIC_HDR(STK_STUB_closure,STK_STUB_info,CC_SUBSUMED,,EXTDATA_RO)
506 %/****************************************************************
508 %* Some GC info tables *
510 %****************************************************************/
512 These have to be in a .lhc file, so they will be reversed correctly.
515 #include "../storage/SMinternal.h"
517 #if defined(_INFO_COPYING)
519 STGFUN(Caf_Evac_Upd_entry) {
521 /* Don't wrap the calls; we're done with STG land */
523 fprintf(stderr,"Entered Caf_Evac_Upd %lx: Should never occur!\n", (W_) Node);
528 CAF_EVAC_UPD_ITBL(Caf_Evac_Upd_info,Caf_Evac_Upd_entry,const/*not static*/);
532 STGFUN(Forward_Ref_New_entry) {
534 /* Don't wrap the calls; we're done with STG land */
536 fprintf(stderr,"Entered Forward_Ref_New %lx: Should never occur!\n", (W_) Node);
537 EXIT(EXIT_FAILURE); /* abort(); */
540 FORWARDREF_ITBL(Forward_Ref_New_info,Forward_Ref_New_entry,const/*not static*/,_Evacuate_Old_Forward_Ref);
542 STGFUN(Forward_Ref_Old_entry) {
544 /* Don't wrap the calls; we're done with STG land */
546 fprintf(stderr,"Entered Forward_Ref_Old %lx: Should never occur!\n", (W_) Node);
547 EXIT(EXIT_FAILURE); /* abort(); */
550 FORWARDREF_ITBL(Forward_Ref_Old_info,Forward_Ref_Old_entry,const/*not static*/,_Evacuate_New_Forward_Ref);
552 STGFUN(OldRoot_Forward_Ref_entry) {
554 /* Don't wrap the calls; we're done with STG land */
556 fprintf(stderr,"Entered OldRoot_Forward_Ref %lx: Should never occur!\n", (W_) Node);
557 EXIT(EXIT_FAILURE); /* abort(); */
560 FORWARDREF_ITBL(OldRoot_Forward_Ref_info,OldRoot_Forward_Ref_entry,const/*not static*/,_Evacuate_OldRoot_Forward);
563 STGFUN(Forward_Ref_entry) {
565 /* Don't wrap the calls; we're done with STG land */
567 fprintf(stderr,"Entered Forward_Ref %lx: Should never occur!\n", (W_) Node);
568 EXIT(EXIT_FAILURE); /* abort(); */
571 FORWARDREF_ITBL(Forward_Ref_info,Forward_Ref_entry,const/*not static*/,_Evacuate_Forward_Ref);
574 #endif /* _INFO_COPYING */
577 OLDROOT_ITBL(OldRoot_info,Ind_Entry,const,EF_);
582 %/***************************************************************
584 %* Cost Centre stuff ... *
586 %****************************************************************/
588 For cost centres we need prelude cost centres and register routine.
590 N.B. ALL prelude cost centres should be declared here as none will
591 be declared when the prelude is compiled.
593 ToDo: Explicit cost centres in prelude for Input and Output costs.
596 #if defined(PROFILING)
598 STGFUN(startCcRegisteringWorld)
602 * We used to push miniInterpretEnd on the register stack, but
603 * miniInterpretEnd must only be entered with the RESUME_ macro,
604 * whereas the other addresses on the register stack must only be
605 * entered with the JMP_ macro. Now, we push NULL and test for
606 * it explicitly at each pop.
608 PUSH_REGISTER_STACK(NULL);
613 CC_DECLARE(CC_CAFs, "CAFs_in_...", "PRELUDE", "PRELUDE", CC_IS_CAF,/*not static*/);
614 CC_DECLARE(CC_DICTs, "DICTs_in_...", "PRELUDE", "PRELUDE", CC_IS_DICT,/*not static*/);
616 START_REGISTER_PRELUDE(_regPrel);
617 REGISTER_CC(CC_CAFs);
618 REGISTER_CC(CC_DICTs);
623 We also need cost centre declarations and registering routines for other
624 built-in prelude-like modules.
626 ToDo: What built-in prelude-like modules exist ?
629 START_REGISTER_PRELUDE(_regByteOps); /* used in Glasgow tests only? */
632 /* _regPrelude is above */
634 START_REGISTER_PRELUDE(_regPrelGHC);