{-
(c) The AQUA Project, Glasgow University, 1993-1998

\section{Common subexpression}
-}

{-# LANGUAGE CPP #-}

{-# OPTIONS_GHC -Wno-incomplete-record-updates #-}
{-# OPTIONS_GHC -Wno-incomplete-uni-patterns   #-}

module GHC.Core.Opt.CSE (cseProgram, cseOneExpr) where

#include "HsVersions.h"

import GHC.Prelude

import GHC.Core.Subst
import GHC.Types.Var    ( Var )
import GHC.Types.Var.Env ( mkInScopeSet )
import GHC.Types.Id     ( Id, idType, idHasRules
                        , idInlineActivation, setInlineActivation
                        , zapIdOccInfo, zapIdUsageInfo, idInlinePragma
                        , isJoinId, isJoinId_maybe )
import GHC.Core.Utils   ( mkAltExpr, eqExpr
                        , exprIsTickedString
                        , stripTicksE, stripTicksT, mkTicks )
import GHC.Core.FVs     ( exprFreeVars )
import GHC.Core.Type    ( tyConAppArgs )
import GHC.Core
import GHC.Utils.Outputable
import GHC.Types.Basic
import GHC.Core.Map
import GHC.Utils.Misc   ( filterOut, equalLength, debugIsOn )
import Data.List        ( mapAccumL )

{-
                        Simple common sub-expression
                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When we see
        x1 = C a b
        x2 = C x1 b
we build up a reverse mapping:   C a b  -> x1
                                 C x1 b -> x2
and apply that to the rest of the program.

When we then see
        y1 = C a b
        y2 = C y1 b
we replace the C a b with x1.  But then we *dont* want to
add   x1 -> y1  to the mapping.  Rather, we want the reverse, y1 -> x1
so that a subsequent binding
        y2 = C y1 b
will get transformed to C x1 b, and then to x2.

So we carry an extra var->var substitution which we apply *before* looking up in the
reverse mapping.


Note [Shadowing]
~~~~~~~~~~~~~~~~
We have to be careful about shadowing.
For example, consider
        f = \x -> let y = x+x in
                      h = \x -> x+x
                  in ...

Here we must *not* do CSE on the inner x+x!  The simplifier used to guarantee no
shadowing, but it doesn't any more (it proved too hard), so we clone as we go.
We can simply add clones to the substitution already described.


Note [CSE for bindings]
~~~~~~~~~~~~~~~~~~~~~~~
Let-bindings have two cases, implemented by addBinding.

* SUBSTITUTE: applies when the RHS is a variable

     let x = y in ...(h x)....

  Here we want to extend the /substitution/ with x -> y, so that the
  (h x) in the body might CSE with an enclosing (let v = h y in ...).
  NB: the substitution maps InIds, so we extend the substitution with
      a binding for the original InId 'x'

  How can we have a variable on the RHS? Doesn't the simplifier inline them?

    - First, the original RHS might have been (g z) which has CSE'd
      with an enclosing (let y = g z in ...).  This is super-important.
      See #5996:
         x1 = C a b
         x2 = C x1 b
         y1 = C a b
         y2 = C y1 b
      Here we CSE y1's rhs to 'x1', and then we must add (y1->x1) to
      the substitution so that we can CSE the binding for y2.

    - Second, we use addBinding for case expression scrutinees too;
      see Note [CSE for case expressions]

* EXTEND THE REVERSE MAPPING: applies in all other cases

     let x = h y in ...(h y)...

  Here we want to extend the /reverse mapping (cs_map)/ so that
  we CSE the (h y) call to x.

  Note that we use EXTEND even for a trivial expression, provided it
  is not a variable or literal. In particular this /includes/ type
  applications. This can be important (#13156); e.g.
     case f @ Int of { r1 ->
     case f @ Int of { r2 -> ...
  Here we want to common-up the two uses of (f @ Int) so we can
  remove one of the case expressions.

  See also Note [Corner case for case expressions] for another
  reason not to use SUBSTITUTE for all trivial expressions.

Notice that
  - The SUBSTITUTE situation extends the substitution (cs_subst)
  - The EXTEND situation extends the reverse mapping (cs_map)

Notice also that in the SUBSTITUTE case we leave behind a binding
  x = y
even though we /also/ carry a substitution x -> y.  Can we just drop
the binding instead?  Well, not at top level! See Note [Top level and
postInlineUnconditionally] in GHC.Core.Opt.Simplify.Utils; and in any
case CSE applies only to the /bindings/ of the program, and we leave
it to the simplifier to propate effects to the RULES. Finally, it
doesn't seem worth the effort to discard the nested bindings because
the simplifier will do it next.

Note [CSE for case expressions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
  case scrut_expr of x { ...alts... }
This is very like a strict let-binding
  let !x = scrut_expr in ...
So we use (addBinding x scrut_expr) to process scrut_expr and x, and as a
result all the stuff under Note [CSE for bindings] applies directly.

For example:

* Trivial scrutinee
     f = \x -> case x of wild {
                 (a:as) -> case a of wild1 {
                             (p,q) -> ...(wild1:as)...

  Here, (wild1:as) is morally the same as (a:as) and hence equal to
  wild. But that's not quite obvious.  In the rest of the compiler we
  want to keep it as (wild1:as), but for CSE purpose that's a bad
  idea.

  By using addBinding we add the binding (wild1 -> a) to the substitution,
  which does exactly the right thing.

  (Notice this is exactly backwards to what the simplifier does, which
  is to try to replaces uses of 'a' with uses of 'wild1'.)

  This is the main reason that addBinding is called with a trivial rhs.

* Non-trivial scrutinee
     case (f x) of y { pat -> ...let z = f x in ... }

  By using addBinding we'll add (f x :-> y) to the cs_map, and
  thereby CSE the inner (f x) to y.

Note [CSE for INLINE and NOINLINE]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
There are some subtle interactions of CSE with functions that the user
has marked as INLINE or NOINLINE. (Examples from Roman Leshchinskiy.)
Consider

        yes :: Int  {-# NOINLINE yes #-}
        yes = undefined

        no :: Int   {-# NOINLINE no #-}
        no = undefined

        foo :: Int -> Int -> Int  {-# NOINLINE foo #-}
        foo m n = n

        {-# RULES "foo/no" foo no = id #-}

        bar :: Int -> Int
        bar = foo yes

We do not expect the rule to fire.  But if we do CSE, then we risk
getting yes=no, and the rule does fire.  Actually, it won't because
NOINLINE means that 'yes' will never be inlined, not even if we have
yes=no.  So that's fine (now; perhaps in the olden days, yes=no would
have substituted even if 'yes' was NOINLINE).

But we do need to take care.  Consider

        {-# NOINLINE bar #-}
        bar = <rhs>     -- Same rhs as foo

        foo = <rhs>

If CSE produces
        foo = bar
then foo will never be inlined to <rhs> (when it should be, if <rhs>
is small).  The conclusion here is this:

   We should not add
       <rhs> :-> bar
  to the CSEnv if 'bar' has any constraints on when it can inline;
  that is, if its 'activation' not always active.  Otherwise we
  might replace <rhs> by 'bar', and then later be unable to see that it
  really was <rhs>.

An except to the rule is when the INLINE pragma is not from the user, e.g. from
WorkWrap (see Note [Wrapper activation]). We can tell because noUserInlineSpec
is then true.

Note that we do not (currently) do CSE on the unfolding stored inside
an Id, even if it is a 'stable' unfolding.  That means that when an
unfolding happens, it is always faithful to what the stable unfolding
originally was.

Note [CSE for stable unfoldings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
   {-# Unf = Stable (\pq. build blah) #-}
   foo = x

Here 'foo' has a stable unfolding, but its (optimised) RHS is trivial.
(Turns out that this actually happens for the enumFromTo method of
the Integer instance of Enum in GHC.Enum.)  Suppose moreover that foo's
stable unfolding originates from an INLINE or INLINEABLE pragma on foo.
Then we obviously do NOT want to extend the substitution with (foo->x),
because we promised to inline foo as what the user wrote.  See similar Note
[Stable unfoldings and postInlineUnconditionally] in GHC.Core.Opt.Simplify.Utils.

Nor do we want to change the reverse mapping. Suppose we have

   {-# Unf = Stable (\pq. build blah) #-}
   foo = <expr>
   bar = <expr>

There could conceivably be merit in rewriting the RHS of bar:
   bar = foo
but now bar's inlining behaviour will change, and importing
modules might see that.  So it seems dodgy and we don't do it.

Stable unfoldings are also created during worker/wrapper when we decide
that a function's definition is so small that it should always inline.
In this case we still want to do CSE (#13340). Hence the use of
isAnyInlinePragma rather than isStableUnfolding.

Note [Corner case for case expressions]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Here is another reason that we do not use SUBSTITUTE for
all trivial expressions. Consider
   case x |> co of (y::Array# Int) { ... }

We do not want to extend the substitution with (y -> x |> co); since y
is of unlifted type, this would destroy the let/app invariant if (x |>
co) was not ok-for-speculation.

But surely (x |> co) is ok-for-speculation, because it's a trivial
expression, and x's type is also unlifted, presumably.  Well, maybe
not if you are using unsafe casts.  I actually found a case where we
had
   (x :: HValue) |> (UnsafeCo :: HValue ~ Array# Int)

Note [CSE for join points?]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
We must not be naive about join points in CSE:
   join j = e in
   if b then jump j else 1 + e
The expression (1 + jump j) is not good (see Note [Invariants on join points] in
GHC.Core). This seems to come up quite seldom, but it happens (first seen
compiling ppHtml in Haddock.Backends.Xhtml).

We could try and be careful by tracking which join points are still valid at
each subexpression, but since join points aren't allocated or shared, there's
less to gain by trying to CSE them. (#13219)

Note [Look inside join-point binders]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Another way how CSE for join points is tricky is

  let join foo x = (x, 42)
      join bar x = (x, 42)
  in … jump foo 1 … jump bar 2 …

naively, CSE would turn this into

  let join foo x = (x, 42)
      join bar = foo
  in … jump foo 1 … jump bar 2 …

but now bar is a join point that claims arity one, but its right-hand side
is not a lambda, breaking the join-point invariant (this was #15002).

So `cse_bind` must zoom past the lambdas of a join point (using
`collectNBinders`) and resume searching for CSE opportunities only in
the body of the join point.

Note [CSE for recursive bindings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
  f = \x ... f....
  g = \y ... g ...
where the "..." are identical.  Could we CSE them?  In full generality
with mutual recursion it's quite hard; but for self-recursive bindings
(which are very common) it's rather easy:

* Maintain a separate cs_rec_map, that maps
      (\f. (\x. ...f...) ) -> f
  Note the \f in the domain of the mapping!

* When we come across the binding for 'g', look up (\g. (\y. ...g...))
  Bingo we get a hit.  So we can replace the 'g' binding with
     g = f

We can't use cs_map for this, because the key isn't an expression of
the program; it's a kind of synthetic key for recursive bindings.


************************************************************************
*                                                                      *
\section{Common subexpression}
*                                                                      *
************************************************************************
-}

cseProgram :: CoreProgram -> CoreProgram
cseProgram :: CoreProgram -> CoreProgram
cseProgram CoreProgram
binds = (CSEnv, CoreProgram) -> CoreProgram
forall a b. (a, b) -> b
snd ((CSEnv -> CoreBind -> (CSEnv, CoreBind))
-> CSEnv -> CoreProgram -> (CSEnv, CoreProgram)
forall (t :: * -> *) s a b.
Traversable t =>
(s -> a -> (s, b)) -> s -> t a -> (s, t b)
mapAccumL (TopLevelFlag -> CSEnv -> CoreBind -> (CSEnv, CoreBind)
cseBind TopLevelFlag
TopLevel) CSEnv
emptyCSEnv CoreProgram
binds)

cseBind :: TopLevelFlag -> CSEnv -> CoreBind -> (CSEnv, CoreBind)
cseBind :: TopLevelFlag -> CSEnv -> CoreBind -> (CSEnv, CoreBind)
cseBind TopLevelFlag
toplevel CSEnv
env (NonRec CoreBndr
b Expr CoreBndr
e)
  = (CSEnv
env2, CoreBndr -> Expr CoreBndr -> CoreBind
forall b. b -> Expr b -> Bind b
NonRec CoreBndr
b2 Expr CoreBndr
e2)
  where
    (CSEnv
env1, CoreBndr
b1)       = CSEnv -> CoreBndr -> (CSEnv, CoreBndr)
addBinder CSEnv
env CoreBndr
b
    (CSEnv
env2, (CoreBndr
b2, Expr CoreBndr
e2)) = TopLevelFlag
-> CSEnv
-> (CoreBndr, Expr CoreBndr)
-> CoreBndr
-> (CSEnv, (CoreBndr, Expr CoreBndr))
cse_bind TopLevelFlag
toplevel CSEnv
env1 (CoreBndr
b,Expr CoreBndr
e) CoreBndr
b1

cseBind TopLevelFlag
toplevel CSEnv
env (Rec [(CoreBndr
in_id, Expr CoreBndr
rhs)])
  | CoreBndr -> Bool
noCSE CoreBndr
in_id
  = (CSEnv
env1, [(CoreBndr, Expr CoreBndr)] -> CoreBind
forall b. [(b, Expr b)] -> Bind b
Rec [(CoreBndr
out_id, Expr CoreBndr
rhs')])

  -- See Note [CSE for recursive bindings]
  | Just Expr CoreBndr
previous <- CSEnv -> CoreBndr -> Expr CoreBndr -> Maybe (Expr CoreBndr)
lookupCSRecEnv CSEnv
env CoreBndr
out_id Expr CoreBndr
rhs''
  , let previous' :: Expr CoreBndr
previous' = [Tickish CoreBndr] -> Expr CoreBndr -> Expr CoreBndr
mkTicks [Tickish CoreBndr]
ticks Expr CoreBndr
previous
        out_id' :: CoreBndr
out_id'   = TopLevelFlag -> CoreBndr -> CoreBndr
delayInlining TopLevelFlag
toplevel CoreBndr
out_id
  = -- We have a hit in the recursive-binding cache
    (CSEnv -> CoreBndr -> Expr CoreBndr -> CSEnv
extendCSSubst CSEnv
env1 CoreBndr
in_id Expr CoreBndr
previous', CoreBndr -> Expr CoreBndr -> CoreBind
forall b. b -> Expr b -> Bind b
NonRec CoreBndr
out_id' Expr CoreBndr
previous')

  | Bool
otherwise
  = (CSEnv -> CoreBndr -> Expr CoreBndr -> Expr CoreBndr -> CSEnv
extendCSRecEnv CSEnv
env1 CoreBndr
out_id Expr CoreBndr
rhs'' Expr CoreBndr
forall {b}. Expr b
id_expr', [(CoreBndr, Expr CoreBndr)] -> CoreBind
forall b. [(b, Expr b)] -> Bind b
Rec [(CoreBndr
zapped_id, Expr CoreBndr
rhs')])

  where
    (CSEnv
env1, [CoreBndr
out_id]) = CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addRecBinders CSEnv
env [CoreBndr
in_id]
    rhs' :: Expr CoreBndr
rhs'  = CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env1 Expr CoreBndr
rhs
    rhs'' :: Expr CoreBndr
rhs'' = (Tickish CoreBndr -> Bool) -> Expr CoreBndr -> Expr CoreBndr
forall b. (Tickish CoreBndr -> Bool) -> Expr b -> Expr b
stripTicksE Tickish CoreBndr -> Bool
forall id. Tickish id -> Bool
tickishFloatable Expr CoreBndr
rhs'
    ticks :: [Tickish CoreBndr]
ticks = (Tickish CoreBndr -> Bool) -> Expr CoreBndr -> [Tickish CoreBndr]
forall b.
(Tickish CoreBndr -> Bool) -> Expr b -> [Tickish CoreBndr]
stripTicksT Tickish CoreBndr -> Bool
forall id. Tickish id -> Bool
tickishFloatable Expr CoreBndr
rhs'
    id_expr' :: Expr b
id_expr'  = CoreBndr -> Expr b
forall b. CoreBndr -> Expr b
varToCoreExpr CoreBndr
out_id
    zapped_id :: CoreBndr
zapped_id = CoreBndr -> CoreBndr
zapIdUsageInfo CoreBndr
out_id

cseBind TopLevelFlag
toplevel CSEnv
env (Rec [(CoreBndr, Expr CoreBndr)]
pairs)
  = (CSEnv
env2, [(CoreBndr, Expr CoreBndr)] -> CoreBind
forall b. [(b, Expr b)] -> Bind b
Rec [(CoreBndr, Expr CoreBndr)]
pairs')
  where
    (CSEnv
env1, [CoreBndr]
bndrs1) = CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addRecBinders CSEnv
env (((CoreBndr, Expr CoreBndr) -> CoreBndr)
-> [(CoreBndr, Expr CoreBndr)] -> [CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map (CoreBndr, Expr CoreBndr) -> CoreBndr
forall a b. (a, b) -> a
fst [(CoreBndr, Expr CoreBndr)]
pairs)
    (CSEnv
env2, [(CoreBndr, Expr CoreBndr)]
pairs') = (CSEnv
 -> ((CoreBndr, Expr CoreBndr), CoreBndr)
 -> (CSEnv, (CoreBndr, Expr CoreBndr)))
-> CSEnv
-> [((CoreBndr, Expr CoreBndr), CoreBndr)]
-> (CSEnv, [(CoreBndr, Expr CoreBndr)])
forall (t :: * -> *) s a b.
Traversable t =>
(s -> a -> (s, b)) -> s -> t a -> (s, t b)
mapAccumL CSEnv
-> ((CoreBndr, Expr CoreBndr), CoreBndr)
-> (CSEnv, (CoreBndr, Expr CoreBndr))
do_one CSEnv
env1 ([(CoreBndr, Expr CoreBndr)]
-> [CoreBndr] -> [((CoreBndr, Expr CoreBndr), CoreBndr)]
forall a b. [a] -> [b] -> [(a, b)]
zip [(CoreBndr, Expr CoreBndr)]
pairs [CoreBndr]
bndrs1)

    do_one :: CSEnv
-> ((CoreBndr, Expr CoreBndr), CoreBndr)
-> (CSEnv, (CoreBndr, Expr CoreBndr))
do_one CSEnv
env ((CoreBndr, Expr CoreBndr)
pr, CoreBndr
b1) = TopLevelFlag
-> CSEnv
-> (CoreBndr, Expr CoreBndr)
-> CoreBndr
-> (CSEnv, (CoreBndr, Expr CoreBndr))
cse_bind TopLevelFlag
toplevel CSEnv
env (CoreBndr, Expr CoreBndr)
pr CoreBndr
b1

-- | Given a binding of @in_id@ to @in_rhs@, and a fresh name to refer
-- to @in_id@ (@out_id@, created from addBinder or addRecBinders),
-- first try to CSE @in_rhs@, and then add the resulting (possibly CSE'd)
-- binding to the 'CSEnv', so that we attempt to CSE any expressions
-- which are equal to @out_rhs@.
cse_bind :: TopLevelFlag -> CSEnv -> (InId, InExpr) -> OutId -> (CSEnv, (OutId, OutExpr))
cse_bind :: TopLevelFlag
-> CSEnv
-> (CoreBndr, Expr CoreBndr)
-> CoreBndr
-> (CSEnv, (CoreBndr, Expr CoreBndr))
cse_bind TopLevelFlag
toplevel CSEnv
env (CoreBndr
in_id, Expr CoreBndr
in_rhs) CoreBndr
out_id
  | TopLevelFlag -> Bool
isTopLevel TopLevelFlag
toplevel, Expr CoreBndr -> Bool
exprIsTickedString Expr CoreBndr
in_rhs
      -- See Note [Take care with literal strings]
  = (CSEnv
env', (CoreBndr
out_id', Expr CoreBndr
in_rhs))

  | Just JoinArity
arity <- CoreBndr -> Maybe JoinArity
isJoinId_maybe CoreBndr
in_id
      -- See Note [Look inside join-point binders]
  = let ([CoreBndr]
params, Expr CoreBndr
in_body) = JoinArity -> Expr CoreBndr -> ([CoreBndr], Expr CoreBndr)
forall b. JoinArity -> Expr b -> ([b], Expr b)
collectNBinders JoinArity
arity Expr CoreBndr
in_rhs
        (CSEnv
env', [CoreBndr]
params') = CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addBinders CSEnv
env [CoreBndr]
params
        out_body :: Expr CoreBndr
out_body = CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
env' Expr CoreBndr
in_body
    in (CSEnv
env, (CoreBndr
out_id, [CoreBndr] -> Expr CoreBndr -> Expr CoreBndr
forall b. [b] -> Expr b -> Expr b
mkLams [CoreBndr]
params' Expr CoreBndr
out_body))

  | Bool
otherwise
  = (CSEnv
env', (CoreBndr
out_id'', Expr CoreBndr
out_rhs))
  where
    (CSEnv
env', CoreBndr
out_id') = CSEnv -> CoreBndr -> CoreBndr -> Expr CoreBndr -> (CSEnv, CoreBndr)
addBinding CSEnv
env CoreBndr
in_id CoreBndr
out_id Expr CoreBndr
out_rhs
    (Bool
cse_done, Expr CoreBndr
out_rhs) = CSEnv -> Expr CoreBndr -> (Bool, Expr CoreBndr)
try_for_cse CSEnv
env Expr CoreBndr
in_rhs
    out_id'' :: CoreBndr
out_id'' | Bool
cse_done  = TopLevelFlag -> CoreBndr -> CoreBndr
delayInlining TopLevelFlag
toplevel CoreBndr
out_id'
             | Bool
otherwise = CoreBndr
out_id'

delayInlining :: TopLevelFlag -> Id -> Id
-- Add a NOINLINE[2] if the Id doesn't have an INLNE pragma already
-- See Note [Delay inlining after CSE]
delayInlining :: TopLevelFlag -> CoreBndr -> CoreBndr
delayInlining TopLevelFlag
top_lvl CoreBndr
bndr
  | TopLevelFlag -> Bool
isTopLevel TopLevelFlag
top_lvl
  , Activation -> Bool
isAlwaysActive (CoreBndr -> Activation
idInlineActivation CoreBndr
bndr)
  , CoreBndr -> Bool
idHasRules CoreBndr
bndr  -- Only if the Id has some RULES,
                     -- which might otherwise get lost
       -- These rules are probably auto-generated specialisations,
       -- since Ids with manual rules usually have manually-inserted
       -- delayed inlining anyway
  = CoreBndr
bndr CoreBndr -> Activation -> CoreBndr
`setInlineActivation` Activation
activateAfterInitial
  | Bool
otherwise
  = CoreBndr
bndr

addBinding :: CSEnv                      -- Includes InId->OutId cloning
           -> InVar                      -- Could be a let-bound type
           -> OutId -> OutExpr           -- Processed binding
           -> (CSEnv, OutId)             -- Final env, final bndr
-- Extend the CSE env with a mapping [rhs -> out-id]
-- unless we can instead just substitute [in-id -> rhs]
--
-- It's possible for the binder to be a type variable (see
-- Note [Type-let] in GHC.Core), in which case we can just substitute.
addBinding :: CSEnv -> CoreBndr -> CoreBndr -> Expr CoreBndr -> (CSEnv, CoreBndr)
addBinding CSEnv
env CoreBndr
in_id CoreBndr
out_id Expr CoreBndr
rhs'
  | Bool -> Bool
not (CoreBndr -> Bool
isId CoreBndr
in_id) = (CSEnv -> CoreBndr -> Expr CoreBndr -> CSEnv
extendCSSubst CSEnv
env CoreBndr
in_id Expr CoreBndr
rhs',     CoreBndr
out_id)
  | CoreBndr -> Bool
noCSE CoreBndr
in_id      = (CSEnv
env,                              CoreBndr
out_id)
  | Bool
use_subst        = (CSEnv -> CoreBndr -> Expr CoreBndr -> CSEnv
extendCSSubst CSEnv
env CoreBndr
in_id Expr CoreBndr
rhs',     CoreBndr
out_id)
  | Bool
otherwise        = (CSEnv -> Expr CoreBndr -> Expr CoreBndr -> CSEnv
extendCSEnv CSEnv
env Expr CoreBndr
rhs' Expr CoreBndr
forall {b}. Expr b
id_expr', CoreBndr
zapped_id)
  where
    id_expr' :: Expr b
id_expr'  = CoreBndr -> Expr b
forall b. CoreBndr -> Expr b
varToCoreExpr CoreBndr
out_id
    zapped_id :: CoreBndr
zapped_id = CoreBndr -> CoreBndr
zapIdUsageInfo CoreBndr
out_id
       -- Putting the Id into the cs_map makes it possible that
       -- it'll become shared more than it is now, which would
       -- invalidate (the usage part of) its demand info.
       --    This caused #100218.
       -- Easiest thing is to zap the usage info; subsequently
       -- performing late demand-analysis will restore it.  Don't zap
       -- the strictness info; it's not necessary to do so, and losing
       -- it is bad for performance if you don't do late demand
       -- analysis

    -- Should we use SUBSTITUTE or EXTEND?
    -- See Note [CSE for bindings]
    use_subst :: Bool
use_subst = case Expr CoreBndr
rhs' of
                   Var {} -> Bool
True
                   Expr CoreBndr
_      -> Bool
False

-- | Given a binder `let x = e`, this function
-- determines whether we should add `e -> x` to the cs_map
noCSE :: InId -> Bool
noCSE :: CoreBndr -> Bool
noCSE CoreBndr
id =  Bool -> Bool
not (Activation -> Bool
isAlwaysActive (CoreBndr -> Activation
idInlineActivation CoreBndr
id)) Bool -> Bool -> Bool
&&
            Bool -> Bool
not (InlineSpec -> Bool
noUserInlineSpec (InlinePragma -> InlineSpec
inlinePragmaSpec (CoreBndr -> InlinePragma
idInlinePragma CoreBndr
id)))
             -- See Note [CSE for INLINE and NOINLINE]
         Bool -> Bool -> Bool
|| InlinePragma -> Bool
isAnyInlinePragma (CoreBndr -> InlinePragma
idInlinePragma CoreBndr
id)
             -- See Note [CSE for stable unfoldings]
         Bool -> Bool -> Bool
|| CoreBndr -> Bool
isJoinId CoreBndr
id
             -- See Note [CSE for join points?]


{- Note [Take care with literal strings]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider this example:

  x = "foo"#
  y = "foo"#
  ...x...y...x...y....

We would normally turn this into:

  x = "foo"#
  y = x
  ...x...x...x...x....

But this breaks an invariant of Core, namely that the RHS of a top-level binding
of type Addr# must be a string literal, not another variable. See Note
[Core top-level string literals] in GHC.Core.

For this reason, we special case top-level bindings to literal strings and leave
the original RHS unmodified. This produces:

  x = "foo"#
  y = "foo"#
  ...x...x...x...x....

Now 'y' will be discarded as dead code, and we are done.

The net effect is that for the y-binding we want to
  - Use SUBSTITUTE, by extending the substitution with  y :-> x
  - but leave the original binding for y undisturbed

This is done by cse_bind.  I got it wrong the first time (#13367).

Note [Delay inlining after CSE]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Suppose (#15445) we have
   f,g :: Num a => a -> a
   f x = ...f (x-1).....
   g y = ...g (y-1) ....

and we make some specialisations of 'g', either automatically, or via
a SPECIALISE pragma.  Then CSE kicks in and notices that the RHSs of
'f' and 'g' are identical, so we get
   f x = ...f (x-1)...
   g = f
   {-# RULES g @Int _ = $sg #-}

Now there is terrible danger that, in an importing module, we'll inline
'g' before we have a chance to run its specialisation!

Solution: during CSE, after a "hit" in the CSE cache
  * when adding a binding
        g = f
  * for a top-level function g
  * and g has specialisation RULES
add a NOINLINE[2] activation to it, to ensure it's not inlined
right away.

Notes:
* Why top level only?  Because for nested bindings we are already past
  phase 2 and will never return there.

* Why "only if g has RULES"?  Because there is no point in
  doing this if there are no RULES; and other things being
  equal it delays optimisation to delay inlining (#17409)


---- Historical note ---

This patch is simpler and more direct than an earlier
version:

  commit 2110738b280543698407924a16ac92b6d804dc36
  Author: Simon Peyton Jones <simonpj@microsoft.com>
  Date:   Mon Jul 30 13:43:56 2018 +0100

  Don't inline functions with RULES too early

We had to revert this patch because it made GHC itself slower.

Why? It delayed inlining of /all/ functions with RULES, and that was
very bad in GHC.Tc.Solver.Flatten.flatten_ty_con_app

* It delayed inlining of liftM
* That delayed the unravelling of the recursion in some dictionary
  bindings.
* That delayed some eta expansion, leaving
     flatten_ty_con_app = \x y. let <stuff> in \z. blah
* That allowed the float-out pass to put sguff between
  the \y and \z.
* And that permanently stopped eta expansion of the function,
  even once <stuff> was simplified.

-}

tryForCSE :: CSEnv -> InExpr -> OutExpr
tryForCSE :: CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
env Expr CoreBndr
expr = (Bool, Expr CoreBndr) -> Expr CoreBndr
forall a b. (a, b) -> b
snd (CSEnv -> Expr CoreBndr -> (Bool, Expr CoreBndr)
try_for_cse CSEnv
env Expr CoreBndr
expr)

try_for_cse :: CSEnv -> InExpr -> (Bool, OutExpr)
-- (False, e') => We did not CSE the entire expression,
--                but we might have CSE'd some sub-expressions,
--                yielding e'
--
-- (True, te') => We CSE'd the entire expression,
--                yielding the trivial expression te'
try_for_cse :: CSEnv -> Expr CoreBndr -> (Bool, Expr CoreBndr)
try_for_cse CSEnv
env Expr CoreBndr
expr
  | Just Expr CoreBndr
e <- CSEnv -> Expr CoreBndr -> Maybe (Expr CoreBndr)
lookupCSEnv CSEnv
env Expr CoreBndr
expr'' = (Bool
True,  [Tickish CoreBndr] -> Expr CoreBndr -> Expr CoreBndr
mkTicks [Tickish CoreBndr]
ticks Expr CoreBndr
e)
  | Bool
otherwise                        = (Bool
False, Expr CoreBndr
expr')
    -- The varToCoreExpr is needed if we have
    --   case e of xco { ...case e of yco { ... } ... }
    -- Then CSE will substitute yco -> xco;
    -- but these are /coercion/ variables
  where
    expr' :: Expr CoreBndr
expr'  = CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env Expr CoreBndr
expr
    expr'' :: Expr CoreBndr
expr'' = (Tickish CoreBndr -> Bool) -> Expr CoreBndr -> Expr CoreBndr
forall b. (Tickish CoreBndr -> Bool) -> Expr b -> Expr b
stripTicksE Tickish CoreBndr -> Bool
forall id. Tickish id -> Bool
tickishFloatable Expr CoreBndr
expr'
    ticks :: [Tickish CoreBndr]
ticks  = (Tickish CoreBndr -> Bool) -> Expr CoreBndr -> [Tickish CoreBndr]
forall b.
(Tickish CoreBndr -> Bool) -> Expr b -> [Tickish CoreBndr]
stripTicksT Tickish CoreBndr -> Bool
forall id. Tickish id -> Bool
tickishFloatable Expr CoreBndr
expr'
    -- We don't want to lose the source notes when a common sub
    -- expression gets eliminated. Hence we push all (!) of them on
    -- top of the replaced sub-expression. This is probably not too
    -- useful in practice, but upholds our semantics.

-- | Runs CSE on a single expression.
--
-- This entry point is not used in the compiler itself, but is provided
-- as a convenient entry point for users of the GHC API.
cseOneExpr :: InExpr -> OutExpr
cseOneExpr :: Expr CoreBndr -> Expr CoreBndr
cseOneExpr Expr CoreBndr
e = CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env Expr CoreBndr
e
  where env :: CSEnv
env = CSEnv
emptyCSEnv {cs_subst :: Subst
cs_subst = InScopeSet -> Subst
mkEmptySubst (VarSet -> InScopeSet
mkInScopeSet (Expr CoreBndr -> VarSet
exprFreeVars Expr CoreBndr
e)) }

cseExpr :: CSEnv -> InExpr -> OutExpr
cseExpr :: CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env (Type Type
t)              = Type -> Expr CoreBndr
forall b. Type -> Expr b
Type (Subst -> Type -> Type
substTy (CSEnv -> Subst
csEnvSubst CSEnv
env) Type
t)
cseExpr CSEnv
env (Coercion Coercion
c)          = Coercion -> Expr CoreBndr
forall b. Coercion -> Expr b
Coercion (HasCallStack => Subst -> Coercion -> Coercion
Subst -> Coercion -> Coercion
substCo (CSEnv -> Subst
csEnvSubst CSEnv
env) Coercion
c)
cseExpr CSEnv
_   (Lit Literal
lit)             = Literal -> Expr CoreBndr
forall b. Literal -> Expr b
Lit Literal
lit
cseExpr CSEnv
env (Var CoreBndr
v)               = CSEnv -> CoreBndr -> Expr CoreBndr
lookupSubst CSEnv
env CoreBndr
v
cseExpr CSEnv
env (App Expr CoreBndr
f Expr CoreBndr
a)             = Expr CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. Expr b -> Expr b -> Expr b
App (CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env Expr CoreBndr
f) (CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
env Expr CoreBndr
a)
cseExpr CSEnv
env (Tick Tickish CoreBndr
t Expr CoreBndr
e)            = Tickish CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. Tickish CoreBndr -> Expr b -> Expr b
Tick Tickish CoreBndr
t (CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env Expr CoreBndr
e)
cseExpr CSEnv
env (Cast Expr CoreBndr
e Coercion
co)           = Expr CoreBndr -> Coercion -> Expr CoreBndr
forall b. Expr b -> Coercion -> Expr b
Cast (CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
env Expr CoreBndr
e) (HasCallStack => Subst -> Coercion -> Coercion
Subst -> Coercion -> Coercion
substCo (CSEnv -> Subst
csEnvSubst CSEnv
env) Coercion
co)
cseExpr CSEnv
env (Lam CoreBndr
b Expr CoreBndr
e)             = let (CSEnv
env', CoreBndr
b') = CSEnv -> CoreBndr -> (CSEnv, CoreBndr)
addBinder CSEnv
env CoreBndr
b
                                    in CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. b -> Expr b -> Expr b
Lam CoreBndr
b' (CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env' Expr CoreBndr
e)
cseExpr CSEnv
env (Let CoreBind
bind Expr CoreBndr
e)          = let (CSEnv
env', CoreBind
bind') = TopLevelFlag -> CSEnv -> CoreBind -> (CSEnv, CoreBind)
cseBind TopLevelFlag
NotTopLevel CSEnv
env CoreBind
bind
                                    in CoreBind -> Expr CoreBndr -> Expr CoreBndr
forall b. Bind b -> Expr b -> Expr b
Let CoreBind
bind' (CSEnv -> Expr CoreBndr -> Expr CoreBndr
cseExpr CSEnv
env' Expr CoreBndr
e)
cseExpr CSEnv
env (Case Expr CoreBndr
e CoreBndr
bndr Type
ty [OutAlt]
alts) = CSEnv
-> Expr CoreBndr -> CoreBndr -> Type -> [OutAlt] -> Expr CoreBndr
cseCase CSEnv
env Expr CoreBndr
e CoreBndr
bndr Type
ty [OutAlt]
alts

cseCase :: CSEnv -> InExpr -> InId -> InType -> [InAlt] -> OutExpr
cseCase :: CSEnv
-> Expr CoreBndr -> CoreBndr -> Type -> [OutAlt] -> Expr CoreBndr
cseCase CSEnv
env Expr CoreBndr
scrut CoreBndr
bndr Type
ty [OutAlt]
alts
  = Expr CoreBndr -> CoreBndr -> Type -> [OutAlt] -> Expr CoreBndr
forall b. Expr b -> b -> Type -> [Alt b] -> Expr b
Case Expr CoreBndr
scrut1 CoreBndr
bndr3 Type
ty' ([OutAlt] -> Expr CoreBndr) -> [OutAlt] -> Expr CoreBndr
forall a b. (a -> b) -> a -> b
$
    CSEnv -> [OutAlt] -> [OutAlt]
combineAlts CSEnv
alt_env ((OutAlt -> OutAlt) -> [OutAlt] -> [OutAlt]
forall a b. (a -> b) -> [a] -> [b]
map OutAlt -> OutAlt
cse_alt [OutAlt]
alts)
  where
    ty' :: Type
ty' = Subst -> Type -> Type
substTy (CSEnv -> Subst
csEnvSubst CSEnv
env) Type
ty
    scrut1 :: Expr CoreBndr
scrut1 = CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
env Expr CoreBndr
scrut

    bndr1 :: CoreBndr
bndr1 = CoreBndr -> CoreBndr
zapIdOccInfo CoreBndr
bndr
      -- Zapping the OccInfo is needed because the extendCSEnv
      -- in cse_alt may mean that a dead case binder
      -- becomes alive, and Lint rejects that
    (CSEnv
env1, CoreBndr
bndr2)    = CSEnv -> CoreBndr -> (CSEnv, CoreBndr)
addBinder CSEnv
env CoreBndr
bndr1
    (CSEnv
alt_env, CoreBndr
bndr3) = CSEnv -> CoreBndr -> CoreBndr -> Expr CoreBndr -> (CSEnv, CoreBndr)
addBinding CSEnv
env1 CoreBndr
bndr CoreBndr
bndr2 Expr CoreBndr
scrut1
         -- addBinding: see Note [CSE for case expressions]

    con_target :: OutExpr
    con_target :: Expr CoreBndr
con_target = CSEnv -> CoreBndr -> Expr CoreBndr
lookupSubst CSEnv
alt_env CoreBndr
bndr

    arg_tys :: [OutType]
    arg_tys :: [Type]
arg_tys = Type -> [Type]
tyConAppArgs (CoreBndr -> Type
idType CoreBndr
bndr3)

    -- See Note [CSE for case alternatives]
    cse_alt :: OutAlt -> OutAlt
cse_alt (DataAlt DataCon
con, [CoreBndr]
args, Expr CoreBndr
rhs)
        = (DataCon -> AltCon
DataAlt DataCon
con, [CoreBndr]
args', CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
new_env Expr CoreBndr
rhs)
        where
          (CSEnv
env', [CoreBndr]
args') = CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addBinders CSEnv
alt_env [CoreBndr]
args
          new_env :: CSEnv
new_env       = CSEnv -> Expr CoreBndr -> Expr CoreBndr -> CSEnv
extendCSEnv CSEnv
env' Expr CoreBndr
con_expr Expr CoreBndr
con_target
          con_expr :: Expr CoreBndr
con_expr      = AltCon -> [CoreBndr] -> [Type] -> Expr CoreBndr
mkAltExpr (DataCon -> AltCon
DataAlt DataCon
con) [CoreBndr]
args' [Type]
arg_tys

    cse_alt (AltCon
con, [CoreBndr]
args, Expr CoreBndr
rhs)
        = (AltCon
con, [CoreBndr]
args', CSEnv -> Expr CoreBndr -> Expr CoreBndr
tryForCSE CSEnv
env' Expr CoreBndr
rhs)
        where
          (CSEnv
env', [CoreBndr]
args') = CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addBinders CSEnv
alt_env [CoreBndr]
args

combineAlts :: CSEnv -> [OutAlt] -> [OutAlt]
-- See Note [Combine case alternatives]
combineAlts :: CSEnv -> [OutAlt] -> [OutAlt]
combineAlts CSEnv
env [OutAlt]
alts
  | (Just OutAlt
alt1, [OutAlt]
rest_alts) <- [OutAlt] -> (Maybe OutAlt, [OutAlt])
find_bndr_free_alt [OutAlt]
alts
  , (AltCon
_,[CoreBndr]
bndrs1,Expr CoreBndr
rhs1) <- OutAlt
alt1
  , let filtered_alts :: [OutAlt]
filtered_alts = (OutAlt -> Bool) -> [OutAlt] -> [OutAlt]
forall a. (a -> Bool) -> [a] -> [a]
filterOut (Expr CoreBndr -> OutAlt -> Bool
forall {a} {b}. Expr CoreBndr -> (a, b, Expr CoreBndr) -> Bool
identical_alt Expr CoreBndr
rhs1) [OutAlt]
rest_alts
  , Bool -> Bool
not ([OutAlt] -> [OutAlt] -> Bool
forall a b. [a] -> [b] -> Bool
equalLength [OutAlt]
rest_alts [OutAlt]
filtered_alts)
  = ASSERT2( null bndrs1, ppr alts )
    (AltCon
DEFAULT, [], Expr CoreBndr
rhs1) OutAlt -> [OutAlt] -> [OutAlt]
forall a. a -> [a] -> [a]
: [OutAlt]
filtered_alts

  | Bool
otherwise
  = [OutAlt]
alts
  where
    in_scope :: InScopeSet
in_scope = Subst -> InScopeSet
substInScope (CSEnv -> Subst
csEnvSubst CSEnv
env)

    find_bndr_free_alt :: [CoreAlt] -> (Maybe CoreAlt, [CoreAlt])
       -- The (Just alt) is a binder-free alt
       -- See Note [Combine case alts: awkward corner]
    find_bndr_free_alt :: [OutAlt] -> (Maybe OutAlt, [OutAlt])
find_bndr_free_alt []
      = (Maybe OutAlt
forall a. Maybe a
Nothing, [])
    find_bndr_free_alt (alt :: OutAlt
alt@(AltCon
_,[CoreBndr]
bndrs,Expr CoreBndr
_) : [OutAlt]
alts)
      | [CoreBndr] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [CoreBndr]
bndrs = (OutAlt -> Maybe OutAlt
forall a. a -> Maybe a
Just OutAlt
alt, [OutAlt]
alts)
      | Bool
otherwise  = case [OutAlt] -> (Maybe OutAlt, [OutAlt])
find_bndr_free_alt [OutAlt]
alts of
                       (Maybe OutAlt
mb_bf, [OutAlt]
alts) -> (Maybe OutAlt
mb_bf, OutAlt
altOutAlt -> [OutAlt] -> [OutAlt]
forall a. a -> [a] -> [a]
:[OutAlt]
alts)

    identical_alt :: Expr CoreBndr -> (a, b, Expr CoreBndr) -> Bool
identical_alt Expr CoreBndr
rhs1 (a
_,b
_,Expr CoreBndr
rhs) = InScopeSet -> Expr CoreBndr -> Expr CoreBndr -> Bool
eqExpr InScopeSet
in_scope Expr CoreBndr
rhs1 Expr CoreBndr
rhs
       -- Even if this alt has binders, they will have been cloned
       -- If any of these binders are mentioned in 'rhs', then
       -- 'rhs' won't compare equal to 'rhs1' (which is from an
       -- alt with no binders).

{- Note [CSE for case alternatives]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider   case e of x
            K1 y -> ....(K1 y)...
            K2   -> ....K2....

We definitely want to CSE that (K1 y) into just x.

But what about the lone K2?  At first you would think "no" because
turning K2 into 'x' increases the number of live variables.  But

* Turning K2 into x increases the chance of combining identical alts.
  Example      case xs of
                  (_:_) -> f xs
                  []    -> f []
  See #17901 and simplCore/should_compile/T17901 for more examples
  of this kind.

* The next run of the simplifier will turn 'x' back into K2, so we won't
  permanently bloat the free-var count.


Note [Combine case alternatives]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
combineAlts is just a more heavyweight version of the use of
combineIdenticalAlts in GHC.Core.Opt.Simplify.Utils.prepareAlts.  The basic idea is
to transform

    DEFAULT -> e1
    K x     -> e1
    W y z   -> e2
===>
   DEFAULT -> e1
   W y z   -> e2

In the simplifier we use cheapEqExpr, because it is called a lot.
But here in CSE we use the full eqExpr.  After all, two alternatives usually
differ near the root, so it probably isn't expensive to compare the full
alternative.  It seems like the same kind of thing that CSE is supposed
to be doing, which is why I put it here.

I actually saw some examples in the wild, where some inlining made e1 too
big for cheapEqExpr to catch it.

Note [Combine case alts: awkward corner]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We would really like to check isDeadBinder on the binders in the
alternative.  But alas, the simplifer zaps occ-info on binders in case
alternatives; see Note [Case alternative occ info] in GHC.Core.Opt.Simplify.

* One alternative (perhaps a good one) would be to do OccAnal
  just before CSE.  Then perhaps we could get rid of combineIdenticalAlts
  in the Simplifier, which might save work.

* Another would be for CSE to return free vars as it goes.

* But the current solution is to find a nullary alternative (including
  the DEFAULT alt, if any). This will not catch
      case x of
        A y   -> blah
        B z p -> blah
  where no alternative is nullary or DEFAULT.  But the current
  solution is at least cheap.


************************************************************************
*                                                                      *
\section{The CSE envt}
*                                                                      *
************************************************************************
-}

data CSEnv
  = CS { CSEnv -> Subst
cs_subst :: Subst  -- Maps InBndrs to OutExprs
            -- The substitution variables to
            -- /trivial/ OutExprs, not arbitrary expressions

       , CSEnv -> CoreMap (Expr CoreBndr)
cs_map   :: CoreMap OutExpr   -- The reverse mapping
            -- Maps a OutExpr to a /trivial/ OutExpr
            -- The key of cs_map is stripped of all Ticks

       , CSEnv -> CoreMap (Expr CoreBndr)
cs_rec_map :: CoreMap OutExpr
            -- See Note [CSE for recursive bindings]
       }

emptyCSEnv :: CSEnv
emptyCSEnv :: CSEnv
emptyCSEnv = CS :: Subst
-> CoreMap (Expr CoreBndr) -> CoreMap (Expr CoreBndr) -> CSEnv
CS { cs_map :: CoreMap (Expr CoreBndr)
cs_map = CoreMap (Expr CoreBndr)
forall a. CoreMap a
emptyCoreMap, cs_rec_map :: CoreMap (Expr CoreBndr)
cs_rec_map = CoreMap (Expr CoreBndr)
forall a. CoreMap a
emptyCoreMap
                , cs_subst :: Subst
cs_subst = Subst
emptySubst }

lookupCSEnv :: CSEnv -> OutExpr -> Maybe OutExpr
lookupCSEnv :: CSEnv -> Expr CoreBndr -> Maybe (Expr CoreBndr)
lookupCSEnv (CS { cs_map :: CSEnv -> CoreMap (Expr CoreBndr)
cs_map = CoreMap (Expr CoreBndr)
csmap }) Expr CoreBndr
expr
  = CoreMap (Expr CoreBndr) -> Expr CoreBndr -> Maybe (Expr CoreBndr)
forall a. CoreMap a -> Expr CoreBndr -> Maybe a
lookupCoreMap CoreMap (Expr CoreBndr)
csmap Expr CoreBndr
expr

extendCSEnv :: CSEnv -> OutExpr -> OutExpr -> CSEnv
extendCSEnv :: CSEnv -> Expr CoreBndr -> Expr CoreBndr -> CSEnv
extendCSEnv CSEnv
cse Expr CoreBndr
expr Expr CoreBndr
triv_expr
  = CSEnv
cse { cs_map :: CoreMap (Expr CoreBndr)
cs_map = CoreMap (Expr CoreBndr)
-> Expr CoreBndr -> Expr CoreBndr -> CoreMap (Expr CoreBndr)
forall a. CoreMap a -> Expr CoreBndr -> a -> CoreMap a
extendCoreMap (CSEnv -> CoreMap (Expr CoreBndr)
cs_map CSEnv
cse) Expr CoreBndr
sexpr Expr CoreBndr
triv_expr }
  where
    sexpr :: Expr CoreBndr
sexpr = (Tickish CoreBndr -> Bool) -> Expr CoreBndr -> Expr CoreBndr
forall b. (Tickish CoreBndr -> Bool) -> Expr b -> Expr b
stripTicksE Tickish CoreBndr -> Bool
forall id. Tickish id -> Bool
tickishFloatable Expr CoreBndr
expr

extendCSRecEnv :: CSEnv -> OutId -> OutExpr -> OutExpr -> CSEnv
-- See Note [CSE for recursive bindings]
extendCSRecEnv :: CSEnv -> CoreBndr -> Expr CoreBndr -> Expr CoreBndr -> CSEnv
extendCSRecEnv CSEnv
cse CoreBndr
bndr Expr CoreBndr
expr Expr CoreBndr
triv_expr
  = CSEnv
cse { cs_rec_map :: CoreMap (Expr CoreBndr)
cs_rec_map = CoreMap (Expr CoreBndr)
-> Expr CoreBndr -> Expr CoreBndr -> CoreMap (Expr CoreBndr)
forall a. CoreMap a -> Expr CoreBndr -> a -> CoreMap a
extendCoreMap (CSEnv -> CoreMap (Expr CoreBndr)
cs_rec_map CSEnv
cse) (CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. b -> Expr b -> Expr b
Lam CoreBndr
bndr Expr CoreBndr
expr) Expr CoreBndr
triv_expr }

lookupCSRecEnv :: CSEnv -> OutId -> OutExpr -> Maybe OutExpr
-- See Note [CSE for recursive bindings]
lookupCSRecEnv :: CSEnv -> CoreBndr -> Expr CoreBndr -> Maybe (Expr CoreBndr)
lookupCSRecEnv (CS { cs_rec_map :: CSEnv -> CoreMap (Expr CoreBndr)
cs_rec_map = CoreMap (Expr CoreBndr)
csmap }) CoreBndr
bndr Expr CoreBndr
expr
  = CoreMap (Expr CoreBndr) -> Expr CoreBndr -> Maybe (Expr CoreBndr)
forall a. CoreMap a -> Expr CoreBndr -> Maybe a
lookupCoreMap CoreMap (Expr CoreBndr)
csmap (CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. b -> Expr b -> Expr b
Lam CoreBndr
bndr Expr CoreBndr
expr)

csEnvSubst :: CSEnv -> Subst
csEnvSubst :: CSEnv -> Subst
csEnvSubst = CSEnv -> Subst
cs_subst

lookupSubst :: CSEnv -> Id -> OutExpr
lookupSubst :: CSEnv -> CoreBndr -> Expr CoreBndr
lookupSubst (CS { cs_subst :: CSEnv -> Subst
cs_subst = Subst
sub}) CoreBndr
x = HasDebugCallStack => Subst -> CoreBndr -> Expr CoreBndr
Subst -> CoreBndr -> Expr CoreBndr
lookupIdSubst Subst
sub CoreBndr
x

extendCSSubst :: CSEnv -> Id  -> CoreExpr -> CSEnv
extendCSSubst :: CSEnv -> CoreBndr -> Expr CoreBndr -> CSEnv
extendCSSubst CSEnv
cse CoreBndr
x Expr CoreBndr
rhs = CSEnv
cse { cs_subst :: Subst
cs_subst = Subst -> CoreBndr -> Expr CoreBndr -> Subst
extendSubst (CSEnv -> Subst
cs_subst CSEnv
cse) CoreBndr
x Expr CoreBndr
rhs }

-- | Add clones to the substitution to deal with shadowing.  See
-- Note [Shadowing] for more details.  You should call this whenever
-- you go under a binder.
addBinder :: CSEnv -> Var -> (CSEnv, Var)
addBinder :: CSEnv -> CoreBndr -> (CSEnv, CoreBndr)
addBinder CSEnv
cse CoreBndr
v = (CSEnv
cse { cs_subst :: Subst
cs_subst = Subst
sub' }, CoreBndr
v')
                where
                  (Subst
sub', CoreBndr
v') = Subst -> CoreBndr -> (Subst, CoreBndr)
substBndr (CSEnv -> Subst
cs_subst CSEnv
cse) CoreBndr
v

addBinders :: CSEnv -> [Var] -> (CSEnv, [Var])
addBinders :: CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addBinders CSEnv
cse [CoreBndr]
vs = (CSEnv
cse { cs_subst :: Subst
cs_subst = Subst
sub' }, [CoreBndr]
vs')
                where
                  (Subst
sub', [CoreBndr]
vs') = Subst -> [CoreBndr] -> (Subst, [CoreBndr])
substBndrs (CSEnv -> Subst
cs_subst CSEnv
cse) [CoreBndr]
vs

addRecBinders :: CSEnv -> [Id] -> (CSEnv, [Id])
addRecBinders :: CSEnv -> [CoreBndr] -> (CSEnv, [CoreBndr])
addRecBinders CSEnv
cse [CoreBndr]
vs = (CSEnv
cse { cs_subst :: Subst
cs_subst = Subst
sub' }, [CoreBndr]
vs')
                where
                  (Subst
sub', [CoreBndr]
vs') = Subst -> [CoreBndr] -> (Subst, [CoreBndr])
substRecBndrs (CSEnv -> Subst
cs_subst CSEnv
cse) [CoreBndr]
vs