PprCmm.hs 17.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 35 36 37 38 39 40 41
--
-----------------------------------------------------------------------------

--
-- 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
--

module PprCmm ( 	
	writeCmms, pprCmms, pprCmm, pprStmt, pprExpr
  ) where

#include "HsVersions.h"

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) => [GenCmm CmmStatic info CmmStmt] -> SDoc
56 57 58 59 60 61 62 63 64
pprCmms cmms = pprCode CStyle (vcat (intersperse separator $ map ppr cmms))
        where
          separator = space $$ ptext SLIT("-------------------") $$ space

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

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

65
instance (Outputable info) => Outputable (GenCmm CmmStatic info CmmStmt) where
66 67
    ppr c = pprCmm c

68
instance (Outputable info) => Outputable (GenCmmTop CmmStatic info CmmStmt) where
69 70 71 72 73 74 75 76 77 78 79 80 81 82
    ppr t = pprTop t

instance Outputable CmmBasicBlock where
    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

83 84 85
instance Outputable LocalReg where
    ppr e = pprLocalReg e

86 87 88
instance Outputable GlobalReg where
    ppr e = pprGlobalReg e

89 90 91 92 93 94
instance Outputable CmmStatic where
    ppr e = pprStatic e

instance Outputable CmmInfo where
    ppr e = pprInfo e

95 96
-----------------------------------------------------------------------------

97
pprCmm :: (Outputable info) => GenCmm CmmStatic info CmmStmt -> SDoc
98 99 100
pprCmm (Cmm tops) = vcat $ intersperse (text "") $ map pprTop tops

-- --------------------------------------------------------------------------
101
-- Top level `procedure' blocks.
102
--
103
pprTop :: (Outputable info) => GenCmmTop CmmStatic info CmmStmt -> SDoc
104 105
pprTop (CmmProc info lbl params blocks )

106
  = vcat [ pprCLabel lbl <> parens (commafy $ map ppr params) <+> lbrace
107
         , nest 8 $ lbrace <+> ppr info $$ rbrace
108 109 110 111 112 113 114 115 116 117 118 119 120
         , nest 4 $ vcat (map ppr blocks)
         , rbrace ]

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


121 122 123 124 125 126 127 128

-- --------------------------------------------------------------------------
-- 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".
129 130 131
pprInfo (CmmNonInfo gc_target) =
    ptext SLIT("gc_target: ") <>
          maybe (ptext SLIT("<none>")) pprBlockId gc_target
132 133 134 135 136 137 138 139 140 141 142 143 144
pprInfo (CmmInfo (ProfilingInfo closure_type closure_desc)
                 gc_target tag info) =
    vcat [ptext SLIT("type: ") <> pprLit closure_type,
          ptext SLIT("desc: ") <> pprLit closure_desc,
          ptext SLIT("gc_target: ") <>
                maybe (ptext SLIT("<none>")) pprBlockId gc_target,
          ptext SLIT("tag: ") <> integer (toInteger tag),
          pprTypeInfo info]

pprTypeInfo (ConstrInfo layout constr descr) =
    vcat [ptext SLIT("ptrs: ") <> integer (toInteger (fst layout)),
          ptext SLIT("nptrs: ") <> integer (toInteger (snd layout)),
          ptext SLIT("constructor: ") <> integer (toInteger constr),
145
          pprLit descr]
146 147 148 149 150 151 152 153 154 155 156 157 158
pprTypeInfo (FunInfo layout srt fun_type arity args slow_entry) =
    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)
          --ppr args, -- TODO: needs to be printed
          --ppr slow_entry -- TODO: needs to be printed
         ]
pprTypeInfo (ThunkInfo layout srt) =
    vcat [ptext SLIT("ptrs: ") <> integer (toInteger (fst layout)),
          ptext SLIT("nptrs: ") <> integer (toInteger (snd layout)),
          ptext SLIT("srt: ") <> ppr srt]
159 160 161
pprTypeInfo (ThunkSelectorInfo offset srt) =
    vcat [ptext SLIT("ptrs: ") <> integer (toInteger offset),
          ptext SLIT("srt: ") <> ppr srt]
162 163 164 165
pprTypeInfo (ContInfo stack srt) =
    vcat [ptext SLIT("stack: ") <> ppr stack,
          ptext SLIT("srt: ") <> ppr srt]

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
-- --------------------------------------------------------------------------
-- Basic blocks look like assembly blocks.
--      lbl: stmt ; stmt ; .. 
pprBBlock :: CmmBasicBlock -> SDoc
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

182
    --  // text
183 184 185 186 187 188 189 190 191 192 193 194
    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
195
    CmmCall (CmmForeignCall fn cconv) results args srt ->
196 197 198 199 200
        hcat [ if null results
                  then empty
                  else parens (commafy $ map ppr results) <>
                       ptext SLIT(" = "),
               ptext SLIT("call"), space, 
201 202
               doubleQuotes(ppr cconv), space,
               target fn, parens  ( commafy $ map ppr args ),
203
               brackets (ppr srt), semi ]
204 205 206 207
        where
            target (CmmLit lit) = pprLit lit
            target fn'          = parens (ppr fn')

208
    CmmCall (CmmPrim op) results args srt ->
209
        pprStmt (CmmCall (CmmForeignCall (CmmLit lbl) CCallConv)
210
                        results args srt)
211 212 213 214 215 216
        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
217
    CmmReturn params         -> genReturn params
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
    CmmSwitch arg ids        -> genSwitch arg ids

-- --------------------------------------------------------------------------
-- goto local label. [1], section 6.6
--
--     goto lbl;
--
genBranch :: BlockId -> SDoc
genBranch ident = 
    ptext SLIT("goto") <+> pprBlockId ident <> semi

-- --------------------------------------------------------------------------
-- Conditional. [1], section 6.4
--
--     if (expr) { goto lbl; } 
--
genCondBranch :: CmmExpr -> BlockId -> SDoc
genCondBranch expr ident =
    hsep [ ptext SLIT("if")
         , parens(ppr expr)
         , ptext SLIT("goto")
         , pprBlockId ident <> semi ]

-- --------------------------------------------------------------------------
-- A tail call. [1], Section 6.9
--
--     jump foo(a, b, c);
--
246 247
genJump :: CmmExpr -> [(CmmExpr, MachHint)] -> SDoc
genJump expr args = 
248 249 250 251 252 253 254 255

    hcat [ ptext SLIT("jump")
         , space
         , if isTrivialCmmExpr expr
                then pprExpr expr
                else case expr of
                    CmmLoad (CmmReg _) _ -> pprExpr expr 
                    _ -> parens (pprExpr expr)
256
         , space
257
         , parens  ( commafy $ map ppr args )
258 259
         , semi ]

260 261 262 263 264 265 266 267 268 269 270 271
-- --------------------------------------------------------------------------
-- Return from a function. [1], Section 6.8.2 of version 1.128
--
--     return (a, b, c);
--
genReturn :: [(CmmExpr, MachHint)] -> SDoc
genReturn args = 

    hcat [ ptext SLIT("return")
         , space
         , parens  ( commafy $ map ppr args )
         , semi ]
272 273 274 275 276 277 278 279 280 281 282

-- --------------------------------------------------------------------------
-- 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 

283
    = let pairs = groupBy snds (zip [0 .. ] maybe_ids )
284 285

      in hang (hcat [ ptext SLIT("switch [0 .. ") 
286
                    , int (length maybe_ids - 1)
287 288 289 290 291 292 293 294 295 296 297
                    , ptext SLIT("] ")
                    , if isTrivialCmmExpr expr
                        then pprExpr expr
                        else parens (pprExpr expr)
                    , ptext SLIT(" {") 
                    ]) 
            4 (vcat ( map caseify pairs )) $$ rbrace

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

298 299 300 301
      caseify :: [(Int,Maybe BlockId)] -> SDoc
      caseify ixs@((i,Nothing):_)
        = ptext SLIT("/* impossible: ") <> hcat (intersperse comma (map (int.fst) ixs))
		<> ptext SLIT(" */")
302 303 304 305 306
      caseify as 
        = let (is,ids) = unzip as 
          in hsep [ ptext SLIT("case")
                  , hcat (punctuate comma (map int is))
                  , ptext SLIT(": goto")
307
                  , pprBlockId (head [ id | Just id <- ids]) <> semi ]
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351

-- --------------------------------------------------------------------------
-- 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 '>=' '>' '<=' '<' '!=' '=='
pprExpr1 (CmmMachOp op [x,y]) | Just doc <- infixMachOp1 op
   = pprExpr7 x <+> doc <+> pprExpr7 y
pprExpr1 e = pprExpr7 e

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("<="))
infixMachOp1 (MO_U_Gt   _) = Just (char '>')
infixMachOp1 (MO_U_Lt   _) = Just (char '<')
infixMachOp1 _             = Nothing

-- %left '-' '+'
352 353
pprExpr7 (CmmMachOp (MO_Add rep1) [x, CmmLit (CmmInt i rep2)]) | i < 0
   = pprExpr7 (CmmMachOp (MO_Sub rep1) [x, CmmLit (CmmInt (negate i) rep2)])
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
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
378
        CmmRegOff reg off   -> parens (ppr reg <+> char '+' <+> int off)
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
	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))

399 400 401 402
   | 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,
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433

--
-- 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
434 435
    CmmLabelDiffOff clbl1 clbl2 i -> pprCLabel clbl1 <> char '-'  
                                  <> pprCLabel clbl2 <> ppr_offset i
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456

pprLit1 lit@(CmmLabelOff clbl i) = parens (pprLit lit)
pprLit1 lit                      = pprLit lit

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
    CmmStaticLit lit   -> nest 4 $ ptext SLIT("const") <+> pprLit lit <> semi
    CmmUninitialised i -> nest 4 $ text "I8" <> brackets (int i)
    CmmAlign i         -> nest 4 $ text "align" <+> int i
    CmmDataLabel clbl  -> pprCLabel clbl <> colon
457
    CmmString s'       -> nest 4 $ text "I8[]" <+> text (show s')
458 459 460 461 462 463 464 465 466 467 468 469 470 471

-- --------------------------------------------------------------------------
-- Registers, whether local (temps) or global
--
pprReg :: CmmReg -> SDoc
pprReg r 
    = case r of
        CmmLocal  local  -> pprLocalReg local
        CmmGlobal global -> pprGlobalReg global

--
-- We only print the type of the local reg if it isn't wordRep
--
pprLocalReg :: LocalReg -> SDoc
472 473 474 475 476 477 478 479
pprLocalReg (LocalReg uniq rep follow) 
    = hcat [ char '_', ppr uniq, ty ] where
  ty = if rep == wordRep && follow == KindNonPtr
                then empty
                else dcolon <> ptr <> ppr rep
  ptr = if follow == KindNonPtr
                then empty
                else doubleQuotes (text "ptr")
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499

-- 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
        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")
500
        PicBaseReg     -> ptext SLIT("PicBaseReg")
501 502 503 504 505 506 507 508 509

-- --------------------------------------------------------------------------
-- data sections
--
pprSection :: Section -> SDoc
pprSection s = case s of
    Text              -> section <+> doubleQuotes (ptext SLIT("text"))
    Data              -> section <+> doubleQuotes (ptext SLIT("data"))
    ReadOnlyData      -> section <+> doubleQuotes (ptext SLIT("readonly"))
510 511
    RelocatableReadOnlyData
                      -> section <+> doubleQuotes (ptext SLIT("relreadonly"))
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
    UninitialisedData -> section <+> doubleQuotes (ptext SLIT("uninitialised"))
    OtherSection s'   -> section <+> doubleQuotes (text s')
 where
    section = ptext SLIT("section")
       
-- --------------------------------------------------------------------------
-- Basic block ids
--
pprBlockId :: BlockId -> SDoc
pprBlockId b = ppr $ getUnique b

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

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