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 )
63 import Util ( lengthExceeds, listLengthCmp )
70 For spitting out the costs of an abstract~C expression, @writeRealC@
71 now not only prints the C~code of the @absC@ arg but also adds a macro
72 call to a cost evaluation function @GRAN_EXEC@. For that,
73 @pprAbsC@ has a new ``costs'' argument. %% HWL
77 writeRealC :: Handle -> AbstractC -> IO ()
78 writeRealC handle absC
79 -- avoid holding on to the whole of absC in the !Gransim case.
81 then printForCFast fp (pprAbsC absC (costs absC))
82 else printForCFast fp (pprAbsC absC (panic "costs"))
83 --printForC handle (pprAbsC absC (panic "costs"))
84 dumpRealC :: AbstractC -> SDoc
85 dumpRealC absC = pprAbsC absC (costs absC)
88 writeRealC :: Handle -> AbstractC -> IO ()
89 --writeRealC handle absC =
91 -- printDoc LeftMode handle (pprAbsC absC (costs absC))
93 writeRealC handle absC
94 | opt_GranMacros = _scc_ "writeRealC" printForC handle $
95 pprCode CStyle (pprAbsC absC (costs absC))
96 | otherwise = _scc_ "writeRealC" printForC handle $
97 pprCode CStyle (pprAbsC absC (panic "costs"))
99 dumpRealC :: AbstractC -> SDoc
101 | opt_GranMacros = pprCode CStyle (pprAbsC absC (costs absC))
102 | otherwise = pprCode CStyle (pprAbsC absC (panic "costs"))
106 This emits the macro, which is used in GrAnSim to compute the total costs
107 from a cost 5 tuple. %% HWL
110 emitMacro :: CostRes -> SDoc
112 emitMacro _ | not opt_GranMacros = empty
114 emitMacro (Cost (i,b,l,s,f))
115 = hcat [ ptext SLIT("GRAN_EXEC"), char '(',
116 int i, comma, int b, comma, int l, comma,
117 int s, comma, int f, pp_paren_semi ]
119 pp_paren_semi = text ");"
122 New type: Now pprAbsC also takes the costs for evaluating the Abstract C
123 code as an argument (that's needed when spitting out the GRAN_EXEC macro
124 which must be done before the return i.e. inside absC code) HWL
127 pprAbsC :: AbstractC -> CostRes -> SDoc
128 pprAbsC AbsCNop _ = empty
129 pprAbsC (AbsCStmts s1 s2) c = ($$) (pprAbsC s1 c) (pprAbsC s2 c)
131 pprAbsC (CAssign dest src) _ = pprAssign (getAmodeRep dest) dest src
133 pprAbsC (CJump target) c
134 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CJump */"-} ])
135 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
137 pprAbsC (CFallThrough target) c
138 = ($$) (hcat [emitMacro c {-WDP:, text "/* <--++ CFallThrough */"-} ])
139 (hcat [ text jmp_lit, pprAmode target, pp_paren_semi ])
141 -- --------------------------------------------------------------------------
142 -- Spit out GRAN_EXEC macro immediately before the return HWL
144 pprAbsC (CReturn am return_info) c
145 = ($$) (hcat [emitMacro c {-WDP:, text "/* <---- CReturn */"-} ])
146 (hcat [text jmp_lit, target, pp_paren_semi ])
148 target = case return_info of
149 DirectReturn -> hcat [ptext SLIT("ENTRY_CODE"), lparen,
151 DynamicVectoredReturn am' -> mk_vector (pprAmode am')
152 StaticVectoredReturn n -> mk_vector (int n) -- Always positive
153 mk_vector x = hcat [ptext SLIT("RET_VEC"), char '(', pprAmode am, comma,
156 pprAbsC (CSplitMarker) _ = ptext SLIT("__STG_SPLIT_MARKER")
158 -- we optimise various degenerate cases of CSwitches.
160 -- --------------------------------------------------------------------------
161 -- Assume: CSwitch is also end of basic block
162 -- costs function yields nullCosts for whole switch
163 -- ==> inherited costs c are those of basic block up to switch
164 -- ==> inherit c + costs for the corresponding branch
166 -- --------------------------------------------------------------------------
168 pprAbsC (CSwitch discrim [] deflt) c
169 = pprAbsC deflt (c + costs deflt)
170 -- Empty alternative list => no costs for discrim as nothing cond. here HWL
172 pprAbsC (CSwitch discrim [(tag,alt_code)] deflt) c -- only one alt
173 = case (nonemptyAbsC deflt) of
174 Nothing -> -- one alt and no default
175 pprAbsC alt_code (c + costs alt_code)
176 -- Nothing conditional in here either HWL
178 Just dc -> -- make it an "if"
179 do_if_stmt discrim tag alt_code dc c
181 -- What problem is the re-ordering trying to solve ?
182 pprAbsC (CSwitch discrim [(tag1@(MachInt i1), alt_code1),
183 (tag2@(MachInt i2), alt_code2)] deflt) c
184 | empty_deflt && ((i1 == 0 && i2 == 1) || (i1 == 1 && i2 == 0))
186 do_if_stmt discrim tag1 alt_code1 alt_code2 c
188 do_if_stmt discrim tag2 alt_code2 alt_code1 c
190 empty_deflt = not (maybeToBool (nonemptyAbsC deflt))
192 pprAbsC (CSwitch discrim alts deflt) c -- general case
193 | isFloatingRep (getAmodeRep discrim)
194 = pprAbsC (foldr ( \ a -> CSwitch discrim [a]) deflt alts) c
197 hcat [text "switch (", pp_discrim, text ") {"],
198 nest 2 (vcat (map ppr_alt alts)),
199 (case (nonemptyAbsC deflt) of
202 nest 2 (vcat [ptext SLIT("default:"),
203 pprAbsC dc (c + switch_head_cost
205 ptext SLIT("break;")])),
212 = vcat [ hcat [ptext SLIT("case "), pprBasicLit lit, char ':'],
213 nest 2 (($$) (pprAbsC absC (c + switch_head_cost + costs absC))
214 (ptext SLIT("break;"))) ]
216 -- Costs for addressing header of switch and cond. branching -- HWL
217 switch_head_cost = addrModeCosts discrim Rhs + (Cost (0, 1, 0, 0, 0))
219 pprAbsC stmt@(COpStmt results (StgFCallOp fcall uniq) args vol_regs) _
220 = pprFCall fcall uniq args results vol_regs
222 pprAbsC stmt@(COpStmt results (StgPrimOp op) args vol_regs) _
224 non_void_args = grab_non_void_amodes args
225 non_void_results = grab_non_void_amodes results
226 -- if just one result, we print in the obvious "assignment" style;
227 -- if 0 or many results, we emit a macro call, w/ the results
228 -- followed by the arguments. The macro presumably knows which
231 the_op = ppr_op_call non_void_results non_void_args
232 -- liveness mask is *in* the non_void_args
234 if primOpNeedsWrapper op then
235 case (ppr_vol_regs vol_regs) of { (pp_saves, pp_restores) ->
244 ppr_op_call results args
245 = hcat [ ppr op, lparen,
246 hcat (punctuate comma (map ppr_op_result results)),
247 if null results || null args then empty else comma,
248 hcat (punctuate comma (map pprAmode args)),
251 ppr_op_result r = ppr_amode r
252 -- primop macros do their own casting of result;
253 -- hence we can toss the provided cast...
255 -- NEW CASES FOR EXPANDED PRIMOPS
257 pprAbsC stmt@(CMachOpStmt res mop [arg1,arg2] maybe_vols) _
258 = let prefix_fn = mop `elem` [MO_Dbl_Pwr, MO_Flt_Pwr, MO_NatS_MulMayOflo]
260 case ppr_maybe_vol_regs maybe_vols of {(saves,restores) ->
263 [ppr_amode res, equals]
265 then [pprMachOp_for_C mop, parens (pprAmode arg1 <> comma <> pprAmode arg2)]
266 else [pprAmode arg1, pprMachOp_for_C mop, pprAmode arg2])
272 pprAbsC stmt@(CMachOpStmt res mop [arg1] maybe_vols) _
273 = case ppr_maybe_vol_regs maybe_vols of {(saves,restores) ->
275 hcat [ppr_amode res, equals,
276 pprMachOp_for_C mop, parens (pprAmode arg1),
281 pprAbsC stmt@(CSequential stuff) c
282 = vcat (map (flip pprAbsC c) stuff)
284 -- end of NEW CASES FOR EXPANDED PRIMOPS
286 pprAbsC stmt@(CSRT lbl closures) c
287 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
289 $$ ptext SLIT("SRT") <> lparen <> pprCLabel lbl <> rparen
290 $$ nest 2 (hcat (punctuate comma (map pp_closure_lbl closures)))
294 pprAbsC stmt@(CBitmap lbl mask) c
295 = pp_bitmap_switch mask semi $
296 hcat [ ptext SLIT("BITMAP"), lparen,
297 pprCLabel lbl, comma,
298 int (length mask), comma,
299 pp_bitmap mask, rparen ]
301 pprAbsC (CSimultaneous abs_c) c
302 = hcat [ptext SLIT("{{"), pprAbsC abs_c c, ptext SLIT("}}")]
304 pprAbsC (CCheck macro as code) c
305 = hcat [ptext (cCheckMacroText macro), lparen,
306 hcat (punctuate comma (map ppr_amode as)), comma,
307 pprAbsC code c, pp_paren_semi
309 pprAbsC (CMacroStmt macro as) _
310 = hcat [ptext (cStmtMacroText macro), lparen,
311 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi] -- no casting
312 pprAbsC (CCallProfCtrMacro op as) _
313 = hcat [ftext op, lparen,
314 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
315 pprAbsC (CCallProfCCMacro op as) _
316 = hcat [ftext op, lparen,
317 hcat (punctuate comma (map ppr_amode as)),pp_paren_semi]
318 pprAbsC stmt@(CCallTypedef is_tdef (CCallSpec op_str cconv _) uniq results args) _
319 = hsep [ ptext (if is_tdef then SLIT("typedef") else SLIT("extern"))
322 , parens (hsep (punctuate comma ccall_decl_ty_args))
326 In the non-casm case, to ensure that we're entering the given external
327 entry point using the correct calling convention, we have to do the following:
329 - When entering via a function pointer (the `dynamic' case) using the specified
330 calling convention, we emit a typedefn declaration attributed with the
331 calling convention to use together with the result and parameter types we're
332 assuming. Coerce the function pointer to this type and go.
334 - to enter the function at a given code label, we emit an extern declaration
335 for the label here, stating the calling convention together with result and
336 argument types we're assuming.
338 The C compiler will hopefully use this extern declaration to good effect,
339 reporting any discrepancies between our extern decl and any other that
342 Re: calling convention, notice that gcc (2.8.1 and egcs-1.0.2) will for
343 the external function `foo' use the calling convention of the first `foo'
344 prototype it encounters (nor does it complain about conflicting attribute
345 declarations). The consequence of this is that you cannot override the
346 calling convention of `foo' using an extern declaration (you'd have to use
347 a typedef), but why you would want to do such a thing in the first place
348 is totally beyond me.
350 ToDo: petition the gcc folks to add code to warn about conflicting attribute
356 | is_tdef = parens (text (ccallConvAttribute cconv) <+> char '*' <> ccall_fun_ty)
357 | otherwise = text (ccallConvAttribute cconv) <+> ccall_fun_ty
361 DynamicTarget -> ptext SLIT("_ccall_fun_ty") <> ppr uniq
362 StaticTarget x -> pprCLabelString x
365 case non_void_results of
366 [] -> ptext SLIT("void")
367 [amode] -> ppr (getAmodeRep amode)
368 _ -> panic "pprAbsC{CCallTypedef}: ccall_res_ty"
371 | is_tdef = tail ccall_arg_tys
372 | otherwise = ccall_arg_tys
374 ccall_arg_tys = map (ppr . getAmodeRep) non_void_args
376 -- the first argument will be the "I/O world" token (a VoidRep)
377 -- all others should be non-void
380 in ASSERT (all non_void nvas) nvas
382 -- there will usually be two results: a (void) state which we
383 -- should ignore and a (possibly void) result.
385 let nvrs = grab_non_void_amodes results
386 in ASSERT (listLengthCmp nvrs 1 /= GT) nvrs
388 pprAbsC (CCodeBlock lbl abs_C) _
389 = if not (maybeToBool(nonemptyAbsC abs_C)) then
390 pprTrace "pprAbsC: curious empty code block for" (pprCLabel lbl) empty
392 case (pprTempAndExternDecls abs_C) of { (pp_temps, pp_exts) ->
396 hcat [text (if (externallyVisibleCLabel lbl)
397 then "FN_(" -- abbreviations to save on output
399 pprCLabel lbl, text ") {"],
403 nest 8 (ptext SLIT("FB_")),
404 nest 8 (pprAbsC abs_C (costs abs_C)),
405 nest 8 (ptext SLIT("FE_")),
411 pprAbsC (CInitHdr cl_info amode cost_centre size) _
412 = hcat [ ptext SLIT("SET_HDR_"), char '(',
413 ppr_amode amode, comma,
414 pprCLabelAddr info_lbl, comma,
415 if_profiling (pprAmode cost_centre), comma,
416 if_profiling (int size),
419 info_lbl = infoTableLabelFromCI cl_info
422 pprAbsC stmt@(CStaticClosure cl_info cost_centre amodes) _
423 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
427 ptext SLIT("SET_STATIC_HDR"), char '(',
428 pprCLabel closure_lbl, comma,
429 pprCLabel info_lbl, comma,
430 if_profiling (pprAmode cost_centre), comma,
431 ppLocalness closure_lbl, comma,
432 ppLocalnessMacro True{-include dyn-} info_lbl,
435 nest 2 (ppr_payload amodes),
439 closure_lbl = closureLabelFromCI cl_info
440 info_lbl = infoTableLabelFromCI cl_info
442 ppr_payload [] = empty
445 (braces $ hsep $ punctuate comma $
446 map (text "(L_)" <>) (foldr ppr_item [] ls))
449 | rep == VoidRep = rest
450 | rep == FloatRep = ppr_amode (floatToWord item) : rest
451 | rep == DoubleRep = map ppr_amode (doubleToWords item) ++ rest
452 | otherwise = ppr_amode item : rest
454 rep = getAmodeRep item
457 pprAbsC stmt@(CClosureInfoAndCode cl_info slow maybe_fast cl_descr) _
460 ptext SLIT("INFO_TABLE"),
461 ( if is_selector then
462 ptext SLIT("_SELECTOR")
463 else if is_constr then
464 ptext SLIT("_CONSTR")
465 else if needs_srt then
467 else empty ), char '(',
469 pprCLabel info_lbl, comma,
470 pprCLabel slow_lbl, comma,
471 pp_rest, {- ptrs,nptrs,[srt,]type,-} comma,
473 ppLocalness info_lbl, comma,
474 ppLocalnessMacro True{-include dyn-} slow_lbl, comma,
476 if_profiling pp_descr, comma,
477 if_profiling pp_type,
483 Just fast -> let stuff = CCodeBlock fast_lbl fast in
484 pprAbsC stuff (costs stuff)
487 info_lbl = infoTableLabelFromCI cl_info
488 fast_lbl = fastLabelFromCI cl_info
491 = case (nonemptyAbsC slow) of
492 Nothing -> (mkErrorStdEntryLabel, empty)
493 Just xx -> (entryLabelFromCI cl_info,
494 let stuff = CCodeBlock slow_lbl xx in
495 pprAbsC stuff (costs stuff))
497 maybe_selector = maybeSelectorInfo cl_info
498 is_selector = maybeToBool maybe_selector
499 (Just select_word_i) = maybe_selector
501 maybe_tag = closureSemiTag cl_info
502 is_constr = maybeToBool maybe_tag
503 (Just tag) = maybe_tag
505 srt = closureSRT cl_info
506 needs_srt = case srt of
511 size = closureNonHdrSize cl_info
513 ptrs = closurePtrsSize cl_info
516 pp_rest | is_selector = int select_word_i
521 hcat [ int tag, comma ]
522 else if needs_srt then
527 type_str = pprSMRep (closureSMRep cl_info)
529 pp_descr = pprStringInCStyle cl_descr
530 pp_type = pprStringInCStyle (closureTypeDescr cl_info)
532 pprAbsC stmt@(CClosureTbl tycon) _
534 ptext SLIT("CLOSURE_TBL") <>
535 lparen <> pprCLabel (mkClosureTblLabel tycon) <> rparen :
537 map (pp_closure_lbl . mkClosureLabel . getName . dataConWrapId) (tyConDataCons tycon)
539 ) $$ ptext SLIT("};")
541 pprAbsC stmt@(CRetDirect uniq code srt liveness) _
544 ptext SLIT("INFO_TABLE_SRT_BITMAP"), lparen,
545 pprCLabel info_lbl, comma,
546 pprCLabel entry_lbl, comma,
547 pp_liveness liveness, comma, -- bitmap
548 pp_srt_info srt, -- SRT
549 closure_type, comma, -- closure type
550 ppLocalness info_lbl, comma, -- info table storage class
551 ppLocalnessMacro True{-include dyn-} entry_lbl, comma, -- entry pt storage class
558 info_lbl = mkReturnInfoLabel uniq
559 entry_lbl = mkReturnPtLabel uniq
561 pp_code = let stuff = CCodeBlock entry_lbl code in
562 pprAbsC stuff (costs stuff)
564 closure_type = pp_liveness_switch liveness
565 (ptext SLIT("RET_SMALL"))
566 (ptext SLIT("RET_BIG"))
568 pprAbsC stmt@(CRetVector lbl amodes srt liveness) _
569 = case (pprTempAndExternDecls stmt) of { (_, pp_exts) ->
573 ptext SLIT("VEC_INFO_") <> int size,
575 pprCLabel lbl, comma,
576 pp_liveness liveness, comma, -- bitmap liveness mask
577 pp_srt_info srt, -- SRT
579 ppLocalness lbl, comma
581 nest 2 (sep (punctuate comma (map ppr_item amodes))),
587 ppr_item item = (<>) (text "(F_) ") (ppr_amode item)
590 closure_type = pp_liveness_switch liveness
591 (ptext SLIT("RET_VEC_SMALL"))
592 (ptext SLIT("RET_VEC_BIG"))
595 pprAbsC stmt@(CModuleInitBlock plain_lbl lbl code) _
597 ptext SLIT("START_MOD_INIT") <>
598 parens (pprCLabel plain_lbl <> comma <> pprCLabel lbl),
599 case (pprTempAndExternDecls stmt) of { (_, pp_exts) -> pp_exts },
600 pprAbsC code (costs code),
601 hcat [ptext SLIT("END_MOD_INIT"), lparen, rparen]
604 pprAbsC (CCostCentreDecl is_local cc) _ = pprCostCentreDecl is_local cc
605 pprAbsC (CCostCentreStackDecl ccs) _ = pprCostCentreStackDecl ccs
609 -- Print a CMachOp in a way suitable for emitting via C.
610 pprMachOp_for_C MO_Nat_Add = char '+'
611 pprMachOp_for_C MO_Nat_Sub = char '-'
612 pprMachOp_for_C MO_Nat_Eq = text "=="
613 pprMachOp_for_C MO_Nat_Ne = text "!="
615 pprMachOp_for_C MO_NatS_Ge = text ">="
616 pprMachOp_for_C MO_NatS_Le = text "<="
617 pprMachOp_for_C MO_NatS_Gt = text ">"
618 pprMachOp_for_C MO_NatS_Lt = text "<"
620 pprMachOp_for_C MO_NatU_Ge = text ">="
621 pprMachOp_for_C MO_NatU_Le = text "<="
622 pprMachOp_for_C MO_NatU_Gt = text ">"
623 pprMachOp_for_C MO_NatU_Lt = text "<"
625 pprMachOp_for_C MO_NatS_Mul = char '*'
626 pprMachOp_for_C MO_NatS_MulMayOflo = text "mulIntMayOflo"
627 pprMachOp_for_C MO_NatS_Quot = char '/'
628 pprMachOp_for_C MO_NatS_Rem = char '%'
629 pprMachOp_for_C MO_NatS_Neg = char '-'
631 pprMachOp_for_C MO_NatU_Mul = char '*'
632 pprMachOp_for_C MO_NatU_Quot = char '/'
633 pprMachOp_for_C MO_NatU_Rem = char '%'
635 pprMachOp_for_C MO_Nat_And = text "&"
636 pprMachOp_for_C MO_Nat_Or = text "|"
637 pprMachOp_for_C MO_Nat_Xor = text "^"
638 pprMachOp_for_C MO_Nat_Not = text "~"
639 pprMachOp_for_C MO_Nat_Shl = text "<<"
640 pprMachOp_for_C MO_Nat_Shr = text ">>"
641 pprMachOp_for_C MO_Nat_Sar = text ">>"
643 pprMachOp_for_C MO_32U_Eq = text "=="
644 pprMachOp_for_C MO_32U_Ne = text "!="
645 pprMachOp_for_C MO_32U_Ge = text ">="
646 pprMachOp_for_C MO_32U_Le = text "<="
647 pprMachOp_for_C MO_32U_Gt = text ">"
648 pprMachOp_for_C MO_32U_Lt = text "<"
650 pprMachOp_for_C MO_Dbl_Eq = text "=="
651 pprMachOp_for_C MO_Dbl_Ne = text "!="
652 pprMachOp_for_C MO_Dbl_Ge = text ">="
653 pprMachOp_for_C MO_Dbl_Le = text "<="
654 pprMachOp_for_C MO_Dbl_Gt = text ">"
655 pprMachOp_for_C MO_Dbl_Lt = text "<"
657 pprMachOp_for_C MO_Dbl_Add = text "+"
658 pprMachOp_for_C MO_Dbl_Sub = text "-"
659 pprMachOp_for_C MO_Dbl_Mul = text "*"
660 pprMachOp_for_C MO_Dbl_Div = text "/"
661 pprMachOp_for_C MO_Dbl_Pwr = text "pow"
663 pprMachOp_for_C MO_Dbl_Sin = text "sin"
664 pprMachOp_for_C MO_Dbl_Cos = text "cos"
665 pprMachOp_for_C MO_Dbl_Tan = text "tan"
666 pprMachOp_for_C MO_Dbl_Sinh = text "sinh"
667 pprMachOp_for_C MO_Dbl_Cosh = text "cosh"
668 pprMachOp_for_C MO_Dbl_Tanh = text "tanh"
669 pprMachOp_for_C MO_Dbl_Asin = text "asin"
670 pprMachOp_for_C MO_Dbl_Acos = text "acos"
671 pprMachOp_for_C MO_Dbl_Atan = text "atan"
672 pprMachOp_for_C MO_Dbl_Log = text "log"
673 pprMachOp_for_C MO_Dbl_Exp = text "exp"
674 pprMachOp_for_C MO_Dbl_Sqrt = text "sqrt"
675 pprMachOp_for_C MO_Dbl_Neg = text "-"
677 pprMachOp_for_C MO_Flt_Add = text "+"
678 pprMachOp_for_C MO_Flt_Sub = text "-"
679 pprMachOp_for_C MO_Flt_Mul = text "*"
680 pprMachOp_for_C MO_Flt_Div = text "/"
681 pprMachOp_for_C MO_Flt_Pwr = text "pow"
683 pprMachOp_for_C MO_Flt_Eq = text "=="
684 pprMachOp_for_C MO_Flt_Ne = text "!="
685 pprMachOp_for_C MO_Flt_Ge = text ">="
686 pprMachOp_for_C MO_Flt_Le = text "<="
687 pprMachOp_for_C MO_Flt_Gt = text ">"
688 pprMachOp_for_C MO_Flt_Lt = text "<"
690 pprMachOp_for_C MO_Flt_Sin = text "sin"
691 pprMachOp_for_C MO_Flt_Cos = text "cos"
692 pprMachOp_for_C MO_Flt_Tan = text "tan"
693 pprMachOp_for_C MO_Flt_Sinh = text "sinh"
694 pprMachOp_for_C MO_Flt_Cosh = text "cosh"
695 pprMachOp_for_C MO_Flt_Tanh = text "tanh"
696 pprMachOp_for_C MO_Flt_Asin = text "asin"
697 pprMachOp_for_C MO_Flt_Acos = text "acos"
698 pprMachOp_for_C MO_Flt_Atan = text "atan"
699 pprMachOp_for_C MO_Flt_Log = text "log"
700 pprMachOp_for_C MO_Flt_Exp = text "exp"
701 pprMachOp_for_C MO_Flt_Sqrt = text "sqrt"
702 pprMachOp_for_C MO_Flt_Neg = text "-"
704 pprMachOp_for_C MO_32U_to_NatS = text "(StgInt)"
705 pprMachOp_for_C MO_NatS_to_32U = text "(StgWord32)"
707 pprMachOp_for_C MO_NatS_to_Dbl = text "(StgDouble)"
708 pprMachOp_for_C MO_Dbl_to_NatS = text "(StgInt)"
710 pprMachOp_for_C MO_NatS_to_Flt = text "(StgFloat)"
711 pprMachOp_for_C MO_Flt_to_NatS = text "(StgInt)"
713 pprMachOp_for_C MO_NatS_to_NatU = text "(StgWord)"
714 pprMachOp_for_C MO_NatU_to_NatS = text "(StgInt)"
716 pprMachOp_for_C MO_NatS_to_NatP = text "(void*)"
717 pprMachOp_for_C MO_NatP_to_NatS = text "(StgInt)"
718 pprMachOp_for_C MO_NatU_to_NatP = text "(void*)"
719 pprMachOp_for_C MO_NatP_to_NatU = text "(StgWord)"
721 pprMachOp_for_C MO_Dbl_to_Flt = text "(StgFloat)"
722 pprMachOp_for_C MO_Flt_to_Dbl = text "(StgDouble)"
724 pprMachOp_for_C MO_8S_to_NatS = text "(StgInt8)(StgInt)"
725 pprMachOp_for_C MO_16S_to_NatS = text "(StgInt16)(StgInt)"
726 pprMachOp_for_C MO_32S_to_NatS = text "(StgInt32)(StgInt)"
728 pprMachOp_for_C MO_8U_to_NatU = text "(StgWord8)(StgWord)"
729 pprMachOp_for_C MO_16U_to_NatU = text "(StgWord16)(StgWord)"
730 pprMachOp_for_C MO_32U_to_NatU = text "(StgWord32)(StgWord)"
732 pprMachOp_for_C MO_8U_to_32U = text "(StgWord32)"
733 pprMachOp_for_C MO_32U_to_8U = text "(StgWord8)"
737 = if (externallyVisibleCLabel lbl)
739 else ptext SLIT("static ")
741 -- Horrible macros for declaring the types and locality of labels (see
744 ppLocalnessMacro include_dyn_prefix clabel =
749 ClosureType -> ptext SLIT("C_")
750 CodeType -> ptext SLIT("F_")
751 InfoTblType -> ptext SLIT("I_")
752 ClosureTblType -> ptext SLIT("CP_")
753 DataType -> ptext SLIT("D_")
756 is_visible = externallyVisibleCLabel clabel
757 label_type = labelType clabel
760 | is_visible = char 'E'
761 | otherwise = char 'I'
764 | include_dyn_prefix && labelDynamic clabel = char 'D'
772 grab_non_void_amodes amodes
773 = filter non_void amodes
776 = case (getAmodeRep amode) of
782 ppr_maybe_vol_regs :: Maybe [MagicId] -> (SDoc, SDoc)
783 ppr_maybe_vol_regs Nothing
785 ppr_maybe_vol_regs (Just vrs)
786 = case ppr_vol_regs vrs of
788 -> (pp_basic_saves $$ saves,
789 pp_basic_restores $$ restores)
791 ppr_vol_regs :: [MagicId] -> (SDoc, SDoc)
793 ppr_vol_regs [] = (empty, empty)
794 ppr_vol_regs (VoidReg:rs) = ppr_vol_regs rs
796 = let pp_reg = case r of
797 VanillaReg pk n -> pprVanillaReg n
799 (more_saves, more_restores) = ppr_vol_regs rs
801 (($$) ((<>) (ptext SLIT("CALLER_SAVE_")) pp_reg) more_saves,
802 ($$) ((<>) (ptext SLIT("CALLER_RESTORE_")) pp_reg) more_restores)
804 -- pp_basic_{saves,restores}: The BaseReg, Sp, Su, Hp and
805 -- HpLim (see StgRegs.lh) may need to be saved/restored around CCalls,
806 -- depending on the platform. (The "volatile regs" stuff handles all
807 -- other registers.) Just be *sure* BaseReg is OK before trying to do
808 -- anything else. The correct sequence of saves&restores are
809 -- encoded by the CALLER_*_SYSTEM macros.
810 pp_basic_saves = ptext SLIT("CALLER_SAVE_SYSTEM")
811 pp_basic_restores = ptext SLIT("CALLER_RESTORE_SYSTEM")
815 pp_srt_info NoC_SRT = hcat [ int 0, comma,
818 pp_srt_info (C_SRT lbl off len) = hcat [ pprCLabel lbl, comma,
825 | labelDynamic lbl = text "DLL_SRT_ENTRY" <> parens (pprCLabel lbl)
826 | otherwise = char '&' <> pprCLabel lbl
831 = if opt_SccProfilingOn
833 else char '0' -- leave it out!
834 -- ---------------------------------------------------------------------------
835 -- Changes for GrAnSim:
836 -- draw costs for computation in head of if into both branches;
837 -- as no abstractC data structure is given for the head, one is constructed
838 -- guessing unknown values and fed into the costs function
839 -- ---------------------------------------------------------------------------
841 do_if_stmt discrim tag alt_code deflt c
843 cond = hcat [ pprAmode discrim
846 , pprAmode (CLit tag)
848 -- to be absolutely sure that none of the
849 -- conversion rules hit, e.g.,
851 -- minInt is different to (int)minInt
853 -- in C (when minInt is a number not a constant
854 -- expression which evaluates to it.)
857 MachInt _ -> ptext SLIT("(I_)")
862 (addrModeCosts discrim Rhs) c
864 ppr_if_stmt pp_pred then_part else_part discrim_costs c
866 hcat [text "if (", pp_pred, text ") {"],
867 nest 8 (pprAbsC then_part (c + discrim_costs +
868 (Cost (0, 2, 0, 0, 0)) +
870 (case nonemptyAbsC else_part of Nothing -> empty; Just _ -> text "} else {"),
871 nest 8 (pprAbsC else_part (c + discrim_costs +
872 (Cost (0, 1, 0, 0, 0)) +
875 {- Total costs = inherited costs (before if) + costs for accessing discrim
876 + costs for cond branch ( = (0, 1, 0, 0, 0) )
877 + costs for that alternative
881 Historical note: this used to be two separate cases -- one for `ccall'
882 and one for `casm'. To get round a potential limitation to only 10
883 arguments, the numbering of arguments in @process_casm@ was beefed up a
886 Some rough notes on generating code for @CCallOp@:
888 1) Evaluate all arguments and stuff them into registers. (done elsewhere)
889 2) Save any essential registers (heap, stack, etc).
891 ToDo: If stable pointers are in use, these must be saved in a place
892 where the runtime system can get at them so that the Stg world can
893 be restarted during the call.
895 3) Save any temporary registers that are currently in use.
896 4) Do the call, putting result into a local variable
897 5) Restore essential registers
898 6) Restore temporaries
900 (This happens after restoration of essential registers because we
901 might need the @Base@ register to access all the others correctly.)
903 Otherwise, copy local variable into result register.
905 8) If ccall (not casm), declare the function being called as extern so
906 that C knows if it returns anything other than an int.
909 { ResultType _ccall_result;
912 _ccall_result = f( args );
916 return_reg = _ccall_result;
920 Amendment to the above: if we can GC, we have to:
922 * make sure we save all our registers away where the garbage collector
924 * be sure that there are no live registers or we're in trouble.
925 (This can cause problems if you try something foolish like passing
926 an array or a foreign obj to a _ccall_GC_ thing.)
927 * increment/decrement the @inCCallGC@ counter before/after the call so
928 that the runtime check that PerformGC is being used sensibly will work.
931 pprFCall call@(CCall (CCallSpec target cconv safety)) uniq args results vol_regs
934 declare_local_vars, -- local var for *result*
935 vcat local_arg_decls,
937 process_casm local_vars pp_non_void_args call_str,
943 (pp_saves, pp_restores) = ppr_vol_regs vol_regs
945 thread_macro_args = ppr_uniq_token <> comma <+>
946 text "rts" <> ppr (playThreadSafe safety)
947 ppr_uniq_token = text "tok_" <> ppr uniq
948 (pp_save_context, pp_restore_context)
949 | playSafe safety = ( text "{ I_" <+> ppr_uniq_token <>
950 text "; SUSPEND_THREAD" <> parens thread_macro_args <> semi
951 , text "RESUME_THREAD" <> parens thread_macro_args <> text ";}"
953 | otherwise = ( pp_basic_saves $$ pp_saves,
954 pp_basic_restores $$ pp_restores)
958 in ASSERT2 ( all non_void nvas, ppr call <+> hsep (map pprAmode args) )
960 -- the last argument will be the "I/O world" token (a VoidRep)
961 -- all others should be non-void
964 let nvrs = grab_non_void_amodes results
965 in ASSERT (listLengthCmp nvrs 1 /= GT) nvrs
966 -- there will usually be two results: a (void) state which we
967 -- should ignore and a (possibly void) result.
969 (local_arg_decls, pp_non_void_args)
970 = unzip [ ppr_casm_arg a i | (a,i) <- non_void_args `zip` [1..] ]
972 (declare_local_vars, local_vars, assign_results)
973 = ppr_casm_results non_void_results
975 call_str = case target of
976 CasmTarget str -> unpackFS str
977 StaticTarget fn -> mk_ccall_str (pprCLabelString fn) ccall_args
978 DynamicTarget -> mk_ccall_str dyn_fun (tail ccall_args)
980 ccall_args = zipWith (\ _ i -> char '%' <> int i) non_void_args [0..]
981 dyn_fun = parens (parens (ptext SLIT("_ccall_fun_ty") <> ppr uniq) <> text "%0")
984 -- Remainder only used for ccall
985 mk_ccall_str fun_name ccall_fun_args = showSDoc
987 if null non_void_results
990 lparen, fun_name, lparen,
991 hcat (punctuate comma ccall_fun_args),
996 If the argument is a heap object, we need to reach inside and pull out
997 the bit the C world wants to see. The only heap objects which can be
998 passed are @Array@s and @ByteArray@s.
1001 ppr_casm_arg :: CAddrMode -> Int -> (SDoc, SDoc)
1002 -- (a) decl and assignment, (b) local var to be used later
1004 ppr_casm_arg amode a_num
1006 a_kind = getAmodeRep amode
1007 pp_amode = pprAmode amode
1008 pp_kind = pprPrimKind a_kind
1010 local_var = (<>) (ptext SLIT("_ccall_arg")) (int a_num)
1012 (arg_type, pp_amode2)
1015 -- for array arguments, pass a pointer to the body of the array
1016 -- (PTRS_ARR_CTS skips over all the header nonsense)
1017 ArrayRep -> (pp_kind,
1018 hcat [ptext SLIT("PTRS_ARR_CTS"),char '(', pp_amode, rparen])
1019 ByteArrayRep -> (pp_kind,
1020 hcat [ptext SLIT("BYTE_ARR_CTS"),char '(', pp_amode, rparen])
1022 -- for ForeignObj, use FOREIGN_OBJ_DATA to fish out the contents.
1023 ForeignObjRep -> (pp_kind,
1024 hcat [ptext SLIT("ForeignObj_CLOSURE_DATA"),
1025 char '(', pp_amode, char ')'])
1027 other -> (pp_kind, pp_amode)
1030 = hcat [ arg_type, space, local_var, equals, pp_amode2, semi ]
1032 (declare_local_var, local_var)
1035 For l-values, the critical questions are:
1037 1) Are there any results at all?
1039 We only allow zero or one results.
1043 :: [CAddrMode] -- list of results (length <= 1)
1045 ( SDoc, -- declaration of any local vars
1046 [SDoc], -- list of result vars (same length as results)
1047 SDoc ) -- assignment (if any) of results in local var to registers
1050 = (empty, [], empty) -- no results
1052 ppr_casm_results [r]
1054 result_reg = ppr_amode r
1055 r_kind = getAmodeRep r
1057 local_var = ptext SLIT("_ccall_result")
1059 (result_type, assign_result)
1060 = (pprPrimKind r_kind,
1061 hcat [ result_reg, equals, local_var, semi ])
1063 declare_local_var = hcat [ result_type, space, local_var, semi ]
1065 (declare_local_var, [local_var], assign_result)
1068 = panic "ppr_casm_results: ccall/casm with many results"
1072 Note the sneaky way _the_ result is represented by a list so that we
1073 can complain if it's used twice.
1075 ToDo: Any chance of giving line numbers when process-casm fails?
1076 Or maybe we should do a check _much earlier_ in compiler. ADR
1079 process_casm :: [SDoc] -- results (length <= 1)
1080 -> [SDoc] -- arguments
1081 -> String -- format string (with embedded %'s)
1082 -> SDoc -- code being generated
1084 process_casm results args string = process results args string
1086 process [] _ "" = empty
1087 process (_:_) _ "" = error ("process_casm: non-void result not assigned while processing _casm_ \"" ++
1089 "\"\n(Try changing result type to IO ()\n")
1091 process ress args ('%':cs)
1094 error ("process_casm: lonely % while processing _casm_ \"" ++ string ++ "\".\n")
1097 char '%' <> process ress args css
1101 [] -> error ("process_casm: no result to match %r while processing _casm_ \"" ++ string ++ "\".\nTry deleting %r or changing result type from PrimIO ()\n")
1102 [r] -> r <> (process [] args css)
1103 _ -> panic ("process_casm: casm with many results while processing _casm_ \"" ++ string ++ "\".\n")
1107 read_int :: ReadS Int
1110 case (read_int other) of
1112 if num >= 0 && args `lengthExceeds` num
1113 then parens (args !! num) <> process ress args css
1114 else error ("process_casm: no such arg #:"++(show num)++" while processing \"" ++ string ++ "\".\n")
1115 _ -> error ("process_casm: not %<num> while processing _casm_ \"" ++ string ++ "\".\n")
1117 process ress args (other_c:cs)
1118 = char other_c <> process ress args cs
1121 %************************************************************************
1123 \subsection[a2r-assignments]{Assignments}
1125 %************************************************************************
1127 Printing assignments is a little tricky because of type coercion.
1129 First of all, the kind of the thing being assigned can be gotten from
1130 the destination addressing mode. (It should be the same as the kind
1131 of the source addressing mode.) If the kind of the assignment is of
1132 @VoidRep@, then don't generate any code at all.
1135 pprAssign :: PrimRep -> CAddrMode -> CAddrMode -> SDoc
1137 pprAssign VoidRep dest src = empty
1140 Special treatment for floats and doubles, to avoid unwanted conversions.
1143 pprAssign FloatRep dest@(CVal reg_rel _) src
1144 = hcat [ ptext SLIT("ASSIGN_FLT((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1146 pprAssign DoubleRep dest@(CVal reg_rel _) src
1147 = hcat [ ptext SLIT("ASSIGN_DBL((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1149 pprAssign Int64Rep dest@(CVal reg_rel _) src
1150 = hcat [ ptext SLIT("ASSIGN_Int64((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1151 pprAssign Word64Rep dest@(CVal reg_rel _) src
1152 = hcat [ ptext SLIT("ASSIGN_Word64((W_*)"), parens (ppr_amode (CAddr reg_rel)), comma, pprAmode src, pp_paren_semi ]
1155 Lastly, the question is: will the C compiler think the types of the
1156 two sides of the assignment match?
1158 We assume that the types will match if neither side is a
1159 @CVal@ addressing mode for any register which can point into
1162 Why? Because the heap and stack are used to store miscellaneous
1163 things, whereas the temporaries, registers, etc., are only used for
1164 things of fixed type.
1167 pprAssign kind (CReg (VanillaReg _ dest)) (CReg (VanillaReg _ src))
1168 = hcat [ pprVanillaReg dest, equals,
1169 pprVanillaReg src, semi ]
1171 pprAssign kind dest src
1172 | mixedTypeLocn dest
1173 -- Add in a cast to StgWord (a.k.a. W_) iff the destination is mixed
1174 = hcat [ ppr_amode dest, equals,
1175 text "(W_)(", -- Here is the cast
1176 ppr_amode src, pp_paren_semi ]
1178 pprAssign kind dest src
1179 | mixedPtrLocn dest && getAmodeRep src /= PtrRep
1180 -- Add in a cast to StgPtr (a.k.a. P_) iff the destination is mixed
1181 = hcat [ ppr_amode dest, equals,
1182 text "(P_)(", -- Here is the cast
1183 ppr_amode src, pp_paren_semi ]
1185 pprAssign ByteArrayRep dest src
1187 -- Add in a cast iff the source is mixed
1188 = hcat [ ppr_amode dest, equals,
1189 text "(StgByteArray)(", -- Here is the cast
1190 ppr_amode src, pp_paren_semi ]
1192 pprAssign kind other_dest src
1193 = hcat [ ppr_amode other_dest, equals,
1194 pprAmode src, semi ]
1198 %************************************************************************
1200 \subsection[a2r-CAddrModes]{Addressing modes}
1202 %************************************************************************
1204 @pprAmode@ is used to print r-values (which may need casts), whereas
1205 @ppr_amode@ is used for l-values {\em and} as a help function for
1209 pprAmode, ppr_amode :: CAddrMode -> SDoc
1212 For reasons discussed above under assignments, @CVal@ modes need
1213 to be treated carefully. First come special cases for floats and doubles,
1214 similar to those in @pprAssign@:
1216 (NB: @PK_FLT@ and @PK_DBL@ require the {\em address} of the value in
1220 pprAmode (CVal reg_rel FloatRep)
1221 = hcat [ text "PK_FLT((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1222 pprAmode (CVal reg_rel DoubleRep)
1223 = hcat [ text "PK_DBL((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1224 pprAmode (CVal reg_rel Int64Rep)
1225 = hcat [ text "PK_Int64((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1226 pprAmode (CVal reg_rel Word64Rep)
1227 = hcat [ text "PK_Word64((W_*)", parens (ppr_amode (CAddr reg_rel)), rparen ]
1230 Next comes the case where there is some other cast need, and the
1235 | mixedTypeLocn amode
1236 = parens (hcat [ pprPrimKind (getAmodeRep amode), ptext SLIT(")("),
1238 | otherwise -- No cast needed
1242 When we have an indirection through a CIndex, we have to be careful to
1243 get the type casts right.
1247 CVal (CIndex kind1 base offset) kind2
1251 *(kind2 *)((kind1 *)base + offset)
1253 That is, the indexing is done in units of kind1, but the resulting
1257 ppr_amode CBytesPerWord
1258 = text "(sizeof(void*))"
1260 ppr_amode (CVal reg_rel@(CIndex _ _ _) kind)
1261 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1262 (pp_reg, Nothing) -> panic "ppr_amode: CIndex"
1263 (pp_reg, Just offset) ->
1264 hcat [ char '*', parens (pprPrimKind kind <> char '*'),
1265 parens (pp_reg <> char '+' <> offset) ]
1268 Now the rest of the cases for ``workhorse'' @ppr_amode@:
1271 ppr_amode (CVal reg_rel _)
1272 = case (pprRegRelative False{-no sign wanted-} reg_rel) of
1273 (pp_reg, Nothing) -> (<>) (char '*') pp_reg
1274 (pp_reg, Just offset) -> hcat [ pp_reg, brackets offset ]
1276 ppr_amode (CAddr reg_rel)
1277 = case (pprRegRelative True{-sign wanted-} reg_rel) of
1278 (pp_reg, Nothing) -> pp_reg
1279 (pp_reg, Just offset) -> (<>) pp_reg offset
1281 ppr_amode (CReg magic_id) = pprMagicId magic_id
1283 ppr_amode (CTemp uniq kind) = char '_' <> pprUnique uniq <> char '_'
1285 ppr_amode (CLbl lbl kind) = pprCLabelAddr lbl
1287 ppr_amode (CCharLike ch)
1288 = hcat [ptext SLIT("CHARLIKE_CLOSURE"), char '(', pprAmode ch, rparen ]
1289 ppr_amode (CIntLike int)
1290 = hcat [ptext SLIT("INTLIKE_CLOSURE"), char '(', pprAmode int, rparen ]
1292 ppr_amode (CLit lit) = pprBasicLit lit
1294 ppr_amode (CJoinPoint _)
1295 = panic "ppr_amode: CJoinPoint"
1297 ppr_amode (CMacroExpr pk macro as)
1298 = parens (ptext (cExprMacroText macro) <>
1299 parens (hcat (punctuate comma (map pprAmode as))))
1303 cExprMacroText ENTRY_CODE = SLIT("ENTRY_CODE")
1304 cExprMacroText ARG_TAG = SLIT("ARG_TAG")
1305 cExprMacroText GET_TAG = SLIT("GET_TAG")
1306 cExprMacroText UPD_FRAME_UPDATEE = SLIT("UPD_FRAME_UPDATEE")
1307 cExprMacroText CCS_HDR = SLIT("CCS_HDR")
1309 cStmtMacroText ARGS_CHK = SLIT("ARGS_CHK")
1310 cStmtMacroText ARGS_CHK_LOAD_NODE = SLIT("ARGS_CHK_LOAD_NODE")
1311 cStmtMacroText UPD_CAF = SLIT("UPD_CAF")
1312 cStmtMacroText UPD_BH_UPDATABLE = SLIT("UPD_BH_UPDATABLE")
1313 cStmtMacroText UPD_BH_SINGLE_ENTRY = SLIT("UPD_BH_SINGLE_ENTRY")
1314 cStmtMacroText PUSH_UPD_FRAME = SLIT("PUSH_UPD_FRAME")
1315 cStmtMacroText PUSH_SEQ_FRAME = SLIT("PUSH_SEQ_FRAME")
1316 cStmtMacroText UPDATE_SU_FROM_UPD_FRAME = SLIT("UPDATE_SU_FROM_UPD_FRAME")
1317 cStmtMacroText SET_TAG = SLIT("SET_TAG")
1318 cStmtMacroText DATA_TO_TAGZH = SLIT("dataToTagzh")
1319 cStmtMacroText REGISTER_FOREIGN_EXPORT = SLIT("REGISTER_FOREIGN_EXPORT")
1320 cStmtMacroText REGISTER_IMPORT = SLIT("REGISTER_IMPORT")
1321 cStmtMacroText REGISTER_DIMPORT = SLIT("REGISTER_DIMPORT")
1322 cStmtMacroText GRAN_FETCH = SLIT("GRAN_FETCH")
1323 cStmtMacroText GRAN_RESCHEDULE = SLIT("GRAN_RESCHEDULE")
1324 cStmtMacroText GRAN_FETCH_AND_RESCHEDULE= SLIT("GRAN_FETCH_AND_RESCHEDULE")
1325 cStmtMacroText THREAD_CONTEXT_SWITCH = SLIT("THREAD_CONTEXT_SWITCH")
1326 cStmtMacroText GRAN_YIELD = SLIT("GRAN_YIELD")
1328 cCheckMacroText HP_CHK_NP = SLIT("HP_CHK_NP")
1329 cCheckMacroText STK_CHK_NP = SLIT("STK_CHK_NP")
1330 cCheckMacroText HP_STK_CHK_NP = SLIT("HP_STK_CHK_NP")
1331 cCheckMacroText HP_CHK_SEQ_NP = SLIT("HP_CHK_SEQ_NP")
1332 cCheckMacroText HP_CHK = SLIT("HP_CHK")
1333 cCheckMacroText STK_CHK = SLIT("STK_CHK")
1334 cCheckMacroText HP_STK_CHK = SLIT("HP_STK_CHK")
1335 cCheckMacroText HP_CHK_NOREGS = SLIT("HP_CHK_NOREGS")
1336 cCheckMacroText HP_CHK_UNPT_R1 = SLIT("HP_CHK_UNPT_R1")
1337 cCheckMacroText HP_CHK_UNBX_R1 = SLIT("HP_CHK_UNBX_R1")
1338 cCheckMacroText HP_CHK_F1 = SLIT("HP_CHK_F1")
1339 cCheckMacroText HP_CHK_D1 = SLIT("HP_CHK_D1")
1340 cCheckMacroText HP_CHK_L1 = SLIT("HP_CHK_L1")
1341 cCheckMacroText HP_CHK_UT_ALT = SLIT("HP_CHK_UT_ALT")
1342 cCheckMacroText HP_CHK_GEN = SLIT("HP_CHK_GEN")
1348 %************************************************************************
1350 \subsection[ppr-liveness-masks]{Liveness Masks}
1352 %************************************************************************
1355 pp_bitmap_switch :: [BitSet] -> SDoc -> SDoc -> SDoc
1356 pp_bitmap_switch ([ ]) small large = small
1357 pp_bitmap_switch ([_ ]) small large = small
1358 pp_bitmap_switch ([_,_]) small large = hcat
1359 [ptext SLIT("BITMAP_SWITCH64"), lparen, small, comma, large, rparen]
1360 pp_bitmap_switch (_ ) small large = large
1362 pp_liveness_switch :: Liveness -> SDoc -> SDoc -> SDoc
1363 pp_liveness_switch (Liveness lbl mask) = pp_bitmap_switch mask
1365 pp_bitset :: BitSet -> SDoc
1367 | i < -1 = int (i + 1) <> text "-1"
1371 pp_bitmap :: [BitSet] -> SDoc
1372 pp_bitmap [] = int 0
1373 pp_bitmap ss = hcat (punctuate delayed_comma (bundle ss)) where
1374 delayed_comma = hcat [space, ptext SLIT("COMMA"), space]
1376 bundle [s] = [hcat bitmap32]
1377 where bitmap32 = [ptext SLIT("BITMAP32"), lparen,
1378 pp_bitset s, rparen]
1379 bundle (s1:s2:ss) = hcat bitmap64 : bundle ss
1380 where bitmap64 = [ptext SLIT("BITMAP64"), lparen,
1381 pp_bitset s1, comma, pp_bitset s2, rparen]
1383 pp_liveness :: Liveness -> SDoc
1384 pp_liveness (Liveness lbl mask)
1385 = pp_bitmap_switch mask (pp_bitmap mask) (char '&' <> pprCLabel lbl)
1388 %************************************************************************
1390 \subsection[a2r-MagicIds]{Magic ids}
1392 %************************************************************************
1394 @pprRegRelative@ returns a pair of the @Doc@ for the register
1395 (some casting may be required), and a @Maybe Doc@ for the offset
1396 (zero offset gives a @Nothing@).
1399 addPlusSign :: Bool -> SDoc -> SDoc
1400 addPlusSign False p = p
1401 addPlusSign True p = (<>) (char '+') p
1403 pprSignedInt :: Bool -> Int -> Maybe SDoc -- Nothing => 0
1404 pprSignedInt sign_wanted n
1405 = if n == 0 then Nothing else
1406 if n > 0 then Just (addPlusSign sign_wanted (int n))
1409 pprRegRelative :: Bool -- True <=> Print leading plus sign (if +ve)
1411 -> (SDoc, Maybe SDoc)
1413 pprRegRelative sign_wanted (SpRel off)
1414 = (pprMagicId Sp, pprSignedInt sign_wanted (I# off))
1416 pprRegRelative sign_wanted r@(HpRel o)
1417 = let pp_Hp = pprMagicId Hp; off = I# o
1422 (pp_Hp, Just ((<>) (char '-') (int off)))
1424 pprRegRelative sign_wanted (NodeRel o)
1425 = let pp_Node = pprMagicId node; off = I# o
1430 (pp_Node, Just (addPlusSign sign_wanted (int off)))
1432 pprRegRelative sign_wanted (CIndex base offset kind)
1433 = ( hcat [text "((", pprPrimKind kind, text " *)(", ppr_amode base, text "))"]
1434 , Just (hcat [if sign_wanted then char '+' else empty,
1435 text "(I_)(", ppr_amode offset, ptext SLIT(")")])
1439 @pprMagicId@ just prints the register name. @VanillaReg@ registers are
1440 represented by a discriminated union (@StgUnion@), so we use the @PrimRep@
1441 to select the union tag.
1444 pprMagicId :: MagicId -> SDoc
1446 pprMagicId BaseReg = ptext SLIT("BaseReg")
1447 pprMagicId (VanillaReg pk n)
1448 = hcat [ pprVanillaReg n, char '.',
1450 pprMagicId (FloatReg n) = ptext SLIT("F") <> int (I# n)
1451 pprMagicId (DoubleReg n) = ptext SLIT("D") <> int (I# n)
1452 pprMagicId (LongReg _ n) = ptext SLIT("L") <> int (I# n)
1453 pprMagicId Sp = ptext SLIT("Sp")
1454 pprMagicId Su = ptext SLIT("Su")
1455 pprMagicId SpLim = ptext SLIT("SpLim")
1456 pprMagicId Hp = ptext SLIT("Hp")
1457 pprMagicId HpLim = ptext SLIT("HpLim")
1458 pprMagicId CurCostCentre = ptext SLIT("CCCS")
1459 pprMagicId VoidReg = panic "pprMagicId:VoidReg!"
1461 pprVanillaReg :: Int# -> SDoc
1462 pprVanillaReg n = char 'R' <> int (I# n)
1464 pprUnionTag :: PrimRep -> SDoc
1466 pprUnionTag PtrRep = char 'p'
1467 pprUnionTag CodePtrRep = ptext SLIT("fp")
1468 pprUnionTag DataPtrRep = char 'd'
1469 pprUnionTag RetRep = char 'p'
1470 pprUnionTag CostCentreRep = panic "pprUnionTag:CostCentre?"
1472 pprUnionTag CharRep = char 'c'
1473 pprUnionTag Int8Rep = ptext SLIT("i8")
1474 pprUnionTag IntRep = char 'i'
1475 pprUnionTag WordRep = char 'w'
1476 pprUnionTag Int32Rep = char 'i'
1477 pprUnionTag Word32Rep = char 'w'
1478 pprUnionTag AddrRep = char 'a'
1479 pprUnionTag FloatRep = char 'f'
1480 pprUnionTag DoubleRep = panic "pprUnionTag:Double?"
1482 pprUnionTag StablePtrRep = char 'p'
1483 pprUnionTag StableNameRep = char 'p'
1484 pprUnionTag WeakPtrRep = char 'p'
1485 pprUnionTag ForeignObjRep = char 'p'
1486 pprUnionTag PrimPtrRep = char 'p'
1488 pprUnionTag ThreadIdRep = char 't'
1490 pprUnionTag ArrayRep = char 'p'
1491 pprUnionTag ByteArrayRep = char 'b'
1492 pprUnionTag BCORep = char 'p'
1494 pprUnionTag _ = panic "pprUnionTag:Odd kind"
1498 Find and print local and external declarations for a list of
1499 Abstract~C statements.
1501 pprTempAndExternDecls :: AbstractC -> (SDoc{-temps-}, SDoc{-externs-})
1502 pprTempAndExternDecls AbsCNop = (empty, empty)
1504 pprTempAndExternDecls (AbsCStmts stmt1 stmt2)
1505 = initTE (ppr_decls_AbsC stmt1 `thenTE` \ (t_p1, e_p1) ->
1506 ppr_decls_AbsC stmt2 `thenTE` \ (t_p2, e_p2) ->
1507 case (catMaybes [t_p1, t_p2]) of { real_temps ->
1508 case (catMaybes [e_p1, e_p2]) of { real_exts ->
1509 returnTE (vcat real_temps, vcat real_exts) }}
1512 pprTempAndExternDecls other_stmt
1513 = initTE (ppr_decls_AbsC other_stmt `thenTE` \ (maybe_t, maybe_e) ->
1524 pprBasicLit :: Literal -> SDoc
1525 pprPrimKind :: PrimRep -> SDoc
1527 pprBasicLit lit = ppr lit
1528 pprPrimKind k = ppr k
1532 %************************************************************************
1534 \subsection[a2r-monad]{Monadery}
1536 %************************************************************************
1538 We need some monadery to keep track of temps and externs we have already
1539 printed. This info must be threaded right through the Abstract~C, so
1540 it's most convenient to hide it in this monad.
1542 WDP 95/02: Switched from \tr{([Unique], [CLabel])} to
1543 \tr{(UniqSet, CLabelSet)}. Allegedly for efficiency.
1546 type CLabelSet = FiniteMap CLabel (){-any type will do-}
1547 emptyCLabelSet = emptyFM
1548 x `elementOfCLabelSet` labs
1549 = case (lookupFM labs x) of { Just _ -> True; Nothing -> False }
1551 addToCLabelSet set x = addToFM set x ()
1553 type TEenv = (UniqSet Unique, CLabelSet)
1555 type TeM result = TEenv -> (TEenv, result)
1557 initTE :: TeM a -> a
1559 = case sa (emptyUniqSet, emptyCLabelSet) of { (_, result) ->
1562 {-# INLINE thenTE #-}
1563 {-# INLINE returnTE #-}
1565 thenTE :: TeM a -> (a -> TeM b) -> TeM b
1567 = case a u of { (u_1, result_of_a) ->
1570 mapTE :: (a -> TeM b) -> [a] -> TeM [b]
1571 mapTE f [] = returnTE []
1573 = f x `thenTE` \ r ->
1574 mapTE f xs `thenTE` \ rs ->
1577 returnTE :: a -> TeM a
1578 returnTE result env = (env, result)
1580 -- these next two check whether the thing is already
1581 -- recorded, and THEN THEY RECORD IT
1582 -- (subsequent calls will return False for the same uniq/label)
1584 tempSeenTE :: Unique -> TeM Bool
1585 tempSeenTE uniq env@(seen_uniqs, seen_labels)
1586 = if (uniq `elementOfUniqSet` seen_uniqs)
1588 else ((addOneToUniqSet seen_uniqs uniq,
1592 labelSeenTE :: CLabel -> TeM Bool
1593 labelSeenTE lbl env@(seen_uniqs, seen_labels)
1594 = if (lbl `elementOfCLabelSet` seen_labels)
1597 addToCLabelSet seen_labels lbl),
1602 pprTempDecl :: Unique -> PrimRep -> SDoc
1603 pprTempDecl uniq kind
1604 = hcat [ pprPrimKind kind, space, char '_', pprUnique uniq, ptext SLIT("_;") ]
1606 pprExternDecl :: Bool -> CLabel -> SDoc
1607 pprExternDecl in_srt clabel
1608 | not (needsCDecl clabel) = empty -- do not print anything for "known external" things
1610 hcat [ ppLocalnessMacro (not in_srt) clabel,
1611 lparen, dyn_wrapper (pprCLabel clabel), pp_paren_semi ]
1614 | in_srt && labelDynamic clabel = text "DLL_IMPORT_DATA_VAR" <> parens d
1620 ppr_decls_AbsC :: AbstractC -> TeM (Maybe SDoc{-temps-}, Maybe SDoc{-externs-})
1622 ppr_decls_AbsC AbsCNop = returnTE (Nothing, Nothing)
1624 ppr_decls_AbsC (AbsCStmts stmts_1 stmts_2)
1625 = ppr_decls_AbsC stmts_1 `thenTE` \ p1 ->
1626 ppr_decls_AbsC stmts_2 `thenTE` \ p2 ->
1627 returnTE (maybe_vcat [p1, p2])
1629 ppr_decls_AbsC (CSplitMarker) = returnTE (Nothing, Nothing)
1631 ppr_decls_AbsC (CAssign dest source)
1632 = ppr_decls_Amode dest `thenTE` \ p1 ->
1633 ppr_decls_Amode source `thenTE` \ p2 ->
1634 returnTE (maybe_vcat [p1, p2])
1636 ppr_decls_AbsC (CJump target) = ppr_decls_Amode target
1638 ppr_decls_AbsC (CFallThrough target) = ppr_decls_Amode target
1640 ppr_decls_AbsC (CReturn target _) = ppr_decls_Amode target
1642 ppr_decls_AbsC (CSwitch discrim alts deflt)
1643 = ppr_decls_Amode discrim `thenTE` \ pdisc ->
1644 mapTE ppr_alt_stuff alts `thenTE` \ palts ->
1645 ppr_decls_AbsC deflt `thenTE` \ pdeflt ->
1646 returnTE (maybe_vcat (pdisc:pdeflt:palts))
1648 ppr_alt_stuff (_, absC) = ppr_decls_AbsC absC
1650 ppr_decls_AbsC (CCodeBlock lbl absC)
1651 = ppr_decls_AbsC absC
1653 ppr_decls_AbsC (CInitHdr cl_info reg_rel cost_centre _)
1654 -- ToDo: strictly speaking, should chk "cost_centre" amode
1655 = labelSeenTE info_lbl `thenTE` \ label_seen ->
1660 Just (pprExternDecl False{-not in an SRT decl-} info_lbl))
1662 info_lbl = infoTableLabelFromCI cl_info
1664 ppr_decls_AbsC (CMachOpStmt res _ args _) = ppr_decls_Amodes (res : args)
1665 ppr_decls_AbsC (COpStmt results _ args _) = ppr_decls_Amodes (results ++ args)
1667 ppr_decls_AbsC (CSimultaneous abc) = ppr_decls_AbsC abc
1669 ppr_decls_AbsC (CSequential abcs)
1670 = mapTE ppr_decls_AbsC abcs `thenTE` \ t_and_e_s ->
1671 returnTE (maybe_vcat t_and_e_s)
1673 ppr_decls_AbsC (CCheck _ amodes code) =
1674 ppr_decls_Amodes amodes `thenTE` \p1 ->
1675 ppr_decls_AbsC code `thenTE` \p2 ->
1676 returnTE (maybe_vcat [p1,p2])
1678 ppr_decls_AbsC (CMacroStmt _ amodes) = ppr_decls_Amodes amodes
1680 ppr_decls_AbsC (CCallProfCtrMacro _ amodes) = ppr_decls_Amodes [] -- *****!!!
1681 -- you get some nasty re-decls of stdio.h if you compile
1682 -- the prelude while looking inside those amodes;
1683 -- no real reason to, anyway.
1684 ppr_decls_AbsC (CCallProfCCMacro _ amodes) = ppr_decls_Amodes amodes
1686 ppr_decls_AbsC (CStaticClosure closure_info cost_centre amodes)
1687 -- ToDo: strictly speaking, should chk "cost_centre" amode
1688 = ppr_decls_Amodes amodes
1690 ppr_decls_AbsC (CClosureInfoAndCode cl_info slow maybe_fast _)
1691 = ppr_decls_Amodes [entry_lbl] `thenTE` \ p1 ->
1692 ppr_decls_AbsC slow `thenTE` \ p2 ->
1694 Nothing -> returnTE (Nothing, Nothing)
1695 Just fast -> ppr_decls_AbsC fast) `thenTE` \ p3 ->
1696 returnTE (maybe_vcat [p1, p2, p3])
1698 entry_lbl = CLbl slow_lbl CodePtrRep
1699 slow_lbl = case (nonemptyAbsC slow) of
1700 Nothing -> mkErrorStdEntryLabel
1701 Just _ -> entryLabelFromCI cl_info
1703 ppr_decls_AbsC (CSRT _ closure_lbls)
1704 = mapTE labelSeenTE closure_lbls `thenTE` \ seen ->
1706 if and seen then Nothing
1707 else Just (vcat [ pprExternDecl True{-in SRT decl-} l
1708 | (l,False) <- zip closure_lbls seen ]))
1710 ppr_decls_AbsC (CRetDirect _ code _ _) = ppr_decls_AbsC code
1711 ppr_decls_AbsC (CRetVector _ amodes _ _) = ppr_decls_Amodes amodes
1712 ppr_decls_AbsC (CModuleInitBlock _ _ code) = ppr_decls_AbsC code
1714 ppr_decls_AbsC (_) = returnTE (Nothing, Nothing)
1718 ppr_decls_Amode :: CAddrMode -> TeM (Maybe SDoc, Maybe SDoc)
1719 ppr_decls_Amode (CVal (CIndex base offset _) _) = ppr_decls_Amodes [base,offset]
1720 ppr_decls_Amode (CAddr (CIndex base offset _)) = ppr_decls_Amodes [base,offset]
1721 ppr_decls_Amode (CVal _ _) = returnTE (Nothing, Nothing)
1722 ppr_decls_Amode (CAddr _) = returnTE (Nothing, Nothing)
1723 ppr_decls_Amode (CReg _) = returnTE (Nothing, Nothing)
1724 ppr_decls_Amode (CLit _) = returnTE (Nothing, Nothing)
1726 -- CIntLike must be a literal -- no decls
1727 ppr_decls_Amode (CIntLike int) = returnTE (Nothing, Nothing)
1730 ppr_decls_Amode (CCharLike char) = returnTE (Nothing, Nothing)
1732 -- now, the only place where we actually print temps/externs...
1733 ppr_decls_Amode (CTemp uniq kind)
1735 VoidRep -> returnTE (Nothing, Nothing)
1737 tempSeenTE uniq `thenTE` \ temp_seen ->
1739 (if temp_seen then Nothing else Just (pprTempDecl uniq kind), Nothing)
1741 ppr_decls_Amode (CLbl lbl VoidRep)
1742 = returnTE (Nothing, Nothing)
1744 ppr_decls_Amode (CLbl lbl kind)
1745 = labelSeenTE lbl `thenTE` \ label_seen ->
1747 if label_seen then Nothing else Just (pprExternDecl False{-not in an SRT decl-} lbl))
1749 ppr_decls_Amode (CMacroExpr _ _ amodes)
1750 = ppr_decls_Amodes amodes
1752 ppr_decls_Amode other = returnTE (Nothing, Nothing)
1755 maybe_vcat :: [(Maybe SDoc, Maybe SDoc)] -> (Maybe SDoc, Maybe SDoc)
1757 = case (unzip ps) of { (ts, es) ->
1758 case (catMaybes ts) of { real_ts ->
1759 case (catMaybes es) of { real_es ->
1760 (if (null real_ts) then Nothing else Just (vcat real_ts),
1761 if (null real_es) then Nothing else Just (vcat real_es))
1766 ppr_decls_Amodes :: [CAddrMode] -> TeM (Maybe SDoc, Maybe SDoc)
1767 ppr_decls_Amodes amodes
1768 = mapTE ppr_decls_Amode amodes `thenTE` \ ps ->
1769 returnTE ( maybe_vcat ps )
1772 Print out a C Label where you want the *address* of the label, not the
1773 object it refers to. The distinction is important when the label may
1774 refer to a C structure (info tables and closures, for instance).
1776 When just generating a declaration for the label, use pprCLabel.
1779 pprCLabelAddr :: CLabel -> SDoc
1780 pprCLabelAddr clabel =
1781 case labelType clabel of
1782 InfoTblType -> addr_of_label
1783 ClosureType -> addr_of_label
1784 VecTblType -> addr_of_label
1787 addr_of_label = ptext SLIT("(P_)&") <> pp_label
1788 pp_label = pprCLabel clabel
1792 -----------------------------------------------------------------------------
1793 Initialising static objects with floating-point numbers. We can't
1794 just emit the floating point number, because C will cast it to an int
1795 by rounding it. We want the actual bit-representation of the float.
1797 This is a hack to turn the floating point numbers into ints that we
1798 can safely initialise to static locations.
1801 big_doubles = (getPrimRepSize DoubleRep) /= 1
1803 -- floatss are always 1 word
1804 floatToWord :: CAddrMode -> CAddrMode
1805 floatToWord (CLit (MachFloat r))
1807 arr <- newFloatArray ((0::Int),0)
1808 writeFloatArray arr 0 (fromRational r)
1809 i <- readIntArray arr 0
1810 return (CLit (MachInt (toInteger i)))
1813 doubleToWords :: CAddrMode -> [CAddrMode]
1814 doubleToWords (CLit (MachDouble r))
1815 | big_doubles -- doubles are 2 words
1817 arr <- newDoubleArray ((0::Int),1)
1818 writeDoubleArray arr 0 (fromRational r)
1819 i1 <- readIntArray arr 0
1820 i2 <- readIntArray arr 1
1821 return [ CLit (MachInt (toInteger i1))
1822 , CLit (MachInt (toInteger i2))
1825 | otherwise -- doubles are 1 word
1827 arr <- newDoubleArray ((0::Int),0)
1828 writeDoubleArray arr 0 (fromRational r)
1829 i <- readIntArray arr 0
1830 return [ CLit (MachInt (toInteger i)) ]