1 -----------------------------------------------------------------------------
3 -- Pretty-printing of Cmm as C, suitable for feeding gcc
5 -- (c) The University of Glasgow 2004
7 -----------------------------------------------------------------------------
10 -- Print Cmm as real C, for -fvia-C
12 -- This is simpler than the old PprAbsC, because Cmm is "macro-expanded"
13 -- relative to the old AbstractC, and many oddities/decorations have
14 -- disappeared from the data type.
17 -- ToDo: save/restore volatile registers around calls.
24 #include "HsVersions.h"
33 import Unique ( getUnique )
36 import UniqFM ( eltsUFM )
40 import CmdLineOpts ( opt_EnsureSplittableC )
43 import Data.List ( intersperse, group )
44 import Data.Bits ( shiftR )
45 import Char ( ord, chr )
50 import PprCmm () -- instances only
54 #if __GLASGOW_HASKELL__ >= 504
59 -- --------------------------------------------------------------------------
62 pprCs :: [Cmm] -> SDoc
63 pprCs cmms = pprCode CStyle (vcat $ map (\c -> split_marker $$ pprC c) cmms)
65 writeCs :: Handle -> [Cmm] -> IO ()
66 writeCs handle cmms = printForUser handle alwaysQualify (pprCs cmms)
67 -- ToDo: should be printForC
70 | opt_EnsureSplittableC = ptext SLIT("__STG_SPLIT_MARKER")
73 -- --------------------------------------------------------------------------
74 -- Now do some real work
76 -- for fun, we could call cmmToCmm over the tops...
80 pprC (Cmm tops) = vcat $ intersperse (text "") $ map pprTop tops
85 pprTop :: CmmTop -> SDoc
86 pprTop (CmmProc info clbl _params blocks) =
88 then pprWordArray (entryLblToInfoLbl clbl) info
92 -- the first block doesn't get a label:
93 (BasicBlock _ stmts : rest) -> vcat [
96 (if (externallyVisibleCLabel clbl)
97 then mkFN_ else mkIF_) (pprCLabel clbl) <+> lbrace,
100 nest 8 (vcat (map pprStmt stmts)) $$
101 vcat (map pprBBlock rest),
106 (temp_decls, extern_decls) = pprTempAndExternDecls blocks
109 -- Chunks of static data.
111 -- We only handle (a) arrays of word-sized things and (b) strings.
113 pprTop (CmmData _section _ds@[CmmDataLabel lbl, CmmString str]) =
115 pprLocalness lbl, ptext SLIT("char "), pprCLabel lbl,
116 ptext SLIT("[] = "), pprStringInCStyle str, semi
119 pprTop (CmmData _section _ds@[CmmDataLabel lbl, CmmUninitialised size]) =
121 pprLocalness lbl, ptext SLIT("char "), pprCLabel lbl,
122 brackets (int size), semi
125 pprTop top@(CmmData _section (CmmDataLabel lbl : lits)) =
126 pprDataExterns lits $$
127 pprWordArray lbl lits
129 -- these shouldn't appear?
130 pprTop (CmmData _ _) = panic "PprC.pprTop: can't handle this data"
133 -- --------------------------------------------------------------------------
134 -- BasicBlocks are self-contained entities: they always end in a jump.
136 -- Like nativeGen/AsmCodeGen, we could probably reorder blocks to turn
137 -- as many jumps as possible into fall throughs.
140 pprBBlock :: CmmBasicBlock -> SDoc
141 pprBBlock (BasicBlock lbl stmts) =
143 pprTrace "pprC.pprBBlock: curious empty code block for"
144 (pprBlockId lbl) empty
146 nest 4 (pprBlockId lbl <> colon) $$
147 nest 8 (vcat (map pprStmt stmts))
149 -- --------------------------------------------------------------------------
150 -- Info tables. Just arrays of words.
151 -- See codeGen/ClosureInfo, and nativeGen/PprMach
153 pprWordArray :: CLabel -> [CmmStatic] -> SDoc
155 = hcat [ pprLocalness lbl, ptext SLIT("StgWord")
156 , space, pprCLabel lbl, ptext SLIT("[] = {") ]
157 $$ nest 8 (commafy (pprStatics ds))
161 -- has to be static, if it isn't globally visible
163 pprLocalness :: CLabel -> SDoc
164 pprLocalness lbl | not $ externallyVisibleCLabel lbl = ptext SLIT("static ")
167 -- --------------------------------------------------------------------------
171 pprStmt :: CmmStmt -> SDoc
173 pprStmt stmt = case stmt of
175 CmmComment s -> (hang (ptext SLIT("/*")) 3 (ftext s)) $$ ptext SLIT("*/")
177 CmmAssign dest src -> pprAssign dest src
181 -> ptext SLIT("ASSIGN_Word64") <>
182 parens (mkP_ <> pprExpr1 dest <> comma <> pprExpr src) <> semi
185 -> hsep [ pprExpr (CmmLoad dest rep), equals, pprExpr src <> semi ]
189 CmmCall (CmmForeignCall fn cconv) results args volatile ->
190 -- Controversial: leave this out for now.
193 pprCall ppr_fn cconv results args volatile
196 CmmLit (CmmLabel lbl) -> pprCLabel lbl
197 _other -> parens (cCast (pprCFunType results args) fn)
198 -- for a dynamic call, cast the expression to
199 -- a function of the right type (we hope).
201 -- we #undef a function before calling it: the FFI is supposed to be
202 -- an interface specifically to C, not to C+CPP. For one thing, this
203 -- makes the via-C route more compatible with the NCG. If macros
204 -- are being used for optimisation, then inline functions are probably
206 pprUndef (CmmLit (CmmLabel lbl)) =
207 ptext SLIT("#undef") <+> pprCLabel lbl
210 CmmCall (CmmPrim op) results args volatile ->
211 pprCall ppr_fn CCallConv results args volatile
213 ppr_fn = pprCallishMachOp_for_C op
215 CmmBranch ident -> pprBranch ident
216 CmmCondBranch expr ident -> pprCondBranch expr ident
217 CmmJump lbl _params -> mkJMP_(pprExpr lbl) <> semi
218 CmmSwitch arg ids -> pprSwitch arg ids
220 pprCFunType :: [(CmmReg,MachHint)] -> [(CmmExpr,MachHint)] -> SDoc
221 pprCFunType ress args =
222 res_type ress <> parens (char '*') <> parens (commafy (map arg_type args))
224 res_type [] = ptext SLIT("void")
225 res_type [(one,hint)] = machRepHintCType (cmmRegRep one) hint
227 arg_type (expr,hint) = machRepHintCType (cmmExprRep expr) hint
229 -- ---------------------------------------------------------------------
230 -- unconditional branches
231 pprBranch :: BlockId -> SDoc
232 pprBranch ident = ptext SLIT("goto") <+> pprBlockId ident <> semi
235 -- ---------------------------------------------------------------------
236 -- conditional branches to local labels
237 pprCondBranch :: CmmExpr -> BlockId -> SDoc
238 pprCondBranch expr ident
239 = hsep [ ptext SLIT("if") , parens(pprExpr expr) ,
240 ptext SLIT("goto") , (pprBlockId ident) <> semi ]
243 -- ---------------------------------------------------------------------
244 -- a local table branch
246 -- we find the fall-through cases
248 -- N.B. we remove Nothing's from the list of branches, as they are
249 -- 'undefined'. However, they may be defined one day, so we better
250 -- document this behaviour.
252 pprSwitch :: CmmExpr -> [ Maybe BlockId ] -> SDoc
253 pprSwitch e maybe_ids
254 = let ids = [ i | Just i <- maybe_ids ]
255 pairs = zip [ 0 .. ] (concatMap markfalls (group ids))
257 (hang (ptext SLIT("switch") <+> parens ( pprExpr e ) <+> lbrace)
258 4 (vcat ( map caseify pairs )))
263 caseify (i,Left ident) =
264 hsep [ ptext SLIT("case") , pprHexVal i <> colon ,
265 ptext SLIT("/* fall through for"),
269 caseify (i,Right ident) =
270 hsep [ ptext SLIT("case") , pprHexVal i <> colon ,
271 ptext SLIT("goto") , (pprBlockId ident) <> semi ]
273 -- mark the bottom of a fallthough sequence of cases as `Right'
274 markfalls [a] = [Right a]
275 markfalls as = map (\a -> Left a) (init as) ++ [Right (last as)]
278 -- ---------------------------------------------------------------------
282 -- C Types: the invariant is that the C expression generated by
286 -- has a type in C which is also given by
288 -- machRepCType (cmmExprRep e)
290 -- (similar invariants apply to the rest of the pretty printer).
292 pprExpr :: CmmExpr -> SDoc
293 pprExpr e = case e of
294 CmmLit lit -> pprLit lit
297 -> ptext SLIT("PK_Word64") <> parens (mkP_ <> pprExpr1 e)
299 CmmLoad (CmmReg r) rep
300 | isPtrReg r && rep == wordRep
301 -> char '*' <> pprAsPtrReg r
303 CmmLoad (CmmRegOff r 0) rep
304 | isPtrReg r && rep == wordRep
305 -> char '*' <> pprAsPtrReg r
307 CmmLoad (CmmRegOff r off) rep
308 | isPtrReg r && rep == wordRep
309 -- ToDo: check that the offset is a word multiple?
310 -> pprAsPtrReg r <> brackets (ppr (off `shiftR` wordShift))
314 char '*' <> parens (cCast (machRepPtrCType rep) expr)
316 CmmReg reg -> pprCastReg reg
317 CmmRegOff reg 0 -> pprCastReg reg
320 | i > 0 -> pprRegOff (char '+') i
321 | otherwise -> pprRegOff (char '-') (-i)
323 pprRegOff op i' = pprCastReg reg <> op <> int i'
325 CmmMachOp mop args -> pprMachOpApp mop args
327 pprExpr1 :: CmmExpr -> SDoc
328 pprExpr1 (CmmLit lit) = pprLit1 lit
329 pprExpr1 e@(CmmReg _reg) = pprExpr e
330 pprExpr1 other = parens (pprExpr other)
332 -- --------------------------------------------------------------------------
333 -- MachOp applications
335 pprMachOpApp :: MachOp -> [CmmExpr] -> SDoc
339 = ptext SLIT("mulIntMayOflo") <> parens (commafy (map pprExpr args)) <> semi
340 where isMulMayOfloOp (MO_U_MulMayOflo _) = True
341 isMulMayOfloOp (MO_S_MulMayOflo _) = True
342 isMulMayOfloOp _ = False
344 pprMachOpApp mop args
347 [x,y] -> pprArg x <+> pprMachOp_for_C mop <+> pprArg y
350 [x] -> pprMachOp_for_C mop <> parens (pprArg x)
352 _ -> panic "PprC.pprMachOp : machop with wrong number of args"
355 pprArg e | signedOp mop = cCast (machRepSignedCType (cmmExprRep e)) e
356 | otherwise = pprExpr1 e
358 -- --------------------------------------------------------------------------
361 pprLit :: CmmLit -> SDoc
362 pprLit lit = case lit of
363 CmmInt i _rep -> pprHexVal i
364 CmmFloat f rep -> parens (machRepCType rep) <> (rational f)
365 CmmLabel clbl -> mkW_ <> pprCLabel clbl
366 CmmLabelOff clbl i -> mkW_ <> pprCLabel clbl <> char '+' <> int i
368 pprLit1 :: CmmLit -> SDoc
369 pprLit1 lit@(CmmLabelOff _ _) = parens (pprLit lit)
370 pprLit1 lit@(CmmFloat _ _) = parens (pprLit lit)
371 pprLit1 other = pprLit other
373 -- ---------------------------------------------------------------------------
376 pprStatics :: [CmmStatic] -> [SDoc]
378 pprStatics (CmmStaticLit (CmmFloat f F32) : rest)
379 = pprLit1 (floatToWord f) : pprStatics rest
380 pprStatics (CmmStaticLit (CmmFloat f F64) : rest)
381 = map pprLit1 (doubleToWords f) ++ pprStatics rest
382 pprStatics (CmmStaticLit (CmmInt i I64) : rest)
383 | machRepByteWidth I32 == wORD_SIZE
384 #ifdef WORDS_BIGENDIAN
385 = pprStatics (CmmStaticLit (CmmInt q I32) :
386 CmmStaticLit (CmmInt r I32) : rest)
388 = pprStatics (CmmStaticLit (CmmInt r I32) :
389 CmmStaticLit (CmmInt q I32) : rest)
391 where r = i .&. 0xffffffff
393 pprStatics (CmmStaticLit lit : rest)
394 = pprLit1 lit : pprStatics rest
395 pprStatics (other : rest)
396 = pprPanic "pprWord" (pprStatic other)
398 pprStatic :: CmmStatic -> SDoc
399 pprStatic s = case s of
401 CmmStaticLit lit -> nest 4 (pprLit lit)
402 CmmAlign i -> nest 4 (ptext SLIT("/* align */") <+> int i)
403 CmmDataLabel clbl -> pprCLabel clbl <> colon
404 CmmUninitialised i -> nest 4 (mkC_ <> brackets (int i))
406 -- these should be inlined, like the old .hc
407 CmmString s' -> nest 4 (mkW_ <> parens(pprStringInCStyle s'))
410 -- ---------------------------------------------------------------------------
413 pprBlockId :: BlockId -> SDoc
414 pprBlockId b = char '_' <> ppr (getUnique b)
416 -- --------------------------------------------------------------------------
417 -- Print a MachOp in a way suitable for emitting via C.
420 pprMachOp_for_C :: MachOp -> SDoc
422 pprMachOp_for_C mop = case mop of
424 -- Integer operations
427 MO_Eq _ -> ptext SLIT("==")
428 MO_Ne _ -> ptext SLIT("!=")
431 MO_S_Quot _ -> char '/'
432 MO_S_Rem _ -> char '%'
433 MO_S_Neg _ -> char '-'
435 MO_U_Quot _ -> char '/'
436 MO_U_Rem _ -> char '%'
438 -- Signed comparisons (floating-point comparisons also use these)
439 -- & Unsigned comparisons
440 MO_S_Ge _ -> ptext SLIT(">=")
441 MO_S_Le _ -> ptext SLIT("<=")
442 MO_S_Gt _ -> char '>'
443 MO_S_Lt _ -> char '<'
445 MO_U_Ge _ -> ptext SLIT(">=")
446 MO_U_Le _ -> ptext SLIT("<=")
447 MO_U_Gt _ -> char '>'
448 MO_U_Lt _ -> char '<'
450 -- Bitwise operations. Not all of these may be supported at all
451 -- sizes, and only integral MachReps are valid.
456 MO_Shl _ -> ptext SLIT("<<")
457 MO_U_Shr _ -> ptext SLIT(">>") -- unsigned shift right
458 MO_S_Shr _ -> ptext SLIT(">>") -- signed shift right
460 -- Conversions. Some of these will be NOPs.
461 -- Floating-point conversions use the signed variant.
462 -- We won't know to generate (void*) casts here, but maybe from
466 MO_U_Conv I8 I8 -> empty
467 MO_U_Conv I16 I16 -> empty
468 MO_U_Conv I32 I32 -> empty
469 MO_U_Conv I64 I64 -> empty
470 MO_U_Conv I128 I128 -> empty
471 MO_S_Conv I8 I8 -> empty
472 MO_S_Conv I16 I16 -> empty
473 MO_S_Conv I32 I32 -> empty
474 MO_S_Conv I64 I64 -> empty
475 MO_S_Conv I128 I128 -> empty
477 MO_U_Conv _from to -> parens (machRepCType to)
478 MO_S_Conv _from to -> parens (machRepSignedCType to)
480 _ -> panic "PprC.pprMachOp_for_C: unknown machop"
482 signedOp :: MachOp -> Bool
483 signedOp (MO_S_Quot _) = True
484 signedOp (MO_S_Rem _) = True
485 signedOp (MO_S_Neg _) = True
486 signedOp (MO_S_Ge _) = True
487 signedOp (MO_S_Le _) = True
488 signedOp (MO_S_Gt _) = True
489 signedOp (MO_S_Lt _) = True
490 signedOp (MO_S_Shr _) = True
491 signedOp (MO_S_Conv _ _) = True
494 -- ---------------------------------------------------------------------
495 -- tend to be implemented by foreign calls
497 pprCallishMachOp_for_C :: CallishMachOp -> SDoc
499 pprCallishMachOp_for_C mop
501 MO_F64_Pwr -> ptext SLIT("pow")
502 MO_F64_Sin -> ptext SLIT("sin")
503 MO_F64_Cos -> ptext SLIT("cos")
504 MO_F64_Tan -> ptext SLIT("tan")
505 MO_F64_Sinh -> ptext SLIT("sinh")
506 MO_F64_Cosh -> ptext SLIT("cosh")
507 MO_F64_Tanh -> ptext SLIT("tanh")
508 MO_F64_Asin -> ptext SLIT("asin")
509 MO_F64_Acos -> ptext SLIT("asin")
510 MO_F64_Atan -> ptext SLIT("atan")
511 MO_F64_Log -> ptext SLIT("log")
512 MO_F64_Exp -> ptext SLIT("exp")
513 MO_F64_Sqrt -> ptext SLIT("sqrt")
514 MO_F32_Pwr -> ptext SLIT("pow")
515 MO_F32_Sin -> ptext SLIT("sin")
516 MO_F32_Cos -> ptext SLIT("cos")
517 MO_F32_Tan -> ptext SLIT("tan")
518 MO_F32_Sinh -> ptext SLIT("sinh")
519 MO_F32_Cosh -> ptext SLIT("cosh")
520 MO_F32_Tanh -> ptext SLIT("tanh")
521 MO_F32_Asin -> ptext SLIT("asin")
522 MO_F32_Acos -> ptext SLIT("acos")
523 MO_F32_Atan -> ptext SLIT("atan")
524 MO_F32_Log -> ptext SLIT("log")
525 MO_F32_Exp -> ptext SLIT("exp")
526 MO_F32_Sqrt -> ptext SLIT("sqrt")
528 -- ---------------------------------------------------------------------
532 mkJMP_, mkFN_, mkIF_ :: SDoc -> SDoc
534 mkJMP_ i = ptext SLIT("JMP_") <> parens i
535 mkFN_ i = ptext SLIT("FN_") <> parens i -- externally visible function
536 mkIF_ i = ptext SLIT("IF_") <> parens i -- locally visible
540 mkFB_ = ptext SLIT("FB_") -- function code begin
541 mkFE_ = ptext SLIT("FE_") -- function code end
543 -- from includes/Stg.h
545 mkC_,mkW_,mkP_,mkPP_,mkI_,mkA_,mkD_,mkF_,mkB_,mkL_,mkLI_,mkLW_ :: SDoc
547 mkC_ = ptext SLIT("(C_)") -- StgChar
548 mkW_ = ptext SLIT("(W_)") -- StgWord
549 mkP_ = ptext SLIT("(P_)") -- StgWord*
550 mkPP_ = ptext SLIT("(PP_)") -- P_*
551 mkI_ = ptext SLIT("(I_)") -- StgInt
552 mkA_ = ptext SLIT("(A_)") -- StgAddr
553 mkD_ = ptext SLIT("(D_)") -- const StgWord*
554 mkF_ = ptext SLIT("(F_)") -- StgFunPtr
555 mkB_ = ptext SLIT("(B_)") -- StgByteArray
556 mkL_ = ptext SLIT("(L_)") -- StgClosurePtr
558 mkLI_ = ptext SLIT("(LI_)") -- StgInt64
559 mkLW_ = ptext SLIT("(LW_)") -- StgWord64
562 -- ---------------------------------------------------------------------
566 -- Generating assignments is what we're all about, here
568 pprAssign :: CmmReg -> CmmExpr -> SDoc
570 -- dest is a reg, rhs is a reg
571 pprAssign r1 (CmmReg r2)
572 | not (isStrangeTypeReg r1) && not (isStrangeTypeReg r2)
573 || isPtrReg r1 && isPtrReg r2
574 = hcat [ pprAsPtrReg r1, equals, pprAsPtrReg r2, semi ]
576 -- dest is a reg, rhs is a CmmRegOff
577 pprAssign r1 (CmmRegOff r2 off)
578 | not (isStrangeTypeReg r1) && not (isStrangeTypeReg r2)
579 || isPtrReg r1 && isPtrReg r2
580 = hcat [ pprAsPtrReg r1, equals, pprAsPtrReg r2, op, int off', semi ]
582 off1 | isPtrReg r2 = off `shiftR` wordShift
585 (op,off') | off >= 0 = (char '+', off1)
586 | otherwise = (char '-', -off1)
588 -- dest is a reg, rhs is anything.
589 -- We can't cast the lvalue, so we have to cast the rhs if necessary. Casting
590 -- the lvalue elicits a warning from new GCC versions (3.4+).
593 = pprAsPtrReg r1 <> ptext SLIT(" = ") <> mkP_ <> pprExpr1 r2 <> semi
594 | Just ty <- strangeRegType r1
595 = pprReg r1 <> ptext SLIT(" = ") <> parens ty <> pprExpr1 r2 <> semi
597 = pprReg r1 <> ptext SLIT(" = ") <> pprExpr r2 <> semi
599 -- ---------------------------------------------------------------------
603 | isStrangeTypeReg reg = mkW_ <> pprReg reg
604 | otherwise = pprReg reg
606 -- True if the register has type StgPtr in C, otherwise it has an
607 -- integer type. We need to take care with pointer arithmetic on registers
609 isPtrReg :: CmmReg -> Bool
610 isPtrReg (CmmLocal _) = False
611 isPtrReg (CmmGlobal r) = isPtrGlobalReg r
613 isPtrGlobalReg :: GlobalReg -> Bool
614 isPtrGlobalReg (VanillaReg n) = True
615 isPtrGlobalReg Sp = True
616 isPtrGlobalReg Hp = True
617 isPtrGlobalReg HpLim = True
618 isPtrGlobalReg SpLim = True
619 isPtrGlobalReg _ = False
621 -- True if in C this register doesn't have the type given by
622 -- (machRepCType (cmmRegRep reg)), so it has to be cast.
623 isStrangeTypeReg :: CmmReg -> Bool
624 isStrangeTypeReg (CmmLocal _) = False
625 isStrangeTypeReg (CmmGlobal g) = isStrangeTypeGlobal g
627 isStrangeTypeGlobal :: GlobalReg -> Bool
628 isStrangeTypeGlobal CurrentTSO = True
629 isStrangeTypeGlobal CurrentNursery = True
630 isStrangeTypeGlobal r = isPtrGlobalReg r
632 strangeRegType :: CmmReg -> Maybe SDoc
633 strangeRegType (CmmGlobal CurrentTSO) = Just (ptext SLIT("struct StgTSO_ *"))
634 strangeRegType (CmmGlobal CurrentNursery) = Just (ptext SLIT("struct bdescr_ *"))
635 strangeRegType _ = Nothing
637 -- pprReg just prints the register name.
639 pprReg :: CmmReg -> SDoc
641 CmmLocal local -> pprLocalReg local
642 CmmGlobal global -> pprGlobalReg global
644 pprAsPtrReg :: CmmReg -> SDoc
645 pprAsPtrReg (CmmGlobal (VanillaReg n)) = char 'R' <> int n <> ptext SLIT(".p")
646 pprAsPtrReg other_reg = pprReg other_reg
648 pprGlobalReg :: GlobalReg -> SDoc
649 pprGlobalReg gr = case gr of
650 VanillaReg n -> char 'R' <> int n <> ptext SLIT(".w")
651 FloatReg n -> char 'F' <> int n
652 DoubleReg n -> char 'D' <> int n
653 LongReg n -> char 'L' <> int n
654 Sp -> ptext SLIT("Sp")
655 SpLim -> ptext SLIT("SpLim")
656 Hp -> ptext SLIT("Hp")
657 HpLim -> ptext SLIT("HpLim")
658 CurrentTSO -> ptext SLIT("CurrentTSO")
659 CurrentNursery -> ptext SLIT("CurrentNursery")
660 HpAlloc -> ptext SLIT("HpAlloc")
661 BaseReg -> ptext SLIT("BaseReg")
662 GCEnter1 -> ptext SLIT("stg_gc_enter_1")
663 GCFun -> ptext SLIT("stg_gc_fun")
665 pprLocalReg :: LocalReg -> SDoc
666 pprLocalReg (LocalReg uniq _rep) = char '_' <> ppr uniq
668 -- -----------------------------------------------------------------------------
671 pprCall :: SDoc -> CCallConv -> [(CmmReg,MachHint)] -> [(CmmExpr,MachHint)]
672 -> Maybe [GlobalReg] -> SDoc
674 pprCall ppr_fn cconv results args vols
675 | not (is_cish cconv)
676 = panic "pprForeignCall: unknown calling convention"
680 ptext SLIT("CALLER_SAVE_SYSTEM") $$
681 hcat [ ppr_results results, ppr_fn,
682 parens (commafy (map pprArg args)), semi ] $$
683 ptext SLIT("CALLER_RESTORE_SYSTEM") $$
686 ppr_results [] = empty
687 ppr_results [(one,hint)]
688 = pprExpr (CmmReg one) <> ptext SLIT(" = ") <> pprUnHint hint
689 ppr_results _other = panic "pprCall: multiple results"
691 pprArg (expr, PtrHint)
692 = cCast (ptext SLIT("void *")) expr
693 -- see comment by machRepHintCType below
694 pprArg (expr, SignedHint)
695 = cCast (machRepSignedCType (cmmExprRep expr)) expr
696 pprArg (expr, _other)
699 pprUnHint PtrHint = mkW_
700 pprUnHint SignedHint = mkW_
703 save = save_restore SLIT("CALLER_SAVE")
704 restore = save_restore SLIT("CALLER_RESTORE")
706 -- Nothing says "I don't know what's live; save everything"
707 -- CALLER_SAVE_USER is defined in ghc/includes/Regs.h
708 save_restore txt Nothing = ptext txt <> ptext SLIT("_USER")
709 save_restore txt (Just these) = vcat (map saveRestoreGlobal these)
710 where saveRestoreGlobal r = ptext txt <> char '_' <> pprGlobalRegName r
712 pprGlobalRegName :: GlobalReg -> SDoc
713 pprGlobalRegName gr = case gr of
714 VanillaReg n -> char 'R' <> int n -- without the .w suffix
717 is_cish CCallConv = True
718 is_cish StdCallConv = True
721 -- ---------------------------------------------------------------------
722 -- Find and print local and external declarations for a list of
725 pprTempAndExternDecls :: [CmmBasicBlock] -> (SDoc{-temps-}, SDoc{-externs-})
726 pprTempAndExternDecls stmts
727 = (vcat (map pprTempDecl (eltsUFM temps)),
728 vcat (map (pprExternDecl False{-ToDo-}) (keysFM lbls)))
729 where (temps, lbls) = runTE (mapM_ te_BB stmts)
731 pprDataExterns :: [CmmStatic] -> SDoc
732 pprDataExterns statics
733 = vcat (map (pprExternDecl False{-ToDo-}) (keysFM lbls))
734 where (_, lbls) = runTE (mapM_ te_Static statics)
736 pprTempDecl :: LocalReg -> SDoc
737 pprTempDecl l@(LocalReg _uniq rep)
738 = hcat [ machRepCType rep, space, pprLocalReg l, semi ]
740 pprExternDecl :: Bool -> CLabel -> SDoc
741 pprExternDecl in_srt lbl
742 -- do not print anything for "known external" things
743 | not (needsCDecl lbl) = empty
745 hcat [ visibility, label_type (labelType lbl),
746 lparen, dyn_wrapper (pprCLabel lbl), text ");" ]
749 | in_srt && labelDynamic lbl = text "DLL_IMPORT_DATA_VAR" <> parens d
752 label_type CodeLabel = ptext SLIT("F_")
753 label_type DataLabel = ptext SLIT("I_")
756 | externallyVisibleCLabel lbl = char 'E'
757 | otherwise = char 'I'
760 type TEState = (UniqSet LocalReg, FiniteMap CLabel ())
761 newtype TE a = TE { unTE :: TEState -> (a, TEState) }
763 instance Monad TE where
764 TE m >>= k = TE $ \s -> case m s of (a, s') -> unTE (k a) s'
765 return a = TE $ \s -> (a, s)
767 te_lbl :: CLabel -> TE ()
768 te_lbl lbl = TE $ \(temps,lbls) -> ((), (temps, addToFM lbls lbl ()))
770 te_temp :: LocalReg -> TE ()
771 te_temp r = TE $ \(temps,lbls) -> ((), (addOneToUniqSet temps r, lbls))
773 runTE :: TE () -> TEState
774 runTE (TE m) = snd (m (emptyUniqSet, emptyFM))
776 te_Static :: CmmStatic -> TE ()
777 te_Static (CmmStaticLit lit) = te_Lit lit
778 te_Static _ = return ()
780 te_BB :: CmmBasicBlock -> TE ()
781 te_BB (BasicBlock _ ss) = mapM_ te_Stmt ss
783 te_Lit :: CmmLit -> TE ()
784 te_Lit (CmmLabel l) = te_lbl l
787 te_Stmt :: CmmStmt -> TE ()
788 te_Stmt (CmmAssign r e) = te_Reg r >> te_Expr e
789 te_Stmt (CmmStore l r) = te_Expr l >> te_Expr r
790 te_Stmt (CmmCall _ rs es _) = mapM_ (te_Reg.fst) rs >>
791 mapM_ (te_Expr.fst) es
792 te_Stmt (CmmCondBranch e _) = te_Expr e
793 te_Stmt (CmmSwitch e _) = te_Expr e
794 te_Stmt (CmmJump e _) = te_Expr e
795 te_Stmt _ = return ()
797 te_Expr :: CmmExpr -> TE ()
798 te_Expr (CmmLit lit) = te_Lit lit
799 te_Expr (CmmReg r) = te_Reg r
800 te_Expr (CmmLoad e _) = te_Expr e
801 te_Expr (CmmMachOp _ es) = mapM_ te_Expr es
802 te_Expr (CmmRegOff r _) = te_Reg r
803 te_Expr _ = return ()
805 te_Reg :: CmmReg -> TE ()
806 te_Reg (CmmLocal l) = te_temp l
810 -- ---------------------------------------------------------------------
811 -- C types for MachReps
813 cCast :: SDoc -> CmmExpr -> SDoc
814 cCast ty expr = parens ty <> pprExpr1 expr
816 -- This is for finding the types of foreign call arguments. For a pointer
817 -- argument, we always cast the argument to (void *), to avoid warnings from
819 machRepHintCType :: MachRep -> MachHint -> SDoc
820 machRepHintCType rep PtrHint = ptext SLIT("void *")
821 machRepHintCType rep SignedHint = machRepSignedCType rep
822 machRepHintCType rep _other = machRepCType rep
824 machRepPtrCType :: MachRep -> SDoc
825 machRepPtrCType r | r == wordRep = ptext SLIT("P_")
826 | otherwise = machRepCType r <> char '*'
828 machRepCType :: MachRep -> SDoc
829 machRepCType r | r == wordRep = ptext SLIT("W_")
830 | otherwise = sized_type
831 where sized_type = case r of
832 I8 -> ptext SLIT("StgWord8")
833 I16 -> ptext SLIT("StgWord16")
834 I32 -> ptext SLIT("StgWord32")
835 I64 -> ptext SLIT("StgWord64")
836 F32 -> ptext SLIT("StgFloat") -- ToDo: correct?
837 F64 -> ptext SLIT("StgDouble")
838 _ -> panic "machRepCType"
840 machRepSignedCType :: MachRep -> SDoc
841 machRepSignedCType r | r == wordRep = ptext SLIT("I_")
842 | otherwise = sized_type
843 where sized_type = case r of
844 I8 -> ptext SLIT("StgInt8")
845 I16 -> ptext SLIT("StgInt16")
846 I32 -> ptext SLIT("StgInt32")
847 I64 -> ptext SLIT("StgInt64")
848 F32 -> ptext SLIT("StgFloat") -- ToDo: correct?
849 F64 -> ptext SLIT("StgDouble")
850 _ -> panic "machRepCType"
852 -- ---------------------------------------------------------------------
853 -- print strings as valid C strings
855 -- Assumes it contains only characters '\0'..'\xFF'!
856 pprFSInCStyle :: FastString -> SDoc
857 pprFSInCStyle fs = pprStringInCStyle (unpackFS fs)
859 pprStringInCStyle :: String -> SDoc
860 pprStringInCStyle s = doubleQuotes (text (concatMap charToC s))
862 charToC :: Char -> String
863 charToC '\"' = "\\\""
864 charToC '\'' = "\\\'"
865 charToC '\\' = "\\\\"
866 charToC c | c >= ' ' && c <= '~' = [c]
867 | c > '\xFF' = panic ("charToC "++show c)
869 chr (ord '0' + ord c `div` 64),
870 chr (ord '0' + ord c `div` 8 `mod` 8),
871 chr (ord '0' + ord c `mod` 8)]
874 -- ---------------------------------------------------------------------------
875 -- Initialising static objects with floating-point numbers. We can't
876 -- just emit the floating point number, because C will cast it to an int
877 -- by rounding it. We want the actual bit-representation of the float.
879 -- This is a hack to turn the floating point numbers into ints that we
880 -- can safely initialise to static locations.
883 | machRepByteWidth F64 == 2 * wORD_SIZE = True
884 | machRepByteWidth F64 == wORD_SIZE = False
885 | otherwise = panic "big_doubles"
887 #if __GLASGOW_HASKELL__ >= 504
888 newFloatArray :: (Int,Int) -> ST s (STUArray s Int Float)
889 newFloatArray = newArray_
891 newDoubleArray :: (Int,Int) -> ST s (STUArray s Int Double)
892 newDoubleArray = newArray_
894 castFloatToIntArray :: STUArray s Int Float -> ST s (STUArray s Int Int)
895 castFloatToIntArray = castSTUArray
897 castDoubleToIntArray :: STUArray s Int Double -> ST s (STUArray s Int Int)
898 castDoubleToIntArray = castSTUArray
900 writeFloatArray :: STUArray s Int Float -> Int -> Float -> ST s ()
901 writeFloatArray = writeArray
903 writeDoubleArray :: STUArray s Int Double -> Int -> Double -> ST s ()
904 writeDoubleArray = writeArray
906 readIntArray :: STUArray s Int Int -> Int -> ST s Int
907 readIntArray = readArray
911 castFloatToIntArray :: MutableByteArray s t -> ST s (MutableByteArray s t)
912 castFloatToIntArray = return
914 castDoubleToIntArray :: MutableByteArray s t -> ST s (MutableByteArray s t)
915 castDoubleToIntArray = return
919 -- floats are always 1 word
920 floatToWord :: Rational -> CmmLit
923 arr <- newFloatArray ((0::Int),0)
924 writeFloatArray arr 0 (fromRational r)
925 arr' <- castFloatToIntArray arr
926 i <- readIntArray arr' 0
927 return (CmmInt (toInteger i) wordRep)
930 doubleToWords :: Rational -> [CmmLit]
932 | big_doubles -- doubles are 2 words
934 arr <- newDoubleArray ((0::Int),1)
935 writeDoubleArray arr 0 (fromRational r)
936 arr' <- castDoubleToIntArray arr
937 i1 <- readIntArray arr' 0
938 i2 <- readIntArray arr' 1
939 return [ CmmInt (toInteger i1) wordRep
940 , CmmInt (toInteger i2) wordRep
943 | otherwise -- doubles are 1 word
945 arr <- newDoubleArray ((0::Int),0)
946 writeDoubleArray arr 0 (fromRational r)
947 arr' <- castDoubleToIntArray arr
948 i <- readIntArray arr' 0
949 return [ CmmInt (toInteger i) wordRep ]
952 -- ---------------------------------------------------------------------------
956 wordShift = machRepLogWidth wordRep
958 commafy :: [SDoc] -> SDoc
959 commafy xs = hsep $ punctuate comma xs
961 -- Print in C hex format: 0x13fa
962 pprHexVal :: Integer -> SDoc
963 pprHexVal 0 = ptext SLIT("0x0")
965 | w < 0 = parens (char '-' <> ptext SLIT("0x") <> go (-w))
966 | otherwise = ptext SLIT("0x") <> go w
971 (q,r) = w' `quotRem` 16
972 dig | r < 10 = char (chr (fromInteger r + ord '0'))
973 | otherwise = char (chr (fromInteger r - 10 + ord 'a'))