CmmContFlowOpt.hs 8.74 KB
Newer Older
1

2 3
module CmmContFlowOpt
    ( runCmmOpts, cmmCfgOpts, cmmCfgOptsZ
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
4
    , branchChainElimZ, removeUnreachableBlocksZ, predMap
5
    , replaceLabelsZ, runCmmContFlowOptsZs
6 7 8
    )
where

9
import BlockId
10 11 12
import Cmm
import CmmTx
import qualified ZipCfg as G
13
import ZipCfg
14
import ZipCfgCmmRep
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
15

16
import Maybes
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
17
import Monad
18
import Outputable
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
19 20
import Panic
import Prelude hiding (unzip, zip)
21 22 23 24
import Util
import UniqFM

------------------------------------
25 26 27 28
runCmmContFlowOptsZs :: [CmmZ] -> [CmmZ]
runCmmContFlowOptsZs prog
  = [ runTx (runCmmOpts cmmCfgOptsZ) cmm_top
    | cmm_top <- prog ]
29 30 31 32 33

cmmCfgOpts  :: Tx (ListGraph CmmStmt)
cmmCfgOptsZ :: Tx CmmGraph

cmmCfgOpts  = branchChainElim  -- boring, but will get more exciting later
34
cmmCfgOptsZ = branchChainElimZ `seqTx` blockConcatZ `seqTx` removeUnreachableBlocksZ
35 36 37 38 39 40 41 42 43 44
        -- Here branchChainElim can ultimately be replaced
        -- with a more exciting combination of optimisations

runCmmOpts :: Tx g -> Tx (GenCmm d h g)
runCmmOpts opt = mapProcs (optGraph opt)

optGraph :: Tx g -> Tx (GenCmmTop d h g)
optGraph _   top@(CmmData {}) = noTx top
optGraph opt (CmmProc info lbl formals g) = fmap (CmmProc info lbl formals) (opt g)

45 46 47 48
------------------------------------
mapProcs :: Tx (GenCmmTop d h s) -> Tx (GenCmm d h s)
mapProcs f (Cmm tops) = fmap Cmm (mapTx f tops)

49 50
----------------------------------------------------------------
branchChainElim :: Tx (ListGraph CmmStmt)
51 52 53
-- If L is not captured in an instruction, we can remove any
-- basic block of the form L: goto L', and replace L with L' everywhere else.
-- How does L get captured? In a CallArea.
54 55 56 57 58 59 60 61 62 63 64 65 66
branchChainElim (ListGraph blocks)
  | null lone_branch_blocks     -- No blocks to remove
  = noTx (ListGraph blocks)
  | otherwise
  = aTx (ListGraph new_blocks)
  where
    (lone_branch_blocks, others) = partitionWith isLoneBranch blocks
    new_blocks = map (replaceLabels env) others
    env = mkClosureBlockEnv lone_branch_blocks

isLoneBranch :: CmmBasicBlock -> Either (BlockId, BlockId) CmmBasicBlock
isLoneBranch (BasicBlock id [CmmBranch target]) | id /= target = Left (id, target)
isLoneBranch other_block                                       = Right other_block
Thomas Schilling's avatar
Thomas Schilling committed
67
   -- An infinite loop is not a link in a branch chain!
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82

replaceLabels :: BlockEnv BlockId -> CmmBasicBlock -> CmmBasicBlock
replaceLabels env (BasicBlock id stmts)
  = BasicBlock id (map replace stmts)
  where
    replace (CmmBranch id)       = CmmBranch (lookup id)
    replace (CmmCondBranch e id) = CmmCondBranch e (lookup id)
    replace (CmmSwitch e tbl)    = CmmSwitch e (map (fmap lookup) tbl)
    replace other_stmt           = other_stmt

    lookup id = lookupBlockEnv env id `orElse` id 
----------------------------------------------------------------
branchChainElimZ :: Tx CmmGraph
-- Remove any basic block of the form L: goto L',
-- and replace L with L' everywhere else
83
branchChainElimZ g@(G.LGraph eid args _)
84 85 86
  | null lone_branch_blocks     -- No blocks to remove
  = noTx g
  | otherwise
87
  = aTx $ replaceLabelsZ env $ G.of_block_list eid args (self_branches ++ others)
88 89
  where
    (lone_branch_blocks, others) = partitionWith isLoneBranchZ (G.to_block_list g)
90
    env = mkClosureBlockEnvZ lone_branch_blocks
91 92 93
    self_branches =
        let loop_to (id, _) =
                if lookup id == id then
94
                    Just (G.Block id Nothing (G.ZLast (G.mkBranchNode id)))
95 96 97
                else
                    Nothing
        in  mapMaybe loop_to lone_branch_blocks
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
98
    lookup id = lookupBlockEnv env id `orElse` id 
99

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
100
isLoneBranchZ :: CmmBlock -> Either (BlockId, BlockId) CmmBlock
101
isLoneBranchZ (G.Block id Nothing (G.ZLast (G.LastOther (LastBranch target))))
102 103
    | id /= target  = Left (id,target)
isLoneBranchZ other = Right other
Thomas Schilling's avatar
Thomas Schilling committed
104
   -- An infinite loop is not a link in a branch chain!
105

dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
106
replaceLabelsZ :: BlockEnv BlockId -> CmmGraph -> CmmGraph
107
replaceLabelsZ env = replace_eid . G.map_nodes id middle last
108
  where
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
    replace_eid (G.LGraph eid off blocks) = G.LGraph (lookup eid) off blocks
    middle m@(MidComment _)            = m
    middle   (MidAssign r e)           = MidAssign r (exp e)
    middle   (MidStore addr e)         = MidStore (exp addr) (exp e)
    middle   (MidUnsafeCall tgt fs as) = MidUnsafeCall (midcall tgt) fs (map exp as)
    middle   (MidAddToContext e es)    = MidAddToContext (exp e) (map exp es)
    last (LastBranch id)             = LastBranch (lookup id)
    last (LastCondBranch e ti fi)    = LastCondBranch (exp e) (lookup ti) (lookup fi)
    last (LastSwitch e tbl)          = LastSwitch (exp e) (map (fmap lookup) tbl)
    last (LastCall tgt mb_id s)      = LastCall (exp tgt) (fmap lookup mb_id) s
    last (LastJump e s)              = LastJump (exp e) s
    last (LastReturn s)              = LastReturn s
    midcall   (ForeignTarget e c)    = ForeignTarget (exp e) c
    midcall m@(PrimTarget _)         = m
    exp e@(CmmLit _)         = e
    exp   (CmmLoad addr ty)  = CmmLoad (exp addr) ty
    exp e@(CmmReg _)         = e
    exp   (CmmMachOp op es)  = CmmMachOp op $ map exp es
    exp e@(CmmRegOff _ _)    = e
    exp   (CmmStackSlot (CallArea (Young id)) i) =
      CmmStackSlot (CallArea (Young (lookup id))) i
    exp e@(CmmStackSlot _ _) = e
    lookup id = fmap lookup (lookupBlockEnv env id) `orElse` id 
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
132 133 134 135 136 137

----------------------------------------------------------------
-- Build a map from a block to its set of predecessors. Very useful.
predMap :: G.LastNode l => G.LGraph m l -> BlockEnv BlockSet
predMap g = G.fold_blocks add_preds emptyBlockEnv g -- find the back edges
  where add_preds b env = foldl (add b) env (G.succs b)
138
        add (G.Block bid _ _) env b' =
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
139 140 141 142 143 144
          extendBlockEnv env b' $
                extendBlockSet (lookupBlockEnv env b' `orElse` emptyBlockSet) bid
----------------------------------------------------------------
-- If a block B branches to a label L, and L has no other predecessors,
-- then we can splice the block starting with L onto the end of B.
-- Because this optmization can be inhibited by unreachable blocks,
145
-- we first take a pass to drops unreachable blocks.
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
146
-- Order matters, so we work bottom up (reverse postorder DFS).
147 148 149 150 151 152
--
-- To ensure correctness, we have to make sure that the BlockId of the block
-- we are about to eliminate is not named in another instruction
-- (except an adjacent stack pointer adjustment, which we expect and also eliminate).
-- For 
--
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
153
-- Note: This optimization does _not_ subsume branch chain elimination.
154 155
blockConcatZ  :: Tx CmmGraph
blockConcatZ = removeUnreachableBlocksZ `seqTx` blockConcatZ'
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
156
blockConcatZ' :: Tx CmmGraph
157 158 159 160 161 162
blockConcatZ' g@(G.LGraph eid off blocks) =
  tx $ pprTrace "concatMap" (ppr concatMap) $ replaceLabelsZ concatMap $ G.LGraph eid off blocks'
  where (changed, blocks', concatMap) =
           foldr maybe_concat (False, blocks, emptyBlockEnv) $ G.postorder_dfs g
        maybe_concat b@(G.Block bid _ _) (changed, blocks', concatMap) =
          let unchanged = (changed, extendBlockEnv blocks' bid b, concatMap)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
163 164 165
          in case G.goto_end $ G.unzip b of
               (h, G.LastOther (LastBranch b')) ->
                  if num_preds b' == 1 then
166 167
                    (True, extendBlockEnv blocks' bid $ splice blocks' h b',
                     extendBlockEnv concatMap b' bid)
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
168 169 170 171 172 173
                  else unchanged
               _ -> unchanged
        num_preds bid = liftM sizeBlockSet (lookupBlockEnv backEdges bid) `orElse` 0
        backEdges = predMap g
        splice blocks' h bid' =
          case lookupBlockEnv blocks' bid' of
174 175 176
            Just (G.Block _ Nothing t) -> G.zip $ G.ZBlock h t
            Just (G.Block _ (Just _) _) ->
              panic "trying to concatenate but successor block has incoming args"
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
177 178
            Nothing -> panic "unknown successor block"
        tx = if changed then aTx else noTx
179 180 181 182 183 184 185 186
----------------------------------------------------------------
mkClosureBlockEnv :: [(BlockId, BlockId)] -> BlockEnv BlockId
mkClosureBlockEnv blocks = mkBlockEnv $ map follow blocks
    where singleEnv = mkBlockEnv blocks
          follow (id, next) = (id, endChain id next)
          endChain orig id = case lookupBlockEnv singleEnv id of
                               Just id' | id /= orig -> endChain orig id'
                               _ -> id
187 188 189 190 191 192 193
mkClosureBlockEnvZ :: [(BlockId, BlockId)] -> BlockEnv BlockId
mkClosureBlockEnvZ blocks = mkBlockEnv $ map follow blocks
    where singleEnv = mkBlockEnv blocks
          follow (id, next) = (id, endChain id next)
          endChain orig id = case lookupBlockEnv singleEnv id of
                               Just id' | id /= orig -> endChain orig id'
                               _ -> id
194 195
----------------------------------------------------------------
removeUnreachableBlocksZ :: Tx CmmGraph
196 197
removeUnreachableBlocksZ g@(G.LGraph id off blocks) =
      if length blocks' < sizeUFM blocks then aTx $ G.of_block_list id off blocks'
198 199
      else noTx g
    where blocks' = G.postorder_dfs g