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 )
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, PrimOp(..), CCall(..), CCallTarget(..) )
49 import PrimRep ( isFloatingRep, PrimRep(..), getPrimRepSize, showPrimRep )
50 import SMRep ( pprSMRep )
51 import Unique ( pprUnique, Unique{-instance NamedThing-} )
52 import UniqSet ( emptyUniqSet, elementOfUniqSet,
53 addOneToUniqSet, UniqSet
55 import StgSyn ( SRT(..) )
56 import BitSet ( intBS )
58 import Util ( nOfThem )
67 For spitting out the costs of an abstract~C expression, @writeRealC@
68 now not only prints the C~code of the @absC@ arg but also adds a macro
69 call to a cost evaluation function @GRAN_EXEC@. For that,
70 @pprAbsC@ has a new ``costs'' argument. %% HWL
74 writeRealC :: Handle -> AbstractC -> IO ()
75 writeRealC handle absC
76 -- avoid holding on to the whole of absC in the !Gransim case.
78 then printForCFast fp (pprAbsC absC (costs absC))
79 else printForCFast fp (pprAbsC absC (panic "costs"))
80 --printForC handle (pprAbsC absC (panic "costs"))
81 dumpRealC :: AbstractC -> SDoc
82 dumpRealC absC = pprAbsC absC (costs absC)
85 writeRealC :: Handle -> AbstractC -> IO ()
86 --writeRealC handle absC =
88 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
90 writeRealC handle absC
91 | opt_GranMacros = _scc_ "writeRealC" printForC handle $
92 pprCode CStyle (pprAbsC absC (costs absC))
93 | otherwise = _scc_ "writeRealC" printForC handle $
94 pprCode CStyle (pprAbsC absC (panic "costs"))
96 dumpRealC :: AbstractC -> SDoc
98 | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
99 | otherwise = pprCode CStyle (pprAbsC absC (panic "costs"))
103 This emits the macro, which is used in GrAnSim to compute the total costs
104 from a cost 5 tuple. %% HWL
107 emitMacro :: CostRes -> SDoc
109 emitMacro _ | not opt_GranMacros = empty
111 emitMacro (Cost (i,b,l,s,f))
112 = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
113 int i, comma, int b, comma, int l, comma,
114 int s, comma, int f, pp_paren_semi ]
116 pp_paren_semi = text ");"
119 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
120 code as an argument (that's needed when spitting out the GRAN_EXEC macro
121 which must be done before the return i.e. inside absC code) HWL
124 pprAbsC :: AbstractC -> CostRes -> SDoc
125 pprAbsC AbsCNop _ = empty
126 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
128 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
130 pprAbsC (CJump target) c
131 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CJump */"-} ])
132 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
134 pprAbsC (CFallThrough target) c
135 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CFallThrough */"-} ])
136 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
138 -- --------------------------------------------------------------------------
139 -- Spit out GRAN_EXEC macro immediately before the return HWL
141 pprAbsC (CReturn am return_info) c
142 = ($$) (hcat [emitMacro c {-WDP:, text "/* <---- CReturn */"-} ])
143 (hcat [text jmp_lit, target, pp_paren_semi ])
145 target = case return_info of
146 DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
148 DynamicVectoredReturn am' -> mk_vector (pprAmode am')
149 StaticVectoredReturn n -> mk_vector (int n) -- Always positive
150 mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
153 pprAbsC (CSplitMarker) _ = ptext SLIT("/* SPLIT */")
155 -- we optimise various degenerate cases of CSwitches.
157 -- --------------------------------------------------------------------------
158 -- Assume: CSwitch is also end of basic block
159 -- costs function yields nullCosts for whole switch
160 -- ==> inherited costs c are those of basic block up to switch
161 -- ==> inherit c + costs for the corresponding branch
163 -- --------------------------------------------------------------------------
165 pprAbsC (CSwitch discrim [] deflt) c
166 = pprAbsC deflt (c + costs deflt)
167 -- Empty alternative list => no costs for discrim as nothing cond. here HWL
169 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
170 = case (nonemptyAbsC deflt) of
171 Nothing -> -- one alt and no default
172 pprAbsC alt_code (c + costs alt_code)
173 -- Nothing conditional in here either HWL
175 Just dc -> -- make it an "if"
176 do_if_stmt discrim tag alt_code dc c
178 -- What problem is the re-ordering trying to solve ?
179 pprAbsC (CSwitch discrim [(tag1@(MachInt i1), alt_code1),
180 (tag2@(MachInt i2), alt_code2)] deflt) c
181 | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
183 do_if_stmt discrim tag1 alt_code1 alt_code2 c
185 do_if_stmt discrim tag2 alt_code2 alt_code1 c
187 empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
189 pprAbsC (CSwitch discrim alts deflt) c -- general case
190 | isFloatingRep (getAmodeRep discrim)
191 = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
194 hcat [text "switch (", pp_discrim, text ") {"],
195 nest 2 (vcat (map ppr_alt alts)),
196 (case (nonemptyAbsC deflt) of
199 nest 2 (vcat [ptext SLIT("default:"),
200 pprAbsC dc (c + switch_head_cost
202 ptext SLIT("break;")])),
209 = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
210 nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
211 (ptext SLIT("break;"))) ]
213 -- Costs for addressing header of switch and cond. branching -- HWL
214 switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
216 pprAbsC stmt@(COpStmt results (CCallOp ccall) args vol_regs) _
217 = pprCCall ccall args results vol_regs
219 pprAbsC stmt@(COpStmt results op args vol_regs) _
221 non_void_args = grab_non_void_amodes args
222 non_void_results = grab_non_void_amodes results
223 -- if just one result, we print in the obvious "assignment" style;
224 -- if 0 or many results, we emit a macro call, w/ the results
225 -- followed by the arguments. The macro presumably knows which
228 the_op = ppr_op_call non_void_results non_void_args
229 -- liveness mask is *in* the non_void_args
231 if primOpNeedsWrapper op then
232 case (ppr_vol_regs vol_regs) of { (pp_saves, pp_restores) ->
241 ppr_op_call results args
242 = hcat [ pprPrimOp op, lparen,
243 hcat (punctuate comma (map ppr_op_result results)),
244 if null results || null args then empty else comma,
245 hcat (punctuate comma (map pprAmode args)),
248 ppr_op_result r = ppr_amode r
249 -- primop macros do their own casting of result;
250 -- hence we can toss the provided cast...
252 pprAbsC stmt@(CSRT lbl closures) c
253 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
255 $$ ptext SLIT("SRT") <> lparen <> pprCLabel lbl <> rparen
256 $$ nest 2 (hcat (punctuate comma (map pp_closure_lbl closures)))
260 pprAbsC stmt@(CBitmap lbl mask) c
262 hcat [ ptext SLIT("BITMAP"), lparen,
263 pprCLabel lbl, comma,
266 hcat (punctuate comma (map (int.intBS) mask)),
270 pprAbsC (CSimultaneous abs_c) c
271 = hcat [ptext SLIT("{{"), pprAbsC abs_c c, ptext SLIT("}}")]
273 pprAbsC (CCheck macro as code) c
274 = hcat [ptext (cCheckMacroText macro), lparen,
275 hcat (punctuate comma (map ppr_amode as)), comma,
276 pprAbsC code c, pp_paren_semi
278 pprAbsC (CMacroStmt macro as) _
279 = hcat [ptext (cStmtMacroText macro), lparen,
280 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi] -- no casting
281 pprAbsC (CCallProfCtrMacro op as) _
282 = hcat [ptext op, lparen,
283 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
284 pprAbsC (CCallProfCCMacro op as) _
285 = hcat [ptext op, lparen,
286 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
287 pprAbsC stmt@(CCallTypedef is_tdef (CCall op_str is_asm may_gc cconv) results args) _
288 = hsep [ ptext (if is_tdef then SLIT("typedef") else SLIT("extern"))
291 , parens (hsep (punctuate comma ccall_decl_ty_args))
295 In the non-casm case, to ensure that we're entering the given external
296 entry point using the correct calling convention, we have to do the following:
298 - When entering via a function pointer (the `dynamic' case) using the specified
299 calling convention, we emit a typedefn declaration attributed with the
300 calling convention to use together with the result and parameter types we're
301 assuming. Coerce the function pointer to this type and go.
303 - to enter the function at a given code label, we emit an extern declaration
304 for the label here, stating the calling convention together with result and
305 argument types we're assuming.
307 The C compiler will hopefully use this extern declaration to good effect,
308 reporting any discrepancies between our extern decl and any other that
311 Re: calling convention, notice that gcc (2.8.1 and egcs-1.0.2) will for
312 the external function `foo' use the calling convention of the first `foo'
313 prototype it encounters (nor does it complain about conflicting attribute
314 declarations). The consequence of this is that you cannot override the
315 calling convention of `foo' using an extern declaration (you'd have to use
316 a typedef), but why you would want to do such a thing in the first place
317 is totally beyond me.
319 ToDo: petition the gcc folks to add code to warn about conflicting attribute
325 | is_tdef = parens (text (callConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
326 | otherwise = text (callConvAttribute cconv) <+> ccall_fun_ty
330 DynamicTarget u -> ptext SLIT("_ccall_fun_ty") <> ppr u
331 StaticTarget x -> ptext x
334 case non_void_results of
335 [] -> ptext SLIT("void")
336 [amode] -> text (showPrimRep (getAmodeRep amode))
337 _ -> panic "pprAbsC{CCallTypedef}: ccall_res_ty"
340 | is_tdef = tail ccall_arg_tys
341 | otherwise = ccall_arg_tys
343 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
345 -- the first argument will be the "I/O world" token (a VoidRep)
346 -- all others should be non-void
349 in ASSERT (all non_void nvas) nvas
351 -- there will usually be two results: a (void) state which we
352 -- should ignore and a (possibly void) result.
354 let nvrs = grab_non_void_amodes results
355 in ASSERT (length nvrs <= 1) nvrs
357 pprAbsC (CCodeBlock lbl abs_C) _
358 = if not (maybeToBool(nonemptyAbsC abs_C)) then
359 pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
361 case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
364 hcat [text (if (externallyVisibleCLabel lbl)
365 then "FN_(" -- abbreviations to save on output
367 pprCLabel lbl, text ") {"],
371 nest 8 (ptext SLIT("FB_")),
372 nest 8 (pprAbsC abs_C (costs abs_C)),
373 nest 8 (ptext SLIT("FE_")),
379 pprAbsC (CInitHdr cl_info amode cost_centre) _
380 = hcat [ ptext SLIT("SET_HDR_"), char '(',
381 ppr_amode amode, comma,
382 pprCLabelAddr info_lbl, comma,
383 if_profiling (pprAmode cost_centre),
386 info_lbl = infoTableLabelFromCI cl_info
388 pprAbsC stmt@(CStaticClosure closure_lbl cl_info cost_centre amodes) _
389 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
393 ptext SLIT("SET_STATIC_HDR"), char '(',
394 pprCLabel closure_lbl, comma,
395 pprCLabel info_lbl, comma,
396 if_profiling (pprAmode cost_centre), comma,
397 ppLocalness closure_lbl, comma,
398 ppLocalnessMacro True{-include dyn-} info_lbl,
401 nest 2 (ppr_payload (amodes ++ padding_wds ++ static_link_field)),
405 info_lbl = infoTableLabelFromCI cl_info
407 ppr_payload [] = empty
408 ppr_payload ls = comma <+>
409 braces (hsep (punctuate comma (map ((text "(L_)" <>).ppr_item) ls)))
412 | rep == VoidRep = text "0" -- might not even need this...
413 | rep == FloatRep = ppr_amode (floatToWord item)
414 | rep == DoubleRep = hcat (punctuate (text ", (L_)")
415 (map ppr_amode (doubleToWords item)))
416 | otherwise = ppr_amode item
418 rep = getAmodeRep item
421 if not (closureUpdReqd cl_info) then
424 case max 0 (mIN_UPD_SIZE - length amodes) of { still_needed ->
425 nOfThem still_needed (mkIntCLit 0) } -- a bunch of 0s
428 | staticClosureNeedsLink cl_info = [mkIntCLit 0]
431 pprAbsC stmt@(CClosureInfoAndCode cl_info slow maybe_fast cl_descr) _
434 ptext SLIT("INFO_TABLE"),
435 ( if is_selector then
436 ptext SLIT("_SELECTOR")
437 else if is_constr then
438 ptext SLIT("_CONSTR")
439 else if needs_srt then
441 else empty ), char '(',
443 pprCLabel info_lbl, comma,
444 pprCLabel slow_lbl, comma,
445 pp_rest, {- ptrs,nptrs,[srt,]type,-} comma,
447 ppLocalness info_lbl, comma,
448 ppLocalnessMacro True{-include dyn-} slow_lbl, comma,
450 if_profiling pp_descr, comma,
451 if_profiling pp_type,
457 Just fast -> let stuff = CCodeBlock fast_lbl fast in
458 pprAbsC stuff (costs stuff)
461 info_lbl = infoTableLabelFromCI cl_info
462 fast_lbl = fastLabelFromCI cl_info
465 = case (nonemptyAbsC slow) of
466 Nothing -> (mkErrorStdEntryLabel, empty)
467 Just xx -> (entryLabelFromCI cl_info,
468 let stuff = CCodeBlock slow_lbl xx in
469 pprAbsC stuff (costs stuff))
471 maybe_selector = maybeSelectorInfo cl_info
472 is_selector = maybeToBool maybe_selector
473 (Just select_word_i) = maybe_selector
475 maybe_tag = closureSemiTag cl_info
476 is_constr = maybeToBool maybe_tag
477 (Just tag) = maybe_tag
479 needs_srt = infoTblNeedsSRT cl_info
480 srt = getSRTInfo cl_info
482 size = closureNonHdrSize cl_info
484 ptrs = closurePtrsSize cl_info
487 pp_rest | is_selector = int select_word_i
492 hcat [ int tag, comma ]
493 else if needs_srt then
498 type_str = pprSMRep (closureSMRep cl_info)
500 pp_descr = hcat [char '"', text (stringToC cl_descr), char '"']
501 pp_type = hcat [char '"', text (stringToC (closureTypeDescr cl_info)), char '"']
503 pprAbsC stmt@(CClosureTbl tycon) _
505 ptext SLIT("CLOSURE_TBL") <>
506 lparen <> pprCLabel (mkClosureTblLabel tycon) <> rparen :
508 map (pp_closure_lbl . mkClosureLabel . getName . dataConWrapId) (tyConDataCons tycon)
510 ) $$ ptext SLIT("};")
512 pprAbsC stmt@(CRetDirect uniq code srt liveness) _
515 ptext SLIT("INFO_TABLE_SRT_BITMAP"), lparen,
516 pprCLabel info_lbl, comma,
517 pprCLabel entry_lbl, comma,
518 pp_liveness liveness, comma, -- bitmap
519 pp_srt_info srt, -- SRT
520 ptext type_str, comma, -- closure type
521 ppLocalness info_lbl, comma, -- info table storage class
522 ppLocalnessMacro True{-include dyn-} entry_lbl, comma, -- entry pt storage class
529 info_lbl = mkReturnInfoLabel uniq
530 entry_lbl = mkReturnPtLabel uniq
532 pp_code = let stuff = CCodeBlock entry_lbl code in
533 pprAbsC stuff (costs stuff)
535 type_str = case liveness of
536 LvSmall _ -> SLIT("RET_SMALL")
537 LvLarge _ -> SLIT("RET_BIG")
539 pprAbsC stmt@(CRetVector lbl amodes srt liveness) _
540 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
544 ptext SLIT("VEC_INFO_") <> int size,
546 pprCLabel lbl, comma,
547 pp_liveness liveness, comma, -- bitmap liveness mask
548 pp_srt_info srt, -- SRT
549 ptext type_str, comma,
550 ppLocalness lbl, comma
552 nest 2 (sep (punctuate comma (map ppr_item amodes))),
558 ppr_item item = (<>) (text "(F_) ") (ppr_amode item)
561 type_str = case liveness of
562 LvSmall _ -> SLIT("RET_VEC_SMALL")
563 LvLarge _ -> SLIT("RET_VEC_BIG")
566 pprAbsC stmt@(CModuleInitBlock lbl code) _
568 ptext SLIT("START_MOD_INIT") <> parens (pprCLabel lbl),
569 case (pprTempAndExternDecls stmt) of { (_, pp_exts) -> pp_exts },
570 pprAbsC code (costs code),
571 hcat [ptext SLIT("END_MOD_INIT"), lparen, rparen]
574 pprAbsC (CCostCentreDecl is_local cc) _ = pprCostCentreDecl is_local cc
575 pprAbsC (CCostCentreStackDecl ccs) _ = pprCostCentreStackDecl ccs
580 = if (externallyVisibleCLabel lbl)
582 else ptext SLIT("static ")
584 -- Horrible macros for declaring the types and locality of labels (see
587 ppLocalnessMacro include_dyn_prefix clabel =
592 ClosureType -> ptext SLIT("C_")
593 CodeType -> ptext SLIT("F_")
594 InfoTblType -> ptext SLIT("I_")
595 ClosureTblType -> ptext SLIT("CP_")
596 DataType -> ptext SLIT("D_")
599 is_visible = externallyVisibleCLabel clabel
600 label_type = labelType clabel
601 is_dynamic = labelDynamic clabel
604 | is_visible = char 'E'
605 | otherwise = char 'I'
608 | not include_dyn_prefix = empty
609 | is_dynamic = char 'D'
617 grab_non_void_amodes amodes
618 = filter non_void amodes
621 = case (getAmodeRep amode) of
627 ppr_vol_regs :: [MagicId] -> (SDoc, SDoc)
629 ppr_vol_regs [] = (empty, empty)
630 ppr_vol_regs (VoidReg:rs) = ppr_vol_regs rs
632 = let pp_reg = case r of
633 VanillaReg pk n -> pprVanillaReg n
635 (more_saves, more_restores) = ppr_vol_regs rs
637 (($$) ((<>) (ptext SLIT("CALLER_SAVE_")) pp_reg) more_saves,
638 ($$) ((<>) (ptext SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
640 -- pp_basic_{saves,restores}: The BaseReg, Sp, Su, Hp and
641 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
642 -- depending on the platform. (The "volatile regs" stuff handles all
643 -- other registers.) Just be *sure* BaseReg is OK before trying to do
644 -- anything else. The correct sequence of saves&restores are
645 -- encoded by the CALLER_*_SYSTEM macros.
646 pp_basic_saves = ptext SLIT("CALLER_SAVE_SYSTEM")
647 pp_basic_restores = ptext SLIT("CALLER_RESTORE_SYSTEM")
651 has_srt (_, NoSRT) = False
660 (lbl, SRT off len) ->
661 hcat [ pprCLabel lbl, comma,
668 | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
669 | otherwise = char '&' <> pprCLabel lbl
674 = if opt_SccProfilingOn
676 else char '0' -- leave it out!
677 -- ---------------------------------------------------------------------------
678 -- Changes for GrAnSim:
679 -- draw costs for computation in head of if into both branches;
680 -- as no abstractC data structure is given for the head, one is constructed
681 -- guessing unknown values and fed into the costs function
682 -- ---------------------------------------------------------------------------
684 do_if_stmt discrim tag alt_code deflt c
686 -- This special case happens when testing the result of a comparison.
687 -- We can just avoid some redundant clutter in the output.
688 MachInt n | n==0 -> ppr_if_stmt (pprAmode discrim)
690 (addrModeCosts discrim Rhs) c
692 cond = hcat [ pprAmode discrim
695 , pprAmode (CLit tag)
697 -- to be absolutely sure that none of the
698 -- conversion rules hit, e.g.,
700 -- minInt is different to (int)minInt
702 -- in C (when minInt is a number not a constant
703 -- expression which evaluates to it.)
705 tcast = case other of
706 MachInt _ -> ptext SLIT("(I_)")
711 (addrModeCosts discrim Rhs) c
713 ppr_if_stmt pp_pred then_part else_part discrim_costs c
715 hcat [text "if (", pp_pred, text ") {"],
716 nest 8 (pprAbsC then_part (c + discrim_costs +
717 (Cost (0, 2, 0, 0, 0)) +
719 (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
720 nest 8 (pprAbsC else_part (c + discrim_costs +
721 (Cost (0, 1, 0, 0, 0)) +
724 {- Total costs = inherited costs (before if) + costs for accessing discrim
725 + costs for cond branch ( = (0, 1, 0, 0, 0) )
726 + costs for that alternative
730 Historical note: this used to be two separate cases -- one for `ccall'
731 and one for `casm'. To get round a potential limitation to only 10
732 arguments, the numbering of arguments in @process_casm@ was beefed up a
735 Some rough notes on generating code for @CCallOp@:
737 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
738 2) Save any essential registers (heap, stack, etc).
740 ToDo: If stable pointers are in use, these must be saved in a place
741 where the runtime system can get at them so that the Stg world can
742 be restarted during the call.
744 3) Save any temporary registers that are currently in use.
745 4) Do the call, putting result into a local variable
746 5) Restore essential registers
747 6) Restore temporaries
749 (This happens after restoration of essential registers because we
750 might need the @Base@ register to access all the others correctly.)
752 Otherwise, copy local variable into result register.
754 8) If ccall (not casm), declare the function being called as extern so
755 that C knows if it returns anything other than an int.
758 { ResultType _ccall_result;
761 _ccall_result = f( args );
765 return_reg = _ccall_result;
769 Amendment to the above: if we can GC, we have to:
771 * make sure we save all our registers away where the garbage collector
773 * be sure that there are no live registers or we're in trouble.
774 (This can cause problems if you try something foolish like passing
775 an array or a foreign obj to a _ccall_GC_ thing.)
776 * increment/decrement the @inCCallGC@ counter before/after the call so
777 that the runtime check that PerformGC is being used sensibly will work.
780 pprCCall (CCall op_str is_asm may_gc cconv) args results vol_regs
783 declare_local_vars, -- local var for *result*
784 vcat local_arg_decls,
786 process_casm local_vars pp_non_void_args casm_str,
792 (pp_saves, pp_restores) = ppr_vol_regs vol_regs
793 (pp_save_context, pp_restore_context)
794 | may_gc = ( text "{ I_ id; SUSPEND_THREAD(id);"
795 , text "RESUME_THREAD(id);}"
797 | otherwise = ( pp_basic_saves $$ pp_saves,
798 pp_basic_restores $$ pp_restores)
802 in ASSERT (all non_void nvas) nvas
803 -- the first argument will be the "I/O world" token (a VoidRep)
804 -- all others should be non-void
807 let nvrs = grab_non_void_amodes results
808 in ASSERT (length nvrs <= 1) nvrs
809 -- there will usually be two results: a (void) state which we
810 -- should ignore and a (possibly void) result.
812 (local_arg_decls, pp_non_void_args)
813 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
815 ccall_arg_tys = map (text.showPrimRep.getAmodeRep) non_void_args
818 case non_void_results of
819 [] -> ptext SLIT("void")
820 [amode] -> text (showPrimRep (getAmodeRep amode))
821 _ -> panic "pprCCall: ccall_res_ty"
824 ptext SLIT("_ccall_fun_ty") <>
826 DynamicTarget u -> ppr u
829 (declare_local_vars, local_vars, assign_results)
830 = ppr_casm_results non_void_results
832 (StaticTarget asm_str) = op_str
835 StaticTarget _ -> False
836 DynamicTarget _ -> True
838 casm_str = if is_asm then _UNPK_ asm_str else ccall_str
840 -- Remainder only used for ccall
843 | is_dynamic = parens (parens (ccall_fun_ty) <> text "%0")
844 | otherwise = ptext asm_str
848 if null non_void_results
851 lparen, fun_name, lparen,
852 hcat (punctuate comma ccall_fun_args),
857 | is_dynamic = tail ccall_args
858 | otherwise = ccall_args
860 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
864 If the argument is a heap object, we need to reach inside and pull out
865 the bit the C world wants to see. The only heap objects which can be
866 passed are @Array@s and @ByteArray@s.
869 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
870 -- (a) decl and assignment, (b) local var to be used later
872 ppr_casm_arg amode a_num
874 a_kind = getAmodeRep amode
875 pp_amode = pprAmode amode
876 pp_kind = pprPrimKind a_kind
878 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
880 (arg_type, pp_amode2)
883 -- for array arguments, pass a pointer to the body of the array
884 -- (PTRS_ARR_CTS skips over all the header nonsense)
885 ArrayRep -> (pp_kind,
886 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
887 ByteArrayRep -> (pp_kind,
888 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
890 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
891 ForeignObjRep -> (pp_kind,
892 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
893 char '(', pp_amode, char ')'])
895 other -> (pp_kind, pp_amode)
898 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
900 (declare_local_var, local_var)
903 For l-values, the critical questions are:
905 1) Are there any results at all?
907 We only allow zero or one results.
911 :: [CAddrMode] -- list of results (length <= 1)
913 ( SDoc, -- declaration of any local vars
914 [SDoc], -- list of result vars (same length as results)
915 SDoc ) -- assignment (if any) of results in local var to registers
918 = (empty, [], empty) -- no results
922 result_reg = ppr_amode r
923 r_kind = getAmodeRep r
925 local_var = ptext SLIT("_ccall_result")
927 (result_type, assign_result)
928 = (pprPrimKind r_kind,
929 hcat [ result_reg, equals, local_var, semi ])
931 declare_local_var = hcat [ result_type, space, local_var, semi ]
933 (declare_local_var, [local_var], assign_result)
936 = panic "ppr_casm_results: ccall/casm with many results"
940 Note the sneaky way _the_ result is represented by a list so that we
941 can complain if it's used twice.
943 ToDo: Any chance of giving line numbers when process-casm fails?
944 Or maybe we should do a check _much earlier_ in compiler. ADR
947 process_casm :: [SDoc] -- results (length <= 1)
948 -> [SDoc] -- arguments
949 -> String -- format string (with embedded %'s)
950 -> SDoc -- code being generated
952 process_casm results args string = process results args string
954 process [] _ "" = empty
955 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
957 "\"\n(Try changing result type to PrimIO ()\n")
959 process ress args ('%':cs)
962 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
965 char '%' <> process ress args css
969 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
970 [r] -> r <> (process [] args css)
971 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
975 read_int :: ReadS Int
978 case (read_int other) of
980 if 0 <= num && num < length args
981 then parens (args !! num) <> process ress args css
982 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
983 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
985 process ress args (other_c:cs)
986 = char other_c <> process ress args cs
989 %************************************************************************
991 \subsection[a2r-assignments]{Assignments}
993 %************************************************************************
995 Printing assignments is a little tricky because of type coercion.
997 First of all, the kind of the thing being assigned can be gotten from
998 the destination addressing mode. (It should be the same as the kind
999 of the source addressing mode.) If the kind of the assignment is of
1000 @VoidRep@, then don't generate any code at all.
1003 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
1005 pprAssign VoidRep dest src = empty
1008 Special treatment for floats and doubles, to avoid unwanted conversions.
1011 pprAssign FloatRep dest@(CVal reg_rel _) src
1012 = hcat [ ptext SLIT("ASSIGN_FLT"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1014 pprAssign DoubleRep dest@(CVal reg_rel _) src
1015 = hcat [ ptext SLIT("ASSIGN_DBL"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1017 pprAssign Int64Rep dest@(CVal reg_rel _) src
1018 = hcat [ ptext SLIT("ASSIGN_Int64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1019 pprAssign Word64Rep dest@(CVal reg_rel _) src
1020 = hcat [ ptext SLIT("ASSIGN_Word64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1023 Lastly, the question is: will the C compiler think the types of the
1024 two sides of the assignment match?
1026 We assume that the types will match if neither side is a
1027 @CVal@ addressing mode for any register which can point into
1030 Why? Because the heap and stack are used to store miscellaneous
1031 things, whereas the temporaries, registers, etc., are only used for
1032 things of fixed type.
1035 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1036 = hcat [ pprVanillaReg dest, equals,
1037 pprVanillaReg src, semi ]
1039 pprAssign kind dest src
1040 | mixedTypeLocn dest
1041 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1042 = hcat [ ppr_amode dest, equals,
1043 text "(W_)(", -- Here is the cast
1044 ppr_amode src, pp_paren_semi ]
1046 pprAssign kind dest src
1047 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1048 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1049 = hcat [ ppr_amode dest, equals,
1050 text "(P_)(", -- Here is the cast
1051 ppr_amode src, pp_paren_semi ]
1053 pprAssign ByteArrayRep dest src
1055 -- Add in a cast iff the source is mixed
1056 = hcat [ ppr_amode dest, equals,
1057 text "(StgByteArray)(", -- Here is the cast
1058 ppr_amode src, pp_paren_semi ]
1060 pprAssign kind other_dest src
1061 = hcat [ ppr_amode other_dest, equals,
1062 pprAmode src, semi ]
1066 %************************************************************************
1068 \subsection[a2r-CAddrModes]{Addressing modes}
1070 %************************************************************************
1072 @pprAmode@ is used to print r-values (which may need casts), whereas
1073 @ppr_amode@ is used for l-values {\em and} as a help function for
1077 pprAmode, ppr_amode :: CAddrMode -> SDoc
1080 For reasons discussed above under assignments, @CVal@ modes need
1081 to be treated carefully. First come special cases for floats and doubles,
1082 similar to those in @pprAssign@:
1084 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1088 pprAmode (CVal reg_rel FloatRep)
1089 = hcat [ text "PK_FLT(", ppr_amode (CAddr reg_rel), rparen ]
1090 pprAmode (CVal reg_rel DoubleRep)
1091 = hcat [ text "PK_DBL(", ppr_amode (CAddr reg_rel), rparen ]
1092 pprAmode (CVal reg_rel Int64Rep)
1093 = hcat [ text "PK_Int64(", ppr_amode (CAddr reg_rel), rparen ]
1094 pprAmode (CVal reg_rel Word64Rep)
1095 = hcat [ text "PK_Word64(", ppr_amode (CAddr reg_rel), rparen ]
1098 Next comes the case where there is some other cast need, and the
1103 | mixedTypeLocn amode
1104 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1106 | otherwise -- No cast needed
1110 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1113 ppr_amode (CVal reg_rel _)
1114 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1115 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1116 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1118 ppr_amode (CAddr reg_rel)
1119 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1120 (pp_reg, Nothing) -> pp_reg
1121 (pp_reg, Just offset) -> (<>) pp_reg offset
1123 ppr_amode (CReg magic_id) = pprMagicId magic_id
1125 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1127 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1129 ppr_amode (CCharLike ch)
1130 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1131 ppr_amode (CIntLike int)
1132 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1134 ppr_amode (CLit lit) = pprBasicLit lit
1136 ppr_amode (CLitLit str _) = ptext str
1138 ppr_amode (CJoinPoint _)
1139 = panic "ppr_amode: CJoinPoint"
1141 ppr_amode (CMacroExpr pk macro as)
1142 = parens (pprPrimKind pk) <>
1143 parens (ptext (cExprMacroText macro) <>
1144 parens (hcat (punctuate comma (map pprAmode as))))
1148 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1149 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1150 cExprMacroText GET_TAG = SLIT("GET_TAG")
1151 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1153 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1154 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1155 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1156 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1157 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1158 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1159 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1160 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1161 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1162 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1163 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1164 cStmtMacroText GRAN_FETCH = SLIT("GRAN_FETCH")
1165 cStmtMacroText GRAN_RESCHEDULE = SLIT("GRAN_RESCHEDULE")
1166 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1167 cStmtMacroText THREAD_CONTEXT_SWITCH = SLIT("THREAD_CONTEXT_SWITCH")
1168 cStmtMacroText GRAN_YIELD = SLIT("GRAN_YIELD")
1170 cCheckMacroText HP_CHK_NP = SLIT("HP_CHK_NP")
1171 cCheckMacroText STK_CHK_NP = SLIT("STK_CHK_NP")
1172 cCheckMacroText HP_STK_CHK_NP = SLIT("HP_STK_CHK_NP")
1173 cCheckMacroText HP_CHK_SEQ_NP = SLIT("HP_CHK_SEQ_NP")
1174 cCheckMacroText HP_CHK = SLIT("HP_CHK")
1175 cCheckMacroText STK_CHK = SLIT("STK_CHK")
1176 cCheckMacroText HP_STK_CHK = SLIT("HP_STK_CHK")
1177 cCheckMacroText HP_CHK_NOREGS = SLIT("HP_CHK_NOREGS")
1178 cCheckMacroText HP_CHK_UNPT_R1 = SLIT("HP_CHK_UNPT_R1")
1179 cCheckMacroText HP_CHK_UNBX_R1 = SLIT("HP_CHK_UNBX_R1")
1180 cCheckMacroText HP_CHK_F1 = SLIT("HP_CHK_F1")
1181 cCheckMacroText HP_CHK_D1 = SLIT("HP_CHK_D1")
1182 cCheckMacroText HP_CHK_L1 = SLIT("HP_CHK_L1")
1183 cCheckMacroText HP_CHK_UT_ALT = SLIT("HP_CHK_UT_ALT")
1184 cCheckMacroText HP_CHK_GEN = SLIT("HP_CHK_GEN")
1187 %************************************************************************
1189 \subsection[ppr-liveness-masks]{Liveness Masks}
1191 %************************************************************************
1194 pp_liveness :: Liveness -> SDoc
1197 LvLarge lbl -> char '&' <> pprCLabel lbl
1198 LvSmall mask -- Avoid gcc bug when printing minInt
1199 | bitmap_int == minInt -> int (bitmap_int+1) <> text "-1"
1200 | otherwise -> int bitmap_int
1202 bitmap_int = intBS mask
1205 %************************************************************************
1207 \subsection[a2r-MagicIds]{Magic ids}
1209 %************************************************************************
1211 @pprRegRelative@ returns a pair of the @Doc@ for the register
1212 (some casting may be required), and a @Maybe Doc@ for the offset
1213 (zero offset gives a @Nothing@).
1216 addPlusSign :: Bool -> SDoc -> SDoc
1217 addPlusSign False p = p
1218 addPlusSign True p = (<>) (char '+') p
1220 pprSignedInt :: Bool -> Int -> Maybe SDoc -- Nothing => 0
1221 pprSignedInt sign_wanted n
1222 = if n == 0 then Nothing else
1223 if n > 0 then Just (addPlusSign sign_wanted (int n))
1226 pprRegRelative :: Bool -- True <=> Print leading plus sign (if +ve)
1228 -> (SDoc, Maybe SDoc)
1230 pprRegRelative sign_wanted (SpRel off)
1231 = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1233 pprRegRelative sign_wanted r@(HpRel o)
1234 = let pp_Hp = pprMagicId Hp; off = I# o
1239 (pp_Hp, Just ((<>) (char '-') (int off)))
1241 pprRegRelative sign_wanted (NodeRel o)
1242 = let pp_Node = pprMagicId node; off = I# o
1247 (pp_Node, Just (addPlusSign sign_wanted (int off)))
1249 pprRegRelative sign_wanted (CIndex base offset kind)
1250 = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1251 , Just (hcat [if sign_wanted then char '+' else empty,
1252 text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1256 @pprMagicId@ just prints the register name. @VanillaReg@ registers are
1257 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1258 to select the union tag.
1261 pprMagicId :: MagicId -> SDoc
1263 pprMagicId BaseReg = ptext SLIT("BaseReg")
1264 pprMagicId (VanillaReg pk n)
1265 = hcat [ pprVanillaReg n, char '.',
1267 pprMagicId (FloatReg n) = (<>) (ptext SLIT("F")) (int IBOX(n))
1268 pprMagicId (DoubleReg n) = (<>) (ptext SLIT("D")) (int IBOX(n))
1269 pprMagicId (LongReg _ n) = (<>) (ptext SLIT("L")) (int IBOX(n))
1270 pprMagicId Sp = ptext SLIT("Sp")
1271 pprMagicId Su = ptext SLIT("Su")
1272 pprMagicId SpLim = ptext SLIT("SpLim")
1273 pprMagicId Hp = ptext SLIT("Hp")
1274 pprMagicId HpLim = ptext SLIT("HpLim")
1275 pprMagicId CurCostCentre = ptext SLIT("CCCS")
1276 pprMagicId VoidReg = panic "pprMagicId:VoidReg!"
1278 pprVanillaReg :: FAST_INT -> SDoc
1279 pprVanillaReg n = (<>) (char 'R') (int IBOX(n))
1281 pprUnionTag :: PrimRep -> SDoc
1283 pprUnionTag PtrRep = char 'p'
1284 pprUnionTag CodePtrRep = ptext SLIT("fp")
1285 pprUnionTag DataPtrRep = char 'd'
1286 pprUnionTag RetRep = char 'p'
1287 pprUnionTag CostCentreRep = panic "pprUnionTag:CostCentre?"
1289 pprUnionTag CharRep = char 'c'
1290 pprUnionTag IntRep = char 'i'
1291 pprUnionTag WordRep = char 'w'
1292 pprUnionTag AddrRep = char 'a'
1293 pprUnionTag FloatRep = char 'f'
1294 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1296 pprUnionTag StablePtrRep = char 'i'
1297 pprUnionTag StableNameRep = char 'p'
1298 pprUnionTag WeakPtrRep = char 'p'
1299 pprUnionTag ForeignObjRep = char 'p'
1301 pprUnionTag ThreadIdRep = char 't'
1303 pprUnionTag ArrayRep = char 'p'
1304 pprUnionTag ByteArrayRep = char 'b'
1306 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1310 Find and print local and external declarations for a list of
1311 Abstract~C statements.
1313 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1314 pprTempAndExternDecls AbsCNop = (empty, empty)
1316 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1317 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1318 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1319 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1320 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1321 returnTE (vcat real_temps, vcat real_exts) }}
1324 pprTempAndExternDecls other_stmt
1325 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1336 pprBasicLit :: Literal -> SDoc
1337 pprPrimKind :: PrimRep -> SDoc
1339 pprBasicLit lit = ppr lit
1340 pprPrimKind k = ppr k
1344 %************************************************************************
1346 \subsection[a2r-monad]{Monadery}
1348 %************************************************************************
1350 We need some monadery to keep track of temps and externs we have already
1351 printed. This info must be threaded right through the Abstract~C, so
1352 it's most convenient to hide it in this monad.
1354 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1355 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1358 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1359 emptyCLabelSet = emptyFM
1360 x `elementOfCLabelSet` labs
1361 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1363 addToCLabelSet set x = addToFM set x ()
1365 type TEenv = (UniqSet Unique, CLabelSet)
1367 type TeM result = TEenv -> (TEenv, result)
1369 initTE :: TeM a -> a
1371 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1374 {-# INLINE thenTE #-}
1375 {-# INLINE returnTE #-}
1377 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1379 = case a u of { (u_1, result_of_a) ->
1382 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1383 mapTE f [] = returnTE []
1385 = f x `thenTE` \ r ->
1386 mapTE f xs `thenTE` \ rs ->
1389 returnTE :: a -> TeM a
1390 returnTE result env = (env, result)
1392 -- these next two check whether the thing is already
1393 -- recorded, and THEN THEY RECORD IT
1394 -- (subsequent calls will return False for the same uniq/label)
1396 tempSeenTE :: Unique -> TeM Bool
1397 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1398 = if (uniq `elementOfUniqSet` seen_uniqs)
1400 else ((addOneToUniqSet seen_uniqs uniq,
1404 labelSeenTE :: CLabel -> TeM Bool
1405 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1406 = if (lbl `elementOfCLabelSet` seen_labels)
1409 addToCLabelSet seen_labels lbl),
1414 pprTempDecl :: Unique -> PrimRep -> SDoc
1415 pprTempDecl uniq kind
1416 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1418 pprExternDecl :: Bool -> CLabel -> SDoc
1419 pprExternDecl in_srt clabel
1420 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1422 hcat [ ppLocalnessMacro (not in_srt) clabel,
1423 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1426 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1432 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1434 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1436 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1437 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1438 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1439 returnTE (maybe_vcat [p1, p2])
1441 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1443 ppr_decls_AbsC (CAssign dest source)
1444 = ppr_decls_Amode dest `thenTE` \ p1 ->
1445 ppr_decls_Amode source `thenTE` \ p2 ->
1446 returnTE (maybe_vcat [p1, p2])
1448 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1450 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1452 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1454 ppr_decls_AbsC (CSwitch discrim alts deflt)
1455 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1456 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1457 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1458 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1460 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1462 ppr_decls_AbsC (CCodeBlock lbl absC)
1463 = ppr_decls_AbsC absC
1465 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre)
1466 -- ToDo: strictly speaking, should chk "cost_centre" amode
1467 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1472 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1474 info_lbl = infoTableLabelFromCI cl_info
1476 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1477 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1479 ppr_decls_AbsC (CCheck _ amodes code) =
1480 ppr_decls_Amodes amodes `thenTE` \p1 ->
1481 ppr_decls_AbsC code `thenTE` \p2 ->
1482 returnTE (maybe_vcat [p1,p2])
1484 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1486 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1487 -- you get some nasty re-decls of stdio.h if you compile
1488 -- the prelude while looking inside those amodes;
1489 -- no real reason to, anyway.
1490 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1492 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1493 -- ToDo: strictly speaking, should chk "cost_centre" amode
1494 = ppr_decls_Amodes amodes
1496 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1497 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1498 ppr_decls_AbsC slow `thenTE` \ p2 ->
1500 Nothing -> returnTE (Nothing, Nothing)
1501 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1502 returnTE (maybe_vcat [p1, p2, p3])
1504 entry_lbl = CLbl slow_lbl CodePtrRep
1505 slow_lbl = case (nonemptyAbsC slow) of
1506 Nothing -> mkErrorStdEntryLabel
1507 Just _ -> entryLabelFromCI cl_info
1509 ppr_decls_AbsC (CSRT lbl closure_lbls)
1510 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1512 if and seen then Nothing
1513 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1514 | (l,False) <- zip closure_lbls seen ]))
1516 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1517 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1518 ppr_decls_AbsC (CModuleInitBlock _ code) = ppr_decls_AbsC code
1520 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1524 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1525 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1526 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1527 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1528 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1529 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1530 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1531 ppr_decls_Amode (CLitLit _ _) = returnTE (Nothing, Nothing)
1533 -- CIntLike must be a literal -- no decls
1534 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1536 -- CCharLike may have be arbitrary value -- may have decls
1537 ppr_decls_Amode (CCharLike char)
1538 = ppr_decls_Amode char
1540 -- now, the only place where we actually print temps/externs...
1541 ppr_decls_Amode (CTemp uniq kind)
1543 VoidRep -> returnTE (Nothing, Nothing)
1545 tempSeenTE uniq `thenTE` \ temp_seen ->
1547 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1549 ppr_decls_Amode (CLbl lbl VoidRep)
1550 = returnTE (Nothing, Nothing)
1552 ppr_decls_Amode (CLbl lbl kind)
1553 = labelSeenTE lbl `thenTE` \ label_seen ->
1555 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1557 ppr_decls_Amode (CMacroExpr _ _ amodes)
1558 = ppr_decls_Amodes amodes
1560 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1563 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1565 = case (unzip ps) of { (ts, es) ->
1566 case (catMaybes ts) of { real_ts ->
1567 case (catMaybes es) of { real_es ->
1568 (if (null real_ts) then Nothing else Just (vcat real_ts),
1569 if (null real_es) then Nothing else Just (vcat real_es))
1574 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1575 ppr_decls_Amodes amodes
1576 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1577 returnTE ( maybe_vcat ps )
1580 Print out a C Label where you want the *address* of the label, not the
1581 object it refers to. The distinction is important when the label may
1582 refer to a C structure (info tables and closures, for instance).
1584 When just generating a declaration for the label, use pprCLabel.
1587 pprCLabelAddr :: CLabel -> SDoc
1588 pprCLabelAddr clabel =
1589 case labelType clabel of
1590 InfoTblType -> addr_of_label
1591 ClosureType -> addr_of_label
1592 VecTblType -> addr_of_label
1595 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1596 pp_label = pprCLabel clabel
1600 -----------------------------------------------------------------------------
1601 Initialising static objects with floating-point numbers. We can't
1602 just emit the floating point number, because C will cast it to an int
1603 by rounding it. We want the actual bit-representation of the float.
1605 This is a hack to turn the floating point numbers into ints that we
1606 can safely initialise to static locations.
1609 big_doubles = (getPrimRepSize DoubleRep) /= 1
1611 -- floatss are always 1 word
1612 floatToWord :: CAddrMode -> CAddrMode
1613 floatToWord (CLit (MachFloat r))
1615 arr <- newFloatArray ((0::Int),0)
1616 writeFloatArray arr 0 (fromRational r)
1617 i <- readIntArray arr 0
1618 return (CLit (MachInt (toInteger i)))
1621 doubleToWords :: CAddrMode -> [CAddrMode]
1622 doubleToWords (CLit (MachDouble r))
1623 | big_doubles -- doubles are 2 words
1625 arr <- newDoubleArray ((0::Int),1)
1626 writeDoubleArray arr 0 (fromRational r)
1627 i1 <- readIntArray arr 0
1628 i2 <- readIntArray arr 1
1629 return [ CLit (MachInt (toInteger i1))
1630 , CLit (MachInt (toInteger i2))
1633 | otherwise -- doubles are 1 word
1635 arr <- newDoubleArray ((0::Int),0)
1636 writeDoubleArray arr 0 (fromRational r)
1637 i <- readIntArray arr 0
1638 return [ CLit (MachInt (toInteger i)) ]