compiler/coreSyn/CoreSubst.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5
   6 Utility functions on @Core@ syntax
   7
   8 \begin{code}
   9 module CoreSubst (
  10         -- Substitution stuff
  11         Subst, TvSubstEnv, IdSubstEnv, InScopeSet,
  12
  13         deShadowBinds,
  14         substTy, substExpr, substSpec, substWorker,
  15         lookupIdSubst, lookupTvSubst,
  16
  17         emptySubst, mkEmptySubst, mkSubst, substInScope, isEmptySubst,
  18         extendIdSubst, extendIdSubstList, extendTvSubst, extendTvSubstList,
  19         extendSubst, extendSubstList, zapSubstEnv,
  20         extendInScope, extendInScopeList, extendInScopeIds,
  21         isInScope,
  22
  23         -- Binders
  24         substBndr, substBndrs, substRecBndrs,
  25         cloneIdBndr, cloneIdBndrs, cloneRecIdBndrs
  26     ) where
  27
  28 #include "HsVersions.h"
  29
  30 import CoreSyn
  31 import CoreFVs
  32 import CoreUtils
  33
  34 import qualified Type
  35 import Type     ( Type, TvSubst(..), TvSubstEnv )
  36 import VarSet
  37 import VarEnv
  38 import Id
  39 import Var      ( Var, TyVar, setVarUnique )
  40 import IdInfo
  41 import Unique
  42 import UniqSupply
  43 import Maybes
  44 import Outputable
  45 import PprCore          ()              -- Instances
  46
  47 import Data.List
  48 \end{code}
  49
  50
  51 %************************************************************************
  52 %*                                                                      *
  53 \subsection{Substitutions}
  54 %*                                                                      *
  55 %************************************************************************
  56
  57 \begin{code}
  58 data Subst
  59   = Subst InScopeSet    -- Variables in in scope (both Ids and TyVars)
  60                         -- *after* applying the substitution
  61           IdSubstEnv    -- Substitution for Ids
  62           TvSubstEnv    -- Substitution for TyVars
  63
  64         -- INVARIANT 1: The (domain of the) in-scope set is a superset
  65         --              of the free vars of the range of the substitution
  66         --              that might possibly clash with locally-bound variables
  67         --              in the thing being substituted in.
  68         -- This is what lets us deal with name capture properly
  69         -- It's a hard invariant to check...
  70         -- There are various ways of causing it to happen:
  71         --      - arrange that the in-scope set really is all the things in scope
  72         --      - arrange that it's the free vars of the range of the substitution
  73         --      - make it empty because all the free vars of the subst are fresh,
  74         --              and hence can't possibly clash.a
  75         --
  76         -- INVARIANT 2: The substitution is apply-once; see Note [Apply once] with
  77         --              Types.TvSubstEnv
  78         --
  79         -- INVARIANT 3: See Note [Extending the Subst]
  80
  81 {-
  82 Note [Extending the Subst]
  83 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  84 For a core Subst, which binds Ids as well, we make a different choice for Ids
  85 than we do for TyVars.
  86
  87 For TyVars, see Note [Extending the TvSubst] with Type.TvSubstEnv
  88
  89 For Ids, we have a different invariant
  90         The IdSubstEnv is extended *only* when the Unique on an Id changes
  91         Otherwise, we just extend the InScopeSet
  92
  93 In consequence:
  94
  95 * In substIdBndr, we extend the IdSubstEnv only when the unique changes
  96
  97 * If the TvSubstEnv and IdSubstEnv are both empty, substExpr does nothing
  98   (Note that the above rule for substIdBndr maintains this property.  If
  99    the incoming envts are both empty, then substituting the type and
 100    IdInfo can't change anything.)
 101
 102 * In lookupIdSubst, we *must* look up the Id in the in-scope set, because
 103   it may contain non-trivial changes.  Example:
 104         (/\a. \x:a. ...x...) Int
 105   We extend the TvSubstEnv with [a |-> Int]; but x's unique does not change
 106   so we only extend the in-scope set.  Then we must look up in the in-scope
 107   set when we find the occurrence of x.
 108
 109 Why do we make a different choice for the IdSubstEnv than the TvSubstEnv?
 110
 111 * For Ids, we change the IdInfo all the time (e.g. deleting the
 112   unfolding), and adding it back later, so using the TyVar convention
 113   would entail extending the substitution almost all the time
 114
 115 * The simplifier wants to look up in the in-scope set anyway, in case it
 116   can see a better unfolding from an enclosing case expression
 117
 118 * For TyVars, only coercion variables can possibly change, and they are
 119   easy to spot
 120 -}
 121
 122 type IdSubstEnv = IdEnv CoreExpr
 123
 124 ----------------------------
 125 isEmptySubst :: Subst -> Bool
 126 isEmptySubst (Subst _ id_env tv_env) = isEmptyVarEnv id_env && isEmptyVarEnv tv_env
 127
 128 emptySubst :: Subst
 129 emptySubst = Subst emptyInScopeSet emptyVarEnv emptyVarEnv
 130
 131 mkEmptySubst :: InScopeSet -> Subst
 132 mkEmptySubst in_scope = Subst in_scope emptyVarEnv emptyVarEnv
 133
 134 mkSubst :: InScopeSet -> TvSubstEnv -> IdSubstEnv -> Subst
 135 mkSubst in_scope tvs ids = Subst in_scope ids tvs
 136
 137 -- getTvSubst :: Subst -> TvSubst
 138 -- getTvSubst (Subst in_scope _ tv_env) = TvSubst in_scope tv_env
 139
 140 -- getTvSubstEnv :: Subst -> TvSubstEnv
 141 -- getTvSubstEnv (Subst _ _ tv_env) = tv_env
 142 --
 143 -- setTvSubstEnv :: Subst -> TvSubstEnv -> Subst
 144 -- setTvSubstEnv (Subst in_scope ids _) tvs = Subst in_scope ids tvs
 145
 146 substInScope :: Subst -> InScopeSet
 147 substInScope (Subst in_scope _ _) = in_scope
 148
 149 zapSubstEnv :: Subst -> Subst
 150 zapSubstEnv (Subst in_scope _ _) = Subst in_scope emptyVarEnv emptyVarEnv
 151
 152 -- ToDo: add an ASSERT that fvs(subst-result) is already in the in-scope set
 153 extendIdSubst :: Subst -> Id -> CoreExpr -> Subst
 154 extendIdSubst (Subst in_scope ids tvs) v r = Subst in_scope (extendVarEnv ids v r) tvs
 155
 156 extendIdSubstList :: Subst -> [(Id, CoreExpr)] -> Subst
 157 extendIdSubstList (Subst in_scope ids tvs) prs = Subst in_scope (extendVarEnvList ids prs) tvs
 158
 159 extendTvSubst :: Subst -> TyVar -> Type -> Subst
 160 extendTvSubst (Subst in_scope ids tvs) v r = Subst in_scope ids (extendVarEnv tvs v r)
 161
 162 extendTvSubstList :: Subst -> [(TyVar,Type)] -> Subst
 163 extendTvSubstList (Subst in_scope ids tvs) prs = Subst in_scope ids (extendVarEnvList tvs prs)
 164
 165 extendSubstList :: Subst -> [(Var,CoreArg)] -> Subst
 166 extendSubstList subst []              = subst
 167 extendSubstList subst ((var,rhs):prs) = extendSubstList (extendSubst subst var rhs) prs
 168
 169 extendSubst :: Subst -> Var -> CoreArg -> Subst
 170 extendSubst (Subst in_scope ids tvs) tv (Type ty)
 171   = ASSERT( isTyVar tv ) Subst in_scope ids (extendVarEnv tvs tv ty)
 172 extendSubst (Subst in_scope ids tvs) id expr
 173   = ASSERT( isId id ) Subst in_scope (extendVarEnv ids id expr) tvs
 174
 175 lookupIdSubst :: Subst -> Id -> CoreExpr
 176 lookupIdSubst (Subst in_scope ids _) v
 177   | not (isLocalId v) = Var v
 178   | Just e  <- lookupVarEnv ids       v = e
 179   | Just v' <- lookupInScope in_scope v = Var v'
 180         -- Vital! See Note [Extending the Subst]
 181   | otherwise = WARN( True, ptext SLIT("CoreSubst.lookupIdSubst") <+> ppr v )
 182                 Var v
 183
 184 lookupTvSubst :: Subst -> TyVar -> Type
 185 lookupTvSubst (Subst _ _ tvs) v = lookupVarEnv tvs v `orElse` Type.mkTyVarTy v
 186
 187 ------------------------------
 188 isInScope :: Var -> Subst -> Bool
 189 isInScope v (Subst in_scope _ _) = v `elemInScopeSet` in_scope
 190
 191 extendInScope :: Subst -> Var -> Subst
 192 extendInScope (Subst in_scope ids tvs) v
 193   = Subst (in_scope `extendInScopeSet` v)
 194           (ids `delVarEnv` v) (tvs `delVarEnv` v)
 195
 196 extendInScopeList :: Subst -> [Var] -> Subst
 197 extendInScopeList (Subst in_scope ids tvs) vs
 198   = Subst (in_scope `extendInScopeSetList` vs)
 199           (ids `delVarEnvList` vs) (tvs `delVarEnvList` vs)
 200
 201 extendInScopeIds :: Subst -> [Id] -> Subst
 202 extendInScopeIds (Subst in_scope ids tvs) vs
 203   = Subst (in_scope `extendInScopeSetList` vs)
 204           (ids `delVarEnvList` vs) tvs
 205 \end{code}
 206
 207 Pretty printing, for debugging only
 208
 209 \begin{code}
 210 instance Outputable Subst where
 211   ppr (Subst in_scope ids tvs)
 212         =  ptext SLIT("<InScope =") <+> braces (fsep (map ppr (varEnvElts (getInScopeVars in_scope))))
 213         $$ ptext SLIT(" IdSubst   =") <+> ppr ids
 214         $$ ptext SLIT(" TvSubst   =") <+> ppr tvs
 215          <> char '>'
 216 \end{code}
 217
 218
 219 %************************************************************************
 220 %*                                                                      *
 221         Substituting expressions
 222 %*                                                                      *
 223 %************************************************************************
 224
 225 \begin{code}
 226 substExpr :: Subst -> CoreExpr -> CoreExpr
 227 substExpr subst expr
 228   = go expr
 229   where
 230     go (Var v)         = lookupIdSubst subst v
 231     go (Type ty)       = Type (substTy subst ty)
 232     go (Lit lit)       = Lit lit
 233     go (App fun arg)   = App (go fun) (go arg)
 234     go (Note note e)   = Note (go_note note) (go e)
 235     go (Cast e co)     = Cast (go e) (substTy subst co)
 236     go (Lam bndr body) = Lam bndr' (substExpr subst' body)
 237                        where
 238                          (subst', bndr') = substBndr subst bndr
 239
 240     go (Let bind body) = Let bind' (substExpr subst' body)
 241                        where
 242                          (subst', bind') = substBind subst bind
 243
 244     go (Case scrut bndr ty alts) = Case (go scrut) bndr' (substTy subst ty) (map (go_alt subst') alts)
 245                                  where
 246                                  (subst', bndr') = substBndr subst bndr
 247
 248     go_alt subst (con, bndrs, rhs) = (con, bndrs', substExpr subst' rhs)
 249                                  where
 250                                    (subst', bndrs') = substBndrs subst bndrs
 251
 252     go_note note             = note
 253
 254 substBind :: Subst -> CoreBind -> (Subst, CoreBind)
 255 substBind subst (NonRec bndr rhs) = (subst', NonRec bndr' (substExpr subst rhs))
 256                                   where
 257                                     (subst', bndr') = substBndr subst bndr
 258
 259 substBind subst (Rec pairs) = (subst', Rec pairs')
 260                             where
 261                                 (subst', bndrs') = substRecBndrs subst (map fst pairs)
 262                                 pairs'  = bndrs' `zip` rhss'
 263                                 rhss'   = map (substExpr subst' . snd) pairs
 264 \end{code}
 265
 266 De-shadowing the program is sometimes a useful pre-pass.  It can be done simply
 267 by running over the bindings with an empty substitution, becuase substitution
 268 returns a result that has no-shadowing guaranteed.
 269
 270 (Actually, within a single *type* there might still be shadowing, because
 271 substType is a no-op for the empty substitution, but that's OK.)
 272
 273 \begin{code}
 274 deShadowBinds :: [CoreBind] -> [CoreBind]
 275 deShadowBinds binds = snd (mapAccumL substBind emptySubst binds)
 276 \end{code}
 277
 278
 279 %************************************************************************
 280 %*                                                                      *
 281         Substituting binders
 282 %*                                                                      *
 283 %************************************************************************
 284
 285 Remember that substBndr and friends are used when doing expression
 286 substitution only.  Their only business is substitution, so they
 287 preserve all IdInfo (suitably substituted).  For example, we *want* to
 288 preserve occ info in rules.
 289
 290 \begin{code}
 291 substBndr :: Subst -> Var -> (Subst, Var)
 292 substBndr subst bndr
 293   | isTyVar bndr  = substTyVarBndr subst bndr
 294   | otherwise     = substIdBndr subst subst bndr
 295
 296 substBndrs :: Subst -> [Var] -> (Subst, [Var])
 297 substBndrs subst bndrs = mapAccumL substBndr subst bndrs
 298
 299 substRecBndrs :: Subst -> [Id] -> (Subst, [Id])
 300 -- Substitute a mutually recursive group
 301 substRecBndrs subst bndrs
 302   = (new_subst, new_bndrs)
 303   where         -- Here's the reason we need to pass rec_subst to subst_id
 304     (new_subst, new_bndrs) = mapAccumL (substIdBndr new_subst) subst bndrs
 305 \end{code}
 306
 307
 308 \begin{code}
 309 substIdBndr :: Subst            -- Substitution to use for the IdInfo
 310             -> Subst -> Id      -- Substitition and Id to transform
 311             -> (Subst, Id)      -- Transformed pair
 312                                 -- NB: unfolding may be zapped
 313
 314 substIdBndr rec_subst subst@(Subst in_scope env tvs) old_id
 315   = (Subst (in_scope `extendInScopeSet` new_id) new_env tvs, new_id)
 316   where
 317     id1 = uniqAway in_scope old_id      -- id1 is cloned if necessary
 318     id2 | no_type_change = id1
 319         | otherwise      = setIdType id1 (substTy subst old_ty)
 320
 321     old_ty = idType old_id
 322     no_type_change = isEmptyVarEnv tvs ||
 323                      isEmptyVarSet (Type.tyVarsOfType old_ty)
 324
 325         -- new_id has the right IdInfo
 326         -- The lazy-set is because we're in a loop here, with
 327         -- rec_subst, when dealing with a mutually-recursive group
 328     new_id = maybeModifyIdInfo mb_new_info id2
 329     mb_new_info = substIdInfo rec_subst id2 (idInfo id2)
 330         -- NB: unfolding info may be zapped
 331
 332         -- Extend the substitution if the unique has changed
 333         -- See the notes with substTyVarBndr for the delVarEnv
 334     new_env | no_change = delVarEnv env old_id
 335             | otherwise = extendVarEnv env old_id (Var new_id)
 336
 337     no_change = id1 == old_id
 338         -- See Note [Extending the Subst]
 339         -- *not* necessary to check mb_new_info and no_type_change
 340 \end{code}
 341
 342 Now a variant that unconditionally allocates a new unique.
 343 It also unconditionally zaps the OccInfo.
 344
 345 \begin{code}
 346 cloneIdBndr :: Subst -> UniqSupply -> Id -> (Subst, Id)
 347 cloneIdBndr subst us old_id
 348   = clone_id subst subst (old_id, uniqFromSupply us)
 349
 350 cloneIdBndrs :: Subst -> UniqSupply -> [Id] -> (Subst, [Id])
 351 cloneIdBndrs subst us ids
 352   = mapAccumL (clone_id subst) subst (ids `zip` uniqsFromSupply us)
 353
 354 cloneRecIdBndrs :: Subst -> UniqSupply -> [Id] -> (Subst, [Id])
 355 cloneRecIdBndrs subst us ids
 356   = (subst', ids')
 357   where
 358     (subst', ids') = mapAccumL (clone_id subst') subst
 359                                (ids `zip` uniqsFromSupply us)
 360
 361 -- Just like substIdBndr, except that it always makes a new unique
 362 -- It is given the unique to use
 363 clone_id    :: Subst                    -- Substitution for the IdInfo
 364             -> Subst -> (Id, Unique)    -- Substitition and Id to transform
 365             -> (Subst, Id)              -- Transformed pair
 366
 367 clone_id rec_subst subst@(Subst in_scope env tvs) (old_id, uniq)
 368   = (Subst (in_scope `extendInScopeSet` new_id) new_env tvs, new_id)
 369   where
 370     id1     = setVarUnique old_id uniq
 371     id2     = substIdType subst id1
 372     new_id  = maybeModifyIdInfo (substIdInfo rec_subst id2 (idInfo old_id)) id2
 373     new_env = extendVarEnv env old_id (Var new_id)
 374 \end{code}
 375
 376
 377 %************************************************************************
 378 %*                                                                      *
 379                 Types
 380 %*                                                                      *
 381 %************************************************************************
 382
 383 For types we just call the corresponding function in Type, but we have
 384 to repackage the substitution, from a Subst to a TvSubst
 385
 386 \begin{code}
 387 substTyVarBndr :: Subst -> TyVar -> (Subst, TyVar)
 388 substTyVarBndr (Subst in_scope id_env tv_env) tv
 389   = case Type.substTyVarBndr (TvSubst in_scope tv_env) tv of
 390         (TvSubst in_scope' tv_env', tv')
 391            -> (Subst in_scope' id_env tv_env', tv')
 392
 393 substTy :: Subst -> Type -> Type
 394 substTy (Subst in_scope _id_env tv_env) ty
 395   = Type.substTy (TvSubst in_scope tv_env) ty
 396 \end{code}
 397
 398
 399 %************************************************************************
 400 %*                                                                      *
 401 \section{IdInfo substitution}
 402 %*                                                                      *
 403 %************************************************************************
 404
 405 \begin{code}
 406 substIdType :: Subst -> Id -> Id
 407 substIdType subst@(Subst _ _ tv_env) id
 408   | isEmptyVarEnv tv_env || isEmptyVarSet (Type.tyVarsOfType old_ty) = id
 409   | otherwise   = setIdType id (substTy subst old_ty)
 410                 -- The tyVarsOfType is cheaper than it looks
 411                 -- because we cache the free tyvars of the type
 412                 -- in a Note in the id's type itself
 413   where
 414     old_ty = idType id
 415
 416 ------------------
 417 substIdInfo :: Subst -> Id -> IdInfo -> Maybe IdInfo
 418 -- Always zaps the unfolding, to save substitution work
 419 substIdInfo subst new_id info
 420   | nothing_to_do = Nothing
 421   | otherwise     = Just (info `setSpecInfo`      substSpec subst new_id old_rules
 422                                `setWorkerInfo`    substWorker subst old_wrkr
 423                                `setUnfoldingInfo` noUnfolding)
 424   where
 425     old_rules     = specInfo info
 426     old_wrkr      = workerInfo info
 427     nothing_to_do = isEmptySpecInfo old_rules &&
 428                     not (workerExists old_wrkr) &&
 429                     not (hasUnfolding (unfoldingInfo info))
 430
 431
 432 ------------------
 433 substWorker :: Subst -> WorkerInfo -> WorkerInfo
 434         -- Seq'ing on the returned WorkerInfo is enough to cause all the
 435         -- substitutions to happen completely
 436
 437 substWorker _ NoWorker
 438   = NoWorker
 439 substWorker subst (HasWorker w a)
 440   = case lookupIdSubst subst w of
 441         Var w1 -> HasWorker w1 a
 442         other  -> WARN( not (exprIsTrivial other), text "CoreSubst.substWorker:" <+> ppr w )
 443                   NoWorker      -- Worker has got substituted away altogether
 444                                 -- (This can happen if it's trivial,
 445                                 --  via postInlineUnconditionally, hence warning)
 446
 447 ------------------
 448 substSpec :: Subst -> Id -> SpecInfo -> SpecInfo
 449
 450 substSpec subst new_fn spec@(SpecInfo rules rhs_fvs)
 451   | isEmptySubst subst
 452   = spec
 453   | otherwise
 454   = seqSpecInfo new_rules `seq` new_rules
 455   where
 456     new_name = idName new_fn
 457     new_rules = SpecInfo (map do_subst rules) (substVarSet subst rhs_fvs)
 458
 459     do_subst rule@(BuiltinRule {}) = rule
 460     do_subst rule@(Rule { ru_bndrs = bndrs, ru_args = args, ru_rhs = rhs })
 461         = rule { ru_bndrs = bndrs',
 462                  ru_fn = new_name,      -- Important: the function may have changed its name!
 463                  ru_args  = map (substExpr subst') args,
 464                  ru_rhs   = substExpr subst' rhs }
 465         where
 466           (subst', bndrs') = substBndrs subst bndrs
 467
 468 ------------------
 469 substVarSet :: Subst -> VarSet -> VarSet
 470 substVarSet subst fvs
 471   = foldVarSet (unionVarSet . subst_fv subst) emptyVarSet fvs
 472   where
 473     subst_fv subst fv
 474         | isId fv   = exprFreeVars (lookupIdSubst subst fv)
 475         | otherwise = Type.tyVarsOfType (lookupTvSubst subst fv)
 476 \end{code}