CoreSubst.lhs 38.4 KB
Newer Older
1
%
Simon Marlow's avatar
Simon Marlow committed
2
% (c) The University of Glasgow 2006
3 4
% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
%
Simon Marlow's avatar
Simon Marlow committed
5 6

Utility functions on @Core@ syntax
7 8 9

\begin{code}
module CoreSubst (
batterseapower's avatar
batterseapower committed
10
	-- * Main data types
11 12
	Subst(..), -- Implementation exported for supercompiler's Renaming.hs only
	TvSubstEnv, IdSubstEnv, InScopeSet,
13

batterseapower's avatar
batterseapower committed
14
        -- ** Substituting into expressions and related types
15
	deShadowBinds, substSpec, substRulesForImportedIds,
16
	substTy, substCo, substExpr, substExprSC, substBind, substBindSC,
17
        substUnfolding, substUnfoldingSC,
18
	substUnfoldingSource, lookupIdSubst, lookupTvSubst, lookupCvSubst, substIdOcc,
19

batterseapower's avatar
batterseapower committed
20
        -- ** Operations on substitutions
21
	emptySubst, mkEmptySubst, mkSubst, mkOpenSubst, substInScope, isEmptySubst, 
22
 	extendIdSubst, extendIdSubstList, extendTvSubst, extendTvSubstList,
23 24
        extendCvSubst, extendCvSubstList,
	extendSubst, extendSubstList, extendSubstWithVar, zapSubstEnv,
25 26 27
        addInScopeSet, extendInScope, extendInScopeList, extendInScopeIds,
        isInScope, setInScope,
        delBndr, delBndrs,
28

batterseapower's avatar
batterseapower committed
29
	-- ** Substituting and cloning binders
30
	substBndr, substBndrs, substRecBndrs,
31
	cloneBndrs, cloneIdBndr, cloneIdBndrs, cloneRecIdBndrs,
32 33

	-- ** Simple expression optimiser
34
        simpleOptPgm, simpleOptExpr, simpleOptExprWith
35 36 37 38
    ) where

#include "HsVersions.h"

Simon Marlow's avatar
Simon Marlow committed
39 40 41
import CoreSyn
import CoreFVs
import CoreUtils
42
import OccurAnal( occurAnalyseExpr, occurAnalysePgm )
43

Simon Marlow's avatar
Simon Marlow committed
44
import qualified Type
45 46 47 48
import qualified Coercion

	-- We are defining local versions
import Type     hiding ( substTy, extendTvSubst, extendTvSubstList
49
                       , isInScope, substTyVarBndr, cloneTyVarBndr )
50 51
import Coercion hiding ( substTy, substCo, extendTvSubst, substTyVarBndr, substCoVarBndr )

52
import OptCoercion ( optCoercion )
53
import PprCore     ( pprCoreBindings, pprRules )
54
import Module	   ( Module )
55 56
import VarSet
import VarEnv
Simon Marlow's avatar
Simon Marlow committed
57
import Id
58
import Name	( Name )
59
import Var
Simon Marlow's avatar
Simon Marlow committed
60 61 62 63
import IdInfo
import Unique
import UniqSupply
import Maybes
64 65
import ErrUtils
import DynFlags   ( DynFlags, DynFlag(..) )
66
import BasicTypes ( isAlwaysActive )
67 68
import Outputable
import PprCore		()		-- Instances
69
import FastString
70 71

import Data.List
72 73 74 75 76 77 78 79 80 81
\end{code}


%************************************************************************
%*									*
\subsection{Substitutions}
%*									*
%************************************************************************

\begin{code}
batterseapower's avatar
batterseapower committed
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
-- | A substitution environment, containing both 'Id' and 'TyVar' substitutions.
--
-- Some invariants apply to how you use the substitution:
--
-- 1. #in_scope_invariant# The in-scope set contains at least those 'Id's and 'TyVar's that will be in scope /after/
-- applying the substitution to a term. Precisely, the in-scope set must be a superset of the free vars of the
-- substitution range that might possibly clash with locally-bound variables in the thing being substituted in.
--
-- 2. #apply_once# You may apply the substitution only /once/
--
-- There are various ways of setting up the in-scope set such that the first of these invariants hold:
--
-- * Arrange that the in-scope set really is all the things in scope
--
-- * Arrange that it's the free vars of the range of the substitution
--
-- * Make it empty, if you know that all the free vars of the substitution are fresh, and hence can't possibly clash
99
data Subst 
Thomas Schilling's avatar
Thomas Schilling committed
100 101 102
  = Subst InScopeSet  -- Variables in in scope (both Ids and TyVars) /after/
                      -- applying the substitution
          IdSubstEnv  -- Substitution for Ids
103
          TvSubstEnv  -- Substitution from TyVars to Types
104
          CvSubstEnv  -- Substitution from CoVars to Coercions
105

batterseapower's avatar
batterseapower committed
106
	-- INVARIANT 1: See #in_scope_invariant#
107 108 109
	-- This is what lets us deal with name capture properly
	-- It's a hard invariant to check...
	--
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
110
	-- INVARIANT 2: The substitution is apply-once; see Note [Apply once] with
111
	--		Types.TvSubstEnv
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
112 113
	--
	-- INVARIANT 3: See Note [Extending the Subst]
114
\end{code}
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128

Note [Extending the Subst]
~~~~~~~~~~~~~~~~~~~~~~~~~~
For a core Subst, which binds Ids as well, we make a different choice for Ids
than we do for TyVars.  

For TyVars, see Note [Extending the TvSubst] with Type.TvSubstEnv

For Ids, we have a different invariant
	The IdSubstEnv is extended *only* when the Unique on an Id changes
	Otherwise, we just extend the InScopeSet

In consequence:

129 130 131 132 133 134
* If the TvSubstEnv and IdSubstEnv are both empty, substExpr would be a
  no-op, so substExprSC ("short cut") does nothing.

  However, substExpr still goes ahead and substitutes.  Reason: we may
  want to replace existing Ids with new ones from the in-scope set, to
  avoid space leaks.
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
135

136
* In substIdBndr, we extend the IdSubstEnv only when the unique changes
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
137

138 139 140 141 142
* If the CvSubstEnv, TvSubstEnv and IdSubstEnv are all empty,
  substExpr does nothing (Note that the above rule for substIdBndr
  maintains this property.  If the incoming envts are both empty, then
  substituting the type and IdInfo can't change anything.)

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
143 144 145 146 147 148 149
* In lookupIdSubst, we *must* look up the Id in the in-scope set, because
  it may contain non-trivial changes.  Example:
	(/\a. \x:a. ...x...) Int
  We extend the TvSubstEnv with [a |-> Int]; but x's unique does not change
  so we only extend the in-scope set.  Then we must look up in the in-scope
  set when we find the occurrence of x.

150
* The requirement to look up the Id in the in-scope set means that we
151
  must NOT take no-op short cut when the IdSubst is empty.
152 153 154 155 156
  We must still look up every Id in the in-scope set.

* (However, we don't need to do so for expressions found in the IdSubst
  itself, whose range is assumed to be correct wrt the in-scope set.)

157 158
Why do we make a different choice for the IdSubstEnv than the
TvSubstEnv and CvSubstEnv?
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
159 160 161 162 163 164 165 166 167 168

* For Ids, we change the IdInfo all the time (e.g. deleting the
  unfolding), and adding it back later, so using the TyVar convention
  would entail extending the substitution almost all the time

* The simplifier wants to look up in the in-scope set anyway, in case it 
  can see a better unfolding from an enclosing case expression

* For TyVars, only coercion variables can possibly change, and they are 
  easy to spot
169

170
\begin{code}
batterseapower's avatar
batterseapower committed
171
-- | An environment for substituting for 'Id's
172 173 174 175
type IdSubstEnv = IdEnv CoreExpr

----------------------------
isEmptySubst :: Subst -> Bool
176 177
isEmptySubst (Subst _ id_env tv_env cv_env) 
  = isEmptyVarEnv id_env && isEmptyVarEnv tv_env && isEmptyVarEnv cv_env
178 179

emptySubst :: Subst
180
emptySubst = Subst emptyInScopeSet emptyVarEnv emptyVarEnv emptyVarEnv
181 182

mkEmptySubst :: InScopeSet -> Subst
183
mkEmptySubst in_scope = Subst in_scope emptyVarEnv emptyVarEnv emptyVarEnv
184

185 186
mkSubst :: InScopeSet -> TvSubstEnv -> CvSubstEnv -> IdSubstEnv -> Subst
mkSubst in_scope tvs cvs ids = Subst in_scope ids tvs cvs
187

batterseapower's avatar
batterseapower committed
188
-- | Find the in-scope set: see "CoreSubst#in_scope_invariant"
189
substInScope :: Subst -> InScopeSet
190
substInScope (Subst in_scope _ _ _) = in_scope
191

batterseapower's avatar
batterseapower committed
192 193
-- | Remove all substitutions for 'Id's and 'Var's that might have been built up
-- while preserving the in-scope set
194
zapSubstEnv :: Subst -> Subst
195
zapSubstEnv (Subst in_scope _ _ _) = Subst in_scope emptyVarEnv emptyVarEnv emptyVarEnv
196

batterseapower's avatar
batterseapower committed
197 198
-- | Add a substitution for an 'Id' to the 'Subst': you must ensure that the in-scope set is
-- such that the "CoreSubst#in_scope_invariant" is true after extending the substitution like this
199
extendIdSubst :: Subst -> Id -> CoreExpr -> Subst
batterseapower's avatar
batterseapower committed
200
-- ToDo: add an ASSERT that fvs(subst-result) is already in the in-scope set
201
extendIdSubst (Subst in_scope ids tvs cvs) v r = Subst in_scope (extendVarEnv ids v r) tvs cvs
202

batterseapower's avatar
batterseapower committed
203
-- | Adds multiple 'Id' substitutions to the 'Subst': see also 'extendIdSubst'
204
extendIdSubstList :: Subst -> [(Id, CoreExpr)] -> Subst
205
extendIdSubstList (Subst in_scope ids tvs cvs) prs = Subst in_scope (extendVarEnvList ids prs) tvs cvs
206

batterseapower's avatar
batterseapower committed
207 208
-- | Add a substitution for a 'TyVar' to the 'Subst': you must ensure that the in-scope set is
-- such that the "CoreSubst#in_scope_invariant" is true after extending the substitution like this
209
extendTvSubst :: Subst -> TyVar -> Type -> Subst
210
extendTvSubst (Subst in_scope ids tvs cvs) v r = Subst in_scope ids (extendVarEnv tvs v r) cvs
211

batterseapower's avatar
batterseapower committed
212
-- | Adds multiple 'TyVar' substitutions to the 'Subst': see also 'extendTvSubst'
213
extendTvSubstList :: Subst -> [(TyVar,Type)] -> Subst
214
extendTvSubstList (Subst in_scope ids tvs cvs) prs = Subst in_scope ids (extendVarEnvList tvs prs) cvs
215

216
-- | Add a substitution from a 'CoVar' to a 'Coercion' to the 'Subst': you must ensure that the in-scope set is
217
-- such that the "CoreSubst#in_scope_invariant" is true after extending the substitution like this
218
extendCvSubst :: Subst -> CoVar -> Coercion -> Subst
219 220
extendCvSubst (Subst in_scope ids tvs cvs) v r = Subst in_scope ids tvs (extendVarEnv cvs v r)

221
-- | Adds multiple 'CoVar' -> 'Coercion' substitutions to the
222
-- 'Subst': see also 'extendCvSubst'
223
extendCvSubstList :: Subst -> [(CoVar,Coercion)] -> Subst
224
extendCvSubstList (Subst in_scope ids tvs cvs) prs = Subst in_scope ids tvs (extendVarEnvList cvs prs)
225

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
-- | Add a substitution appropriate to the thing being substituted
--   (whether an expression, type, or coercion). See also
--   'extendIdSubst', 'extendTvSubst', and 'extendCvSubst'.
extendSubst :: Subst -> Var -> CoreArg -> Subst
extendSubst subst var arg
  = case arg of
      Type ty     -> ASSERT( isTyVar var ) extendTvSubst subst var ty
      Coercion co -> ASSERT( isCoVar var ) extendCvSubst subst var co
      _           -> ASSERT( isId    var ) extendIdSubst subst var arg

extendSubstWithVar :: Subst -> Var -> Var -> Subst
extendSubstWithVar subst v1 v2
  | isTyVar v1 = ASSERT( isTyVar v2 ) extendTvSubst subst v1 (mkTyVarTy v2)
  | isCoVar v1 = ASSERT( isCoVar v2 ) extendCvSubst subst v1 (mkCoVarCo v2)
  | otherwise  = ASSERT( isId    v2 ) extendIdSubst subst v1 (Var v2)

-- | Add a substitution as appropriate to each of the terms being
--   substituted (whether expressions, types, or coercions). See also
--   'extendSubst'.
batterseapower's avatar
batterseapower committed
245 246 247 248 249
extendSubstList :: Subst -> [(Var,CoreArg)] -> Subst
extendSubstList subst []	      = subst
extendSubstList subst ((var,rhs):prs) = extendSubstList (extendSubst subst var rhs) prs

-- | Find the substitution for an 'Id' in the 'Subst'
250
lookupIdSubst :: SDoc -> Subst -> Id -> CoreExpr
251
lookupIdSubst doc (Subst in_scope ids _ _) v
252
  | not (isLocalId v) = Var v
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
253 254 255
  | Just e  <- lookupVarEnv ids       v = e
  | Just v' <- lookupInScope in_scope v = Var v'
	-- Vital! See Note [Extending the Subst]
Simon Peyton Jones's avatar
Simon Peyton Jones committed
256 257
  | otherwise = WARN( True, ptext (sLit "CoreSubst.lookupIdSubst") <+> doc <+> ppr v 
                            $$ ppr in_scope) 
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
258
		Var v
259

batterseapower's avatar
batterseapower committed
260
-- | Find the substitution for a 'TyVar' in the 'Subst'
261
lookupTvSubst :: Subst -> TyVar -> Type
262 263
lookupTvSubst (Subst _ _ tvs _) v = ASSERT( isTyVar v) lookupVarEnv tvs v `orElse` Type.mkTyVarTy v

264
-- | Find the coercion substitution for a 'CoVar' in the 'Subst'
265 266
lookupCvSubst :: Subst -> CoVar -> Coercion
lookupCvSubst (Subst _ _ _ cvs) v = ASSERT( isCoVar v ) lookupVarEnv cvs v `orElse` mkCoVarCo v
267

268
delBndr :: Subst -> Var -> Subst
269 270 271 272
delBndr (Subst in_scope ids tvs cvs) v
  | isCoVar v = Subst in_scope ids tvs (delVarEnv cvs v)
  | isTyVar v = Subst in_scope ids (delVarEnv tvs v) cvs
  | otherwise = Subst in_scope (delVarEnv ids v) tvs cvs
273 274

delBndrs :: Subst -> [Var] -> Subst
275 276 277
delBndrs (Subst in_scope ids tvs cvs) vs
  = Subst in_scope (delVarEnvList ids vs) (delVarEnvList tvs vs) (delVarEnvList cvs vs)
      -- Easist thing is just delete all from all!
278

279 280 281 282
-- | Simultaneously substitute for a bunch of variables
--   No left-right shadowing
--   ie the substitution for   (\x \y. e) a1 a2
--      so neither x nor y scope over a1 a2
283 284 285 286
mkOpenSubst :: InScopeSet -> [(Var,CoreArg)] -> Subst
mkOpenSubst in_scope pairs = Subst in_scope
	    	          	   (mkVarEnv [(id,e)  | (id, e) <- pairs, isId id])
			  	   (mkVarEnv [(tv,ty) | (tv, Type ty) <- pairs])
287
                                   (mkVarEnv [(v,co)  | (v, Coercion co) <- pairs])
288

289 290
------------------------------
isInScope :: Var -> Subst -> Bool
291
isInScope v (Subst in_scope _ _ _) = v `elemInScopeSet` in_scope
292

293 294 295
-- | Add the 'Var' to the in-scope set, but do not remove
-- any existing substitutions for it
addInScopeSet :: Subst -> VarSet -> Subst
296 297
addInScopeSet (Subst in_scope ids tvs cvs) vs
  = Subst (in_scope `extendInScopeSetSet` vs) ids tvs cvs
298 299 300

-- | Add the 'Var' to the in-scope set: as a side effect,
-- and remove any existing substitutions for it
301
extendInScope :: Subst -> Var -> Subst
302
extendInScope (Subst in_scope ids tvs cvs) v
303
  = Subst (in_scope `extendInScopeSet` v) 
304
	  (ids `delVarEnv` v) (tvs `delVarEnv` v) (cvs `delVarEnv` v)
305

batterseapower's avatar
batterseapower committed
306
-- | Add the 'Var's to the in-scope set: see also 'extendInScope'
307
extendInScopeList :: Subst -> [Var] -> Subst
308
extendInScopeList (Subst in_scope ids tvs cvs) vs
309
  = Subst (in_scope `extendInScopeSetList` vs) 
310
	  (ids `delVarEnvList` vs) (tvs `delVarEnvList` vs) (cvs `delVarEnvList` vs)
311

batterseapower's avatar
batterseapower committed
312
-- | Optimized version of 'extendInScopeList' that can be used if you are certain 
313
-- all the things being added are 'Id's and hence none are 'TyVar's or 'CoVar's
314
extendInScopeIds :: Subst -> [Id] -> Subst
315
extendInScopeIds (Subst in_scope ids tvs cvs) vs 
316
  = Subst (in_scope `extendInScopeSetList` vs) 
317
	  (ids `delVarEnvList` vs) tvs cvs
318 319

setInScope :: Subst -> InScopeSet -> Subst
320
setInScope (Subst _ ids tvs cvs) in_scope = Subst in_scope ids tvs cvs
321 322 323 324 325 326
\end{code}

Pretty printing, for debugging only

\begin{code}
instance Outputable Subst where
327
  ppr (Subst in_scope ids tvs cvs) 
Ian Lynagh's avatar
Ian Lynagh committed
328 329 330
	=  ptext (sLit "<InScope =") <+> braces (fsep (map ppr (varEnvElts (getInScopeVars in_scope))))
	$$ ptext (sLit " IdSubst   =") <+> ppr ids
	$$ ptext (sLit " TvSubst   =") <+> ppr tvs
331
        $$ ptext (sLit " CvSubst   =") <+> ppr cvs   
332 333 334 335 336 337 338 339 340 341 342
 	 <> char '>'
\end{code}


%************************************************************************
%*									*
	Substituting expressions
%*									*
%************************************************************************

\begin{code}
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
343 344
-- | Apply a substititon to an entire 'CoreExpr'. Rememeber, you may only 
-- apply the substitution /once/: see "CoreSubst#apply_once"
345 346 347
--
-- Do *not* attempt to short-cut in the case of an empty substitution!
-- See Note [Extending the Subst]
348 349 350 351 352 353 354 355 356 357 358
substExprSC :: SDoc -> Subst -> CoreExpr -> CoreExpr
substExprSC _doc subst orig_expr
  | isEmptySubst subst = orig_expr
  | otherwise          = -- pprTrace "enter subst-expr" (doc $$ ppr orig_expr) $
                         subst_expr subst orig_expr

substExpr :: SDoc -> Subst -> CoreExpr -> CoreExpr
substExpr _doc subst orig_expr = subst_expr subst orig_expr

subst_expr :: Subst -> CoreExpr -> CoreExpr
subst_expr subst expr
359 360
  = go expr
  where
361
    go (Var v)	       = lookupIdSubst (text "subst_expr") subst v 
362
    go (Type ty)       = Type (substTy subst ty)
363
    go (Coercion co)   = Coercion (substCo subst co)
364 365 366
    go (Lit lit)       = Lit lit
    go (App fun arg)   = App (go fun) (go arg)
    go (Note note e)   = Note (go_note note) (go e)
367
    go (Cast e co)     = Cast (go e) (substCo subst co)
368 369 370 371 372
       -- Do not optimise even identity coercions
       -- Reason: substitution applies to the LHS of RULES, and
       --         if you "optimise" an identity coercion, you may
       --         lose a binder. We optimise the LHS of rules at
       --         construction time
373

374
    go (Lam bndr body) = Lam bndr' (subst_expr subst' body)
375 376 377
		       where
			 (subst', bndr') = substBndr subst bndr

378
    go (Let bind body) = Let bind' (subst_expr subst' body)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
379 380
		       where
			 (subst', bind') = substBind subst bind
381 382 383 384 385

    go (Case scrut bndr ty alts) = Case (go scrut) bndr' (substTy subst ty) (map (go_alt subst') alts)
			         where
			  	 (subst', bndr') = substBndr subst bndr

386
    go_alt subst (con, bndrs, rhs) = (con, bndrs', subst_expr subst' rhs)
387 388 389 390
				 where
				   (subst', bndrs') = substBndrs subst bndrs

    go_note note	     = note
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
391

batterseapower's avatar
batterseapower committed
392 393
-- | Apply a substititon to an entire 'CoreBind', additionally returning an updated 'Subst'
-- that should be used by subsequent substitutons.
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
substBind, substBindSC :: Subst -> CoreBind -> (Subst, CoreBind)

substBindSC subst bind 	  -- Short-cut if the substitution is empty
  | not (isEmptySubst subst)
  = substBind subst bind
  | otherwise
  = case bind of
       NonRec bndr rhs -> (subst', NonRec bndr' rhs)
          where
      	    (subst', bndr') = substBndr subst bndr
       Rec pairs -> (subst', Rec (bndrs' `zip` rhss'))
          where
            (bndrs, rhss)    = unzip pairs
      	    (subst', bndrs') = substRecBndrs subst bndrs
      	    rhss' | isEmptySubst subst' = rhss
                  | otherwise	        = map (subst_expr subst') rhss

substBind subst (NonRec bndr rhs) = (subst', NonRec bndr' (subst_expr subst rhs))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
412 413 414
				  where
				    (subst', bndr') = substBndr subst bndr

415
substBind subst (Rec pairs) = (subst', Rec (bndrs' `zip` rhss'))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
416
			    where
417 418 419
                                (bndrs, rhss)    = unzip pairs
				(subst', bndrs') = substRecBndrs subst bndrs
				rhss' = map (subst_expr subst') rhss
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
420 421 422
\end{code}

\begin{code}
batterseapower's avatar
batterseapower committed
423 424 425 426 427 428
-- | De-shadowing the program is sometimes a useful pre-pass. It can be done simply
-- by running over the bindings with an empty substitution, becuase substitution
-- returns a result that has no-shadowing guaranteed.
--
-- (Actually, within a single /type/ there might still be shadowing, because 
-- 'substTy' is a no-op for the empty substitution, but that's probably OK.)
429 430 431
--
-- [Aug 09] This function is not used in GHC at the moment, but seems so 
--          short and simple that I'm going to leave it here
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
432 433
deShadowBinds :: [CoreBind] -> [CoreBind]
deShadowBinds binds = snd (mapAccumL substBind emptySubst binds)
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
\end{code}


%************************************************************************
%*									*
	Substituting binders
%*									*
%************************************************************************

Remember that substBndr and friends are used when doing expression
substitution only.  Their only business is substitution, so they
preserve all IdInfo (suitably substituted).  For example, we *want* to
preserve occ info in rules.

\begin{code}
batterseapower's avatar
batterseapower committed
449 450 451
-- | Substitutes a 'Var' for another one according to the 'Subst' given, returning
-- the result and an updated 'Subst' that should be used by subsequent substitutons.
-- 'IdInfo' is preserved by this process, although it is substituted into appropriately.
452 453
substBndr :: Subst -> Var -> (Subst, Var)
substBndr subst bndr
454 455 456
  | isTyVar bndr  = substTyVarBndr subst bndr
  | isCoVar bndr  = substCoVarBndr subst bndr
  | otherwise     = substIdBndr (text "var-bndr") subst subst bndr
457

batterseapower's avatar
batterseapower committed
458
-- | Applies 'substBndr' to a number of 'Var's, accumulating a new 'Subst' left-to-right
459 460 461
substBndrs :: Subst -> [Var] -> (Subst, [Var])
substBndrs subst bndrs = mapAccumL substBndr subst bndrs

batterseapower's avatar
batterseapower committed
462
-- | Substitute in a mutually recursive group of 'Id's
463 464 465 466
substRecBndrs :: Subst -> [Id] -> (Subst, [Id])
substRecBndrs subst bndrs 
  = (new_subst, new_bndrs)
  where		-- Here's the reason we need to pass rec_subst to subst_id
467
    (new_subst, new_bndrs) = mapAccumL (substIdBndr (text "rec-bndr") new_subst) subst bndrs
468 469 470 471
\end{code}


\begin{code}
472 473
substIdBndr :: SDoc 
            -> Subst		-- ^ Substitution to use for the IdInfo
batterseapower's avatar
batterseapower committed
474 475
	    -> Subst -> Id 	-- ^ Substitition and Id to transform
	    -> (Subst, Id)	-- ^ Transformed pair
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
476
				-- NB: unfolding may be zapped
477

478
substIdBndr _doc rec_subst subst@(Subst in_scope env tvs cvs) old_id
479
  = -- pprTrace "substIdBndr" (doc $$ ppr old_id $$ ppr in_scope) $
480
    (Subst (in_scope `extendInScopeSet` new_id) new_env tvs cvs, new_id)
481 482
  where
    id1 = uniqAway in_scope old_id	-- id1 is cloned if necessary
483 484 485 486
    id2 | no_type_change = id1
	| otherwise	 = setIdType id1 (substTy subst old_ty)

    old_ty = idType old_id
Simon Marlow's avatar
Simon Marlow committed
487 488
    no_type_change = isEmptyVarEnv tvs || 
                     isEmptyVarSet (Type.tyVarsOfType old_ty)
489 490 491 492

	-- new_id has the right IdInfo
	-- The lazy-set is because we're in a loop here, with 
	-- rec_subst, when dealing with a mutually-recursive group
493
    new_id = maybeModifyIdInfo mb_new_info id2
494
    mb_new_info = substIdInfo rec_subst id2 (idInfo id2)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
495
	-- NB: unfolding info may be zapped
496 497

	-- Extend the substitution if the unique has changed
498
	-- See the notes with substTyVarBndr for the delVarEnv
499 500 501
    new_env | no_change = delVarEnv env old_id
	    | otherwise = extendVarEnv env old_id (Var new_id)

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
502 503
    no_change = id1 == old_id
	-- See Note [Extending the Subst]
Thomas Schilling's avatar
Thomas Schilling committed
504
	-- it's /not/ necessary to check mb_new_info and no_type_change
505 506 507 508 509 510
\end{code}

Now a variant that unconditionally allocates a new unique.
It also unconditionally zaps the OccInfo.

\begin{code}
batterseapower's avatar
batterseapower committed
511
-- | Very similar to 'substBndr', but it always allocates a new 'Unique' for
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
512
-- each variable in its output.  It substitutes the IdInfo though.
513 514 515 516
cloneIdBndr :: Subst -> UniqSupply -> Id -> (Subst, Id)
cloneIdBndr subst us old_id
  = clone_id subst subst (old_id, uniqFromSupply us)

batterseapower's avatar
batterseapower committed
517 518
-- | Applies 'cloneIdBndr' to a number of 'Id's, accumulating a final
-- substitution from left to right
519 520 521 522
cloneIdBndrs :: Subst -> UniqSupply -> [Id] -> (Subst, [Id])
cloneIdBndrs subst us ids
  = mapAccumL (clone_id subst) subst (ids `zip` uniqsFromSupply us)

523 524 525 526 527 528 529 530 531 532
cloneBndrs :: Subst -> UniqSupply -> [Var] -> (Subst, [Var])
-- Works for all kinds of variables (typically case binders)
-- not just Ids
cloneBndrs subst us vs
  = mapAccumL clone subst (vs `zip` uniqsFromSupply us)
  where
    clone subst (v,uniq) 
      | isTyVar v = cloneTyVarBndr subst v uniq
      | otherwise = clone_id subst subst (v,uniq)  -- Works for coercion variables too

batterseapower's avatar
batterseapower committed
533
-- | Clone a mutually recursive group of 'Id's
534 535 536 537 538 539 540 541 542 543 544 545 546
cloneRecIdBndrs :: Subst -> UniqSupply -> [Id] -> (Subst, [Id])
cloneRecIdBndrs subst us ids
  = (subst', ids')
  where
    (subst', ids') = mapAccumL (clone_id subst') subst
			       (ids `zip` uniqsFromSupply us)

-- Just like substIdBndr, except that it always makes a new unique
-- It is given the unique to use
clone_id    :: Subst			-- Substitution for the IdInfo
	    -> Subst -> (Id, Unique)	-- Substitition and Id to transform
	    -> (Subst, Id)		-- Transformed pair

547 548
clone_id rec_subst subst@(Subst in_scope env tvs cvs) (old_id, uniq)
  = (Subst (in_scope `extendInScopeSet` new_id) new_env tvs cvs, new_id)
549 550 551
  where
    id1	    = setVarUnique old_id uniq
    id2     = substIdType subst id1
552
    new_id  = maybeModifyIdInfo (substIdInfo rec_subst id2 (idInfo old_id)) id2
553 554 555 556 557 558
    new_env = extendVarEnv env old_id (Var new_id)
\end{code}


%************************************************************************
%*									*
559
		Types and Coercions
560 561 562
%*									*
%************************************************************************

563 564 565
For types and coercions we just call the corresponding functions in
Type and Coercion, but we have to repackage the substitution, from a
Subst to a TvSubst.
566 567 568

\begin{code}
substTyVarBndr :: Subst -> TyVar -> (Subst, TyVar)
569
substTyVarBndr (Subst in_scope id_env tv_env cv_env) tv
570 571
  = case Type.substTyVarBndr (TvSubst in_scope tv_env) tv of
	(TvSubst in_scope' tv_env', tv') 
572 573
	   -> (Subst in_scope' id_env tv_env' cv_env, tv')

574 575 576 577 578 579
cloneTyVarBndr :: Subst -> TyVar -> Unique -> (Subst, TyVar)
cloneTyVarBndr (Subst in_scope id_env tv_env cv_env) tv uniq
  = case Type.cloneTyVarBndr (TvSubst in_scope tv_env) tv uniq of
	(TvSubst in_scope' tv_env', tv') 
	   -> (Subst in_scope' id_env tv_env' cv_env, tv')

580 581 582 583 584
substCoVarBndr :: Subst -> TyVar -> (Subst, TyVar)
substCoVarBndr (Subst in_scope id_env tv_env cv_env) cv
  = case Coercion.substCoVarBndr (CvSubst in_scope tv_env cv_env) cv of
	(CvSubst in_scope' tv_env' cv_env', cv') 
	   -> (Subst in_scope' id_env tv_env' cv_env', cv')
585

batterseapower's avatar
batterseapower committed
586
-- | See 'Type.substTy'
587
substTy :: Subst -> Type -> Type 
588 589 590
substTy subst ty = Type.substTy (getTvSubst subst) ty

getTvSubst :: Subst -> TvSubst
591 592 593 594 595 596 597 598
getTvSubst (Subst in_scope _ tenv _) = TvSubst in_scope tenv

getCvSubst :: Subst -> CvSubst
getCvSubst (Subst in_scope _ tenv cenv) = CvSubst in_scope tenv cenv

-- | See 'Coercion.substCo'
substCo :: Subst -> Coercion -> Coercion
substCo subst co = Coercion.substCo (getCvSubst subst) co
599 600 601 602 603 604 605 606 607 608 609
\end{code}


%************************************************************************
%*									*
\section{IdInfo substitution}
%*									*
%************************************************************************

\begin{code}
substIdType :: Subst -> Id -> Id
610 611
substIdType subst@(Subst _ _ tv_env cv_env) id
  | (isEmptyVarEnv tv_env && isEmptyVarEnv cv_env) || isEmptyVarSet (Type.tyVarsOfType old_ty) = id
612 613 614 615 616 617 618 619
  | otherwise	= setIdType id (substTy subst old_ty)
		-- The tyVarsOfType is cheaper than it looks
		-- because we cache the free tyvars of the type
		-- in a Note in the id's type itself
  where
    old_ty = idType id

------------------
batterseapower's avatar
batterseapower committed
620 621
-- | Substitute into some 'IdInfo' with regard to the supplied new 'Id'.
substIdInfo :: Subst -> Id -> IdInfo -> Maybe IdInfo
622
substIdInfo subst new_id info
623
  | nothing_to_do = Nothing
624
  | otherwise     = Just (info `setSpecInfo`      substSpec subst new_id old_rules
625
			       `setUnfoldingInfo` substUnfolding subst old_unf)
626 627
  where
    old_rules 	  = specInfo info
628 629
    old_unf	  = unfoldingInfo info
    nothing_to_do = isEmptySpecInfo old_rules && isClosedUnfolding old_unf
630 631 632
    

------------------
633
-- | Substitutes for the 'Id's within an unfolding
634
substUnfolding, substUnfoldingSC :: Subst -> Unfolding -> Unfolding
635 636
	-- Seq'ing on the returned Unfolding is enough to cause
	-- all the substitutions to happen completely
637 638 639 640 641

substUnfoldingSC subst unf 	 -- Short-cut version
  | isEmptySubst subst = unf
  | otherwise          = substUnfolding subst unf

642
substUnfolding subst (DFunUnfolding ar con args)
643 644
  = DFunUnfolding ar con (map subst_arg args)
  where
645
    subst_arg = substExpr (text "dfun-unf") subst
646

647
substUnfolding subst unf@(CoreUnfolding { uf_tmpl = tmpl, uf_src = src })
648
	-- Retain an InlineRule!
649
  | not (isStableSource src)  -- Zap an unstable unfolding, to save substitution work
650
  = NoUnfolding
651
  | otherwise                 -- But keep a stable one!
652
  = seqExpr new_tmpl `seq` 
653 654
    new_src `seq`
    unf { uf_tmpl = new_tmpl, uf_src = new_src }
655
  where
656
    new_tmpl = substExpr (text "subst-unf") subst tmpl
657
    new_src  = substUnfoldingSource subst src
658

659
substUnfolding _ unf = unf	-- NoUnfolding, OtherCon
660 661

-------------------
662
substUnfoldingSource :: Subst -> UnfoldingSource -> UnfoldingSource
663
substUnfoldingSource (Subst in_scope ids _ _) (InlineWrapper wkr)
664 665 666
  | Just wkr_expr <- lookupVarEnv ids wkr 
  = case wkr_expr of
      Var w1 -> InlineWrapper w1
667 668
      _other -> -- WARN( True, text "Interesting! CoreSubst.substWorker1:" <+> ppr wkr 
                --             <+> ifPprDebug (equals <+> ppr wkr_expr) )   
669
			      -- Note [Worker inlining]
670
                InlineStable  -- It's not a wrapper any more, but still inline it!
671 672

  | Just w1  <- lookupInScope in_scope wkr = InlineWrapper w1
673
  | otherwise = -- WARN( True, text "Interesting! CoreSubst.substWorker2:" <+> ppr wkr )
674 675 676 677
    	      	-- This can legitimately happen.  The worker has been inlined and
		-- dropped as dead code, because we don't treat the UnfoldingSource
		-- as an "occurrence".
                -- Note [Worker inlining]
678
      	        InlineStable
679 680

substUnfoldingSource _ src = src
681 682 683 684

------------------
substIdOcc :: Subst -> Id -> Id
-- These Ids should not be substituted to non-Ids
685
substIdOcc subst v = case lookupIdSubst (text "substIdOcc") subst v of
686 687
	   	        Var v' -> v'
			other  -> pprPanic "substIdOcc" (vcat [ppr v <+> ppr other, ppr subst])
688 689

------------------
batterseapower's avatar
batterseapower committed
690
-- | Substitutes for the 'Id's within the 'WorkerInfo' given the new function 'Id'
691
substSpec :: Subst -> Id -> SpecInfo -> SpecInfo
692 693
substSpec subst new_id (SpecInfo rules rhs_fvs)
  = seqSpecInfo new_spec `seq` new_spec
694
  where
695 696
    subst_ru_fn = const (idName new_id)
    new_spec = SpecInfo (map (substRule subst subst_ru_fn) rules)
697
                        (substVarSet subst rhs_fvs)
698 699 700 701

------------------
substRulesForImportedIds :: Subst -> [CoreRule] -> [CoreRule]
substRulesForImportedIds subst rules 
702 703 704
  = map (substRule subst not_needed) rules
  where
    not_needed name = pprPanic "substRulesForImportedIds" (ppr name)
705 706 707 708 709 710 711 712 713

------------------
substRule :: Subst -> (Name -> Name) -> CoreRule -> CoreRule

-- The subst_ru_fn argument is applied to substitute the ru_fn field
-- of the rule:
--    - Rules for *imported* Ids never change ru_fn
--    - Rules for *local* Ids are in the IdInfo for that Id,
--      and the ru_fn field is simply replaced by the new name 
714
--      of the Id
715 716
substRule _ _ rule@(BuiltinRule {}) = rule
substRule subst subst_ru_fn rule@(Rule { ru_bndrs = bndrs, ru_args = args
717 718
                                       , ru_fn = fn_name, ru_rhs = rhs
                                       , ru_local = is_local })
719
  = rule { ru_bndrs = bndrs', 
720 721 722 723
           ru_fn    = if is_local 
                        then subst_ru_fn fn_name 
                        else fn_name,
           ru_args  = map (substExpr (text "subst-rule" <+> ppr fn_name) subst') args,
724 725 726
           ru_rhs   = simpleOptExprWith subst' rhs }
           -- Do simple optimisation on RHS, in case substitution lets
           -- you improve it.  The real simplifier never gets to look at it.
727 728
  where
    (subst', bndrs') = substBndrs subst bndrs
729

730 731 732 733 734 735
------------------
substVects :: Subst -> [CoreVect] -> [CoreVect]
substVects subst = map (substVect subst)

------------------
substVect :: Subst -> CoreVect -> CoreVect
736 737
substVect _subst (Vect   v Nothing)    = Vect   v Nothing
substVect subst  (Vect   v (Just rhs)) = Vect   v (Just (simpleOptExprWith subst rhs))
738 739
substVect _subst vd@(NoVect _)         = vd
substVect _subst vd@(VectType _ _)     = vd
740

741
------------------
twanvl's avatar
twanvl committed
742
substVarSet :: Subst -> VarSet -> VarSet
743
substVarSet subst fvs
744 745 746
  = foldVarSet (unionVarSet . subst_fv subst) emptyVarSet fvs
  where
    subst_fv subst fv 
747 748
        | isId fv   = exprFreeVars (lookupIdSubst (text "substVarSet") subst fv)
        | otherwise = Type.tyVarsOfType (lookupTvSubst subst fv)
749
\end{code}
750

751 752 753 754 755 756 757 758 759 760 761 762
Note [Worker inlining]
~~~~~~~~~~~~~~~~~~~~~~
A worker can get sustituted away entirely.
	- it might be trivial
	- it might simply be very small
We do not treat an InlWrapper as an 'occurrence' in the occurence 
analyser, so it's possible that the worker is not even in scope any more.

In all all these cases we simply drop the special case, returning to
InlVanilla.  The WARN is just so I can see if it happens a lot.


763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
%************************************************************************
%*									*
	The Very Simple Optimiser
%*									*
%************************************************************************

\begin{code}
simpleOptExpr :: CoreExpr -> CoreExpr
-- Do simple optimisation on an expression
-- The optimisation is very straightforward: just
-- inline non-recursive bindings that are used only once, 
-- or where the RHS is trivial
--
-- The result is NOT guaranteed occurence-analysed, becuase
-- in  (let x = y in ....) we substitute for x; so y's occ-info
-- may change radically

simpleOptExpr expr
781
  = -- pprTrace "simpleOptExpr" (ppr init_subst $$ ppr expr)
782
    simpleOptExprWith init_subst expr
783 784 785 786 787 788 789 790 791
  where
    init_subst = mkEmptySubst (mkInScopeSet (exprFreeVars expr))
	-- It's potentially important to make a proper in-scope set
	-- Consider  let x = ..y.. in \y. ...x...
	-- Then we should remember to clone y before substituting
	-- for x.  It's very unlikely to occur, because we probably
	-- won't *be* substituting for x if it occurs inside a
	-- lambda.  
	--
792
        -- It's a bit painful to call exprFreeVars, because it makes
793 794
	-- three passes instead of two (occ-anal, and go)

795 796 797
simpleOptExprWith :: Subst -> InExpr -> OutExpr
simpleOptExprWith subst expr = simple_opt_expr subst (occurAnalyseExpr expr)

798
----------------------
799 800
simpleOptPgm :: DynFlags -> Module 
             -> [CoreBind] -> [CoreRule] -> [CoreVect] 
801
             -> IO ([CoreBind], [CoreRule], [CoreVect])
802
simpleOptPgm dflags this_mod binds rules vects
803
  = do { dumpIfSet_dyn dflags Opt_D_dump_occur_anal "Occurrence analysis"
804
                       (pprCoreBindings occ_anald_binds $$ pprRules rules );
805

806
       ; return (reverse binds', substRulesForImportedIds subst' rules, substVects subst' vects) }
807
  where
808
    occ_anald_binds  = occurAnalysePgm this_mod (\_ -> False) {- No rules active -}
809
                                       rules vects binds
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
    (subst', binds') = foldl do_one (emptySubst, []) occ_anald_binds
                       
    do_one (subst, binds') bind 
      = case simple_opt_bind subst bind of
          (subst', Nothing)    -> (subst', binds')
          (subst', Just bind') -> (subst', bind':binds')

----------------------
type InVar   = Var
type OutVar  = Var
type InId    = Id
type OutId   = Id
type InExpr  = CoreExpr
type OutExpr = CoreExpr

-- In these functions the substitution maps InVar -> OutExpr

----------------------
828 829 830 831
simple_opt_expr, simple_opt_expr' :: Subst -> InExpr -> OutExpr
simple_opt_expr s e = simple_opt_expr' s e

simple_opt_expr' subst expr
832 833 834
  = go expr
  where
    go (Var v)          = lookupIdSubst (text "simpleOptExpr") subst v
835
    go (App e1 e2)      = simple_app subst e1 [go e2]
836 837
    go (Type ty)        = Type     (substTy subst ty)
    go (Coercion co)    = Coercion (optCoercion (getCvSubst subst) co)
838 839
    go (Lit lit)        = Lit lit
    go (Note note e)    = Note note (go e)
840 841
    go (Cast e co)      | isReflCo co' = go e
       	                | otherwise    = Cast (go e) co' 
842
                        where
843
                          co' = optCoercion (getCvSubst subst) co
844

845 846 847 848
    go (Let bind body) = case simple_opt_bind subst bind of
                           (subst', Nothing)   -> simple_opt_expr subst' body
                           (subst', Just bind) -> Let bind (simple_opt_expr subst' body)

849 850 851 852 853
    go lam@(Lam {})     = go_lam [] subst lam
    go (Case e b ty as) = Case (go e) b' (substTy subst ty)
       			       (map (go_alt subst') as)
       		        where
       		  	  (subst', b') = subst_opt_bndr subst b
854 855

    ----------------------
856 857
    go_alt subst (con, bndrs, rhs) 
      = (con, bndrs', simple_opt_expr subst' rhs)
858
      where
859
	(subst', bndrs') = subst_opt_bndrs subst bndrs
860 861

    ----------------------
862 863 864 865 866 867 868 869 870 871 872 873
    -- go_lam tries eta reduction
    go_lam bs' subst (Lam b e) 
       = go_lam (b':bs') subst' e
       where
         (subst', b') = subst_opt_bndr subst b
    go_lam bs' subst e 
       | Just etad_e <- tryEtaReduce bs e' = etad_e
       | otherwise                         = mkLams bs e'
       where
         bs = reverse bs'
         e' = simple_opt_expr subst e

874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
----------------------
-- simple_app collects arguments for beta reduction
simple_app :: Subst -> InExpr -> [OutExpr] -> CoreExpr
simple_app subst (App e1 e2) as   
  = simple_app subst e1 (simple_opt_expr subst e2 : as)
simple_app subst (Lam b e) (a:as) 
  = case maybe_substitute subst b a of
      Just ext_subst -> simple_app ext_subst e as
      Nothing        -> Let (NonRec b2 a) (simple_app subst' e as)
  where
    (subst', b') = subst_opt_bndr subst b
    b2 = add_info subst' b b'
simple_app subst e as
  = foldl App (simple_opt_expr subst e) as

889
----------------------
890 891 892 893 894 895
simple_opt_bind,simple_opt_bind' :: Subst -> CoreBind -> (Subst, Maybe CoreBind)
simple_opt_bind s b 		  -- Can add trace stuff here
  = simple_opt_bind' s b

simple_opt_bind' subst (Rec prs)
  = (subst'', res_bind)
896
  where
897
    res_bind            = Just (Rec (reverse rev_prs'))
898 899
    (subst', bndrs')    = subst_opt_bndrs subst (map fst prs)
    (subst'', rev_prs') = foldl do_pr (subst', []) (prs `zip` bndrs')
900 901 902
    do_pr (subst, prs) ((b,r), b') 
       = case maybe_substitute subst b r2 of
           Just subst' -> (subst', prs)
903
           Nothing     -> (subst,  (b2,r2):prs)
904 905 906
       where
         b2 = add_info subst b b'
         r2 = simple_opt_expr subst r
907

908
simple_opt_bind' subst (NonRec b r)
909 910 911 912 913 914 915
  = case maybe_substitute subst b r' of
      Just ext_subst -> (ext_subst, Nothing)
      Nothing        -> (subst', Just (NonRec b2 r'))
  where
    r' = simple_opt_expr subst r
    (subst', b') = subst_opt_bndr subst b
    b2 = add_info subst' b b'
916 917

----------------------
918 919
maybe_substitute :: Subst -> InVar -> OutExpr -> Maybe Subst
    -- (maybe_substitute subst in_var out_rhs)  
920
    --   either extends subst with (in_var -> out_rhs)
921 922
    --   or     returns Nothing
maybe_substitute subst b r
923
  | Type ty <- r 	-- let a::* = TYPE ty in <body>
924
  = ASSERT( isTyVar b )
925
    Just (extendTvSubst subst b ty)
926

927 928 929 930 931
  | Coercion co <- r
  = ASSERT( isCoVar b )
    Just (extendCvSubst subst b co)

  | isId b              -- let x = e in <body>
932 933 934 935
  , safe_to_inline (idOccInfo b) 
  , isAlwaysActive (idInlineActivation b)	-- Note [Inline prag in simplOpt]
  , not (isStableUnfolding (idUnfolding b))
  , not (isExportedId b)
936
  = Just (extendIdSubst subst b r)
937 938
  
  | otherwise
939
  = Nothing
940
  where
941 942 943
	-- Unconditionally safe to inline
    safe_to_inline :: OccInfo -> Bool
    safe_to_inline (IAmALoopBreaker {})     = False
944
    safe_to_inline IAmDead                  = True
945 946
    safe_to_inline (OneOcc in_lam one_br _) = (not in_lam && one_br) || exprIsTrivial r
    safe_to_inline NoOccInfo                = exprIsTrivial r
947 948 949 950

----------------------
subst_opt_bndr :: Subst -> InVar -> (Subst, OutVar)
subst_opt_bndr subst bndr
951 952 953
  | isTyVar bndr  = substTyVarBndr subst bndr
  | isCoVar bndr  = substCoVarBndr subst bndr
  | otherwise     = subst_opt_id_bndr subst bndr
954 955 956 957 958 959

subst_opt_id_bndr :: Subst -> InId -> (Subst, OutId)
-- Nuke all fragile IdInfo, unfolding, and RULES; 
--    it gets added back later by add_info
-- Rather like SimplEnv.substIdBndr
--
960
-- It's important to zap fragile OccInfo (which CoreSubst.substIdBndr 
961 962
-- carefully does not do) because simplOptExpr invalidates it

963 964
subst_opt_id_bndr subst@(Subst in_scope id_subst tv_subst cv_subst) old_id
  = (Subst new_in_scope new_id_subst tv_subst cv_subst, new_id)
965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
  where
    id1	   = uniqAway in_scope old_id
    id2    = setIdType id1 (substTy subst (idType old_id))
    new_id = zapFragileIdInfo id2	-- Zaps rules, worker-info, unfolding
					-- and fragile OccInfo
    new_in_scope = in_scope `extendInScopeSet` new_id

	-- Extend the substitution if the unique has changed,
	-- or there's some useful occurrence information
	-- See the notes with substTyVarBndr for the delSubstEnv
    new_id_subst | new_id /= old_id
	         = extendVarEnv id_subst old_id (Var new_id)
	         | otherwise 
	         = delVarEnv id_subst old_id

----------------------
subst_opt_bndrs :: Subst -> [InVar] -> (Subst, [OutVar])
subst_opt_bndrs subst bndrs
  = mapAccumL subst_opt_bndr subst bndrs

----------------------
add_info :: Subst -> InVar -> OutVar -> OutVar
987 988 989
add_info subst old_bndr new_bndr
 | isTyVar old_bndr = new_bndr
 | otherwise        = maybeModifyIdInfo mb_new_info new_bndr
990 991
 where
   mb_new_info = substIdInfo subst new_bndr (idInfo old_bndr)
992
\end{code}
993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010

Note [Inline prag in simplOpt]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If there's an INLINE/NOINLINE pragma that restricts the phase in 
which the binder can be inlined, we don't inline here; after all,
we don't know what phase we're in.  Here's an example

  foo :: Int -> Int -> Int
  {-# INLINE foo #-}
  foo m n = inner m
     where
       {-# INLINE [1] inner #-}
       inner m = m+n

  bar :: Int -> Int
  bar n = foo n 1

When inlining 'foo' in 'bar' we want the let-binding for 'inner' 
1011 1012
to remain visible until Phase 1

1013