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 ( 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_EmitCExternDecls, 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(..) )
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 )
68 For spitting out the costs of an abstract~C expression, @writeRealC@
69 now not only prints the C~code of the @absC@ arg but also adds a macro
70 call to a cost evaluation function @GRAN_EXEC@. For that,
71 @pprAbsC@ has a new ``costs'' argument. %% HWL
75 writeRealC :: Handle -> AbstractC -> IO ()
76 writeRealC handle absC
77 -- avoid holding on to the whole of absC in the !Gransim case.
79 then printForCFast fp (pprAbsC absC (costs absC))
80 else printForCFast fp (pprAbsC absC (panic "costs"))
81 --printForC handle (pprAbsC absC (panic "costs"))
82 dumpRealC :: AbstractC -> SDoc
83 dumpRealC absC = pprAbsC absC (costs absC)
86 writeRealC :: Handle -> AbstractC -> IO ()
87 --writeRealC handle absC =
89 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
91 writeRealC handle absC
92 | opt_GranMacros = _scc_ "writeRealC" printForC handle $
93 pprCode CStyle (pprAbsC absC (costs absC))
94 | otherwise = _scc_ "writeRealC" printForC handle $
95 pprCode CStyle (pprAbsC absC (panic "costs"))
97 dumpRealC :: AbstractC -> SDoc
99 | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
100 | otherwise = pprCode CStyle (pprAbsC absC (panic "costs"))
104 This emits the macro, which is used in GrAnSim to compute the total costs
105 from a cost 5 tuple. %% HWL
108 emitMacro :: CostRes -> SDoc
110 emitMacro _ | not opt_GranMacros = empty
112 emitMacro (Cost (i,b,l,s,f))
113 = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
114 int i, comma, int b, comma, int l, comma,
115 int s, comma, int f, pp_paren_semi ]
117 pp_paren_semi = text ");"
120 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
121 code as an argument (that's needed when spitting out the GRAN_EXEC macro
122 which must be done before the return i.e. inside absC code) HWL
125 pprAbsC :: AbstractC -> CostRes -> SDoc
126 pprAbsC AbsCNop _ = empty
127 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
129 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
131 pprAbsC (CJump target) c
132 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CJump */"-} ])
133 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
135 pprAbsC (CFallThrough target) c
136 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CFallThrough */"-} ])
137 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
139 -- --------------------------------------------------------------------------
140 -- Spit out GRAN_EXEC macro immediately before the return HWL
142 pprAbsC (CReturn am return_info) c
143 = ($$) (hcat [emitMacro c {-WDP:, text "/* <---- CReturn */"-} ])
144 (hcat [text jmp_lit, target, pp_paren_semi ])
146 target = case return_info of
147 DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
149 DynamicVectoredReturn am' -> mk_vector (pprAmode am')
150 StaticVectoredReturn n -> mk_vector (int n) -- Always positive
151 mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
154 pprAbsC (CSplitMarker) _ = ptext SLIT("/* SPLIT */")
156 -- we optimise various degenerate cases of CSwitches.
158 -- --------------------------------------------------------------------------
159 -- Assume: CSwitch is also end of basic block
160 -- costs function yields nullCosts for whole switch
161 -- ==> inherited costs c are those of basic block up to switch
162 -- ==> inherit c + costs for the corresponding branch
164 -- --------------------------------------------------------------------------
166 pprAbsC (CSwitch discrim [] deflt) c
167 = pprAbsC deflt (c + costs deflt)
168 -- Empty alternative list => no costs for discrim as nothing cond. here HWL
170 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
171 = case (nonemptyAbsC deflt) of
172 Nothing -> -- one alt and no default
173 pprAbsC alt_code (c + costs alt_code)
174 -- Nothing conditional in here either HWL
176 Just dc -> -- make it an "if"
177 do_if_stmt discrim tag alt_code dc c
179 -- What problem is the re-ordering trying to solve ?
180 pprAbsC (CSwitch discrim [(tag1@(MachInt i1), alt_code1),
181 (tag2@(MachInt i2), alt_code2)] deflt) c
182 | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
184 do_if_stmt discrim tag1 alt_code1 alt_code2 c
186 do_if_stmt discrim tag2 alt_code2 alt_code1 c
188 empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
190 pprAbsC (CSwitch discrim alts deflt) c -- general case
191 | isFloatingRep (getAmodeRep discrim)
192 = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
195 hcat [text "switch (", pp_discrim, text ") {"],
196 nest 2 (vcat (map ppr_alt alts)),
197 (case (nonemptyAbsC deflt) of
200 nest 2 (vcat [ptext SLIT("default:"),
201 pprAbsC dc (c + switch_head_cost
203 ptext SLIT("break;")])),
210 = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
211 nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
212 (ptext SLIT("break;"))) ]
214 -- Costs for addressing header of switch and cond. branching -- HWL
215 switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
217 pprAbsC stmt@(COpStmt results (CCallOp ccall) args vol_regs) _
218 = pprCCall ccall args results vol_regs
220 pprAbsC stmt@(COpStmt results op args vol_regs) _
222 non_void_args = grab_non_void_amodes args
223 non_void_results = grab_non_void_amodes results
224 -- if just one result, we print in the obvious "assignment" style;
225 -- if 0 or many results, we emit a macro call, w/ the results
226 -- followed by the arguments. The macro presumably knows which
229 the_op = ppr_op_call non_void_results non_void_args
230 -- liveness mask is *in* the non_void_args
232 if primOpNeedsWrapper op then
233 case (ppr_vol_regs vol_regs) of { (pp_saves, pp_restores) ->
242 ppr_op_call results args
243 = hcat [ pprPrimOp op, lparen,
244 hcat (punctuate comma (map ppr_op_result results)),
245 if null results || null args then empty else comma,
246 hcat (punctuate comma (map pprAmode args)),
249 ppr_op_result r = ppr_amode r
250 -- primop macros do their own casting of result;
251 -- hence we can toss the provided cast...
253 pprAbsC stmt@(CSRT lbl closures) c
254 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
256 $$ ptext SLIT("SRT") <> lparen <> pprCLabel lbl <> rparen
257 $$ nest 2 (hcat (punctuate comma (map pp_closure_lbl closures)))
261 pprAbsC stmt@(CBitmap lbl mask) c
263 hcat [ ptext SLIT("BITMAP"), lparen,
264 pprCLabel lbl, comma,
267 hcat (punctuate comma (map (int.intBS) mask)),
271 pprAbsC (CSimultaneous abs_c) c
272 = hcat [ptext SLIT("{{"), pprAbsC abs_c c, ptext SLIT("}}")]
274 pprAbsC (CCheck macro as code) c
275 = hcat [ptext (cCheckMacroText macro), lparen,
276 hcat (punctuate comma (map ppr_amode as)), comma,
277 pprAbsC code c, pp_paren_semi
279 pprAbsC (CMacroStmt macro as) _
280 = hcat [ptext (cStmtMacroText macro), lparen,
281 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi] -- no casting
282 pprAbsC (CCallProfCtrMacro op as) _
283 = hcat [ptext op, lparen,
284 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
285 pprAbsC (CCallProfCCMacro op as) _
286 = hcat [ptext op, lparen,
287 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
288 pprAbsC stmt@(CCallTypedef is_tdef (CCall op_str is_asm may_gc cconv) results args) _
289 = hsep [ ptext (if is_tdef then SLIT("typedef") else SLIT("extern"))
292 , parens (hsep (punctuate comma ccall_decl_ty_args))
296 In the non-casm case, to ensure that we're entering the given external
297 entry point using the correct calling convention, we have to do the following:
299 - When entering via a function pointer (the `dynamic' case) using the specified
300 calling convention, we emit a typedefn declaration attributed with the
301 calling convention to use together with the result and parameter types we're
302 assuming. Coerce the function pointer to this type and go.
304 - to enter the function at a given code label, we emit an extern declaration
305 for the label here, stating the calling convention together with result and
306 argument types we're assuming.
308 The C compiler will hopefully use this extern declaration to good effect,
309 reporting any discrepancies between our extern decl and any other that
312 Re: calling convention, notice that gcc (2.8.1 and egcs-1.0.2) will for
313 the external function `foo' use the calling convention of the first `foo'
314 prototype it encounters (nor does it complain about conflicting attribute
315 declarations). The consequence of this is that you cannot override the
316 calling convention of `foo' using an extern declaration (you'd have to use
317 a typedef), but why you would want to do such a thing in the first place
318 is totally beyond me.
320 ToDo: petition the gcc folks to add code to warn about conflicting attribute
326 | is_tdef = parens (text (callConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
327 | otherwise = text (callConvAttribute cconv) <+> ccall_fun_ty
331 DynamicTarget u -> ptext SLIT("_ccall_fun_ty") <> ppr u
332 StaticTarget x -> pprCLabelString x
335 case non_void_results of
336 [] -> ptext SLIT("void")
337 [amode] -> text (showPrimRep (getAmodeRep amode))
338 _ -> panic "pprAbsC{CCallTypedef}: ccall_res_ty"
341 | is_tdef = tail ccall_arg_tys
342 | otherwise = ccall_arg_tys
344 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
346 -- the first argument will be the "I/O world" token (a VoidRep)
347 -- all others should be non-void
350 in ASSERT (all non_void nvas) nvas
352 -- there will usually be two results: a (void) state which we
353 -- should ignore and a (possibly void) result.
355 let nvrs = grab_non_void_amodes results
356 in ASSERT (length nvrs <= 1) nvrs
358 pprAbsC (CCodeBlock lbl abs_C) _
359 = if not (maybeToBool(nonemptyAbsC abs_C)) then
360 pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
362 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
602 is_dynamic = labelDynamic clabel
605 | is_visible = char 'E'
606 | otherwise = char 'I'
609 | not include_dyn_prefix = empty
610 | is_dynamic = char 'D'
618 grab_non_void_amodes amodes
619 = filter non_void amodes
622 = case (getAmodeRep amode) of
628 ppr_vol_regs :: [MagicId] -> (SDoc, SDoc)
630 ppr_vol_regs [] = (empty, empty)
631 ppr_vol_regs (VoidReg:rs) = ppr_vol_regs rs
633 = let pp_reg = case r of
634 VanillaReg pk n -> pprVanillaReg n
636 (more_saves, more_restores) = ppr_vol_regs rs
638 (($$) ((<>) (ptext SLIT("CALLER_SAVE_")) pp_reg) more_saves,
639 ($$) ((<>) (ptext SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
641 -- pp_basic_{saves,restores}: The BaseReg, Sp, Su, Hp and
642 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
643 -- depending on the platform. (The "volatile regs" stuff handles all
644 -- other registers.) Just be *sure* BaseReg is OK before trying to do
645 -- anything else. The correct sequence of saves&restores are
646 -- encoded by the CALLER_*_SYSTEM macros.
647 pp_basic_saves = ptext SLIT("CALLER_SAVE_SYSTEM")
648 pp_basic_restores = ptext SLIT("CALLER_RESTORE_SYSTEM")
652 has_srt (_, NoSRT) = False
661 (lbl, SRT off len) ->
662 hcat [ pprCLabel lbl, comma,
669 | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
670 | otherwise = char '&' <> pprCLabel lbl
675 = if opt_SccProfilingOn
677 else char '0' -- leave it out!
678 -- ---------------------------------------------------------------------------
679 -- Changes for GrAnSim:
680 -- draw costs for computation in head of if into both branches;
681 -- as no abstractC data structure is given for the head, one is constructed
682 -- guessing unknown values and fed into the costs function
683 -- ---------------------------------------------------------------------------
685 do_if_stmt discrim tag alt_code deflt c
687 -- This special case happens when testing the result of a comparison.
688 -- We can just avoid some redundant clutter in the output.
689 MachInt n | n==0 -> ppr_if_stmt (pprAmode discrim)
691 (addrModeCosts discrim Rhs) c
693 cond = hcat [ pprAmode discrim
696 , pprAmode (CLit tag)
698 -- to be absolutely sure that none of the
699 -- conversion rules hit, e.g.,
701 -- minInt is different to (int)minInt
703 -- in C (when minInt is a number not a constant
704 -- expression which evaluates to it.)
706 tcast = case other of
707 MachInt _ -> ptext SLIT("(I_)")
712 (addrModeCosts discrim Rhs) c
714 ppr_if_stmt pp_pred then_part else_part discrim_costs c
716 hcat [text "if (", pp_pred, text ") {"],
717 nest 8 (pprAbsC then_part (c + discrim_costs +
718 (Cost (0, 2, 0, 0, 0)) +
720 (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
721 nest 8 (pprAbsC else_part (c + discrim_costs +
722 (Cost (0, 1, 0, 0, 0)) +
725 {- Total costs = inherited costs (before if) + costs for accessing discrim
726 + costs for cond branch ( = (0, 1, 0, 0, 0) )
727 + costs for that alternative
731 Historical note: this used to be two separate cases -- one for `ccall'
732 and one for `casm'. To get round a potential limitation to only 10
733 arguments, the numbering of arguments in @process_casm@ was beefed up a
736 Some rough notes on generating code for @CCallOp@:
738 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
739 2) Save any essential registers (heap, stack, etc).
741 ToDo: If stable pointers are in use, these must be saved in a place
742 where the runtime system can get at them so that the Stg world can
743 be restarted during the call.
745 3) Save any temporary registers that are currently in use.
746 4) Do the call, putting result into a local variable
747 5) Restore essential registers
748 6) Restore temporaries
750 (This happens after restoration of essential registers because we
751 might need the @Base@ register to access all the others correctly.)
753 Otherwise, copy local variable into result register.
755 8) If ccall (not casm), declare the function being called as extern so
756 that C knows if it returns anything other than an int.
759 { ResultType _ccall_result;
762 _ccall_result = f( args );
766 return_reg = _ccall_result;
770 Amendment to the above: if we can GC, we have to:
772 * make sure we save all our registers away where the garbage collector
774 * be sure that there are no live registers or we're in trouble.
775 (This can cause problems if you try something foolish like passing
776 an array or a foreign obj to a _ccall_GC_ thing.)
777 * increment/decrement the @inCCallGC@ counter before/after the call so
778 that the runtime check that PerformGC is being used sensibly will work.
781 pprCCall call@(CCall op_str is_asm may_gc cconv) args results vol_regs
784 declare_local_vars, -- local var for *result*
785 vcat local_arg_decls,
787 process_casm local_vars pp_non_void_args casm_str,
793 (pp_saves, pp_restores) = ppr_vol_regs vol_regs
794 (pp_save_context, pp_restore_context)
795 | may_gc = ( text "{ I_ id; SUSPEND_THREAD(id);"
796 , text "RESUME_THREAD(id);}"
798 | otherwise = ( pp_basic_saves $$ pp_saves,
799 pp_basic_restores $$ pp_restores)
801 non_void_args = let nvas = take (length args - 1) args
802 in ASSERT2 ( all non_void nvas, pprCCallOp call <+> hsep (map pprAmode args) )
804 -- the last argument will be the "I/O world" token (a VoidRep)
805 -- all others should be non-void
808 let nvrs = grab_non_void_amodes results
809 in ASSERT (length nvrs <= 1) nvrs
810 -- there will usually be two results: a (void) state which we
811 -- should ignore and a (possibly void) result.
813 (local_arg_decls, pp_non_void_args)
814 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
816 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
819 case non_void_results of
820 [] -> ptext SLIT("void")
821 [amode] -> text (showPrimRep (getAmodeRep amode))
822 _ -> panic "pprCCall: ccall_res_ty"
825 ptext SLIT("_ccall_fun_ty") <>
827 DynamicTarget u -> ppr u
830 (declare_local_vars, local_vars, assign_results)
831 = ppr_casm_results non_void_results
833 (StaticTarget asm_str) = op_str
836 StaticTarget _ -> False
837 DynamicTarget _ -> True
839 casm_str = if is_asm then _UNPK_ asm_str else ccall_str
841 -- Remainder only used for ccall
844 | is_dynamic = parens (parens (ccall_fun_ty) <> text "%0")
845 | otherwise = ptext asm_str
849 if null non_void_results
852 lparen, fun_name, lparen,
853 hcat (punctuate comma ccall_fun_args),
858 | is_dynamic = tail ccall_args
859 | otherwise = ccall_args
861 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
865 If the argument is a heap object, we need to reach inside and pull out
866 the bit the C world wants to see. The only heap objects which can be
867 passed are @Array@s and @ByteArray@s.
870 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
871 -- (a) decl and assignment, (b) local var to be used later
873 ppr_casm_arg amode a_num
875 a_kind = getAmodeRep amode
876 pp_amode = pprAmode amode
877 pp_kind = pprPrimKind a_kind
879 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
881 (arg_type, pp_amode2)
884 -- for array arguments, pass a pointer to the body of the array
885 -- (PTRS_ARR_CTS skips over all the header nonsense)
886 ArrayRep -> (pp_kind,
887 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
888 ByteArrayRep -> (pp_kind,
889 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
891 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
892 ForeignObjRep -> (pp_kind,
893 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
894 char '(', pp_amode, char ')'])
896 other -> (pp_kind, pp_amode)
899 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
901 (declare_local_var, local_var)
904 For l-values, the critical questions are:
906 1) Are there any results at all?
908 We only allow zero or one results.
912 :: [CAddrMode] -- list of results (length <= 1)
914 ( SDoc, -- declaration of any local vars
915 [SDoc], -- list of result vars (same length as results)
916 SDoc ) -- assignment (if any) of results in local var to registers
919 = (empty, [], empty) -- no results
923 result_reg = ppr_amode r
924 r_kind = getAmodeRep r
926 local_var = ptext SLIT("_ccall_result")
928 (result_type, assign_result)
929 = (pprPrimKind r_kind,
930 hcat [ result_reg, equals, local_var, semi ])
932 declare_local_var = hcat [ result_type, space, local_var, semi ]
934 (declare_local_var, [local_var], assign_result)
937 = panic "ppr_casm_results: ccall/casm with many results"
941 Note the sneaky way _the_ result is represented by a list so that we
942 can complain if it's used twice.
944 ToDo: Any chance of giving line numbers when process-casm fails?
945 Or maybe we should do a check _much earlier_ in compiler. ADR
948 process_casm :: [SDoc] -- results (length <= 1)
949 -> [SDoc] -- arguments
950 -> String -- format string (with embedded %'s)
951 -> SDoc -- code being generated
953 process_casm results args string = process results args string
955 process [] _ "" = empty
956 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
958 "\"\n(Try changing result type to PrimIO ()\n")
960 process ress args ('%':cs)
963 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
966 char '%' <> process ress args css
970 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
971 [r] -> r <> (process [] args css)
972 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
976 read_int :: ReadS Int
979 case (read_int other) of
981 if 0 <= num && num < length args
982 then parens (args !! num) <> process ress args css
983 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
984 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
986 process ress args (other_c:cs)
987 = char other_c <> process ress args cs
990 %************************************************************************
992 \subsection[a2r-assignments]{Assignments}
994 %************************************************************************
996 Printing assignments is a little tricky because of type coercion.
998 First of all, the kind of the thing being assigned can be gotten from
999 the destination addressing mode. (It should be the same as the kind
1000 of the source addressing mode.) If the kind of the assignment is of
1001 @VoidRep@, then don't generate any code at all.
1004 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
1006 pprAssign VoidRep dest src = empty
1009 Special treatment for floats and doubles, to avoid unwanted conversions.
1012 pprAssign FloatRep dest@(CVal reg_rel _) src
1013 = hcat [ ptext SLIT("ASSIGN_FLT"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1015 pprAssign DoubleRep dest@(CVal reg_rel _) src
1016 = hcat [ ptext SLIT("ASSIGN_DBL"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1018 pprAssign Int64Rep dest@(CVal reg_rel _) src
1019 = hcat [ ptext SLIT("ASSIGN_Int64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1020 pprAssign Word64Rep dest@(CVal reg_rel _) src
1021 = hcat [ ptext SLIT("ASSIGN_Word64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1024 Lastly, the question is: will the C compiler think the types of the
1025 two sides of the assignment match?
1027 We assume that the types will match if neither side is a
1028 @CVal@ addressing mode for any register which can point into
1031 Why? Because the heap and stack are used to store miscellaneous
1032 things, whereas the temporaries, registers, etc., are only used for
1033 things of fixed type.
1036 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1037 = hcat [ pprVanillaReg dest, equals,
1038 pprVanillaReg src, semi ]
1040 pprAssign kind dest src
1041 | mixedTypeLocn dest
1042 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1043 = hcat [ ppr_amode dest, equals,
1044 text "(W_)(", -- Here is the cast
1045 ppr_amode src, pp_paren_semi ]
1047 pprAssign kind dest src
1048 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1049 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1050 = hcat [ ppr_amode dest, equals,
1051 text "(P_)(", -- Here is the cast
1052 ppr_amode src, pp_paren_semi ]
1054 pprAssign ByteArrayRep dest src
1056 -- Add in a cast iff the source is mixed
1057 = hcat [ ppr_amode dest, equals,
1058 text "(StgByteArray)(", -- Here is the cast
1059 ppr_amode src, pp_paren_semi ]
1061 pprAssign kind other_dest src
1062 = hcat [ ppr_amode other_dest, equals,
1063 pprAmode src, semi ]
1067 %************************************************************************
1069 \subsection[a2r-CAddrModes]{Addressing modes}
1071 %************************************************************************
1073 @pprAmode@ is used to print r-values (which may need casts), whereas
1074 @ppr_amode@ is used for l-values {\em and} as a help function for
1078 pprAmode, ppr_amode :: CAddrMode -> SDoc
1081 For reasons discussed above under assignments, @CVal@ modes need
1082 to be treated carefully. First come special cases for floats and doubles,
1083 similar to those in @pprAssign@:
1085 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1089 pprAmode (CVal reg_rel FloatRep)
1090 = hcat [ text "PK_FLT(", ppr_amode (CAddr reg_rel), rparen ]
1091 pprAmode (CVal reg_rel DoubleRep)
1092 = hcat [ text "PK_DBL(", ppr_amode (CAddr reg_rel), rparen ]
1093 pprAmode (CVal reg_rel Int64Rep)
1094 = hcat [ text "PK_Int64(", ppr_amode (CAddr reg_rel), rparen ]
1095 pprAmode (CVal reg_rel Word64Rep)
1096 = hcat [ text "PK_Word64(", ppr_amode (CAddr reg_rel), rparen ]
1099 Next comes the case where there is some other cast need, and the
1104 | mixedTypeLocn amode
1105 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1107 | otherwise -- No cast needed
1111 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1114 ppr_amode (CVal reg_rel _)
1115 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1116 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1117 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1119 ppr_amode (CAddr reg_rel)
1120 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1121 (pp_reg, Nothing) -> pp_reg
1122 (pp_reg, Just offset) -> (<>) pp_reg offset
1124 ppr_amode (CReg magic_id) = pprMagicId magic_id
1126 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1128 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1130 ppr_amode (CCharLike ch)
1131 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1132 ppr_amode (CIntLike int)
1133 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1135 ppr_amode (CLit lit) = pprBasicLit lit
1137 ppr_amode (CLitLit str _) = ptext str
1139 ppr_amode (CJoinPoint _)
1140 = panic "ppr_amode: CJoinPoint"
1142 ppr_amode (CMacroExpr pk macro as)
1143 = parens (pprPrimKind pk) <>
1144 parens (ptext (cExprMacroText macro) <>
1145 parens (hcat (punctuate comma (map pprAmode as))))
1149 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1150 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1151 cExprMacroText GET_TAG = SLIT("GET_TAG")
1152 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1154 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1155 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1156 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1157 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1158 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1159 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1160 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1161 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1162 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1163 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1164 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1165 cStmtMacroText GRAN_FETCH = SLIT("GRAN_FETCH")
1166 cStmtMacroText GRAN_RESCHEDULE = SLIT("GRAN_RESCHEDULE")
1167 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1168 cStmtMacroText THREAD_CONTEXT_SWITCH = SLIT("THREAD_CONTEXT_SWITCH")
1169 cStmtMacroText GRAN_YIELD = SLIT("GRAN_YIELD")
1171 cCheckMacroText HP_CHK_NP = SLIT("HP_CHK_NP")
1172 cCheckMacroText STK_CHK_NP = SLIT("STK_CHK_NP")
1173 cCheckMacroText HP_STK_CHK_NP = SLIT("HP_STK_CHK_NP")
1174 cCheckMacroText HP_CHK_SEQ_NP = SLIT("HP_CHK_SEQ_NP")
1175 cCheckMacroText HP_CHK = SLIT("HP_CHK")
1176 cCheckMacroText STK_CHK = SLIT("STK_CHK")
1177 cCheckMacroText HP_STK_CHK = SLIT("HP_STK_CHK")
1178 cCheckMacroText HP_CHK_NOREGS = SLIT("HP_CHK_NOREGS")
1179 cCheckMacroText HP_CHK_UNPT_R1 = SLIT("HP_CHK_UNPT_R1")
1180 cCheckMacroText HP_CHK_UNBX_R1 = SLIT("HP_CHK_UNBX_R1")
1181 cCheckMacroText HP_CHK_F1 = SLIT("HP_CHK_F1")
1182 cCheckMacroText HP_CHK_D1 = SLIT("HP_CHK_D1")
1183 cCheckMacroText HP_CHK_L1 = SLIT("HP_CHK_L1")
1184 cCheckMacroText HP_CHK_UT_ALT = SLIT("HP_CHK_UT_ALT")
1185 cCheckMacroText HP_CHK_GEN = SLIT("HP_CHK_GEN")
1188 %************************************************************************
1190 \subsection[ppr-liveness-masks]{Liveness Masks}
1192 %************************************************************************
1195 pp_liveness :: Liveness -> SDoc
1198 LvLarge lbl -> char '&' <> pprCLabel lbl
1199 LvSmall mask -- Avoid gcc bug when printing minInt
1200 | bitmap_int == minInt -> int (bitmap_int+1) <> text "-1"
1201 | otherwise -> int bitmap_int
1203 bitmap_int = intBS mask
1206 %************************************************************************
1208 \subsection[a2r-MagicIds]{Magic ids}
1210 %************************************************************************
1212 @pprRegRelative@ returns a pair of the @Doc@ for the register
1213 (some casting may be required), and a @Maybe Doc@ for the offset
1214 (zero offset gives a @Nothing@).
1217 addPlusSign :: Bool -> SDoc -> SDoc
1218 addPlusSign False p = p
1219 addPlusSign True p = (<>) (char '+') p
1221 pprSignedInt :: Bool -> Int -> Maybe SDoc -- Nothing => 0
1222 pprSignedInt sign_wanted n
1223 = if n == 0 then Nothing else
1224 if n > 0 then Just (addPlusSign sign_wanted (int n))
1227 pprRegRelative :: Bool -- True <=> Print leading plus sign (if +ve)
1229 -> (SDoc, Maybe SDoc)
1231 pprRegRelative sign_wanted (SpRel off)
1232 = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1234 pprRegRelative sign_wanted r@(HpRel o)
1235 = let pp_Hp = pprMagicId Hp; off = I# o
1240 (pp_Hp, Just ((<>) (char '-') (int off)))
1242 pprRegRelative sign_wanted (NodeRel o)
1243 = let pp_Node = pprMagicId node; off = I# o
1248 (pp_Node, Just (addPlusSign sign_wanted (int off)))
1250 pprRegRelative sign_wanted (CIndex base offset kind)
1251 = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1252 , Just (hcat [if sign_wanted then char '+' else empty,
1253 text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1257 @pprMagicId@ just prints the register name. @VanillaReg@ registers are
1258 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1259 to select the union tag.
1262 pprMagicId :: MagicId -> SDoc
1264 pprMagicId BaseReg = ptext SLIT("BaseReg")
1265 pprMagicId (VanillaReg pk n)
1266 = hcat [ pprVanillaReg n, char '.',
1268 pprMagicId (FloatReg n) = (<>) (ptext SLIT("F")) (int IBOX(n))
1269 pprMagicId (DoubleReg n) = (<>) (ptext SLIT("D")) (int IBOX(n))
1270 pprMagicId (LongReg _ n) = (<>) (ptext SLIT("L")) (int IBOX(n))
1271 pprMagicId Sp = ptext SLIT("Sp")
1272 pprMagicId Su = ptext SLIT("Su")
1273 pprMagicId SpLim = ptext SLIT("SpLim")
1274 pprMagicId Hp = ptext SLIT("Hp")
1275 pprMagicId HpLim = ptext SLIT("HpLim")
1276 pprMagicId CurCostCentre = ptext SLIT("CCCS")
1277 pprMagicId VoidReg = panic "pprMagicId:VoidReg!"
1279 pprVanillaReg :: FAST_INT -> SDoc
1280 pprVanillaReg n = (<>) (char 'R') (int IBOX(n))
1282 pprUnionTag :: PrimRep -> SDoc
1284 pprUnionTag PtrRep = char 'p'
1285 pprUnionTag CodePtrRep = ptext SLIT("fp")
1286 pprUnionTag DataPtrRep = char 'd'
1287 pprUnionTag RetRep = char 'p'
1288 pprUnionTag CostCentreRep = panic "pprUnionTag:CostCentre?"
1290 pprUnionTag CharRep = char 'c'
1291 pprUnionTag IntRep = char 'i'
1292 pprUnionTag WordRep = char 'w'
1293 pprUnionTag AddrRep = char 'a'
1294 pprUnionTag FloatRep = char 'f'
1295 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1297 pprUnionTag StablePtrRep = char 'i'
1298 pprUnionTag StableNameRep = char 'p'
1299 pprUnionTag WeakPtrRep = char 'p'
1300 pprUnionTag ForeignObjRep = char 'p'
1302 pprUnionTag ThreadIdRep = char 't'
1304 pprUnionTag ArrayRep = char 'p'
1305 pprUnionTag ByteArrayRep = char 'b'
1307 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1311 Find and print local and external declarations for a list of
1312 Abstract~C statements.
1314 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1315 pprTempAndExternDecls AbsCNop = (empty, empty)
1317 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1318 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1319 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1320 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1321 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1322 returnTE (vcat real_temps, vcat real_exts) }}
1325 pprTempAndExternDecls other_stmt
1326 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1337 pprBasicLit :: Literal -> SDoc
1338 pprPrimKind :: PrimRep -> SDoc
1340 pprBasicLit lit = ppr lit
1341 pprPrimKind k = ppr k
1345 %************************************************************************
1347 \subsection[a2r-monad]{Monadery}
1349 %************************************************************************
1351 We need some monadery to keep track of temps and externs we have already
1352 printed. This info must be threaded right through the Abstract~C, so
1353 it's most convenient to hide it in this monad.
1355 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1356 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1359 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1360 emptyCLabelSet = emptyFM
1361 x `elementOfCLabelSet` labs
1362 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1364 addToCLabelSet set x = addToFM set x ()
1366 type TEenv = (UniqSet Unique, CLabelSet)
1368 type TeM result = TEenv -> (TEenv, result)
1370 initTE :: TeM a -> a
1372 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1375 {-# INLINE thenTE #-}
1376 {-# INLINE returnTE #-}
1378 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1380 = case a u of { (u_1, result_of_a) ->
1383 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1384 mapTE f [] = returnTE []
1386 = f x `thenTE` \ r ->
1387 mapTE f xs `thenTE` \ rs ->
1390 returnTE :: a -> TeM a
1391 returnTE result env = (env, result)
1393 -- these next two check whether the thing is already
1394 -- recorded, and THEN THEY RECORD IT
1395 -- (subsequent calls will return False for the same uniq/label)
1397 tempSeenTE :: Unique -> TeM Bool
1398 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1399 = if (uniq `elementOfUniqSet` seen_uniqs)
1401 else ((addOneToUniqSet seen_uniqs uniq,
1405 labelSeenTE :: CLabel -> TeM Bool
1406 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1407 = if (lbl `elementOfCLabelSet` seen_labels)
1410 addToCLabelSet seen_labels lbl),
1415 pprTempDecl :: Unique -> PrimRep -> SDoc
1416 pprTempDecl uniq kind
1417 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1419 pprExternDecl :: Bool -> CLabel -> SDoc
1420 pprExternDecl in_srt clabel
1421 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1423 hcat [ ppLocalnessMacro (not in_srt) clabel,
1424 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1427 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1433 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1435 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1437 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1438 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1439 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1440 returnTE (maybe_vcat [p1, p2])
1442 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1444 ppr_decls_AbsC (CAssign dest source)
1445 = ppr_decls_Amode dest `thenTE` \ p1 ->
1446 ppr_decls_Amode source `thenTE` \ p2 ->
1447 returnTE (maybe_vcat [p1, p2])
1449 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1451 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1453 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1455 ppr_decls_AbsC (CSwitch discrim alts deflt)
1456 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1457 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1458 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1459 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1461 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1463 ppr_decls_AbsC (CCodeBlock lbl absC)
1464 = ppr_decls_AbsC absC
1466 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre)
1467 -- ToDo: strictly speaking, should chk "cost_centre" amode
1468 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1473 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1475 info_lbl = infoTableLabelFromCI cl_info
1477 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1478 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1480 ppr_decls_AbsC (CCheck _ amodes code) =
1481 ppr_decls_Amodes amodes `thenTE` \p1 ->
1482 ppr_decls_AbsC code `thenTE` \p2 ->
1483 returnTE (maybe_vcat [p1,p2])
1485 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1487 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1488 -- you get some nasty re-decls of stdio.h if you compile
1489 -- the prelude while looking inside those amodes;
1490 -- no real reason to, anyway.
1491 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1493 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1494 -- ToDo: strictly speaking, should chk "cost_centre" amode
1495 = ppr_decls_Amodes amodes
1497 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1498 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1499 ppr_decls_AbsC slow `thenTE` \ p2 ->
1501 Nothing -> returnTE (Nothing, Nothing)
1502 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1503 returnTE (maybe_vcat [p1, p2, p3])
1505 entry_lbl = CLbl slow_lbl CodePtrRep
1506 slow_lbl = case (nonemptyAbsC slow) of
1507 Nothing -> mkErrorStdEntryLabel
1508 Just _ -> entryLabelFromCI cl_info
1510 ppr_decls_AbsC (CSRT lbl closure_lbls)
1511 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1513 if and seen then Nothing
1514 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1515 | (l,False) <- zip closure_lbls seen ]))
1517 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1518 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1519 ppr_decls_AbsC (CModuleInitBlock _ code) = ppr_decls_AbsC code
1521 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1525 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1526 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1527 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1528 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1529 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1530 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1531 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1532 ppr_decls_Amode (CLitLit _ _) = returnTE (Nothing, Nothing)
1534 -- CIntLike must be a literal -- no decls
1535 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1537 -- CCharLike may have be arbitrary value -- may have decls
1538 ppr_decls_Amode (CCharLike char)
1539 = ppr_decls_Amode char
1541 -- now, the only place where we actually print temps/externs...
1542 ppr_decls_Amode (CTemp uniq kind)
1544 VoidRep -> returnTE (Nothing, Nothing)
1546 tempSeenTE uniq `thenTE` \ temp_seen ->
1548 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1550 ppr_decls_Amode (CLbl lbl VoidRep)
1551 = returnTE (Nothing, Nothing)
1553 ppr_decls_Amode (CLbl lbl kind)
1554 = labelSeenTE lbl `thenTE` \ label_seen ->
1556 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1558 ppr_decls_Amode (CMacroExpr _ _ amodes)
1559 = ppr_decls_Amodes amodes
1561 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1564 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1566 = case (unzip ps) of { (ts, es) ->
1567 case (catMaybes ts) of { real_ts ->
1568 case (catMaybes es) of { real_es ->
1569 (if (null real_ts) then Nothing else Just (vcat real_ts),
1570 if (null real_es) then Nothing else Just (vcat real_es))
1575 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1576 ppr_decls_Amodes amodes
1577 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1578 returnTE ( maybe_vcat ps )
1581 Print out a C Label where you want the *address* of the label, not the
1582 object it refers to. The distinction is important when the label may
1583 refer to a C structure (info tables and closures, for instance).
1585 When just generating a declaration for the label, use pprCLabel.
1588 pprCLabelAddr :: CLabel -> SDoc
1589 pprCLabelAddr clabel =
1590 case labelType clabel of
1591 InfoTblType -> addr_of_label
1592 ClosureType -> addr_of_label
1593 VecTblType -> addr_of_label
1596 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1597 pp_label = pprCLabel clabel
1601 -----------------------------------------------------------------------------
1602 Initialising static objects with floating-point numbers. We can't
1603 just emit the floating point number, because C will cast it to an int
1604 by rounding it. We want the actual bit-representation of the float.
1606 This is a hack to turn the floating point numbers into ints that we
1607 can safely initialise to static locations.
1610 big_doubles = (getPrimRepSize DoubleRep) /= 1
1612 -- floatss are always 1 word
1613 floatToWord :: CAddrMode -> CAddrMode
1614 floatToWord (CLit (MachFloat r))
1616 arr <- newFloatArray ((0::Int),0)
1617 writeFloatArray arr 0 (fromRational r)
1618 i <- readIntArray arr 0
1619 return (CLit (MachInt (toInteger i)))
1622 doubleToWords :: CAddrMode -> [CAddrMode]
1623 doubleToWords (CLit (MachDouble r))
1624 | big_doubles -- doubles are 2 words
1626 arr <- newDoubleArray ((0::Int),1)
1627 writeDoubleArray arr 0 (fromRational r)
1628 i1 <- readIntArray arr 0
1629 i2 <- readIntArray arr 1
1630 return [ CLit (MachInt (toInteger i1))
1631 , CLit (MachInt (toInteger i2))
1634 | otherwise -- doubles are 1 word
1636 arr <- newDoubleArray ((0::Int),0)
1637 writeDoubleArray arr 0 (fromRational r)
1638 i <- readIntArray arr 0
1639 return [ CLit (MachInt (toInteger i)) ]