[project @ 2005-03-07 16:46:08 by simonpj]
[ghc-hetmet.git] / ghc / compiler / simplCore / SimplCore.lhs
index 4e77ca9..8b2118a 100644 (file)
@@ -15,24 +15,30 @@ import CmdLineOpts  ( CoreToDo(..), SimplifierSwitch(..),
 import CoreSyn
 import TcIface         ( loadImportedRules )
 import HscTypes                ( HscEnv(..), ModGuts(..), ExternalPackageState(..),
-                         ModDetails(..), HomeModInfo(..), hscEPS )
+                         Dependencies( dep_mods ), 
+                         hscEPS, hptRules )
 import CSE             ( cseProgram )
 import Rules           ( RuleBase, ruleBaseIds, emptyRuleBase,
                          extendRuleBaseList, pprRuleBase, ruleCheckProgram )
-import Module          ( moduleEnvElts )
 import PprCore         ( pprCoreBindings, pprCoreExpr, pprIdRules )
-import OccurAnal       ( occurAnalyseBinds, occurAnalyseGlobalExpr )
+import OccurAnal       ( occurAnalysePgm, occurAnalyseGlobalExpr )
+import IdInfo          ( setNewStrictnessInfo, newStrictnessInfo, 
+                         setWorkerInfo, workerInfo,
+                         setSpecInfo, specInfo )
 import CoreUtils       ( coreBindsSize )
 import Simplify                ( simplTopBinds, simplExpr )
-import SimplUtils      ( simplBinders )
+import SimplEnv                ( SimplEnv, simplBinders, mkSimplEnv, setInScopeSet )
 import SimplMonad
 import ErrUtils                ( dumpIfSet, dumpIfSet_dyn, showPass )
 import CoreLint                ( endPass )
 import VarEnv          ( mkInScopeSet )
 import FloatIn         ( floatInwards )
 import FloatOut                ( floatOutwards )
-import Id              ( idIsFrom, idSpecialisation, setIdSpecialisation )
+import Id              ( Id, modifyIdInfo, idInfo, idIsFrom, isExportedId, isLocalId,
+                         idSpecialisation, setIdSpecialisation )
+import Rules           ( addRules )
 import VarSet
+import VarEnv
 import LiberateCase    ( liberateCase )
 import SAT             ( doStaticArgs )
 import Specialise      ( specProgram)
@@ -98,8 +104,8 @@ simplifyExpr dflags expr
 
        ; us <-  mkSplitUniqSupply 's'
 
-       ; let env              = emptySimplEnv SimplGently []
-             (expr', _counts) = initSmpl dflags us (simplExprGently env expr)
+       ; let (expr', _counts) = initSmpl dflags us $
+                                simplExprGently gentleSimplEnv expr
 
        ; dumpIfSet_dyn dflags Opt_D_dump_simpl "Simplified expression"
                        (pprCoreExpr expr')
@@ -107,6 +113,11 @@ simplifyExpr dflags expr
        ; return expr'
        }
 
+gentleSimplEnv :: SimplEnv
+gentleSimplEnv = mkSimplEnv SimplGently 
+                           (isAmongSimpl [])
+                           emptyRuleBase
+
 doCorePasses :: HscEnv
              -> UniqSupply      -- uniques
             -> SimplCount      -- simplifier stats
@@ -209,15 +220,16 @@ prepareRules :: HscEnv
                                        --      (b) Rules are now just orphan rules
 
 prepareRules hsc_env@(HscEnv { hsc_dflags = dflags, hsc_HPT = hpt })
-            guts@(ModGuts { mg_binds = binds, mg_rules = local_rules })
+            guts@(ModGuts { mg_binds = binds, mg_deps = deps, mg_rules = local_rules })
             us 
   = do { eps <- hscEPS hsc_env
 
        ; let   -- Simplify the local rules; boringly, we need to make an in-scope set
                -- from the local binders, to avoid warnings from Simplify.simplVar
              local_ids        = mkInScopeSet (mkVarSet (bindersOfBinds binds))
-             env              = setInScopeSet (emptySimplEnv SimplGently []) local_ids 
+             env              = setInScopeSet gentleSimplEnv local_ids 
              (better_rules,_) = initSmpl dflags us (mapSmpl (simplRule env) local_rules)
+             home_pkg_rules   = hptRules hsc_env (dep_mods deps)
 
              (orphan_rules, rules_for_locals) = partition isOrphanRule better_rules
                -- Get the rules for locally-defined Ids out of the RuleBase
@@ -234,7 +246,7 @@ prepareRules hsc_env@(HscEnv { hsc_dflags = dflags, hsc_HPT = hpt })
                --     rules for Ids in this module; if there is, the above bad things may happen
 
              pkg_rule_base = eps_rule_base eps
-             hpt_rule_base = foldl add_rules pkg_rule_base (moduleEnvElts hpt)
+             hpt_rule_base = extendRuleBaseList pkg_rule_base home_pkg_rules
              imp_rule_base = extendRuleBaseList hpt_rule_base orphan_rules
 
                -- Update the binders in the local bindings with the lcoal rules
@@ -268,8 +280,6 @@ prepareRules hsc_env@(HscEnv { hsc_dflags = dflags, hsc_HPT = hpt })
 #endif
        ; return (imp_rule_base, guts { mg_binds = binds_w_rules, mg_rules = orphan_rules })
     }
-  where
-    add_rules rule_base mod_info = extendRuleBaseList rule_base (md_rules (hm_details mod_info))
 
 updateBinders :: RuleBase -> [CoreBind] -> [CoreBind]
 updateBinders rule_base binds
@@ -413,8 +423,7 @@ simplifyPgm mode switches hsc_env us rule_base guts
                          SimplGently  -> "gentle"
                          SimplPhase n -> show n
 
-    simpl_env        = emptySimplEnv mode switches
-    sw_chkr          = getSwitchChecker simpl_env
+    sw_chkr          = isAmongSimpl switches
     max_iterations    = intSwitchSet sw_chkr MaxSimplifierIterations `orElse` 2
  
     do_iteration us rule_base iteration_no counts guts
@@ -440,7 +449,11 @@ simplifyPgm mode switches hsc_env us rule_base guts
       | let sz = coreBindsSize (mg_binds guts) in sz == sz
       = do {
                -- Occurrence analysis
-          let { tagged_binds = _scc_ "OccAnal" occurAnalyseBinds (mg_binds guts) } ;
+          let { short_inds   = _scc_ "ZapInd" shortOutIndirections (mg_binds guts) ;
+                tagged_binds = _scc_ "OccAnal" occurAnalysePgm short_inds } ;
+
+          dumpIfSet_dyn dflags Opt_D_dump_occur_anal "Short indirections"
+                    (pprCoreBindings short_inds);
 
           dumpIfSet_dyn dflags Opt_D_dump_occur_anal "Occurrence analysis"
                     (pprCoreBindings tagged_binds);
@@ -455,8 +468,7 @@ simplifyPgm mode switches hsc_env us rule_base guts
                -- miss the rules for Ids hidden inside imported inlinings
           new_rules <- loadImportedRules hsc_env guts ;
           let  { rule_base' = extendRuleBaseList rule_base new_rules
-               ; in_scope   = mkInScopeSet (ruleBaseIds rule_base')
-               ; simpl_env' = setInScopeSet simpl_env in_scope } ;
+               ; simpl_env  = mkSimplEnv mode sw_chkr rule_base' } ;
                        -- The new rule base Ids are used 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
@@ -473,7 +485,7 @@ simplifyPgm mode switches hsc_env us rule_base guts
                --      case t of {(_,counts') -> if counts'=0 then ... }
                -- So the conditional didn't force counts', because the
                -- selection got duplicated.  Sigh!
-          case initSmpl dflags us1 (simplTopBinds simpl_env' tagged_binds) of {
+          case initSmpl dflags us1 (_scc_ "SimplTopBinds" simplTopBinds simpl_env tagged_binds) of {
                (binds', counts') -> do {
 
           let  { guts'      = guts { mg_binds = binds' }
@@ -501,3 +513,196 @@ simplifyPgm mode switches hsc_env us rule_base guts
       where
          (us1, us2) = splitUniqSupply us
 \end{code}
+
+
+%************************************************************************
+%*                                                                     *
+               Top-level occurrence analysis
+       [In here, not OccurAnal, because it uses 
+        Rules.lhs, which depends on OccurAnal]
+%*                                                                     *
+%************************************************************************
+
+In @occAnalPgm@ we do indirection-shorting.  That is, if we have this:
+
+       x_local = <expression>
+       ...bindings...
+       x_exported = x_local
+
+where x_exported is exported, and x_local is not, then we replace it with this:
+
+       x_exported = <expression>
+       x_local = x_exported
+       ...bindings...
+
+Without this we never get rid of the x_exported = x_local thing.  This
+save a gratuitous jump (from \tr{x_exported} to \tr{x_local}), and
+makes strictness information propagate better.  This used to happen in
+the final phase, but it's tidier to do it here.
+
+STRICTNESS: if we have done strictness analysis, we want the strictness info on
+x_local to transfer to x_exported.  Hence the copyIdInfo call.
+
+RULES: we want to *add* any RULES for x_local to x_exported.
+
+Note [Rules and indirection-zapping]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Problem: what if x_exported has a RULE that mentions something in ...bindings...?
+Then the things mentioned can be out of scope!  Solution
+ a) Make sure that in this pass the usage-info from x_exported is 
+       available for ...bindings...
+ b) If there are any such RULES, rec-ify the entire top-level. 
+    It'll get sorted out next time round
+
+Messing up the rules
+~~~~~~~~~~~~~~~~~~~~
+The example that went bad on me at one stage was this one:
+       
+    iterate :: (a -> a) -> a -> [a]
+       [Exported]
+    iterate = iterateList      
+    
+    iterateFB c f x = x `c` iterateFB c f (f x)
+    iterateList f x =  x : iterateList f (f x)
+       [Not exported]
+    
+    {-# RULES
+    "iterate"  forall f x.     iterate f x = build (\c _n -> iterateFB c f x)
+    "iterateFB"                iterateFB (:) = iterateList
+     #-}
+
+This got shorted out to:
+
+    iterateList :: (a -> a) -> a -> [a]
+    iterateList = iterate
+    
+    iterateFB c f x = x `c` iterateFB c f (f x)
+    iterate f x =  x : iterate f (f x)
+    
+    {-# RULES
+    "iterate"  forall f x.     iterate f x = build (\c _n -> iterateFB c f x)
+    "iterateFB"                iterateFB (:) = iterate
+     #-}
+
+And now we get an infinite loop in the rule system 
+       iterate f x -> build (\cn -> iterateFB c f x)
+                   -> iterateFB (:) f x
+                   -> iterate f x
+
+Tiresome old solution: 
+       don't do shorting out if f has rewrite rules (see shortableIdInfo)
+
+New solution (I think): 
+       use rule switching-off pragmas to get rid 
+       of iterateList in the first place
+
+
+Other remarks
+~~~~~~~~~~~~~
+If more than one exported thing is equal to a local thing (i.e., the
+local thing really is shared), then we do one only:
+\begin{verbatim}
+       x_local = ....
+       x_exported1 = x_local
+       x_exported2 = x_local
+==>
+       x_exported1 = ....
+
+       x_exported2 = x_exported1
+\end{verbatim}
+
+We rely on prior eta reduction to simplify things like
+\begin{verbatim}
+       x_exported = /\ tyvars -> x_local tyvars
+==>
+       x_exported = x_local
+\end{verbatim}
+Hence,there's a possibility of leaving unchanged something like this:
+\begin{verbatim}
+       x_local = ....
+       x_exported1 = x_local Int
+\end{verbatim}
+By the time we've thrown away the types in STG land this 
+could be eliminated.  But I don't think it's very common
+and it's dangerous to do this fiddling in STG land 
+because we might elminate a binding that's mentioned in the
+unfolding for something.
+
+\begin{code}
+type IndEnv = IdEnv Id         -- Maps local_id -> exported_id
+
+shortOutIndirections :: [CoreBind] -> [CoreBind]
+shortOutIndirections binds
+  | isEmptyVarEnv ind_env = binds
+  | no_need_to_flatten   = binds'
+  | otherwise            = [Rec (flattenBinds binds')] -- See Note [Rules and indirect-zapping]
+  where
+    ind_env           = makeIndEnv binds
+    exp_ids           = varSetElems ind_env
+    exp_id_set        = mkVarSet exp_ids
+    no_need_to_flatten = all (null . rulesRules . idSpecialisation) exp_ids
+    binds'            = concatMap zap binds
+
+    zap (NonRec bndr rhs) = [NonRec b r | (b,r) <- zapPair (bndr,rhs)]
+    zap (Rec pairs)      = [Rec (concatMap zapPair pairs)]
+
+    zapPair (bndr, rhs)
+       | bndr `elemVarSet` exp_id_set             = []
+       | Just exp_id <- lookupVarEnv ind_env bndr = [(transferIdInfo exp_id bndr, rhs),
+                                                     (bndr, Var exp_id)]
+       | otherwise                                = [(bndr,rhs)]
+                            
+makeIndEnv :: [CoreBind] -> IndEnv
+makeIndEnv binds
+  = foldr add_bind emptyVarEnv binds
+  where
+    add_bind :: CoreBind -> IndEnv -> IndEnv
+    add_bind (NonRec exported_id rhs) env = add_pair (exported_id, rhs) env
+    add_bind (Rec pairs)             env = foldr add_pair env pairs
+
+    add_pair :: (Id,CoreExpr) -> IndEnv -> IndEnv
+    add_pair (exported_id, Var local_id) env
+       | shortMeOut env exported_id local_id = extendVarEnv env local_id exported_id
+    add_pair (exported_id, rhs) env
+       = env
+                       
+shortMeOut ind_env exported_id local_id
+-- The if-then-else stuff is just so I can get a pprTrace to see
+-- how often I don't get shorting out becuase of IdInfo stuff
+  = if isExportedId exported_id &&             -- Only if this is exported
+
+       isLocalId local_id &&                   -- Only if this one is defined in this
+                                               --      module, so that we *can* change its
+                                               --      binding to be the exported thing!
+
+       not (isExportedId local_id) &&          -- Only if this one is not itself exported,
+                                               --      since the transformation will nuke it
+   
+       not (local_id `elemVarEnv` ind_env)     -- Only if not already substituted for
+    then
+       True
+
+{- No longer needed
+       if isEmptyCoreRules (specInfo (idInfo exported_id))     -- Only if no rules
+       then True       -- See note on "Messing up rules"
+       else 
+#ifdef DEBUG 
+          pprTrace "shortMeOut:" (ppr exported_id)
+#endif
+                                                False
+-}
+    else
+       False
+
+
+-----------------
+transferIdInfo :: Id -> Id -> Id
+transferIdInfo exported_id local_id
+  = modifyIdInfo transfer exported_id
+  where
+    local_info = idInfo local_id
+    transfer exp_info = exp_info `setNewStrictnessInfo` newStrictnessInfo local_info
+                                `setWorkerInfo`        workerInfo local_info
+                                `setSpecInfo`          addRules exported_id (specInfo exp_info)
+                                                                (rulesRules (specInfo local_info))
+\end{code}