1 /* -----------------------------------------------------------------------------
2 * $Id: Regs.h,v 1.9 2000/03/23 17:45:31 simonpj Exp $
4 * (c) The GHC Team, 1998-1999
6 * Registers used in STG code. Might or might not correspond to
7 * actual machine registers.
9 * ---------------------------------------------------------------------------*/
15 * This file should do the right thing if we have no machine-registers
16 * defined, i.e. everything lives in the RegTable.
20 * This is the table that holds shadow-locations for all the STG
21 * registers. The shadow locations are used when:
23 * 1) the particular register isn't mapped to a real machine
24 * register, probably because there's a shortage of real registers.
25 * 2) caller-saves registers are saved across a CCall
28 typedef struct StgSparkPool_ {
35 typedef struct StgRegTable_ {
44 StgUnion rR9; /* used occasionally by heap/stack checks */
45 StgUnion rR10; /* used occasionally by heap/stack checks */
59 struct _bdescr *rNursery;
60 struct _bdescr *rCurrentNursery;
61 #if defined(SMP) || defined(PAR)
62 StgSparkPool rSparks; /* per-task spark pool */
65 struct StgRegTable_ *link; /* per-task register tables are linked together */
69 /* No such thing as a MainRegTable under SMP - each thread must
70 * have its own MainRegTable.
73 extern DLL_IMPORT_RTS StgRegTable MainRegTable;
79 * Registers Hp and HpLim are global across the entire system, and are
80 * copied into the RegTable before executing a thread.
82 * Registers Sp, Su, and SpLim are saved in the TSO for the
83 * thread, but are copied into the RegTable before executing a thread.
85 * All other registers are "general purpose", and are used for passing
86 * arguments to functions, and returning values. The code generator
87 * knows how many of these are in real registers, and avoids
88 * generating code that uses non-real registers. General purpose
89 * registers are never saved when returning to the scheduler, instead
90 * we save whatever is live at the time on the stack, and restore it
91 * later. This should reduce the context switch time, amongst other
94 * For argument passing, the stack will be used in preference to
95 * pseudo-registers if the architecture has too few general purpose
98 * Some special RTS functions like newArray and the Integer primitives
99 * expect their arguments to be in registers R1-Rn, so we use these
100 * (pseudo-)registers in those cases.
104 * Locations for saving per-thread registers.
107 #define SAVE_Sp (CurrentTSO->sp)
108 #define SAVE_Su (CurrentTSO->su)
109 #define SAVE_SpLim (CurrentTSO->splim)
111 #define SAVE_Hp (BaseReg->rHp)
112 #define SAVE_HpLim (BaseReg->rHpLim)
114 #define SAVE_CurrentTSO (BaseReg->rCurrentTSO)
115 #define SAVE_CurrentNursery (BaseReg->rCurrentNursery)
116 #if defined(SMP) || defined(PAR)
117 #define SAVE_SparkHd (BaseReg->rSparks.hd)
118 #define SAVE_SparkTl (BaseReg->rSparks.tl)
119 #define SAVE_SparkBase (BaseReg->rSparks.base)
120 #define SAVE_SparkLim (BaseReg->rSparks.lim)
123 /* We sometimes need to save registers across a C-call, eg. if they
124 * are clobbered in the standard calling convention. We define the
125 * save locations for all registers in the register table.
128 #define SAVE_R1 (BaseReg->rR1)
129 #define SAVE_R2 (BaseReg->rR2)
130 #define SAVE_R3 (BaseReg->rR3)
131 #define SAVE_R4 (BaseReg->rR4)
132 #define SAVE_R5 (BaseReg->rR5)
133 #define SAVE_R6 (BaseReg->rR6)
134 #define SAVE_R7 (BaseReg->rR7)
135 #define SAVE_R8 (BaseReg->rR8)
137 #define SAVE_F1 (BaseReg->rF1)
138 #define SAVE_F2 (BaseReg->rF2)
139 #define SAVE_F3 (BaseReg->rF3)
140 #define SAVE_F4 (BaseReg->rF4)
142 #define SAVE_D1 (BaseReg->rD1)
143 #define SAVE_D2 (BaseReg->rD2)
145 #define SAVE_L1 (BaseReg->rL1)
147 /* -----------------------------------------------------------------------------
148 * Emit the GCC-specific register declarations for each machine
149 * register being used. If any STG register isn't mapped to a machine
150 * register, then map it to an offset from BaseReg.
152 * First, the general purpose registers. The idea is, if a particular
153 * general-purpose STG register can't be mapped to a real machine
154 * register, it won't be used at all. Instead, we'll use the stack.
156 * This is an improvement on the way things used to be done, when all
157 * registers were mapped to locations in the register table, and stuff
158 * was being shifted from the stack to the register table and back
159 * again for no good reason (on register-poor architectures).
162 #define GLOBAL_REG_DECL(type,name,reg) register type name REG(reg);
165 GLOBAL_REG_DECL(StgUnion,R1,REG_R1)
167 #define R1 (BaseReg->rR1)
171 GLOBAL_REG_DECL(StgUnion,R2,REG_R2)
173 #define R2 (BaseReg->rR2)
177 GLOBAL_REG_DECL(StgUnion,R3,REG_R3)
179 # define R3 (BaseReg->rR3)
183 GLOBAL_REG_DECL(StgUnion,R4,REG_R4)
185 # define R4 (BaseReg->rR4)
189 GLOBAL_REG_DECL(StgUnion,R5,REG_R5)
191 # define R5 (BaseReg->rR5)
195 GLOBAL_REG_DECL(StgUnion,R6,REG_R6)
197 # define R6 (BaseReg->rR6)
201 GLOBAL_REG_DECL(StgUnion,R7,REG_R7)
203 # define R7 (BaseReg->rR7)
207 GLOBAL_REG_DECL(StgUnion,R8,REG_R8)
209 # define R8 (BaseReg->rR8)
213 GLOBAL_REG_DECL(StgUnion,R9,REG_R9)
215 # define R9 (BaseReg->rR9)
219 GLOBAL_REG_DECL(StgUnion,R10,REG_R10)
221 # define R10 (BaseReg->rR10)
225 GLOBAL_REG_DECL(StgFloat,F1,REG_F1)
227 #define F1 (BaseReg->rF1)
231 GLOBAL_REG_DECL(StgFloat,F2,REG_F2)
233 #define F2 (BaseReg->rF2)
237 GLOBAL_REG_DECL(StgFloat,F3,REG_F3)
239 #define F3 (BaseReg->rF3)
243 GLOBAL_REG_DECL(StgFloat,F4,REG_F4)
245 #define F4 (BaseReg->rF4)
249 GLOBAL_REG_DECL(StgDouble,D1,REG_D1)
251 #define D1 (BaseReg->rD1)
255 GLOBAL_REG_DECL(StgDouble,D2,REG_D2)
257 #define D2 (BaseReg->rD2)
261 GLOBAL_REG_DECL(StgWord64,L1,REG_L1)
263 #define L1 (BaseReg->rL1)
267 * If BaseReg isn't mapped to a machine register, just use the global
268 * address of the current register table (CurrentRegTable in
269 * concurrent Haskell, MainRegTable otherwise).
273 GLOBAL_REG_DECL(StgRegTable *,BaseReg,REG_Base)
276 #error BaseReg must be in a register for SMP
278 #define BaseReg (&MainRegTable)
282 GLOBAL_REG_DECL(P_,Sp,REG_Sp)
284 #define Sp (BaseReg->rSp)
288 GLOBAL_REG_DECL(StgUpdateFrame *,Su,REG_Su)
290 #define Su (BaseReg->rSu)
294 GLOBAL_REG_DECL(P_,SpLim,REG_SpLim)
296 #define SpLim (BaseReg->rSpLim)
300 GLOBAL_REG_DECL(P_,Hp,REG_Hp)
302 #define Hp (BaseReg->rHp)
306 GLOBAL_REG_DECL(P_,HpLim,REG_HpLim)
308 #define HpLim (BaseReg->rHpLim)
311 #ifdef REG_CurrentTSO
312 GLOBAL_REG_DECL(StgTSO *,CurrentTSO,REG_CurrentTSO)
314 #define CurrentTSO (BaseReg->rCurrentTSO)
317 #ifdef REG_CurrentNursery
318 GLOBAL_REG_DECL(bdescr *,CurrentNursery,REG_CurrentNursery)
320 #define CurrentNursery (BaseReg->rCurrentNursery)
324 GLOBAL_REG_DECL(bdescr *,SparkHd,REG_SparkHd)
326 #define SparkHd (BaseReg->rSparks.hd)
330 GLOBAL_REG_DECL(bdescr *,SparkTl,REG_SparkTl)
332 #define SparkTl (BaseReg->rSparks.tl)
336 GLOBAL_REG_DECL(bdescr *,SparkBase,REG_SparkBase)
338 #define SparkBase (BaseReg->rSparks.base)
342 GLOBAL_REG_DECL(bdescr *,SparkLim,REG_SparkLim)
344 #define SparkLim (BaseReg->rSparks.lim)
347 /* -----------------------------------------------------------------------------
348 For any registers which are denoted "caller-saves" by the C calling
349 convention, we have to emit code to save and restore them across C
351 -------------------------------------------------------------------------- */
353 #ifdef CALLER_SAVES_R1
354 #define CALLER_SAVE_R1 SAVE_R1 = R1;
355 #define CALLER_RESTORE_R1 R1 = SAVE_R1;
357 #define CALLER_SAVE_R1 /* nothing */
358 #define CALLER_RESTORE_R1 /* nothing */
361 #ifdef CALLER_SAVES_R2
362 #define CALLER_SAVE_R2 SAVE_R2 = R2;
363 #define CALLER_RESTORE_R2 R2 = SAVE_R2;
365 #define CALLER_SAVE_R2 /* nothing */
366 #define CALLER_RESTORE_R2 /* nothing */
369 #ifdef CALLER_SAVES_R3
370 #define CALLER_SAVE_R3 SAVE_R3 = R3;
371 #define CALLER_RESTORE_R3 R3 = SAVE_R3;
373 #define CALLER_SAVE_R3 /* nothing */
374 #define CALLER_RESTORE_R3 /* nothing */
377 #ifdef CALLER_SAVES_R4
378 #define CALLER_SAVE_R4 SAVE_R4 = R4;
379 #define CALLER_RESTORE_R4 R4 = SAVE_R4;
381 #define CALLER_SAVE_R4 /* nothing */
382 #define CALLER_RESTORE_R4 /* nothing */
385 #ifdef CALLER_SAVES_R5
386 #define CALLER_SAVE_R5 SAVE_R5 = R5;
387 #define CALLER_RESTORE_R5 R5 = SAVE_R5;
389 #define CALLER_SAVE_R5 /* nothing */
390 #define CALLER_RESTORE_R5 /* nothing */
393 #ifdef CALLER_SAVES_R6
394 #define CALLER_SAVE_R6 SAVE_R6 = R6;
395 #define CALLER_RESTORE_R6 R6 = SAVE_R6;
397 #define CALLER_SAVE_R6 /* nothing */
398 #define CALLER_RESTORE_R6 /* nothing */
401 #ifdef CALLER_SAVES_R7
402 #define CALLER_SAVE_R7 SAVE_R7 = R7;
403 #define CALLER_RESTORE_R7 R7 = SAVE_R7;
405 #define CALLER_SAVE_R7 /* nothing */
406 #define CALLER_RESTORE_R7 /* nothing */
409 #ifdef CALLER_SAVES_R8
410 #define CALLER_SAVE_R8 SAVE_R8 = R8;
411 #define CALLER_RESTORE_R8 R8 = SAVE_R8;
413 #define CALLER_SAVE_R8 /* nothing */
414 #define CALLER_RESTORE_R8 /* nothing */
417 #ifdef CALLER_SAVES_R9
418 #define CALLER_SAVE_R9 SAVE_R9 = R9;
419 #define CALLER_RESTORE_R9 R9 = SAVE_R9;
421 #define CALLER_SAVE_R9 /* nothing */
422 #define CALLER_RESTORE_R9 /* nothing */
425 #ifdef CALLER_SAVES_R10
426 #define CALLER_SAVE_R10 SAVE_R10 = R10;
427 #define CALLER_RESTORE_R10 R10 = SAVE_R10;
429 #define CALLER_SAVE_R10 /* nothing */
430 #define CALLER_RESTORE_R10 /* nothing */
433 #ifdef CALLER_SAVES_F1
434 #define CALLER_SAVE_F1 SAVE_F1 = F1;
435 #define CALLER_RESTORE_F1 F1 = SAVE_F1;
437 #define CALLER_SAVE_F1 /* nothing */
438 #define CALLER_RESTORE_F1 /* nothing */
441 #ifdef CALLER_SAVES_F2
442 #define CALLER_SAVE_F2 SAVE_F2 = F2;
443 #define CALLER_RESTORE_F2 F2 = SAVE_F2;
445 #define CALLER_SAVE_F2 /* nothing */
446 #define CALLER_RESTORE_F2 /* nothing */
449 #ifdef CALLER_SAVES_F3
450 #define CALLER_SAVE_F3 SAVE_F3 = F3;
451 #define CALLER_RESTORE_F3 F3 = SAVE_F3;
453 #define CALLER_SAVE_F3 /* nothing */
454 #define CALLER_RESTORE_F3 /* nothing */
457 #ifdef CALLER_SAVES_F4
458 #define CALLER_SAVE_F4 SAVE_F4 = F4;
459 #define CALLER_RESTORE_F4 F4 = SAVE_F4;
461 #define CALLER_SAVE_F4 /* nothing */
462 #define CALLER_RESTORE_F4 /* nothing */
465 #ifdef CALLER_SAVES_D1
466 #define CALLER_SAVE_D1 SAVE_D1 = D1;
467 #define CALLER_RESTORE_D1 D1 = SAVE_D1;
469 #define CALLER_SAVE_D1 /* nothing */
470 #define CALLER_RESTORE_D1 /* nothing */
473 #ifdef CALLER_SAVES_D2
474 #define CALLER_SAVE_D2 SAVE_D2 = D2;
475 #define CALLER_RESTORE_D2 D2 = SAVE_D2;
477 #define CALLER_SAVE_D2 /* nothing */
478 #define CALLER_RESTORE_D2 /* nothing */
481 #ifdef CALLER_SAVES_L1
482 #define CALLER_SAVE_L1 SAVE_L1 = L1;
483 #define CALLER_RESTORE_L1 L1 = SAVE_L1;
485 #define CALLER_SAVE_L1 /* nothing */
486 #define CALLER_RESTORE_L1 /* nothing */
489 #ifdef CALLER_SAVES_Sp
490 #define CALLER_SAVE_Sp SAVE_Sp = Sp;
491 #define CALLER_RESTORE_Sp Sp = SAVE_Sp;
493 #define CALLER_SAVE_Sp /* nothing */
494 #define CALLER_RESTORE_Sp /* nothing */
497 #ifdef CALLER_SAVES_Su
498 #define CALLER_SAVE_Su SAVE_Su = Su;
499 #define CALLER_RESTORE_Su Su = SAVE_Su;
501 #define CALLER_SAVE_Su /* nothing */
502 #define CALLER_RESTORE_Su /* nothing */
505 #ifdef CALLER_SAVES_SpLim
506 #define CALLER_SAVE_SpLim SAVE_SpLim = SpLim;
507 #define CALLER_RESTORE_SpLim SpLim = SAVE_SpLim;
509 #define CALLER_SAVE_SpLim /* nothing */
510 #define CALLER_RESTORE_SpLim /* nothing */
513 #ifdef CALLER_SAVES_Hp
514 #define CALLER_SAVE_Hp SAVE_Hp = Hp;
515 #define CALLER_RESTORE_Hp Hp = SAVE_Hp;
517 #define CALLER_SAVE_Hp /* nothing */
518 #define CALLER_RESTORE_Hp /* nothing */
521 #ifdef CALLER_SAVES_HpLim
522 #define CALLER_SAVE_HpLim SAVE_HpLim = HpLim;
523 #define CALLER_RESTORE_HpLim HpLim = SAVE_HpLim;
525 #define CALLER_SAVE_HpLim /* nothing */
526 #define CALLER_RESTORE_HpLim /* nothing */
529 #ifdef CALLER_SAVES_Base
531 #error "Can't have caller-saved BaseReg with SMP"
533 #define CALLER_SAVE_Base /* nothing */
534 #define CALLER_RESTORE_Base BaseReg = &MainRegTable;
536 #define CALLER_SAVE_Base /* nothing */
537 #define CALLER_RESTORE_Base /* nothing */
540 #ifdef CALLER_SAVES_CurrentTSO
541 #define CALLER_SAVE_CurrentTSO SAVE_CurrentTSO = CurrentTSO;
542 #define CALLER_RESTORE_CurrentTSO CurrentTSO = SAVE_CurrentTSO;
544 #define CALLER_SAVE_CurrentTSO /* nothing */
545 #define CALLER_RESTORE_CurrentTSO /* nothing */
548 #ifdef CALLER_SAVES_CurrentNursery
549 #define CALLER_SAVE_CurrentNursery SAVE_CurrentNursery = CurrentNursery;
550 #define CALLER_RESTORE_CurrentNursery CurrentNursery = SAVE_CurrentNursery;
552 #define CALLER_SAVE_CurrentNursery /* nothing */
553 #define CALLER_RESTORE_CurrentNursery /* nothing */
556 #ifdef CALLER_SAVES_SparkHd
557 #define CALLER_SAVE_SparkHd SAVE_SparkHd = SparkHd;
558 #define CALLER_RESTORE_SparkHd SparkHd = SAVE_SparkHd;
560 #define CALLER_SAVE_SparkHd /* nothing */
561 #define CALLER_RESTORE_SparkHd /* nothing */
564 #ifdef CALLER_SAVES_SparkTl
565 #define CALLER_SAVE_SparkTl SAVE_SparkTl = SparkTl;
566 #define CALLER_RESTORE_SparkTl SparkTl = SAVE_SparkTl;
568 #define CALLER_SAVE_SparkTl /* nothing */
569 #define CALLER_RESTORE_SparkTl /* nothing */
572 #ifdef CALLER_SAVES_SparkBase
573 #define CALLER_SAVE_SparkBase SAVE_SparkBase = SparkBase;
574 #define CALLER_RESTORE_SparkBase SparkBase = SAVE_SparkBase;
576 #define CALLER_SAVE_SparkBase /* nothing */
577 #define CALLER_RESTORE_SparkBase /* nothing */
580 #ifdef CALLER_SAVES_SparkLim
581 #define CALLER_SAVE_SparkLim SAVE_SparkLim = SparkLim;
582 #define CALLER_RESTORE_SparkLim SparkLim = SAVE_SparkLim;
584 #define CALLER_SAVE_SparkLim /* nothing */
585 #define CALLER_RESTORE_SparkLim /* nothing */
588 #endif /* IN_STG_CODE */
590 /* ----------------------------------------------------------------------------
591 Handy bunches of saves/restores
592 ------------------------------------------------------------------------ */
596 #define CALLER_SAVE_USER \
613 /* Save Base last, since the others may
614 be addressed relative to it */
615 #define CALLER_SAVE_SYSTEM \
621 CALLER_SAVE_CurrentTSO \
622 CALLER_SAVE_CurrentNursery \
623 CALLER_SAVE_SparkHd \
624 CALLER_SAVE_SparkTl \
625 CALLER_SAVE_SparkBase \
626 CALLER_SAVE_SparkLim \
629 #define CALLER_RESTORE_USER \
646 /* Restore Base first, since the others may
647 be addressed relative to it */
648 #define CALLER_RESTORE_SYSTEM \
649 CALLER_RESTORE_Base \
652 CALLER_RESTORE_SpLim \
654 CALLER_RESTORE_HpLim \
655 CALLER_RESTORE_CurrentTSO \
656 CALLER_RESTORE_CurrentNursery \
657 CALLER_RESTORE_SparkHd \
658 CALLER_RESTORE_SparkTl \
659 CALLER_RESTORE_SparkBase \
660 CALLER_RESTORE_SparkLim
662 #else /* not IN_STG_CODE */
664 #define CALLER_SAVE_USER /* nothing */
665 #define CALLER_SAVE_SYSTEM /* nothing */
666 #define CALLER_RESTORE_USER /* nothing */
667 #define CALLER_RESTORE_SYSTEM /* nothing */
669 #endif /* IN_STG_CODE */
671 #define CALLER_SAVE_ALL \
675 #define CALLER_RESTORE_ALL \
676 CALLER_RESTORE_SYSTEM \