2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 % $Id: CgCase.lhs,v 1.40 2000/03/27 16:22:09 simonpj Exp $
6 %********************************************************
8 \section[CgCase]{Converting @StgCase@ expressions}
10 %********************************************************
13 module CgCase ( cgCase, saveVolatileVarsAndRegs, restoreCurrentCostCentre
16 #include "HsVersions.h"
18 import {-# SOURCE #-} CgExpr ( cgExpr )
24 import AbsCUtils ( mkAbstractCs, mkAbsCStmts, mkAlgAltsCSwitch,
25 getAmodeRep, nonemptyAbsC
27 import CgUpdate ( reserveSeqFrame )
28 import CgBindery ( getVolatileRegs, getArgAmodes, getArgAmode,
29 bindNewToReg, bindNewToTemp,
31 rebindToStack, getCAddrMode,
32 getCAddrModeAndInfo, getCAddrModeIfVolatile,
33 buildContLivenessMask, nukeDeadBindings,
35 import CgCon ( bindConArgs, bindUnboxedTupleComponents )
36 import CgHeapery ( altHeapCheck, yield )
37 import CgRetConv ( dataReturnConvPrim, ctrlReturnConvAlg,
38 CtrlReturnConvention(..)
40 import CgStackery ( allocPrimStack, allocStackTop,
41 deAllocStackTop, freeStackSlots, dataStackSlots
43 import CgTailCall ( tailCallFun )
44 import CgUsages ( getSpRelOffset, getRealSp )
45 import CLabel ( CLabel, mkVecTblLabel, mkReturnPtLabel,
46 mkDefaultLabel, mkAltLabel, mkReturnInfoLabel,
47 mkErrorStdEntryLabel, mkClosureTblLabel
49 import ClosureInfo ( mkLFArgument )
50 import CmdLineOpts ( opt_SccProfilingOn, opt_GranMacros )
51 import CostCentre ( CostCentre )
52 import Id ( Id, idPrimRep, isDeadBinder )
53 import DataCon ( DataCon, dataConTag, fIRST_TAG, ConTag,
55 import VarSet ( varSetElems )
56 import Literal ( Literal )
57 import PrimOp ( primOpOutOfLine, PrimOp(..) )
58 import PrimRep ( getPrimRepSize, retPrimRepSize, PrimRep(..)
60 import TyCon ( TyCon, isEnumerationTyCon, isUnboxedTupleTyCon,
61 isNewTyCon, isAlgTyCon, isFunTyCon, isPrimTyCon,
62 tyConDataCons, tyConFamilySize )
63 import Type ( Type, typePrimRep, splitAlgTyConApp,
64 splitTyConApp_maybe, repType )
65 import Unique ( Unique, Uniquable(..), mkPseudoUnique1 )
66 import Maybes ( maybeToBool )
73 = GCMayHappen -- The scrutinee may involve GC, so everything must be
74 -- tidy before the code for the scrutinee.
76 | NoGC -- The scrutinee is a primitive value, or a call to a
77 -- primitive op which does no GC. Hence the case can
78 -- be done inline, without tidying up first.
81 It is quite interesting to decide whether to put a heap-check
82 at the start of each alternative. Of course we certainly have
83 to do so if the case forces an evaluation, or if there is a primitive
84 op which can trigger GC.
86 A more interesting situation is this:
93 default -> !C!; ...C...
96 where \tr{!x!} indicates a possible heap-check point. The heap checks
97 in the alternatives {\em can} be omitted, in which case the topmost
98 heapcheck will take their worst case into account.
100 In favour of omitting \tr{!B!}, \tr{!C!}:
102 - {\em May} save a heap overflow test,
103 if ...A... allocates anything. The other advantage
104 of this is that we can use relative addressing
105 from a single Hp to get at all the closures so allocated.
107 - No need to save volatile vars etc across the case
111 - May do more allocation than reqd. This sometimes bites us
112 badly. For example, nfib (ha!) allocates about 30\% more space if the
113 worst-casing is done, because many many calls to nfib are leaf calls
114 which don't need to allocate anything.
116 This never hurts us if there is only one alternative.
128 Special case #1: PrimOps returning enumeration types.
130 For enumeration types, we invent a temporary (builtin-unique 1) to
131 hold the tag, and cross our fingers that this doesn't clash with
132 anything else. Builtin-unique 0 is used for a similar reason when
133 compiling enumerated-type primops in CgExpr.lhs. We can't use the
134 unique from the case binder, because this is used to hold the actual
135 closure (when the case binder is live, that is).
137 There is an extra special case for
142 which generates no code for the primop, unless x is used in the
143 alternatives (in which case we lookup the tag in the relevant closure
144 table to get the closure).
146 Being a bit short of uniques for temporary variables here, we use
147 mkPseudoUnique1 to generate a temporary for the tag. We can't use
148 mkBuiltinUnique, because that occasionally clashes with some
149 temporaries generated for _ccall_GC, amongst others (see CgExpr.lhs).
152 cgCase (StgPrimApp op args res_ty)
153 live_in_whole_case live_in_alts bndr srt (StgAlgAlts ty alts deflt)
154 | isEnumerationTyCon tycon
155 = getArgAmodes args `thenFC` \ arg_amodes ->
157 let tag_amode = case op of
158 TagToEnumOp -> only arg_amodes
159 _ -> CTemp (mkPseudoUnique1{-see above-} 1) IntRep
161 closure = CVal (CIndex (CLbl (mkClosureTblLabel tycon) PtrRep) tag_amode PtrRep) PtrRep
165 TagToEnumOp -> nopC; -- no code!
167 _ -> -- Perform the operation
168 getVolatileRegs live_in_alts `thenFC` \ vol_regs ->
170 absC (COpStmt [tag_amode] op
171 arg_amodes -- note: no liveness arg
175 -- bind the default binder if necessary
176 -- The deadness info is set by StgVarInfo
177 (if (isDeadBinder bndr)
179 else bindNewToTemp bndr `thenFC` \ bndr_amode ->
180 absC (CAssign bndr_amode closure))
184 cgAlgAlts NoGC uniq Nothing{-cc_slot-} False{-no semi-tagging-}
185 False{-not poly case-} alts deflt
186 False{-don't emit yield-} `thenFC` \ (tagged_alts, deflt_c) ->
189 absC (mkAlgAltsCSwitch tag_amode tagged_alts deflt_c)
192 (Just (tycon,_)) = splitTyConApp_maybe res_ty
193 uniq = getUnique bndr
196 Special case #2: inline PrimOps.
199 cgCase (StgPrimApp op args res_ty)
200 live_in_whole_case live_in_alts bndr srt alts
201 | not (primOpOutOfLine op)
203 -- Get amodes for the arguments and results
204 getArgAmodes args `thenFC` \ arg_amodes ->
206 result_amodes = getPrimAppResultAmodes (getUnique bndr) alts
208 -- Perform the operation
209 getVolatileRegs live_in_alts `thenFC` \ vol_regs ->
211 absC (COpStmt result_amodes op
212 arg_amodes -- note: no liveness arg
215 -- Scrutinise the result
216 cgInlineAlts bndr alts
219 TODO: Case-of-case of primop can probably be done inline too (but
220 maybe better to translate it out beforehand). See
221 ghc/lib/misc/PackedString.lhs for examples where this crops up (with
224 Another special case: scrutinising a primitive-typed variable. No
225 evaluation required. We don't save volatile variables, nor do we do a
226 heap-check in the alternatives. Instead, the heap usage of the
227 alternatives is worst-cased and passed upstream. This can result in
228 allocating more heap than strictly necessary, but it will sometimes
229 eliminate a heap check altogether.
232 cgCase (StgApp v []) live_in_whole_case live_in_alts bndr srt
233 (StgPrimAlts ty alts deflt)
236 getCAddrMode v `thenFC` \amode ->
239 Careful! we can't just bind the default binder to the same thing
240 as the scrutinee, since it might be a stack location, and having
241 two bindings pointing at the same stack locn doesn't work (it
242 confuses nukeDeadBindings). Hence, use a new temp.
244 bindNewToTemp bndr `thenFC` \deflt_amode ->
245 absC (CAssign deflt_amode amode) `thenC`
247 cgPrimAlts NoGC amode alts deflt []
250 Special case: scrutinising a non-primitive variable.
251 This can be done a little better than the general case, because
252 we can reuse/trim the stack slot holding the variable (if it is in one).
255 cgCase (StgApp fun args)
256 live_in_whole_case live_in_alts bndr srt alts@(StgAlgAlts ty _ _)
258 getCAddrModeAndInfo fun `thenFC` \ (fun_amode, lf_info) ->
259 getArgAmodes args `thenFC` \ arg_amodes ->
261 -- Squish the environment
262 nukeDeadBindings live_in_alts `thenC`
263 saveVolatileVarsAndRegs live_in_alts
264 `thenFC` \ (save_assts, alts_eob_info, maybe_cc_slot) ->
266 allocStackTop retPrimRepSize `thenFC` \_ ->
268 forkEval alts_eob_info nopC (
269 deAllocStackTop retPrimRepSize `thenFC` \_ ->
270 cgEvalAlts maybe_cc_slot bndr srt alts)
271 `thenFC` \ scrut_eob_info ->
273 let real_scrut_eob_info =
275 then reserveSeqFrame scrut_eob_info
279 setEndOfBlockInfo real_scrut_eob_info (
280 tailCallFun fun fun_amode lf_info arg_amodes save_assts
284 not_con_ty = case (getScrutineeTyCon ty) of
289 Note about return addresses: we *always* push a return address, even
290 if because of an optimisation we end up jumping direct to the return
291 code (not through the address itself). The alternatives always assume
292 that the return address is on the stack. The return address is
293 required in case the alternative performs a heap check, since it
294 encodes the liveness of the slots in the activation record.
296 On entry to the case alternative, we can re-use the slot containing
297 the return address immediately after the heap check. That's what the
298 deAllocStackTop call is doing above.
300 Finally, here is the general case.
303 cgCase expr live_in_whole_case live_in_alts bndr srt alts
304 = -- Figure out what volatile variables to save
305 nukeDeadBindings live_in_whole_case `thenC`
307 saveVolatileVarsAndRegs live_in_alts
308 `thenFC` \ (save_assts, alts_eob_info, maybe_cc_slot) ->
310 -- Save those variables right now!
311 absC save_assts `thenC`
313 -- generate code for the alts
314 forkEval alts_eob_info
316 nukeDeadBindings live_in_alts `thenC`
317 allocStackTop retPrimRepSize -- space for retn address
320 (deAllocStackTop retPrimRepSize `thenFC` \_ ->
321 cgEvalAlts maybe_cc_slot bndr srt alts) `thenFC` \ scrut_eob_info ->
323 let real_scrut_eob_info =
325 then reserveSeqFrame scrut_eob_info
329 setEndOfBlockInfo real_scrut_eob_info (cgExpr expr)
332 not_con_ty = case (getScrutineeTyCon (alts_ty alts)) of
337 There's a lot of machinery going on behind the scenes to manage the
338 stack pointer here. forkEval takes the virtual Sp and free list from
339 the first argument, and turns that into the *real* Sp for the second
340 argument. It also uses this virtual Sp as the args-Sp in the EOB info
341 returned, so that the scrutinee will trim the real Sp back to the
342 right place before doing whatever it does.
343 --SDM (who just spent an hour figuring this out, and didn't want to
346 Why don't we push the return address just before evaluating the
347 scrutinee? Because the slot reserved for the return address might
348 contain something useful, so we wait until performing a tail call or
349 return before pushing the return address (see
350 CgTailCall.pushReturnAddress).
352 This also means that the environment doesn't need to know about the
353 free stack slot for the return address (for generating bitmaps),
354 because we don't reserve it until just before the eval.
356 TODO!! Problem: however, we have to save the current cost centre
357 stack somewhere, because at the eval point the current CCS might be
358 different. So we pick a free stack slot and save CCCS in it. The
359 problem with this is that this slot isn't recorded as free/unboxed in
360 the environment, so a case expression in the scrutinee will have the
361 wrong bitmap attached. Fortunately we don't ever seem to see
362 case-of-case at the back end. One solution might be to shift the
363 saved CCS to the correct place in the activation record just before
367 (one consequence of the above is that activation records on the stack
368 don't follow the layout of closures when we're profiling. The CCS
369 could be anywhere within the record).
372 alts_ty (StgAlgAlts ty _ _) = ty
373 alts_ty (StgPrimAlts ty _ _) = ty
376 %************************************************************************
378 \subsection[CgCase-primops]{Primitive applications}
380 %************************************************************************
382 Get result amodes for a primitive operation, in the case wher GC can't happen.
383 The amodes are returned in canonical order, ready for the prim-op!
385 Alg case: temporaries named as in the alternatives,
386 plus (CTemp u) for the tag (if needed)
389 This is all disgusting, because these amodes must be consistent with those
390 invented by CgAlgAlts.
393 getPrimAppResultAmodes
398 getPrimAppResultAmodes uniq (StgAlgAlts ty alts some_default)
400 | isUnboxedTupleTyCon tycon =
402 [(con, args, use_mask, rhs)] ->
403 [ CTemp (getUnique arg) (idPrimRep arg) | arg <- args ]
404 _ -> panic "getPrimAppResultAmodes: case of unboxed tuple has multiple branches"
406 | otherwise = panic ("getPrimAppResultAmodes: case of primop has strange type: " ++ showSDoc (ppr ty))
408 where (tycon, _, _) = splitAlgTyConApp ty
410 -- The situation is simpler for primitive results, because there is only
413 getPrimAppResultAmodes uniq (StgPrimAlts ty _ _)
414 = [CTemp uniq (typePrimRep ty)]
418 %************************************************************************
420 \subsection[CgCase-alts]{Alternatives}
422 %************************************************************************
424 @cgEvalAlts@ returns an addressing mode for a continuation for the
425 alternatives of a @case@, used in a context when there
426 is some evaluation to be done.
429 cgEvalAlts :: Maybe VirtualSpOffset -- Offset of cost-centre to be restored, if any
431 -> SRT -- SRT for the continuation
433 -> FCode Sequel -- Any addr modes inside are guaranteed
434 -- to be a label so that we can duplicate it
435 -- without risk of duplicating code
437 cgEvalAlts cc_slot bndr srt alts
439 let uniq = getUnique bndr in
441 buildContLivenessMask uniq `thenFC` \ liveness_mask ->
445 -- algebraic alts ...
446 (StgAlgAlts ty alts deflt) ->
448 -- bind the default binder (it covers all the alternatives)
449 bindNewToReg bndr node mkLFArgument `thenC`
451 -- Generate sequel info for use downstream
452 -- At the moment, we only do it if the type is vector-returnable.
453 -- Reason: if not, then it costs extra to label the
454 -- alternatives, because we'd get return code like:
456 -- switch TagReg { 0 : JMP(alt_1); 1 : JMP(alt_2) ..etc }
458 -- which is worse than having the alt code in the switch statement
460 let tycon_info = getScrutineeTyCon ty
461 is_alg = maybeToBool tycon_info
462 Just spec_tycon = tycon_info
465 -- deal with the unboxed tuple case
466 if is_alg && isUnboxedTupleTyCon spec_tycon then
468 [alt] -> let lbl = mkReturnInfoLabel uniq in
469 cgUnboxedTupleAlt uniq cc_slot True alt
471 getSRTLabel `thenFC` \srt_label ->
472 absC (CRetDirect uniq abs_c (srt_label, srt)
473 liveness_mask) `thenC`
474 returnFC (CaseAlts (CLbl lbl RetRep) Nothing)
475 _ -> panic "cgEvalAlts: dodgy case of unboxed tuple type"
477 -- normal algebraic (or polymorphic) case alternatives
479 ret_conv | is_alg = ctrlReturnConvAlg spec_tycon
480 | otherwise = UnvectoredReturn 0
482 use_labelled_alts = case ret_conv of
483 VectoredReturn _ -> True
487 = if use_labelled_alts then
488 cgSemiTaggedAlts bndr alts deflt -- Just <something>
490 Nothing -- no semi-tagging info
493 cgAlgAlts GCMayHappen uniq cc_slot use_labelled_alts (not is_alg)
494 alts deflt True `thenFC` \ (tagged_alt_absCs, deflt_absC) ->
496 mkReturnVector uniq tagged_alt_absCs deflt_absC srt liveness_mask
497 ret_conv `thenFC` \ return_vec ->
499 returnFC (CaseAlts return_vec semi_tagged_stuff)
502 (StgPrimAlts ty alts deflt) ->
504 -- Restore the cost centre
505 restoreCurrentCostCentre cc_slot `thenFC` \ cc_restore ->
507 -- Generate the switch
508 getAbsC (cgPrimEvalAlts bndr ty alts deflt) `thenFC` \ abs_c ->
510 -- Generate the labelled block, starting with restore-cost-centre
511 getSRTLabel `thenFC` \srt_label ->
512 absC (CRetDirect uniq (cc_restore `mkAbsCStmts` abs_c)
513 (srt_label,srt) liveness_mask) `thenC`
515 -- Return an amode for the block
516 returnFC (CaseAlts (CLbl (mkReturnInfoLabel uniq) RetRep) Nothing)
526 HWL comment on {\em GrAnSim\/} (adding GRAN_YIELDs for context switch): If
527 we do an inlining of the case no separate functions for returning are
528 created, so we don't have to generate a GRAN_YIELD in that case. This info
529 must be propagated to cgAlgAltRhs (where the GRAN_YIELD macro might be
530 emitted). Hence, the new Bool arg to cgAlgAltRhs.
532 First case: primitive op returns an unboxed tuple.
535 cgInlineAlts bndr (StgAlgAlts ty [alt@(con,args,use_mask,rhs)] StgNoDefault)
536 | isUnboxedTupleCon con
537 = -- no heap check, no yield, just get in there and do it.
538 mapFCs bindNewToTemp args `thenFC` \ _ ->
542 = panic "cgInlineAlts: single alternative, not an unboxed tuple"
545 Third (real) case: primitive result type.
548 cgInlineAlts bndr (StgPrimAlts ty alts deflt)
549 = cgPrimInlineAlts bndr ty alts deflt
552 %************************************************************************
554 \subsection[CgCase-alg-alts]{Algebraic alternatives}
556 %************************************************************************
558 In @cgAlgAlts@, none of the binders in the alternatives are
559 assumed to be yet bound.
561 HWL comment on {\em GrAnSim\/} (adding GRAN_YIELDs for context switch): The
562 last arg of cgAlgAlts indicates if we want a context switch at the
563 beginning of each alternative. Normally we want that. The only exception
564 are inlined alternatives.
569 -> Maybe VirtualSpOffset
570 -> Bool -- True <=> branches must be labelled
571 -> Bool -- True <=> polymorphic case
572 -> [(DataCon, [Id], [Bool], StgExpr)] -- The alternatives
573 -> StgCaseDefault -- The default
574 -> Bool -- Context switch at alts?
575 -> FCode ([(ConTag, AbstractC)], -- The branches
576 AbstractC -- The default case
579 cgAlgAlts gc_flag uniq restore_cc must_label_branches is_fun alts deflt
580 emit_yield{-should a yield macro be emitted?-}
582 = forkAlts (map (cgAlgAlt gc_flag uniq restore_cc must_label_branches emit_yield) alts)
583 (cgAlgDefault gc_flag is_fun uniq restore_cc must_label_branches deflt emit_yield)
587 cgAlgDefault :: GCFlag
588 -> Bool -- could be a function-typed result?
589 -> Unique -> Maybe VirtualSpOffset -> Bool -- turgid state...
590 -> StgCaseDefault -- input
592 -> FCode AbstractC -- output
594 cgAlgDefault gc_flag is_fun uniq cc_slot must_label_branch StgNoDefault _
597 cgAlgDefault gc_flag is_fun uniq cc_slot must_label_branch
599 emit_yield{-should a yield macro be emitted?-}
601 = -- We have arranged that Node points to the thing
602 restoreCurrentCostCentre cc_slot `thenFC` \restore_cc ->
603 getAbsC (absC restore_cc `thenC`
604 -- HWL: maybe need yield here
606 -- then yield [node] True
607 -- else absC AbsCNop) `thenC`
608 possibleHeapCheck gc_flag is_fun [node] [] Nothing (cgExpr rhs)
609 -- Node is live, but doesn't need to point at the thing itself;
610 -- it's ok for Node to point to an indirection or FETCH_ME
611 -- Hence no need to re-enter Node.
612 ) `thenFC` \ abs_c ->
615 final_abs_c | must_label_branch = CCodeBlock lbl abs_c
620 lbl = mkDefaultLabel uniq
622 -- HWL comment on GrAnSim: GRAN_YIELDs needed; emitted in cgAlgAltRhs
625 -> Unique -> Maybe VirtualSpOffset -> Bool -- turgid state
626 -> Bool -- Context switch at alts?
627 -> (DataCon, [Id], [Bool], StgExpr)
628 -> FCode (ConTag, AbstractC)
630 cgAlgAlt gc_flag uniq cc_slot must_label_branch
631 emit_yield{-should a yield macro be emitted?-}
632 (con, args, use_mask, rhs)
634 restoreCurrentCostCentre cc_slot `thenFC` \restore_cc ->
635 getAbsC (absC restore_cc `thenC`
636 -- HWL: maybe need yield here
638 -- then yield [node] True -- XXX live regs wrong
639 -- else absC AbsCNop) `thenC`
641 NoGC -> mapFCs bindNewToTemp args `thenFC` \_ -> nopC
642 GCMayHappen -> bindConArgs con args
644 possibleHeapCheck gc_flag False [node] [] Nothing (
646 ) `thenFC` \ abs_c ->
648 final_abs_c | must_label_branch = CCodeBlock lbl abs_c
651 returnFC (tag, final_abs_c)
654 lbl = mkAltLabel uniq tag
657 :: Unique -- unique for label of the alternative
658 -> Maybe VirtualSpOffset -- Restore cost centre
659 -> Bool -- ctxt switch
660 -> (DataCon, [Id], [Bool], StgExpr) -- alternative
663 cgUnboxedTupleAlt lbl cc_slot emit_yield (con,args,use_mask,rhs)
665 bindUnboxedTupleComponents args
666 `thenFC` \ (live_regs,tags,stack_res) ->
668 restoreCurrentCostCentre cc_slot `thenFC` \restore_cc ->
669 absC restore_cc `thenC`
671 -- HWL: maybe need yield here
673 -- then yield live_regs True -- XXX live regs wrong?
674 -- else absC AbsCNop) `thenC`
676 -- ToDo: could maybe use Nothing here if stack_res is False
677 -- since the heap-check can just return to the top of the
682 -- free up stack slots containing tags,
683 freeStackSlots (map fst tags) `thenC`
685 -- generate a heap check if necessary
686 possibleHeapCheck GCMayHappen False live_regs tags ret_addr (
688 -- and finally the code for the alternative
693 %************************************************************************
695 \subsection[CgCase-semi-tagged-alts]{The code to deal with sem-tagging}
697 %************************************************************************
699 Turgid-but-non-monadic code to conjure up the required info from
700 algebraic case alternatives for semi-tagging.
703 cgSemiTaggedAlts :: Id
704 -> [(DataCon, [Id], [Bool], StgExpr)]
705 -> GenStgCaseDefault Id Id
708 cgSemiTaggedAlts binder alts deflt
709 = Just (map st_alt alts, st_deflt deflt)
711 uniq = getUnique binder
713 st_deflt StgNoDefault = Nothing
715 st_deflt (StgBindDefault _)
717 (CCallProfCtrMacro SLIT("RET_SEMI_BY_DEFAULT") [], -- ToDo: monadise?
721 st_alt (con, args, use_mask, _)
722 = -- Ha! Nothing to do; Node already points to the thing
724 (CCallProfCtrMacro SLIT("RET_SEMI_IN_HEAP") -- ToDo: monadise?
725 [mkIntCLit (length args)], -- how big the thing in the heap is
729 con_tag = dataConTag con
730 join_label = mkAltLabel uniq con_tag
733 %************************************************************************
735 \subsection[CgCase-prim-alts]{Primitive alternatives}
737 %************************************************************************
739 @cgPrimEvalAlts@ and @cgPrimInlineAlts@ generate suitable @CSwitch@es
740 for dealing with the alternatives of a primitive @case@, given an
741 addressing mode for the thing to scrutinise. It also keeps track of
742 the maximum stack depth encountered down any branch.
744 As usual, no binders in the alternatives are yet bound.
747 cgPrimInlineAlts bndr ty alts deflt
748 = cgPrimAltsWithDefault bndr NoGC (CTemp uniq kind) alts deflt []
750 uniq = getUnique bndr
751 kind = typePrimRep ty
753 cgPrimEvalAlts bndr ty alts deflt
754 = cgPrimAltsWithDefault bndr GCMayHappen (CReg reg) alts deflt [reg]
756 reg = WARN( case kind of { PtrRep -> True; other -> False }, text "cgPrimEE" <+> ppr bndr <+> ppr ty )
757 dataReturnConvPrim kind
758 kind = typePrimRep ty
760 cgPrimAltsWithDefault bndr gc_flag scrutinee alts deflt regs
761 = -- first bind the default if necessary
762 bindNewPrimToAmode bndr scrutinee `thenC`
763 cgPrimAlts gc_flag scrutinee alts deflt regs
765 cgPrimAlts gc_flag scrutinee alts deflt regs
766 = forkAlts (map (cgPrimAlt gc_flag regs) alts)
767 (cgPrimDefault gc_flag regs deflt)
768 `thenFC` \ (alt_absCs, deflt_absC) ->
770 absC (CSwitch scrutinee alt_absCs deflt_absC)
771 -- CSwitch does sensible things with one or zero alternatives
775 -> [MagicId] -- live registers
776 -> (Literal, StgExpr) -- The alternative
777 -> FCode (Literal, AbstractC) -- Its compiled form
779 cgPrimAlt gc_flag regs (lit, rhs)
780 = getAbsC rhs_code `thenFC` \ absC ->
783 rhs_code = possibleHeapCheck gc_flag False regs [] Nothing (cgExpr rhs)
785 cgPrimDefault :: GCFlag
786 -> [MagicId] -- live registers
790 cgPrimDefault gc_flag regs StgNoDefault
791 = panic "cgPrimDefault: No default in prim case"
793 cgPrimDefault gc_flag regs (StgBindDefault rhs)
794 = getAbsC (possibleHeapCheck gc_flag False regs [] Nothing (cgExpr rhs))
798 %************************************************************************
800 \subsection[CgCase-tidy]{Code for tidying up prior to an eval}
802 %************************************************************************
805 saveVolatileVarsAndRegs
806 :: StgLiveVars -- Vars which should be made safe
807 -> FCode (AbstractC, -- Assignments to do the saves
808 EndOfBlockInfo, -- sequel for the alts
809 Maybe VirtualSpOffset) -- Slot for current cost centre
812 saveVolatileVarsAndRegs vars
813 = saveVolatileVars vars `thenFC` \ var_saves ->
814 saveCurrentCostCentre `thenFC` \ (maybe_cc_slot, cc_save) ->
815 getEndOfBlockInfo `thenFC` \ eob_info ->
816 returnFC (mkAbstractCs [var_saves, cc_save],
821 saveVolatileVars :: StgLiveVars -- Vars which should be made safe
822 -> FCode AbstractC -- Assignments to to the saves
824 saveVolatileVars vars
825 = save_em (varSetElems vars)
827 save_em [] = returnFC AbsCNop
830 = getCAddrModeIfVolatile var `thenFC` \ v ->
832 Nothing -> save_em vars -- Non-volatile, so carry on
835 Just vol_amode -> -- Aha! It's volatile
836 save_var var vol_amode `thenFC` \ abs_c ->
837 save_em vars `thenFC` \ abs_cs ->
838 returnFC (abs_c `mkAbsCStmts` abs_cs)
840 save_var var vol_amode
841 = allocPrimStack (getPrimRepSize kind) `thenFC` \ slot ->
842 rebindToStack var slot `thenC`
843 getSpRelOffset slot `thenFC` \ sp_rel ->
844 returnFC (CAssign (CVal sp_rel kind) vol_amode)
846 kind = getAmodeRep vol_amode
849 ---------------------------------------------------------------------------
851 When we save the current cost centre (which is done for lexical
852 scoping), we allocate a free stack location, and return (a)~the
853 virtual offset of the location, to pass on to the alternatives, and
854 (b)~the assignment to do the save (just as for @saveVolatileVars@).
857 saveCurrentCostCentre ::
858 FCode (Maybe VirtualSpOffset, -- Where we decide to store it
859 AbstractC) -- Assignment to save it
861 saveCurrentCostCentre
862 = if not opt_SccProfilingOn then
863 returnFC (Nothing, AbsCNop)
865 allocPrimStack (getPrimRepSize CostCentreRep) `thenFC` \ slot ->
866 dataStackSlots [slot] `thenC`
867 getSpRelOffset slot `thenFC` \ sp_rel ->
869 CAssign (CVal sp_rel CostCentreRep) (CReg CurCostCentre))
871 restoreCurrentCostCentre :: Maybe VirtualSpOffset -> FCode AbstractC
872 restoreCurrentCostCentre Nothing = returnFC AbsCNop
873 restoreCurrentCostCentre (Just slot)
874 = getSpRelOffset slot `thenFC` \ sp_rel ->
875 freeStackSlots [slot] `thenC`
876 returnFC (CCallProfCCMacro SLIT("RESTORE_CCCS") [CVal sp_rel CostCentreRep])
877 -- we use the RESTORE_CCCS macro, rather than just
878 -- assigning into CurCostCentre, in case RESTORE_CCC
879 -- has some sanity-checking in it.
882 %************************************************************************
884 \subsection[CgCase-return-vec]{Building a return vector}
886 %************************************************************************
888 Build a return vector, and return a suitable label addressing
892 mkReturnVector :: Unique
893 -> [(ConTag, AbstractC)] -- Branch codes
894 -> AbstractC -- Default case
895 -> SRT -- continuation's SRT
896 -> Liveness -- stack liveness
897 -> CtrlReturnConvention
900 mkReturnVector uniq tagged_alt_absCs deflt_absC srt liveness ret_conv
901 = getSRTLabel `thenFC` \srt_label ->
903 srt_info = (srt_label, srt)
905 (return_vec_amode, vtbl_body) = case ret_conv of {
907 -- might be a polymorphic case...
908 UnvectoredReturn 0 ->
909 ASSERT(null tagged_alt_absCs)
910 (CLbl ret_label RetRep,
911 absC (CRetDirect uniq deflt_absC (srt_label, srt) liveness));
913 UnvectoredReturn n ->
914 -- find the tag explicitly rather than using tag_reg for now.
915 -- on architectures with lots of regs the tag will be loaded
916 -- into tag_reg by the code doing the returning.
918 tag = CMacroExpr WordRep GET_TAG [CVal (nodeRel 0) DataPtrRep]
920 (CLbl ret_label RetRep,
921 absC (CRetDirect uniq
922 (mkAlgAltsCSwitch tag tagged_alt_absCs deflt_absC)
926 VectoredReturn table_size ->
928 (vector_table, alts_absC) =
929 unzip (map mk_vector_entry [fIRST_TAG .. (table_size+fIRST_TAG-1)])
931 ret_vector = CRetVector vtbl_label
933 (srt_label, srt) liveness
935 (CLbl vtbl_label DataPtrRep,
936 -- alts come first, because we don't want to declare all the symbols
937 absC (mkAbstractCs (mkAbstractCs alts_absC : [deflt_absC,ret_vector]))
942 returnFC return_vec_amode
946 vtbl_label = mkVecTblLabel uniq
947 ret_label = mkReturnInfoLabel uniq
950 case nonemptyAbsC deflt_absC of
951 -- the simplifier might have eliminated a case
952 Nothing -> CLbl mkErrorStdEntryLabel CodePtrRep
953 Just absC@(CCodeBlock lbl _) -> CLbl lbl CodePtrRep
955 mk_vector_entry :: ConTag -> (CAddrMode, AbstractC)
957 = case [ absC | (t, absC) <- tagged_alt_absCs, t == tag ] of
958 [] -> (deflt_lbl, AbsCNop)
959 [absC@(CCodeBlock lbl _)] -> (CLbl lbl CodePtrRep,absC)
960 _ -> panic "mkReturnVector: too many"
963 %************************************************************************
965 \subsection[CgCase-utils]{Utilities for handling case expressions}
967 %************************************************************************
969 @possibleHeapCheck@ tests a flag passed in to decide whether to do a
970 heap check or not. These heap checks are always in a case
971 alternative, so we use altHeapCheck.
976 -> Bool -- True <=> algebraic case
977 -> [MagicId] -- live registers
978 -> [(VirtualSpOffset,Int)] -- stack slots to tag
979 -> Maybe Unique -- return address unique
980 -> Code -- continuation
983 possibleHeapCheck GCMayHappen is_alg regs tags lbl code
984 = altHeapCheck is_alg regs tags AbsCNop lbl code
985 possibleHeapCheck NoGC _ _ tags lbl code
990 getScrutineeTyCon :: Type -> Maybe TyCon
991 getScrutineeTyCon ty =
992 case splitTyConApp_maybe (repType ty) of
995 if isFunTyCon tc then Nothing else -- not interested in funs
996 if isPrimTyCon tc then Just tc else -- return primitive tycons
997 -- otherwise (algebraic tycons) check the no. of constructors