ghc/compiler/simplStg/SimplStg.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section[SimplStg]{Driver for simplifying @STG@ programs}
   5
   6 \begin{code}
   7 module SimplStg ( stg2stg ) where
   8
   9 #include "HsVersions.h"
  10
  11 import StgSyn
  12
  13 import LambdaLift       ( liftProgram )
  14 import CostCentre       ( CostCentre, CostCentreStack )
  15 import SCCfinal         ( stgMassageForProfiling )
  16 import StgLint          ( lintStgBindings )
  17 import StgStats         ( showStgStats )
  18 import StgVarInfo       ( setStgVarInfo )
  19 import SRT              ( computeSRTs )
  20
  21 import CmdLineOpts      ( DynFlags, DynFlag(..), dopt,
  22                           opt_StgDoLetNoEscapes,
  23                           StgToDo(..), dopt_StgToDo
  24                         )
  25 import Id               ( Id )
  26 import Module           ( Module, moduleString )
  27 import ErrUtils         ( doIfSet_dyn, dumpIfSet_dyn )
  28 import UniqSupply       ( splitUniqSupply, UniqSupply )
  29 import IO               ( hPutStr, stdout )
  30 import Outputable
  31 \end{code}
  32
  33 \begin{code}
  34 stg2stg :: DynFlags             -- includes spec of what stg-to-stg passes to do
  35         -> Module               -- module name (profiling only)
  36         -> UniqSupply           -- a name supply
  37         -> [StgBinding]         -- input...
  38         -> IO
  39             ([(StgBinding,[Id])],  -- output program...
  40              ([CostCentre],        -- local cost-centres that need to be decl'd
  41               [CostCentre],        -- "extern" cost-centres
  42               [CostCentreStack]))  -- pre-defined "singleton" cost centre stacks
  43
  44 stg2stg dflags module_name us binds
  45   = case (splitUniqSupply us)   of { (us4now, us4later) ->
  46
  47     doIfSet_dyn dflags Opt_D_verbose_stg2stg (printErrs (text "VERBOSE STG-TO-STG:")) >>
  48
  49     end_pass us4now "Core2Stg" ([],[],[]) binds
  50                 >>= \ (binds', us, ccs) ->
  51
  52         -- Do the main business!
  53     foldl_mn do_stg_pass (binds', us, ccs) (dopt_StgToDo dflags)
  54                 >>= \ (processed_binds, _, cost_centres) ->
  55
  56         --      Do essential wind-up
  57
  58         -- Essential wind-up: part (b), do setStgVarInfo. It has to
  59         -- happen regardless, because the code generator uses its
  60         -- decorations.
  61         --
  62         -- Why does it have to happen last?  Because earlier passes
  63         -- may move things around, which would change the live-var
  64         -- info.  Also, setStgVarInfo decides about let-no-escape
  65         -- things, which in turn do a better job if arities are
  66         -- correct, which is done by satStgRhs.
  67         --
  68
  69     let
  70         annotated_binds = setStgVarInfo opt_StgDoLetNoEscapes processed_binds
  71         srt_binds       = computeSRTs annotated_binds
  72     in
  73
  74     dumpIfSet_dyn dflags Opt_D_dump_stg "STG syntax:"
  75               (pprStgBindingsWithSRTs srt_binds)        >>
  76
  77     return (srt_binds, cost_centres)
  78    }
  79
  80   where
  81     stg_linter = if dopt Opt_DoStgLinting dflags
  82                  then lintStgBindings
  83                  else ( \ whodunnit binds -> binds )
  84
  85     -------------------------------------------
  86     do_stg_pass (binds, us, ccs) to_do
  87       = let
  88             (us1, us2) = splitUniqSupply us
  89         in
  90         case to_do of
  91           StgDoStaticArgs ->  panic "STG static argument transformation deleted"
  92
  93           D_stg_stats ->
  94              trace (showStgStats binds)
  95              end_pass us2 "StgStats" ccs binds
  96
  97           StgDoLambdaLift ->
  98              _scc_ "StgLambdaLift"
  99                 -- NB We have to do setStgVarInfo first!
 100              let
 101                 binds3 = liftProgram module_name us1 (setStgVarInfo opt_StgDoLetNoEscapes binds)
 102              in
 103              end_pass us2 "LambdaLift" ccs binds3
 104
 105           StgDoMassageForProfiling ->
 106              _scc_ "ProfMassage"
 107              let
 108                  (collected_CCs, binds3)
 109                    = stgMassageForProfiling module_name us1 binds
 110              in
 111              end_pass us2 "ProfMassage" collected_CCs binds3
 112
 113     end_pass us2 what ccs binds2
 114       = -- report verbosely, if required
 115         (if dopt Opt_D_verbose_stg2stg dflags then
 116             hPutStr stdout (showSDoc
 117               (text ("*** "++what++":") $$ vcat (map ppr binds2)
 118             ))
 119          else return ()) >>
 120         let
 121             linted_binds = stg_linter what binds2
 122         in
 123         return (linted_binds, us2, ccs)
 124             -- return: processed binds
 125             --         UniqueSupply for the next guy to use
 126             --         cost-centres to be declared/registered (specialised)
 127             --         add to description of what's happened (reverse order)
 128
 129 -- here so it can be inlined...
 130 foldl_mn f z []     = return z
 131 foldl_mn f z (x:xs) = f z x     >>= \ zz ->
 132                      foldl_mn f zz xs
 133 \end{code}