(F)SLIT -> (f)sLit in ZipCfgCmmRep

[ghc-hetmet.git] / compiler / cmm / ZipCfgCmmRep.hs

diff --git a/compiler/cmm/ZipCfgCmmRep.hs b/compiler/cmm/ZipCfgCmmRep.hs
index da84f7b..ee1206e 100644 (file)
--- a/compiler/cmm/ZipCfgCmmRep.hs
+++ b/compiler/cmm/ZipCfgCmmRep.hs
@@ -1,4 +1,4 @@
-{-# OPTIONS -Wall -fno-warn-name-shadowing #-}
+

 
 -- This module is pure representation and should be imported only by
 -- clients that need to manipulate representation and know what
 
 -- This module is pure representation and should be imported only by
 -- clients that need to manipulate representation and know what

@@ -11,12 +11,10 @@ module ZipCfgCmmRep
   )
 where
 
   )
 where
 

-#include "HsVersions.h"
-

 import CmmExpr
 import Cmm ( GenCmm(..), GenCmmTop(..), CmmStatic, CmmInfo
 import CmmExpr
 import Cmm ( GenCmm(..), GenCmmTop(..), CmmStatic, CmmInfo

-           , CmmCallTarget(..), CmmActuals, CmmFormalsWithoutKinds, CmmFormals
-           , CmmStmt(CmmJump, CmmSwitch) -- imported in order to call ppr
+           , CmmCallTarget(..), CmmActuals, CmmFormals, CmmHinted(..)
+           , CmmStmt(CmmSwitch) -- imported in order to call ppr

            )
 import PprCmm()
 
            )
 import PprCmm()
 

@@ -25,14 +23,18 @@ import ClosureInfo
 import FastString
 import ForeignCall
 import MachOp
 import FastString
 import ForeignCall
 import MachOp

-import qualified ZipDataflow as DF
+import qualified ZipDataflow0 as DF

 import ZipCfg 
 import MkZipCfg
 import ZipCfg 
 import MkZipCfg

+import Util

 
 import Maybes
 import Outputable
 import Prelude hiding (zip, unzip, last)
 
 
 import Maybes
 import Outputable
 import Prelude hiding (zip, unzip, last)
 

+----------------------------------------------------------------------
+----- Type synonyms and definitions
+

 type CmmGraph  = LGraph Middle Last
 type CmmAGraph = AGraph Middle Last
 type CmmBlock  = Block  Middle Last
 type CmmGraph  = LGraph Middle Last
 type CmmAGraph = AGraph Middle Last
 type CmmBlock  = Block  Middle Last

@@ -40,8 +42,7 @@ type CmmZ      = GenCmm    CmmStatic CmmInfo CmmGraph
 type CmmTopZ   = GenCmmTop CmmStatic CmmInfo CmmGraph
 
 data Middle
 type CmmTopZ   = GenCmmTop CmmStatic CmmInfo CmmGraph
 
 data Middle

-  = MidNop
-  | MidComment FastString
+  = MidComment FastString

 
   | MidAssign CmmReg CmmExpr     -- Assign to register
 
 
   | MidAssign CmmReg CmmExpr     -- Assign to register
 

@@ -53,35 +54,46 @@ data Middle
      CmmFormals                  -- zero or more results
      CmmActuals                  -- zero or more arguments
 
      CmmFormals                  -- zero or more results
      CmmActuals                  -- zero or more arguments
 

-  | CopyIn    -- Move parameters or results from conventional locations to registers
-              -- Note [CopyIn invariant]
+  | MidAddToContext              -- push a frame on the stack;
+                                 -- I will return to this frame
+     CmmExpr                     -- The frame's return address; it must be
+                                 -- preceded by an info table that describes the
+                                 -- live variables.
+     [CmmExpr]                   -- The frame's live variables, to go on the 
+                                 -- stack with the first one at the young end
+
+  | CopyIn    -- Move incoming parameters or results from conventional
+              -- locations to registers.  Note [CopyIn invariant]

         Convention 
         CmmFormals      -- eventually [CmmKind] will be used only for foreign
                         -- calls and will migrate into 'Convention' (helping to
         Convention 
         CmmFormals      -- eventually [CmmKind] will be used only for foreign
                         -- calls and will migrate into 'Convention' (helping to

-                        -- drain "the swamp")
+                        -- drain "the swamp"), leaving this as [LocalReg]

         C_SRT           -- Static things kept alive by this block
         C_SRT           -- Static things kept alive by this block

+

   | CopyOut Convention CmmActuals
   | CopyOut Convention CmmActuals

+              -- Move outgoing parameters or results from registers to
+              -- conventional locations.  Every 'LastReturn',
+              -- 'LastJump', or 'LastCall' must be dominated by a
+              -- matching 'CopyOut' in the same basic block.
+              -- As above, '[CmmKind]' will migrate into the foreign calling
+              -- convention, leaving the actuals as '[CmmExpr]'.

 
 data Last
 
 data Last

-  = LastReturn CmmActuals          -- Return from a function,
-                                  -- with these return values.
-
-  | LastJump   CmmExpr CmmActuals
-        -- Tail call to another procedure
-
-  | LastBranch BlockId CmmFormalsWithoutKinds
-        -- To another block in the same procedure
-        -- The parameters are unused at present.
-
-  | LastCall {                   -- A call (native or safe foreign)
-        cml_target :: CmmExpr,   -- never a CmmPrim to a CallishMachOp!
-        cml_next   :: Maybe BlockId }  -- BlockId of continuation, if call returns
+  = LastBranch BlockId  -- Goto another block in the same procedure

 
   | LastCondBranch {            -- conditional branch
         cml_pred :: CmmExpr,
         cml_true, cml_false :: BlockId
     }
 
 
   | LastCondBranch {            -- conditional branch
         cml_pred :: CmmExpr,
         cml_true, cml_false :: BlockId
     }
 

+  | LastReturn          -- Return from a function; values in a previous CopyOut node
+
+  | LastJump CmmExpr    -- Tail call to another procedure; args in a CopyOut node
+
+  | LastCall {                   -- A call (native or safe foreign); args in CopyOut node
+        cml_target :: CmmExpr,   -- never a CmmPrim to a CallishMachOp!
+        cml_cont   :: Maybe BlockId }  -- BlockId of continuation, if call returns
+

   | LastSwitch CmmExpr [Maybe BlockId]   -- Table branch
         -- The scrutinee is zero-based; 
         --      zero -> first block
   | LastSwitch CmmExpr [Maybe BlockId]   -- Table branch
         -- The scrutinee is zero-based; 
         --      zero -> first block

@@ -91,11 +103,12 @@ data Last
 data Convention
   = ConventionStandard CCallConv ValueDirection
   | ConventionPrivate
 data Convention
   = ConventionStandard CCallConv ValueDirection
   | ConventionPrivate

-                -- Used for control transfers within a (pre-CPS) procedure
-                -- All jump sites known, never pushed on the stack (hence no SRT)
-                -- You can choose whatever calling convention
-                -- you please (provided you make sure
-                -- all the call sites agree)!
+                -- Used for control transfers within a (pre-CPS) procedure All
+                -- jump sites known, never pushed on the stack (hence no SRT)
+                -- You can choose whatever calling convention you please
+                -- (provided you make sure all the call sites agree)!
+                -- This data type eventually to be extended to record the convention. 
+

   deriving Eq
 
 data ValueDirection = Arguments | Results
   deriving Eq
 
 data ValueDirection = Arguments | Results

@@ -106,29 +119,31 @@ data ValueDirection = Arguments | Results
 {-
 Note [CopyIn invariant]
 ~~~~~~~~~~~~~~~~~~~~~~~
 {-
 Note [CopyIn invariant]
 ~~~~~~~~~~~~~~~~~~~~~~~

-In principle, CopyIn ought to be a First node, but in practice, the
+One might wish for CopyIn to be a First node, but in practice, the

 possibility raises all sorts of hairy issues with graph splicing,
 rewriting, and so on.  In the end, NR finds it better to make the
 possibility raises all sorts of hairy issues with graph splicing,
 rewriting, and so on.  In the end, NR finds it better to make the

-placement of CopyIn a dynamic invariant.  This change will complicate
-the dataflow fact for the proc-point calculation, but it should make
-things easier in many other respects.  
+placement of CopyIn a dynamic invariant; it should normally be the first
+Middle node in the basic block in which it occurs.

 -}
 
 -}
 

+----------------------------------------------------------------------
+----- Instance declarations for control flow
+

 instance HavingSuccessors Last where
     succs = cmmSuccs
     fold_succs = fold_cmm_succs
 
 instance LastNode Last where
 instance HavingSuccessors Last where
     succs = cmmSuccs
     fold_succs = fold_cmm_succs
 
 instance LastNode Last where

-    mkBranchNode id = LastBranch id []
-    isBranchNode (LastBranch _ []) = True
+    mkBranchNode id = LastBranch id
+    isBranchNode (LastBranch _) = True

     isBranchNode _ = False
     isBranchNode _ = False

-    branchNodeTarget (LastBranch id []) = id
+    branchNodeTarget (LastBranch id) = id

     branchNodeTarget _ = panic "asked for target of non-branch"
 
 cmmSuccs :: Last -> [BlockId]
 cmmSuccs (LastReturn {})        = []
 cmmSuccs (LastJump {})          = [] 
     branchNodeTarget _ = panic "asked for target of non-branch"
 
 cmmSuccs :: Last -> [BlockId]
 cmmSuccs (LastReturn {})        = []
 cmmSuccs (LastJump {})          = [] 

-cmmSuccs (LastBranch id _)      = [id]
+cmmSuccs (LastBranch id)        = [id]

 cmmSuccs (LastCall _ (Just id)) = [id]
 cmmSuccs (LastCall _ Nothing)   = []
 cmmSuccs (LastCondBranch _ t f) = [f, t]  -- meets layout constraint
 cmmSuccs (LastCall _ (Just id)) = [id]
 cmmSuccs (LastCall _ Nothing)   = []
 cmmSuccs (LastCondBranch _ t f) = [f, t]  -- meets layout constraint

@@ -137,15 +152,38 @@ cmmSuccs (LastSwitch _ edges)   = catMaybes edges
 fold_cmm_succs :: (BlockId -> a -> a) -> Last -> a -> a
 fold_cmm_succs _f (LastReturn {})          z = z
 fold_cmm_succs _f (LastJump {})            z = z
 fold_cmm_succs :: (BlockId -> a -> a) -> Last -> a -> a
 fold_cmm_succs _f (LastReturn {})          z = z
 fold_cmm_succs _f (LastJump {})            z = z

-fold_cmm_succs  f (LastBranch id _)        z = f id z
+fold_cmm_succs  f (LastBranch id)          z = f id z

 fold_cmm_succs  f (LastCall _ (Just id))   z = f id z
 fold_cmm_succs _f (LastCall _ Nothing)     z = z
 fold_cmm_succs  f (LastCondBranch _ te fe) z = f te (f fe z)
 fold_cmm_succs  f (LastSwitch _ edges)     z = foldl (flip f) z $ catMaybes edges
 
 fold_cmm_succs  f (LastCall _ (Just id))   z = f id z
 fold_cmm_succs _f (LastCall _ Nothing)     z = z
 fold_cmm_succs  f (LastCondBranch _ te fe) z = f te (f fe z)
 fold_cmm_succs  f (LastSwitch _ edges)     z = foldl (flip f) z $ catMaybes edges
 

-
-----------------------------------------------------------------
--- prettyprinting (avoids recursive imports)
+----------------------------------------------------------------------
+----- Instance declarations for register use
+
+instance UserOfLocalRegs Middle where
+    foldRegsUsed f z m = middle m
+      where middle (MidComment {})                = z
+            middle (MidAssign _lhs expr)          = fold f z expr
+            middle (MidStore addr rval)           = fold f (fold f z addr) rval
+            middle (MidUnsafeCall tgt _ress args) = fold f (fold f z tgt) args
+            middle (MidAddToContext ra args)      = fold f (fold f z ra) args
+            middle (CopyIn _ _formals _)          = z
+            middle (CopyOut _ actuals)            = fold f z actuals
+            fold f z m = foldRegsUsed f z m  -- avoid monomorphism restriction
+
+instance UserOfLocalRegs Last where
+    foldRegsUsed f z m = last m
+      where last (LastReturn)           = z
+            last (LastJump e)           = foldRegsUsed f z e
+            last (LastBranch _id)       = z
+            last (LastCall tgt _)       = foldRegsUsed f z tgt
+            last (LastCondBranch e _ _) = foldRegsUsed f z e
+            last (LastSwitch e _tbl)    = foldRegsUsed f z e
+
+
+----------------------------------------------------------------------
+----- Instance declarations for prettyprinting (avoids recursive imports)

 
 instance Outputable Middle where
     ppr s = pprMiddle s
 
 instance Outputable Middle where
     ppr s = pprMiddle s

@@ -158,26 +196,20 @@ instance Outputable Convention where
 
 instance DF.DebugNodes Middle Last
 
 
 instance DF.DebugNodes Middle Last
 

-instance Outputable CmmGraph where
-    ppr = pprLgraph
-

 debugPpr :: Bool
 debugPpr = debugIsOn
 
 pprMiddle :: Middle -> SDoc    
 pprMiddle stmt = (case stmt of
 
 debugPpr :: Bool
 debugPpr = debugIsOn
 
 pprMiddle :: Middle -> SDoc    
 pprMiddle stmt = (case stmt of
 

-    MidNop -> semi
-

     CopyIn conv args _ ->
     CopyIn conv args _ ->

-        if null args then ptext SLIT("empty CopyIn")
+        if null args then ptext (sLit "empty CopyIn")

         else commafy (map pprHinted args) <+> equals <+>
         else commafy (map pprHinted args) <+> equals <+>

-             ptext SLIT("foreign") <+> doubleQuotes(ppr conv) <+> ptext SLIT("...")
+             ptext (sLit "foreign") <+> doubleQuotes(ppr conv) <+> ptext (sLit "...")

 
     CopyOut conv args ->
 
     CopyOut conv args ->

-        if null args then empty
-        else ptext SLIT("CopyOut") <+> doubleQuotes(ppr conv) <+>
-             parens (commafy (map pprHinted args))
+        ptext (sLit "next, pass") <+> doubleQuotes(ppr conv) <+>
+        parens (commafy (map pprHinted args))

 
     --  // text
     MidComment s -> text "//" <+> ftext s
 
     --  // text
     MidComment s -> text "//" <+> ftext s

@@ -196,46 +228,53 @@ pprMiddle stmt = (case stmt of
         hcat [ if null results
                   then empty
                   else parens (commafy $ map ppr results) <>
         hcat [ if null results
                   then empty
                   else parens (commafy $ map ppr results) <>

-                       ptext SLIT(" = "),
-               ptext SLIT("call"), space, 
+                       ptext (sLit " = "),
+               ptext (sLit "call"), space, 

                doubleQuotes(ppr cconv), space,
                doubleQuotes(ppr cconv), space,

-               target fn, parens  ( commafy $ map ppr args ),
+               ppr_target fn, parens  ( commafy $ map ppr args ),

                semi ]
                semi ]

-        where
-            target t@(CmmLit _) = ppr t
-            target fn'          = parens (ppr fn')

 
     MidUnsafeCall (CmmPrim op) results args ->
         pprMiddle (MidUnsafeCall (CmmCallee (CmmLit lbl) CCallConv) results args)
         where
           lbl = CmmLabel (mkForeignLabel (mkFastString (show op)) Nothing False)
 
     MidUnsafeCall (CmmPrim op) results args ->
         pprMiddle (MidUnsafeCall (CmmCallee (CmmLit lbl) CCallConv) results args)
         where
           lbl = CmmLabel (mkForeignLabel (mkFastString (show op)) Nothing False)

+
+    MidAddToContext ra args ->
+        hcat [ ptext (sLit "return via ")
+             , ppr_target ra, parens (commafy $ map ppr args), semi ]
+

   ) <>
   if debugPpr then empty
   else text " //" <+>
        case stmt of
   ) <>
   if debugPpr then empty
   else text " //" <+>
        case stmt of

-         MidNop {}     -> text "MidNop"

          CopyIn {}     -> text "CopyIn"
          CopyOut {}    -> text "CopyOut"
          MidComment {} -> text "MidComment"
          MidAssign {}  -> text "MidAssign"
          MidStore {}   -> text "MidStore"
          CopyIn {}     -> text "CopyIn"
          CopyOut {}    -> text "CopyOut"
          MidComment {} -> text "MidComment"
          MidAssign {}  -> text "MidAssign"
          MidStore {}   -> text "MidStore"

-         MidUnsafeCall {} -> text "MidUnsafeCall"
+         MidUnsafeCall  {} -> text "MidUnsafeCall"
+         MidAddToContext {} -> text "MidAddToContext"
+
+
+ppr_target :: CmmExpr -> SDoc
+ppr_target t@(CmmLit _) = ppr t
+ppr_target fn'          = parens (ppr fn')

 
 
 
 

-pprHinted :: Outputable a => (a, MachHint) -> SDoc
-pprHinted (a, NoHint)     = ppr a
-pprHinted (a, PtrHint)    = doubleQuotes (text "address") <+> ppr a
-pprHinted (a, SignedHint) = doubleQuotes (text "signed")  <+> ppr a
-pprHinted (a, FloatHint)  = doubleQuotes (text "float")   <+> ppr a
+pprHinted :: Outputable a => CmmHinted a -> SDoc
+pprHinted (CmmHinted a NoHint)     = ppr a
+pprHinted (CmmHinted a PtrHint)    = doubleQuotes (text "address") <+> ppr a
+pprHinted (CmmHinted a SignedHint) = doubleQuotes (text "signed")  <+> ppr a
+pprHinted (CmmHinted a FloatHint)  = doubleQuotes (text "float")   <+> ppr a

 
 pprLast :: Last -> SDoc    
 pprLast stmt = (case stmt of
 
 pprLast :: Last -> SDoc    
 pprLast stmt = (case stmt of

-    LastBranch ident args     -> genBranchWithArgs ident args
+    LastBranch ident          -> ptext (sLit "goto") <+> ppr ident <> semi

     LastCondBranch expr t f   -> genFullCondBranch expr t f
     LastCondBranch expr t f   -> genFullCondBranch expr t f

-    LastJump expr params      -> ppr $ CmmJump expr params
-    LastReturn results        -> hcat [ ptext SLIT("return"), space
-                                      , parens ( commafy $ map pprHinted results )
-                                      , semi ]
+    LastJump expr             -> hcat [ ptext (sLit "jump"), space, pprFun expr
+                                      , ptext (sLit "(...)"), semi]
+    LastReturn                -> hcat [ ptext (sLit "return"), space 
+                                      , ptext (sLit "(...)"), semi]

     LastSwitch arg ids        -> ppr $ CmmSwitch arg ids
     LastCall tgt k            -> genBareCall tgt k
   ) <>
     LastSwitch arg ids        -> ppr $ CmmSwitch arg ids
     LastCall tgt k            -> genBareCall tgt k
   ) <>

@@ -251,28 +290,24 @@ pprLast stmt = (case stmt of
 
 genBareCall :: CmmExpr -> Maybe BlockId -> SDoc
 genBareCall fn k =
 
 genBareCall :: CmmExpr -> Maybe BlockId -> SDoc
 genBareCall fn k =

-        hcat [ ptext SLIT("foreign"), space
-             , doubleQuotes(ptext SLIT("<convention from CopyOut>")), space
-             , target fn, parens  ( ptext SLIT("<parameters from CopyOut>") ), space
-             , case k of Nothing -> ptext SLIT("never returns")
-                         Just k -> ptext SLIT("returns to") <+> ppr k
+        hcat [ ptext (sLit "call"), space
+             , pprFun fn, ptext (sLit "(...)"), space
+             , case k of Nothing -> ptext (sLit "never returns")
+                         Just k -> ptext (sLit "returns to") <+> ppr k

              , semi ]
         where
              , semi ]
         where

-            target t@(CmmLit _) = ppr t
-            target fn'          = parens (ppr fn')

 
 

-genBranchWithArgs :: (Outputable id, Outputable arg) => id -> [arg] -> SDoc
-genBranchWithArgs ident [] = ptext SLIT("goto") <+> ppr ident <> semi
-genBranchWithArgs ident args = ptext SLIT("goto") <+> ppr ident <+>
-                               parens (commafy (map ppr args)) <> semi
+pprFun :: CmmExpr -> SDoc
+pprFun f@(CmmLit _) = ppr f
+pprFun f = parens (ppr f)

 
 genFullCondBranch :: Outputable id => CmmExpr -> id -> id -> SDoc
 genFullCondBranch expr t f =
 
 genFullCondBranch :: Outputable id => CmmExpr -> id -> id -> SDoc
 genFullCondBranch expr t f =

-    hsep [ ptext SLIT("if")
+    hsep [ ptext (sLit "if")

          , parens(ppr expr)
          , parens(ppr expr)

-         , ptext SLIT("goto")
+         , ptext (sLit "goto")

          , ppr t <> semi
          , ppr t <> semi

-         , ptext SLIT("else goto")
+         , ptext (sLit "else goto")

          , ppr f <> semi
          ]
 
          , ppr f <> semi
          ]