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 ForeignCall ( CCallSpec(..), CCallTarget(..), playSafe, ccallConvAttribute )
30 import CLabel ( externallyVisibleCLabel,
31 needsCDecl, pprCLabel,
32 mkReturnInfoLabel, mkReturnPtLabel, mkClosureTblLabel,
33 mkClosureLabel, mkErrorStdEntryLabel,
34 CLabel, CLabelType(..), labelType, labelDynamic
37 import CmdLineOpts ( opt_SccProfilingOn, opt_GranMacros )
38 import CostCentre ( pprCostCentreDecl, pprCostCentreStackDecl )
40 import Costs ( costs, addrModeCosts, CostRes(..), Side(..) )
41 import CStrings ( pprStringInCStyle, pprCLabelString )
42 import FiniteMap ( addToFM, emptyFM, lookupFM, FiniteMap )
43 import Literal ( Literal(..) )
44 import TyCon ( tyConDataCons )
45 import Name ( NamedThing(..) )
46 import DataCon ( dataConWrapId )
47 import Maybes ( maybeToBool, catMaybes )
48 import PrimOp ( primOpNeedsWrapper )
49 import ForeignCall ( ForeignCall(..), isDynamicTarget )
50 import PrimRep ( isFloatingRep, PrimRep(..), getPrimRepSize )
51 import SMRep ( pprSMRep )
52 import Unique ( pprUnique, Unique{-instance NamedThing-} )
53 import UniqSet ( emptyUniqSet, elementOfUniqSet,
54 addOneToUniqSet, UniqSet
56 import StgSyn ( SRT(..), StgOp(..) )
57 import BitSet ( intBS )
60 import Util ( nOfThem )
67 For spitting out the costs of an abstract~C expression, @writeRealC@
68 now not only prints the C~code of the @absC@ arg but also adds a macro
69 call to a cost evaluation function @GRAN_EXEC@. For that,
70 @pprAbsC@ has a new ``costs'' argument. %% HWL
74 writeRealC :: Handle -> AbstractC -> IO ()
75 writeRealC handle absC
76 -- avoid holding on to the whole of absC in the !Gransim case.
78 then printForCFast fp (pprAbsC absC (costs absC))
79 else printForCFast fp (pprAbsC absC (panic "costs"))
80 --printForC handle (pprAbsC absC (panic "costs"))
81 dumpRealC :: AbstractC -> SDoc
82 dumpRealC absC = pprAbsC absC (costs absC)
85 writeRealC :: Handle -> AbstractC -> IO ()
86 --writeRealC handle absC =
88 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
90 writeRealC handle absC
91 | opt_GranMacros = _scc_ "writeRealC" printForC handle $
92 pprCode CStyle (pprAbsC absC (costs absC))
93 | otherwise = _scc_ "writeRealC" printForC handle $
94 pprCode CStyle (pprAbsC absC (panic "costs"))
96 dumpRealC :: AbstractC -> SDoc
98 | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
99 | otherwise = pprCode CStyle (pprAbsC absC (panic "costs"))
103 This emits the macro, which is used in GrAnSim to compute the total costs
104 from a cost 5 tuple. %% HWL
107 emitMacro :: CostRes -> SDoc
109 emitMacro _ | not opt_GranMacros = empty
111 emitMacro (Cost (i,b,l,s,f))
112 = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
113 int i, comma, int b, comma, int l, comma,
114 int s, comma, int f, pp_paren_semi ]
116 pp_paren_semi = text ");"
119 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
120 code as an argument (that's needed when spitting out the GRAN_EXEC macro
121 which must be done before the return i.e. inside absC code) HWL
124 pprAbsC :: AbstractC -> CostRes -> SDoc
125 pprAbsC AbsCNop _ = empty
126 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
128 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
130 pprAbsC (CJump target) c
131 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CJump */"-} ])
132 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
134 pprAbsC (CFallThrough target) c
135 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CFallThrough */"-} ])
136 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
138 -- --------------------------------------------------------------------------
139 -- Spit out GRAN_EXEC macro immediately before the return HWL
141 pprAbsC (CReturn am return_info) c
142 = ($$) (hcat [emitMacro c {-WDP:, text "/* <---- CReturn */"-} ])
143 (hcat [text jmp_lit, target, pp_paren_semi ])
145 target = case return_info of
146 DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
148 DynamicVectoredReturn am' -> mk_vector (pprAmode am')
149 StaticVectoredReturn n -> mk_vector (int n) -- Always positive
150 mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
153 pprAbsC (CSplitMarker) _ = ptext SLIT("__STG_SPLIT_MARKER")
155 -- we optimise various degenerate cases of CSwitches.
157 -- --------------------------------------------------------------------------
158 -- Assume: CSwitch is also end of basic block
159 -- costs function yields nullCosts for whole switch
160 -- ==> inherited costs c are those of basic block up to switch
161 -- ==> inherit c + costs for the corresponding branch
163 -- --------------------------------------------------------------------------
165 pprAbsC (CSwitch discrim [] deflt) c
166 = pprAbsC deflt (c + costs deflt)
167 -- Empty alternative list => no costs for discrim as nothing cond. here HWL
169 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
170 = case (nonemptyAbsC deflt) of
171 Nothing -> -- one alt and no default
172 pprAbsC alt_code (c + costs alt_code)
173 -- Nothing conditional in here either HWL
175 Just dc -> -- make it an "if"
176 do_if_stmt discrim tag alt_code dc c
178 -- What problem is the re-ordering trying to solve ?
179 pprAbsC (CSwitch discrim [(tag1@(MachInt i1), alt_code1),
180 (tag2@(MachInt i2), alt_code2)] deflt) c
181 | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
183 do_if_stmt discrim tag1 alt_code1 alt_code2 c
185 do_if_stmt discrim tag2 alt_code2 alt_code1 c
187 empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
189 pprAbsC (CSwitch discrim alts deflt) c -- general case
190 | isFloatingRep (getAmodeRep discrim)
191 = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
194 hcat [text "switch (", pp_discrim, text ") {"],
195 nest 2 (vcat (map ppr_alt alts)),
196 (case (nonemptyAbsC deflt) of
199 nest 2 (vcat [ptext SLIT("default:"),
200 pprAbsC dc (c + switch_head_cost
202 ptext SLIT("break;")])),
209 = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
210 nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
211 (ptext SLIT("break;"))) ]
213 -- Costs for addressing header of switch and cond. branching -- HWL
214 switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
216 pprAbsC stmt@(COpStmt results (StgFCallOp fcall uniq) args vol_regs) _
217 = pprFCall fcall uniq args results vol_regs
219 pprAbsC stmt@(COpStmt results (StgPrimOp 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 [ ppr 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 (CCallSpec op_str cconv _ _) uniq 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 (ccallConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
326 | otherwise = text (ccallConvAttribute cconv) <+> ccall_fun_ty
330 DynamicTarget -> ptext SLIT("_ccall_fun_ty") <> ppr uniq
331 StaticTarget x -> pprCLabelString x
334 case non_void_results of
335 [] -> ptext SLIT("void")
336 [amode] -> ppr (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 (ppr . getAmodeRep) non_void_args
345 -- the first argument will be the "I/O world" token (a VoidRep)
346 -- all others should be non-void
349 in ASSERT (all non_void nvas) nvas
351 -- there will usually be two results: a (void) state which we
352 -- should ignore and a (possibly void) result.
354 let nvrs = grab_non_void_amodes results
355 in ASSERT (length nvrs <= 1) nvrs
357 pprAbsC (CCodeBlock lbl abs_C) _
358 = if not (maybeToBool(nonemptyAbsC abs_C)) then
359 pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
361 case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
365 hcat [text (if (externallyVisibleCLabel lbl)
366 then "FN_(" -- abbreviations to save on output
368 pprCLabel lbl, text ") {"],
372 nest 8 (ptext SLIT("FB_")),
373 nest 8 (pprAbsC abs_C (costs abs_C)),
374 nest 8 (ptext SLIT("FE_")),
380 pprAbsC (CInitHdr cl_info amode cost_centre) _
381 = hcat [ ptext SLIT("SET_HDR_"), char '(',
382 ppr_amode amode, comma,
383 pprCLabelAddr info_lbl, comma,
384 if_profiling (pprAmode cost_centre),
387 info_lbl = infoTableLabelFromCI cl_info
389 pprAbsC stmt@(CStaticClosure closure_lbl cl_info cost_centre amodes) _
390 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
394 ptext SLIT("SET_STATIC_HDR"), char '(',
395 pprCLabel closure_lbl, comma,
396 pprCLabel info_lbl, comma,
397 if_profiling (pprAmode cost_centre), comma,
398 ppLocalness closure_lbl, comma,
399 ppLocalnessMacro True{-include dyn-} info_lbl,
402 nest 2 (ppr_payload (amodes ++ padding_wds ++ static_link_field)),
406 info_lbl = infoTableLabelFromCI cl_info
408 ppr_payload [] = empty
409 ppr_payload ls = comma <+>
410 braces (hsep (punctuate comma (map ((text "(L_)" <>).ppr_item) ls)))
413 | rep == VoidRep = text "0" -- might not even need this...
414 | rep == FloatRep = ppr_amode (floatToWord item)
415 | rep == DoubleRep = hcat (punctuate (text ", (L_)")
416 (map ppr_amode (doubleToWords item)))
417 | otherwise = ppr_amode item
419 rep = getAmodeRep item
421 upd_reqd = closureUpdReqd cl_info
425 | otherwise = case max 0 (mIN_UPD_SIZE - length amodes) of { still_needed ->
426 nOfThem still_needed (mkIntCLit 0) } -- a bunch of 0s
428 -- always have a static link field, it's used to save the closure's
429 -- info pointer when we're reverting CAFs (see comment in Storage.c)
431 | upd_reqd || staticClosureNeedsLink cl_info = [mkIntCLit 0]
434 pprAbsC stmt@(CClosureInfoAndCode cl_info slow maybe_fast cl_descr) _
437 ptext SLIT("INFO_TABLE"),
438 ( if is_selector then
439 ptext SLIT("_SELECTOR")
440 else if is_constr then
441 ptext SLIT("_CONSTR")
442 else if needs_srt then
444 else empty ), char '(',
446 pprCLabel info_lbl, comma,
447 pprCLabel slow_lbl, comma,
448 pp_rest, {- ptrs,nptrs,[srt,]type,-} comma,
450 ppLocalness info_lbl, comma,
451 ppLocalnessMacro True{-include dyn-} slow_lbl, comma,
453 if_profiling pp_descr, comma,
454 if_profiling pp_type,
460 Just fast -> let stuff = CCodeBlock fast_lbl fast in
461 pprAbsC stuff (costs stuff)
464 info_lbl = infoTableLabelFromCI cl_info
465 fast_lbl = fastLabelFromCI cl_info
468 = case (nonemptyAbsC slow) of
469 Nothing -> (mkErrorStdEntryLabel, empty)
470 Just xx -> (entryLabelFromCI cl_info,
471 let stuff = CCodeBlock slow_lbl xx in
472 pprAbsC stuff (costs stuff))
474 maybe_selector = maybeSelectorInfo cl_info
475 is_selector = maybeToBool maybe_selector
476 (Just select_word_i) = maybe_selector
478 maybe_tag = closureSemiTag cl_info
479 is_constr = maybeToBool maybe_tag
480 (Just tag) = maybe_tag
482 needs_srt = infoTblNeedsSRT cl_info
483 srt = getSRTInfo cl_info
485 size = closureNonHdrSize cl_info
487 ptrs = closurePtrsSize cl_info
490 pp_rest | is_selector = int select_word_i
495 hcat [ int tag, comma ]
496 else if needs_srt then
501 type_str = pprSMRep (closureSMRep cl_info)
503 pp_descr = pprStringInCStyle cl_descr
504 pp_type = pprStringInCStyle (closureTypeDescr cl_info)
506 pprAbsC stmt@(CClosureTbl tycon) _
508 ptext SLIT("CLOSURE_TBL") <>
509 lparen <> pprCLabel (mkClosureTblLabel tycon) <> rparen :
511 map (pp_closure_lbl . mkClosureLabel . getName . dataConWrapId) (tyConDataCons tycon)
513 ) $$ ptext SLIT("};")
515 pprAbsC stmt@(CRetDirect uniq code srt liveness) _
518 ptext SLIT("INFO_TABLE_SRT_BITMAP"), lparen,
519 pprCLabel info_lbl, comma,
520 pprCLabel entry_lbl, comma,
521 pp_liveness liveness, comma, -- bitmap
522 pp_srt_info srt, -- SRT
523 ptext type_str, comma, -- closure type
524 ppLocalness info_lbl, comma, -- info table storage class
525 ppLocalnessMacro True{-include dyn-} entry_lbl, comma, -- entry pt storage class
532 info_lbl = mkReturnInfoLabel uniq
533 entry_lbl = mkReturnPtLabel uniq
535 pp_code = let stuff = CCodeBlock entry_lbl code in
536 pprAbsC stuff (costs stuff)
538 type_str = case liveness of
539 LvSmall _ -> SLIT("RET_SMALL")
540 LvLarge _ -> SLIT("RET_BIG")
542 pprAbsC stmt@(CRetVector lbl amodes srt liveness) _
543 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
547 ptext SLIT("VEC_INFO_") <> int size,
549 pprCLabel lbl, comma,
550 pp_liveness liveness, comma, -- bitmap liveness mask
551 pp_srt_info srt, -- SRT
552 ptext type_str, comma,
553 ppLocalness lbl, comma
555 nest 2 (sep (punctuate comma (map ppr_item amodes))),
561 ppr_item item = (<>) (text "(F_) ") (ppr_amode item)
564 type_str = case liveness of
565 LvSmall _ -> SLIT("RET_VEC_SMALL")
566 LvLarge _ -> SLIT("RET_VEC_BIG")
569 pprAbsC stmt@(CModuleInitBlock lbl code) _
571 ptext SLIT("START_MOD_INIT") <> parens (pprCLabel lbl),
572 case (pprTempAndExternDecls stmt) of { (_, pp_exts) -> pp_exts },
573 pprAbsC code (costs code),
574 hcat [ptext SLIT("END_MOD_INIT"), lparen, rparen]
577 pprAbsC (CCostCentreDecl is_local cc) _ = pprCostCentreDecl is_local cc
578 pprAbsC (CCostCentreStackDecl ccs) _ = pprCostCentreStackDecl ccs
583 = if (externallyVisibleCLabel lbl)
585 else ptext SLIT("static ")
587 -- Horrible macros for declaring the types and locality of labels (see
590 ppLocalnessMacro include_dyn_prefix clabel =
595 ClosureType -> ptext SLIT("C_")
596 CodeType -> ptext SLIT("F_")
597 InfoTblType -> ptext SLIT("I_")
598 ClosureTblType -> ptext SLIT("CP_")
599 DataType -> ptext SLIT("D_")
602 is_visible = externallyVisibleCLabel clabel
603 label_type = labelType clabel
606 | is_visible = char 'E'
607 | otherwise = char 'I'
610 | include_dyn_prefix && labelDynamic clabel = 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")
658 (lbl, SRT off len) ->
659 hcat [ pprCLabel lbl, comma,
666 | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
667 | otherwise = char '&' <> pprCLabel lbl
672 = if opt_SccProfilingOn
674 else char '0' -- leave it out!
675 -- ---------------------------------------------------------------------------
676 -- Changes for GrAnSim:
677 -- draw costs for computation in head of if into both branches;
678 -- as no abstractC data structure is given for the head, one is constructed
679 -- guessing unknown values and fed into the costs function
680 -- ---------------------------------------------------------------------------
682 do_if_stmt discrim tag alt_code deflt c
684 -- This special case happens when testing the result of a comparison.
685 -- We can just avoid some redundant clutter in the output.
686 MachInt n | n==0 -> ppr_if_stmt (pprAmode discrim)
688 (addrModeCosts discrim Rhs) c
690 cond = hcat [ pprAmode discrim
693 , pprAmode (CLit tag)
695 -- to be absolutely sure that none of the
696 -- conversion rules hit, e.g.,
698 -- minInt is different to (int)minInt
700 -- in C (when minInt is a number not a constant
701 -- expression which evaluates to it.)
703 tcast = case other of
704 MachInt _ -> ptext SLIT("(I_)")
709 (addrModeCosts discrim Rhs) c
711 ppr_if_stmt pp_pred then_part else_part discrim_costs c
713 hcat [text "if (", pp_pred, text ") {"],
714 nest 8 (pprAbsC then_part (c + discrim_costs +
715 (Cost (0, 2, 0, 0, 0)) +
717 (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
718 nest 8 (pprAbsC else_part (c + discrim_costs +
719 (Cost (0, 1, 0, 0, 0)) +
722 {- Total costs = inherited costs (before if) + costs for accessing discrim
723 + costs for cond branch ( = (0, 1, 0, 0, 0) )
724 + costs for that alternative
728 Historical note: this used to be two separate cases -- one for `ccall'
729 and one for `casm'. To get round a potential limitation to only 10
730 arguments, the numbering of arguments in @process_casm@ was beefed up a
733 Some rough notes on generating code for @CCallOp@:
735 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
736 2) Save any essential registers (heap, stack, etc).
738 ToDo: If stable pointers are in use, these must be saved in a place
739 where the runtime system can get at them so that the Stg world can
740 be restarted during the call.
742 3) Save any temporary registers that are currently in use.
743 4) Do the call, putting result into a local variable
744 5) Restore essential registers
745 6) Restore temporaries
747 (This happens after restoration of essential registers because we
748 might need the @Base@ register to access all the others correctly.)
750 Otherwise, copy local variable into result register.
752 8) If ccall (not casm), declare the function being called as extern so
753 that C knows if it returns anything other than an int.
756 { ResultType _ccall_result;
759 _ccall_result = f( args );
763 return_reg = _ccall_result;
767 Amendment to the above: if we can GC, we have to:
769 * make sure we save all our registers away where the garbage collector
771 * be sure that there are no live registers or we're in trouble.
772 (This can cause problems if you try something foolish like passing
773 an array or a foreign obj to a _ccall_GC_ thing.)
774 * increment/decrement the @inCCallGC@ counter before/after the call so
775 that the runtime check that PerformGC is being used sensibly will work.
778 pprFCall call@(CCall (CCallSpec op_str cconv safety is_asm)) uniq args results vol_regs
781 declare_local_vars, -- local var for *result*
782 vcat local_arg_decls,
784 process_casm local_vars pp_non_void_args casm_str,
790 (pp_saves, pp_restores) = ppr_vol_regs vol_regs
791 (pp_save_context, pp_restore_context)
792 | playSafe safety = ( text "{ I_ id; SUSPEND_THREAD(id);"
793 , text "RESUME_THREAD(id);}"
795 | otherwise = ( pp_basic_saves $$ pp_saves,
796 pp_basic_restores $$ pp_restores)
800 in ASSERT2 ( all non_void nvas, ppr call <+> hsep (map pprAmode args) )
802 -- the last argument will be the "I/O world" token (a VoidRep)
803 -- all others should be non-void
806 let nvrs = grab_non_void_amodes results
807 in ASSERT (length nvrs <= 1) nvrs
808 -- there will usually be two results: a (void) state which we
809 -- should ignore and a (possibly void) result.
811 (local_arg_decls, pp_non_void_args)
812 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
814 (declare_local_vars, local_vars, assign_results)
815 = ppr_casm_results non_void_results
817 casm_str = if is_asm then _UNPK_ asm_str else ccall_str
818 StaticTarget asm_str = op_str -- Must be static if it's a casm
820 -- Remainder only used for ccall
822 fun_name = case op_str of
823 DynamicTarget -> parens (parens (ptext SLIT("_ccall_fun_ty") <> ppr uniq) <> text "%0")
824 StaticTarget st -> pprCLabelString st
828 if null non_void_results
831 lparen, fun_name, lparen,
832 hcat (punctuate comma ccall_fun_args),
836 ccall_fun_args | isDynamicTarget op_str = tail ccall_args
837 | otherwise = ccall_args
839 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
842 If the argument is a heap object, we need to reach inside and pull out
843 the bit the C world wants to see. The only heap objects which can be
844 passed are @Array@s and @ByteArray@s.
847 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
848 -- (a) decl and assignment, (b) local var to be used later
850 ppr_casm_arg amode a_num
852 a_kind = getAmodeRep amode
853 pp_amode = pprAmode amode
854 pp_kind = pprPrimKind a_kind
856 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
858 (arg_type, pp_amode2)
861 -- for array arguments, pass a pointer to the body of the array
862 -- (PTRS_ARR_CTS skips over all the header nonsense)
863 ArrayRep -> (pp_kind,
864 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
865 ByteArrayRep -> (pp_kind,
866 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
868 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
869 ForeignObjRep -> (pp_kind,
870 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
871 char '(', pp_amode, char ')'])
873 other -> (pp_kind, pp_amode)
876 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
878 (declare_local_var, local_var)
881 For l-values, the critical questions are:
883 1) Are there any results at all?
885 We only allow zero or one results.
889 :: [CAddrMode] -- list of results (length <= 1)
891 ( SDoc, -- declaration of any local vars
892 [SDoc], -- list of result vars (same length as results)
893 SDoc ) -- assignment (if any) of results in local var to registers
896 = (empty, [], empty) -- no results
900 result_reg = ppr_amode r
901 r_kind = getAmodeRep r
903 local_var = ptext SLIT("_ccall_result")
905 (result_type, assign_result)
906 = (pprPrimKind r_kind,
907 hcat [ result_reg, equals, local_var, semi ])
909 declare_local_var = hcat [ result_type, space, local_var, semi ]
911 (declare_local_var, [local_var], assign_result)
914 = panic "ppr_casm_results: ccall/casm with many results"
918 Note the sneaky way _the_ result is represented by a list so that we
919 can complain if it's used twice.
921 ToDo: Any chance of giving line numbers when process-casm fails?
922 Or maybe we should do a check _much earlier_ in compiler. ADR
925 process_casm :: [SDoc] -- results (length <= 1)
926 -> [SDoc] -- arguments
927 -> String -- format string (with embedded %'s)
928 -> SDoc -- code being generated
930 process_casm results args string = process results args string
932 process [] _ "" = empty
933 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
935 "\"\n(Try changing result type to IO ()\n")
937 process ress args ('%':cs)
940 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
943 char '%' <> process ress args css
947 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
948 [r] -> r <> (process [] args css)
949 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
953 read_int :: ReadS Int
956 case (read_int other) of
958 if 0 <= num && num < length args
959 then parens (args !! num) <> process ress args css
960 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
961 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
963 process ress args (other_c:cs)
964 = char other_c <> process ress args cs
967 %************************************************************************
969 \subsection[a2r-assignments]{Assignments}
971 %************************************************************************
973 Printing assignments is a little tricky because of type coercion.
975 First of all, the kind of the thing being assigned can be gotten from
976 the destination addressing mode. (It should be the same as the kind
977 of the source addressing mode.) If the kind of the assignment is of
978 @VoidRep@, then don't generate any code at all.
981 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
983 pprAssign VoidRep dest src = empty
986 Special treatment for floats and doubles, to avoid unwanted conversions.
989 pprAssign FloatRep dest@(CVal reg_rel _) src
990 = hcat [ ptext SLIT("ASSIGN_FLT"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
992 pprAssign DoubleRep dest@(CVal reg_rel _) src
993 = hcat [ ptext SLIT("ASSIGN_DBL"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
995 pprAssign Int64Rep dest@(CVal reg_rel _) src
996 = hcat [ ptext SLIT("ASSIGN_Int64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
997 pprAssign Word64Rep dest@(CVal reg_rel _) src
998 = hcat [ ptext SLIT("ASSIGN_Word64"),char '(', ppr_amode (CAddr reg_rel), comma, pprAmode src, pp_paren_semi ]
1001 Lastly, the question is: will the C compiler think the types of the
1002 two sides of the assignment match?
1004 We assume that the types will match if neither side is a
1005 @CVal@ addressing mode for any register which can point into
1008 Why? Because the heap and stack are used to store miscellaneous
1009 things, whereas the temporaries, registers, etc., are only used for
1010 things of fixed type.
1013 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1014 = hcat [ pprVanillaReg dest, equals,
1015 pprVanillaReg src, semi ]
1017 pprAssign kind dest src
1018 | mixedTypeLocn dest
1019 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1020 = hcat [ ppr_amode dest, equals,
1021 text "(W_)(", -- Here is the cast
1022 ppr_amode src, pp_paren_semi ]
1024 pprAssign kind dest src
1025 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1026 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1027 = hcat [ ppr_amode dest, equals,
1028 text "(P_)(", -- Here is the cast
1029 ppr_amode src, pp_paren_semi ]
1031 pprAssign ByteArrayRep dest src
1033 -- Add in a cast iff the source is mixed
1034 = hcat [ ppr_amode dest, equals,
1035 text "(StgByteArray)(", -- Here is the cast
1036 ppr_amode src, pp_paren_semi ]
1038 pprAssign kind other_dest src
1039 = hcat [ ppr_amode other_dest, equals,
1040 pprAmode src, semi ]
1044 %************************************************************************
1046 \subsection[a2r-CAddrModes]{Addressing modes}
1048 %************************************************************************
1050 @pprAmode@ is used to print r-values (which may need casts), whereas
1051 @ppr_amode@ is used for l-values {\em and} as a help function for
1055 pprAmode, ppr_amode :: CAddrMode -> SDoc
1058 For reasons discussed above under assignments, @CVal@ modes need
1059 to be treated carefully. First come special cases for floats and doubles,
1060 similar to those in @pprAssign@:
1062 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1066 pprAmode (CVal reg_rel FloatRep)
1067 = hcat [ text "PK_FLT(", ppr_amode (CAddr reg_rel), rparen ]
1068 pprAmode (CVal reg_rel DoubleRep)
1069 = hcat [ text "PK_DBL(", ppr_amode (CAddr reg_rel), rparen ]
1070 pprAmode (CVal reg_rel Int64Rep)
1071 = hcat [ text "PK_Int64(", ppr_amode (CAddr reg_rel), rparen ]
1072 pprAmode (CVal reg_rel Word64Rep)
1073 = hcat [ text "PK_Word64(", ppr_amode (CAddr reg_rel), rparen ]
1076 Next comes the case where there is some other cast need, and the
1081 | mixedTypeLocn amode
1082 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1084 | otherwise -- No cast needed
1088 When we have an indirection through a CIndex, we have to be careful to
1089 get the type casts right.
1093 CVal (CIndex kind1 base offset) kind2
1097 *(kind2 *)((kind1 *)base + offset)
1099 That is, the indexing is done in units of kind1, but the resulting
1103 ppr_amode (CVal reg_rel@(CIndex _ _ _) kind)
1104 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1105 (pp_reg, Nothing) -> panic "ppr_amode: CIndex"
1106 (pp_reg, Just offset) ->
1107 hcat [ char '*', parens (pprPrimKind kind <> char '*'),
1108 parens (pp_reg <> char '+' <> offset) ]
1111 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1114 ppr_amode (CVal reg_rel _)
1115 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1116 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1117 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1119 ppr_amode (CAddr reg_rel)
1120 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1121 (pp_reg, Nothing) -> pp_reg
1122 (pp_reg, Just offset) -> (<>) pp_reg offset
1124 ppr_amode (CReg magic_id) = pprMagicId magic_id
1126 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1128 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1130 ppr_amode (CCharLike ch)
1131 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1132 ppr_amode (CIntLike int)
1133 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1135 ppr_amode (CLit lit) = pprBasicLit lit
1137 ppr_amode (CJoinPoint _)
1138 = panic "ppr_amode: CJoinPoint"
1140 ppr_amode (CMacroExpr pk macro as)
1141 = parens (ptext (cExprMacroText macro) <>
1142 parens (hcat (punctuate comma (map pprAmode as))))
1146 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1147 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1148 cExprMacroText GET_TAG = SLIT("GET_TAG")
1149 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1150 cExprMacroText CCS_HDR = SLIT("CCS_HDR")
1152 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1153 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1154 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1155 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1156 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1157 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1158 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1159 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1160 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1161 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1162 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1163 cStmtMacroText REGISTER_DIMPORT = SLIT("REGISTER_DIMPORT")
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 (I# n)
1268 pprMagicId (DoubleReg n) = ptext SLIT("D") <> int (I# n)
1269 pprMagicId (LongReg _ n) = ptext SLIT("L") <> int (I# 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 :: Int# -> SDoc
1279 pprVanillaReg n = char 'R' <> int (I# 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 Int8Rep = ptext SLIT("i8")
1291 pprUnionTag IntRep = char 'i'
1292 pprUnionTag WordRep = char 'w'
1293 pprUnionTag AddrRep = char 'a'
1294 pprUnionTag FloatRep = char 'f'
1295 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1297 pprUnionTag StablePtrRep = char 'p'
1298 pprUnionTag StableNameRep = char 'p'
1299 pprUnionTag WeakPtrRep = char 'p'
1300 pprUnionTag ForeignObjRep = char 'p'
1301 pprUnionTag PrimPtrRep = char 'p'
1303 pprUnionTag ThreadIdRep = char 't'
1305 pprUnionTag ArrayRep = char 'p'
1306 pprUnionTag ByteArrayRep = char 'b'
1307 pprUnionTag BCORep = char 'p'
1309 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1313 Find and print local and external declarations for a list of
1314 Abstract~C statements.
1316 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1317 pprTempAndExternDecls AbsCNop = (empty, empty)
1319 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1320 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1321 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1322 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1323 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1324 returnTE (vcat real_temps, vcat real_exts) }}
1327 pprTempAndExternDecls other_stmt
1328 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1339 pprBasicLit :: Literal -> SDoc
1340 pprPrimKind :: PrimRep -> SDoc
1342 pprBasicLit lit = ppr lit
1343 pprPrimKind k = ppr k
1347 %************************************************************************
1349 \subsection[a2r-monad]{Monadery}
1351 %************************************************************************
1353 We need some monadery to keep track of temps and externs we have already
1354 printed. This info must be threaded right through the Abstract~C, so
1355 it's most convenient to hide it in this monad.
1357 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1358 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1361 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1362 emptyCLabelSet = emptyFM
1363 x `elementOfCLabelSet` labs
1364 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1366 addToCLabelSet set x = addToFM set x ()
1368 type TEenv = (UniqSet Unique, CLabelSet)
1370 type TeM result = TEenv -> (TEenv, result)
1372 initTE :: TeM a -> a
1374 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1377 {-# INLINE thenTE #-}
1378 {-# INLINE returnTE #-}
1380 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1382 = case a u of { (u_1, result_of_a) ->
1385 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1386 mapTE f [] = returnTE []
1388 = f x `thenTE` \ r ->
1389 mapTE f xs `thenTE` \ rs ->
1392 returnTE :: a -> TeM a
1393 returnTE result env = (env, result)
1395 -- these next two check whether the thing is already
1396 -- recorded, and THEN THEY RECORD IT
1397 -- (subsequent calls will return False for the same uniq/label)
1399 tempSeenTE :: Unique -> TeM Bool
1400 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1401 = if (uniq `elementOfUniqSet` seen_uniqs)
1403 else ((addOneToUniqSet seen_uniqs uniq,
1407 labelSeenTE :: CLabel -> TeM Bool
1408 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1409 = if (lbl `elementOfCLabelSet` seen_labels)
1412 addToCLabelSet seen_labels lbl),
1417 pprTempDecl :: Unique -> PrimRep -> SDoc
1418 pprTempDecl uniq kind
1419 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1421 pprExternDecl :: Bool -> CLabel -> SDoc
1422 pprExternDecl in_srt clabel
1423 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1425 hcat [ ppLocalnessMacro (not in_srt) clabel,
1426 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1429 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1435 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1437 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1439 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1440 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1441 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1442 returnTE (maybe_vcat [p1, p2])
1444 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1446 ppr_decls_AbsC (CAssign dest source)
1447 = ppr_decls_Amode dest `thenTE` \ p1 ->
1448 ppr_decls_Amode source `thenTE` \ p2 ->
1449 returnTE (maybe_vcat [p1, p2])
1451 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1453 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1455 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1457 ppr_decls_AbsC (CSwitch discrim alts deflt)
1458 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1459 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1460 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1461 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1463 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1465 ppr_decls_AbsC (CCodeBlock lbl absC)
1466 = ppr_decls_AbsC absC
1468 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre)
1469 -- ToDo: strictly speaking, should chk "cost_centre" amode
1470 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1475 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1477 info_lbl = infoTableLabelFromCI cl_info
1479 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1480 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1482 ppr_decls_AbsC (CCheck _ amodes code) =
1483 ppr_decls_Amodes amodes `thenTE` \p1 ->
1484 ppr_decls_AbsC code `thenTE` \p2 ->
1485 returnTE (maybe_vcat [p1,p2])
1487 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1489 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1490 -- you get some nasty re-decls of stdio.h if you compile
1491 -- the prelude while looking inside those amodes;
1492 -- no real reason to, anyway.
1493 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1495 ppr_decls_AbsC (CStaticClosure closure_lbl closure_info cost_centre amodes)
1496 -- ToDo: strictly speaking, should chk "cost_centre" amode
1497 = ppr_decls_Amodes amodes
1499 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1500 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1501 ppr_decls_AbsC slow `thenTE` \ p2 ->
1503 Nothing -> returnTE (Nothing, Nothing)
1504 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1505 returnTE (maybe_vcat [p1, p2, p3])
1507 entry_lbl = CLbl slow_lbl CodePtrRep
1508 slow_lbl = case (nonemptyAbsC slow) of
1509 Nothing -> mkErrorStdEntryLabel
1510 Just _ -> entryLabelFromCI cl_info
1512 ppr_decls_AbsC (CSRT _ closure_lbls)
1513 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1515 if and seen then Nothing
1516 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1517 | (l,False) <- zip closure_lbls seen ]))
1519 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1520 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1521 ppr_decls_AbsC (CModuleInitBlock _ code) = ppr_decls_AbsC code
1523 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1527 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1528 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1529 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1530 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1531 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1532 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1533 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1535 -- CIntLike must be a literal -- no decls
1536 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1539 ppr_decls_Amode (CCharLike char) = returnTE (Nothing, Nothing)
1541 -- now, the only place where we actually print temps/externs...
1542 ppr_decls_Amode (CTemp uniq kind)
1544 VoidRep -> returnTE (Nothing, Nothing)
1546 tempSeenTE uniq `thenTE` \ temp_seen ->
1548 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1550 ppr_decls_Amode (CLbl lbl VoidRep)
1551 = returnTE (Nothing, Nothing)
1553 ppr_decls_Amode (CLbl lbl kind)
1554 = labelSeenTE lbl `thenTE` \ label_seen ->
1556 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1558 ppr_decls_Amode (CMacroExpr _ _ amodes)
1559 = ppr_decls_Amodes amodes
1561 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1564 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1566 = case (unzip ps) of { (ts, es) ->
1567 case (catMaybes ts) of { real_ts ->
1568 case (catMaybes es) of { real_es ->
1569 (if (null real_ts) then Nothing else Just (vcat real_ts),
1570 if (null real_es) then Nothing else Just (vcat real_es))
1575 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1576 ppr_decls_Amodes amodes
1577 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1578 returnTE ( maybe_vcat ps )
1581 Print out a C Label where you want the *address* of the label, not the
1582 object it refers to. The distinction is important when the label may
1583 refer to a C structure (info tables and closures, for instance).
1585 When just generating a declaration for the label, use pprCLabel.
1588 pprCLabelAddr :: CLabel -> SDoc
1589 pprCLabelAddr clabel =
1590 case labelType clabel of
1591 InfoTblType -> addr_of_label
1592 ClosureType -> addr_of_label
1593 VecTblType -> addr_of_label
1596 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1597 pp_label = pprCLabel clabel
1601 -----------------------------------------------------------------------------
1602 Initialising static objects with floating-point numbers. We can't
1603 just emit the floating point number, because C will cast it to an int
1604 by rounding it. We want the actual bit-representation of the float.
1606 This is a hack to turn the floating point numbers into ints that we
1607 can safely initialise to static locations.
1610 big_doubles = (getPrimRepSize DoubleRep) /= 1
1612 -- floatss are always 1 word
1613 floatToWord :: CAddrMode -> CAddrMode
1614 floatToWord (CLit (MachFloat r))
1616 arr <- newFloatArray ((0::Int),0)
1617 writeFloatArray arr 0 (fromRational r)
1618 i <- readIntArray arr 0
1619 return (CLit (MachInt (toInteger i)))
1622 doubleToWords :: CAddrMode -> [CAddrMode]
1623 doubleToWords (CLit (MachDouble r))
1624 | big_doubles -- doubles are 2 words
1626 arr <- newDoubleArray ((0::Int),1)
1627 writeDoubleArray arr 0 (fromRational r)
1628 i1 <- readIntArray arr 0
1629 i2 <- readIntArray arr 1
1630 return [ CLit (MachInt (toInteger i1))
1631 , CLit (MachInt (toInteger i2))
1634 | otherwise -- doubles are 1 word
1636 arr <- newDoubleArray ((0::Int),0)
1637 writeDoubleArray arr 0 (fromRational r)
1638 i <- readIntArray arr 0
1639 return [ CLit (MachInt (toInteger i)) ]