[project @ 2003-07-02 14:59:00 by simonpj]
[ghc-hetmet.git] / ghc / compiler / simplCore / SimplCore.lhs
index d6e7146..be781e6 100644 (file)
@@ -4,44 +4,56 @@
 \section[SimplCore]{Driver for simplifying @Core@ programs}
 
 \begin{code}
-module SimplCore ( core2core ) where
+module SimplCore ( core2core, simplifyExpr ) where
 
 #include "HsVersions.h"
 
-import CmdLineOpts     ( CoreToDo(..), SimplifierSwitch(..), 
-                         SwitchResult(..), intSwitchSet,
-                          opt_UsageSPOn,
-                         DynFlags, DynFlag(..), dopt
+import CmdLineOpts     ( CoreToDo(..), SimplifierSwitch(..),
+                         SimplifierMode(..), DynFlags, DynFlag(..), dopt,
+                         dopt_CoreToDo
                        )
-import CoreLint                ( beginPass, endPass )
 import CoreSyn
+import CoreFVs         ( ruleRhsFreeVars )
+import HscTypes                ( HscEnv(..), GhciMode(..),
+                         ModGuts(..), ModGuts, Avails, availsToNameSet, 
+                         PackageRuleBase, HomePackageTable, ModDetails(..),
+                         HomeModInfo(..)
+                       )
 import CSE             ( cseProgram )
-import Rules           ( RuleBase, ProtoCoreRule(..), pprProtoCoreRule, prepareLocalRuleBase,
-                          prepareOrphanRuleBase, unionRuleBase, localRule )
-import CoreUnfold
-import PprCore         ( pprCoreBindings )
-import OccurAnal       ( occurAnalyseBinds )
-import CoreUtils       ( exprIsTrivial, etaReduceExpr, coreBindsSize )
+import Rules           ( RuleBase, emptyRuleBase, ruleBaseFVs, ruleBaseIds, 
+                         extendRuleBaseList, addRuleBaseFVs, pprRuleBase, 
+                         ruleCheckProgram )
+import Module          ( moduleEnvElts )
+import Name            ( Name, isExternalName )
+import NameSet         ( elemNameSet )
+import PprCore         ( pprCoreBindings, pprCoreExpr )
+import OccurAnal       ( occurAnalyseBinds, occurAnalyseGlobalExpr )
+import CoreUtils       ( coreBindsSize )
 import Simplify                ( simplTopBinds, simplExpr )
 import SimplUtils      ( simplBinders )
 import SimplMonad
-import ErrUtils                ( dumpIfSet, dumpIfSet_dyn )
+import ErrUtils                ( dumpIfSet, dumpIfSet_dyn, showPass )
+import CoreLint                ( endPass )
 import FloatIn         ( floatInwards )
 import FloatOut                ( floatOutwards )
-import Id              ( isDataConWrapId )
+import Id              ( idName, setIdLocalExported )
 import VarSet
 import LiberateCase    ( liberateCase )
 import SAT             ( doStaticArgs )
 import Specialise      ( specProgram)
-import UsageSPInf       ( doUsageSPInf )
-import StrictAnal      ( saBinds )
+import SpecConstr      ( specConstrProgram)
+import DmdAnal         ( dmdAnalPgm )
 import WorkWrap                ( wwTopBinds )
+#ifdef OLD_STRICTNESS
+import StrictAnal      ( saBinds )
 import CprAnalyse       ( cprAnalyse )
+#endif
 
 import UniqSupply      ( UniqSupply, mkSplitUniqSupply, splitUniqSupply )
 import IO              ( hPutStr, stderr )
 import Outputable
 
+import Maybes          ( orElse )
 import List             ( partition )
 \end{code}
 
@@ -52,28 +64,35 @@ import List             ( partition )
 %************************************************************************
 
 \begin{code}
-core2core :: DynFlags 
-         -> [CoreToDo]         -- Spec of what core-to-core passes to do
-         -> [CoreBind]         -- Binds in
-         -> [ProtoCoreRule]    -- Rules in
-         -> IO ([CoreBind], RuleBase)  -- binds, local orphan rules out
-
-core2core dflags core_todos binds rules
+core2core :: HscEnv
+         -> PackageRuleBase
+         -> ModGuts
+         -> IO ModGuts
+
+core2core hsc_env pkg_rule_base
+         mod_impl@(ModGuts { mg_exports = exports, 
+                             mg_binds = binds_in, 
+                             mg_rules = rules_in })
   = do
+        let dflags       = hsc_dflags hsc_env
+           hpt           = hsc_HPT hsc_env
+           ghci_mode     = hsc_mode hsc_env
+           core_todos    = dopt_CoreToDo dflags
+
        us <-  mkSplitUniqSupply 's'
        let (cp_us, ru_us) = splitUniqSupply us
 
-        let (local_rules, imported_rules) = partition localRule rules
+               -- COMPUTE THE RULE BASE TO USE
+       (rule_base, local_rule_ids, orphan_rules, rule_rhs_fvs)
+               <- prepareRules dflags pkg_rule_base hpt ru_us binds_in rules_in
 
-        better_local_rules <- simplRules dflags ru_us local_rules binds
+               -- PREPARE THE BINDINGS
+       let binds1 = updateBinders ghci_mode local_rule_ids 
+                                  rule_rhs_fvs exports binds_in
 
-        let (binds1, local_rule_base) = prepareLocalRuleBase binds better_local_rules
-            imported_rule_base        = prepareOrphanRuleBase imported_rules
-
-       -- Do the main business
-       (stats, processed_binds, processed_local_rules)
-            <- doCorePasses dflags (zeroSimplCount dflags) cp_us binds1 local_rule_base
-                           imported_rule_base Nothing core_todos
+               -- DO THE BUSINESS
+       (stats, processed_binds)
+               <- doCorePasses dflags rule_base (zeroSimplCount dflags) cp_us binds1 core_todos
 
        dumpIfSet_dyn dflags Opt_D_dump_simpl_stats
                  "Grand total simplifier statistics"
@@ -81,69 +100,101 @@ core2core dflags core_todos binds rules
 
        -- Return results
         -- We only return local orphan rules, i.e., local rules not attached to an Id
-       return (processed_binds, processed_local_rules)
+       -- The bindings cotain more rules, embedded in the Ids
+       return (mod_impl { mg_binds = processed_binds, mg_rules = orphan_rules})
+
+
+simplifyExpr :: DynFlags -- includes spec of what core-to-core passes to do
+            -> CoreExpr
+            -> IO CoreExpr
+-- simplifyExpr is called by the driver to simplify an
+-- expression typed in at the interactive prompt
+simplifyExpr dflags expr
+  = do {
+       ; showPass dflags "Simplify"
+
+       ; us <-  mkSplitUniqSupply 's'
+
+       ; let env              = emptySimplEnv SimplGently [] emptyVarSet
+             (expr', _counts) = initSmpl dflags us (simplExprGently env expr)
+
+       ; dumpIfSet_dyn dflags Opt_D_dump_simpl "Simplified expression"
+                       (pprCoreExpr expr')
+
+       ; return expr'
+       }
 
 
 doCorePasses :: DynFlags
+             -> RuleBase        -- the main rule base
             -> SimplCount      -- simplifier stats
              -> UniqSupply      -- uniques
              -> [CoreBind]      -- local binds in (with rules attached)
-             -> RuleBase        -- local orphan rules
-             -> RuleBase        -- imported and builtin rules
-             -> Maybe RuleBase  -- combined rulebase, or Nothing to ask for it to be rebuilt
              -> [CoreToDo]      -- which passes to do
-             -> IO (SimplCount, [CoreBind], RuleBase)  -- stats, binds, local orphan rules
+             -> IO (SimplCount, [CoreBind])  -- stats, binds, local orphan rules
 
-doCorePasses dflags stats us binds lrb irb rb0 []
-  = return (stats, binds, lrb)
+doCorePasses dflags rb stats us binds []
+  = return (stats, binds)
 
-doCorePasses dflags stats us binds lrb irb rb0 (to_do : to_dos) 
+doCorePasses dflags rb stats us binds (to_do : to_dos) 
   = do
        let (us1, us2) = splitUniqSupply us
 
-        -- recompute rulebase if necessary
-        let rb         = maybe (irb `unionRuleBase` lrb) id rb0
-
-       (stats1, binds1, mlrb1) <- doCorePass dflags us1 binds lrb rb to_do
+       (stats1, binds1) <- doCorePass dflags rb us1 binds to_do
 
-        -- request rulebase recomputation if pass returned a new local rulebase
-        let (lrb1,rb1) = maybe (lrb, Just rb) (\ lrb1 -> (lrb1, Nothing)) mlrb1
+       doCorePasses dflags rb (stats `plusSimplCount` stats1) us2 binds1 to_dos
 
-       doCorePasses dflags (stats `plusSimplCount` stats1) us2 binds1 lrb1 irb rb1 to_dos
-
-doCorePass dfs us binds lrb rb (CoreDoSimplify sw_chkr) 
-   = _scc_ "Simplify"      simplifyPgm dfs rb sw_chkr us binds
-doCorePass dfs us binds lrb rb CoreCSE                 
+doCorePass dfs rb us binds (CoreDoSimplify mode switches) 
+   = _scc_ "Simplify"      simplifyPgm dfs rb mode switches us binds
+doCorePass dfs rb us binds CoreCSE                     
    = _scc_ "CommonSubExpr" noStats dfs (cseProgram dfs binds)
-doCorePass dfs us binds lrb rb CoreLiberateCase                
+doCorePass dfs rb us binds CoreLiberateCase            
    = _scc_ "LiberateCase"  noStats dfs (liberateCase dfs binds)
-doCorePass dfs us binds lrb rb CoreDoFloatInwards       
+doCorePass dfs rb us binds CoreDoFloatInwards       
    = _scc_ "FloatInwards"  noStats dfs (floatInwards dfs binds)
-doCorePass dfs us binds lrb rb (CoreDoFloatOutwards f)  
+doCorePass dfs rb us binds (CoreDoFloatOutwards f)  
    = _scc_ "FloatOutwards" noStats dfs (floatOutwards dfs f us binds)
-doCorePass dfs us binds lrb rb CoreDoStaticArgs                
+doCorePass dfs rb us binds CoreDoStaticArgs            
    = _scc_ "StaticArgs"    noStats dfs (doStaticArgs us binds)
-doCorePass dfs us binds lrb rb CoreDoStrictness                
-   = _scc_ "Stranal"       noStats dfs (saBinds dfs binds)
-doCorePass dfs us binds lrb rb CoreDoWorkerWrapper      
+doCorePass dfs rb us binds CoreDoStrictness            
+   = _scc_ "Stranal"       noStats dfs (dmdAnalPgm dfs binds)
+doCorePass dfs rb us binds CoreDoWorkerWrapper      
    = _scc_ "WorkWrap"      noStats dfs (wwTopBinds dfs us binds)
-doCorePass dfs us binds lrb rb CoreDoSpecialising       
+doCorePass dfs rb us binds CoreDoSpecialising       
    = _scc_ "Specialise"    noStats dfs (specProgram dfs us binds)
-doCorePass dfs us binds lrb rb CoreDoCPResult          
-   = _scc_ "CPResult"      noStats dfs (cprAnalyse dfs binds)
-doCorePass dfs us binds lrb rb CoreDoPrintCore         
+doCorePass dfs rb us binds CoreDoSpecConstr
+   = _scc_ "SpecConstr"    noStats dfs (specConstrProgram dfs us binds)
+#ifdef OLD_STRICTNESS
+doCorePass dfs rb us binds CoreDoOldStrictness
+   = _scc_ "OldStrictness"      noStats dfs (doOldStrictness dfs binds)
+#endif
+doCorePass dfs rb us binds CoreDoPrintCore             
    = _scc_ "PrintCore"     noStats dfs (printCore binds)
-doCorePass dfs us binds lrb rb CoreDoUSPInf             
-   = _scc_ "CoreUsageSPInf" noStats dfs (doUsageSPInf dfs us binds lrb)
-doCorePass dfs us binds lrb rb CoreDoGlomBinds         
+doCorePass dfs rb us binds CoreDoGlomBinds             
    = noStats dfs (glomBinds dfs binds)
+doCorePass dfs rb us binds (CoreDoRuleCheck phase pat)
+   = noStats dfs (ruleCheck dfs phase pat binds)
+doCorePass dfs rb us binds CoreDoNothing
+   = noStats dfs (return binds)
+
+#ifdef OLD_STRICTNESS
+doOldStrictness dfs binds 
+  = do binds1 <- saBinds dfs binds
+       binds2 <- cprAnalyse dfs binds1
+       return binds2
+#endif
 
 printCore binds = do dumpIfSet True "Print Core"
                               (pprCoreBindings binds)
                     return binds
 
+ruleCheck dflags phase pat binds = do showPass dflags "RuleCheck"
+                                     printDump (ruleCheckProgram phase pat binds)
+                                     return binds
+
 -- most passes return no stats and don't change rules
-noStats dfs thing = do { binds <- thing; return (zeroSimplCount dfs, binds, Nothing) }
+noStats dfs thing = do { binds <- thing; return (zeroSimplCount dfs, binds) }
+
 \end{code}
 
 
@@ -154,61 +205,175 @@ noStats dfs thing = do { binds <- thing; return (zeroSimplCount dfs, binds, Noth
 %*                                                                     *
 %************************************************************************
 
-We must do some gentle simplification on the template (but not the RHS)
-of each rule.  The case that forced me to add this was the fold/build rule,
-which without simplification looked like:
-       fold k z (build (/\a. g a))  ==>  ...
-This doesn't match unless you do eta reduction on the build argument.
+-- prepareLocalRuleBase takes the CoreBinds and rules defined in this module.
+-- It attaches those rules that are for local Ids to their binders, and
+-- returns the remainder attached to Ids in an IdSet.  It also returns
+-- Ids mentioned on LHS of some rule; these should be blacklisted.
+
+-- The rule Ids and LHS Ids are black-listed; that is, they aren't inlined
+-- so that the opportunity to apply the rule isn't lost too soon
 
 \begin{code}
-simplRules :: DynFlags -> UniqSupply -> [ProtoCoreRule] -> [CoreBind] 
-          -> IO [ProtoCoreRule]
-simplRules dflags us rules binds
-  = do  let (better_rules,_) 
-               = initSmpl dflags sw_chkr us bind_vars black_list_all 
-                          (mapSmpl simplRule rules)
-       
-       dumpIfSet_dyn dflags Opt_D_dump_rules
-                 "Transformation rules"
-                 (vcat (map pprProtoCoreRule better_rules))
-
-       return better_rules
+prepareRules :: DynFlags -> PackageRuleBase -> HomePackageTable
+            -> UniqSupply
+            -> [CoreBind]
+            -> [IdCoreRule]            -- Local rules
+            -> IO (RuleBase,           -- Full rule base
+                   IdSet,              -- Local rule Ids
+                   [IdCoreRule],       -- Orphan rules
+                   IdSet)              -- RHS free vars of all rules
+
+prepareRules dflags pkg_rule_base hpt us binds local_rules
+  = do { let env              = emptySimplEnv SimplGently [] local_ids 
+             (better_rules,_) = initSmpl dflags us (mapSmpl (simplRule env) local_rules)
+
+       ; let (local_rules, orphan_rules) = partition ((`elemVarSet` local_ids) . fst) better_rules
+               -- We use (`elemVarSet` local_ids) rather than isLocalId because
+               -- isLocalId isn't true of class methods.
+               -- If we miss any rules for Ids defined here, then we end up
+               -- giving the local decl a new Unique (because the in-scope-set is the
+               -- same as the rule-id set), and now the binding for the class method 
+               -- doesn't have the same Unique as the one in the Class and the tc-env
+               --      Example:        class Foo a where
+               --                        op :: a -> a
+               --                      {-# RULES "op" op x = x #-}
+
+             rule_rhs_fvs                = unionVarSets (map (ruleRhsFreeVars . snd) better_rules)
+             local_rule_base             = extendRuleBaseList emptyRuleBase local_rules
+             local_rule_ids              = ruleBaseIds local_rule_base -- Local Ids with rules attached
+             imp_rule_base               = foldl add_rules pkg_rule_base (moduleEnvElts hpt)
+             rule_base                   = extendRuleBaseList imp_rule_base orphan_rules
+             final_rule_base             = addRuleBaseFVs rule_base (ruleBaseFVs local_rule_base)
+               -- The last step black-lists the free vars of local rules too
+
+       ; dumpIfSet_dyn dflags Opt_D_dump_rules "Transformation rules"
+               (vcat [text "Local rules", pprRuleBase local_rule_base,
+                      text "",
+                      text "Imported rules", pprRuleBase final_rule_base])
+
+       ; return (final_rule_base, local_rule_ids, orphan_rules, rule_rhs_fvs)
+    }
   where
-    black_list_all v = not (isDataConWrapId v)
-               -- This stops all inlining except the
-               -- wrappers for data constructors
-
-    sw_chkr any = SwBool False                 -- A bit bogus
+    add_rules rule_base mod_info = extendRuleBaseList rule_base (md_rules (hm_details mod_info))
 
        -- Boringly, we need to gather the in-scope set.
-       -- Typically this thunk won't even be force, but the test in
-       -- simpVar fails if it isn't right, and it might conceivably matter
-    bind_vars = foldr (unionVarSet . mkVarSet . bindersOf) emptyVarSet binds
+    local_ids = foldr (unionVarSet . mkVarSet . bindersOf) emptyVarSet binds
+
 
+updateBinders :: GhciMode
+             -> IdSet                  -- Locally defined ids with their Rules attached
+             -> IdSet                  -- Ids free in the RHS of local rules
+             -> Avails                 -- What is exported
+             -> [CoreBind] -> [CoreBind]
+       -- A horrible function
 
-simplRule rule@(ProtoCoreRule is_local id (BuiltinRule _))
+-- Update the binders of top-level bindings as follows
+--     a) Attach the rules for each locally-defined Id to that Id.
+--     b) Set the no-discard flag if either the Id is exported,
+--        or it's mentioned in the RHS of a rule
+--
+-- You might wonder why exported Ids aren't already marked as such;
+-- it's just because the type checker is rather busy already and
+-- I didn't want to pass in yet another mapping.
+-- 
+-- Reason for (a)
+--     - It makes the rules easier to look up
+--     - It means that transformation rules and specialisations for
+--       locally defined Ids are handled uniformly
+--     - It keeps alive things that are referred to only from a rule
+--       (the occurrence analyser knows about rules attached to Ids)
+--     - It makes sure that, when we apply a rule, the free vars
+--       of the RHS are more likely to be in scope
+--
+-- Reason for (b)
+--     It means that the binding won't be discarded EVEN if the binding
+--     ends up being trivial (v = w) -- the simplifier would usually just 
+--     substitute w for v throughout, but we don't apply the substitution to
+--     the rules (maybe we should?), so this substitution would make the rule
+--     bogus.
+
+updateBinders ghci_mode rule_ids rule_rhs_fvs exports binds
+  = map update_bndrs binds
+  where
+    update_bndrs (NonRec b r) = NonRec (update_bndr b) r
+    update_bndrs (Rec prs)    = Rec [(update_bndr b, r) | (b,r) <- prs]
+
+    update_bndr bndr 
+       | dont_discard bndr = setIdLocalExported bndr_with_rules
+       | otherwise         = bndr_with_rules
+       where
+         bndr_with_rules = lookupVarSet rule_ids bndr `orElse` bndr
+
+    dont_discard bndr =  is_exported (idName bndr)
+                     || bndr `elemVarSet` rule_rhs_fvs 
+
+       -- In interactive mode, we don't want to discard any top-level
+       -- entities at all (eg. do not inline them away during
+       -- simplification), and retain them all in the TypeEnv so they are
+       -- available from the command line.
+       --
+       -- isExternalName separates the user-defined top-level names from those
+       -- introduced by the type checker.
+    is_exported :: Name -> Bool
+    is_exported | ghci_mode == Interactive = isExternalName
+               | otherwise                = (`elemNameSet` export_fvs)
+
+    export_fvs = availsToNameSet exports
+\end{code}
+
+
+We must do some gentle simplification on the template (but not the RHS)
+of each rule.  The case that forced me to add this was the fold/build rule,
+which without simplification looked like:
+       fold k z (build (/\a. g a))  ==>  ...
+This doesn't match unless you do eta reduction on the build argument.
+
+\begin{code}
+simplRule env rule@(id, BuiltinRule _ _)
   = returnSmpl rule
-simplRule rule@(ProtoCoreRule is_local id (Rule name bndrs args rhs))
-  | not is_local
-  = returnSmpl rule    -- No need to fiddle with imported rules
-  | otherwise
-  = simplBinders bndrs                 $ \ bndrs' -> 
-    mapSmpl simpl_arg args             `thenSmpl` \ args' ->
-    simplExpr rhs                      `thenSmpl` \ rhs' ->
-    returnSmpl (ProtoCoreRule is_local id (Rule name bndrs' args' rhs'))
-
-simpl_arg e 
---  I've seen rules in which a LHS like 
+simplRule env rule@(id, Rule act name bndrs args rhs)
+  = simplBinders env bndrs             `thenSmpl` \ (env, bndrs') -> 
+    mapSmpl (simplExprGently env) args `thenSmpl` \ args' ->
+    simplExprGently env rhs            `thenSmpl` \ rhs' ->
+    returnSmpl (id, Rule act name bndrs' args' rhs')
+
+-- It's important that simplExprGently does eta reduction.
+-- For example, in a rule like:
 --     augment g (build h) 
--- turns into
+-- we do not want to get
 --     augment (\a. g a) (build h)
--- So it's a help to eta-reduce the args as we simplify them.
--- Otherwise we don't match when given an argument like
+-- otherwise we don't match when given an argument like
 --     (\a. h a a)
-  = simplExpr e        `thenSmpl` \ e' ->
-    returnSmpl (etaReduceExpr e')
+--
+-- The simplifier does indeed do eta reduction (it's in
+-- Simplify.completeLam) but only if -O is on.
+\end{code}
+
+\begin{code}
+simplExprGently :: SimplEnv -> CoreExpr -> SimplM CoreExpr
+-- Simplifies an expression 
+--     does occurrence analysis, then simplification
+--     and repeats (twice currently) because one pass
+--     alone leaves tons of crud.
+-- Used (a) for user expressions typed in at the interactive prompt
+--     (b) the LHS and RHS of a RULE
+--
+-- The name 'Gently' suggests that the SimplifierMode is SimplGently,
+-- and in fact that is so.... but the 'Gently' in simplExprGently doesn't
+-- enforce that; it just simplifies the expression twice
+
+simplExprGently env expr
+  = simplExpr env (occurAnalyseGlobalExpr expr)        `thenSmpl` \ expr1 ->
+    simplExpr env (occurAnalyseGlobalExpr expr1)
 \end{code}
 
+
+%************************************************************************
+%*                                                                     *
+\subsection{Glomming}
+%*                                                                     *
+%************************************************************************
+
 \begin{code}
 glomBinds :: DynFlags -> [CoreBind] -> IO [CoreBind]
 -- Glom all binds together in one Rec, in case any
@@ -237,13 +402,14 @@ glomBinds :: DynFlags -> [CoreBind] -> IO [CoreBind]
 -- analyser as free in f.
 
 glomBinds dflags binds
-  = do { beginPass dflags "GlomBinds" ;
+  = do { showPass dflags "GlomBinds" ;
         let { recd_binds = [Rec (flattenBinds binds)] } ;
         return recd_binds }
        -- Not much point in printing the result... 
        -- just consumes output bandwidth
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
 \subsection{The driver for the simplifier}
@@ -253,15 +419,16 @@ glomBinds dflags binds
 \begin{code}
 simplifyPgm :: DynFlags 
            -> RuleBase
-           -> (SimplifierSwitch -> SwitchResult)
+           -> SimplifierMode
+           -> [SimplifierSwitch]
            -> UniqSupply
-           -> [CoreBind]                                   -- Input
-           -> IO (SimplCount, [CoreBind], Maybe RuleBase)  -- New bindings
+           -> [CoreBind]                   -- Input
+           -> IO (SimplCount, [CoreBind])  -- New bindings
 
-simplifyPgm dflags (imported_rule_ids, rule_lhs_fvs) 
-           sw_chkr us binds
+simplifyPgm dflags rule_base
+           mode switches us binds
   = do {
-       beginPass dflags "Simplify";
+       showPass dflags "Simplify";
 
        (termination_msg, it_count, counts_out, binds') 
           <- iteration us 1 (zeroSimplCount dflags) binds;
@@ -273,18 +440,38 @@ simplifyPgm dflags (imported_rule_ids, rule_lhs_fvs)
                         text "",
                         pprSimplCount counts_out]);
 
-       endPass dflags "Simplify" 
-               (dopt Opt_D_verbose_core2core dflags 
-                 && not (dopt Opt_D_dump_simpl_iterations dflags))
-               binds' ;
+       endPass dflags "Simplify" Opt_D_verbose_core2core binds';
 
-       return (counts_out, binds', Nothing)
+       return (counts_out, binds')
     }
   where
-    max_iterations = getSimplIntSwitch sw_chkr MaxSimplifierIterations
-    black_list_fn  = blackListed rule_lhs_fvs (intSwitchSet sw_chkr SimplInlinePhase)
-
+    phase_info       = case mode of
+                         SimplGently  -> "gentle"
+                         SimplPhase n -> show n
+
+    imported_rule_ids = ruleBaseIds rule_base
+    simpl_env        = emptySimplEnv mode switches imported_rule_ids
+    sw_chkr          = getSwitchChecker simpl_env
+    max_iterations    = intSwitchSet sw_chkr MaxSimplifierIterations `orElse` 2
     iteration us iteration_no counts binds
+       -- iteration_no is the number of the iteration we are
+       -- about to begin, with '1' for the first
+      | iteration_no > max_iterations  -- Stop if we've run out of iterations
+      = do {
+#ifdef DEBUG
+           if  max_iterations > 2 then
+               hPutStr stderr ("NOTE: Simplifier still going after " ++ 
+                               show max_iterations ++ 
+                               " iterations; bailing out.\n")
+           else 
+               return ();
+#endif
+               -- Subtract 1 from iteration_no to get the
+               -- number of iterations we actually completed
+           return ("Simplifier baled out", iteration_no - 1, counts, binds)
+       }
+
       -- Try and force thunks off the binds; significantly reduces
       -- space usage, especially with -O.  JRS, 000620.
       | let sz = coreBindsSize binds in sz == sz
@@ -303,18 +490,21 @@ simplifyPgm dflags (imported_rule_ids, rule_lhs_fvs)
                --      t = initSmpl ...
                --      counts' = snd t
                --   in
-               --      case t of {(_,counts') -> if counts'=0 then ...
+               --      case t of {(_,counts') -> if counts'=0 then ... }
                -- So the conditional didn't force counts', because the
                -- selection got duplicated.  Sigh!
-          case initSmpl dflags sw_chkr us1 imported_rule_ids black_list_fn 
-                        (simplTopBinds tagged_binds)
-               of { (binds', counts') -> do {
+          case initSmpl dflags us1 (simplTopBinds simpl_env tagged_binds) of {
+               (binds', counts') -> do {
                        -- The imported_rule_ids are used by initSmpl to initialise
                        -- the in-scope set.  That way, the simplifier will change any
                        -- occurrences of the imported id to the one in the imported_rule_ids
                        -- set, which are decorated with their rules.
 
-          let { all_counts = counts `plusSimplCount` counts' } ;
+          let { all_counts = counts `plusSimplCount` counts' ;
+                herald     = "Simplifier phase " ++ phase_info ++ 
+                             ", iteration " ++ show iteration_no ++
+                             " out of " ++ show max_iterations
+               } ;
 
                -- Stop if nothing happened; don't dump output
           if isZeroSimplCount counts' then
@@ -322,36 +512,13 @@ simplifyPgm dflags (imported_rule_ids, rule_lhs_fvs)
           else do {
 
                -- Dump the result of this iteration
-          dumpIfSet_dyn dflags Opt_D_dump_simpl_iterations
-                    ("Simplifier iteration " ++ show iteration_no 
-                     ++ " out of " ++ show max_iterations)
-                    (pprSimplCount counts') ;
-
-          if dopt Opt_D_dump_simpl_iterations dflags then
-               endPass dflags 
-                        ("Simplifier iteration " ++ show iteration_no ++ " result")
-                       (dopt Opt_D_verbose_core2core dflags)
-                       binds'
-          else
-               return [] ;
-
-               -- Stop if we've run out of iterations
-          if iteration_no == max_iterations then
-               do {
-#ifdef DEBUG
-                   if  max_iterations > 2 then
-                           hPutStr stderr ("NOTE: Simplifier still going after " ++ 
-                                   show max_iterations ++ 
-                                   " iterations; bailing out.\n")
-                   else 
-#endif
-                       return ();
+          dumpIfSet_dyn dflags Opt_D_dump_simpl_iterations herald
+                        (pprSimplCount counts') ;
 
-                   return ("Simplifier baled out", iteration_no, all_counts, binds')
-               }
+          endPass dflags herald Opt_D_dump_simpl_iterations binds' ;
 
-               -- Else loop
-          else iteration us2 (iteration_no + 1) all_counts binds'
+               -- Loop
+          iteration us2 (iteration_no + 1) all_counts binds'
        }  } } }
       where
          (us1, us2) = splitUniqSupply us