{-# LANGUAGE BangPatterns #-}
module GHC.Cmm.Pipeline (
cmmPipeline
) where
import GHC.Prelude
import GHC.Cmm
import GHC.Cmm.Config
import GHC.Cmm.ContFlowOpt
import GHC.Cmm.CommonBlockElim
import GHC.Cmm.Dataflow.Collections
import GHC.Cmm.Info.Build
import GHC.Cmm.Lint
import GHC.Cmm.LayoutStack
import GHC.Cmm.ProcPoint
import GHC.Cmm.Sink
import GHC.Cmm.Switch.Implement
import GHC.Types.Unique.Supply
import GHC.Driver.Session
import GHC.Driver.Config.Cmm
import GHC.Utils.Error
import GHC.Utils.Logger
import GHC.Driver.Env
import Control.Monad
import GHC.Utils.Outputable
import GHC.Platform
import Data.Either (partitionEithers)
cmmPipeline
:: HscEnv
-> ModuleSRTInfo
-> CmmGroup
-> IO (ModuleSRTInfo, CmmGroupSRTs)
cmmPipeline :: HscEnv
-> ModuleSRTInfo -> CmmGroup -> IO (ModuleSRTInfo, [CmmDeclSRTs])
cmmPipeline HscEnv
hsc_env ModuleSRTInfo
srtInfo CmmGroup
prog = do
let logger :: Logger
logger = HscEnv -> Logger
hsc_logger HscEnv
hsc_env
let cmmConfig :: CmmConfig
cmmConfig = DynFlags -> CmmConfig
initCmmConfig (HscEnv -> DynFlags
hsc_dflags HscEnv
hsc_env)
let forceRes :: (a, t a) -> ()
forceRes (a
info, t a
group) = a
info seq :: forall a b. a -> b -> b
`seq` forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr seq :: forall a b. a -> b -> b
seq () t a
group
let platform :: Platform
platform = CmmConfig -> Platform
cmmPlatform CmmConfig
cmmConfig
forall (m :: * -> *) a.
MonadIO m =>
Logger -> SDoc -> (a -> ()) -> m a -> m a
withTimingSilent Logger
logger (String -> SDoc
text String
"Cmm pipeline") forall {t :: * -> *} {a} {a}. Foldable t => (a, t a) -> ()
forceRes forall a b. (a -> b) -> a -> b
$ do
[Either (CAFEnv, CmmGroup) (Set CAFfyLabel, CmmDecl)]
tops <- {-# SCC "tops" #-} forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
(a -> m b) -> t a -> m (t b)
mapM (Logger
-> Platform
-> CmmConfig
-> CmmDecl
-> IO (Either (CAFEnv, CmmGroup) (Set CAFfyLabel, CmmDecl))
cpsTop Logger
logger Platform
platform CmmConfig
cmmConfig) CmmGroup
prog
let ([(CAFEnv, CmmGroup)]
procs, [(Set CAFfyLabel, CmmDecl)]
data_) = forall a b. [Either a b] -> ([a], [b])
partitionEithers [Either (CAFEnv, CmmGroup) (Set CAFfyLabel, CmmDecl)]
tops
(ModuleSRTInfo
srtInfo, [CmmDeclSRTs]
cmms) <- {-# SCC "doSRTs" #-} CmmConfig
-> ModuleSRTInfo
-> [(CAFEnv, CmmGroup)]
-> [(Set CAFfyLabel, CmmDecl)]
-> IO (ModuleSRTInfo, [CmmDeclSRTs])
doSRTs CmmConfig
cmmConfig ModuleSRTInfo
srtInfo [(CAFEnv, CmmGroup)]
procs [(Set CAFfyLabel, CmmDecl)]
data_
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
Opt_D_dump_cmm_cps String
"Post CPS Cmm" DumpFormat
FormatCMM (forall env a. OutputableP env a => env -> a -> SDoc
pdoc Platform
platform [CmmDeclSRTs]
cmms)
forall (m :: * -> *) a. Monad m => a -> m a
return (ModuleSRTInfo
srtInfo, [CmmDeclSRTs]
cmms)
cpsTop :: Logger -> Platform -> CmmConfig -> CmmDecl -> IO (Either (CAFEnv, [CmmDecl]) (CAFSet, CmmDecl))
cpsTop :: Logger
-> Platform
-> CmmConfig
-> CmmDecl
-> IO (Either (CAFEnv, CmmGroup) (Set CAFfyLabel, CmmDecl))
cpsTop Logger
_logger Platform
platform CmmConfig
_ p :: CmmDecl
p@(CmmData Section
_ GenCmmStatics 'False
statics) = forall (m :: * -> *) a. Monad m => a -> m a
return (forall a b. b -> Either a b
Right (Platform -> GenCmmStatics 'False -> Set CAFfyLabel
cafAnalData Platform
platform GenCmmStatics 'False
statics, CmmDecl
p))
cpsTop Logger
logger Platform
platform CmmConfig
cfg CmmDecl
proc =
do
CmmProc CmmTopInfo
h CLabel
l [GlobalReg]
v CmmGraph
g <- {-# SCC "cmmCfgOpts(1)" #-}
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ Bool -> CmmDecl -> CmmDecl
cmmCfgOptsProc Bool
splitting_proc_points CmmDecl
proc
DumpFlag -> String -> CmmGraph -> IO ()
dump DumpFlag
Opt_D_dump_cmm_cfg String
"Post control-flow optimisations" CmmGraph
g
let !TopInfo {stack_info :: CmmTopInfo -> CmmStackInfo
stack_info=StackInfo { arg_space :: CmmStackInfo -> ByteOff
arg_space = ByteOff
entry_off
, do_layout :: CmmStackInfo -> Bool
do_layout = Bool
do_layout }} = CmmTopInfo
h
CmmGraph
g <- {-# SCC "elimCommonBlocks" #-}
Bool
-> (CmmGraph -> CmmGraph)
-> CmmGraph
-> DumpFlag
-> String
-> IO CmmGraph
condPass (CmmConfig -> Bool
cmmOptElimCommonBlks CmmConfig
cfg) CmmGraph -> CmmGraph
elimCommonBlocks CmmGraph
g
DumpFlag
Opt_D_dump_cmm_cbe String
"Post common block elimination"
CmmGraph
g <- if CmmConfig -> Bool
cmmDoCmmSwitchPlans CmmConfig
cfg
then {-# SCC "createSwitchPlans" #-}
forall a. UniqSM a -> IO a
runUniqSM forall a b. (a -> b) -> a -> b
$ Platform -> CmmGraph -> UniqSM CmmGraph
cmmImplementSwitchPlans Platform
platform CmmGraph
g
else forall (f :: * -> *) a. Applicative f => a -> f a
pure CmmGraph
g
DumpFlag -> String -> CmmGraph -> IO ()
dump DumpFlag
Opt_D_dump_cmm_switch String
"Post switch plan" CmmGraph
g
let
call_pps :: ProcPointSet
call_pps :: ProcPointSet
call_pps = {-# SCC "callProcPoints" #-} CmmGraph -> ProcPointSet
callProcPoints CmmGraph
g
ProcPointSet
proc_points <-
if Bool
splitting_proc_points
then do
ProcPointSet
pp <- {-# SCC "minimalProcPointSet" #-} forall a. UniqSM a -> IO a
runUniqSM forall a b. (a -> b) -> a -> b
$
Platform -> ProcPointSet -> CmmGraph -> UniqSM ProcPointSet
minimalProcPointSet Platform
platform ProcPointSet
call_pps CmmGraph
g
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
Opt_D_dump_cmm_proc String
"Proc points"
DumpFormat
FormatCMM (forall env a. OutputableP env a => env -> a -> SDoc
pdoc Platform
platform CLabel
l SDoc -> SDoc -> SDoc
$$ forall a. Outputable a => a -> SDoc
ppr ProcPointSet
pp SDoc -> SDoc -> SDoc
$$ forall env a. OutputableP env a => env -> a -> SDoc
pdoc Platform
platform CmmGraph
g)
forall (m :: * -> *) a. Monad m => a -> m a
return ProcPointSet
pp
else
forall (m :: * -> *) a. Monad m => a -> m a
return ProcPointSet
call_pps
(CmmGraph
g, LabelMap StackMap
stackmaps) <-
{-# SCC "layoutStack" #-}
if Bool
do_layout
then forall a. UniqSM a -> IO a
runUniqSM forall a b. (a -> b) -> a -> b
$ CmmConfig
-> ProcPointSet
-> ByteOff
-> CmmGraph
-> UniqSM (CmmGraph, LabelMap StackMap)
cmmLayoutStack CmmConfig
cfg ProcPointSet
proc_points ByteOff
entry_off CmmGraph
g
else forall (m :: * -> *) a. Monad m => a -> m a
return (CmmGraph
g, forall (map :: * -> *) a. IsMap map => map a
mapEmpty)
DumpFlag -> String -> CmmGraph -> IO ()
dump DumpFlag
Opt_D_dump_cmm_sp String
"Layout Stack" CmmGraph
g
CmmGraph
g <- {-# SCC "sink" #-}
Bool
-> (CmmGraph -> CmmGraph)
-> CmmGraph
-> DumpFlag
-> String
-> IO CmmGraph
condPass (CmmConfig -> Bool
cmmOptSink CmmConfig
cfg) (Platform -> CmmGraph -> CmmGraph
cmmSink Platform
platform) CmmGraph
g
DumpFlag
Opt_D_dump_cmm_sink String
"Sink assignments"
let cafEnv :: CAFEnv
cafEnv = {-# SCC "cafAnal" #-} Platform -> ProcPointSet -> CLabel -> CmmGraph -> CAFEnv
cafAnal Platform
platform ProcPointSet
call_pps CLabel
l CmmGraph
g
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
Opt_D_dump_cmm_caf String
"CAFEnv" DumpFormat
FormatText (forall env a. OutputableP env a => env -> a -> SDoc
pdoc Platform
platform CAFEnv
cafEnv)
CmmGroup
g <- if Bool
splitting_proc_points
then do
let pp_map :: LabelMap Status
pp_map = {-# SCC "procPointAnalysis" #-}
ProcPointSet -> CmmGraph -> LabelMap Status
procPointAnalysis ProcPointSet
proc_points CmmGraph
g
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
Opt_D_dump_cmm_procmap String
"procpoint map"
DumpFormat
FormatCMM (forall a. Outputable a => a -> SDoc
ppr LabelMap Status
pp_map)
CmmGroup
g <- {-# SCC "splitAtProcPoints" #-} forall a. UniqSM a -> IO a
runUniqSM forall a b. (a -> b) -> a -> b
$
Platform
-> CLabel
-> ProcPointSet
-> ProcPointSet
-> LabelMap Status
-> CmmDecl
-> UniqSM CmmGroup
splitAtProcPoints Platform
platform CLabel
l ProcPointSet
call_pps ProcPointSet
proc_points LabelMap Status
pp_map
(forall d h g. h -> CLabel -> [GlobalReg] -> g -> GenCmmDecl d h g
CmmProc CmmTopInfo
h CLabel
l [GlobalReg]
v CmmGraph
g)
DumpFlag -> String -> CmmGroup -> IO ()
dumps DumpFlag
Opt_D_dump_cmm_split String
"Post splitting" CmmGroup
g
forall (m :: * -> *) a. Monad m => a -> m a
return CmmGroup
g
else
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ [ProcPointSet -> CmmDecl -> CmmDecl
attachContInfoTables ProcPointSet
call_pps (forall d h g. h -> CLabel -> [GlobalReg] -> g -> GenCmmDecl d h g
CmmProc CmmTopInfo
h CLabel
l [GlobalReg]
v CmmGraph
g)]
CmmGroup
g <- {-# SCC "setInfoTableStackMap" #-}
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. (a -> b) -> [a] -> [b]
map (Platform -> LabelMap StackMap -> CmmDecl -> CmmDecl
setInfoTableStackMap Platform
platform LabelMap StackMap
stackmaps) CmmGroup
g
DumpFlag -> String -> CmmGroup -> IO ()
dumps DumpFlag
Opt_D_dump_cmm_info String
"after setInfoTableStackMap" CmmGroup
g
CmmGroup
g <- {-# SCC "cmmCfgOpts(2)" #-}
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ if CmmConfig -> Bool
cmmOptControlFlow CmmConfig
cfg
then forall a b. (a -> b) -> [a] -> [b]
map (Bool -> CmmDecl -> CmmDecl
cmmCfgOptsProc Bool
splitting_proc_points) CmmGroup
g
else CmmGroup
g
CmmGroup
g <- forall (m :: * -> *) a. Monad m => a -> m a
return (forall a b. (a -> b) -> [a] -> [b]
map CmmDecl -> CmmDecl
removeUnreachableBlocksProc CmmGroup
g)
DumpFlag -> String -> CmmGroup -> IO ()
dumps DumpFlag
Opt_D_dump_cmm_cfg String
"Post control-flow optimisations" CmmGroup
g
forall (m :: * -> *) a. Monad m => a -> m a
return (forall a b. a -> Either a b
Left (CAFEnv
cafEnv, CmmGroup
g))
where dump :: DumpFlag -> String -> CmmGraph -> IO ()
dump = Logger
-> Platform -> Bool -> DumpFlag -> String -> CmmGraph -> IO ()
dumpGraph Logger
logger Platform
platform (CmmConfig -> Bool
cmmDoLinting CmmConfig
cfg)
dumps :: DumpFlag -> String -> CmmGroup -> IO ()
dumps DumpFlag
flag String
name
= forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ (Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
flag String
name DumpFormat
FormatCMM forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall env a. OutputableP env a => env -> a -> SDoc
pdoc Platform
platform)
condPass :: Bool
-> (CmmGraph -> CmmGraph)
-> CmmGraph
-> DumpFlag
-> String
-> IO CmmGraph
condPass Bool
do_opt CmmGraph -> CmmGraph
pass CmmGraph
g DumpFlag
dumpflag String
dumpname =
if Bool
do_opt
then do
CmmGraph
g <- forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ CmmGraph -> CmmGraph
pass CmmGraph
g
DumpFlag -> String -> CmmGraph -> IO ()
dump DumpFlag
dumpflag String
dumpname CmmGraph
g
forall (m :: * -> *) a. Monad m => a -> m a
return CmmGraph
g
else forall (m :: * -> *) a. Monad m => a -> m a
return CmmGraph
g
splitting_proc_points :: Bool
splitting_proc_points = CmmConfig -> Bool
cmmSplitProcPoints CmmConfig
cfg
runUniqSM :: UniqSM a -> IO a
runUniqSM :: forall a. UniqSM a -> IO a
runUniqSM UniqSM a
m = do
UniqSupply
us <- Char -> IO UniqSupply
mkSplitUniqSupply Char
'u'
forall (m :: * -> *) a. Monad m => a -> m a
return (forall a. UniqSupply -> UniqSM a -> a
initUs_ UniqSupply
us UniqSM a
m)
dumpGraph :: Logger -> Platform -> Bool -> DumpFlag -> String -> CmmGraph -> IO ()
dumpGraph :: Logger
-> Platform -> Bool -> DumpFlag -> String -> CmmGraph -> IO ()
dumpGraph Logger
logger Platform
platform Bool
do_linting DumpFlag
flag String
name CmmGraph
g = do
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when Bool
do_linting forall a b. (a -> b) -> a -> b
$ CmmGraph -> IO ()
do_lint CmmGraph
g
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
flag String
name DumpFormat
FormatCMM (forall env a. OutputableP env a => env -> a -> SDoc
pdoc Platform
platform CmmGraph
g)
where
do_lint :: CmmGraph -> IO ()
do_lint CmmGraph
g = case Platform -> CmmGraph -> Maybe SDoc
cmmLintGraph Platform
platform CmmGraph
g of
Just SDoc
err -> do { Logger -> SDoc -> IO ()
fatalErrorMsg Logger
logger SDoc
err
; Logger -> ByteOff -> IO ()
ghcExit Logger
logger ByteOff
1
}
Maybe SDoc
Nothing -> forall (m :: * -> *) a. Monad m => a -> m a
return ()
dumpWith :: Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith :: Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
dumpWith Logger
logger DumpFlag
flag String
txt DumpFormat
fmt SDoc
sdoc = do
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
putDumpFileMaybe Logger
logger DumpFlag
flag String
txt DumpFormat
fmt SDoc
sdoc
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Bool -> Bool
not (Logger -> DumpFlag -> Bool
logHasDumpFlag Logger
logger DumpFlag
flag)) forall a b. (a -> b) -> a -> b
$
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Logger -> DumpFlag -> Bool
logHasDumpFlag Logger
logger DumpFlag
Opt_D_dump_cmm_verbose)
forall a b. (a -> b) -> a -> b
$ Logger
-> PprStyle -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
logDumpFile Logger
logger (PrintUnqualified -> PprStyle
mkDumpStyle PrintUnqualified
alwaysQualify) DumpFlag
flag String
txt DumpFormat
fmt SDoc
sdoc
Logger -> DumpFlag -> String -> DumpFormat -> SDoc -> IO ()
putDumpFileMaybe Logger
logger DumpFlag
Opt_D_dump_cmm_verbose_by_proc String
txt DumpFormat
fmt SDoc
sdoc