{-
(c) The University of Glasgow 2006
(c) The AQUA Project, Glasgow University, 1996-1998


This module contains "tidying" code for *nested* expressions, bindings, rules.
The code for *top-level* bindings is in GHC.Iface.Tidy.
-}


{-# OPTIONS_GHC -Wno-incomplete-record-updates #-}
module GHC.Core.Tidy (
        tidyExpr, tidyRules, tidyUnfolding, tidyCbvInfoTop
    ) where

import GHC.Prelude

import GHC.Core
import GHC.Core.Type

import GHC.Core.Seq ( seqUnfolding )
import GHC.Core.Utils ( computeCbvInfo )
import GHC.Types.Id
import GHC.Types.Id.Info
import GHC.Types.Demand ( zapDmdEnvSig )
import GHC.Core.Coercion ( tidyCo )
import GHC.Types.Var
import GHC.Types.Var.Env
import GHC.Types.Unique (getUnique)
import GHC.Types.Unique.FM
import GHC.Types.Name hiding (tidyNameOcc)
import GHC.Types.Name.Set
import GHC.Types.SrcLoc
import GHC.Types.Tickish
import GHC.Data.Maybe
import GHC.Utils.Misc
import Data.List (mapAccumL)

{-
************************************************************************
*                                                                      *
\subsection{Tidying expressions, rules}
*                                                                      *
************************************************************************
-}

tidyBind :: TidyEnv
         -> CoreBind
         ->  (TidyEnv, CoreBind)

tidyBind :: TidyEnv -> CoreBind -> (TidyEnv, CoreBind)
tidyBind TidyEnv
env (NonRec CoreBndr
bndr Expr CoreBndr
rhs)
  = -- pprTrace "tidyBindNonRec" (ppr bndr) $
    let cbv_bndr :: CoreBndr
cbv_bndr = (HasDebugCallStack => CoreBndr -> Expr CoreBndr -> CoreBndr
CoreBndr -> Expr CoreBndr -> CoreBndr
tidyCbvInfoLocal CoreBndr
bndr Expr CoreBndr
rhs)
        (TidyEnv
env', CoreBndr
bndr') = TidyEnv -> TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyLetBndr TidyEnv
env TidyEnv
env CoreBndr
cbv_bndr
        tidy_rhs :: Expr CoreBndr
tidy_rhs = (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env' Expr CoreBndr
rhs)
    in (TidyEnv
env', CoreBndr -> Expr CoreBndr -> CoreBind
forall b. b -> Expr b -> Bind b
NonRec CoreBndr
bndr' Expr CoreBndr
tidy_rhs)

tidyBind TidyEnv
env (Rec [(CoreBndr, Expr CoreBndr)]
prs)
  = -- pprTrace "tidyBindRec" (ppr $ map fst prs) $
    let
       cbv_bndrs :: [CoreBndr]
cbv_bndrs = ((CoreBndr, Expr CoreBndr) -> CoreBndr)
-> [(CoreBndr, Expr CoreBndr)] -> [CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map ((\(CoreBndr
bnd,Expr CoreBndr
rhs) -> HasDebugCallStack => CoreBndr -> Expr CoreBndr -> CoreBndr
CoreBndr -> Expr CoreBndr -> CoreBndr
tidyCbvInfoLocal CoreBndr
bnd Expr CoreBndr
rhs)) [(CoreBndr, Expr CoreBndr)]
prs
       ([CoreBndr]
_bndrs, [Expr CoreBndr]
rhss)  = [(CoreBndr, Expr CoreBndr)] -> ([CoreBndr], [Expr CoreBndr])
forall a b. [(a, b)] -> ([a], [b])
unzip [(CoreBndr, Expr CoreBndr)]
prs
       (TidyEnv
env', [CoreBndr]
bndrs') = (TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr))
-> TidyEnv -> [CoreBndr] -> (TidyEnv, [CoreBndr])
forall (t :: * -> *) a b c.
Traversable t =>
(a -> b -> (a, c)) -> a -> t b -> (a, t c)
mapAccumL (TidyEnv -> TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyLetBndr TidyEnv
env') TidyEnv
env [CoreBndr]
cbv_bndrs
    in
    (Expr CoreBndr -> Expr CoreBndr)
-> [Expr CoreBndr] -> [Expr CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env') [Expr CoreBndr]
rhss [Expr CoreBndr]
-> ([Expr CoreBndr] -> (TidyEnv, CoreBind)) -> (TidyEnv, CoreBind)
forall a b. a -> (a -> b) -> b
=: \ [Expr CoreBndr]
rhss' ->
    (TidyEnv
env', [(CoreBndr, Expr CoreBndr)] -> CoreBind
forall b. [(b, Expr b)] -> Bind b
Rec ([CoreBndr] -> [Expr CoreBndr] -> [(CoreBndr, Expr CoreBndr)]
forall a b. [a] -> [b] -> [(a, b)]
zip [CoreBndr]
bndrs' [Expr CoreBndr]
rhss'))


-- Note [Attaching CBV Marks to ids]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Before tidy, function arguments which have a call-by-value semantics are identified
-- by having an `OtherCon[]` unfolding. During tidy, we transform this information into CBV (call-by-value)
-- marks. The marks themselves then are put onto the function id itself.
-- This means the code generator can get the full calling convention by only looking at the function
-- itself without having to inspect the RHS for potential argument unfoldings.
--
-- The actual logic is in tidyCbvInfo and takes:
-- * The function id
-- * The functions rhs
-- And gives us back the function annotated with the marks.
-- We call it in:
-- * tidyTopPair for top level bindings
-- * tidyBind for local bindings.
--
-- Not that we *have* to look at the untidied rhs.
-- During tidying some knot-tying occurs which can blow up
-- if we look at the types of the arguments, but here we dont:
-- we only check if the manifest lambdas have OtherCon unfoldings
-- and these remain valid post tidy.
--
-- If the id is boot-exported we don't use a cbv calling convention via marks,
-- as the boot file won't contain them. Which means code calling boot-exported
-- ids might expect these ids to have a vanilla calling convention even if we
-- determine a different one here.
-- To be able to avoid this we pass a set of boot exported ids for this module around.
-- For non top level ids we can skip this. Local ids are never boot-exported
-- as boot files don't have unfoldings. So there this isn't a concern.
-- See also Note [Strict Worker Ids]


-- See Note [Attaching CBV Marks to ids]
tidyCbvInfoTop :: HasDebugCallStack => NameSet -> Id -> CoreExpr -> Id
tidyCbvInfoTop :: NameSet -> CoreBndr -> Expr CoreBndr -> CoreBndr
tidyCbvInfoTop NameSet
boot_exports CoreBndr
id Expr CoreBndr
rhs
  -- Can't change calling convention for boot exported things
  | Name -> NameSet -> Bool
elemNameSet (CoreBndr -> Name
idName CoreBndr
id) NameSet
boot_exports = CoreBndr
id
  | Bool
otherwise = HasCallStack => CoreBndr -> Expr CoreBndr -> CoreBndr
CoreBndr -> Expr CoreBndr -> CoreBndr
computeCbvInfo CoreBndr
id Expr CoreBndr
rhs

-- See Note [Attaching CBV Marks to ids]
tidyCbvInfoLocal :: HasDebugCallStack => Id -> CoreExpr -> Id
tidyCbvInfoLocal :: CoreBndr -> Expr CoreBndr -> CoreBndr
tidyCbvInfoLocal CoreBndr
id Expr CoreBndr
rhs
  | Bool
otherwise = HasCallStack => CoreBndr -> Expr CoreBndr -> CoreBndr
CoreBndr -> Expr CoreBndr -> CoreBndr
computeCbvInfo CoreBndr
id Expr CoreBndr
rhs

------------  Expressions  --------------
tidyExpr :: TidyEnv -> CoreExpr -> CoreExpr
tidyExpr :: TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env (Var CoreBndr
v)       = CoreBndr -> Expr CoreBndr
forall b. CoreBndr -> Expr b
Var (TidyEnv -> CoreBndr -> CoreBndr
tidyVarOcc TidyEnv
env CoreBndr
v)
tidyExpr TidyEnv
env (Type Type
ty)     = Type -> Expr CoreBndr
forall b. Type -> Expr b
Type (TidyEnv -> Type -> Type
tidyType TidyEnv
env Type
ty)
tidyExpr TidyEnv
env (Coercion Coercion
co) = Coercion -> Expr CoreBndr
forall b. Coercion -> Expr b
Coercion (TidyEnv -> Coercion -> Coercion
tidyCo TidyEnv
env Coercion
co)
tidyExpr TidyEnv
_   (Lit Literal
lit)     = Literal -> Expr CoreBndr
forall b. Literal -> Expr b
Lit Literal
lit
tidyExpr TidyEnv
env (App Expr CoreBndr
f Expr CoreBndr
a)     = Expr CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. Expr b -> Expr b -> Expr b
App (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env Expr CoreBndr
f) (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env Expr CoreBndr
a)
tidyExpr TidyEnv
env (Tick CoreTickish
t Expr CoreBndr
e)    = CoreTickish -> Expr CoreBndr -> Expr CoreBndr
forall b. CoreTickish -> Expr b -> Expr b
Tick (TidyEnv -> CoreTickish -> CoreTickish
tidyTickish TidyEnv
env CoreTickish
t) (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env Expr CoreBndr
e)
tidyExpr TidyEnv
env (Cast Expr CoreBndr
e Coercion
co)   = Expr CoreBndr -> Coercion -> Expr CoreBndr
forall b. Expr b -> Coercion -> Expr b
Cast (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env Expr CoreBndr
e) (TidyEnv -> Coercion -> Coercion
tidyCo TidyEnv
env Coercion
co)

tidyExpr TidyEnv
env (Let CoreBind
b Expr CoreBndr
e)
  = TidyEnv -> CoreBind -> (TidyEnv, CoreBind)
tidyBind TidyEnv
env CoreBind
b      (TidyEnv, CoreBind)
-> ((TidyEnv, CoreBind) -> Expr CoreBndr) -> Expr CoreBndr
forall a b. a -> (a -> b) -> b
=: \ (TidyEnv
env', CoreBind
b') ->
    CoreBind -> Expr CoreBndr -> Expr CoreBndr
forall b. Bind b -> Expr b -> Expr b
Let CoreBind
b' (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env' Expr CoreBndr
e)

tidyExpr TidyEnv
env (Case Expr CoreBndr
e CoreBndr
b Type
ty [Alt CoreBndr]
alts)
  = TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyBndr TidyEnv
env CoreBndr
b  (TidyEnv, CoreBndr)
-> ((TidyEnv, CoreBndr) -> Expr CoreBndr) -> Expr CoreBndr
forall a b. a -> (a -> b) -> b
=: \ (TidyEnv
env', CoreBndr
b) ->
    Expr CoreBndr
-> CoreBndr -> Type -> [Alt CoreBndr] -> Expr CoreBndr
forall b. Expr b -> b -> Type -> [Alt b] -> Expr b
Case (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env Expr CoreBndr
e) CoreBndr
b (TidyEnv -> Type -> Type
tidyType TidyEnv
env Type
ty)
         ((Alt CoreBndr -> Alt CoreBndr) -> [Alt CoreBndr] -> [Alt CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map (TidyEnv -> Alt CoreBndr -> Alt CoreBndr
tidyAlt TidyEnv
env') [Alt CoreBndr]
alts)

tidyExpr TidyEnv
env (Lam CoreBndr
b Expr CoreBndr
e)
  = TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyBndr TidyEnv
env CoreBndr
b      (TidyEnv, CoreBndr)
-> ((TidyEnv, CoreBndr) -> Expr CoreBndr) -> Expr CoreBndr
forall a b. a -> (a -> b) -> b
=: \ (TidyEnv
env', CoreBndr
b) ->
    CoreBndr -> Expr CoreBndr -> Expr CoreBndr
forall b. b -> Expr b -> Expr b
Lam CoreBndr
b (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env' Expr CoreBndr
e)

------------  Case alternatives  --------------
tidyAlt :: TidyEnv -> CoreAlt -> CoreAlt
tidyAlt :: TidyEnv -> Alt CoreBndr -> Alt CoreBndr
tidyAlt TidyEnv
env (Alt AltCon
con [CoreBndr]
vs Expr CoreBndr
rhs)
  = TidyEnv -> [CoreBndr] -> (TidyEnv, [CoreBndr])
tidyBndrs TidyEnv
env [CoreBndr]
vs    (TidyEnv, [CoreBndr])
-> ((TidyEnv, [CoreBndr]) -> Alt CoreBndr) -> Alt CoreBndr
forall a b. a -> (a -> b) -> b
=: \ (TidyEnv
env', [CoreBndr]
vs) ->
    (AltCon -> [CoreBndr] -> Expr CoreBndr -> Alt CoreBndr
forall b. AltCon -> [b] -> Expr b -> Alt b
Alt AltCon
con [CoreBndr]
vs (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env' Expr CoreBndr
rhs))

------------  Tickish  --------------
tidyTickish :: TidyEnv -> CoreTickish -> CoreTickish
tidyTickish :: TidyEnv -> CoreTickish -> CoreTickish
tidyTickish TidyEnv
env (Breakpoint XBreakpoint 'TickishPassCore
ext Int
ix [XTickishId 'TickishPassCore]
ids)
  = XBreakpoint 'TickishPassCore
-> Int -> [XTickishId 'TickishPassCore] -> CoreTickish
forall (pass :: TickishPass).
XBreakpoint pass -> Int -> [XTickishId pass] -> GenTickish pass
Breakpoint XBreakpoint 'TickishPassCore
ext Int
ix ((CoreBndr -> CoreBndr) -> [CoreBndr] -> [CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map (TidyEnv -> CoreBndr -> CoreBndr
tidyVarOcc TidyEnv
env) [CoreBndr]
[XTickishId 'TickishPassCore]
ids)
tidyTickish TidyEnv
_   CoreTickish
other_tickish       = CoreTickish
other_tickish

------------  Rules  --------------
tidyRules :: TidyEnv -> [CoreRule] -> [CoreRule]
tidyRules :: TidyEnv -> [CoreRule] -> [CoreRule]
tidyRules TidyEnv
_   [] = []
tidyRules TidyEnv
env (CoreRule
rule : [CoreRule]
rules)
  = TidyEnv -> CoreRule -> CoreRule
tidyRule TidyEnv
env CoreRule
rule           CoreRule -> (CoreRule -> [CoreRule]) -> [CoreRule]
forall a b. a -> (a -> b) -> b
=: \ CoreRule
rule ->
    TidyEnv -> [CoreRule] -> [CoreRule]
tidyRules TidyEnv
env [CoreRule]
rules         [CoreRule] -> ([CoreRule] -> [CoreRule]) -> [CoreRule]
forall a b. a -> (a -> b) -> b
=: \ [CoreRule]
rules ->
    (CoreRule
rule CoreRule -> [CoreRule] -> [CoreRule]
forall a. a -> [a] -> [a]
: [CoreRule]
rules)

tidyRule :: TidyEnv -> CoreRule -> CoreRule
tidyRule :: TidyEnv -> CoreRule -> CoreRule
tidyRule TidyEnv
_   rule :: CoreRule
rule@(BuiltinRule {}) = CoreRule
rule
tidyRule TidyEnv
env rule :: CoreRule
rule@(Rule { ru_bndrs :: CoreRule -> [CoreBndr]
ru_bndrs = [CoreBndr]
bndrs, ru_args :: CoreRule -> [Expr CoreBndr]
ru_args = [Expr CoreBndr]
args, ru_rhs :: CoreRule -> Expr CoreBndr
ru_rhs = Expr CoreBndr
rhs,
                          ru_fn :: CoreRule -> Name
ru_fn = Name
fn, ru_rough :: CoreRule -> [Maybe Name]
ru_rough = [Maybe Name]
mb_ns })
  = TidyEnv -> [CoreBndr] -> (TidyEnv, [CoreBndr])
tidyBndrs TidyEnv
env [CoreBndr]
bndrs         (TidyEnv, [CoreBndr])
-> ((TidyEnv, [CoreBndr]) -> CoreRule) -> CoreRule
forall a b. a -> (a -> b) -> b
=: \ (TidyEnv
env', [CoreBndr]
bndrs) ->
    (Expr CoreBndr -> Expr CoreBndr)
-> [Expr CoreBndr] -> [Expr CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env') [Expr CoreBndr]
args    [Expr CoreBndr] -> ([Expr CoreBndr] -> CoreRule) -> CoreRule
forall a b. a -> (a -> b) -> b
=: \ [Expr CoreBndr]
args ->
    CoreRule
rule { ru_bndrs :: [CoreBndr]
ru_bndrs = [CoreBndr]
bndrs, ru_args :: [Expr CoreBndr]
ru_args = [Expr CoreBndr]
args,
           ru_rhs :: Expr CoreBndr
ru_rhs   = TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
env' Expr CoreBndr
rhs,
           ru_fn :: Name
ru_fn    = TidyEnv -> Name -> Name
tidyNameOcc TidyEnv
env Name
fn,
           ru_rough :: [Maybe Name]
ru_rough = (Maybe Name -> Maybe Name) -> [Maybe Name] -> [Maybe Name]
forall a b. (a -> b) -> [a] -> [b]
map ((Name -> Name) -> Maybe Name -> Maybe Name
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap (TidyEnv -> Name -> Name
tidyNameOcc TidyEnv
env')) [Maybe Name]
mb_ns }

{-
************************************************************************
*                                                                      *
\subsection{Tidying non-top-level binders}
*                                                                      *
************************************************************************
-}

tidyNameOcc :: TidyEnv -> Name -> Name
-- In rules and instances, we have Names, and we must tidy them too
-- Fortunately, we can lookup in the VarEnv with a name
tidyNameOcc :: TidyEnv -> Name -> Name
tidyNameOcc (TidyOccEnv
_, VarEnv CoreBndr
var_env) Name
n = case VarEnv CoreBndr -> Unique -> Maybe CoreBndr
forall key elt. UniqFM key elt -> Unique -> Maybe elt
lookupUFM_Directly VarEnv CoreBndr
var_env (Name -> Unique
forall a. Uniquable a => a -> Unique
getUnique Name
n) of
                                Maybe CoreBndr
Nothing -> Name
n
                                Just CoreBndr
v  -> CoreBndr -> Name
idName CoreBndr
v

tidyVarOcc :: TidyEnv -> Var -> Var
tidyVarOcc :: TidyEnv -> CoreBndr -> CoreBndr
tidyVarOcc (TidyOccEnv
_, VarEnv CoreBndr
var_env) CoreBndr
v = VarEnv CoreBndr -> CoreBndr -> Maybe CoreBndr
forall a. VarEnv a -> CoreBndr -> Maybe a
lookupVarEnv VarEnv CoreBndr
var_env CoreBndr
v Maybe CoreBndr -> CoreBndr -> CoreBndr
forall a. Maybe a -> a -> a
`orElse` CoreBndr
v

-- tidyBndr is used for lambda and case binders
tidyBndr :: TidyEnv -> Var -> (TidyEnv, Var)
tidyBndr :: TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyBndr TidyEnv
env CoreBndr
var
  | CoreBndr -> Bool
isTyCoVar CoreBndr
var = TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyVarBndr TidyEnv
env CoreBndr
var
  | Bool
otherwise     = TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyIdBndr TidyEnv
env CoreBndr
var

tidyBndrs :: TidyEnv -> [Var] -> (TidyEnv, [Var])
tidyBndrs :: TidyEnv -> [CoreBndr] -> (TidyEnv, [CoreBndr])
tidyBndrs TidyEnv
env [CoreBndr]
vars = (TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr))
-> TidyEnv -> [CoreBndr] -> (TidyEnv, [CoreBndr])
forall (t :: * -> *) a b c.
Traversable t =>
(a -> b -> (a, c)) -> a -> t b -> (a, t c)
mapAccumL TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyBndr TidyEnv
env [CoreBndr]
vars

-- Non-top-level variables, not covars
tidyIdBndr :: TidyEnv -> Id -> (TidyEnv, Id)
tidyIdBndr :: TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyIdBndr env :: TidyEnv
env@(TidyOccEnv
tidy_env, VarEnv CoreBndr
var_env) CoreBndr
id
  = -- Do this pattern match strictly, otherwise we end up holding on to
    -- stuff in the OccName.
    case TidyOccEnv -> OccName -> (TidyOccEnv, OccName)
tidyOccName TidyOccEnv
tidy_env (CoreBndr -> OccName
forall a. NamedThing a => a -> OccName
getOccName CoreBndr
id) of { (TidyOccEnv
tidy_env', OccName
occ') ->
    let
        -- Give the Id a fresh print-name, *and* rename its type
        -- The SrcLoc isn't important now,
        -- though we could extract it from the Id
        --
        ty' :: Type
ty'      = TidyEnv -> Type -> Type
tidyType TidyEnv
env (CoreBndr -> Type
idType CoreBndr
id)
        mult' :: Type
mult'    = TidyEnv -> Type -> Type
tidyType TidyEnv
env (CoreBndr -> Type
idMult CoreBndr
id)
        name' :: Name
name'    = Unique -> OccName -> SrcSpan -> Name
mkInternalName (CoreBndr -> Unique
idUnique CoreBndr
id) OccName
occ' SrcSpan
noSrcSpan
        id' :: CoreBndr
id'      = HasDebugCallStack => Name -> Type -> Type -> IdInfo -> CoreBndr
Name -> Type -> Type -> IdInfo -> CoreBndr
mkLocalIdWithInfo Name
name' Type
mult' Type
ty' IdInfo
new_info
        var_env' :: VarEnv CoreBndr
var_env' = VarEnv CoreBndr -> CoreBndr -> CoreBndr -> VarEnv CoreBndr
forall a. VarEnv a -> CoreBndr -> a -> VarEnv a
extendVarEnv VarEnv CoreBndr
var_env CoreBndr
id CoreBndr
id'

        -- Note [Tidy IdInfo]
        new_info :: IdInfo
new_info = IdInfo
vanillaIdInfo IdInfo -> OccInfo -> IdInfo
`setOccInfo` IdInfo -> OccInfo
occInfo IdInfo
old_info
                                 IdInfo -> Unfolding -> IdInfo
`setUnfoldingInfo` Unfolding
new_unf
                                  -- see Note [Preserve OneShotInfo]
                                 IdInfo -> OneShotInfo -> IdInfo
`setOneShotInfo` IdInfo -> OneShotInfo
oneShotInfo IdInfo
old_info
        old_info :: IdInfo
old_info = HasDebugCallStack => CoreBndr -> IdInfo
CoreBndr -> IdInfo
idInfo CoreBndr
id
        old_unf :: Unfolding
old_unf  = IdInfo -> Unfolding
realUnfoldingInfo IdInfo
old_info
        new_unf :: Unfolding
new_unf  = Unfolding -> Unfolding
zapUnfolding Unfolding
old_unf  -- See Note [Preserve evaluatedness]
    in
    ((TidyOccEnv
tidy_env', VarEnv CoreBndr
var_env'), CoreBndr
id')
   }

tidyLetBndr :: TidyEnv         -- Knot-tied version for unfoldings
            -> TidyEnv         -- The one to extend
            -> Id -> (TidyEnv, Id)
-- Used for local (non-top-level) let(rec)s
-- Just like tidyIdBndr above, but with more IdInfo
tidyLetBndr :: TidyEnv -> TidyEnv -> CoreBndr -> (TidyEnv, CoreBndr)
tidyLetBndr TidyEnv
rec_tidy_env env :: TidyEnv
env@(TidyOccEnv
tidy_env, VarEnv CoreBndr
var_env) CoreBndr
id
  = case TidyOccEnv -> OccName -> (TidyOccEnv, OccName)
tidyOccName TidyOccEnv
tidy_env (CoreBndr -> OccName
forall a. NamedThing a => a -> OccName
getOccName CoreBndr
id) of { (TidyOccEnv
tidy_env', OccName
occ') ->
    let
        ty' :: Type
ty'      = TidyEnv -> Type -> Type
tidyType TidyEnv
env (CoreBndr -> Type
idType CoreBndr
id)
        mult' :: Type
mult'    = TidyEnv -> Type -> Type
tidyType TidyEnv
env (CoreBndr -> Type
idMult CoreBndr
id)
        name' :: Name
name'    = Unique -> OccName -> SrcSpan -> Name
mkInternalName (CoreBndr -> Unique
idUnique CoreBndr
id) OccName
occ' SrcSpan
noSrcSpan
        details :: IdDetails
details  = CoreBndr -> IdDetails
idDetails CoreBndr
id
        id' :: CoreBndr
id'      = IdDetails -> Name -> Type -> Type -> IdInfo -> CoreBndr
mkLocalVar IdDetails
details Name
name' Type
mult' Type
ty' IdInfo
new_info
        var_env' :: VarEnv CoreBndr
var_env' = VarEnv CoreBndr -> CoreBndr -> CoreBndr -> VarEnv CoreBndr
forall a. VarEnv a -> CoreBndr -> a -> VarEnv a
extendVarEnv VarEnv CoreBndr
var_env CoreBndr
id CoreBndr
id'

        -- Note [Tidy IdInfo]
        -- We need to keep around any interesting strictness and
        -- demand info because later on we may need to use it when
        -- converting to A-normal form.
        -- eg.
        --      f (g x),  where f is strict in its argument, will be converted
        --      into  case (g x) of z -> f z  by CorePrep, but only if f still
        --      has its strictness info.
        --
        -- Similarly for the demand info - on a let binder, this tells
        -- CorePrep to turn the let into a case.
        -- But: Remove the usage demand here
        --      (See Note [Zapping DmdEnv after Demand Analyzer] in GHC.Core.Opt.WorkWrap)
        --
        -- Similarly arity info for eta expansion in CorePrep
        -- Don't attempt to recompute arity here; this is just tidying!
        -- Trying to do so led to #17294
        --
        -- Set inline-prag info so that we preserve it across
        -- separate compilation boundaries
        old_info :: IdInfo
old_info = HasDebugCallStack => CoreBndr -> IdInfo
CoreBndr -> IdInfo
idInfo CoreBndr
id
        new_info :: IdInfo
new_info = IdInfo
vanillaIdInfo
                    IdInfo -> OccInfo -> IdInfo
`setOccInfo`        IdInfo -> OccInfo
occInfo IdInfo
old_info
                    IdInfo -> Int -> IdInfo
`setArityInfo`      IdInfo -> Int
arityInfo IdInfo
old_info
                    IdInfo -> DmdSig -> IdInfo
`setDmdSigInfo` DmdSig -> DmdSig
zapDmdEnvSig (IdInfo -> DmdSig
dmdSigInfo IdInfo
old_info)
                    IdInfo -> Demand -> IdInfo
`setDemandInfo`     IdInfo -> Demand
demandInfo IdInfo
old_info
                    IdInfo -> InlinePragma -> IdInfo
`setInlinePragInfo` IdInfo -> InlinePragma
inlinePragInfo IdInfo
old_info
                    IdInfo -> Unfolding -> IdInfo
`setUnfoldingInfo`  Unfolding
new_unf

        old_unf :: Unfolding
old_unf = IdInfo -> Unfolding
realUnfoldingInfo IdInfo
old_info
        new_unf :: Unfolding
new_unf | Unfolding -> Bool
isStableUnfolding Unfolding
old_unf = TidyEnv -> Unfolding -> Unfolding -> Unfolding
tidyUnfolding TidyEnv
rec_tidy_env Unfolding
old_unf Unfolding
old_unf
                | Bool
otherwise                 = Unfolding -> Unfolding
zapUnfolding Unfolding
old_unf
                                              -- See Note [Preserve evaluatedness]

    in
    ((TidyOccEnv
tidy_env', VarEnv CoreBndr
var_env'), CoreBndr
id') }

------------ Unfolding  --------------
tidyUnfolding :: TidyEnv -> Unfolding -> Unfolding -> Unfolding
tidyUnfolding :: TidyEnv -> Unfolding -> Unfolding -> Unfolding
tidyUnfolding TidyEnv
tidy_env df :: Unfolding
df@(DFunUnfolding { df_bndrs :: Unfolding -> [CoreBndr]
df_bndrs = [CoreBndr]
bndrs, df_args :: Unfolding -> [Expr CoreBndr]
df_args = [Expr CoreBndr]
args }) Unfolding
_
  = Unfolding
df { df_bndrs :: [CoreBndr]
df_bndrs = [CoreBndr]
bndrs', df_args :: [Expr CoreBndr]
df_args = (Expr CoreBndr -> Expr CoreBndr)
-> [Expr CoreBndr] -> [Expr CoreBndr]
forall a b. (a -> b) -> [a] -> [b]
map (TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
tidy_env') [Expr CoreBndr]
args }
  where
    (TidyEnv
tidy_env', [CoreBndr]
bndrs') = TidyEnv -> [CoreBndr] -> (TidyEnv, [CoreBndr])
tidyBndrs TidyEnv
tidy_env [CoreBndr]
bndrs

tidyUnfolding TidyEnv
tidy_env
              unf :: Unfolding
unf@(CoreUnfolding { uf_tmpl :: Unfolding -> Expr CoreBndr
uf_tmpl = Expr CoreBndr
unf_rhs, uf_src :: Unfolding -> UnfoldingSource
uf_src = UnfoldingSource
src })
              Unfolding
unf_from_rhs
  | UnfoldingSource -> Bool
isStableSource UnfoldingSource
src
  = Unfolding -> Unfolding
seqIt (Unfolding -> Unfolding) -> Unfolding -> Unfolding
forall a b. (a -> b) -> a -> b
$ Unfolding
unf { uf_tmpl :: Expr CoreBndr
uf_tmpl = TidyEnv -> Expr CoreBndr -> Expr CoreBndr
tidyExpr TidyEnv
tidy_env Expr CoreBndr
unf_rhs }    -- Preserves OccInfo
    -- This seqIt avoids a space leak: otherwise the uf_is_value,
    -- uf_is_conlike, ... fields may retain a reference to the
    -- pre-tidied expression forever (GHC.CoreToIface doesn't look at them)

  | Bool
otherwise
  = Unfolding
unf_from_rhs
  where seqIt :: Unfolding -> Unfolding
seqIt Unfolding
unf = Unfolding -> ()
seqUnfolding Unfolding
unf () -> Unfolding -> Unfolding
`seq` Unfolding
unf
tidyUnfolding TidyEnv
_ Unfolding
unf Unfolding
_ = Unfolding
unf     -- NoUnfolding or OtherCon

{-
Note [Tidy IdInfo]
~~~~~~~~~~~~~~~~~~
All nested Ids now have the same IdInfo, namely vanillaIdInfo, which
should save some space; except that we preserve occurrence info for
two reasons:

  (a) To make printing tidy core nicer

  (b) Because we tidy RULES and InlineRules, which may then propagate
      via --make into the compilation of the next module, and we want
      the benefit of that occurrence analysis when we use the rule or
      or inline the function.  In particular, it's vital not to lose
      loop-breaker info, else we get an infinite inlining loop

Note that tidyLetBndr puts more IdInfo back.

Note [Preserve evaluatedness]
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Consider
  data T = MkT !Bool
  ....(case v of MkT y ->
       let z# = case y of
                  True -> 1#
                  False -> 2#
       in ...)

The z# binding is ok because the RHS is ok-for-speculation,
but Lint will complain unless it can *see* that.  So we
preserve the evaluated-ness on 'y' in tidyBndr.

(Another alternative would be to tidy unboxed lets into cases,
but that seems more indirect and surprising.)

Note [Preserve OneShotInfo]
~~~~~~~~~~~~~~~~~~~~~~~~~~~
We keep the OneShotInfo because we want it to propagate into the interface.
Not all OneShotInfo is determined by a compiler analysis; some is added by a
call of GHC.Exts.oneShot, which is then discarded before the end of the
optimisation pipeline, leaving only the OneShotInfo on the lambda. Hence we
must preserve this info in inlinings. See Note [The oneShot function] in GHC.Types.Id.Make.

This applies to lambda binders only, hence it is stored in IfaceLamBndr.
-}

(=:) :: a -> (a -> b) -> b
a
m =: :: a -> (a -> b) -> b
=: a -> b
k = a
m a -> b -> b
`seq` a -> b
k a
m