PprCmm.hs 20.7 KB
Newer Older
1 2 3 4
----------------------------------------------------------------------------
--
-- Pretty-printing of Cmm as (a superset of) C--
--
Simon Marlow's avatar
Simon Marlow committed
5
-- (c) The University of Glasgow 2004-2006
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
--
-----------------------------------------------------------------------------

--
-- This is where we walk over Cmm emitting an external representation,
-- suitable for parsing, in a syntax strongly reminiscent of C--. This
-- is the "External Core" for the Cmm layer.
--
-- As such, this should be a well-defined syntax: we want it to look nice.
-- Thus, we try wherever possible to use syntax defined in [1],
-- "The C-- Reference Manual", http://www.cminusminus.org/. We differ
-- slightly, in some cases. For one, we use I8 .. I64 for types, rather
-- than C--'s bits8 .. bits64.
--
-- We try to ensure that all information available in the abstract
-- syntax is reproduced, or reproducible, in the concrete syntax.
-- Data that is not in printed out can be reconstructed according to
-- conventions used in the pretty printer. There are at least two such
-- cases:
--      1) if a value has wordRep type, the type is not appended in the
--      output.
--      2) MachOps that operate over wordRep type are printed in a
--      C-style, rather than as their internal MachRep name.
--
-- These conventions produce much more readable Cmm output.
--
-- A useful example pass over Cmm is in nativeGen/MachCodeGen.hs
--

35
module PprCmm
36
    ( writeCmms, pprCmms, pprCmm, pprStmt, pprExpr, pprSection, pprStatic, pprLit
37 38
    )
where
39

40
import BlockId
41
import Cmm
Simon Marlow's avatar
Simon Marlow committed
42 43 44
import CmmUtils
import MachOp
import CLabel
45

Simon Marlow's avatar
Simon Marlow committed
46 47
import ForeignCall
import Unique
48
import Outputable
Simon Marlow's avatar
Simon Marlow committed
49
import FastString
50

Simon Marlow's avatar
Simon Marlow committed
51 52 53
import Data.List
import System.IO
import Data.Maybe
54

55
pprCmms :: (Outputable info, Outputable g) => [GenCmm CmmStatic info g] -> SDoc
56 57
pprCmms cmms = pprCode CStyle (vcat (intersperse separator $ map ppr cmms))
        where
Ian Lynagh's avatar
Ian Lynagh committed
58
          separator = space $$ ptext (sLit "-------------------") $$ space
59 60 61 62 63 64

writeCmms :: Handle -> [Cmm] -> IO ()
writeCmms handle cmms = printForC handle (pprCmms cmms)

-----------------------------------------------------------------------------

65 66
instance (Outputable d, Outputable info, Outputable g)
    => Outputable (GenCmm d info g) where
67 68
    ppr c = pprCmm c

69 70
instance (Outputable d, Outputable info, Outputable i)
	=> Outputable (GenCmmTop d info i) where
71 72
    ppr t = pprTop t

73
instance (Outputable instr) => Outputable (ListGraph instr) where
74 75
    ppr (ListGraph blocks) = vcat (map ppr blocks)

76
instance (Outputable instr) => Outputable (GenBasicBlock instr) where
77 78 79 80 81 82 83 84 85 86 87
    ppr b = pprBBlock b

instance Outputable CmmStmt where
    ppr s = pprStmt s

instance Outputable CmmExpr where
    ppr e = pprExpr e

instance Outputable CmmReg where
    ppr e = pprReg e

88 89 90
instance Outputable CmmLit where
    ppr l = pprLit l

91 92 93
instance Outputable LocalReg where
    ppr e = pprLocalReg e

94 95 96
instance Outputable Area where
    ppr e = pprArea e

97 98 99
instance Outputable GlobalReg where
    ppr e = pprGlobalReg e

100 101 102 103 104 105
instance Outputable CmmStatic where
    ppr e = pprStatic e

instance Outputable CmmInfo where
    ppr e = pprInfo e

106 107


108 109
-----------------------------------------------------------------------------

110
pprCmm :: (Outputable d, Outputable info, Outputable g) => GenCmm d info g -> SDoc
111 112 113
pprCmm (Cmm tops) = vcat $ intersperse (text "") $ map pprTop tops

-- --------------------------------------------------------------------------
114
-- Top level `procedure' blocks.
115
--
116 117
pprTop 	:: (Outputable d, Outputable info, Outputable i)
	=> GenCmmTop d info i -> SDoc
118

119
pprTop (CmmProc info lbl params graph )
120

121
  = vcat [ pprCLabel lbl <> parens (commafy $ map ppr params) <+> lbrace
122
         , nest 8 $ lbrace <+> ppr info $$ rbrace
123
         , nest 4 $ ppr graph
124 125 126 127 128 129 130 131
         , rbrace ]

-- --------------------------------------------------------------------------
-- We follow [1], 4.5
--
--      section "data" { ... }
--
pprTop (CmmData section ds) = 
132
    (hang (pprSection section <+> lbrace) 4 (vcat (map ppr ds)))
133 134
    $$ rbrace

135 136
-- --------------------------------------------------------------------------
instance Outputable CmmSafety where
Ian Lynagh's avatar
Ian Lynagh committed
137
  ppr CmmUnsafe = ptext (sLit "_unsafe_call_")
138
  ppr (CmmSafe srt) = ppr srt
139 140 141 142 143 144 145 146

-- --------------------------------------------------------------------------
-- Info tables. The current pretty printer needs refinement
-- but will work for now.
--
-- For ideas on how to refine it, they used to be printed in the
-- style of C--'s 'stackdata' declaration, just inside the proc body,
-- and were labelled with the procedure name ++ "_info".
147 148
pprInfo :: CmmInfo -> SDoc
pprInfo (CmmInfo _gc_target update_frame CmmNonInfoTable) =
Ian Lynagh's avatar
Ian Lynagh committed
149 150 151 152
    vcat [{-ptext (sLit "gc_target: ") <>
                maybe (ptext (sLit "<none>")) pprBlockId gc_target,-}
          ptext (sLit "update_frame: ") <>
                maybe (ptext (sLit "<none>")) pprUpdateFrame update_frame]
153
pprInfo (CmmInfo _gc_target update_frame
154
         (CmmInfoTable (ProfilingInfo closure_type closure_desc) tag info)) =
Ian Lynagh's avatar
Ian Lynagh committed
155 156 157 158 159 160 161
    vcat [{-ptext (sLit "gc_target: ") <>
                maybe (ptext (sLit "<none>")) pprBlockId gc_target,-}
          ptext (sLit "update_frame: ") <>
                maybe (ptext (sLit "<none>")) pprUpdateFrame update_frame,
          ptext (sLit "type: ") <> pprLit closure_type,
          ptext (sLit "desc: ") <> pprLit closure_desc,
          ptext (sLit "tag: ") <> integer (toInteger tag),
162 163
          pprTypeInfo info]

164
pprTypeInfo :: ClosureTypeInfo -> SDoc
165
pprTypeInfo (ConstrInfo layout constr descr) =
Ian Lynagh's avatar
Ian Lynagh committed
166 167 168
    vcat [ptext (sLit "ptrs: ") <> integer (toInteger (fst layout)),
          ptext (sLit "nptrs: ") <> integer (toInteger (snd layout)),
          ptext (sLit "constructor: ") <> integer (toInteger constr),
169
          pprLit descr]
170
pprTypeInfo (FunInfo layout srt fun_type arity _args slow_entry) =
Ian Lynagh's avatar
Ian Lynagh committed
171 172 173 174 175 176 177
    vcat [ptext (sLit "ptrs: ") <> integer (toInteger (fst layout)),
          ptext (sLit "nptrs: ") <> integer (toInteger (snd layout)),
          ptext (sLit "srt: ") <> ppr srt,
          ptext (sLit "fun_type: ") <> integer (toInteger fun_type),
          ptext (sLit "arity: ") <> integer (toInteger arity),
          --ptext (sLit "args: ") <> ppr args, -- TODO: needs to be printed
          ptext (sLit "slow: ") <> pprLit slow_entry
178 179
         ]
pprTypeInfo (ThunkInfo layout srt) =
Ian Lynagh's avatar
Ian Lynagh committed
180 181 182
    vcat [ptext (sLit "ptrs: ") <> integer (toInteger (fst layout)),
          ptext (sLit "nptrs: ") <> integer (toInteger (snd layout)),
          ptext (sLit "srt: ") <> ppr srt]
183
pprTypeInfo (ThunkSelectorInfo offset srt) =
Ian Lynagh's avatar
Ian Lynagh committed
184 185
    vcat [ptext (sLit "ptrs: ") <> integer (toInteger offset),
          ptext (sLit "srt: ") <> ppr srt]
186
pprTypeInfo (ContInfo stack srt) =
Ian Lynagh's avatar
Ian Lynagh committed
187 188
    vcat [ptext (sLit "stack: ") <> ppr stack,
          ptext (sLit "srt: ") <> ppr srt]
189

190 191
pprUpdateFrame :: UpdateFrame -> SDoc
pprUpdateFrame (UpdateFrame expr args) = 
Ian Lynagh's avatar
Ian Lynagh committed
192
    hcat [ ptext (sLit "jump")
193 194 195 196 197 198 199 200 201 202
         , space
         , if isTrivialCmmExpr expr
                then pprExpr expr
                else case expr of
                    CmmLoad (CmmReg _) _ -> pprExpr expr 
                    _ -> parens (pprExpr expr)
         , space
         , parens  ( commafy $ map ppr args ) ]


203 204 205
-- --------------------------------------------------------------------------
-- Basic blocks look like assembly blocks.
--      lbl: stmt ; stmt ; .. 
206
pprBBlock :: Outputable stmt => GenBasicBlock stmt -> SDoc
207 208 209 210 211 212 213 214 215 216 217 218
pprBBlock (BasicBlock ident stmts) =
    hang (pprBlockId ident <> colon) 4 (vcat (map ppr stmts))

-- --------------------------------------------------------------------------
-- Statements. C-- usually, exceptions to this should be obvious.
--
pprStmt :: CmmStmt -> SDoc    
pprStmt stmt = case stmt of

    -- ;
    CmmNop -> semi

219
    --  // text
220 221 222 223 224 225 226 227 228 229 230 231
    CmmComment s -> text "//" <+> ftext s

    -- reg = expr;
    CmmAssign reg expr -> ppr reg <+> equals <+> ppr expr <> semi

    -- rep[lv] = expr;
    CmmStore lv expr -> rep <> brackets(ppr lv) <+> equals <+> ppr expr <> semi
        where
          rep = ppr ( cmmExprRep expr )

    -- call "ccall" foo(x, y)[r1, r2];
    -- ToDo ppr volatile
232
    CmmCall (CmmCallee fn cconv) results args safety ret ->
233 234 235
        hcat [ if null results
                  then empty
                  else parens (commafy $ map ppr results) <>
Ian Lynagh's avatar
Ian Lynagh committed
236 237
                       ptext (sLit " = "),
               ptext (sLit "foreign"), space, 
238 239
               doubleQuotes(ppr cconv), space,
               target fn, parens  ( commafy $ map ppr args ),
240 241
               brackets (ppr safety), 
               case ret of CmmMayReturn -> empty
Ian Lynagh's avatar
Ian Lynagh committed
242
                           CmmNeverReturns -> ptext (sLit " never returns"),
243
               semi ]
244
        where
245 246 247 248 249 250 251
          ---- With the following three functions, I was going somewhere
          ---- useful, but I don't remember where.  Probably making 
          ---- emitted Cmm output look better. ---NR, 2 May 2008
	  _pp_lhs | null results = empty
		  | otherwise    = commafy (map ppr_ar results) <+> equals
		-- Don't print the hints on a native C-- call
	  ppr_ar arg = case cconv of
252 253 254
			    CmmCallConv -> ppr (kindlessCmm arg)
			    _   	-> doubleQuotes (ppr $ cmmKind arg) <+>
                                           ppr (kindlessCmm arg)
255 256 257 258 259 260
	  _pp_conv = case cconv of
		      CmmCallConv -> empty
		      _ -> ptext (sLit "foreign") <+> doubleQuotes (ppr cconv)

          target (CmmLit lit) = pprLit lit
          target fn'          = parens (ppr fn')
261

262
    CmmCall (CmmPrim op) results args safety ret ->
263
        pprStmt (CmmCall (CmmCallee (CmmLit lbl) CCallConv)
264
                        results args safety ret)
265 266 267 268 269 270
        where
          lbl = CmmLabel (mkForeignLabel (mkFastString (show op)) Nothing False)

    CmmBranch ident          -> genBranch ident
    CmmCondBranch expr ident -> genCondBranch expr ident
    CmmJump expr params      -> genJump expr params
271
    CmmReturn params         -> genReturn params
272 273 274 275 276 277 278 279 280
    CmmSwitch arg ids        -> genSwitch arg ids

-- --------------------------------------------------------------------------
-- goto local label. [1], section 6.6
--
--     goto lbl;
--
genBranch :: BlockId -> SDoc
genBranch ident = 
Ian Lynagh's avatar
Ian Lynagh committed
281
    ptext (sLit "goto") <+> pprBlockId ident <> semi
282 283 284 285 286 287 288 289

-- --------------------------------------------------------------------------
-- Conditional. [1], section 6.4
--
--     if (expr) { goto lbl; } 
--
genCondBranch :: CmmExpr -> BlockId -> SDoc
genCondBranch expr ident =
Ian Lynagh's avatar
Ian Lynagh committed
290
    hsep [ ptext (sLit "if")
291
         , parens(ppr expr)
Ian Lynagh's avatar
Ian Lynagh committed
292
         , ptext (sLit "goto")
293 294 295 296 297 298 299
         , pprBlockId ident <> semi ]

-- --------------------------------------------------------------------------
-- A tail call. [1], Section 6.9
--
--     jump foo(a, b, c);
--
300
genJump :: CmmExpr -> [CmmKinded CmmExpr] -> SDoc
301
genJump expr args = 
302

Ian Lynagh's avatar
Ian Lynagh committed
303
    hcat [ ptext (sLit "jump")
304 305 306 307 308 309
         , space
         , if isTrivialCmmExpr expr
                then pprExpr expr
                else case expr of
                    CmmLoad (CmmReg _) _ -> pprExpr expr 
                    _ -> parens (pprExpr expr)
310
         , space
311
         , parens  ( commafy $ map pprKinded args )
312 313
         , semi ]

314 315 316 317 318
pprKinded :: Outputable a => (CmmKinded a) -> SDoc
pprKinded (CmmKinded a NoHint)     = ppr a
pprKinded (CmmKinded a PtrHint)    = quotes(text "address") <+> ppr a
pprKinded (CmmKinded a SignedHint) = quotes(text "signed")  <+> ppr a
pprKinded (CmmKinded a FloatHint)  = quotes(text "float")   <+> ppr a
319

320 321 322 323 324
-- --------------------------------------------------------------------------
-- Return from a function. [1], Section 6.8.2 of version 1.128
--
--     return (a, b, c);
--
325
genReturn :: [CmmKinded CmmExpr] -> SDoc
326 327
genReturn args = 

Ian Lynagh's avatar
Ian Lynagh committed
328
    hcat [ ptext (sLit "return")
329 330 331
         , space
         , parens  ( commafy $ map ppr args )
         , semi ]
332 333 334 335 336 337 338 339 340 341 342

-- --------------------------------------------------------------------------
-- Tabled jump to local label
--
-- The syntax is from [1], section 6.5
--
--      switch [0 .. n] (expr) { case ... ; }
--
genSwitch :: CmmExpr -> [Maybe BlockId] -> SDoc
genSwitch expr maybe_ids 

343
    = let pairs = groupBy snds (zip [0 .. ] maybe_ids )
344

Ian Lynagh's avatar
Ian Lynagh committed
345
      in hang (hcat [ ptext (sLit "switch [0 .. ") 
346
                    , int (length maybe_ids - 1)
Ian Lynagh's avatar
Ian Lynagh committed
347
                    , ptext (sLit "] ")
348 349 350
                    , if isTrivialCmmExpr expr
                        then pprExpr expr
                        else parens (pprExpr expr)
Ian Lynagh's avatar
Ian Lynagh committed
351
                    , ptext (sLit " {") 
352 353 354 355 356 357
                    ]) 
            4 (vcat ( map caseify pairs )) $$ rbrace

    where
      snds a b = (snd a) == (snd b)

358
      caseify :: [(Int,Maybe BlockId)] -> SDoc
359
      caseify ixs@((_,Nothing):_)
Ian Lynagh's avatar
Ian Lynagh committed
360 361
        = ptext (sLit "/* impossible: ") <> hcat (intersperse comma (map (int.fst) ixs))
		<> ptext (sLit " */")
362 363
      caseify as 
        = let (is,ids) = unzip as 
Ian Lynagh's avatar
Ian Lynagh committed
364
          in hsep [ ptext (sLit "case")
365
                  , hcat (punctuate comma (map int is))
Ian Lynagh's avatar
Ian Lynagh committed
366
                  , ptext (sLit ": goto")
367
                  , pprBlockId (head [ id | Just id <- ids]) <> semi ]
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396

-- --------------------------------------------------------------------------
-- Expressions
--

pprExpr :: CmmExpr -> SDoc
pprExpr e 
    = case e of
        CmmRegOff reg i -> 
		pprExpr (CmmMachOp (MO_Add rep)
			   [CmmReg reg, CmmLit (CmmInt (fromIntegral i) rep)])
		where rep = cmmRegRep reg	
	CmmLit lit -> pprLit lit
	_other     -> pprExpr1 e

-- Here's the precedence table from CmmParse.y:
-- %nonassoc '>=' '>' '<=' '<' '!=' '=='
-- %left '|'
-- %left '^'
-- %left '&'
-- %left '>>' '<<'
-- %left '-' '+'
-- %left '/' '*' '%'
-- %right '~'

-- We just cope with the common operators for now, the rest will get
-- a default conservative behaviour.

-- %nonassoc '>=' '>' '<=' '<' '!=' '=='
397
pprExpr1, pprExpr7, pprExpr8 :: CmmExpr -> SDoc
398 399 400 401
pprExpr1 (CmmMachOp op [x,y]) | Just doc <- infixMachOp1 op
   = pprExpr7 x <+> doc <+> pprExpr7 y
pprExpr1 e = pprExpr7 e

402 403
infixMachOp1, infixMachOp7, infixMachOp8 :: MachOp -> Maybe SDoc

Ian Lynagh's avatar
Ian Lynagh committed
404 405 406 407 408 409
infixMachOp1 (MO_Eq     _) = Just (ptext (sLit "=="))
infixMachOp1 (MO_Ne     _) = Just (ptext (sLit "!="))
infixMachOp1 (MO_Shl    _) = Just (ptext (sLit "<<"))
infixMachOp1 (MO_U_Shr  _) = Just (ptext (sLit ">>"))
infixMachOp1 (MO_U_Ge   _) = Just (ptext (sLit ">="))
infixMachOp1 (MO_U_Le   _) = Just (ptext (sLit "<="))
410 411 412 413 414
infixMachOp1 (MO_U_Gt   _) = Just (char '>')
infixMachOp1 (MO_U_Lt   _) = Just (char '<')
infixMachOp1 _             = Nothing

-- %left '-' '+'
415 416
pprExpr7 (CmmMachOp (MO_Add rep1) [x, CmmLit (CmmInt i rep2)]) | i < 0
   = pprExpr7 (CmmMachOp (MO_Sub rep1) [x, CmmLit (CmmInt (negate i) rep2)])
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
pprExpr7 (CmmMachOp op [x,y]) | Just doc <- infixMachOp7 op
   = pprExpr7 x <+> doc <+> pprExpr8 y
pprExpr7 e = pprExpr8 e

infixMachOp7 (MO_Add _)  = Just (char '+')
infixMachOp7 (MO_Sub _)  = Just (char '-')
infixMachOp7 _           = Nothing

-- %left '/' '*' '%'
pprExpr8 (CmmMachOp op [x,y]) | Just doc <- infixMachOp8 op
   = pprExpr8 x <+> doc <+> pprExpr9 y
pprExpr8 e = pprExpr9 e

infixMachOp8 (MO_U_Quot _) = Just (char '/')
infixMachOp8 (MO_Mul _)    = Just (char '*')
infixMachOp8 (MO_U_Rem _)  = Just (char '%')
infixMachOp8 _             = Nothing

pprExpr9 :: CmmExpr -> SDoc
pprExpr9 e = 
   case e of
        CmmLit    lit       -> pprLit1 lit
        CmmLoad   expr rep  -> ppr rep <> brackets( ppr expr )
        CmmReg    reg       -> ppr reg
441 442
        CmmRegOff  reg off  -> parens (ppr reg <+> char '+' <+> int off)
        CmmStackSlot a off  -> parens (ppr a   <+> char '+' <+> int off)
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
	CmmMachOp mop args  -> genMachOp mop args

genMachOp :: MachOp -> [CmmExpr] -> SDoc
genMachOp mop args
   | Just doc <- infixMachOp mop = case args of
        -- dyadic
        [x,y] -> pprExpr9 x <+> doc <+> pprExpr9 y

        -- unary
        [x]   -> doc <> pprExpr9 x

        _     -> pprTrace "PprCmm.genMachOp: machop with strange number of args"
                          (pprMachOp mop <+>
                            parens (hcat $ punctuate comma (map pprExpr args)))
                          empty

   | isJust (infixMachOp1 mop)
   || isJust (infixMachOp7 mop)
   || isJust (infixMachOp8 mop)	 = parens (pprExpr (CmmMachOp mop args))

463 464 465 466
   | otherwise = char '%' <> ppr_op <> parens (commafy (map pprExpr args))
        where ppr_op = text (map (\c -> if c == ' ' then '_' else c)
                                 (show mop))
                -- replace spaces in (show mop) with underscores,
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497

--
-- Unsigned ops on the word size of the machine get nice symbols.
-- All else get dumped in their ugly format.
--
infixMachOp :: MachOp -> Maybe SDoc
infixMachOp mop
	= case mop of
            MO_And    _ -> Just $ char '&'
            MO_Or     _ -> Just $ char '|'
            MO_Xor    _ -> Just $ char '^'
            MO_Not    _ -> Just $ char '~'
            MO_S_Neg  _ -> Just $ char '-' -- there is no unsigned neg :)
            _ -> Nothing

-- --------------------------------------------------------------------------
-- Literals.
--  To minimise line noise we adopt the convention that if the literal
--  has the natural machine word size, we do not append the type
--
pprLit :: CmmLit -> SDoc
pprLit lit = case lit of
    CmmInt i rep ->
        hcat [ (if i < 0 then parens else id)(integer i)
             , (if rep == wordRep 
                    then empty 
                    else space <> dcolon <+> ppr rep) ]

    CmmFloat f rep     -> hsep [ rational f, dcolon, ppr rep ]
    CmmLabel clbl      -> pprCLabel clbl
    CmmLabelOff clbl i -> pprCLabel clbl <> ppr_offset i
498 499
    CmmLabelDiffOff clbl1 clbl2 i -> pprCLabel clbl1 <> char '-'  
                                  <> pprCLabel clbl2 <> ppr_offset i
500

501 502 503
pprLit1 :: CmmLit -> SDoc
pprLit1 lit@(CmmLabelOff {}) = parens (pprLit lit)
pprLit1 lit                  = pprLit lit
504 505 506 507 508 509 510 511 512 513 514 515 516 517

ppr_offset :: Int -> SDoc
ppr_offset i
    | i==0      = empty
    | i>=0      = char '+' <> int i
    | otherwise = char '-' <> int (-i)

-- --------------------------------------------------------------------------
-- Static data.
--      Strings are printed as C strings, and we print them as I8[],
--      following C--
--
pprStatic :: CmmStatic -> SDoc
pprStatic s = case s of
Ian Lynagh's avatar
Ian Lynagh committed
518
    CmmStaticLit lit   -> nest 4 $ ptext (sLit "const") <+> pprLit lit <> semi
519 520 521
    CmmUninitialised i -> nest 4 $ text "I8" <> brackets (int i)
    CmmAlign i         -> nest 4 $ text "align" <+> int i
    CmmDataLabel clbl  -> pprCLabel clbl <> colon
522
    CmmString s'       -> nest 4 $ text "I8[]" <+> text (show s')
523 524 525 526 527 528 529

-- --------------------------------------------------------------------------
-- Registers, whether local (temps) or global
--
pprReg :: CmmReg -> SDoc
pprReg r 
    = case r of
530
        CmmLocal  local  -> pprLocalReg  local
531 532 533 534 535 536
        CmmGlobal global -> pprGlobalReg global

--
-- We only print the type of the local reg if it isn't wordRep
--
pprLocalReg :: LocalReg -> SDoc
537 538
pprLocalReg (LocalReg uniq rep follow) 
    = hcat [ char '_', ppr uniq, ty ] where
539
  ty = if rep == wordRep && follow == GCKindNonPtr
540 541
                then empty
                else dcolon <> ptr <> ppr rep
542
  ptr = if follow == GCKindNonPtr
543 544
                then empty
                else doubleQuotes (text "ptr")
545

546 547 548 549 550 551
-- Stack areas
pprArea :: Area -> SDoc
pprArea (RegSlot r)    = hcat [ text "slot<", ppr r, text ">" ]
pprArea (CallArea id n n') =
  hcat [ text "callslot<", ppr id, char '+', ppr n, char '/', ppr n', text ">" ]

552 553 554 555 556 557 558 559 560
-- needs to be kept in syn with Cmm.hs.GlobalReg
--
pprGlobalReg :: GlobalReg -> SDoc
pprGlobalReg gr 
    = case gr of
        VanillaReg n   -> char 'R' <> int n
        FloatReg   n   -> char 'F' <> int n
        DoubleReg  n   -> char 'D' <> int n
        LongReg    n   -> char 'L' <> int n
Ian Lynagh's avatar
Ian Lynagh committed
561 562 563 564 565 566 567 568 569 570 571
        Sp             -> ptext (sLit "Sp")
        SpLim          -> ptext (sLit "SpLim")
        Hp             -> ptext (sLit "Hp")
        HpLim          -> ptext (sLit "HpLim")
        CurrentTSO     -> ptext (sLit "CurrentTSO")
        CurrentNursery -> ptext (sLit "CurrentNursery")
        HpAlloc        -> ptext (sLit "HpAlloc")
        GCEnter1       -> ptext (sLit "stg_gc_enter_1")
        GCFun          -> ptext (sLit "stg_gc_fun")
        BaseReg        -> ptext (sLit "BaseReg")
        PicBaseReg     -> ptext (sLit "PicBaseReg")
572 573 574 575 576 577

-- --------------------------------------------------------------------------
-- data sections
--
pprSection :: Section -> SDoc
pprSection s = case s of
Ian Lynagh's avatar
Ian Lynagh committed
578 579 580 581
    Text              -> section <+> doubleQuotes (ptext (sLit "text"))
    Data              -> section <+> doubleQuotes (ptext (sLit "data"))
    ReadOnlyData      -> section <+> doubleQuotes (ptext (sLit "readonly"))
    ReadOnlyData16    -> section <+> doubleQuotes (ptext (sLit "readonly16"))
582
    RelocatableReadOnlyData
Ian Lynagh's avatar
Ian Lynagh committed
583 584
                      -> section <+> doubleQuotes (ptext (sLit "relreadonly"))
    UninitialisedData -> section <+> doubleQuotes (ptext (sLit "uninitialised"))
585 586
    OtherSection s'   -> section <+> doubleQuotes (text s')
 where
Ian Lynagh's avatar
Ian Lynagh committed
587 588
    section = ptext (sLit "section")

589 590 591 592 593 594 595 596 597
-- --------------------------------------------------------------------------
-- Basic block ids
--
pprBlockId :: BlockId -> SDoc
pprBlockId b = ppr $ getUnique b

-----------------------------------------------------------------------------

commafy :: [SDoc] -> SDoc
598
commafy xs = fsep $ punctuate comma xs