CmmContFlowOpt.hs 8.58 KB
Newer Older
1 2
{-# LANGUAGE GADTs #-}
{-# OPTIONS_GHC -fno-warn-warnings-deprecations -fno-warn-incomplete-patterns #-}
3

4
module CmmContFlowOpt
5
    ( cmmCfgOpts
Simon Marlow's avatar
Simon Marlow committed
6
    , cmmCfgOptsProc
7 8
    , removeUnreachableBlocks
    , replaceLabels
9 10 11
    )
where

12
import BlockId
13
import Cmm
14
import CmmUtils
15
import Maybes
16

Simon Marlow's avatar
Simon Marlow committed
17
import Hoopl
Ian Lynagh's avatar
Ian Lynagh committed
18
import Control.Monad
19
import Prelude hiding (succ, unzip, zip)
20

21 22 23 24 25
-----------------------------------------------------------------------------
--
-- Control-flow optimisations
--
-----------------------------------------------------------------------------
26

27
cmmCfgOpts :: CmmGraph -> CmmGraph
28
cmmCfgOpts g = fst (blockConcat g)
29

Simon Marlow's avatar
Simon Marlow committed
30
cmmCfgOptsProc :: CmmDecl -> CmmDecl
31
cmmCfgOptsProc (CmmProc info lbl g) = CmmProc info' lbl g'
32 33 34
    where (g', env) = blockConcat g
          info' = info{ info_tbls = new_info_tbls }
          new_info_tbls = mapFromList (map upd_info (mapToList (info_tbls info)))
Simon Marlow's avatar
Simon Marlow committed
35

36 37 38
          -- If we changed any labels, then we have to update the info tables
          -- too, except for the top-level info table because that might be
          -- referred to by other procs.
39 40
          upd_info (k,info)
             | Just k' <- mapLookup k env
41 42 43
             = (k', if k' == g_entry g'
                       then info
                       else info{ cit_lbl = infoTblLbl k' })
44 45 46 47
             | otherwise
             = (k,info)

cmmCfgOptsProc top = top
48

49

50 51
-----------------------------------------------------------------------------
--
52
-- Block concatenation
53 54 55
--
-----------------------------------------------------------------------------

56
-- This optimisation does three things:
57 58 59 60 61 62 63 64 65 66
--   - If a block finishes with an unconditional branch, then we may
--     be able to concatenate the block it points to and remove the
--     branch.  We do this either if the destination block is small
--     (e.g. just another branch), or if this is the only jump to
--     this particular destination block.
--
--   - If a block finishes in a call whose continuation block is a
--     goto, then we can shortcut the destination, making the
--     continuation block the destination of the goto.
--
67 68 69 70
--   - removes any unreachable blocks from the graph.  This is a side
--     effect of starting with a postorder DFS traversal of the graph
--

71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
-- Both transformations are improved by working from the end of the
-- graph towards the beginning, because we may be able to perform many
-- shortcuts in one go.


-- We need to walk over the blocks from the end back to the
-- beginning.  We are going to maintain the "current" graph
-- (BlockEnv CmmBlock) as we go, and also a mapping from BlockId
-- to BlockId, representing continuation labels that we have
-- renamed.  This latter mapping is important because we might
-- shortcut a CmmCall continuation.  For example:
--
--    Sp[0] = L
--    call g returns to L
--
--    L: goto M
87
--
88 89 90 91 92 93 94 95
--    M: ...
--
-- So when we shortcut the L block, we need to replace not only
-- the continuation of the call, but also references to L in the
-- code (e.g. the assignment Sp[0] = L).  So we keep track of
-- which labels we have renamed and apply the mapping at the end
-- with replaceLabels.

96
blockConcat  :: CmmGraph -> (CmmGraph, BlockEnv BlockId)
97
blockConcat g@CmmGraph { g_entry = entry_id }
98
  = (replaceLabels shortcut_map $ ofBlockMap new_entry new_blocks, shortcut_map)
99
  where
100 101 102 103 104 105 106
     -- we might be able to shortcut the entry BlockId itself
     new_entry
       | Just entry_blk <- mapLookup entry_id new_blocks
       , Just dest      <- canShortcut entry_blk
       = dest
       | otherwise
       = entry_id
107

108
     blocks = postorderDfs g
109 110 111
     blockmap = foldr addBlock emptyBody blocks
      -- the initial blockmap is constructed from the postorderDfs result,
      -- so that we automatically throw away unreachable blocks.
112 113

     (new_blocks, shortcut_map) =
114
           foldr maybe_concat (blockmap, mapEmpty) blocks
115 116 117 118

     maybe_concat :: CmmBlock
                  -> (BlockEnv CmmBlock, BlockEnv BlockId)
                  -> (BlockEnv CmmBlock, BlockEnv BlockId)
119
     maybe_concat block (blocks, shortcut_map)
120 121
        | CmmBranch b' <- last
        , Just blk' <- mapLookup b' blocks
Simon Marlow's avatar
Simon Marlow committed
122 123
        , shouldConcatWith b' blk'
        = (mapInsert bid (splice head blk') blocks, shortcut_map)
124

125 126 127
        -- calls: if we can shortcut the continuation label, then
        -- we must *also* remember to substitute for the label in the
        -- code, because we will push it somewhere.
128 129
        | Just b'   <- callContinuation_maybe last
        , Just blk' <- mapLookup b' blocks
Simon Marlow's avatar
Simon Marlow committed
130 131
        , Just dest <- canShortcut blk'
        = (blocks, mapInsert b' dest shortcut_map)
132 133
           -- replaceLabels will substitute dest for b' everywhere, later

134 135 136 137 138 139 140
        -- non-calls: see if we can shortcut any of the successors.
        | Nothing <- callContinuation_maybe last
        = ( mapInsert bid (blockJoinTail head shortcut_last) blocks
          , shortcut_map )

        | otherwise
        = (blocks, shortcut_map)
141
        where
Simon Marlow's avatar
Simon Marlow committed
142 143
          (head, last) = blockSplitTail block
          bid = entryLabel block
144 145 146 147 148
          shortcut_last = mapSuccessors shortcut last
          shortcut l =
             case mapLookup l blocks of
               Just b | Just dest <- canShortcut b  -> dest
               _otherwise -> l
149 150 151 152 153 154 155

     shouldConcatWith b block
       | num_preds b == 1    = True  -- only one predecessor: go for it
       | okToDuplicate block = True  -- short enough to duplicate
       | otherwise           = False
       where num_preds bid = mapLookup bid backEdges `orElse` 0

Simon Marlow's avatar
Simon Marlow committed
156
     canShortcut :: CmmBlock -> Maybe BlockId
157
     canShortcut block
Simon Marlow's avatar
Simon Marlow committed
158
       | (_, middle, CmmBranch dest) <- blockSplit block
159 160 161 162 163 164
       , isEmptyBlock middle
       = Just dest
       | otherwise
       = Nothing

     backEdges :: BlockEnv Int -- number of predecessors for each block
Simon Marlow's avatar
Simon Marlow committed
165 166
     backEdges = mapInsertWith (+) entry_id 1 $ -- add 1 for the entry id
                   mapMap setSize $ predMap blocks
167 168

     splice :: Block CmmNode C O -> CmmBlock -> CmmBlock
Simon Marlow's avatar
Simon Marlow committed
169
     splice head rest = head `blockAppend` snd (blockSplitHead rest)
170 171 172 173 174 175 176


callContinuation_maybe :: CmmNode O C -> Maybe BlockId
callContinuation_maybe (CmmCall { cml_cont = Just b }) = Just b
callContinuation_maybe (CmmForeignCall { succ = b })   = Just b
callContinuation_maybe _ = Nothing

Simon Marlow's avatar
Simon Marlow committed
177
okToDuplicate :: CmmBlock -> Bool
178
okToDuplicate block
179 180 181 182 183 184 185
  = case blockSplit block of
      (_, m, CmmBranch _) -> isEmptyBlock m
      -- cheap and cheerful; we might expand this in the future to
      -- e.g. spot blocks that represent a single instruction or two.
      -- Be careful: a CmmCall can be more than one instruction, it
      -- has a CmmExpr inside it.
      _otherwise -> False
186 187 188 189

------------------------------------------------------------------------
-- Map over the CmmGraph, replacing each label with its mapping in the
-- supplied BlockEnv.
190 191

replaceLabels :: BlockEnv BlockId -> CmmGraph -> CmmGraph
192
replaceLabels env g
Simon Marlow's avatar
Simon Marlow committed
193 194
  | mapNull env = g
  | otherwise   = replace_eid $ mapGraphNodes1 txnode g
195
   where
196
     replace_eid g = g {g_entry = lookup (g_entry g)}
197 198 199 200
     lookup id = mapLookup id env `orElse` id

     txnode :: CmmNode e x -> CmmNode e x
     txnode (CmmBranch bid)         = CmmBranch (lookup bid)
201
     txnode (CmmCondBranch p t f)   = mkCmmCondBranch (exp p) (lookup t) (lookup f)
202
     txnode (CmmSwitch e arms)      = CmmSwitch (exp e) (map (liftM lookup) arms)
203
     txnode (CmmCall t k rg a res r) = CmmCall (exp t) (liftM lookup k) rg a res r
204 205 206 207 208
     txnode fc@CmmForeignCall{}     = fc{ args = map exp (args fc)
                                        , succ = lookup (succ fc) }
     txnode other                   = mapExpDeep exp other

     exp :: CmmExpr -> CmmExpr
209
     exp (CmmLit (CmmBlock bid))                = CmmLit (CmmBlock (lookup bid))
Simon Marlow's avatar
Simon Marlow committed
210
     exp (CmmStackSlot (Young id) i) = CmmStackSlot (Young (lookup id)) i
211 212
     exp e                                      = e

Simon Marlow's avatar
Simon Marlow committed
213
mkCmmCondBranch :: CmmExpr -> Label -> Label -> CmmNode O C
214
mkCmmCondBranch p t f = if t == f then CmmBranch t else CmmCondBranch p t f
dias@eecs.harvard.edu's avatar
dias@eecs.harvard.edu committed
215 216 217

----------------------------------------------------------------
-- Build a map from a block to its set of predecessors. Very useful.
218

219 220 221 222 223
predMap :: [CmmBlock] -> BlockEnv BlockSet
predMap blocks = foldr add_preds mapEmpty blocks -- find the back edges
  where add_preds block env = foldl (add (entryLabel block)) env (successors block)
        add bid env b' =
          mapInsert b' (setInsert bid (mapLookup b' env `orElse` setEmpty)) env
224 225 226 227 228 229


-----------------------------------------------------------------------------
--
-- Removing unreachable blocks

230
removeUnreachableBlocks :: CmmGraph -> CmmGraph
231 232 233 234
removeUnreachableBlocks g
  | length blocks < mapSize (toBlockMap g) = ofBlockList (g_entry g) blocks
  | otherwise = g
  where blocks = postorderDfs g