ghc/compiler/simplCore/SimplCore.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[SimplCore]{Driver for simplifying @Core@ programs}
   5
   6 \begin{code}
   7 module SimplCore ( core2core, simplifyExpr ) where
   8
   9 #include "HsVersions.h"
  10
  11 import CmdLineOpts      ( CoreToDo(..), SimplifierSwitch(..),
  12                           SimplifierMode(..), DynFlags, DynFlag(..), dopt,
  13                           dopt_CoreToDo, buildCoreToDo
  14                         )
  15 import CoreSyn
  16 import CoreFVs          ( ruleRhsFreeVars )
  17 import HscTypes         ( HscEnv(..), GhciMode(..),
  18                           ModGuts(..), ModGuts, Avails, availsToNameSet,
  19                           ModDetails(..),
  20                           HomeModInfo(..), ExternalPackageState(..), hscEPS
  21                         )
  22 import CSE              ( cseProgram )
  23 import Rules            ( RuleBase, emptyRuleBase, ruleBaseIds,
  24                           extendRuleBaseList, pprRuleBase,
  25                           ruleCheckProgram )
  26 import Module           ( moduleEnvElts )
  27 import Name             ( Name, isExternalName )
  28 import NameSet          ( elemNameSet )
  29 import PprCore          ( pprCoreBindings, pprCoreExpr )
  30 import OccurAnal        ( occurAnalyseBinds, occurAnalyseGlobalExpr )
  31 import CoreUtils        ( coreBindsSize )
  32 import Simplify         ( simplTopBinds, simplExpr )
  33 import SimplUtils       ( simplBinders )
  34 import SimplMonad
  35 import ErrUtils         ( dumpIfSet, dumpIfSet_dyn, showPass )
  36 import CoreLint         ( endPass )
  37 import FloatIn          ( floatInwards )
  38 import FloatOut         ( floatOutwards )
  39 import Id               ( idName, setIdLocalExported )
  40 import VarSet
  41 import LiberateCase     ( liberateCase )
  42 import SAT              ( doStaticArgs )
  43 import Specialise       ( specProgram)
  44 import SpecConstr       ( specConstrProgram)
  45 import DmdAnal          ( dmdAnalPgm )
  46 import WorkWrap         ( wwTopBinds )
  47 #ifdef OLD_STRICTNESS
  48 import StrictAnal       ( saBinds )
  49 import CprAnalyse       ( cprAnalyse )
  50 #endif
  51
  52 import UniqSupply       ( UniqSupply, mkSplitUniqSupply, splitUniqSupply )
  53 import IO               ( hPutStr, stderr )
  54 import Outputable
  55
  56 import Maybes           ( orElse )
  57 import List             ( partition )
  58 \end{code}
  59
  60 %************************************************************************
  61 %*                                                                      *
  62 \subsection{The driver for the simplifier}
  63 %*                                                                      *
  64 %************************************************************************
  65
  66 \begin{code}
  67 core2core :: HscEnv
  68           -> ModGuts
  69           -> IO ModGuts
  70
  71 core2core hsc_env
  72           mod_impl@(ModGuts { mg_exports = exports,
  73                               mg_binds = binds_in,
  74                               mg_rules = rules_in })
  75   = do
  76         let dflags        = hsc_dflags hsc_env
  77             ghci_mode     = hsc_mode hsc_env
  78             core_todos
  79                 | Just todo <- dopt_CoreToDo dflags  =  todo
  80                 | otherwise                          =  buildCoreToDo dflags
  81
  82         us <-  mkSplitUniqSupply 's'
  83         let (cp_us, ru_us) = splitUniqSupply us
  84
  85                 -- COMPUTE THE RULE BASE TO USE
  86         (rule_base, local_rule_ids, orphan_rules)
  87                 <- prepareRules hsc_env ru_us binds_in rules_in
  88
  89                 -- PREPARE THE BINDINGS
  90         let binds1 = updateBinders ghci_mode local_rule_ids
  91                                    orphan_rules exports binds_in
  92
  93                 -- DO THE BUSINESS
  94         (stats, processed_binds)
  95                 <- doCorePasses dflags rule_base (zeroSimplCount dflags) cp_us binds1 core_todos
  96
  97         dumpIfSet_dyn dflags Opt_D_dump_simpl_stats
  98                   "Grand total simplifier statistics"
  99                   (pprSimplCount stats)
 100
 101         -- Return results
 102         -- We only return local orphan rules, i.e., local rules not attached to an Id
 103         -- The bindings cotain more rules, embedded in the Ids
 104         return (mod_impl { mg_binds = processed_binds, mg_rules = orphan_rules})
 105
 106
 107 simplifyExpr :: DynFlags -- includes spec of what core-to-core passes to do
 108              -> CoreExpr
 109              -> IO CoreExpr
 110 -- simplifyExpr is called by the driver to simplify an
 111 -- expression typed in at the interactive prompt
 112 simplifyExpr dflags expr
 113   = do  {
 114         ; showPass dflags "Simplify"
 115
 116         ; us <-  mkSplitUniqSupply 's'
 117
 118         ; let env              = emptySimplEnv SimplGently [] emptyVarSet
 119               (expr', _counts) = initSmpl dflags us (simplExprGently env expr)
 120
 121         ; dumpIfSet_dyn dflags Opt_D_dump_simpl "Simplified expression"
 122                         (pprCoreExpr expr')
 123
 124         ; return expr'
 125         }
 126
 127
 128 doCorePasses :: DynFlags
 129              -> RuleBase        -- the main rule base
 130              -> SimplCount      -- simplifier stats
 131              -> UniqSupply      -- uniques
 132              -> [CoreBind]      -- local binds in (with rules attached)
 133              -> [CoreToDo]      -- which passes to do
 134              -> IO (SimplCount, [CoreBind])  -- stats, binds, local orphan rules
 135
 136 doCorePasses dflags rb stats us binds []
 137   = return (stats, binds)
 138
 139 doCorePasses dflags rb stats us binds (to_do : to_dos)
 140   = do
 141         let (us1, us2) = splitUniqSupply us
 142
 143         (stats1, binds1) <- doCorePass dflags rb us1 binds to_do
 144
 145         doCorePasses dflags rb (stats `plusSimplCount` stats1) us2 binds1 to_dos
 146
 147 doCorePass dfs rb us binds (CoreDoSimplify mode switches)
 148    = _scc_ "Simplify"      simplifyPgm dfs rb mode switches us binds
 149 doCorePass dfs rb us binds CoreCSE
 150    = _scc_ "CommonSubExpr" noStats dfs (cseProgram dfs binds)
 151 doCorePass dfs rb us binds CoreLiberateCase
 152    = _scc_ "LiberateCase"  noStats dfs (liberateCase dfs binds)
 153 doCorePass dfs rb us binds CoreDoFloatInwards
 154    = _scc_ "FloatInwards"  noStats dfs (floatInwards dfs binds)
 155 doCorePass dfs rb us binds (CoreDoFloatOutwards f)
 156    = _scc_ "FloatOutwards" noStats dfs (floatOutwards dfs f us binds)
 157 doCorePass dfs rb us binds CoreDoStaticArgs
 158    = _scc_ "StaticArgs"    noStats dfs (doStaticArgs us binds)
 159 doCorePass dfs rb us binds CoreDoStrictness
 160    = _scc_ "Stranal"       noStats dfs (dmdAnalPgm dfs binds)
 161 doCorePass dfs rb us binds CoreDoWorkerWrapper
 162    = _scc_ "WorkWrap"      noStats dfs (wwTopBinds dfs us binds)
 163 doCorePass dfs rb us binds CoreDoSpecialising
 164    = _scc_ "Specialise"    noStats dfs (specProgram dfs us binds)
 165 doCorePass dfs rb us binds CoreDoSpecConstr
 166    = _scc_ "SpecConstr"    noStats dfs (specConstrProgram dfs us binds)
 167 #ifdef OLD_STRICTNESS
 168 doCorePass dfs rb us binds CoreDoOldStrictness
 169    = _scc_ "OldStrictness"      noStats dfs (doOldStrictness dfs binds)
 170 #endif
 171 doCorePass dfs rb us binds CoreDoPrintCore
 172    = _scc_ "PrintCore"     noStats dfs (printCore binds)
 173 doCorePass dfs rb us binds CoreDoGlomBinds
 174    = noStats dfs (glomBinds dfs binds)
 175 doCorePass dfs rb us binds (CoreDoRuleCheck phase pat)
 176    = noStats dfs (ruleCheck dfs phase pat binds)
 177 doCorePass dfs rb us binds CoreDoNothing
 178    = noStats dfs (return binds)
 179
 180 #ifdef OLD_STRICTNESS
 181 doOldStrictness dfs binds
 182   = do binds1 <- saBinds dfs binds
 183        binds2 <- cprAnalyse dfs binds1
 184        return binds2
 185 #endif
 186
 187 printCore binds = do dumpIfSet True "Print Core"
 188                                (pprCoreBindings binds)
 189                      return binds
 190
 191 ruleCheck dflags phase pat binds = do showPass dflags "RuleCheck"
 192                                       printDump (ruleCheckProgram phase pat binds)
 193                                       return binds
 194
 195 -- most passes return no stats and don't change rules
 196 noStats dfs thing = do { binds <- thing; return (zeroSimplCount dfs, binds) }
 197
 198 \end{code}
 199
 200
 201
 202 %************************************************************************
 203 %*                                                                      *
 204 \subsection{Dealing with rules}
 205 %*                                                                      *
 206 %************************************************************************
 207
 208 -- prepareLocalRuleBase takes the CoreBinds and rules defined in this module.
 209 -- It attaches those rules that are for local Ids to their binders, and
 210 -- returns the remainder attached to Ids in an IdSet.  It also returns
 211 -- Ids mentioned on LHS of some rule; these should be blacklisted.
 212
 213 -- The rule Ids and LHS Ids are black-listed; that is, they aren't inlined
 214 -- so that the opportunity to apply the rule isn't lost too soon
 215
 216 \begin{code}
 217 prepareRules :: HscEnv
 218              -> UniqSupply
 219              -> [CoreBind]
 220              -> [IdCoreRule]            -- Local rules
 221              -> IO (RuleBase,           -- Full rule base
 222                     IdSet,              -- Local rule Ids
 223                     [IdCoreRule])       -- Orphan rules defined in this module
 224
 225 prepareRules hsc_env@(HscEnv { hsc_dflags = dflags, hsc_HPT = hpt })
 226              us binds local_rules
 227   = do  { eps <- hscEPS hsc_env
 228
 229         ; let env              = emptySimplEnv SimplGently [] local_ids
 230               (better_rules,_) = initSmpl dflags us (mapSmpl (simplRule env) local_rules)
 231
 232         ; let (local_rules, orphan_rules) = partition ((`elemVarSet` local_ids) . fst) better_rules
 233                 -- We use (`elemVarSet` local_ids) rather than isLocalId because
 234                 -- isLocalId isn't true of class methods.
 235                 -- If we miss any rules for Ids defined here, then we end up
 236                 -- giving the local decl a new Unique (because the in-scope-set is the
 237                 -- same as the rule-id set), and now the binding for the class method
 238                 -- doesn't have the same Unique as the one in the Class and the tc-env
 239                 --      Example:        class Foo a where
 240                 --                        op :: a -> a
 241                 --                      {-# RULES "op" op x = x #-}
 242               local_rule_base = extendRuleBaseList emptyRuleBase local_rules
 243               local_rule_ids  = ruleBaseIds local_rule_base     -- Local Ids with rules attached
 244
 245               imp_rule_base   = foldl add_rules (eps_rule_base eps) (moduleEnvElts hpt)
 246               final_rule_base = extendRuleBaseList imp_rule_base orphan_rules
 247
 248         ; dumpIfSet_dyn dflags Opt_D_dump_rules "Transformation rules"
 249                 (vcat [text "Local rules", pprRuleBase local_rule_base,
 250                        text "",
 251                        text "Imported rules", pprRuleBase final_rule_base])
 252
 253         ; return (final_rule_base, local_rule_ids, orphan_rules)
 254     }
 255   where
 256     add_rules rule_base mod_info = extendRuleBaseList rule_base (md_rules (hm_details mod_info))
 257
 258         -- Boringly, we need to gather the in-scope set.
 259     local_ids = foldr (unionVarSet . mkVarSet . bindersOf) emptyVarSet binds
 260
 261
 262 updateBinders :: GhciMode
 263               -> IdSet                  -- Locally defined ids with their Rules attached
 264               -> [IdCoreRule]           -- Orphan rules
 265               -> Avails                 -- What is exported
 266               -> [CoreBind] -> [CoreBind]
 267         -- A horrible function
 268
 269 -- Update the binders of top-level bindings as follows
 270 --      a) Attach the rules for each locally-defined Id to that Id.
 271 --      b) Set the no-discard flag if either the Id is exported,
 272 --         or it's mentioned in the RHS of a rule
 273 --
 274 -- You might wonder why exported Ids aren't already marked as such;
 275 -- it's just because the type checker is rather busy already and
 276 -- I didn't want to pass in yet another mapping.
 277 --
 278 -- Reason for (a)
 279 --      - It makes the rules easier to look up
 280 --      - It means that transformation rules and specialisations for
 281 --        locally defined Ids are handled uniformly
 282 --      - It keeps alive things that are referred to only from a rule
 283 --        (the occurrence analyser knows about rules attached to Ids)
 284 --      - It makes sure that, when we apply a rule, the free vars
 285 --        of the RHS are more likely to be in scope
 286 --
 287 -- Reason for (b)
 288 --     It means that the binding won't be discarded EVEN if the binding
 289 --     ends up being trivial (v = w) -- the simplifier would usually just
 290 --     substitute w for v throughout, but we don't apply the substitution to
 291 --     the rules (maybe we should?), so this substitution would make the rule
 292 --     bogus.
 293
 294 updateBinders ghci_mode rule_ids orphan_rules exports binds
 295   = map update_bndrs binds
 296   where
 297     update_bndrs (NonRec b r) = NonRec (update_bndr b) r
 298     update_bndrs (Rec prs)    = Rec [(update_bndr b, r) | (b,r) <- prs]
 299
 300     update_bndr bndr
 301         | dont_discard bndr = setIdLocalExported bndr_with_rules
 302         | otherwise         = bndr_with_rules
 303         where
 304           bndr_with_rules = lookupVarSet rule_ids bndr `orElse` bndr
 305
 306     orph_rhs_fvs = unionVarSets (map (ruleRhsFreeVars . snd) orphan_rules)
 307         -- An orphan rule must keep alive the free vars
 308         -- of its right-hand side.
 309         -- Non-orphan rules are attached to the Id (bndr_with_rules above)
 310         -- and that keeps the rhs free vars alive
 311
 312     dont_discard bndr =  is_exported (idName bndr)
 313                       || bndr `elemVarSet` orph_rhs_fvs
 314
 315         -- In interactive mode, we don't want to discard any top-level
 316         -- entities at all (eg. do not inline them away during
 317         -- simplification), and retain them all in the TypeEnv so they are
 318         -- available from the command line.
 319         --
 320         -- isExternalName separates the user-defined top-level names from those
 321         -- introduced by the type checker.
 322     is_exported :: Name -> Bool
 323     is_exported | ghci_mode == Interactive = isExternalName
 324                 | otherwise                = (`elemNameSet` export_fvs)
 325
 326     export_fvs = availsToNameSet exports
 327 \end{code}
 328
 329
 330 We must do some gentle simplification on the template (but not the RHS)
 331 of each rule.  The case that forced me to add this was the fold/build rule,
 332 which without simplification looked like:
 333         fold k z (build (/\a. g a))  ==>  ...
 334 This doesn't match unless you do eta reduction on the build argument.
 335
 336 \begin{code}
 337 simplRule env rule@(id, BuiltinRule _ _)
 338   = returnSmpl rule
 339 simplRule env rule@(id, Rule act name bndrs args rhs)
 340   = simplBinders env bndrs              `thenSmpl` \ (env, bndrs') ->
 341     mapSmpl (simplExprGently env) args  `thenSmpl` \ args' ->
 342     simplExprGently env rhs             `thenSmpl` \ rhs' ->
 343     returnSmpl (id, Rule act name bndrs' args' rhs')
 344
 345 -- It's important that simplExprGently does eta reduction.
 346 -- For example, in a rule like:
 347 --      augment g (build h)
 348 -- we do not want to get
 349 --      augment (\a. g a) (build h)
 350 -- otherwise we don't match when given an argument like
 351 --      (\a. h a a)
 352 --
 353 -- The simplifier does indeed do eta reduction (it's in
 354 -- Simplify.completeLam) but only if -O is on.
 355 \end{code}
 356
 357 \begin{code}
 358 simplExprGently :: SimplEnv -> CoreExpr -> SimplM CoreExpr
 359 -- Simplifies an expression
 360 --      does occurrence analysis, then simplification
 361 --      and repeats (twice currently) because one pass
 362 --      alone leaves tons of crud.
 363 -- Used (a) for user expressions typed in at the interactive prompt
 364 --      (b) the LHS and RHS of a RULE
 365 --
 366 -- The name 'Gently' suggests that the SimplifierMode is SimplGently,
 367 -- and in fact that is so.... but the 'Gently' in simplExprGently doesn't
 368 -- enforce that; it just simplifies the expression twice
 369
 370 simplExprGently env expr
 371   = simplExpr env (occurAnalyseGlobalExpr expr)         `thenSmpl` \ expr1 ->
 372     simplExpr env (occurAnalyseGlobalExpr expr1)
 373 \end{code}
 374
 375
 376 %************************************************************************
 377 %*                                                                      *
 378 \subsection{Glomming}
 379 %*                                                                      *
 380 %************************************************************************
 381
 382 \begin{code}
 383 glomBinds :: DynFlags -> [CoreBind] -> IO [CoreBind]
 384 -- Glom all binds together in one Rec, in case any
 385 -- transformations have introduced any new dependencies
 386 --
 387 -- NB: the global invariant is this:
 388 --      *** the top level bindings are never cloned, and are always unique ***
 389 --
 390 -- We sort them into dependency order, but applying transformation rules may
 391 -- make something at the top refer to something at the bottom:
 392 --      f = \x -> p (q x)
 393 --      h = \y -> 3
 394 --
 395 --      RULE:  p (q x) = h x
 396 --
 397 -- Applying this rule makes f refer to h,
 398 -- although it doesn't appear to in the source program.
 399 -- This pass lets us control where it happens.
 400 --
 401 -- NOTICE that this cannot happen for rules whose head is a locally-defined
 402 -- function.  It only happens for rules whose head is an imported function
 403 -- (p in the example above).  So, for example, the rule had been
 404 --      RULE: f (p x) = h x
 405 -- then the rule for f would be attached to f itself (in its IdInfo)
 406 -- by prepareLocalRuleBase and h would be regarded by the occurrency
 407 -- analyser as free in f.
 408
 409 glomBinds dflags binds
 410   = do { showPass dflags "GlomBinds" ;
 411          let { recd_binds = [Rec (flattenBinds binds)] } ;
 412          return recd_binds }
 413         -- Not much point in printing the result...
 414         -- just consumes output bandwidth
 415 \end{code}
 416
 417
 418 %************************************************************************
 419 %*                                                                      *
 420 \subsection{The driver for the simplifier}
 421 %*                                                                      *
 422 %************************************************************************
 423
 424 \begin{code}
 425 simplifyPgm :: DynFlags
 426             -> RuleBase
 427             -> SimplifierMode
 428             -> [SimplifierSwitch]
 429             -> UniqSupply
 430             -> [CoreBind]                   -- Input
 431             -> IO (SimplCount, [CoreBind])  -- New bindings
 432
 433 simplifyPgm dflags rule_base
 434             mode switches us binds
 435   = do {
 436         showPass dflags "Simplify";
 437
 438         (termination_msg, it_count, counts_out, binds')
 439            <- iteration us 1 (zeroSimplCount dflags) binds;
 440
 441         dumpIfSet (dopt Opt_D_verbose_core2core dflags
 442                    && dopt Opt_D_dump_simpl_stats dflags)
 443                   "Simplifier statistics"
 444                   (vcat [text termination_msg <+> text "after" <+> ppr it_count <+> text "iterations",
 445                          text "",
 446                          pprSimplCount counts_out]);
 447
 448         endPass dflags "Simplify" Opt_D_verbose_core2core binds';
 449
 450         return (counts_out, binds')
 451     }
 452   where
 453     phase_info        = case mode of
 454                           SimplGently  -> "gentle"
 455                           SimplPhase n -> show n
 456
 457     imported_rule_ids = ruleBaseIds rule_base
 458     simpl_env         = emptySimplEnv mode switches imported_rule_ids
 459     sw_chkr           = getSwitchChecker simpl_env
 460     max_iterations    = intSwitchSet sw_chkr MaxSimplifierIterations `orElse` 2
 461
 462     iteration us iteration_no counts binds
 463         -- iteration_no is the number of the iteration we are
 464         -- about to begin, with '1' for the first
 465       | iteration_no > max_iterations   -- Stop if we've run out of iterations
 466       = do {
 467 #ifdef DEBUG
 468             if  max_iterations > 2 then
 469                 hPutStr stderr ("NOTE: Simplifier still going after " ++
 470                                 show max_iterations ++
 471                                 " iterations; bailing out.\n")
 472             else
 473                 return ();
 474 #endif
 475                 -- Subtract 1 from iteration_no to get the
 476                 -- number of iterations we actually completed
 477             return ("Simplifier baled out", iteration_no - 1, counts, binds)
 478         }
 479
 480       -- Try and force thunks off the binds; significantly reduces
 481       -- space usage, especially with -O.  JRS, 000620.
 482       | let sz = coreBindsSize binds in sz == sz
 483       = do {
 484                 -- Occurrence analysis
 485            let { tagged_binds = _scc_ "OccAnal" occurAnalyseBinds binds } ;
 486
 487            dumpIfSet_dyn dflags Opt_D_dump_occur_anal "Occurrence analysis"
 488                      (pprCoreBindings tagged_binds);
 489
 490                 -- SIMPLIFY
 491                 -- We do this with a *case* not a *let* because lazy pattern
 492                 -- matching bit us with bad space leak!
 493                 -- With a let, we ended up with
 494                 --   let
 495                 --      t = initSmpl ...
 496                 --      counts' = snd t
 497                 --   in
 498                 --      case t of {(_,counts') -> if counts'=0 then ... }
 499                 -- So the conditional didn't force counts', because the
 500                 -- selection got duplicated.  Sigh!
 501            case initSmpl dflags us1 (simplTopBinds simpl_env tagged_binds) of {
 502                 (binds', counts') -> do {
 503                         -- The imported_rule_ids are used by initSmpl to initialise
 504                         -- the in-scope set.  That way, the simplifier will change any
 505                         -- occurrences of the imported id to the one in the imported_rule_ids
 506                         -- set, which are decorated with their rules.
 507
 508            let { all_counts = counts `plusSimplCount` counts' ;
 509                  herald     = "Simplifier phase " ++ phase_info ++
 510                               ", iteration " ++ show iteration_no ++
 511                               " out of " ++ show max_iterations
 512                 } ;
 513
 514                 -- Stop if nothing happened; don't dump output
 515            if isZeroSimplCount counts' then
 516                 return ("Simplifier reached fixed point", iteration_no, all_counts, binds')
 517            else do {
 518
 519                 -- Dump the result of this iteration
 520            dumpIfSet_dyn dflags Opt_D_dump_simpl_iterations herald
 521                          (pprSimplCount counts') ;
 522
 523            endPass dflags herald Opt_D_dump_simpl_iterations binds' ;
 524
 525                 -- Loop
 526            iteration us2 (iteration_no + 1) all_counts binds'
 527         }  } } }
 528       where
 529           (us1, us2) = splitUniqSupply us
 530 \end{code}