CmmPipeline.hs 8.05 KB
Newer Older
1 2 3
{-# OPTIONS_GHC -XNoMonoLocalBinds #-}
-- Norman likes local bindings
-- If this module lives on I'd like to get rid of this flag in due course
4

Edward Z. Yang's avatar
Edward Z. Yang committed
5
module CmmPipeline (
6 7 8 9
  -- | Converts C-- with an implicit stack and native C-- calls into
  -- optimized, CPS converted and native-call-less C--.  The latter
  -- C-- can be used to generate assembly.
  cmmPipeline
10
) where
11

12
import CLabel
13
import Cmm
14 15 16
import CmmDecl
import CmmBuildInfoTables
import CmmCommonBlockElim
17
import CmmProcPoint
18
import CmmSpillReload
19
import CmmRewriteAssignments
20
import CmmStackLayout
21
import CmmContFlowOpt
22
import OptimizationFuel
23 24 25

import DynFlags
import ErrUtils
26 27
import HscTypes
import Data.Maybe
Ian Lynagh's avatar
Ian Lynagh committed
28
import Control.Monad
29 30 31 32
import Data.Map (Map)
import qualified Data.Map as Map
import Outputable
import StaticFlags
33

34
-----------------------------------------------------------------------------
35
-- | Top level driver for C-- pipeline
36
-----------------------------------------------------------------------------
37 38 39 40 41 42 43 44 45 46 47 48 49
-- There are two complications here:
-- 1. We need to compile the procedures in two stages because we need
--    an analysis of the procedures to tell us what CAFs they use.
--    The first stage returns a map from procedure labels to CAFs,
--    along with a closure that will compute SRTs and attach them to
--    the compiled procedures.
--    The second stage is to combine the CAF information into a top-level
--    CAF environment mapping non-static closures to the CAFs they keep live,
--    then pass that environment to the closures returned in the first
--    stage of compilation.
-- 2. We need to thread the module's SRT around when the SRT tables
--    are computed for each procedure.
--    The SRT needs to be threaded because it is grown lazily.
50 51 52 53 54
-- 3. We run control flow optimizations twice, once before any pipeline
--    work is done, and once again at the very end on all of the
--    resulting C-- blocks.  EZY: It's unclear whether or not whether
--    we actually need to do the initial pass.
cmmPipeline  :: HscEnv -- Compilation env including
55 56 57 58
                       -- dynamic flags: -dcmm-lint -ddump-cps-cmm
             -> (TopSRT, [Cmm])    -- SRT table and accumulating list of compiled procs
             -> Cmm                -- Input C-- with Procedures
             -> IO (TopSRT, [Cmm]) -- Output CPS transformed C--
59
cmmPipeline hsc_env (topSRT, rst) prog =
60
  do let dflags = hsc_dflags hsc_env
61
         (Cmm tops) = runCmmContFlowOpts prog
62 63 64 65 66 67
     showPass dflags "CPSZ"
     (cafEnvs, tops) <- liftM unzip $ mapM (cpsTop hsc_env) tops
     let topCAFEnv = mkTopCAFInfo (concat cafEnvs)
     (topSRT, tops) <- foldM (toTops hsc_env topCAFEnv) (topSRT, []) tops
     let cmms = Cmm (reverse (concat tops))
     dumpIfSet_dyn dflags Opt_D_dump_cps_cmm "Post CPS Cmm" (ppr cmms)
68 69 70
     -- SRT is not affected by control flow optimization pass
     let prog' = map runCmmContFlowOpts (cmms : rst)
     return (topSRT, prog')
71 72 73 74 75 76 77 78

{- [Note global fuel]
~~~~~~~~~~~~~~~~~~~~~
The identity and the last pass are stored in
mutable reference cells in an 'HscEnv' and are
global to one compiler session.
-}

79 80 81 82
-- EZY: It might be helpful to have an easy way of dumping the "pre"
-- input for any given phase, besides just turning it all on with
-- -ddump-cmmz

83 84 85 86
cpsTop :: HscEnv -> CmmTop -> IO ([(CLabel, CAFSet)], [(CAFSet, CmmTop)])
cpsTop _ p@(CmmData {}) = return ([], [(Map.empty, p)])
cpsTop hsc_env (CmmProc h@(TopInfo {stack_info=StackInfo {arg_space=entry_off}}) l g) =
    do
87 88
       -- Why bother doing these early: dualLivenessWithInsertion,
       -- insertLateReloads, rewriteAssignments?
89

90 91 92
       ----------- Eliminate common blocks -------------------
       g <- return $ elimCommonBlocks g
       dump Opt_D_dump_cmmz_cbe "Post common block elimination" g
93 94 95 96 97 98
       -- Any work storing block Labels must be performed _after_ elimCommonBlocks

       ----------- Proc points -------------------
       let callPPs = callProcPoints g
       procPoints <- run $ minimalProcPointSet callPPs g
       g <- run $ addProcPointProtocols callPPs procPoints g
99
       dump Opt_D_dump_cmmz_proc "Post Proc Points Added" g
100 101

       ----------- Spills and reloads -------------------
102 103
       g <- run $ dualLivenessWithInsertion procPoints g
       dump Opt_D_dump_cmmz_spills "Post spills and reloads" g
104

105 106 107 108 109 110
       ----------- Sink and inline assignments -------------------
       g <- runOptimization $ rewriteAssignments g
       dump Opt_D_dump_cmmz_rewrite "Post rewrite assignments" g

       ----------- Eliminate dead assignments -------------------
       -- Remove redundant reloads (and any other redundant asst)
111
       --   in CmmSpillReloads
112 113 114 115 116 117 118 119 120
       g <- runOptimization $ removeDeadAssignmentsAndReloads procPoints g
       dump Opt_D_dump_cmmz_dead "Post Dead Assignment Elimination" g

       ----------- Zero dead stack slots (Debug only) ---------------
       -- Debugging: stubbing slots on death can cause crashes early
       g <- if opt_StubDeadValues
                then run $ stubSlotsOnDeath g
                else return g
       dump Opt_D_dump_cmmz_stub "Post stub dead stack slots" g
121 122 123

       --------------- Stack layout ----------------
       slotEnv <- run $ liveSlotAnal g
124
       let spEntryMap = getSpEntryMap entry_off g
125
       mbpprTrace "live slot analysis results: " (ppr slotEnv) $ return ()
126
       let areaMap = layout procPoints spEntryMap slotEnv entry_off g
127 128 129
       mbpprTrace "areaMap" (ppr areaMap) $ return ()

       ------------  Manifest the stack pointer --------
130
       g  <- run $ manifestSP spEntryMap areaMap entry_off g
131
       dump Opt_D_dump_cmmz_sp "Post manifestSP" g
132 133 134 135 136
       -- UGH... manifestSP can require updates to the procPointMap.
       -- We can probably do something quicker here for the update...

       ------------- Split into separate procedures ------------
       procPointMap  <- run $ procPointAnalysis procPoints g
137
       dump Opt_D_dump_cmmz_procmap "procpoint map" procPointMap
138 139
       gs <- run $ splitAtProcPoints l callPPs procPoints procPointMap
                                       (CmmProc h l g)
140
       mapM_ (dump Opt_D_dump_cmmz_split "Post splitting") gs
141 142 143 144 145 146 147

       ------------- More CAFs and foreign calls ------------
       cafEnv <- run $ cafAnal g
       let localCAFs = catMaybes $ map (localCAFInfo cafEnv) gs
       mbpprTrace "localCAFs" (ppr localCAFs) $ return ()

       gs <- run $ mapM (lowerSafeForeignCalls areaMap) gs
148
       mapM_ (dump Opt_D_dump_cmmz_lower "Post lowerSafeForeignCalls") gs
149 150

       -- NO MORE GRAPH TRANSFORMATION AFTER HERE -- JUST MAKING INFOTABLES
151 152 153 154 155
       gs <- return $ map (setInfoTableStackMap slotEnv areaMap) gs
       mapM_ (dump Opt_D_dump_cmmz_info "after setInfoTableStackMap") gs
       gs <- return $ map (bundleCAFs cafEnv) gs
       mapM_ (dump Opt_D_dump_cmmz_cafs "after bundleCAFs") gs
       return (localCAFs, gs)
156 157
  where dflags = hsc_dflags hsc_env
        mbpprTrace x y z = if dopt Opt_D_dump_cmmz dflags then pprTrace x y z else z
158 159 160 161 162 163 164
        dump f txt g = do
            -- ToDo: No easy way of say "dump all the cmmz, *and* split
            -- them into files."  Also, -ddump-cmmz doesn't play nicely
            -- with -ddump-to-file, since the headers get omitted.
            dumpIfSet_dyn dflags f txt (ppr g)
            when (not (dopt f dflags)) $
                dumpIfSet_dyn dflags Opt_D_dump_cmmz txt (ppr g)
165 166 167 168 169 170
        -- Runs a required transformation/analysis
        run = runInfiniteFuelIO (hsc_OptFuel hsc_env)
        -- Runs an optional transformation/analysis (and should
        -- thus be subject to optimization fuel)
        runOptimization = runFuelIO (hsc_OptFuel hsc_env)

171 172 173 174 175 176 177 178 179 180 181
-- This probably belongs in CmmBuildInfoTables?
-- We're just finishing the job here: once we know what CAFs are defined
-- in non-static closures, we can build the SRTs.
toTops :: HscEnv -> Map CLabel CAFSet -> (TopSRT, [[CmmTop]])
                 -> [(CAFSet, CmmTop)] -> IO (TopSRT, [[CmmTop]])
toTops hsc_env topCAFEnv (topSRT, tops) gs =
  do let setSRT (topSRT, rst) g =
           do (topSRT, gs) <- setInfoTableSRT topCAFEnv topSRT g
              return (topSRT, gs : rst)
     (topSRT, gs') <- runFuelIO (hsc_OptFuel hsc_env) $ foldM setSRT (topSRT, []) gs
     return (topSRT, concat gs' : tops)