2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %************************************************************************
6 \section[PprAbsC]{Pretty-printing Abstract~C}
8 %************************************************************************
18 #include "HsVersions.h"
24 import AbsCUtils ( getAmodeRep, nonemptyAbsC,
25 mixedPtrLocn, mixedTypeLocn
28 import Constants ( mIN_UPD_SIZE )
29 import CallConv ( callConvAttribute )
30 import CLabel ( externallyVisibleCLabel, mkErrorStdEntryLabel,
31 needsCDecl, pprCLabel,
32 mkReturnInfoLabel, mkReturnPtLabel, mkClosureTblLabel,
34 CLabel, CLabelType(..), labelType, labelDynamic
37 import CmdLineOpts ( opt_SccProfilingOn, opt_GranMacros )
38 import CostCentre ( pprCostCentreDecl, pprCostCentreStackDecl )
40 import Costs ( costs, addrModeCosts, CostRes(..), Side(..) )
41 import CStrings ( stringToC, pprCLabelString )
42 import FiniteMap ( addToFM, emptyFM, lookupFM, FiniteMap )
43 import Literal ( Literal(..) )
44 import TyCon ( tyConDataCons )
45 import Name ( NamedThing(..) )
46 import DataCon ( DataCon{-instance NamedThing-}, dataConWrapId )
47 import Maybes ( maybeToBool, catMaybes )
48 import PrimOp ( primOpNeedsWrapper, pprPrimOp, pprCCallOp,
49 PrimOp(..), CCall(..), CCallTarget(..), isDynamicTarget )
50 import PrimRep ( isFloatingRep, PrimRep(..), getPrimRepSize, showPrimRep )
51 import SMRep ( pprSMRep )
52 import Unique ( pprUnique, Unique{-instance NamedThing-} )
53 import UniqSet ( emptyUniqSet, elementOfUniqSet,
54 addOneToUniqSet, UniqSet
56 import StgSyn ( SRT(..) )
57 import BitSet ( intBS )
59 import Util ( nOfThem )
67 For spitting out the costs of an abstract~C expression, @writeRealC@
68 now not only prints the C~code of the @absC@ arg but also adds a macro
69 call to a cost evaluation function @GRAN_EXEC@. For that,
70 @pprAbsC@ has a new ``costs'' argument. %% HWL
74 writeRealC :: Handle -> AbstractC -> IO ()
75 writeRealC handle absC
76 -- avoid holding on to the whole of absC in the !Gransim case.
78 then printForCFast fp (pprAbsC absC (costs absC))
79 else printForCFast fp (pprAbsC absC (panic "costs"))
80 --printForC handle (pprAbsC absC (panic "costs"))
81 dumpRealC :: AbstractC -> SDoc
82 dumpRealC absC = pprAbsC absC (costs absC)
85 writeRealC :: Handle -> AbstractC -> IO ()
86 --writeRealC handle absC =
88 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
90 writeRealC handle absC
91 | opt_GranMacros = _scc_ "writeRealC" printForC handle $
92 pprCode CStyle (pprAbsC absC (costs absC))
93 | otherwise = _scc_ "writeRealC" printForC handle $
94 pprCode CStyle (pprAbsC absC (panic "costs"))
96 dumpRealC :: AbstractC -> SDoc
98 | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
99 | otherwise = pprCode CStyle (pprAbsC absC (panic "costs"))
103 This emits the macro, which is used in GrAnSim to compute the total costs
104 from a cost 5 tuple. %% HWL
107 emitMacro :: CostRes -> SDoc
109 emitMacro _ | not opt_GranMacros = empty
111 emitMacro (Cost (i,b,l,s,f))
112 = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
113 int i, comma, int b, comma, int l, comma,
114 int s, comma, int f, pp_paren_semi ]
116 pp_paren_semi = text ");"
119 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
120 code as an argument (that's needed when spitting out the GRAN_EXEC macro
121 which must be done before the return i.e. inside absC code) HWL
124 pprAbsC :: AbstractC -> CostRes -> SDoc
125 pprAbsC AbsCNop _ = empty
126 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
128 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
130 pprAbsC (CJump target) c
131 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CJump */"-} ])
132 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
134 pprAbsC (CFallThrough target) c
135 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CFallThrough */"-} ])
136 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
138 -- --------------------------------------------------------------------------
139 -- Spit out GRAN_EXEC macro immediately before the return HWL
141 pprAbsC (CReturn am return_info) c
142 = ($$) (hcat [emitMacro c {-WDP:, text "/* <---- CReturn */"-} ])
143 (hcat [text jmp_lit, target, pp_paren_semi ])
145 target = case return_info of
146 DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
148 DynamicVectoredReturn am' -> mk_vector (pprAmode am')
149 StaticVectoredReturn n -> mk_vector (int n) -- Always positive
150 mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
153 pprAbsC (CSplitMarker) _ = ptext SLIT("__STG_SPLIT_MARKER")
155 -- we optimise various degenerate cases of CSwitches.
157 -- --------------------------------------------------------------------------
158 -- Assume: CSwitch is also end of basic block
159 -- costs function yields nullCosts for whole switch
160 -- ==> inherited costs c are those of basic block up to switch
161 -- ==> inherit c + costs for the corresponding branch
163 -- --------------------------------------------------------------------------
165 pprAbsC (CSwitch discrim [] deflt) c
166 = pprAbsC deflt (c + costs deflt)
167 -- Empty alternative list => no costs for discrim as nothing cond. here HWL
169 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
170 = case (nonemptyAbsC deflt) of
171 Nothing -> -- one alt and no default
172 pprAbsC alt_code (c + costs alt_code)
173 -- Nothing conditional in here either HWL
175 Just dc -> -- make it an "if"
176 do_if_stmt discrim tag alt_code dc c
178 -- What problem is the re-ordering trying to solve ?
179 pprAbsC (CSwitch discrim [(tag1@(MachInt i1), alt_code1),
180 (tag2@(MachInt i2), alt_code2)] deflt) c
181 | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
183 do_if_stmt discrim tag1 alt_code1 alt_code2 c
185 do_if_stmt discrim tag2 alt_code2 alt_code1 c
187 empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
189 pprAbsC (CSwitch discrim alts deflt) c -- general case
190 | isFloatingRep (getAmodeRep discrim)
191 = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
194 hcat [text "switch (", pp_discrim, text ") {"],
195 nest 2 (vcat (map ppr_alt alts)),
196 (case (nonemptyAbsC deflt) of
199 nest 2 (vcat [ptext SLIT("default:"),
200 pprAbsC dc (c + switch_head_cost
202 ptext SLIT("break;")])),
209 = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
210 nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
211 (ptext SLIT("break;"))) ]
213 -- Costs for addressing header of switch and cond. branching -- HWL
214 switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
216 pprAbsC stmt@(COpStmt results (CCallOp ccall) args vol_regs) _
217 = pprCCall ccall args results vol_regs
219 pprAbsC stmt@(COpStmt results op args vol_regs) _
221 non_void_args = grab_non_void_amodes args
222 non_void_results = grab_non_void_amodes results
223 -- if just one result, we print in the obvious "assignment" style;
224 -- if 0 or many results, we emit a macro call, w/ the results
225 -- followed by the arguments. The macro presumably knows which
228 the_op = ppr_op_call non_void_results non_void_args
229 -- liveness mask is *in* the non_void_args
231 if primOpNeedsWrapper op then
232 case (ppr_vol_regs vol_regs) of { (pp_saves, pp_restores) ->
241 ppr_op_call results args
242 = hcat [ pprPrimOp op, lparen,
243 hcat (punctuate comma (map ppr_op_result results)),
244 if null results || null args then empty else comma,
245 hcat (punctuate comma (map pprAmode args)),
248 ppr_op_result r = ppr_amode r
249 -- primop macros do their own casting of result;
250 -- hence we can toss the provided cast...
252 pprAbsC stmt@(CSRT lbl closures) c
253 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
255 $$ ptext SLIT("SRT") <> lparen <> pprCLabel lbl <> rparen
256 $$ nest 2 (hcat (punctuate comma (map pp_closure_lbl closures)))
260 pprAbsC stmt@(CBitmap lbl mask) c
262 hcat [ ptext SLIT("BITMAP"), lparen,
263 pprCLabel lbl, comma,
266 hcat (punctuate comma (map (int.intBS) mask)),
270 pprAbsC (CSimultaneous abs_c) c
271 = hcat [ptext SLIT("{{"), pprAbsC abs_c c, ptext SLIT("}}")]
273 pprAbsC (CCheck macro as code) c
274 = hcat [ptext (cCheckMacroText macro), lparen,
275 hcat (punctuate comma (map ppr_amode as)), comma,
276 pprAbsC code c, pp_paren_semi
278 pprAbsC (CMacroStmt macro as) _
279 = hcat [ptext (cStmtMacroText macro), lparen,
280 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi] -- no casting
281 pprAbsC (CCallProfCtrMacro op as) _
282 = hcat [ptext op, lparen,
283 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
284 pprAbsC (CCallProfCCMacro op as) _
285 = hcat [ptext op, lparen,
286 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
287 pprAbsC stmt@(CCallTypedef is_tdef (CCall op_str is_asm may_gc cconv) results args) _
288 = hsep [ ptext (if is_tdef then SLIT("typedef") else SLIT("extern"))
291 , parens (hsep (punctuate comma ccall_decl_ty_args))
295 In the non-casm case, to ensure that we're entering the given external
296 entry point using the correct calling convention, we have to do the following:
298 - When entering via a function pointer (the `dynamic' case) using the specified
299 calling convention, we emit a typedefn declaration attributed with the
300 calling convention to use together with the result and parameter types we're
301 assuming. Coerce the function pointer to this type and go.
303 - to enter the function at a given code label, we emit an extern declaration
304 for the label here, stating the calling convention together with result and
305 argument types we're assuming.
307 The C compiler will hopefully use this extern declaration to good effect,
308 reporting any discrepancies between our extern decl and any other that
311 Re: calling convention, notice that gcc (2.8.1 and egcs-1.0.2) will for
312 the external function `foo' use the calling convention of the first `foo'
313 prototype it encounters (nor does it complain about conflicting attribute
314 declarations). The consequence of this is that you cannot override the
315 calling convention of `foo' using an extern declaration (you'd have to use
316 a typedef), but why you would want to do such a thing in the first place
317 is totally beyond me.
319 ToDo: petition the gcc folks to add code to warn about conflicting attribute
325 | is_tdef = parens (text (callConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
326 | otherwise = text (callConvAttribute cconv) <+> ccall_fun_ty
330 DynamicTarget u -> ptext SLIT("_ccall_fun_ty") <> ppr u
331 StaticTarget x -> pprCLabelString x
334 case non_void_results of
335 [] -> ptext SLIT("void")
336 [amode] -> text (showPrimRep (getAmodeRep amode))
337 _ -> panic "pprAbsC{CCallTypedef}: ccall_res_ty"
340 | is_tdef = tail ccall_arg_tys
341 | otherwise = ccall_arg_tys
343 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
345 -- the first argument will be the "I/O world" token (a VoidRep)
346 -- all others should be non-void
349 in ASSERT (all non_void nvas) nvas
351 -- there will usually be two results: a (void) state which we
352 -- should ignore and a (possibly void) result.
354 let nvrs = grab_non_void_amodes results
355 in ASSERT (length nvrs <= 1) nvrs
357 pprAbsC (CCodeBlock lbl abs_C) _
358 = if not (maybeToBool(nonemptyAbsC abs_C)) then
359 pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
361 case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
365 hcat [text (if (externallyVisibleCLabel lbl)
366 then "FN_(" -- abbreviations to save on output
368 pprCLabel lbl, text ") {"],
372 nest 8 (ptext SLIT("FB_")),
373 nest 8 (pprAbsC abs_C (costs abs_C)),
374 nest 8 (ptext SLIT("FE_")),
380 pprAbsC (CInitHdr cl_info amode cost_centre) _
381 = hcat [ ptext SLIT("SET_HDR_"), char '(',
382 ppr_amode amode, comma,
383 pprCLabelAddr info_lbl, comma,
384 if_profiling (pprAmode cost_centre),
387 info_lbl = infoTableLabelFromCI cl_info
389 pprAbsC stmt@(CStaticClosure closure_lbl cl_info cost_centre amodes) _
390 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
394 ptext SLIT("SET_STATIC_HDR"), char '(',
395 pprCLabel closure_lbl, comma,
396 pprCLabel info_lbl, comma,
397 if_profiling (pprAmode cost_centre), comma,
398 ppLocalness closure_lbl, comma,
399 ppLocalnessMacro True{-include dyn-} info_lbl,
402 nest 2 (ppr_payload (amodes ++ padding_wds ++ static_link_field)),
406 info_lbl = infoTableLabelFromCI cl_info
408 ppr_payload [] = empty
409 ppr_payload ls = comma <+>
410 braces (hsep (punctuate comma (map ((text "(L_)" <>).ppr_item) ls)))
413 | rep == VoidRep = text "0" -- might not even need this...
414 | rep == FloatRep = ppr_amode (floatToWord item)
415 | rep == DoubleRep = hcat (punctuate (text ", (L_)")
416 (map ppr_amode (doubleToWords item)))
417 | otherwise = ppr_amode item
419 rep = getAmodeRep item
422 if not (closureUpdReqd cl_info) then
425 case max 0 (mIN_UPD_SIZE - length amodes) of { still_needed ->
426 nOfThem still_needed (mkIntCLit 0) } -- a bunch of 0s
429 | staticClosureNeedsLink cl_info = [mkIntCLit 0]
432 pprAbsC stmt@(CClosureInfoAndCode cl_info slow maybe_fast cl_descr) _
435 ptext SLIT("INFO_TABLE"),
436 ( if is_selector then
437 ptext SLIT("_SELECTOR")
438 else if is_constr then
439 ptext SLIT("_CONSTR")
440 else if needs_srt then
442 else empty ), char '(',
444 pprCLabel info_lbl, comma,
445 pprCLabel slow_lbl, comma,
446 pp_rest, {- ptrs,nptrs,[srt,]type,-} comma,
448 ppLocalness info_lbl, comma,
449 ppLocalnessMacro True{-include dyn-} slow_lbl, comma,
451 if_profiling pp_descr, comma,
452 if_profiling pp_type,
458 Just fast -> let stuff = CCodeBlock fast_lbl fast in
459 pprAbsC stuff (costs stuff)
462 info_lbl = infoTableLabelFromCI cl_info
463 fast_lbl = fastLabelFromCI cl_info
466 = case (nonemptyAbsC slow) of
467 Nothing -> (mkErrorStdEntryLabel, empty)
468 Just xx -> (entryLabelFromCI cl_info,
469 let stuff = CCodeBlock slow_lbl xx in
470 pprAbsC stuff (costs stuff))
472 maybe_selector = maybeSelectorInfo cl_info
473 is_selector = maybeToBool maybe_selector
474 (Just select_word_i) = maybe_selector
476 maybe_tag = closureSemiTag cl_info
477 is_constr = maybeToBool maybe_tag
478 (Just tag) = maybe_tag
480 needs_srt = infoTblNeedsSRT cl_info
481 srt = getSRTInfo cl_info
483 size = closureNonHdrSize cl_info
485 ptrs = closurePtrsSize cl_info
488 pp_rest | is_selector = int select_word_i
493 hcat [ int tag, comma ]
494 else if needs_srt then
499 type_str = pprSMRep (closureSMRep cl_info)
501 pp_descr = hcat [char '"', text (stringToC cl_descr), char '"']
502 pp_type = hcat [char '"', text (stringToC (closureTypeDescr cl_info)), char '"']
504 pprAbsC stmt@(CClosureTbl tycon) _
506 ptext SLIT("CLOSURE_TBL") <>
507 lparen <> pprCLabel (mkClosureTblLabel tycon) <> rparen :
509 map (pp_closure_lbl . mkClosureLabel . getName . dataConWrapId) (tyConDataCons tycon)
511 ) $$ ptext SLIT("};")
513 pprAbsC stmt@(CRetDirect uniq code srt liveness) _
516 ptext SLIT("INFO_TABLE_SRT_BITMAP"), lparen,
517 pprCLabel info_lbl, comma,
518 pprCLabel entry_lbl, comma,
519 pp_liveness liveness, comma, -- bitmap
520 pp_srt_info srt, -- SRT
521 ptext type_str, comma, -- closure type
522 ppLocalness info_lbl, comma, -- info table storage class
523 ppLocalnessMacro True{-include dyn-} entry_lbl, comma, -- entry pt storage class
530 info_lbl = mkReturnInfoLabel uniq
531 entry_lbl = mkReturnPtLabel uniq
533 pp_code = let stuff = CCodeBlock entry_lbl code in
534 pprAbsC stuff (costs stuff)
536 type_str = case liveness of
537 LvSmall _ -> SLIT("RET_SMALL")
538 LvLarge _ -> SLIT("RET_BIG")
540 pprAbsC stmt@(CRetVector lbl amodes srt liveness) _
541 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
545 ptext SLIT("VEC_INFO_") <> int size,
547 pprCLabel lbl, comma,
548 pp_liveness liveness, comma, -- bitmap liveness mask
549 pp_srt_info srt, -- SRT
550 ptext type_str, comma,
551 ppLocalness lbl, comma
553 nest 2 (sep (punctuate comma (map ppr_item amodes))),
559 ppr_item item = (<>) (text "(F_) ") (ppr_amode item)
562 type_str = case liveness of
563 LvSmall _ -> SLIT("RET_VEC_SMALL")
564 LvLarge _ -> SLIT("RET_VEC_BIG")
567 pprAbsC stmt@(CModuleInitBlock lbl code) _
569 ptext SLIT("START_MOD_INIT") <> parens (pprCLabel lbl),
570 case (pprTempAndExternDecls stmt) of { (_, pp_exts) -> pp_exts },
571 pprAbsC code (costs code),
572 hcat [ptext SLIT("END_MOD_INIT"), lparen, rparen]
575 pprAbsC (CCostCentreDecl is_local cc) _ = pprCostCentreDecl is_local cc
576 pprAbsC (CCostCentreStackDecl ccs) _ = pprCostCentreStackDecl ccs
581 = if (externallyVisibleCLabel lbl)
583 else ptext SLIT("static ")
585 -- Horrible macros for declaring the types and locality of labels (see
588 ppLocalnessMacro include_dyn_prefix clabel =
593 ClosureType -> ptext SLIT("C_")
594 CodeType -> ptext SLIT("F_")
595 InfoTblType -> ptext SLIT("I_")
596 ClosureTblType -> ptext SLIT("CP_")
597 DataType -> ptext SLIT("D_")
600 is_visible = externallyVisibleCLabel clabel
601 label_type = labelType clabel
604 | is_visible = char 'E'
605 | otherwise = char 'I'
608 | include_dyn_prefix && labelDynamic clabel = char 'D'
616 grab_non_void_amodes amodes
617 = filter non_void amodes
620 = case (getAmodeRep amode) of
626 ppr_vol_regs :: [MagicId] -> (SDoc, SDoc)
628 ppr_vol_regs [] = (empty, empty)
629 ppr_vol_regs (VoidReg:rs) = ppr_vol_regs rs
631 = let pp_reg = case r of
632 VanillaReg pk n -> pprVanillaReg n
634 (more_saves, more_restores) = ppr_vol_regs rs
636 (($$) ((<>) (ptext SLIT("CALLER_SAVE_")) pp_reg) more_saves,
637 ($$) ((<>) (ptext SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
639 -- pp_basic_{saves,restores}: The BaseReg, Sp, Su, Hp and
640 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
641 -- depending on the platform. (The "volatile regs" stuff handles all
642 -- other registers.) Just be *sure* BaseReg is OK before trying to do
643 -- anything else. The correct sequence of saves&restores are
644 -- encoded by the CALLER_*_SYSTEM macros.
645 pp_basic_saves = ptext SLIT("CALLER_SAVE_SYSTEM")
646 pp_basic_restores = ptext SLIT("CALLER_RESTORE_SYSTEM")
650 has_srt (_, NoSRT) = False
659 (lbl, SRT off len) ->
660 hcat [ pprCLabel lbl, comma,
667 | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
668 | otherwise = char '&' <> pprCLabel lbl
673 = if opt_SccProfilingOn
675 else char '0' -- leave it out!
676 -- ---------------------------------------------------------------------------
677 -- Changes for GrAnSim:
678 -- draw costs for computation in head of if into both branches;
679 -- as no abstractC data structure is given for the head, one is constructed
680 -- guessing unknown values and fed into the costs function
681 -- ---------------------------------------------------------------------------
683 do_if_stmt discrim tag alt_code deflt c
685 -- This special case happens when testing the result of a comparison.
686 -- We can just avoid some redundant clutter in the output.
687 MachInt n | n==0 -> ppr_if_stmt (pprAmode discrim)
689 (addrModeCosts discrim Rhs) c
691 cond = hcat [ pprAmode discrim
694 , pprAmode (CLit tag)
696 -- to be absolutely sure that none of the
697 -- conversion rules hit, e.g.,
699 -- minInt is different to (int)minInt
701 -- in C (when minInt is a number not a constant
702 -- expression which evaluates to it.)
704 tcast = case other of
705 MachInt _ -> ptext SLIT("(I_)")
710 (addrModeCosts discrim Rhs) c
712 ppr_if_stmt pp_pred then_part else_part discrim_costs c
714 hcat [text "if (", pp_pred, text ") {"],
715 nest 8 (pprAbsC then_part (c + discrim_costs +
716 (Cost (0, 2, 0, 0, 0)) +
718 (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
719 nest 8 (pprAbsC else_part (c + discrim_costs +
720 (Cost (0, 1, 0, 0, 0)) +
723 {- Total costs = inherited costs (before if) + costs for accessing discrim
724 + costs for cond branch ( = (0, 1, 0, 0, 0) )
725 + costs for that alternative
729 Historical note: this used to be two separate cases -- one for `ccall'
730 and one for `casm'. To get round a potential limitation to only 10
731 arguments, the numbering of arguments in @process_casm@ was beefed up a
734 Some rough notes on generating code for @CCallOp@:
736 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
737 2) Save any essential registers (heap, stack, etc).
739 ToDo: If stable pointers are in use, these must be saved in a place
740 where the runtime system can get at them so that the Stg world can
741 be restarted during the call.
743 3) Save any temporary registers that are currently in use.
744 4) Do the call, putting result into a local variable
745 5) Restore essential registers
746 6) Restore temporaries
748 (This happens after restoration of essential registers because we
749 might need the @Base@ register to access all the others correctly.)
751 Otherwise, copy local variable into result register.
753 8) If ccall (not casm), declare the function being called as extern so
754 that C knows if it returns anything other than an int.
757 { ResultType _ccall_result;
760 _ccall_result = f( args );
764 return_reg = _ccall_result;
768 Amendment to the above: if we can GC, we have to:
770 * make sure we save all our registers away where the garbage collector
772 * be sure that there are no live registers or we're in trouble.
773 (This can cause problems if you try something foolish like passing
774 an array or a foreign obj to a _ccall_GC_ thing.)
775 * increment/decrement the @inCCallGC@ counter before/after the call so
776 that the runtime check that PerformGC is being used sensibly will work.
779 pprCCall call@(CCall op_str is_asm may_gc cconv) args results vol_regs
782 declare_local_vars, -- local var for *result*
783 vcat local_arg_decls,
785 process_casm local_vars pp_non_void_args casm_str,
791 (pp_saves, pp_restores) = ppr_vol_regs vol_regs
792 (pp_save_context, pp_restore_context)
793 | may_gc = ( text "{ I_ id; SUSPEND_THREAD(id);"
794 , text "RESUME_THREAD(id);}"
796 | otherwise = ( pp_basic_saves $$ pp_saves,
797 pp_basic_restores $$ pp_restores)
801 in ASSERT2 ( all non_void nvas, pprCCallOp call <+> hsep (map pprAmode args) )
803 -- the last argument will be the "I/O world" token (a VoidRep)
804 -- all others should be non-void
807 let nvrs = grab_non_void_amodes results
808 in ASSERT (length nvrs <= 1) nvrs
809 -- there will usually be two results: a (void) state which we
810 -- should ignore and a (possibly void) result.
812 (local_arg_decls, pp_non_void_args)
813 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
815 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
818 case non_void_results of
819 [] -> ptext SLIT("void")
820 [amode] -> text (showPrimRep (getAmodeRep amode))
821 _ -> panic "pprCCall: ccall_res_ty"
823 (declare_local_vars, local_vars, assign_results)
824 = ppr_casm_results non_void_results
826 casm_str = if is_asm then _UNPK_ asm_str else ccall_str
827 StaticTarget asm_str = op_str -- Must be static if it's a casm
829 -- Remainder only used for ccall
831 fun_name = case op_str of
832 DynamicTarget u -> parens (parens (ptext SLIT("_ccall_fun_ty") <> ppr u) <> text "%0")
833 StaticTarget st -> pprCLabelString st
837 if null non_void_results
840 lparen, fun_name, lparen,
841 hcat (punctuate comma ccall_fun_args),
845 ccall_fun_args | isDynamicTarget op_str = tail ccall_args
846 | otherwise = ccall_args
848 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
852 If the argument is a heap object, we need to reach inside and pull out
853 the bit the C world wants to see. The only heap objects which can be
854 passed are @Array@s and @ByteArray@s.
857 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
858 -- (a) decl and assignment, (b) local var to be used later
860 ppr_casm_arg amode a_num
862 a_kind = getAmodeRep amode
863 pp_amode = pprAmode amode
864 pp_kind = pprPrimKind a_kind
866 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
868 (arg_type, pp_amode2)
871 -- for array arguments, pass a pointer to the body of the array
872 -- (PTRS_ARR_CTS skips over all the header nonsense)
873 ArrayRep -> (pp_kind,
874 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
875 ByteArrayRep -> (pp_kind,
876 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
878 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
879 ForeignObjRep -> (pp_kind,
880 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
881 char '(', pp_amode, char ')'])
883 other -> (pp_kind, pp_amode)
886 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
888 (declare_local_var, local_var)
891 For l-values, the critical questions are:
893 1) Are there any results at all?
895 We only allow zero or one results.
899 :: [CAddrMode] -- list of results (length <= 1)
901 ( SDoc, -- declaration of any local vars
902 [SDoc], -- list of result vars (same length as results)
903 SDoc ) -- assignment (if any) of results in local var to registers
906 = (empty, [], empty) -- no results
910 result_reg = ppr_amode r
911 r_kind = getAmodeRep r
913 local_var = ptext SLIT("_ccall_result")
915 (result_type, assign_result)
916 = (pprPrimKind r_kind,
917 hcat [ result_reg, equals, local_var, semi ])
919 declare_local_var = hcat [ result_type, space, local_var, semi ]
921 (declare_local_var, [local_var], assign_result)
924 = panic "ppr_casm_results: ccall/casm with many results"
928 Note the sneaky way _the_ result is represented by a list so that we
929 can complain if it's used twice.
931 ToDo: Any chance of giving line numbers when process-casm fails?
932 Or maybe we should do a check _much earlier_ in compiler. ADR
935 process_casm :: [SDoc] -- results (length <= 1)
936 -> [SDoc] -- arguments
937 -> String -- format string (with embedded %'s)
938 -> SDoc -- code being generated
940 process_casm results args string = process results args string
942 process [] _ "" = empty
943 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
945 "\"\n(Try changing result type to IO ()\n")
947 process ress args ('%':cs)
950 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
953 char '%' <> process ress args css
957 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
958 [r] -> r <> (process [] args css)
959 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
963 read_int :: ReadS Int
966 case (read_int other) of
968 if 0 <= num && num < length args
969 then parens (args !! num) <> process ress args css
970 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
971 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
973 process ress args (other_c:cs)
974 = char other_c <> process ress args cs
977 %************************************************************************
979 \subsection[a2r-assignments]{Assignments}
981 %************************************************************************
983 Printing assignments is a little tricky because of type coercion.
985 First of all, the kind of the thing being assigned can be gotten from
986 the destination addressing mode. (It should be the same as the kind
987 of the source addressing mode.) If the kind of the assignment is of
988 @VoidRep@, then don't generate any code at all.
991 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
993 pprAssign VoidRep dest src = empty
996 Special treatment for floats and doubles, to avoid unwanted conversions.
999 pprAssign FloatRep dest@(CVal reg_rel _) src
1000 = hcat [ ptext SLIT("ASSIGN_FLT"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1002 pprAssign DoubleRep dest@(CVal reg_rel _) src
1003 = hcat [ ptext SLIT("ASSIGN_DBL"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1005 pprAssign Int64Rep dest@(CVal reg_rel _) src
1006 = hcat [ ptext SLIT("ASSIGN_Int64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1007 pprAssign Word64Rep dest@(CVal reg_rel _) src
1008 = hcat [ ptext SLIT("ASSIGN_Word64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1011 Lastly, the question is: will the C compiler think the types of the
1012 two sides of the assignment match?
1014 We assume that the types will match if neither side is a
1015 @CVal@ addressing mode for any register which can point into
1018 Why? Because the heap and stack are used to store miscellaneous
1019 things, whereas the temporaries, registers, etc., are only used for
1020 things of fixed type.
1023 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1024 = hcat [ pprVanillaReg dest, equals,
1025 pprVanillaReg src, semi ]
1027 pprAssign kind dest src
1028 | mixedTypeLocn dest
1029 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1030 = hcat [ ppr_amode dest, equals,
1031 text "(W_)(", -- Here is the cast
1032 ppr_amode src, pp_paren_semi ]
1034 pprAssign kind dest src
1035 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1036 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1037 = hcat [ ppr_amode dest, equals,
1038 text "(P_)(", -- Here is the cast
1039 ppr_amode src, pp_paren_semi ]
1041 pprAssign ByteArrayRep dest src
1043 -- Add in a cast iff the source is mixed
1044 = hcat [ ppr_amode dest, equals,
1045 text "(StgByteArray)(", -- Here is the cast
1046 ppr_amode src, pp_paren_semi ]
1048 pprAssign kind other_dest src
1049 = hcat [ ppr_amode other_dest, equals,
1050 pprAmode src, semi ]
1054 %************************************************************************
1056 \subsection[a2r-CAddrModes]{Addressing modes}
1058 %************************************************************************
1060 @pprAmode@ is used to print r-values (which may need casts), whereas
1061 @ppr_amode@ is used for l-values {\em and} as a help function for
1065 pprAmode, ppr_amode :: CAddrMode -> SDoc
1068 For reasons discussed above under assignments, @CVal@ modes need
1069 to be treated carefully. First come special cases for floats and doubles,
1070 similar to those in @pprAssign@:
1072 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1076 pprAmode (CVal reg_rel FloatRep)
1077 = hcat [ text "PK_FLT(", ppr_amode (CAddr reg_rel), rparen ]
1078 pprAmode (CVal reg_rel DoubleRep)
1079 = hcat [ text "PK_DBL(", ppr_amode (CAddr reg_rel), rparen ]
1080 pprAmode (CVal reg_rel Int64Rep)
1081 = hcat [ text "PK_Int64(", ppr_amode (CAddr reg_rel), rparen ]
1082 pprAmode (CVal reg_rel Word64Rep)
1083 = hcat [ text "PK_Word64(", ppr_amode (CAddr reg_rel), rparen ]
1086 Next comes the case where there is some other cast need, and the
1091 | mixedTypeLocn amode
1092 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1094 | otherwise -- No cast needed
1098 When we have an indirection through a CIndex, we have to be careful to
1099 get the type casts right.
1103 CVal (CIndex kind1 base offset) kind2
1107 *(kind2 *)((kind1 *)base + offset)
1109 That is, the indexing is done in units of kind1, but the resulting
1113 ppr_amode (CVal reg_rel@(CIndex _ _ _) kind)
1114 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1115 (pp_reg, Nothing) -> panic "ppr_amode: CIndex"
1116 (pp_reg, Just offset) ->
1117 hcat [ char '*', parens (pprPrimKind kind <> char '*'),
1118 parens (pp_reg <> char '+' <> offset) ]
1121 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1124 ppr_amode (CVal reg_rel _)
1125 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1126 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1127 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1129 ppr_amode (CAddr reg_rel)
1130 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1131 (pp_reg, Nothing) -> pp_reg
1132 (pp_reg, Just offset) -> (<>) pp_reg offset
1134 ppr_amode (CReg magic_id) = pprMagicId magic_id
1136 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1138 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1140 ppr_amode (CCharLike ch)
1141 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1142 ppr_amode (CIntLike int)
1143 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1145 ppr_amode (CLit lit) = pprBasicLit lit
1147 ppr_amode (CJoinPoint _)
1148 = panic "ppr_amode: CJoinPoint"
1150 ppr_amode (CMacroExpr pk macro as)
1151 = parens (ptext (cExprMacroText macro) <>
1152 parens (hcat (punctuate comma (map pprAmode as))))
1156 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1157 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1158 cExprMacroText GET_TAG = SLIT("GET_TAG")
1159 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1160 cExprMacroText CCS_HDR = SLIT("CCS_HDR")
1162 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1163 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1164 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1165 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1166 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1167 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1168 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1169 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1170 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1171 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1172 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1173 cStmtMacroText GRAN_FETCH = SLIT("GRAN_FETCH")
1174 cStmtMacroText GRAN_RESCHEDULE = SLIT("GRAN_RESCHEDULE")
1175 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1176 cStmtMacroText THREAD_CONTEXT_SWITCH = SLIT("THREAD_CONTEXT_SWITCH")
1177 cStmtMacroText GRAN_YIELD = SLIT("GRAN_YIELD")
1179 cCheckMacroText HP_CHK_NP = SLIT("HP_CHK_NP")
1180 cCheckMacroText STK_CHK_NP = SLIT("STK_CHK_NP")
1181 cCheckMacroText HP_STK_CHK_NP = SLIT("HP_STK_CHK_NP")
1182 cCheckMacroText HP_CHK_SEQ_NP = SLIT("HP_CHK_SEQ_NP")
1183 cCheckMacroText HP_CHK = SLIT("HP_CHK")
1184 cCheckMacroText STK_CHK = SLIT("STK_CHK")
1185 cCheckMacroText HP_STK_CHK = SLIT("HP_STK_CHK")
1186 cCheckMacroText HP_CHK_NOREGS = SLIT("HP_CHK_NOREGS")
1187 cCheckMacroText HP_CHK_UNPT_R1 = SLIT("HP_CHK_UNPT_R1")
1188 cCheckMacroText HP_CHK_UNBX_R1 = SLIT("HP_CHK_UNBX_R1")
1189 cCheckMacroText HP_CHK_F1 = SLIT("HP_CHK_F1")
1190 cCheckMacroText HP_CHK_D1 = SLIT("HP_CHK_D1")
1191 cCheckMacroText HP_CHK_L1 = SLIT("HP_CHK_L1")
1192 cCheckMacroText HP_CHK_UT_ALT = SLIT("HP_CHK_UT_ALT")
1193 cCheckMacroText HP_CHK_GEN = SLIT("HP_CHK_GEN")
1196 %************************************************************************
1198 \subsection[ppr-liveness-masks]{Liveness Masks}
1200 %************************************************************************
1203 pp_liveness :: Liveness -> SDoc
1206 LvLarge lbl -> char '&' <> pprCLabel lbl
1207 LvSmall mask -- Avoid gcc bug when printing minInt
1208 | bitmap_int == minInt -> int (bitmap_int+1) <> text "-1"
1209 | otherwise -> int bitmap_int
1211 bitmap_int = intBS mask
1214 %************************************************************************
1216 \subsection[a2r-MagicIds]{Magic ids}
1218 %************************************************************************
1220 @pprRegRelative@ returns a pair of the @Doc@ for the register
1221 (some casting may be required), and a @Maybe Doc@ for the offset
1222 (zero offset gives a @Nothing@).
1225 addPlusSign :: Bool -> SDoc -> SDoc
1226 addPlusSign False p = p
1227 addPlusSign True p = (<>) (char '+') p
1229 pprSignedInt :: Bool -> Int -> Maybe SDoc -- Nothing => 0
1230 pprSignedInt sign_wanted n
1231 = if n == 0 then Nothing else
1232 if n > 0 then Just (addPlusSign sign_wanted (int n))
1235 pprRegRelative :: Bool -- True <=> Print leading plus sign (if +ve)
1237 -> (SDoc, Maybe SDoc)
1239 pprRegRelative sign_wanted (SpRel off)
1240 = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1242 pprRegRelative sign_wanted r@(HpRel o)
1243 = let pp_Hp = pprMagicId Hp; off = I# o
1248 (pp_Hp, Just ((<>) (char '-') (int off)))
1250 pprRegRelative sign_wanted (NodeRel o)
1251 = let pp_Node = pprMagicId node; off = I# o
1256 (pp_Node, Just (addPlusSign sign_wanted (int off)))
1258 pprRegRelative sign_wanted (CIndex base offset kind)
1259 = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1260 , Just (hcat [if sign_wanted then char '+' else empty,
1261 text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1265 @pprMagicId@ just prints the register name. @VanillaReg@ registers are
1266 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1267 to select the union tag.
1270 pprMagicId :: MagicId -> SDoc
1272 pprMagicId BaseReg = ptext SLIT("BaseReg")
1273 pprMagicId (VanillaReg pk n)
1274 = hcat [ pprVanillaReg n, char '.',
1276 pprMagicId (FloatReg n) = (<>) (ptext SLIT("F")) (int IBOX(n))
1277 pprMagicId (DoubleReg n) = (<>) (ptext SLIT("D")) (int IBOX(n))
1278 pprMagicId (LongReg _ n) = (<>) (ptext SLIT("L")) (int IBOX(n))
1279 pprMagicId Sp = ptext SLIT("Sp")
1280 pprMagicId Su = ptext SLIT("Su")
1281 pprMagicId SpLim = ptext SLIT("SpLim")
1282 pprMagicId Hp = ptext SLIT("Hp")
1283 pprMagicId HpLim = ptext SLIT("HpLim")
1284 pprMagicId CurCostCentre = ptext SLIT("CCCS")
1285 pprMagicId VoidReg = panic "pprMagicId:VoidReg!"
1287 pprVanillaReg :: FAST_INT -> SDoc
1288 pprVanillaReg n = (<>) (char 'R') (int IBOX(n))
1290 pprUnionTag :: PrimRep -> SDoc
1292 pprUnionTag PtrRep = char 'p'
1293 pprUnionTag CodePtrRep = ptext SLIT("fp")
1294 pprUnionTag DataPtrRep = char 'd'
1295 pprUnionTag RetRep = char 'p'
1296 pprUnionTag CostCentreRep = panic "pprUnionTag:CostCentre?"
1298 pprUnionTag CharRep = char 'c'
1299 pprUnionTag IntRep = char 'i'
1300 pprUnionTag WordRep = char 'w'
1301 pprUnionTag AddrRep = char 'a'
1302 pprUnionTag FloatRep = char 'f'
1303 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1305 pprUnionTag StablePtrRep = char 'p'
1306 pprUnionTag StableNameRep = char 'p'
1307 pprUnionTag WeakPtrRep = char 'p'
1308 pprUnionTag ForeignObjRep = char 'p'
1310 pprUnionTag ThreadIdRep = char 't'
1312 pprUnionTag ArrayRep = char 'p'
1313 pprUnionTag ByteArrayRep = char 'b'
1315 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1319 Find and print local and external declarations for a list of
1320 Abstract~C statements.
1322 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1323 pprTempAndExternDecls AbsCNop = (empty, empty)
1325 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1326 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1327 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1328 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1329 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1330 returnTE (vcat real_temps, vcat real_exts) }}
1333 pprTempAndExternDecls other_stmt
1334 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1345 pprBasicLit :: Literal -> SDoc
1346 pprPrimKind :: PrimRep -> SDoc
1348 pprBasicLit lit = ppr lit
1349 pprPrimKind k = ppr k
1353 %************************************************************************
1355 \subsection[a2r-monad]{Monadery}
1357 %************************************************************************
1359 We need some monadery to keep track of temps and externs we have already
1360 printed. This info must be threaded right through the Abstract~C, so
1361 it's most convenient to hide it in this monad.
1363 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1364 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1367 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1368 emptyCLabelSet = emptyFM
1369 x `elementOfCLabelSet` labs
1370 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1372 addToCLabelSet set x = addToFM set x ()
1374 type TEenv = (UniqSet Unique, CLabelSet)
1376 type TeM result = TEenv -> (TEenv, result)
1378 initTE :: TeM a -> a
1380 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1383 {-# INLINE thenTE #-}
1384 {-# INLINE returnTE #-}
1386 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1388 = case a u of { (u_1, result_of_a) ->
1391 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1392 mapTE f [] = returnTE []
1394 = f x `thenTE` \ r ->
1395 mapTE f xs `thenTE` \ rs ->
1398 returnTE :: a -> TeM a
1399 returnTE result env = (env, result)
1401 -- these next two check whether the thing is already
1402 -- recorded, and THEN THEY RECORD IT
1403 -- (subsequent calls will return False for the same uniq/label)
1405 tempSeenTE :: Unique -> TeM Bool
1406 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1407 = if (uniq `elementOfUniqSet` seen_uniqs)
1409 else ((addOneToUniqSet seen_uniqs uniq,
1413 labelSeenTE :: CLabel -> TeM Bool
1414 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1415 = if (lbl `elementOfCLabelSet` seen_labels)
1418 addToCLabelSet seen_labels lbl),
1423 pprTempDecl :: Unique -> PrimRep -> SDoc
1424 pprTempDecl uniq kind
1425 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1427 pprExternDecl :: Bool -> CLabel -> SDoc
1428 pprExternDecl in_srt clabel
1429 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1431 hcat [ ppLocalnessMacro (not in_srt) clabel,
1432 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1435 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1441 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1443 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1445 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1446 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1447 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1448 returnTE (maybe_vcat [p1, p2])
1450 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1452 ppr_decls_AbsC (CAssign dest source)
1453 = ppr_decls_Amode dest `thenTE` \ p1 ->
1454 ppr_decls_Amode source `thenTE` \ p2 ->
1455 returnTE (maybe_vcat [p1, p2])
1457 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1459 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1461 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1463 ppr_decls_AbsC (CSwitch discrim alts deflt)
1464 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1465 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1466 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1467 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1469 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1471 ppr_decls_AbsC (CCodeBlock lbl absC)
1472 = ppr_decls_AbsC absC
1474 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre)
1475 -- ToDo: strictly speaking, should chk "cost_centre" amode
1476 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1481 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1483 info_lbl = infoTableLabelFromCI cl_info
1485 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1486 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1488 ppr_decls_AbsC (CCheck _ amodes code) =
1489 ppr_decls_Amodes amodes `thenTE` \p1 ->
1490 ppr_decls_AbsC code `thenTE` \p2 ->
1491 returnTE (maybe_vcat [p1,p2])
1493 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1495 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1496 -- you get some nasty re-decls of stdio.h if you compile
1497 -- the prelude while looking inside those amodes;
1498 -- no real reason to, anyway.
1499 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1501 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1502 -- ToDo: strictly speaking, should chk "cost_centre" amode
1503 = ppr_decls_Amodes amodes
1505 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1506 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1507 ppr_decls_AbsC slow `thenTE` \ p2 ->
1509 Nothing -> returnTE (Nothing, Nothing)
1510 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1511 returnTE (maybe_vcat [p1, p2, p3])
1513 entry_lbl = CLbl slow_lbl CodePtrRep
1514 slow_lbl = case (nonemptyAbsC slow) of
1515 Nothing -> mkErrorStdEntryLabel
1516 Just _ -> entryLabelFromCI cl_info
1518 ppr_decls_AbsC (CSRT lbl closure_lbls)
1519 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1521 if and seen then Nothing
1522 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1523 | (l,False) <- zip closure_lbls seen ]))
1525 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1526 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1527 ppr_decls_AbsC (CModuleInitBlock _ code) = ppr_decls_AbsC code
1529 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1533 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1534 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1535 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1536 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1537 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1538 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1539 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1541 -- CIntLike must be a literal -- no decls
1542 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1544 -- CCharLike may have be arbitrary value -- may have decls
1545 ppr_decls_Amode (CCharLike char)
1546 = ppr_decls_Amode char
1548 -- now, the only place where we actually print temps/externs...
1549 ppr_decls_Amode (CTemp uniq kind)
1551 VoidRep -> returnTE (Nothing, Nothing)
1553 tempSeenTE uniq `thenTE` \ temp_seen ->
1555 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1557 ppr_decls_Amode (CLbl lbl VoidRep)
1558 = returnTE (Nothing, Nothing)
1560 ppr_decls_Amode (CLbl lbl kind)
1561 = labelSeenTE lbl `thenTE` \ label_seen ->
1563 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1565 ppr_decls_Amode (CMacroExpr _ _ amodes)
1566 = ppr_decls_Amodes amodes
1568 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1571 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1573 = case (unzip ps) of { (ts, es) ->
1574 case (catMaybes ts) of { real_ts ->
1575 case (catMaybes es) of { real_es ->
1576 (if (null real_ts) then Nothing else Just (vcat real_ts),
1577 if (null real_es) then Nothing else Just (vcat real_es))
1582 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1583 ppr_decls_Amodes amodes
1584 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1585 returnTE ( maybe_vcat ps )
1588 Print out a C Label where you want the *address* of the label, not the
1589 object it refers to. The distinction is important when the label may
1590 refer to a C structure (info tables and closures, for instance).
1592 When just generating a declaration for the label, use pprCLabel.
1595 pprCLabelAddr :: CLabel -> SDoc
1596 pprCLabelAddr clabel =
1597 case labelType clabel of
1598 InfoTblType -> addr_of_label
1599 ClosureType -> addr_of_label
1600 VecTblType -> addr_of_label
1603 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1604 pp_label = pprCLabel clabel
1608 -----------------------------------------------------------------------------
1609 Initialising static objects with floating-point numbers. We can't
1610 just emit the floating point number, because C will cast it to an int
1611 by rounding it. We want the actual bit-representation of the float.
1613 This is a hack to turn the floating point numbers into ints that we
1614 can safely initialise to static locations.
1617 big_doubles = (getPrimRepSize DoubleRep) /= 1
1619 -- floatss are always 1 word
1620 floatToWord :: CAddrMode -> CAddrMode
1621 floatToWord (CLit (MachFloat r))
1623 arr <- newFloatArray ((0::Int),0)
1624 writeFloatArray arr 0 (fromRational r)
1625 i <- readIntArray arr 0
1626 return (CLit (MachInt (toInteger i)))
1629 doubleToWords :: CAddrMode -> [CAddrMode]
1630 doubleToWords (CLit (MachDouble r))
1631 | big_doubles -- doubles are 2 words
1633 arr <- newDoubleArray ((0::Int),1)
1634 writeDoubleArray arr 0 (fromRational r)
1635 i1 <- readIntArray arr 0
1636 i2 <- readIntArray arr 1
1637 return [ CLit (MachInt (toInteger i1))
1638 , CLit (MachInt (toInteger i2))
1641 | otherwise -- doubles are 1 word
1643 arr <- newDoubleArray ((0::Int),0)
1644 writeDoubleArray arr 0 (fromRational r)
1645 i <- readIntArray arr 0
1646 return [ CLit (MachInt (toInteger i)) ]