2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
4 %************************************************************************
6 \section[PprAbsC]{Pretty-printing Abstract~C}
8 %************************************************************************
18 #include "HsVersions.h"
25 import AbsCUtils ( getAmodeRep, nonemptyAbsC,
26 mixedPtrLocn, mixedTypeLocn
29 import ForeignCall ( CCallSpec(..), CCallTarget(..), playSafe,
30 playThreadSafe, ccallConvAttribute )
31 import CLabel ( externallyVisibleCLabel,
32 needsCDecl, pprCLabel,
33 mkReturnInfoLabel, mkReturnPtLabel, mkClosureTblLabel,
34 mkClosureLabel, mkErrorStdEntryLabel,
35 CLabel, CLabelType(..), labelType, labelDynamic
38 import CmdLineOpts ( opt_SccProfilingOn, opt_GranMacros )
39 import CostCentre ( pprCostCentreDecl, pprCostCentreStackDecl )
41 import Costs ( costs, addrModeCosts, CostRes(..), Side(..) )
42 import CStrings ( pprStringInCStyle, pprCLabelString )
43 import FiniteMap ( addToFM, emptyFM, lookupFM, FiniteMap )
44 import Literal ( Literal(..) )
45 import TyCon ( tyConDataCons )
46 import Name ( NamedThing(..) )
47 import DataCon ( dataConWrapId )
48 import Maybes ( maybeToBool, catMaybes )
49 import PrimOp ( primOpNeedsWrapper )
50 import MachOp ( MachOp(..) )
51 import ForeignCall ( ForeignCall(..) )
52 import PrimRep ( isFloatingRep, PrimRep(..), getPrimRepSize )
53 import SMRep ( pprSMRep )
54 import Unique ( pprUnique, Unique{-instance NamedThing-} )
55 import UniqSet ( emptyUniqSet, elementOfUniqSet,
56 addOneToUniqSet, UniqSet
58 import StgSyn ( StgOp(..) )
59 import BitSet ( BitSet, intBS )
62 import Util ( lengthExceeds, listLengthCmp )
69 For spitting out the costs of an abstract~C expression, @writeRealC@
70 now not only prints the C~code of the @absC@ arg but also adds a macro
71 call to a cost evaluation function @GRAN_EXEC@. For that,
72 @pprAbsC@ has a new ``costs'' argument. %% HWL
76 writeRealC :: Handle -> AbstractC -> IO ()
77 writeRealC handle absC
78 -- avoid holding on to the whole of absC in the !Gransim case.
80 then printForCFast fp (pprAbsC absC (costs absC))
81 else printForCFast fp (pprAbsC absC (panic "costs"))
82 --printForC handle (pprAbsC absC (panic "costs"))
83 dumpRealC :: AbstractC -> SDoc
84 dumpRealC absC = pprAbsC absC (costs absC)
87 writeRealC :: Handle -> AbstractC -> IO ()
88 --writeRealC handle absC =
90 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
92 writeRealC handle absC
93 | opt_GranMacros = _scc_ "writeRealC" printForC handle $
94 pprCode CStyle (pprAbsC absC (costs absC))
95 | otherwise = _scc_ "writeRealC" printForC handle $
96 pprCode CStyle (pprAbsC absC (panic "costs"))
98 dumpRealC :: AbstractC -> SDoc
100 | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
101 | otherwise = pprCode CStyle (pprAbsC absC (panic "costs"))
105 This emits the macro, which is used in GrAnSim to compute the total costs
106 from a cost 5 tuple. %% HWL
109 emitMacro :: CostRes -> SDoc
111 emitMacro _ | not opt_GranMacros = empty
113 emitMacro (Cost (i,b,l,s,f))
114 = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
115 int i, comma, int b, comma, int l, comma,
116 int s, comma, int f, pp_paren_semi ]
118 pp_paren_semi = text ");"
121 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
122 code as an argument (that's needed when spitting out the GRAN_EXEC macro
123 which must be done before the return i.e. inside absC code) HWL
126 pprAbsC :: AbstractC -> CostRes -> SDoc
127 pprAbsC AbsCNop _ = empty
128 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
130 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
132 pprAbsC (CJump target) c
133 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CJump */"-} ])
134 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
136 pprAbsC (CFallThrough target) c
137 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CFallThrough */"-} ])
138 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
140 -- --------------------------------------------------------------------------
141 -- Spit out GRAN_EXEC macro immediately before the return HWL
143 pprAbsC (CReturn am return_info) c
144 = ($$) (hcat [emitMacro c {-WDP:, text "/* <---- CReturn */"-} ])
145 (hcat [text jmp_lit, target, pp_paren_semi ])
147 target = case return_info of
148 DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
150 DynamicVectoredReturn am' -> mk_vector (pprAmode am')
151 StaticVectoredReturn n -> mk_vector (int n) -- Always positive
152 mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
155 pprAbsC (CSplitMarker) _ = ptext SLIT("__STG_SPLIT_MARKER")
157 -- we optimise various degenerate cases of CSwitches.
159 -- --------------------------------------------------------------------------
160 -- Assume: CSwitch is also end of basic block
161 -- costs function yields nullCosts for whole switch
162 -- ==> inherited costs c are those of basic block up to switch
163 -- ==> inherit c + costs for the corresponding branch
165 -- --------------------------------------------------------------------------
167 pprAbsC (CSwitch discrim [] deflt) c
168 = pprAbsC deflt (c + costs deflt)
169 -- Empty alternative list => no costs for discrim as nothing cond. here HWL
171 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
172 = case (nonemptyAbsC deflt) of
173 Nothing -> -- one alt and no default
174 pprAbsC alt_code (c + costs alt_code)
175 -- Nothing conditional in here either HWL
177 Just dc -> -- make it an "if"
178 do_if_stmt discrim tag alt_code dc c
180 -- What problem is the re-ordering trying to solve ?
181 pprAbsC (CSwitch discrim [(tag1@(MachInt i1), alt_code1),
182 (tag2@(MachInt i2), alt_code2)] deflt) c
183 | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
185 do_if_stmt discrim tag1 alt_code1 alt_code2 c
187 do_if_stmt discrim tag2 alt_code2 alt_code1 c
189 empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
191 pprAbsC (CSwitch discrim alts deflt) c -- general case
192 | isFloatingRep (getAmodeRep discrim)
193 = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
196 hcat [text "switch (", pp_discrim, text ") {"],
197 nest 2 (vcat (map ppr_alt alts)),
198 (case (nonemptyAbsC deflt) of
201 nest 2 (vcat [ptext SLIT("default:"),
202 pprAbsC dc (c + switch_head_cost
204 ptext SLIT("break;")])),
211 = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
212 nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
213 (ptext SLIT("break;"))) ]
215 -- Costs for addressing header of switch and cond. branching -- HWL
216 switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
218 pprAbsC stmt@(COpStmt results (StgFCallOp fcall uniq) args vol_regs) _
219 = pprFCall fcall uniq args results vol_regs
221 pprAbsC stmt@(COpStmt results (StgPrimOp op) args vol_regs) _
223 non_void_args = grab_non_void_amodes args
224 non_void_results = grab_non_void_amodes results
225 -- if just one result, we print in the obvious "assignment" style;
226 -- if 0 or many results, we emit a macro call, w/ the results
227 -- followed by the arguments. The macro presumably knows which
230 the_op = ppr_op_call non_void_results non_void_args
231 -- liveness mask is *in* the non_void_args
233 if primOpNeedsWrapper op then
234 case (ppr_vol_regs vol_regs) of { (pp_saves, pp_restores) ->
243 ppr_op_call results args
244 = hcat [ ppr op, lparen,
245 hcat (punctuate comma (map ppr_op_result results)),
246 if null results || null args then empty else comma,
247 hcat (punctuate comma (map pprAmode args)),
250 ppr_op_result r = ppr_amode r
251 -- primop macros do their own casting of result;
252 -- hence we can toss the provided cast...
254 -- NEW CASES FOR EXPANDED PRIMOPS
256 pprAbsC stmt@(CMachOpStmt res mop [arg1,arg2] maybe_vols) _
257 = let prefix_fn = mop `elem` [MO_Dbl_Pwr, MO_Flt_Pwr, MO_NatS_MulMayOflo]
259 case ppr_maybe_vol_regs maybe_vols of {(saves,restores) ->
262 [ppr_amode res, equals]
264 then [pprMachOp_for_C mop, parens (pprAmode arg1 <> comma <> pprAmode arg2)]
265 else [pprAmode arg1, pprMachOp_for_C mop, pprAmode arg2])
271 pprAbsC stmt@(CMachOpStmt res mop [arg1] maybe_vols) _
272 = case ppr_maybe_vol_regs maybe_vols of {(saves,restores) ->
274 hcat [ppr_amode res, equals,
275 pprMachOp_for_C mop, parens (pprAmode arg1),
280 pprAbsC stmt@(CSequential stuff) c
281 = vcat (map (flip pprAbsC c) stuff)
283 -- end of NEW CASES FOR EXPANDED PRIMOPS
285 pprAbsC stmt@(CSRT lbl closures) c
286 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
288 $$ ptext SLIT("SRT") <> lparen <> pprCLabel lbl <> rparen
289 $$ nest 2 (hcat (punctuate comma (map pp_closure_lbl closures)))
293 pprAbsC stmt@(CBitmap lbl mask) c
294 = pp_bitmap_switch mask semi $
295 hcat [ ptext SLIT("BITMAP"), lparen,
296 pprCLabel lbl, comma,
297 int (length mask), comma,
298 pp_bitmap mask, rparen ]
300 pprAbsC (CSimultaneous abs_c) c
301 = hcat [ptext SLIT("{{"), pprAbsC abs_c c, ptext SLIT("}}")]
303 pprAbsC (CCheck macro as code) c
304 = hcat [ptext (cCheckMacroText macro), lparen,
305 hcat (punctuate comma (map ppr_amode as)), comma,
306 pprAbsC code c, pp_paren_semi
308 pprAbsC (CMacroStmt macro as) _
309 = hcat [ptext (cStmtMacroText macro), lparen,
310 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi] -- no casting
311 pprAbsC (CCallProfCtrMacro op as) _
312 = hcat [ptext op, lparen,
313 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
314 pprAbsC (CCallProfCCMacro op as) _
315 = hcat [ptext op, lparen,
316 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
317 pprAbsC stmt@(CCallTypedef is_tdef (CCallSpec op_str cconv _) uniq results args) _
318 = hsep [ ptext (if is_tdef then SLIT("typedef") else SLIT("extern"))
321 , parens (hsep (punctuate comma ccall_decl_ty_args))
325 In the non-casm case, to ensure that we're entering the given external
326 entry point using the correct calling convention, we have to do the following:
328 - When entering via a function pointer (the `dynamic' case) using the specified
329 calling convention, we emit a typedefn declaration attributed with the
330 calling convention to use together with the result and parameter types we're
331 assuming. Coerce the function pointer to this type and go.
333 - to enter the function at a given code label, we emit an extern declaration
334 for the label here, stating the calling convention together with result and
335 argument types we're assuming.
337 The C compiler will hopefully use this extern declaration to good effect,
338 reporting any discrepancies between our extern decl and any other that
341 Re: calling convention, notice that gcc (2.8.1 and egcs-1.0.2) will for
342 the external function `foo' use the calling convention of the first `foo'
343 prototype it encounters (nor does it complain about conflicting attribute
344 declarations). The consequence of this is that you cannot override the
345 calling convention of `foo' using an extern declaration (you'd have to use
346 a typedef), but why you would want to do such a thing in the first place
347 is totally beyond me.
349 ToDo: petition the gcc folks to add code to warn about conflicting attribute
355 | is_tdef = parens (text (ccallConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
356 | otherwise = text (ccallConvAttribute cconv) <+> ccall_fun_ty
360 DynamicTarget -> ptext SLIT("_ccall_fun_ty") <> ppr uniq
361 StaticTarget x -> pprCLabelString x
364 case non_void_results of
365 [] -> ptext SLIT("void")
366 [amode] -> ppr (getAmodeRep amode)
367 _ -> panic "pprAbsC{CCallTypedef}: ccall_res_ty"
370 | is_tdef = tail ccall_arg_tys
371 | otherwise = ccall_arg_tys
373 ccall_arg_tys = map (ppr . getAmodeRep) non_void_args
375 -- the first argument will be the "I/O world" token (a VoidRep)
376 -- all others should be non-void
379 in ASSERT (all non_void nvas) nvas
381 -- there will usually be two results: a (void) state which we
382 -- should ignore and a (possibly void) result.
384 let nvrs = grab_non_void_amodes results
385 in ASSERT (listLengthCmp nvrs 1 /= GT) nvrs
387 pprAbsC (CCodeBlock lbl abs_C) _
388 = if not (maybeToBool(nonemptyAbsC abs_C)) then
389 pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
391 case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
395 hcat [text (if (externallyVisibleCLabel lbl)
396 then "FN_(" -- abbreviations to save on output
398 pprCLabel lbl, text ") {"],
402 nest 8 (ptext SLIT("FB_")),
403 nest 8 (pprAbsC abs_C (costs abs_C)),
404 nest 8 (ptext SLIT("FE_")),
410 pprAbsC (CInitHdr cl_info amode cost_centre size) _
411 = hcat [ ptext SLIT("SET_HDR_"), char '(',
412 ppr_amode amode, comma,
413 pprCLabelAddr info_lbl, comma,
414 if_profiling (pprAmode cost_centre), comma,
415 if_profiling (int size),
418 info_lbl = infoTableLabelFromCI cl_info
421 pprAbsC stmt@(CStaticClosure cl_info cost_centre amodes) _
422 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
426 ptext SLIT("SET_STATIC_HDR"), char '(',
427 pprCLabel closure_lbl, comma,
428 pprCLabel info_lbl, comma,
429 if_profiling (pprAmode cost_centre), comma,
430 ppLocalness closure_lbl, comma,
431 ppLocalnessMacro True{-include dyn-} info_lbl,
434 nest 2 (ppr_payload amodes),
438 closure_lbl = closureLabelFromCI cl_info
439 info_lbl = infoTableLabelFromCI cl_info
441 ppr_payload [] = empty
444 (braces $ hsep $ punctuate comma $
445 map (text "(L_)" <>) (foldr ppr_item [] ls))
448 | rep == VoidRep = rest
449 | rep == FloatRep = ppr_amode (floatToWord item) : rest
450 | rep == DoubleRep = map ppr_amode (doubleToWords item) ++ rest
451 | otherwise = ppr_amode item : rest
453 rep = getAmodeRep item
456 pprAbsC stmt@(CClosureInfoAndCode cl_info slow maybe_fast cl_descr) _
459 ptext SLIT("INFO_TABLE"),
460 ( if is_selector then
461 ptext SLIT("_SELECTOR")
462 else if is_constr then
463 ptext SLIT("_CONSTR")
464 else if needs_srt then
466 else empty ), char '(',
468 pprCLabel info_lbl, comma,
469 pprCLabel slow_lbl, comma,
470 pp_rest, {- ptrs,nptrs,[srt,]type,-} comma,
472 ppLocalness info_lbl, comma,
473 ppLocalnessMacro True{-include dyn-} slow_lbl, comma,
475 if_profiling pp_descr, comma,
476 if_profiling pp_type,
482 Just fast -> let stuff = CCodeBlock fast_lbl fast in
483 pprAbsC stuff (costs stuff)
486 info_lbl = infoTableLabelFromCI cl_info
487 fast_lbl = fastLabelFromCI cl_info
490 = case (nonemptyAbsC slow) of
491 Nothing -> (mkErrorStdEntryLabel, empty)
492 Just xx -> (entryLabelFromCI cl_info,
493 let stuff = CCodeBlock slow_lbl xx in
494 pprAbsC stuff (costs stuff))
496 maybe_selector = maybeSelectorInfo cl_info
497 is_selector = maybeToBool maybe_selector
498 (Just select_word_i) = maybe_selector
500 maybe_tag = closureSemiTag cl_info
501 is_constr = maybeToBool maybe_tag
502 (Just tag) = maybe_tag
504 srt = closureSRT cl_info
505 needs_srt = case srt of
510 size = closureNonHdrSize cl_info
512 ptrs = closurePtrsSize cl_info
515 pp_rest | is_selector = int select_word_i
520 hcat [ int tag, comma ]
521 else if needs_srt then
526 type_str = pprSMRep (closureSMRep cl_info)
528 pp_descr = pprStringInCStyle cl_descr
529 pp_type = pprStringInCStyle (closureTypeDescr cl_info)
531 pprAbsC stmt@(CClosureTbl tycon) _
533 ptext SLIT("CLOSURE_TBL") <>
534 lparen <> pprCLabel (mkClosureTblLabel tycon) <> rparen :
536 map (pp_closure_lbl . mkClosureLabel . getName . dataConWrapId) (tyConDataCons tycon)
538 ) $$ ptext SLIT("};")
540 pprAbsC stmt@(CRetDirect uniq code srt liveness) _
543 ptext SLIT("INFO_TABLE_SRT_BITMAP"), lparen,
544 pprCLabel info_lbl, comma,
545 pprCLabel entry_lbl, comma,
546 pp_liveness liveness, comma, -- bitmap
547 pp_srt_info srt, -- SRT
548 closure_type, comma, -- closure type
549 ppLocalness info_lbl, comma, -- info table storage class
550 ppLocalnessMacro True{-include dyn-} entry_lbl, comma, -- entry pt storage class
557 info_lbl = mkReturnInfoLabel uniq
558 entry_lbl = mkReturnPtLabel uniq
560 pp_code = let stuff = CCodeBlock entry_lbl code in
561 pprAbsC stuff (costs stuff)
563 closure_type = pp_liveness_switch liveness
564 (ptext SLIT("RET_SMALL"))
565 (ptext SLIT("RET_BIG"))
567 pprAbsC stmt@(CRetVector lbl amodes srt liveness) _
568 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
572 ptext SLIT("VEC_INFO_") <> int size,
574 pprCLabel lbl, comma,
575 pp_liveness liveness, comma, -- bitmap liveness mask
576 pp_srt_info srt, -- SRT
578 ppLocalness lbl, comma
580 nest 2 (sep (punctuate comma (map ppr_item amodes))),
586 ppr_item item = (<>) (text "(F_) ") (ppr_amode item)
589 closure_type = pp_liveness_switch liveness
590 (ptext SLIT("RET_VEC_SMALL"))
591 (ptext SLIT("RET_VEC_BIG"))
594 pprAbsC stmt@(CModuleInitBlock lbl code) _
596 ptext SLIT("START_MOD_INIT") <> parens (pprCLabel lbl),
597 case (pprTempAndExternDecls stmt) of { (_, pp_exts) -> pp_exts },
598 pprAbsC code (costs code),
599 hcat [ptext SLIT("END_MOD_INIT"), lparen, rparen]
602 pprAbsC (CCostCentreDecl is_local cc) _ = pprCostCentreDecl is_local cc
603 pprAbsC (CCostCentreStackDecl ccs) _ = pprCostCentreStackDecl ccs
607 -- Print a CMachOp in a way suitable for emitting via C.
608 pprMachOp_for_C MO_Nat_Add = char '+'
609 pprMachOp_for_C MO_Nat_Sub = char '-'
610 pprMachOp_for_C MO_Nat_Eq = text "=="
611 pprMachOp_for_C MO_Nat_Ne = text "!="
613 pprMachOp_for_C MO_NatS_Ge = text ">="
614 pprMachOp_for_C MO_NatS_Le = text "<="
615 pprMachOp_for_C MO_NatS_Gt = text ">"
616 pprMachOp_for_C MO_NatS_Lt = text "<"
618 pprMachOp_for_C MO_NatU_Ge = text ">="
619 pprMachOp_for_C MO_NatU_Le = text "<="
620 pprMachOp_for_C MO_NatU_Gt = text ">"
621 pprMachOp_for_C MO_NatU_Lt = text "<"
623 pprMachOp_for_C MO_NatS_Mul = char '*'
624 pprMachOp_for_C MO_NatS_MulMayOflo = text "mulIntMayOflo"
625 pprMachOp_for_C MO_NatS_Quot = char '/'
626 pprMachOp_for_C MO_NatS_Rem = char '%'
627 pprMachOp_for_C MO_NatS_Neg = char '-'
629 pprMachOp_for_C MO_NatU_Mul = char '*'
630 pprMachOp_for_C MO_NatU_Quot = char '/'
631 pprMachOp_for_C MO_NatU_Rem = char '%'
633 pprMachOp_for_C MO_Nat_And = text "&"
634 pprMachOp_for_C MO_Nat_Or = text "|"
635 pprMachOp_for_C MO_Nat_Xor = text "^"
636 pprMachOp_for_C MO_Nat_Not = text "~"
637 pprMachOp_for_C MO_Nat_Shl = text "<<"
638 pprMachOp_for_C MO_Nat_Shr = text ">>"
639 pprMachOp_for_C MO_Nat_Sar = text ">>"
641 pprMachOp_for_C MO_32U_Eq = text "=="
642 pprMachOp_for_C MO_32U_Ne = text "!="
643 pprMachOp_for_C MO_32U_Ge = text ">="
644 pprMachOp_for_C MO_32U_Le = text "<="
645 pprMachOp_for_C MO_32U_Gt = text ">"
646 pprMachOp_for_C MO_32U_Lt = text "<"
648 pprMachOp_for_C MO_Dbl_Eq = text "=="
649 pprMachOp_for_C MO_Dbl_Ne = text "!="
650 pprMachOp_for_C MO_Dbl_Ge = text ">="
651 pprMachOp_for_C MO_Dbl_Le = text "<="
652 pprMachOp_for_C MO_Dbl_Gt = text ">"
653 pprMachOp_for_C MO_Dbl_Lt = text "<"
655 pprMachOp_for_C MO_Dbl_Add = text "+"
656 pprMachOp_for_C MO_Dbl_Sub = text "-"
657 pprMachOp_for_C MO_Dbl_Mul = text "*"
658 pprMachOp_for_C MO_Dbl_Div = text "/"
659 pprMachOp_for_C MO_Dbl_Pwr = text "pow"
661 pprMachOp_for_C MO_Dbl_Sin = text "sin"
662 pprMachOp_for_C MO_Dbl_Cos = text "cos"
663 pprMachOp_for_C MO_Dbl_Tan = text "tan"
664 pprMachOp_for_C MO_Dbl_Sinh = text "sinh"
665 pprMachOp_for_C MO_Dbl_Cosh = text "cosh"
666 pprMachOp_for_C MO_Dbl_Tanh = text "tanh"
667 pprMachOp_for_C MO_Dbl_Asin = text "asin"
668 pprMachOp_for_C MO_Dbl_Acos = text "acos"
669 pprMachOp_for_C MO_Dbl_Atan = text "atan"
670 pprMachOp_for_C MO_Dbl_Log = text "log"
671 pprMachOp_for_C MO_Dbl_Exp = text "exp"
672 pprMachOp_for_C MO_Dbl_Sqrt = text "sqrt"
673 pprMachOp_for_C MO_Dbl_Neg = text "-"
675 pprMachOp_for_C MO_Flt_Add = text "+"
676 pprMachOp_for_C MO_Flt_Sub = text "-"
677 pprMachOp_for_C MO_Flt_Mul = text "*"
678 pprMachOp_for_C MO_Flt_Div = text "/"
679 pprMachOp_for_C MO_Flt_Pwr = text "pow"
681 pprMachOp_for_C MO_Flt_Eq = text "=="
682 pprMachOp_for_C MO_Flt_Ne = text "!="
683 pprMachOp_for_C MO_Flt_Ge = text ">="
684 pprMachOp_for_C MO_Flt_Le = text "<="
685 pprMachOp_for_C MO_Flt_Gt = text ">"
686 pprMachOp_for_C MO_Flt_Lt = text "<"
688 pprMachOp_for_C MO_Flt_Sin = text "sin"
689 pprMachOp_for_C MO_Flt_Cos = text "cos"
690 pprMachOp_for_C MO_Flt_Tan = text "tan"
691 pprMachOp_for_C MO_Flt_Sinh = text "sinh"
692 pprMachOp_for_C MO_Flt_Cosh = text "cosh"
693 pprMachOp_for_C MO_Flt_Tanh = text "tanh"
694 pprMachOp_for_C MO_Flt_Asin = text "asin"
695 pprMachOp_for_C MO_Flt_Acos = text "acos"
696 pprMachOp_for_C MO_Flt_Atan = text "atan"
697 pprMachOp_for_C MO_Flt_Log = text "log"
698 pprMachOp_for_C MO_Flt_Exp = text "exp"
699 pprMachOp_for_C MO_Flt_Sqrt = text "sqrt"
700 pprMachOp_for_C MO_Flt_Neg = text "-"
702 pprMachOp_for_C MO_32U_to_NatS = text "(StgInt)"
703 pprMachOp_for_C MO_NatS_to_32U = text "(StgWord32)"
705 pprMachOp_for_C MO_NatS_to_Dbl = text "(StgDouble)"
706 pprMachOp_for_C MO_Dbl_to_NatS = text "(StgInt)"
708 pprMachOp_for_C MO_NatS_to_Flt = text "(StgFloat)"
709 pprMachOp_for_C MO_Flt_to_NatS = text "(StgInt)"
711 pprMachOp_for_C MO_NatS_to_NatU = text "(StgWord)"
712 pprMachOp_for_C MO_NatU_to_NatS = text "(StgInt)"
714 pprMachOp_for_C MO_NatS_to_NatP = text "(void*)"
715 pprMachOp_for_C MO_NatP_to_NatS = text "(StgInt)"
716 pprMachOp_for_C MO_NatU_to_NatP = text "(void*)"
717 pprMachOp_for_C MO_NatP_to_NatU = text "(StgWord)"
719 pprMachOp_for_C MO_Dbl_to_Flt = text "(StgFloat)"
720 pprMachOp_for_C MO_Flt_to_Dbl = text "(StgDouble)"
722 pprMachOp_for_C MO_8S_to_NatS = text "(StgInt8)(StgInt)"
723 pprMachOp_for_C MO_16S_to_NatS = text "(StgInt16)(StgInt)"
724 pprMachOp_for_C MO_32S_to_NatS = text "(StgInt32)(StgInt)"
726 pprMachOp_for_C MO_8U_to_NatU = text "(StgWord8)(StgWord)"
727 pprMachOp_for_C MO_16U_to_NatU = text "(StgWord16)(StgWord)"
728 pprMachOp_for_C MO_32U_to_NatU = text "(StgWord32)(StgWord)"
730 pprMachOp_for_C MO_8U_to_32U = text "(StgWord32)"
731 pprMachOp_for_C MO_32U_to_8U = text "(StgWord8)"
735 = if (externallyVisibleCLabel lbl)
737 else ptext SLIT("static ")
739 -- Horrible macros for declaring the types and locality of labels (see
742 ppLocalnessMacro include_dyn_prefix clabel =
747 ClosureType -> ptext SLIT("C_")
748 CodeType -> ptext SLIT("F_")
749 InfoTblType -> ptext SLIT("I_")
750 ClosureTblType -> ptext SLIT("CP_")
751 DataType -> ptext SLIT("D_")
754 is_visible = externallyVisibleCLabel clabel
755 label_type = labelType clabel
758 | is_visible = char 'E'
759 | otherwise = char 'I'
762 | include_dyn_prefix && labelDynamic clabel = char 'D'
770 grab_non_void_amodes amodes
771 = filter non_void amodes
774 = case (getAmodeRep amode) of
780 ppr_maybe_vol_regs :: Maybe [MagicId] -> (SDoc, SDoc)
781 ppr_maybe_vol_regs Nothing
783 ppr_maybe_vol_regs (Just vrs)
784 = case ppr_vol_regs vrs of
786 -> (pp_basic_saves $$ saves,
787 pp_basic_restores $$ restores)
789 ppr_vol_regs :: [MagicId] -> (SDoc, SDoc)
791 ppr_vol_regs [] = (empty, empty)
792 ppr_vol_regs (VoidReg:rs) = ppr_vol_regs rs
794 = let pp_reg = case r of
795 VanillaReg pk n -> pprVanillaReg n
797 (more_saves, more_restores) = ppr_vol_regs rs
799 (($$) ((<>) (ptext SLIT("CALLER_SAVE_")) pp_reg) more_saves,
800 ($$) ((<>) (ptext SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
802 -- pp_basic_{saves,restores}: The BaseReg, Sp, Su, Hp and
803 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
804 -- depending on the platform. (The "volatile regs" stuff handles all
805 -- other registers.) Just be *sure* BaseReg is OK before trying to do
806 -- anything else. The correct sequence of saves&restores are
807 -- encoded by the CALLER_*_SYSTEM macros.
808 pp_basic_saves = ptext SLIT("CALLER_SAVE_SYSTEM")
809 pp_basic_restores = ptext SLIT("CALLER_RESTORE_SYSTEM")
813 pp_srt_info NoC_SRT = hcat [ int 0, comma,
816 pp_srt_info (C_SRT lbl off len) = hcat [ pprCLabel lbl, comma,
823 | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
824 | otherwise = char '&' <> pprCLabel lbl
829 = if opt_SccProfilingOn
831 else char '0' -- leave it out!
832 -- ---------------------------------------------------------------------------
833 -- Changes for GrAnSim:
834 -- draw costs for computation in head of if into both branches;
835 -- as no abstractC data structure is given for the head, one is constructed
836 -- guessing unknown values and fed into the costs function
837 -- ---------------------------------------------------------------------------
839 do_if_stmt discrim tag alt_code deflt c
841 cond = hcat [ pprAmode discrim
844 , pprAmode (CLit tag)
846 -- to be absolutely sure that none of the
847 -- conversion rules hit, e.g.,
849 -- minInt is different to (int)minInt
851 -- in C (when minInt is a number not a constant
852 -- expression which evaluates to it.)
855 MachInt _ -> ptext SLIT("(I_)")
860 (addrModeCosts discrim Rhs) c
862 ppr_if_stmt pp_pred then_part else_part discrim_costs c
864 hcat [text "if (", pp_pred, text ") {"],
865 nest 8 (pprAbsC then_part (c + discrim_costs +
866 (Cost (0, 2, 0, 0, 0)) +
868 (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
869 nest 8 (pprAbsC else_part (c + discrim_costs +
870 (Cost (0, 1, 0, 0, 0)) +
873 {- Total costs = inherited costs (before if) + costs for accessing discrim
874 + costs for cond branch ( = (0, 1, 0, 0, 0) )
875 + costs for that alternative
879 Historical note: this used to be two separate cases -- one for `ccall'
880 and one for `casm'. To get round a potential limitation to only 10
881 arguments, the numbering of arguments in @process_casm@ was beefed up a
884 Some rough notes on generating code for @CCallOp@:
886 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
887 2) Save any essential registers (heap, stack, etc).
889 ToDo: If stable pointers are in use, these must be saved in a place
890 where the runtime system can get at them so that the Stg world can
891 be restarted during the call.
893 3) Save any temporary registers that are currently in use.
894 4) Do the call, putting result into a local variable
895 5) Restore essential registers
896 6) Restore temporaries
898 (This happens after restoration of essential registers because we
899 might need the @Base@ register to access all the others correctly.)
901 Otherwise, copy local variable into result register.
903 8) If ccall (not casm), declare the function being called as extern so
904 that C knows if it returns anything other than an int.
907 { ResultType _ccall_result;
910 _ccall_result = f( args );
914 return_reg = _ccall_result;
918 Amendment to the above: if we can GC, we have to:
920 * make sure we save all our registers away where the garbage collector
922 * be sure that there are no live registers or we're in trouble.
923 (This can cause problems if you try something foolish like passing
924 an array or a foreign obj to a _ccall_GC_ thing.)
925 * increment/decrement the @inCCallGC@ counter before/after the call so
926 that the runtime check that PerformGC is being used sensibly will work.
929 pprFCall call@(CCall (CCallSpec target cconv safety)) uniq args results vol_regs
932 declare_local_vars, -- local var for *result*
933 vcat local_arg_decls,
935 process_casm local_vars pp_non_void_args call_str,
941 (pp_saves, pp_restores) = ppr_vol_regs vol_regs
943 thread_macro_args = ppr_uniq_token <> comma <+>
944 text "rts" <> ppr (playThreadSafe safety)
945 ppr_uniq_token = text "tok_" <> ppr uniq
946 (pp_save_context, pp_restore_context)
947 | playSafe safety = ( text "{ I_" <+> ppr_uniq_token <>
948 text "; SUSPEND_THREAD" <> parens thread_macro_args <> semi
949 , text "RESUME_THREAD" <> parens thread_macro_args <> text ";}"
951 | otherwise = ( pp_basic_saves $$ pp_saves,
952 pp_basic_restores $$ pp_restores)
956 in ASSERT2 ( all non_void nvas, ppr call <+> hsep (map pprAmode args) )
958 -- the last argument will be the "I/O world" token (a VoidRep)
959 -- all others should be non-void
962 let nvrs = grab_non_void_amodes results
963 in ASSERT (listLengthCmp nvrs 1 /= GT) nvrs
964 -- there will usually be two results: a (void) state which we
965 -- should ignore and a (possibly void) result.
967 (local_arg_decls, pp_non_void_args)
968 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
970 (declare_local_vars, local_vars, assign_results)
971 = ppr_casm_results non_void_results
973 call_str = case target of
974 CasmTarget str -> _UNPK_ str
975 StaticTarget fn -> mk_ccall_str (pprCLabelString fn) ccall_args
976 DynamicTarget -> mk_ccall_str dyn_fun (tail ccall_args)
978 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
979 dyn_fun = parens (parens (ptext SLIT("_ccall_fun_ty") <> ppr uniq) <> text "%0")
982 -- Remainder only used for ccall
983 mk_ccall_str fun_name ccall_fun_args = showSDoc
985 if null non_void_results
988 lparen, fun_name, lparen,
989 hcat (punctuate comma ccall_fun_args),
994 If the argument is a heap object, we need to reach inside and pull out
995 the bit the C world wants to see. The only heap objects which can be
996 passed are @Array@s and @ByteArray@s.
999 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
1000 -- (a) decl and assignment, (b) local var to be used later
1002 ppr_casm_arg amode a_num
1004 a_kind = getAmodeRep amode
1005 pp_amode = pprAmode amode
1006 pp_kind = pprPrimKind a_kind
1008 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
1010 (arg_type, pp_amode2)
1013 -- for array arguments, pass a pointer to the body of the array
1014 -- (PTRS_ARR_CTS skips over all the header nonsense)
1015 ArrayRep -> (pp_kind,
1016 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
1017 ByteArrayRep -> (pp_kind,
1018 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
1020 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
1021 ForeignObjRep -> (pp_kind,
1022 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
1023 char '(', pp_amode, char ')'])
1025 other -> (pp_kind, pp_amode)
1028 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
1030 (declare_local_var, local_var)
1033 For l-values, the critical questions are:
1035 1) Are there any results at all?
1037 We only allow zero or one results.
1041 :: [CAddrMode] -- list of results (length <= 1)
1043 ( SDoc, -- declaration of any local vars
1044 [SDoc], -- list of result vars (same length as results)
1045 SDoc ) -- assignment (if any) of results in local var to registers
1048 = (empty, [], empty) -- no results
1050 ppr_casm_results [r]
1052 result_reg = ppr_amode r
1053 r_kind = getAmodeRep r
1055 local_var = ptext SLIT("_ccall_result")
1057 (result_type, assign_result)
1058 = (pprPrimKind r_kind,
1059 hcat [ result_reg, equals, local_var, semi ])
1061 declare_local_var = hcat [ result_type, space, local_var, semi ]
1063 (declare_local_var, [local_var], assign_result)
1066 = panic "ppr_casm_results: ccall/casm with many results"
1070 Note the sneaky way _the_ result is represented by a list so that we
1071 can complain if it's used twice.
1073 ToDo: Any chance of giving line numbers when process-casm fails?
1074 Or maybe we should do a check _much earlier_ in compiler. ADR
1077 process_casm :: [SDoc] -- results (length <= 1)
1078 -> [SDoc] -- arguments
1079 -> String -- format string (with embedded %'s)
1080 -> SDoc -- code being generated
1082 process_casm results args string = process results args string
1084 process [] _ "" = empty
1085 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
1087 "\"\n(Try changing result type to IO ()\n")
1089 process ress args ('%':cs)
1092 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
1095 char '%' <> process ress args css
1099 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
1100 [r] -> r <> (process [] args css)
1101 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
1105 read_int :: ReadS Int
1108 case (read_int other) of
1110 if num >= 0 && args `lengthExceeds` num
1111 then parens (args !! num) <> process ress args css
1112 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
1113 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
1115 process ress args (other_c:cs)
1116 = char other_c <> process ress args cs
1119 %************************************************************************
1121 \subsection[a2r-assignments]{Assignments}
1123 %************************************************************************
1125 Printing assignments is a little tricky because of type coercion.
1127 First of all, the kind of the thing being assigned can be gotten from
1128 the destination addressing mode. (It should be the same as the kind
1129 of the source addressing mode.) If the kind of the assignment is of
1130 @VoidRep@, then don't generate any code at all.
1133 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
1135 pprAssign VoidRep dest src = empty
1138 Special treatment for floats and doubles, to avoid unwanted conversions.
1141 pprAssign FloatRep dest@(CVal reg_rel _) src
1142 = hcat [ ptext SLIT("ASSIGN_FLT((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1144 pprAssign DoubleRep dest@(CVal reg_rel _) src
1145 = hcat [ ptext SLIT("ASSIGN_DBL((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1147 pprAssign Int64Rep dest@(CVal reg_rel _) src
1148 = hcat [ ptext SLIT("ASSIGN_Int64((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1149 pprAssign Word64Rep dest@(CVal reg_rel _) src
1150 = hcat [ ptext SLIT("ASSIGN_Word64((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1153 Lastly, the question is: will the C compiler think the types of the
1154 two sides of the assignment match?
1156 We assume that the types will match if neither side is a
1157 @CVal@ addressing mode for any register which can point into
1160 Why? Because the heap and stack are used to store miscellaneous
1161 things, whereas the temporaries, registers, etc., are only used for
1162 things of fixed type.
1165 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1166 = hcat [ pprVanillaReg dest, equals,
1167 pprVanillaReg src, semi ]
1169 pprAssign kind dest src
1170 | mixedTypeLocn dest
1171 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1172 = hcat [ ppr_amode dest, equals,
1173 text "(W_)(", -- Here is the cast
1174 ppr_amode src, pp_paren_semi ]
1176 pprAssign kind dest src
1177 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1178 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1179 = hcat [ ppr_amode dest, equals,
1180 text "(P_)(", -- Here is the cast
1181 ppr_amode src, pp_paren_semi ]
1183 pprAssign ByteArrayRep dest src
1185 -- Add in a cast iff the source is mixed
1186 = hcat [ ppr_amode dest, equals,
1187 text "(StgByteArray)(", -- Here is the cast
1188 ppr_amode src, pp_paren_semi ]
1190 pprAssign kind other_dest src
1191 = hcat [ ppr_amode other_dest, equals,
1192 pprAmode src, semi ]
1196 %************************************************************************
1198 \subsection[a2r-CAddrModes]{Addressing modes}
1200 %************************************************************************
1202 @pprAmode@ is used to print r-values (which may need casts), whereas
1203 @ppr_amode@ is used for l-values {\em and} as a help function for
1207 pprAmode, ppr_amode :: CAddrMode -> SDoc
1210 For reasons discussed above under assignments, @CVal@ modes need
1211 to be treated carefully. First come special cases for floats and doubles,
1212 similar to those in @pprAssign@:
1214 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1218 pprAmode (CVal reg_rel FloatRep)
1219 = hcat [ text "PK_FLT((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1220 pprAmode (CVal reg_rel DoubleRep)
1221 = hcat [ text "PK_DBL((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1222 pprAmode (CVal reg_rel Int64Rep)
1223 = hcat [ text "PK_Int64((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1224 pprAmode (CVal reg_rel Word64Rep)
1225 = hcat [ text "PK_Word64((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1228 Next comes the case where there is some other cast need, and the
1233 | mixedTypeLocn amode
1234 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1236 | otherwise -- No cast needed
1240 When we have an indirection through a CIndex, we have to be careful to
1241 get the type casts right.
1245 CVal (CIndex kind1 base offset) kind2
1249 *(kind2 *)((kind1 *)base + offset)
1251 That is, the indexing is done in units of kind1, but the resulting
1255 ppr_amode CBytesPerWord
1256 = text "(sizeof(void*))"
1258 ppr_amode (CVal reg_rel@(CIndex _ _ _) kind)
1259 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1260 (pp_reg, Nothing) -> panic "ppr_amode: CIndex"
1261 (pp_reg, Just offset) ->
1262 hcat [ char '*', parens (pprPrimKind kind <> char '*'),
1263 parens (pp_reg <> char '+' <> offset) ]
1266 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1269 ppr_amode (CVal reg_rel _)
1270 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1271 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1272 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1274 ppr_amode (CAddr reg_rel)
1275 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1276 (pp_reg, Nothing) -> pp_reg
1277 (pp_reg, Just offset) -> (<>) pp_reg offset
1279 ppr_amode (CReg magic_id) = pprMagicId magic_id
1281 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1283 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1285 ppr_amode (CCharLike ch)
1286 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1287 ppr_amode (CIntLike int)
1288 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1290 ppr_amode (CLit lit) = pprBasicLit lit
1292 ppr_amode (CJoinPoint _)
1293 = panic "ppr_amode: CJoinPoint"
1295 ppr_amode (CMacroExpr pk macro as)
1296 = parens (ptext (cExprMacroText macro) <>
1297 parens (hcat (punctuate comma (map pprAmode as))))
1301 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1302 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1303 cExprMacroText GET_TAG = SLIT("GET_TAG")
1304 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1305 cExprMacroText CCS_HDR = SLIT("CCS_HDR")
1307 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1308 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1309 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1310 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1311 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1312 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1313 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1314 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1315 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1316 cStmtMacroText DATA_TO_TAGZH = SLIT("dataToTagzh")
1317 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1318 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1319 cStmtMacroText REGISTER_DIMPORT = SLIT("REGISTER_DIMPORT")
1320 cStmtMacroText GRAN_FETCH = SLIT("GRAN_FETCH")
1321 cStmtMacroText GRAN_RESCHEDULE = SLIT("GRAN_RESCHEDULE")
1322 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1323 cStmtMacroText THREAD_CONTEXT_SWITCH = SLIT("THREAD_CONTEXT_SWITCH")
1324 cStmtMacroText GRAN_YIELD = SLIT("GRAN_YIELD")
1326 cCheckMacroText HP_CHK_NP = SLIT("HP_CHK_NP")
1327 cCheckMacroText STK_CHK_NP = SLIT("STK_CHK_NP")
1328 cCheckMacroText HP_STK_CHK_NP = SLIT("HP_STK_CHK_NP")
1329 cCheckMacroText HP_CHK_SEQ_NP = SLIT("HP_CHK_SEQ_NP")
1330 cCheckMacroText HP_CHK = SLIT("HP_CHK")
1331 cCheckMacroText STK_CHK = SLIT("STK_CHK")
1332 cCheckMacroText HP_STK_CHK = SLIT("HP_STK_CHK")
1333 cCheckMacroText HP_CHK_NOREGS = SLIT("HP_CHK_NOREGS")
1334 cCheckMacroText HP_CHK_UNPT_R1 = SLIT("HP_CHK_UNPT_R1")
1335 cCheckMacroText HP_CHK_UNBX_R1 = SLIT("HP_CHK_UNBX_R1")
1336 cCheckMacroText HP_CHK_F1 = SLIT("HP_CHK_F1")
1337 cCheckMacroText HP_CHK_D1 = SLIT("HP_CHK_D1")
1338 cCheckMacroText HP_CHK_L1 = SLIT("HP_CHK_L1")
1339 cCheckMacroText HP_CHK_UT_ALT = SLIT("HP_CHK_UT_ALT")
1340 cCheckMacroText HP_CHK_GEN = SLIT("HP_CHK_GEN")
1346 %************************************************************************
1348 \subsection[ppr-liveness-masks]{Liveness Masks}
1350 %************************************************************************
1353 pp_bitmap_switch :: [BitSet] -> SDoc -> SDoc -> SDoc
1354 pp_bitmap_switch ([ ]) small large = small
1355 pp_bitmap_switch ([_ ]) small large = small
1356 pp_bitmap_switch ([_,_]) small large = hcat
1357 [ptext SLIT("BITMAP_SWITCH64"), lparen, small, comma, large, rparen]
1358 pp_bitmap_switch (_ ) small large = large
1360 pp_liveness_switch :: Liveness -> SDoc -> SDoc -> SDoc
1361 pp_liveness_switch (Liveness lbl mask) = pp_bitmap_switch mask
1363 pp_bitset :: BitSet -> SDoc
1365 | i < -1 = int (i + 1) <> text "-1"
1369 pp_bitmap :: [BitSet] -> SDoc
1370 pp_bitmap [] = int 0
1371 pp_bitmap ss = hcat (punctuate delayed_comma (bundle ss)) where
1372 delayed_comma = hcat [space, ptext SLIT("COMMA"), space]
1374 bundle [s] = [hcat bitmap32]
1375 where bitmap32 = [ptext SLIT("BITMAP32"), lparen,
1376 pp_bitset s, rparen]
1377 bundle (s1:s2:ss) = hcat bitmap64 : bundle ss
1378 where bitmap64 = [ptext SLIT("BITMAP64"), lparen,
1379 pp_bitset s1, comma, pp_bitset s2, rparen]
1381 pp_liveness :: Liveness -> SDoc
1382 pp_liveness (Liveness lbl mask)
1383 = pp_bitmap_switch mask (pp_bitmap mask) (char '&' <> pprCLabel lbl)
1386 %************************************************************************
1388 \subsection[a2r-MagicIds]{Magic ids}
1390 %************************************************************************
1392 @pprRegRelative@ returns a pair of the @Doc@ for the register
1393 (some casting may be required), and a @Maybe Doc@ for the offset
1394 (zero offset gives a @Nothing@).
1397 addPlusSign :: Bool -> SDoc -> SDoc
1398 addPlusSign False p = p
1399 addPlusSign True p = (<>) (char '+') p
1401 pprSignedInt :: Bool -> Int -> Maybe SDoc -- Nothing => 0
1402 pprSignedInt sign_wanted n
1403 = if n == 0 then Nothing else
1404 if n > 0 then Just (addPlusSign sign_wanted (int n))
1407 pprRegRelative :: Bool -- True <=> Print leading plus sign (if +ve)
1409 -> (SDoc, Maybe SDoc)
1411 pprRegRelative sign_wanted (SpRel off)
1412 = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1414 pprRegRelative sign_wanted r@(HpRel o)
1415 = let pp_Hp = pprMagicId Hp; off = I# o
1420 (pp_Hp, Just ((<>) (char '-') (int off)))
1422 pprRegRelative sign_wanted (NodeRel o)
1423 = let pp_Node = pprMagicId node; off = I# o
1428 (pp_Node, Just (addPlusSign sign_wanted (int off)))
1430 pprRegRelative sign_wanted (CIndex base offset kind)
1431 = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1432 , Just (hcat [if sign_wanted then char '+' else empty,
1433 text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1437 @pprMagicId@ just prints the register name. @VanillaReg@ registers are
1438 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1439 to select the union tag.
1442 pprMagicId :: MagicId -> SDoc
1444 pprMagicId BaseReg = ptext SLIT("BaseReg")
1445 pprMagicId (VanillaReg pk n)
1446 = hcat [ pprVanillaReg n, char '.',
1448 pprMagicId (FloatReg n) = ptext SLIT("F") <> int (I# n)
1449 pprMagicId (DoubleReg n) = ptext SLIT("D") <> int (I# n)
1450 pprMagicId (LongReg _ n) = ptext SLIT("L") <> int (I# n)
1451 pprMagicId Sp = ptext SLIT("Sp")
1452 pprMagicId Su = ptext SLIT("Su")
1453 pprMagicId SpLim = ptext SLIT("SpLim")
1454 pprMagicId Hp = ptext SLIT("Hp")
1455 pprMagicId HpLim = ptext SLIT("HpLim")
1456 pprMagicId CurCostCentre = ptext SLIT("CCCS")
1457 pprMagicId VoidReg = panic "pprMagicId:VoidReg!"
1459 pprVanillaReg :: Int# -> SDoc
1460 pprVanillaReg n = char 'R' <> int (I# n)
1462 pprUnionTag :: PrimRep -> SDoc
1464 pprUnionTag PtrRep = char 'p'
1465 pprUnionTag CodePtrRep = ptext SLIT("fp")
1466 pprUnionTag DataPtrRep = char 'd'
1467 pprUnionTag RetRep = char 'p'
1468 pprUnionTag CostCentreRep = panic "pprUnionTag:CostCentre?"
1470 pprUnionTag CharRep = char 'c'
1471 pprUnionTag Int8Rep = ptext SLIT("i8")
1472 pprUnionTag IntRep = char 'i'
1473 pprUnionTag WordRep = char 'w'
1474 pprUnionTag Int32Rep = char 'i'
1475 pprUnionTag Word32Rep = char 'w'
1476 pprUnionTag AddrRep = char 'a'
1477 pprUnionTag FloatRep = char 'f'
1478 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1480 pprUnionTag StablePtrRep = char 'p'
1481 pprUnionTag StableNameRep = char 'p'
1482 pprUnionTag WeakPtrRep = char 'p'
1483 pprUnionTag ForeignObjRep = char 'p'
1484 pprUnionTag PrimPtrRep = char 'p'
1486 pprUnionTag ThreadIdRep = char 't'
1488 pprUnionTag ArrayRep = char 'p'
1489 pprUnionTag ByteArrayRep = char 'b'
1490 pprUnionTag BCORep = char 'p'
1492 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1496 Find and print local and external declarations for a list of
1497 Abstract~C statements.
1499 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1500 pprTempAndExternDecls AbsCNop = (empty, empty)
1502 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1503 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1504 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1505 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1506 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1507 returnTE (vcat real_temps, vcat real_exts) }}
1510 pprTempAndExternDecls other_stmt
1511 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1522 pprBasicLit :: Literal -> SDoc
1523 pprPrimKind :: PrimRep -> SDoc
1525 pprBasicLit lit = ppr lit
1526 pprPrimKind k = ppr k
1530 %************************************************************************
1532 \subsection[a2r-monad]{Monadery}
1534 %************************************************************************
1536 We need some monadery to keep track of temps and externs we have already
1537 printed. This info must be threaded right through the Abstract~C, so
1538 it's most convenient to hide it in this monad.
1540 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1541 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1544 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1545 emptyCLabelSet = emptyFM
1546 x `elementOfCLabelSet` labs
1547 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1549 addToCLabelSet set x = addToFM set x ()
1551 type TEenv = (UniqSet Unique, CLabelSet)
1553 type TeM result = TEenv -> (TEenv, result)
1555 initTE :: TeM a -> a
1557 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1560 {-# INLINE thenTE #-}
1561 {-# INLINE returnTE #-}
1563 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1565 = case a u of { (u_1, result_of_a) ->
1568 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1569 mapTE f [] = returnTE []
1571 = f x `thenTE` \ r ->
1572 mapTE f xs `thenTE` \ rs ->
1575 returnTE :: a -> TeM a
1576 returnTE result env = (env, result)
1578 -- these next two check whether the thing is already
1579 -- recorded, and THEN THEY RECORD IT
1580 -- (subsequent calls will return False for the same uniq/label)
1582 tempSeenTE :: Unique -> TeM Bool
1583 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1584 = if (uniq `elementOfUniqSet` seen_uniqs)
1586 else ((addOneToUniqSet seen_uniqs uniq,
1590 labelSeenTE :: CLabel -> TeM Bool
1591 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1592 = if (lbl `elementOfCLabelSet` seen_labels)
1595 addToCLabelSet seen_labels lbl),
1600 pprTempDecl :: Unique -> PrimRep -> SDoc
1601 pprTempDecl uniq kind
1602 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1604 pprExternDecl :: Bool -> CLabel -> SDoc
1605 pprExternDecl in_srt clabel
1606 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1608 hcat [ ppLocalnessMacro (not in_srt) clabel,
1609 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1612 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1618 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1620 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1622 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1623 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1624 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1625 returnTE (maybe_vcat [p1, p2])
1627 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1629 ppr_decls_AbsC (CAssign dest source)
1630 = ppr_decls_Amode dest `thenTE` \ p1 ->
1631 ppr_decls_Amode source `thenTE` \ p2 ->
1632 returnTE (maybe_vcat [p1, p2])
1634 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1636 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1638 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1640 ppr_decls_AbsC (CSwitch discrim alts deflt)
1641 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1642 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1643 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1644 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1646 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1648 ppr_decls_AbsC (CCodeBlock lbl absC)
1649 = ppr_decls_AbsC absC
1651 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre _)
1652 -- ToDo: strictly speaking, should chk "cost_centre" amode
1653 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1658 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1660 info_lbl = infoTableLabelFromCI cl_info
1662 ppr_decls_AbsC (CMachOpStmt res _ args _) = ppr_decls_Amodes (res : args)
1663 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1665 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1667 ppr_decls_AbsC (CSequential abcs)
1668 = mapTE ppr_decls_AbsC abcs `thenTE` \ t_and_e_s ->
1669 returnTE (maybe_vcat t_and_e_s)
1671 ppr_decls_AbsC (CCheck _ amodes code) =
1672 ppr_decls_Amodes amodes `thenTE` \p1 ->
1673 ppr_decls_AbsC code `thenTE` \p2 ->
1674 returnTE (maybe_vcat [p1,p2])
1676 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1678 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1679 -- you get some nasty re-decls of stdio.h if you compile
1680 -- the prelude while looking inside those amodes;
1681 -- no real reason to, anyway.
1682 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1684 ppr_decls_AbsC (CStaticClosure closure_info cost_centre amodes)
1685 -- ToDo: strictly speaking, should chk "cost_centre" amode
1686 = ppr_decls_Amodes amodes
1688 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1689 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1690 ppr_decls_AbsC slow `thenTE` \ p2 ->
1692 Nothing -> returnTE (Nothing, Nothing)
1693 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1694 returnTE (maybe_vcat [p1, p2, p3])
1696 entry_lbl = CLbl slow_lbl CodePtrRep
1697 slow_lbl = case (nonemptyAbsC slow) of
1698 Nothing -> mkErrorStdEntryLabel
1699 Just _ -> entryLabelFromCI cl_info
1701 ppr_decls_AbsC (CSRT _ closure_lbls)
1702 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1704 if and seen then Nothing
1705 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1706 | (l,False) <- zip closure_lbls seen ]))
1708 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1709 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1710 ppr_decls_AbsC (CModuleInitBlock _ code) = ppr_decls_AbsC code
1712 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1716 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1717 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1718 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1719 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1720 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1721 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1722 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1724 -- CIntLike must be a literal -- no decls
1725 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1728 ppr_decls_Amode (CCharLike char) = returnTE (Nothing, Nothing)
1730 -- now, the only place where we actually print temps/externs...
1731 ppr_decls_Amode (CTemp uniq kind)
1733 VoidRep -> returnTE (Nothing, Nothing)
1735 tempSeenTE uniq `thenTE` \ temp_seen ->
1737 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1739 ppr_decls_Amode (CLbl lbl VoidRep)
1740 = returnTE (Nothing, Nothing)
1742 ppr_decls_Amode (CLbl lbl kind)
1743 = labelSeenTE lbl `thenTE` \ label_seen ->
1745 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1747 ppr_decls_Amode (CMacroExpr _ _ amodes)
1748 = ppr_decls_Amodes amodes
1750 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1753 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1755 = case (unzip ps) of { (ts, es) ->
1756 case (catMaybes ts) of { real_ts ->
1757 case (catMaybes es) of { real_es ->
1758 (if (null real_ts) then Nothing else Just (vcat real_ts),
1759 if (null real_es) then Nothing else Just (vcat real_es))
1764 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1765 ppr_decls_Amodes amodes
1766 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1767 returnTE ( maybe_vcat ps )
1770 Print out a C Label where you want the *address* of the label, not the
1771 object it refers to. The distinction is important when the label may
1772 refer to a C structure (info tables and closures, for instance).
1774 When just generating a declaration for the label, use pprCLabel.
1777 pprCLabelAddr :: CLabel -> SDoc
1778 pprCLabelAddr clabel =
1779 case labelType clabel of
1780 InfoTblType -> addr_of_label
1781 ClosureType -> addr_of_label
1782 VecTblType -> addr_of_label
1785 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1786 pp_label = pprCLabel clabel
1790 -----------------------------------------------------------------------------
1791 Initialising static objects with floating-point numbers. We can't
1792 just emit the floating point number, because C will cast it to an int
1793 by rounding it. We want the actual bit-representation of the float.
1795 This is a hack to turn the floating point numbers into ints that we
1796 can safely initialise to static locations.
1799 big_doubles = (getPrimRepSize DoubleRep) /= 1
1801 -- floatss are always 1 word
1802 floatToWord :: CAddrMode -> CAddrMode
1803 floatToWord (CLit (MachFloat r))
1805 arr <- newFloatArray ((0::Int),0)
1806 writeFloatArray arr 0 (fromRational r)
1807 i <- readIntArray arr 0
1808 return (CLit (MachInt (toInteger i)))
1811 doubleToWords :: CAddrMode -> [CAddrMode]
1812 doubleToWords (CLit (MachDouble r))
1813 | big_doubles -- doubles are 2 words
1815 arr <- newDoubleArray ((0::Int),1)
1816 writeDoubleArray arr 0 (fromRational r)
1817 i1 <- readIntArray arr 0
1818 i2 <- readIntArray arr 1
1819 return [ CLit (MachInt (toInteger i1))
1820 , CLit (MachInt (toInteger i2))
1823 | otherwise -- doubles are 1 word
1825 arr <- newDoubleArray ((0::Int),0)
1826 writeDoubleArray arr 0 (fromRational r)
1827 i <- readIntArray arr 0
1828 return [ CLit (MachInt (toInteger i)) ]