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)
803 in ASSERT2 ( all non_void nvas, pprCCallOp call <+> hsep (map pprAmode args) )
805 -- the last argument will be the "I/O world" token (a VoidRep)
806 -- all others should be non-void
809 let nvrs = grab_non_void_amodes results
810 in ASSERT (length nvrs <= 1) nvrs
811 -- there will usually be two results: a (void) state which we
812 -- should ignore and a (possibly void) result.
814 (local_arg_decls, pp_non_void_args)
815 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
817 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
820 case non_void_results of
821 [] -> ptext SLIT("void")
822 [amode] -> text (showPrimRep (getAmodeRep amode))
823 _ -> panic "pprCCall: ccall_res_ty"
826 ptext SLIT("_ccall_fun_ty") <>
828 DynamicTarget u -> ppr u
831 (declare_local_vars, local_vars, assign_results)
832 = ppr_casm_results non_void_results
834 (StaticTarget asm_str) = op_str
837 StaticTarget _ -> False
838 DynamicTarget _ -> True
840 casm_str = if is_asm then _UNPK_ asm_str else ccall_str
842 -- Remainder only used for ccall
845 | is_dynamic = parens (parens (ccall_fun_ty) <> text "%0")
846 | otherwise = ptext asm_str
850 if null non_void_results
853 lparen, fun_name, lparen,
854 hcat (punctuate comma ccall_fun_args),
859 | is_dynamic = tail ccall_args
860 | otherwise = ccall_args
862 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
866 If the argument is a heap object, we need to reach inside and pull out
867 the bit the C world wants to see. The only heap objects which can be
868 passed are @Array@s and @ByteArray@s.
871 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
872 -- (a) decl and assignment, (b) local var to be used later
874 ppr_casm_arg amode a_num
876 a_kind = getAmodeRep amode
877 pp_amode = pprAmode amode
878 pp_kind = pprPrimKind a_kind
880 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
882 (arg_type, pp_amode2)
885 -- for array arguments, pass a pointer to the body of the array
886 -- (PTRS_ARR_CTS skips over all the header nonsense)
887 ArrayRep -> (pp_kind,
888 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
889 ByteArrayRep -> (pp_kind,
890 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
892 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
893 ForeignObjRep -> (pp_kind,
894 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
895 char '(', pp_amode, char ')'])
897 other -> (pp_kind, pp_amode)
900 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
902 (declare_local_var, local_var)
905 For l-values, the critical questions are:
907 1) Are there any results at all?
909 We only allow zero or one results.
913 :: [CAddrMode] -- list of results (length <= 1)
915 ( SDoc, -- declaration of any local vars
916 [SDoc], -- list of result vars (same length as results)
917 SDoc ) -- assignment (if any) of results in local var to registers
920 = (empty, [], empty) -- no results
924 result_reg = ppr_amode r
925 r_kind = getAmodeRep r
927 local_var = ptext SLIT("_ccall_result")
929 (result_type, assign_result)
930 = (pprPrimKind r_kind,
931 hcat [ result_reg, equals, local_var, semi ])
933 declare_local_var = hcat [ result_type, space, local_var, semi ]
935 (declare_local_var, [local_var], assign_result)
938 = panic "ppr_casm_results: ccall/casm with many results"
942 Note the sneaky way _the_ result is represented by a list so that we
943 can complain if it's used twice.
945 ToDo: Any chance of giving line numbers when process-casm fails?
946 Or maybe we should do a check _much earlier_ in compiler. ADR
949 process_casm :: [SDoc] -- results (length <= 1)
950 -> [SDoc] -- arguments
951 -> String -- format string (with embedded %'s)
952 -> SDoc -- code being generated
954 process_casm results args string = process results args string
956 process [] _ "" = empty
957 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
959 "\"\n(Try changing result type to PrimIO ()\n")
961 process ress args ('%':cs)
964 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
967 char '%' <> process ress args css
971 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
972 [r] -> r <> (process [] args css)
973 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
977 read_int :: ReadS Int
980 case (read_int other) of
982 if 0 <= num && num < length args
983 then parens (args !! num) <> process ress args css
984 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
985 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
987 process ress args (other_c:cs)
988 = char other_c <> process ress args cs
991 %************************************************************************
993 \subsection[a2r-assignments]{Assignments}
995 %************************************************************************
997 Printing assignments is a little tricky because of type coercion.
999 First of all, the kind of the thing being assigned can be gotten from
1000 the destination addressing mode. (It should be the same as the kind
1001 of the source addressing mode.) If the kind of the assignment is of
1002 @VoidRep@, then don't generate any code at all.
1005 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
1007 pprAssign VoidRep dest src = empty
1010 Special treatment for floats and doubles, to avoid unwanted conversions.
1013 pprAssign FloatRep dest@(CVal reg_rel _) src
1014 = hcat [ ptext SLIT("ASSIGN_FLT"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1016 pprAssign DoubleRep dest@(CVal reg_rel _) src
1017 = hcat [ ptext SLIT("ASSIGN_DBL"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1019 pprAssign Int64Rep dest@(CVal reg_rel _) src
1020 = hcat [ ptext SLIT("ASSIGN_Int64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1021 pprAssign Word64Rep dest@(CVal reg_rel _) src
1022 = hcat [ ptext SLIT("ASSIGN_Word64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1025 Lastly, the question is: will the C compiler think the types of the
1026 two sides of the assignment match?
1028 We assume that the types will match if neither side is a
1029 @CVal@ addressing mode for any register which can point into
1032 Why? Because the heap and stack are used to store miscellaneous
1033 things, whereas the temporaries, registers, etc., are only used for
1034 things of fixed type.
1037 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1038 = hcat [ pprVanillaReg dest, equals,
1039 pprVanillaReg src, semi ]
1041 pprAssign kind dest src
1042 | mixedTypeLocn dest
1043 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1044 = hcat [ ppr_amode dest, equals,
1045 text "(W_)(", -- Here is the cast
1046 ppr_amode src, pp_paren_semi ]
1048 pprAssign kind dest src
1049 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1050 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1051 = hcat [ ppr_amode dest, equals,
1052 text "(P_)(", -- Here is the cast
1053 ppr_amode src, pp_paren_semi ]
1055 pprAssign ByteArrayRep dest src
1057 -- Add in a cast iff the source is mixed
1058 = hcat [ ppr_amode dest, equals,
1059 text "(StgByteArray)(", -- Here is the cast
1060 ppr_amode src, pp_paren_semi ]
1062 pprAssign kind other_dest src
1063 = hcat [ ppr_amode other_dest, equals,
1064 pprAmode src, semi ]
1068 %************************************************************************
1070 \subsection[a2r-CAddrModes]{Addressing modes}
1072 %************************************************************************
1074 @pprAmode@ is used to print r-values (which may need casts), whereas
1075 @ppr_amode@ is used for l-values {\em and} as a help function for
1079 pprAmode, ppr_amode :: CAddrMode -> SDoc
1082 For reasons discussed above under assignments, @CVal@ modes need
1083 to be treated carefully. First come special cases for floats and doubles,
1084 similar to those in @pprAssign@:
1086 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1090 pprAmode (CVal reg_rel FloatRep)
1091 = hcat [ text "PK_FLT(", ppr_amode (CAddr reg_rel), rparen ]
1092 pprAmode (CVal reg_rel DoubleRep)
1093 = hcat [ text "PK_DBL(", ppr_amode (CAddr reg_rel), rparen ]
1094 pprAmode (CVal reg_rel Int64Rep)
1095 = hcat [ text "PK_Int64(", ppr_amode (CAddr reg_rel), rparen ]
1096 pprAmode (CVal reg_rel Word64Rep)
1097 = hcat [ text "PK_Word64(", ppr_amode (CAddr reg_rel), rparen ]
1100 Next comes the case where there is some other cast need, and the
1105 | mixedTypeLocn amode
1106 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1108 | otherwise -- No cast needed
1112 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1115 ppr_amode (CVal reg_rel _)
1116 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1117 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1118 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1120 ppr_amode (CAddr reg_rel)
1121 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1122 (pp_reg, Nothing) -> pp_reg
1123 (pp_reg, Just offset) -> (<>) pp_reg offset
1125 ppr_amode (CReg magic_id) = pprMagicId magic_id
1127 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1129 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1131 ppr_amode (CCharLike ch)
1132 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1133 ppr_amode (CIntLike int)
1134 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1136 ppr_amode (CLit lit) = pprBasicLit lit
1138 ppr_amode (CLitLit str _) = ptext str
1140 ppr_amode (CJoinPoint _)
1141 = panic "ppr_amode: CJoinPoint"
1143 ppr_amode (CMacroExpr pk macro as)
1144 = parens (pprPrimKind pk) <>
1145 parens (ptext (cExprMacroText macro) <>
1146 parens (hcat (punctuate comma (map pprAmode as))))
1150 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1151 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1152 cExprMacroText GET_TAG = SLIT("GET_TAG")
1153 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1155 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1156 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1157 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1158 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1159 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1160 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1161 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1162 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1163 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1164 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1165 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1166 cStmtMacroText GRAN_FETCH = SLIT("GRAN_FETCH")
1167 cStmtMacroText GRAN_RESCHEDULE = SLIT("GRAN_RESCHEDULE")
1168 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1169 cStmtMacroText THREAD_CONTEXT_SWITCH = SLIT("THREAD_CONTEXT_SWITCH")
1170 cStmtMacroText GRAN_YIELD = SLIT("GRAN_YIELD")
1172 cCheckMacroText HP_CHK_NP = SLIT("HP_CHK_NP")
1173 cCheckMacroText STK_CHK_NP = SLIT("STK_CHK_NP")
1174 cCheckMacroText HP_STK_CHK_NP = SLIT("HP_STK_CHK_NP")
1175 cCheckMacroText HP_CHK_SEQ_NP = SLIT("HP_CHK_SEQ_NP")
1176 cCheckMacroText HP_CHK = SLIT("HP_CHK")
1177 cCheckMacroText STK_CHK = SLIT("STK_CHK")
1178 cCheckMacroText HP_STK_CHK = SLIT("HP_STK_CHK")
1179 cCheckMacroText HP_CHK_NOREGS = SLIT("HP_CHK_NOREGS")
1180 cCheckMacroText HP_CHK_UNPT_R1 = SLIT("HP_CHK_UNPT_R1")
1181 cCheckMacroText HP_CHK_UNBX_R1 = SLIT("HP_CHK_UNBX_R1")
1182 cCheckMacroText HP_CHK_F1 = SLIT("HP_CHK_F1")
1183 cCheckMacroText HP_CHK_D1 = SLIT("HP_CHK_D1")
1184 cCheckMacroText HP_CHK_L1 = SLIT("HP_CHK_L1")
1185 cCheckMacroText HP_CHK_UT_ALT = SLIT("HP_CHK_UT_ALT")
1186 cCheckMacroText HP_CHK_GEN = SLIT("HP_CHK_GEN")
1189 %************************************************************************
1191 \subsection[ppr-liveness-masks]{Liveness Masks}
1193 %************************************************************************
1196 pp_liveness :: Liveness -> SDoc
1199 LvLarge lbl -> char '&' <> pprCLabel lbl
1200 LvSmall mask -- Avoid gcc bug when printing minInt
1201 | bitmap_int == minInt -> int (bitmap_int+1) <> text "-1"
1202 | otherwise -> int bitmap_int
1204 bitmap_int = intBS mask
1207 %************************************************************************
1209 \subsection[a2r-MagicIds]{Magic ids}
1211 %************************************************************************
1213 @pprRegRelative@ returns a pair of the @Doc@ for the register
1214 (some casting may be required), and a @Maybe Doc@ for the offset
1215 (zero offset gives a @Nothing@).
1218 addPlusSign :: Bool -> SDoc -> SDoc
1219 addPlusSign False p = p
1220 addPlusSign True p = (<>) (char '+') p
1222 pprSignedInt :: Bool -> Int -> Maybe SDoc -- Nothing => 0
1223 pprSignedInt sign_wanted n
1224 = if n == 0 then Nothing else
1225 if n > 0 then Just (addPlusSign sign_wanted (int n))
1228 pprRegRelative :: Bool -- True <=> Print leading plus sign (if +ve)
1230 -> (SDoc, Maybe SDoc)
1232 pprRegRelative sign_wanted (SpRel off)
1233 = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1235 pprRegRelative sign_wanted r@(HpRel o)
1236 = let pp_Hp = pprMagicId Hp; off = I# o
1241 (pp_Hp, Just ((<>) (char '-') (int off)))
1243 pprRegRelative sign_wanted (NodeRel o)
1244 = let pp_Node = pprMagicId node; off = I# o
1249 (pp_Node, Just (addPlusSign sign_wanted (int off)))
1251 pprRegRelative sign_wanted (CIndex base offset kind)
1252 = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1253 , Just (hcat [if sign_wanted then char '+' else empty,
1254 text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1258 @pprMagicId@ just prints the register name. @VanillaReg@ registers are
1259 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1260 to select the union tag.
1263 pprMagicId :: MagicId -> SDoc
1265 pprMagicId BaseReg = ptext SLIT("BaseReg")
1266 pprMagicId (VanillaReg pk n)
1267 = hcat [ pprVanillaReg n, char '.',
1269 pprMagicId (FloatReg n) = (<>) (ptext SLIT("F")) (int IBOX(n))
1270 pprMagicId (DoubleReg n) = (<>) (ptext SLIT("D")) (int IBOX(n))
1271 pprMagicId (LongReg _ n) = (<>) (ptext SLIT("L")) (int IBOX(n))
1272 pprMagicId Sp = ptext SLIT("Sp")
1273 pprMagicId Su = ptext SLIT("Su")
1274 pprMagicId SpLim = ptext SLIT("SpLim")
1275 pprMagicId Hp = ptext SLIT("Hp")
1276 pprMagicId HpLim = ptext SLIT("HpLim")
1277 pprMagicId CurCostCentre = ptext SLIT("CCCS")
1278 pprMagicId VoidReg = panic "pprMagicId:VoidReg!"
1280 pprVanillaReg :: FAST_INT -> SDoc
1281 pprVanillaReg n = (<>) (char 'R') (int IBOX(n))
1283 pprUnionTag :: PrimRep -> SDoc
1285 pprUnionTag PtrRep = char 'p'
1286 pprUnionTag CodePtrRep = ptext SLIT("fp")
1287 pprUnionTag DataPtrRep = char 'd'
1288 pprUnionTag RetRep = char 'p'
1289 pprUnionTag CostCentreRep = panic "pprUnionTag:CostCentre?"
1291 pprUnionTag CharRep = char 'c'
1292 pprUnionTag IntRep = char 'i'
1293 pprUnionTag WordRep = char 'w'
1294 pprUnionTag AddrRep = char 'a'
1295 pprUnionTag FloatRep = char 'f'
1296 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1298 pprUnionTag StablePtrRep = char 'i'
1299 pprUnionTag StableNameRep = char 'p'
1300 pprUnionTag WeakPtrRep = char 'p'
1301 pprUnionTag ForeignObjRep = char 'p'
1303 pprUnionTag ThreadIdRep = char 't'
1305 pprUnionTag ArrayRep = char 'p'
1306 pprUnionTag ByteArrayRep = char 'b'
1308 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1312 Find and print local and external declarations for a list of
1313 Abstract~C statements.
1315 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1316 pprTempAndExternDecls AbsCNop = (empty, empty)
1318 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1319 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1320 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1321 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1322 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1323 returnTE (vcat real_temps, vcat real_exts) }}
1326 pprTempAndExternDecls other_stmt
1327 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1338 pprBasicLit :: Literal -> SDoc
1339 pprPrimKind :: PrimRep -> SDoc
1341 pprBasicLit lit = ppr lit
1342 pprPrimKind k = ppr k
1346 %************************************************************************
1348 \subsection[a2r-monad]{Monadery}
1350 %************************************************************************
1352 We need some monadery to keep track of temps and externs we have already
1353 printed. This info must be threaded right through the Abstract~C, so
1354 it's most convenient to hide it in this monad.
1356 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1357 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1360 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1361 emptyCLabelSet = emptyFM
1362 x `elementOfCLabelSet` labs
1363 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1365 addToCLabelSet set x = addToFM set x ()
1367 type TEenv = (UniqSet Unique, CLabelSet)
1369 type TeM result = TEenv -> (TEenv, result)
1371 initTE :: TeM a -> a
1373 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1376 {-# INLINE thenTE #-}
1377 {-# INLINE returnTE #-}
1379 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1381 = case a u of { (u_1, result_of_a) ->
1384 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1385 mapTE f [] = returnTE []
1387 = f x `thenTE` \ r ->
1388 mapTE f xs `thenTE` \ rs ->
1391 returnTE :: a -> TeM a
1392 returnTE result env = (env, result)
1394 -- these next two check whether the thing is already
1395 -- recorded, and THEN THEY RECORD IT
1396 -- (subsequent calls will return False for the same uniq/label)
1398 tempSeenTE :: Unique -> TeM Bool
1399 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1400 = if (uniq `elementOfUniqSet` seen_uniqs)
1402 else ((addOneToUniqSet seen_uniqs uniq,
1406 labelSeenTE :: CLabel -> TeM Bool
1407 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1408 = if (lbl `elementOfCLabelSet` seen_labels)
1411 addToCLabelSet seen_labels lbl),
1416 pprTempDecl :: Unique -> PrimRep -> SDoc
1417 pprTempDecl uniq kind
1418 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1420 pprExternDecl :: Bool -> CLabel -> SDoc
1421 pprExternDecl in_srt clabel
1422 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1424 hcat [ ppLocalnessMacro (not in_srt) clabel,
1425 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1428 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1434 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1436 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1438 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1439 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1440 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1441 returnTE (maybe_vcat [p1, p2])
1443 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1445 ppr_decls_AbsC (CAssign dest source)
1446 = ppr_decls_Amode dest `thenTE` \ p1 ->
1447 ppr_decls_Amode source `thenTE` \ p2 ->
1448 returnTE (maybe_vcat [p1, p2])
1450 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1452 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1454 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1456 ppr_decls_AbsC (CSwitch discrim alts deflt)
1457 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1458 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1459 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1460 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1462 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1464 ppr_decls_AbsC (CCodeBlock lbl absC)
1465 = ppr_decls_AbsC absC
1467 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre)
1468 -- ToDo: strictly speaking, should chk "cost_centre" amode
1469 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1474 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1476 info_lbl = infoTableLabelFromCI cl_info
1478 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1479 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1481 ppr_decls_AbsC (CCheck _ amodes code) =
1482 ppr_decls_Amodes amodes `thenTE` \p1 ->
1483 ppr_decls_AbsC code `thenTE` \p2 ->
1484 returnTE (maybe_vcat [p1,p2])
1486 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1488 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1489 -- you get some nasty re-decls of stdio.h if you compile
1490 -- the prelude while looking inside those amodes;
1491 -- no real reason to, anyway.
1492 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1494 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1495 -- ToDo: strictly speaking, should chk "cost_centre" amode
1496 = ppr_decls_Amodes amodes
1498 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1499 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1500 ppr_decls_AbsC slow `thenTE` \ p2 ->
1502 Nothing -> returnTE (Nothing, Nothing)
1503 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1504 returnTE (maybe_vcat [p1, p2, p3])
1506 entry_lbl = CLbl slow_lbl CodePtrRep
1507 slow_lbl = case (nonemptyAbsC slow) of
1508 Nothing -> mkErrorStdEntryLabel
1509 Just _ -> entryLabelFromCI cl_info
1511 ppr_decls_AbsC (CSRT lbl closure_lbls)
1512 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1514 if and seen then Nothing
1515 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1516 | (l,False) <- zip closure_lbls seen ]))
1518 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1519 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1520 ppr_decls_AbsC (CModuleInitBlock _ code) = ppr_decls_AbsC code
1522 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1526 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1527 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1528 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1529 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1530 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1531 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1532 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1533 ppr_decls_Amode (CLitLit _ _) = returnTE (Nothing, Nothing)
1535 -- CIntLike must be a literal -- no decls
1536 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1538 -- CCharLike may have be arbitrary value -- may have decls
1539 ppr_decls_Amode (CCharLike char)
1540 = ppr_decls_Amode char
1542 -- now, the only place where we actually print temps/externs...
1543 ppr_decls_Amode (CTemp uniq kind)
1545 VoidRep -> returnTE (Nothing, Nothing)
1547 tempSeenTE uniq `thenTE` \ temp_seen ->
1549 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1551 ppr_decls_Amode (CLbl lbl VoidRep)
1552 = returnTE (Nothing, Nothing)
1554 ppr_decls_Amode (CLbl lbl kind)
1555 = labelSeenTE lbl `thenTE` \ label_seen ->
1557 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1559 ppr_decls_Amode (CMacroExpr _ _ amodes)
1560 = ppr_decls_Amodes amodes
1562 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1565 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1567 = case (unzip ps) of { (ts, es) ->
1568 case (catMaybes ts) of { real_ts ->
1569 case (catMaybes es) of { real_es ->
1570 (if (null real_ts) then Nothing else Just (vcat real_ts),
1571 if (null real_es) then Nothing else Just (vcat real_es))
1576 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1577 ppr_decls_Amodes amodes
1578 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1579 returnTE ( maybe_vcat ps )
1582 Print out a C Label where you want the *address* of the label, not the
1583 object it refers to. The distinction is important when the label may
1584 refer to a C structure (info tables and closures, for instance).
1586 When just generating a declaration for the label, use pprCLabel.
1589 pprCLabelAddr :: CLabel -> SDoc
1590 pprCLabelAddr clabel =
1591 case labelType clabel of
1592 InfoTblType -> addr_of_label
1593 ClosureType -> addr_of_label
1594 VecTblType -> addr_of_label
1597 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1598 pp_label = pprCLabel clabel
1602 -----------------------------------------------------------------------------
1603 Initialising static objects with floating-point numbers. We can't
1604 just emit the floating point number, because C will cast it to an int
1605 by rounding it. We want the actual bit-representation of the float.
1607 This is a hack to turn the floating point numbers into ints that we
1608 can safely initialise to static locations.
1611 big_doubles = (getPrimRepSize DoubleRep) /= 1
1613 -- floatss are always 1 word
1614 floatToWord :: CAddrMode -> CAddrMode
1615 floatToWord (CLit (MachFloat r))
1617 arr <- newFloatArray ((0::Int),0)
1618 writeFloatArray arr 0 (fromRational r)
1619 i <- readIntArray arr 0
1620 return (CLit (MachInt (toInteger i)))
1623 doubleToWords :: CAddrMode -> [CAddrMode]
1624 doubleToWords (CLit (MachDouble r))
1625 | big_doubles -- doubles are 2 words
1627 arr <- newDoubleArray ((0::Int),1)
1628 writeDoubleArray arr 0 (fromRational r)
1629 i1 <- readIntArray arr 0
1630 i2 <- readIntArray arr 1
1631 return [ CLit (MachInt (toInteger i1))
1632 , CLit (MachInt (toInteger i2))
1635 | otherwise -- doubles are 1 word
1637 arr <- newDoubleArray ((0::Int),0)
1638 writeDoubleArray arr 0 (fromRational r)
1639 i <- readIntArray arr 0
1640 return [ CLit (MachInt (toInteger i)) ]