compiler/simplCore/Simplify.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section[Simplify]{The main module of the simplifier}
   5
   6 \begin{code}
   7 module Simplify ( simplTopBinds, simplExpr ) where
   8
   9 #include "HsVersions.h"
  10
  11 import DynFlags ( dopt, DynFlag(Opt_D_dump_inlinings),
  12                           SimplifierSwitch(..)
  13                         )
  14 import SimplMonad
  15 import SimplEnv
  16 import SimplUtils       ( mkCase, mkLam,
  17                           SimplCont(..), DupFlag(..), LetRhsFlag(..),
  18                           mkRhsStop, mkBoringStop,  mkLazyArgStop, pushContArgs,
  19                           contResultType, countArgs, contIsDupable, contIsRhsOrArg,
  20                           getContArgs, interestingCallContext, interestingArg, isStrictType,
  21                           preInlineUnconditionally, postInlineUnconditionally,
  22                           interestingArgContext, inlineMode, activeInline, activeRule
  23                         )
  24 import Id               ( Id, idType, idInfo, idArity, isDataConWorkId,
  25                           idUnfolding, setIdUnfolding, isDeadBinder,
  26                           idNewDemandInfo, setIdInfo,
  27                           setIdOccInfo, zapLamIdInfo, setOneShotLambda
  28                         )
  29 import MkId             ( eRROR_ID )
  30 import Literal          ( mkStringLit )
  31 import IdInfo           ( OccInfo(..), isLoopBreaker,
  32                           setArityInfo, zapDemandInfo,
  33                           setUnfoldingInfo,
  34                           occInfo
  35                         )
  36 import NewDemand        ( isStrictDmd )
  37 import Unify            ( coreRefineTys, dataConCanMatch )
  38 import DataCon          ( DataCon, dataConTyCon, dataConRepStrictness, isVanillaDataCon,
  39                           dataConInstArgTys, dataConTyVars )
  40 import TyCon            ( tyConArity, isAlgTyCon, isNewTyCon, tyConDataCons_maybe )
  41 import CoreSyn
  42 import PprCore          ( pprParendExpr, pprCoreExpr )
  43 import CoreUnfold       ( mkUnfolding, callSiteInline )
  44 import CoreUtils        ( exprIsDupable, exprIsTrivial, needsCaseBinding,
  45                           exprIsConApp_maybe, mkPiTypes, findAlt,
  46                           exprType, exprIsHNF, findDefault, mergeAlts,
  47                           exprOkForSpeculation, exprArity,
  48                           mkCoerce, mkCoerce2, mkSCC, mkInlineMe, applyTypeToArg
  49                         )
  50 import Rules            ( lookupRule )
  51 import BasicTypes       ( isMarkedStrict )
  52 import CostCentre       ( currentCCS )
  53 import Type             ( TvSubstEnv, isUnLiftedType, seqType, tyConAppArgs, funArgTy,
  54                           splitFunTy_maybe, splitFunTy, coreEqType, splitTyConApp_maybe,
  55                           isTyVarTy, mkTyVarTys
  56                         )
  57 import Var              ( tyVarKind, mkTyVar )
  58 import VarEnv           ( elemVarEnv, emptyVarEnv )
  59 import TysPrim          ( realWorldStatePrimTy )
  60 import PrelInfo         ( realWorldPrimId )
  61 import BasicTypes       ( TopLevelFlag(..), isTopLevel,
  62                           RecFlag(..), isNonRec
  63                         )
  64 import Name             ( mkSysTvName )
  65 import StaticFlags      ( opt_PprStyle_Debug )
  66 import OrdList
  67 import List             ( nub )
  68 import Maybes           ( orElse )
  69 import Outputable
  70 import Util             ( notNull, filterOut )
  71 \end{code}
  72
  73
  74 The guts of the simplifier is in this module, but the driver loop for
  75 the simplifier is in SimplCore.lhs.
  76
  77
  78 -----------------------------------------
  79         *** IMPORTANT NOTE ***
  80 -----------------------------------------
  81 The simplifier used to guarantee that the output had no shadowing, but
  82 it does not do so any more.   (Actually, it never did!)  The reason is
  83 documented with simplifyArgs.
  84
  85
  86 -----------------------------------------
  87         *** IMPORTANT NOTE ***
  88 -----------------------------------------
  89 Many parts of the simplifier return a bunch of "floats" as well as an
  90 expression. This is wrapped as a datatype SimplUtils.FloatsWith.
  91
  92 All "floats" are let-binds, not case-binds, but some non-rec lets may
  93 be unlifted (with RHS ok-for-speculation).
  94
  95
  96
  97 -----------------------------------------
  98         ORGANISATION OF FUNCTIONS
  99 -----------------------------------------
 100 simplTopBinds
 101   - simplify all top-level binders
 102   - for NonRec, call simplRecOrTopPair
 103   - for Rec,    call simplRecBind
 104
 105
 106         ------------------------------
 107 simplExpr (applied lambda)      ==> simplNonRecBind
 108 simplExpr (Let (NonRec ...) ..) ==> simplNonRecBind
 109 simplExpr (Let (Rec ...)    ..) ==> simplify binders; simplRecBind
 110
 111         ------------------------------
 112 simplRecBind    [binders already simplfied]
 113   - use simplRecOrTopPair on each pair in turn
 114
 115 simplRecOrTopPair [binder already simplified]
 116   Used for: recursive bindings (top level and nested)
 117             top-level non-recursive bindings
 118   Returns:
 119   - check for PreInlineUnconditionally
 120   - simplLazyBind
 121
 122 simplNonRecBind
 123   Used for: non-top-level non-recursive bindings
 124             beta reductions (which amount to the same thing)
 125   Because it can deal with strict arts, it takes a
 126         "thing-inside" and returns an expression
 127
 128   - check for PreInlineUnconditionally
 129   - simplify binder, including its IdInfo
 130   - if strict binding
 131         simplStrictArg
 132         mkAtomicArgs
 133         completeNonRecX
 134     else
 135         simplLazyBind
 136         addFloats
 137
 138 simplNonRecX:   [given a *simplified* RHS, but an *unsimplified* binder]
 139   Used for: binding case-binder and constr args in a known-constructor case
 140   - check for PreInLineUnconditionally
 141   - simplify binder
 142   - completeNonRecX
 143
 144         ------------------------------
 145 simplLazyBind:  [binder already simplified, RHS not]
 146   Used for: recursive bindings (top level and nested)
 147             top-level non-recursive bindings
 148             non-top-level, but *lazy* non-recursive bindings
 149         [must not be strict or unboxed]
 150   Returns floats + an augmented environment, not an expression
 151   - substituteIdInfo and add result to in-scope
 152         [so that rules are available in rec rhs]
 153   - simplify rhs
 154   - mkAtomicArgs
 155   - float if exposes constructor or PAP
 156   - completeLazyBind
 157
 158
 159 completeNonRecX:        [binder and rhs both simplified]
 160   - if the the thing needs case binding (unlifted and not ok-for-spec)
 161         build a Case
 162    else
 163         completeLazyBind
 164         addFloats
 165
 166 completeLazyBind:       [given a simplified RHS]
 167         [used for both rec and non-rec bindings, top level and not]
 168   - try PostInlineUnconditionally
 169   - add unfolding [this is the only place we add an unfolding]
 170   - add arity
 171
 172
 173
 174 Right hand sides and arguments
 175 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 176 In many ways we want to treat
 177         (a) the right hand side of a let(rec), and
 178         (b) a function argument
 179 in the same way.  But not always!  In particular, we would
 180 like to leave these arguments exactly as they are, so they
 181 will match a RULE more easily.
 182
 183         f (g x, h x)
 184         g (+ x)
 185
 186 It's harder to make the rule match if we ANF-ise the constructor,
 187 or eta-expand the PAP:
 188
 189         f (let { a = g x; b = h x } in (a,b))
 190         g (\y. + x y)
 191
 192 On the other hand if we see the let-defns
 193
 194         p = (g x, h x)
 195         q = + x
 196
 197 then we *do* want to ANF-ise and eta-expand, so that p and q
 198 can be safely inlined.
 199
 200 Even floating lets out is a bit dubious.  For let RHS's we float lets
 201 out if that exposes a value, so that the value can be inlined more vigorously.
 202 For example
 203
 204         r = let x = e in (x,x)
 205
 206 Here, if we float the let out we'll expose a nice constructor. We did experiments
 207 that showed this to be a generally good thing.  But it was a bad thing to float
 208 lets out unconditionally, because that meant they got allocated more often.
 209
 210 For function arguments, there's less reason to expose a constructor (it won't
 211 get inlined).  Just possibly it might make a rule match, but I'm pretty skeptical.
 212 So for the moment we don't float lets out of function arguments either.
 213
 214
 215 Eta expansion
 216 ~~~~~~~~~~~~~~
 217 For eta expansion, we want to catch things like
 218
 219         case e of (a,b) -> \x -> case a of (p,q) -> \y -> r
 220
 221 If the \x was on the RHS of a let, we'd eta expand to bring the two
 222 lambdas together.  And in general that's a good thing to do.  Perhaps
 223 we should eta expand wherever we find a (value) lambda?  Then the eta
 224 expansion at a let RHS can concentrate solely on the PAP case.
 225
 226
 227 %************************************************************************
 228 %*                                                                      *
 229 \subsection{Bindings}
 230 %*                                                                      *
 231 %************************************************************************
 232
 233 \begin{code}
 234 simplTopBinds :: SimplEnv -> [InBind] -> SimplM [OutBind]
 235
 236 simplTopBinds env binds
 237   =     -- Put all the top-level binders into scope at the start
 238         -- so that if a transformation rule has unexpectedly brought
 239         -- anything into scope, then we don't get a complaint about that.
 240         -- It's rather as if the top-level binders were imported.
 241     simplRecBndrs env (bindersOfBinds binds)    `thenSmpl` \ (env, bndrs') ->
 242     simpl_binds env binds bndrs'                `thenSmpl` \ (floats, _) ->
 243     freeTick SimplifierDone                     `thenSmpl_`
 244     returnSmpl (floatBinds floats)
 245   where
 246         -- We need to track the zapped top-level binders, because
 247         -- they should have their fragile IdInfo zapped (notably occurrence info)
 248         -- That's why we run down binds and bndrs' simultaneously.
 249     simpl_binds :: SimplEnv -> [InBind] -> [OutId] -> SimplM (FloatsWith ())
 250     simpl_binds env []           bs = ASSERT( null bs ) returnSmpl (emptyFloats env, ())
 251     simpl_binds env (bind:binds) bs = simpl_bind env bind bs            `thenSmpl` \ (floats,env) ->
 252                                       addFloats env floats              $ \env ->
 253                                       simpl_binds env binds (drop_bs bind bs)
 254
 255     drop_bs (NonRec _ _) (_ : bs) = bs
 256     drop_bs (Rec prs)    bs       = drop (length prs) bs
 257
 258     simpl_bind env bind bs
 259       = getDOptsSmpl                            `thenSmpl` \ dflags ->
 260         if dopt Opt_D_dump_inlinings dflags then
 261            pprTrace "SimplBind" (ppr (bindersOf bind)) $ simpl_bind1 env bind bs
 262         else
 263            simpl_bind1 env bind bs
 264
 265     simpl_bind1 env (NonRec b r) (b':_) = simplRecOrTopPair env TopLevel b b' r
 266     simpl_bind1 env (Rec pairs)  bs'    = simplRecBind      env TopLevel pairs bs'
 267 \end{code}
 268
 269
 270 %************************************************************************
 271 %*                                                                      *
 272 \subsection{simplNonRec}
 273 %*                                                                      *
 274 %************************************************************************
 275
 276 simplNonRecBind is used for
 277   * non-top-level non-recursive lets in expressions
 278   * beta reduction
 279
 280 It takes
 281   * An unsimplified (binder, rhs) pair
 282   * The env for the RHS.  It may not be the same as the
 283         current env because the bind might occur via (\x.E) arg
 284
 285 It uses the CPS form because the binding might be strict, in which
 286 case we might discard the continuation:
 287         let x* = error "foo" in (...x...)
 288
 289 It needs to turn unlifted bindings into a @case@.  They can arise
 290 from, say:      (\x -> e) (4# + 3#)
 291
 292 \begin{code}
 293 simplNonRecBind :: SimplEnv
 294                 -> InId                                 -- Binder
 295                 -> InExpr -> SimplEnv                   -- Arg, with its subst-env
 296                 -> OutType                              -- Type of thing computed by the context
 297                 -> (SimplEnv -> SimplM FloatsWithExpr)  -- The body
 298                 -> SimplM FloatsWithExpr
 299 #ifdef DEBUG
 300 simplNonRecBind env bndr rhs rhs_se cont_ty thing_inside
 301   | isTyVar bndr
 302   = pprPanic "simplNonRecBind" (ppr bndr <+> ppr rhs)
 303 #endif
 304
 305 simplNonRecBind env bndr rhs rhs_se cont_ty thing_inside
 306   = simplNonRecBind' env bndr rhs rhs_se cont_ty thing_inside
 307
 308 simplNonRecBind' env bndr rhs rhs_se cont_ty thing_inside
 309   | preInlineUnconditionally env NotTopLevel bndr rhs
 310   = tick (PreInlineUnconditionally bndr)                `thenSmpl_`
 311     thing_inside (extendIdSubst env bndr (mkContEx rhs_se rhs))
 312
 313   | isStrictDmd (idNewDemandInfo bndr) || isStrictType bndr_ty  -- A strict let
 314   =     -- Don't use simplBinder because that doesn't keep
 315         -- fragile occurrence info in the substitution
 316     simplNonRecBndr env bndr                                    `thenSmpl` \ (env, bndr1) ->
 317     simplStrictArg AnRhs env rhs rhs_se (idType bndr1) cont_ty  $ \ env1 rhs1 ->
 318
 319         -- Now complete the binding and simplify the body
 320     let
 321         (env2,bndr2) = addLetIdInfo env1 bndr bndr1
 322     in
 323     if needsCaseBinding bndr_ty rhs1
 324     then
 325       thing_inside env2                                 `thenSmpl` \ (floats, body) ->
 326       returnSmpl (emptyFloats env2, Case rhs1 bndr2 (exprType body)
 327                                         [(DEFAULT, [], wrapFloats floats body)])
 328     else
 329       completeNonRecX env2 True {- strict -} bndr bndr2 rhs1 thing_inside
 330
 331   | otherwise                                                   -- Normal, lazy case
 332   =     -- Don't use simplBinder because that doesn't keep
 333         -- fragile occurrence info in the substitution
 334     simplNonRecBndr env bndr                            `thenSmpl` \ (env, bndr') ->
 335     simplLazyBind env NotTopLevel NonRecursive
 336                   bndr bndr' rhs rhs_se                 `thenSmpl` \ (floats, env) ->
 337     addFloats env floats thing_inside
 338
 339   where
 340     bndr_ty = idType bndr
 341 \end{code}
 342
 343 A specialised variant of simplNonRec used when the RHS is already simplified, notably
 344 in knownCon.  It uses case-binding where necessary.
 345
 346 \begin{code}
 347 simplNonRecX :: SimplEnv
 348              -> InId            -- Old binder
 349              -> OutExpr         -- Simplified RHS
 350              -> (SimplEnv -> SimplM FloatsWithExpr)
 351              -> SimplM FloatsWithExpr
 352
 353 simplNonRecX env bndr new_rhs thing_inside
 354   | needsCaseBinding (idType bndr) new_rhs
 355         -- Make this test *before* the preInlineUnconditionally
 356         -- Consider     case I# (quotInt# x y) of
 357         --                I# v -> let w = J# v in ...
 358         -- If we gaily inline (quotInt# x y) for v, we end up building an
 359         -- extra thunk:
 360         --                let w = J# (quotInt# x y) in ...
 361         -- because quotInt# can fail.
 362   = simplBinder env bndr        `thenSmpl` \ (env, bndr') ->
 363     thing_inside env            `thenSmpl` \ (floats, body) ->
 364     let body' = wrapFloats floats body in
 365     returnSmpl (emptyFloats env, Case new_rhs bndr' (exprType body') [(DEFAULT, [], body')])
 366
 367 {- No, no, no!  Do not try preInlineUnconditionally
 368   | preInlineUnconditionally env NotTopLevel bndr new_rhs
 369         -- This happens; for example, the case_bndr during case of
 370         -- known constructor:  case (a,b) of x { (p,q) -> ... }
 371         -- Here x isn't mentioned in the RHS, so we don't want to
 372         -- create the (dead) let-binding  let x = (a,b) in ...
 373         --
 374         -- Similarly, single occurrences can be inlined vigourously
 375         -- e.g.  case (f x, g y) of (a,b) -> ....
 376         -- If a,b occur once we can avoid constructing the let binding for them.
 377   = thing_inside (extendIdSubst env bndr (DoneEx new_rhs))
 378 -}
 379
 380   | otherwise
 381   = simplBinder env bndr        `thenSmpl` \ (env, bndr') ->
 382     completeNonRecX env False {- Non-strict; pessimistic -}
 383                     bndr bndr' new_rhs thing_inside
 384
 385 completeNonRecX env is_strict old_bndr new_bndr new_rhs thing_inside
 386   = mkAtomicArgs is_strict
 387                  True {- OK to float unlifted -}
 388                  new_rhs                        `thenSmpl` \ (aux_binds, rhs2) ->
 389
 390         -- Make the arguments atomic if necessary,
 391         -- adding suitable bindings
 392     addAtomicBindsE env (fromOL aux_binds)      $ \ env ->
 393     completeLazyBind env NotTopLevel
 394                      old_bndr new_bndr rhs2     `thenSmpl` \ (floats, env) ->
 395     addFloats env floats thing_inside
 396 \end{code}
 397
 398
 399 %************************************************************************
 400 %*                                                                      *
 401 \subsection{Lazy bindings}
 402 %*                                                                      *
 403 %************************************************************************
 404
 405 simplRecBind is used for
 406         * recursive bindings only
 407
 408 \begin{code}
 409 simplRecBind :: SimplEnv -> TopLevelFlag
 410              -> [(InId, InExpr)] -> [OutId]
 411              -> SimplM (FloatsWith SimplEnv)
 412 simplRecBind env top_lvl pairs bndrs'
 413   = go env pairs bndrs'         `thenSmpl` \ (floats, env) ->
 414     returnSmpl (flattenFloats floats, env)
 415   where
 416     go env [] _ = returnSmpl (emptyFloats env, env)
 417
 418     go env ((bndr, rhs) : pairs) (bndr' : bndrs')
 419         = simplRecOrTopPair env top_lvl bndr bndr' rhs  `thenSmpl` \ (floats, env) ->
 420           addFloats env floats (\env -> go env pairs bndrs')
 421 \end{code}
 422
 423
 424 simplRecOrTopPair is used for
 425         * recursive bindings (whether top level or not)
 426         * top-level non-recursive bindings
 427
 428 It assumes the binder has already been simplified, but not its IdInfo.
 429
 430 \begin{code}
 431 simplRecOrTopPair :: SimplEnv
 432                   -> TopLevelFlag
 433                   -> InId -> OutId              -- Binder, both pre-and post simpl
 434                   -> InExpr                     -- The RHS and its environment
 435                   -> SimplM (FloatsWith SimplEnv)
 436
 437 simplRecOrTopPair env top_lvl bndr bndr' rhs
 438   | preInlineUnconditionally env top_lvl bndr rhs       -- Check for unconditional inline
 439   = tick (PreInlineUnconditionally bndr)                `thenSmpl_`
 440     returnSmpl (emptyFloats env, extendIdSubst env bndr (mkContEx env rhs))
 441
 442   | otherwise
 443   = simplLazyBind env top_lvl Recursive bndr bndr' rhs env
 444         -- May not actually be recursive, but it doesn't matter
 445 \end{code}
 446
 447
 448 simplLazyBind is used for
 449         * recursive bindings (whether top level or not)
 450         * top-level non-recursive bindings
 451         * non-top-level *lazy* non-recursive bindings
 452
 453 [Thus it deals with the lazy cases from simplNonRecBind, and all cases
 454 from SimplRecOrTopBind]
 455
 456 Nota bene:
 457     1. It assumes that the binder is *already* simplified,
 458        and is in scope, but not its IdInfo
 459
 460     2. It assumes that the binder type is lifted.
 461
 462     3. It does not check for pre-inline-unconditionallly;
 463        that should have been done already.
 464
 465 \begin{code}
 466 simplLazyBind :: SimplEnv
 467               -> TopLevelFlag -> RecFlag
 468               -> InId -> OutId          -- Binder, both pre-and post simpl
 469               -> InExpr -> SimplEnv     -- The RHS and its environment
 470               -> SimplM (FloatsWith SimplEnv)
 471
 472 simplLazyBind env top_lvl is_rec bndr bndr1 rhs rhs_se
 473   = let
 474         (env1,bndr2)      = addLetIdInfo env bndr bndr1
 475         rhs_env           = setInScope rhs_se env1
 476         is_top_level      = isTopLevel top_lvl
 477         ok_float_unlifted = not is_top_level && isNonRec is_rec
 478         rhs_cont          = mkRhsStop (idType bndr2)
 479     in
 480         -- Simplify the RHS; note the mkRhsStop, which tells
 481         -- the simplifier that this is the RHS of a let.
 482     simplExprF rhs_env rhs rhs_cont             `thenSmpl` \ (floats, rhs1) ->
 483
 484         -- If any of the floats can't be floated, give up now
 485         -- (The allLifted predicate says True for empty floats.)
 486     if (not ok_float_unlifted && not (allLifted floats)) then
 487         completeLazyBind env1 top_lvl bndr bndr2
 488                          (wrapFloats floats rhs1)
 489     else
 490
 491         -- ANF-ise a constructor or PAP rhs
 492     mkAtomicArgs False {- Not strict -}
 493                  ok_float_unlifted rhs1                 `thenSmpl` \ (aux_binds, rhs2) ->
 494
 495         -- If the result is a PAP, float the floats out, else wrap them
 496         -- By this time it's already been ANF-ised (if necessary)
 497     if isEmptyFloats floats && isNilOL aux_binds then   -- Shortcut a common case
 498         completeLazyBind env1 top_lvl bndr bndr2 rhs2
 499
 500     else if is_top_level || exprIsTrivial rhs2 || exprIsHNF rhs2 then
 501         --      WARNING: long dodgy argument coming up
 502         --      WANTED: a better way to do this
 503         --
 504         -- We can't use "exprIsCheap" instead of exprIsHNF,
 505         -- because that causes a strictness bug.
 506         --         x = let y* = E in case (scc y) of { T -> F; F -> T}
 507         -- The case expression is 'cheap', but it's wrong to transform to
 508         --         y* = E; x = case (scc y) of {...}
 509         -- Either we must be careful not to float demanded non-values, or
 510         -- we must use exprIsHNF for the test, which ensures that the
 511         -- thing is non-strict.  So exprIsHNF => bindings are non-strict
 512         -- I think.  The WARN below tests for this.
 513         --
 514         -- We use exprIsTrivial here because we want to reveal lone variables.
 515         -- E.g.  let { x = letrec { y = E } in y } in ...
 516         -- Here we definitely want to float the y=E defn.
 517         -- exprIsHNF definitely isn't right for that.
 518         --
 519         -- Again, the floated binding can't be strict; if it's recursive it'll
 520         -- be non-strict; if it's non-recursive it'd be inlined.
 521         --
 522         -- Note [SCC-and-exprIsTrivial]
 523         -- If we have
 524         --      y = let { x* = E } in scc "foo" x
 525         -- then we do *not* want to float out the x binding, because
 526         -- it's strict!  Fortunately, exprIsTrivial replies False to
 527         -- (scc "foo" x).
 528
 529                 -- There's a subtlety here.  There may be a binding (x* = e) in the
 530                 -- floats, where the '*' means 'will be demanded'.  So is it safe
 531                 -- to float it out?  Answer no, but it won't matter because
 532                 -- we only float if (a) arg' is a WHNF, or (b) it's going to top level
 533                 -- and so there can't be any 'will be demanded' bindings in the floats.
 534                 -- Hence the warning
 535         ASSERT2( is_top_level || not (any demanded_float (floatBinds floats)),
 536                  ppr (filter demanded_float (floatBinds floats)) )
 537
 538         tick LetFloatFromLet                    `thenSmpl_` (
 539         addFloats env1 floats                   $ \ env2 ->
 540         addAtomicBinds env2 (fromOL aux_binds)  $ \ env3 ->
 541         completeLazyBind env3 top_lvl bndr bndr2 rhs2)
 542
 543     else
 544         completeLazyBind env1 top_lvl bndr bndr2 (wrapFloats floats rhs1)
 545
 546 #ifdef DEBUG
 547 demanded_float (NonRec b r) = isStrictDmd (idNewDemandInfo b) && not (isUnLiftedType (idType b))
 548                 -- Unlifted-type (cheap-eagerness) lets may well have a demanded flag on them
 549 demanded_float (Rec _)      = False
 550 #endif
 551 \end{code}
 552
 553
 554 %************************************************************************
 555 %*                                                                      *
 556 \subsection{Completing a lazy binding}
 557 %*                                                                      *
 558 %************************************************************************
 559
 560 completeLazyBind
 561         * deals only with Ids, not TyVars
 562         * takes an already-simplified binder and RHS
 563         * is used for both recursive and non-recursive bindings
 564         * is used for both top-level and non-top-level bindings
 565
 566 It does the following:
 567   - tries discarding a dead binding
 568   - tries PostInlineUnconditionally
 569   - add unfolding [this is the only place we add an unfolding]
 570   - add arity
 571
 572 It does *not* attempt to do let-to-case.  Why?  Because it is used for
 573         - top-level bindings (when let-to-case is impossible)
 574         - many situations where the "rhs" is known to be a WHNF
 575                 (so let-to-case is inappropriate).
 576
 577 \begin{code}
 578 completeLazyBind :: SimplEnv
 579                  -> TopLevelFlag        -- Flag stuck into unfolding
 580                  -> InId                -- Old binder
 581                  -> OutId               -- New binder
 582                  -> OutExpr             -- Simplified RHS
 583                  -> SimplM (FloatsWith SimplEnv)
 584 -- We return a new SimplEnv, because completeLazyBind may choose to do its work
 585 -- by extending the substitution (e.g. let x = y in ...)
 586 -- The new binding (if any) is returned as part of the floats.
 587 -- NB: the returned SimplEnv has the right SubstEnv, but you should
 588 --     (as usual) use the in-scope-env from the floats
 589
 590 completeLazyBind env top_lvl old_bndr new_bndr new_rhs
 591   | postInlineUnconditionally env top_lvl new_bndr occ_info new_rhs unfolding
 592   =             -- Drop the binding
 593     tick (PostInlineUnconditionally old_bndr)   `thenSmpl_`
 594     returnSmpl (emptyFloats env, extendIdSubst env old_bndr (DoneEx new_rhs))
 595                 -- Use the substitution to make quite, quite sure that the substitution
 596                 -- will happen, since we are going to discard the binding
 597
 598   |  otherwise
 599   = let
 600                 -- Add arity info
 601         new_bndr_info = idInfo new_bndr `setArityInfo` exprArity new_rhs
 602
 603         -- Add the unfolding *only* for non-loop-breakers
 604         -- Making loop breakers not have an unfolding at all
 605         -- means that we can avoid tests in exprIsConApp, for example.
 606         -- This is important: if exprIsConApp says 'yes' for a recursive
 607         -- thing, then we can get into an infinite loop
 608
 609         -- If the unfolding is a value, the demand info may
 610         -- go pear-shaped, so we nuke it.  Example:
 611         --      let x = (a,b) in
 612         --      case x of (p,q) -> h p q x
 613         -- Here x is certainly demanded. But after we've nuked
 614         -- the case, we'll get just
 615         --      let x = (a,b) in h a b x
 616         -- and now x is not demanded (I'm assuming h is lazy)
 617         -- This really happens.  Similarly
 618         --      let f = \x -> e in ...f..f...
 619         -- After inling f at some of its call sites the original binding may
 620         -- (for example) be no longer strictly demanded.
 621         -- The solution here is a bit ad hoc...
 622         info_w_unf = new_bndr_info `setUnfoldingInfo` unfolding
 623         final_info | loop_breaker               = new_bndr_info
 624                    | isEvaldUnfolding unfolding = zapDemandInfo info_w_unf `orElse` info_w_unf
 625                    | otherwise                  = info_w_unf
 626
 627         final_id = new_bndr `setIdInfo` final_info
 628     in
 629                 -- These seqs forces the Id, and hence its IdInfo,
 630                 -- and hence any inner substitutions
 631     final_id                                    `seq`
 632     returnSmpl (unitFloat env final_id new_rhs, env)
 633
 634   where
 635     unfolding    = mkUnfolding (isTopLevel top_lvl) new_rhs
 636     loop_breaker = isLoopBreaker occ_info
 637     old_info     = idInfo old_bndr
 638     occ_info     = occInfo old_info
 639 \end{code}
 640
 641
 642
 643 %************************************************************************
 644 %*                                                                      *
 645 \subsection[Simplify-simplExpr]{The main function: simplExpr}
 646 %*                                                                      *
 647 %************************************************************************
 648
 649 The reason for this OutExprStuff stuff is that we want to float *after*
 650 simplifying a RHS, not before.  If we do so naively we get quadratic
 651 behaviour as things float out.
 652
 653 To see why it's important to do it after, consider this (real) example:
 654
 655         let t = f x
 656         in fst t
 657 ==>
 658         let t = let a = e1
 659                     b = e2
 660                 in (a,b)
 661         in fst t
 662 ==>
 663         let a = e1
 664             b = e2
 665             t = (a,b)
 666         in
 667         a       -- Can't inline a this round, cos it appears twice
 668 ==>
 669         e1
 670
 671 Each of the ==> steps is a round of simplification.  We'd save a
 672 whole round if we float first.  This can cascade.  Consider
 673
 674         let f = g d
 675         in \x -> ...f...
 676 ==>
 677         let f = let d1 = ..d.. in \y -> e
 678         in \x -> ...f...
 679 ==>
 680         let d1 = ..d..
 681         in \x -> ...(\y ->e)...
 682
 683 Only in this second round can the \y be applied, and it
 684 might do the same again.
 685
 686
 687 \begin{code}
 688 simplExpr :: SimplEnv -> CoreExpr -> SimplM CoreExpr
 689 simplExpr env expr = simplExprC env expr (mkBoringStop expr_ty')
 690                    where
 691                      expr_ty' = substTy env (exprType expr)
 692         -- The type in the Stop continuation, expr_ty', is usually not used
 693         -- It's only needed when discarding continuations after finding
 694         -- a function that returns bottom.
 695         -- Hence the lazy substitution
 696
 697
 698 simplExprC :: SimplEnv -> CoreExpr -> SimplCont -> SimplM CoreExpr
 699         -- Simplify an expression, given a continuation
 700 simplExprC env expr cont
 701   = simplExprF env expr cont    `thenSmpl` \ (floats, expr) ->
 702     returnSmpl (wrapFloats floats expr)
 703
 704 simplExprF :: SimplEnv -> InExpr -> SimplCont -> SimplM FloatsWithExpr
 705         -- Simplify an expression, returning floated binds
 706
 707 simplExprF env (Var v)          cont = simplVar env v cont
 708 simplExprF env (Lit lit)        cont = rebuild env (Lit lit) cont
 709 simplExprF env expr@(Lam _ _)   cont = simplLam env expr cont
 710 simplExprF env (Note note expr) cont = simplNote env note expr cont
 711 simplExprF env (App fun arg)    cont = simplExprF env fun (ApplyTo NoDup arg (Just env) cont)
 712
 713 simplExprF env (Type ty) cont
 714   = ASSERT( contIsRhsOrArg cont )
 715     simplType env ty                    `thenSmpl` \ ty' ->
 716     rebuild env (Type ty') cont
 717
 718 simplExprF env (Case scrut bndr case_ty alts) cont
 719   | not (switchIsOn (getSwitchChecker env) NoCaseOfCase)
 720   =     -- Simplify the scrutinee with a Select continuation
 721     simplExprF env scrut (Select NoDup bndr alts env cont)
 722
 723   | otherwise
 724   =     -- If case-of-case is off, simply simplify the case expression
 725         -- in a vanilla Stop context, and rebuild the result around it
 726     simplExprC env scrut case_cont      `thenSmpl` \ case_expr' ->
 727     rebuild env case_expr' cont
 728   where
 729     case_cont = Select NoDup bndr alts env (mkBoringStop case_ty')
 730     case_ty'  = substTy env case_ty     -- c.f. defn of simplExpr
 731
 732 simplExprF env (Let (Rec pairs) body) cont
 733   = simplRecBndrs env (map fst pairs)           `thenSmpl` \ (env, bndrs') ->
 734         -- NB: bndrs' don't have unfoldings or rules
 735         -- We add them as we go down
 736
 737     simplRecBind env NotTopLevel pairs bndrs'   `thenSmpl` \ (floats, env) ->
 738     addFloats env floats                        $ \ env ->
 739     simplExprF env body cont
 740
 741 -- A non-recursive let is dealt with by simplNonRecBind
 742 simplExprF env (Let (NonRec bndr rhs) body) cont
 743   = simplNonRecBind env bndr rhs env (contResultType cont)      $ \ env ->
 744     simplExprF env body cont
 745
 746
 747 ---------------------------------
 748 simplType :: SimplEnv -> InType -> SimplM OutType
 749         -- Kept monadic just so we can do the seqType
 750 simplType env ty
 751   = seqType new_ty   `seq`   returnSmpl new_ty
 752   where
 753     new_ty = substTy env ty
 754 \end{code}
 755
 756
 757 %************************************************************************
 758 %*                                                                      *
 759 \subsection{Lambdas}
 760 %*                                                                      *
 761 %************************************************************************
 762
 763 \begin{code}
 764 simplLam env fun cont
 765   = go env fun cont
 766   where
 767     zap_it  = mkLamBndrZapper fun (countArgs cont)
 768     cont_ty = contResultType cont
 769
 770         -- Type-beta reduction
 771     go env (Lam bndr body) (ApplyTo _ (Type ty_arg) mb_arg_se body_cont)
 772       = ASSERT( isTyVar bndr )
 773         do { tick (BetaReduction bndr)
 774            ; ty_arg' <- case mb_arg_se of
 775                           Just arg_se -> simplType (setInScope arg_se env) ty_arg
 776                           Nothing     -> return ty_arg
 777            ; go (extendTvSubst env bndr ty_arg') body body_cont }
 778
 779         -- Ordinary beta reduction
 780     go env (Lam bndr body) cont@(ApplyTo _ arg (Just arg_se) body_cont)
 781       = do { tick (BetaReduction bndr)
 782            ; simplNonRecBind env (zap_it bndr) arg arg_se cont_ty       $ \ env ->
 783              go env body body_cont }
 784
 785     go env (Lam bndr body) cont@(ApplyTo _ arg Nothing body_cont)
 786       = do { tick (BetaReduction bndr)
 787            ; simplNonRecX env (zap_it bndr) arg         $ \ env ->
 788              go env body body_cont }
 789
 790         -- Not enough args, so there are real lambdas left to put in the result
 791     go env lam@(Lam _ _) cont
 792       = do { (env, bndrs') <- simplLamBndrs env bndrs
 793            ; body' <- simplExpr env body
 794            ; (floats, new_lam) <- mkLam env bndrs' body' cont
 795            ; addFloats env floats               $ \ env ->
 796              rebuild env new_lam cont }
 797       where
 798         (bndrs,body) = collectBinders lam
 799
 800         -- Exactly enough args
 801     go env expr cont = simplExprF env expr cont
 802
 803 mkLamBndrZapper :: CoreExpr     -- Function
 804                 -> Int          -- Number of args supplied, *including* type args
 805                 -> Id -> Id     -- Use this to zap the binders
 806 mkLamBndrZapper fun n_args
 807   | n_args >= n_params fun = \b -> b            -- Enough args
 808   | otherwise              = \b -> zapLamIdInfo b
 809   where
 810         -- NB: we count all the args incl type args
 811         -- so we must count all the binders (incl type lambdas)
 812     n_params (Note _ e) = n_params e
 813     n_params (Lam b e)  = 1 + n_params e
 814     n_params other      = 0::Int
 815 \end{code}
 816
 817
 818 %************************************************************************
 819 %*                                                                      *
 820 \subsection{Notes}
 821 %*                                                                      *
 822 %************************************************************************
 823
 824 \begin{code}
 825 simplNote env (Coerce to from) body cont
 826   = let
 827         addCoerce s1 k1 cont    -- Drop redundant coerces.  This can happen if a polymoprhic
 828                                 -- (coerce a b e) is instantiated with a=ty1 b=ty2 and the
 829                                 -- two are the same. This happens a lot in Happy-generated parsers
 830           | s1 `coreEqType` k1 = cont
 831
 832         addCoerce s1 k1 (CoerceIt t1 cont)
 833                 --      coerce T1 S1 (coerce S1 K1 e)
 834                 -- ==>
 835                 --      e,                      if T1=K1
 836                 --      coerce T1 K1 e,         otherwise
 837                 --
 838                 -- For example, in the initial form of a worker
 839                 -- we may find  (coerce T (coerce S (\x.e))) y
 840                 -- and we'd like it to simplify to e[y/x] in one round
 841                 -- of simplification
 842           | t1 `coreEqType` k1  = cont                  -- The coerces cancel out
 843           | otherwise           = CoerceIt t1 cont      -- They don't cancel, but
 844                                                         -- the inner one is redundant
 845
 846         addCoerce t1t2 s1s2 (ApplyTo dup arg mb_arg_se cont)
 847           | not (isTypeArg arg),        -- This whole case only works for value args
 848                                         -- Could upgrade to have equiv thing for type apps too
 849             Just (s1, s2) <- splitFunTy_maybe s1s2
 850                 --      (coerce (T1->T2) (S1->S2) F) E
 851                 -- ===>
 852                 --      coerce T2 S2 (F (coerce S1 T1 E))
 853                 --
 854                 -- t1t2 must be a function type, T1->T2, because it's applied to something
 855                 -- but s1s2 might conceivably not be
 856                 --
 857                 -- When we build the ApplyTo we can't mix the out-types
 858                 -- with the InExpr in the argument, so we simply substitute
 859                 -- to make it all consistent.  It's a bit messy.
 860                 -- But it isn't a common case.
 861           = let
 862                 (t1,t2) = splitFunTy t1t2
 863                 new_arg = mkCoerce2 s1 t1 arg'
 864                 arg' = case mb_arg_se of
 865                           Nothing -> arg
 866                           Just arg_se -> substExpr (setInScope arg_se env) arg
 867             in
 868             ApplyTo dup new_arg Nothing (addCoerce t2 s2 cont)
 869
 870         addCoerce to' _ cont = CoerceIt to' cont
 871     in
 872     simplType env to            `thenSmpl` \ to' ->
 873     simplType env from          `thenSmpl` \ from' ->
 874     simplExprF env body (addCoerce to' from' cont)
 875
 876
 877 -- Hack: we only distinguish subsumed cost centre stacks for the purposes of
 878 -- inlining.  All other CCCSs are mapped to currentCCS.
 879 simplNote env (SCC cc) e cont
 880   = simplExpr (setEnclosingCC env currentCCS) e         `thenSmpl` \ e' ->
 881     rebuild env (mkSCC cc e') cont
 882
 883 -- See notes with SimplMonad.inlineMode
 884 simplNote env InlineMe e cont
 885   | contIsRhsOrArg cont         -- Totally boring continuation; see notes above
 886   =                             -- Don't inline inside an INLINE expression
 887     simplExpr (setMode inlineMode env )  e      `thenSmpl` \ e' ->
 888     rebuild env (mkInlineMe e') cont
 889
 890   | otherwise   -- Dissolve the InlineMe note if there's
 891                 -- an interesting context of any kind to combine with
 892                 -- (even a type application -- anything except Stop)
 893   = simplExprF env e cont
 894
 895 simplNote env (CoreNote s) e cont
 896   = simplExpr env e    `thenSmpl` \ e' ->
 897     rebuild env (Note (CoreNote s) e') cont
 898 \end{code}
 899
 900
 901 %************************************************************************
 902 %*                                                                      *
 903 \subsection{Dealing with calls}
 904 %*                                                                      *
 905 %************************************************************************
 906
 907 \begin{code}
 908 simplVar env var cont
 909   = case substId env var of
 910         DoneEx e         -> simplExprF (zapSubstEnv env) e cont
 911         ContEx tvs ids e -> simplExprF (setSubstEnv env tvs ids) e cont
 912         DoneId var1 occ  -> completeCall (zapSubstEnv env) var1 occ cont
 913                 -- Note [zapSubstEnv]
 914                 -- The template is already simplified, so don't re-substitute.
 915                 -- This is VITAL.  Consider
 916                 --      let x = e in
 917                 --      let y = \z -> ...x... in
 918                 --      \ x -> ...y...
 919                 -- We'll clone the inner \x, adding x->x' in the id_subst
 920                 -- Then when we inline y, we must *not* replace x by x' in
 921                 -- the inlined copy!!
 922
 923 ---------------------------------------------------------
 924 --      Dealing with a call site
 925
 926 completeCall env var occ_info cont
 927   =     -- Simplify the arguments
 928     getDOptsSmpl                                        `thenSmpl` \ dflags ->
 929     let
 930         chkr              = getSwitchChecker env
 931         (args, call_cont) = getContArgs chkr var cont
 932         fn_ty             = idType var
 933     in
 934     simplifyArgs env fn_ty (interestingArgContext var call_cont) args
 935                  (contResultType call_cont)     $ \ env args ->
 936
 937         -- Next, look for rules or specialisations that match
 938         --
 939         -- It's important to simplify the args first, because the rule-matcher
 940         -- doesn't do substitution as it goes.  We don't want to use subst_args
 941         -- (defined in the 'where') because that throws away useful occurrence info,
 942         -- and perhaps-very-important specialisations.
 943         --
 944         -- Some functions have specialisations *and* are strict; in this case,
 945         -- we don't want to inline the wrapper of the non-specialised thing; better
 946         -- to call the specialised thing instead.
 947         -- We used to use the black-listing mechanism to ensure that inlining of
 948         -- the wrapper didn't occur for things that have specialisations till a
 949         -- later phase, so but now we just try RULES first
 950         --
 951         -- You might think that we shouldn't apply rules for a loop breaker:
 952         -- doing so might give rise to an infinite loop, because a RULE is
 953         -- rather like an extra equation for the function:
 954         --      RULE:           f (g x) y = x+y
 955         --      Eqn:            f a     y = a-y
 956         --
 957         -- But it's too drastic to disable rules for loop breakers.
 958         -- Even the foldr/build rule would be disabled, because foldr
 959         -- is recursive, and hence a loop breaker:
 960         --      foldr k z (build g) = g k z
 961         -- So it's up to the programmer: rules can cause divergence
 962
 963     let
 964         in_scope   = getInScope env
 965         rules      = getRules env
 966         maybe_rule = case activeRule env of
 967                         Nothing     -> Nothing  -- No rules apply
 968                         Just act_fn -> lookupRule act_fn in_scope rules var args
 969     in
 970     case maybe_rule of {
 971         Just (rule_name, rule_rhs) ->
 972                 tick (RuleFired rule_name)                      `thenSmpl_`
 973                 (if dopt Opt_D_dump_inlinings dflags then
 974                    pprTrace "Rule fired" (vcat [
 975                         text "Rule:" <+> ftext rule_name,
 976                         text "Before:" <+> ppr var <+> sep (map pprParendExpr args),
 977                         text "After: " <+> pprCoreExpr rule_rhs,
 978                         text "Cont:  " <+> ppr call_cont])
 979                  else
 980                         id)             $
 981                 simplExprF env rule_rhs call_cont ;
 982
 983         Nothing ->              -- No rules
 984
 985         -- Next, look for an inlining
 986     let
 987         arg_infos = [ interestingArg arg | arg <- args, isValArg arg]
 988         interesting_cont = interestingCallContext (notNull args)
 989                                                   (notNull arg_infos)
 990                                                   call_cont
 991         active_inline = activeInline env var occ_info
 992         maybe_inline  = callSiteInline dflags active_inline occ_info
 993                                        var arg_infos interesting_cont
 994     in
 995     case maybe_inline of {
 996         Just unfolding          -- There is an inlining!
 997           ->  tick (UnfoldingDone var)          `thenSmpl_`
 998                 (if dopt Opt_D_dump_inlinings dflags then
 999                    pprTrace "Inlining done" (vcat [
1000                         text "Before:" <+> ppr var <+> sep (map pprParendExpr args),
1001                         text "Inlined fn: " <+> ppr unfolding,
1002                         text "Cont:  " <+> ppr call_cont])
1003                  else
1004                         id)             $
1005               simplExprF env unfolding (pushContArgs args call_cont)
1006
1007         ;
1008         Nothing ->              -- No inlining!
1009
1010         -- Done
1011     rebuild env (mkApps (Var var) args) call_cont
1012     }}
1013 \end{code}
1014
1015 %************************************************************************
1016 %*                                                                      *
1017 \subsection{Arguments}
1018 %*                                                                      *
1019 %************************************************************************
1020
1021 \begin{code}
1022 ---------------------------------------------------------
1023 --      Simplifying the arguments of a call
1024
1025 simplifyArgs :: SimplEnv
1026              -> OutType                         -- Type of the function
1027              -> Bool                            -- True if the fn has RULES
1028              -> [(InExpr, Maybe SimplEnv, Bool)] -- Details of the arguments
1029              -> OutType                         -- Type of the continuation
1030              -> (SimplEnv -> [OutExpr] -> SimplM FloatsWithExpr)
1031              -> SimplM FloatsWithExpr
1032
1033 -- [CPS-like because of strict arguments]
1034
1035 -- Simplify the arguments to a call.
1036 -- This part of the simplifier may break the no-shadowing invariant
1037 -- Consider
1038 --      f (...(\a -> e)...) (case y of (a,b) -> e')
1039 -- where f is strict in its second arg
1040 -- If we simplify the innermost one first we get (...(\a -> e)...)
1041 -- Simplifying the second arg makes us float the case out, so we end up with
1042 --      case y of (a,b) -> f (...(\a -> e)...) e'
1043 -- So the output does not have the no-shadowing invariant.  However, there is
1044 -- no danger of getting name-capture, because when the first arg was simplified
1045 -- we used an in-scope set that at least mentioned all the variables free in its
1046 -- static environment, and that is enough.
1047 --
1048 -- We can't just do innermost first, or we'd end up with a dual problem:
1049 --      case x of (a,b) -> f e (...(\a -> e')...)
1050 --
1051 -- I spent hours trying to recover the no-shadowing invariant, but I just could
1052 -- not think of an elegant way to do it.  The simplifier is already knee-deep in
1053 -- continuations.  We have to keep the right in-scope set around; AND we have
1054 -- to get the effect that finding (error "foo") in a strict arg position will
1055 -- discard the entire application and replace it with (error "foo").  Getting
1056 -- all this at once is TOO HARD!
1057
1058 simplifyArgs env fn_ty has_rules args cont_ty thing_inside
1059   = go env fn_ty args thing_inside
1060   where
1061     go env fn_ty []         thing_inside = thing_inside env []
1062     go env fn_ty (arg:args) thing_inside = simplifyArg env fn_ty has_rules arg cont_ty  $ \ env arg' ->
1063                                            go env (applyTypeToArg fn_ty arg') args      $ \ env args' ->
1064                                            thing_inside env (arg':args')
1065
1066 simplifyArg env fn_ty has_rules (arg, Nothing, _) cont_ty thing_inside
1067   = thing_inside env arg        -- Already simplified
1068
1069 simplifyArg env fn_ty has_rules (Type ty_arg, Just se, _) cont_ty thing_inside
1070   = simplType (setInScope se env) ty_arg        `thenSmpl` \ new_ty_arg ->
1071     thing_inside env (Type new_ty_arg)
1072
1073 simplifyArg env fn_ty has_rules (val_arg, Just arg_se, is_strict) cont_ty thing_inside
1074   | is_strict
1075   = simplStrictArg AnArg env val_arg arg_se arg_ty cont_ty thing_inside
1076
1077   | otherwise   -- Lazy argument
1078                 -- DO NOT float anything outside, hence simplExprC
1079                 -- There is no benefit (unlike in a let-binding), and we'd
1080                 -- have to be very careful about bogus strictness through
1081                 -- floating a demanded let.
1082   = simplExprC (setInScope arg_se env) val_arg
1083                (mkLazyArgStop arg_ty has_rules)         `thenSmpl` \ arg1 ->
1084     thing_inside env arg1
1085   where
1086     arg_ty = funArgTy fn_ty
1087
1088
1089 simplStrictArg ::  LetRhsFlag
1090                 -> SimplEnv             -- The env of the call
1091                 -> InExpr -> SimplEnv   -- The arg plus its env
1092                 -> OutType              -- arg_ty: type of the argument
1093                 -> OutType              -- cont_ty: Type of thing computed by the context
1094                 -> (SimplEnv -> OutExpr -> SimplM FloatsWithExpr)
1095                                         -- Takes an expression of type rhs_ty,
1096                                         -- returns an expression of type cont_ty
1097                                         -- The env passed to this continuation is the
1098                                         -- env of the call, plus any new in-scope variables
1099                 -> SimplM FloatsWithExpr        -- An expression of type cont_ty
1100
1101 simplStrictArg is_rhs call_env arg arg_env arg_ty cont_ty thing_inside
1102   = simplExprF (setInScope arg_env call_env) arg
1103                (ArgOf is_rhs arg_ty cont_ty (\ new_env -> thing_inside (setInScope call_env new_env)))
1104   -- Notice the way we use arg_env (augmented with in-scope vars from call_env)
1105   --    to simplify the argument
1106   -- and call-env (augmented with in-scope vars from the arg) to pass to the continuation
1107 \end{code}
1108
1109
1110 %************************************************************************
1111 %*                                                                      *
1112 \subsection{mkAtomicArgs}
1113 %*                                                                      *
1114 %************************************************************************
1115
1116 mkAtomicArgs takes a putative RHS, checks whether it's a PAP or
1117 constructor application and, if so, converts it to ANF, so that the
1118 resulting thing can be inlined more easily.  Thus
1119         x = (f a, g b)
1120 becomes
1121         t1 = f a
1122         t2 = g b
1123         x = (t1,t2)
1124
1125 There are three sorts of binding context, specified by the two
1126 boolean arguments
1127
1128 Strict
1129    OK-unlifted
1130
1131 N  N    Top-level or recursive                  Only bind args of lifted type
1132
1133 N  Y    Non-top-level and non-recursive,        Bind args of lifted type, or
1134                 but lazy                        unlifted-and-ok-for-speculation
1135
1136 Y  Y    Non-top-level, non-recursive,           Bind all args
1137                  and strict (demanded)
1138
1139
1140 For example, given
1141
1142         x = MkC (y div# z)
1143
1144 there is no point in transforming to
1145
1146         x = case (y div# z) of r -> MkC r
1147
1148 because the (y div# z) can't float out of the let. But if it was
1149 a *strict* let, then it would be a good thing to do.  Hence the
1150 context information.
1151
1152 \begin{code}
1153 mkAtomicArgs :: Bool    -- A strict binding
1154              -> Bool    -- OK to float unlifted args
1155              -> OutExpr
1156              -> SimplM (OrdList (OutId,OutExpr),  -- The floats (unusually) may include
1157                         OutExpr)                  -- things that need case-binding,
1158                                                   -- if the strict-binding flag is on
1159
1160 mkAtomicArgs is_strict ok_float_unlifted rhs
1161   | (Var fun, args) <- collectArgs rhs,                         -- It's an application
1162     isDataConWorkId fun || valArgCount args < idArity fun       -- And it's a constructor or PAP
1163   = go fun nilOL [] args        -- Have a go
1164
1165   | otherwise = bale_out        -- Give up
1166
1167   where
1168     bale_out = returnSmpl (nilOL, rhs)
1169
1170     go fun binds rev_args []
1171         = returnSmpl (binds, mkApps (Var fun) (reverse rev_args))
1172
1173     go fun binds rev_args (arg : args)
1174         | exprIsTrivial arg     -- Easy case
1175         = go fun binds (arg:rev_args) args
1176
1177         | not can_float_arg     -- Can't make this arg atomic
1178         = bale_out              -- ... so give up
1179
1180         | otherwise     -- Don't forget to do it recursively
1181                         -- E.g.  x = a:b:c:[]
1182         =  mkAtomicArgs is_strict ok_float_unlifted arg `thenSmpl` \ (arg_binds, arg') ->
1183            newId FSLIT("a") arg_ty                      `thenSmpl` \ arg_id ->
1184            go fun ((arg_binds `snocOL` (arg_id,arg')) `appOL` binds)
1185               (Var arg_id : rev_args) args
1186         where
1187           arg_ty        = exprType arg
1188           can_float_arg =  is_strict
1189                         || not (isUnLiftedType arg_ty)
1190                         || (ok_float_unlifted && exprOkForSpeculation arg)
1191
1192
1193 addAtomicBinds :: SimplEnv -> [(OutId,OutExpr)]
1194                -> (SimplEnv -> SimplM (FloatsWith a))
1195                -> SimplM (FloatsWith a)
1196 addAtomicBinds env []         thing_inside = thing_inside env
1197 addAtomicBinds env ((v,r):bs) thing_inside = addAuxiliaryBind env (NonRec v r) $ \ env ->
1198                                              addAtomicBinds env bs thing_inside
1199
1200 addAtomicBindsE :: SimplEnv -> [(OutId,OutExpr)]
1201                 -> (SimplEnv -> SimplM FloatsWithExpr)
1202                 -> SimplM FloatsWithExpr
1203 -- Same again, but this time we're in an expression context,
1204 -- and may need to do some case bindings
1205
1206 addAtomicBindsE env [] thing_inside
1207   = thing_inside env
1208 addAtomicBindsE env ((v,r):bs) thing_inside
1209   | needsCaseBinding (idType v) r
1210   = addAtomicBindsE (addNewInScopeIds env [v]) bs thing_inside  `thenSmpl` \ (floats, expr) ->
1211     WARN( exprIsTrivial expr, ppr v <+> pprCoreExpr expr )
1212     (let body = wrapFloats floats expr in
1213      returnSmpl (emptyFloats env, Case r v (exprType body) [(DEFAULT,[],body)]))
1214
1215   | otherwise
1216   = addAuxiliaryBind env (NonRec v r)   $ \ env ->
1217     addAtomicBindsE env bs thing_inside
1218 \end{code}
1219
1220
1221 %************************************************************************
1222 %*                                                                      *
1223 \subsection{The main rebuilder}
1224 %*                                                                      *
1225 %************************************************************************
1226
1227 \begin{code}
1228 rebuild :: SimplEnv -> OutExpr -> SimplCont -> SimplM FloatsWithExpr
1229
1230 rebuild env expr (Stop _ _ _)                 = rebuildDone env expr
1231 rebuild env expr (ArgOf _ _ _ cont_fn)        = cont_fn env expr
1232 rebuild env expr (CoerceIt to_ty cont)        = rebuild env (mkCoerce to_ty expr) cont
1233 rebuild env expr (Select _ bndr alts se cont) = rebuildCase (setInScope se env) expr bndr alts cont
1234 rebuild env expr (ApplyTo _ arg mb_se cont)   = rebuildApp  env expr arg mb_se cont
1235
1236 rebuildApp env fun arg mb_se cont
1237   = do  { arg' <- simplArg env arg mb_se
1238         ; rebuild env (App fun arg') cont }
1239
1240 simplArg :: SimplEnv -> CoreExpr -> Maybe SimplEnv -> SimplM CoreExpr
1241 simplArg env arg Nothing        = return arg    -- The arg is already simplified
1242 simplArg env arg (Just arg_env) = simplExpr (setInScope arg_env env) arg
1243
1244 rebuildDone env expr = returnSmpl (emptyFloats env, expr)
1245 \end{code}
1246
1247
1248 %************************************************************************
1249 %*                                                                      *
1250 \subsection{Functions dealing with a case}
1251 %*                                                                      *
1252 %************************************************************************
1253
1254 Blob of helper functions for the "case-of-something-else" situation.
1255
1256 \begin{code}
1257 ---------------------------------------------------------
1258 --      Eliminate the case if possible
1259
1260 rebuildCase :: SimplEnv
1261             -> OutExpr          -- Scrutinee
1262             -> InId             -- Case binder
1263             -> [InAlt]          -- Alternatives (inceasing order)
1264             -> SimplCont
1265             -> SimplM FloatsWithExpr
1266
1267 rebuildCase env scrut case_bndr alts cont
1268   | Just (con,args) <- exprIsConApp_maybe scrut
1269         -- Works when the scrutinee is a variable with a known unfolding
1270         -- as well as when it's an explicit constructor application
1271   = knownCon env (DataAlt con) args case_bndr alts cont
1272
1273   | Lit lit <- scrut    -- No need for same treatment as constructors
1274                         -- because literals are inlined more vigorously
1275   = knownCon env (LitAlt lit) [] case_bndr alts cont
1276
1277   | otherwise
1278   =     -- Prepare the continuation;
1279         -- The new subst_env is in place
1280     prepareCaseCont env alts cont       `thenSmpl` \ (floats, (dup_cont, nondup_cont)) ->
1281     addFloats env floats                $ \ env ->
1282
1283     let
1284         -- The case expression is annotated with the result type of the continuation
1285         -- This may differ from the type originally on the case.  For example
1286         --      case(T) (case(Int#) a of { True -> 1#; False -> 0# }) of
1287         --         a# -> <blob>
1288         -- ===>
1289         --      let j a# = <blob>
1290         --      in case(T) a of { True -> j 1#; False -> j 0# }
1291         -- Note that the case that scrutinises a now returns a T not an Int#
1292         res_ty' = contResultType dup_cont
1293     in
1294
1295         -- Deal with case binder
1296     simplCaseBinder env scrut case_bndr         `thenSmpl` \ (alt_env, case_bndr') ->
1297
1298         -- Deal with the case alternatives
1299     simplAlts alt_env scrut case_bndr' alts dup_cont    `thenSmpl` \ alts' ->
1300
1301         -- Put the case back together
1302     mkCase scrut case_bndr' res_ty' alts'       `thenSmpl` \ case_expr ->
1303
1304         -- Notice that rebuildDone returns the in-scope set from env, not alt_env
1305         -- The case binder *not* scope over the whole returned case-expression
1306     rebuild env case_expr nondup_cont
1307 \end{code}
1308
1309 simplCaseBinder checks whether the scrutinee is a variable, v.  If so,
1310 try to eliminate uses of v in the RHSs in favour of case_bndr; that
1311 way, there's a chance that v will now only be used once, and hence
1312 inlined.
1313
1314 Note 1
1315 ~~~~~~
1316 There is a time we *don't* want to do that, namely when
1317 -fno-case-of-case is on.  This happens in the first simplifier pass,
1318 and enhances full laziness.  Here's the bad case:
1319         f = \ y -> ...(case x of I# v -> ...(case x of ...) ... )
1320 If we eliminate the inner case, we trap it inside the I# v -> arm,
1321 which might prevent some full laziness happening.  I've seen this
1322 in action in spectral/cichelli/Prog.hs:
1323          [(m,n) | m <- [1..max], n <- [1..max]]
1324 Hence the check for NoCaseOfCase.
1325
1326 Note 2
1327 ~~~~~~
1328 There is another situation when we don't want to do it.  If we have
1329
1330     case x of w1 { DEFAULT -> case x of w2 { A -> e1; B -> e2 }
1331                    ...other cases .... }
1332
1333 We'll perform the binder-swap for the outer case, giving
1334
1335     case x of w1 { DEFAULT -> case w1 of w2 { A -> e1; B -> e2 }
1336                    ...other cases .... }
1337
1338 But there is no point in doing it for the inner case, because w1 can't
1339 be inlined anyway.  Furthermore, doing the case-swapping involves
1340 zapping w2's occurrence info (see paragraphs that follow), and that
1341 forces us to bind w2 when doing case merging.  So we get
1342
1343     case x of w1 { A -> let w2 = w1 in e1
1344                    B -> let w2 = w1 in e2
1345                    ...other cases .... }
1346
1347 This is plain silly in the common case where w2 is dead.
1348
1349 Even so, I can't see a good way to implement this idea.  I tried
1350 not doing the binder-swap if the scrutinee was already evaluated
1351 but that failed big-time:
1352
1353         data T = MkT !Int
1354
1355         case v of w  { MkT x ->
1356         case x of x1 { I# y1 ->
1357         case x of x2 { I# y2 -> ...
1358
1359 Notice that because MkT is strict, x is marked "evaluated".  But to
1360 eliminate the last case, we must either make sure that x (as well as
1361 x1) has unfolding MkT y1.  THe straightforward thing to do is to do
1362 the binder-swap.  So this whole note is a no-op.
1363
1364 Note 3
1365 ~~~~~~
1366 If we replace the scrutinee, v, by tbe case binder, then we have to nuke
1367 any occurrence info (eg IAmDead) in the case binder, because the
1368 case-binder now effectively occurs whenever v does.  AND we have to do
1369 the same for the pattern-bound variables!  Example:
1370
1371         (case x of { (a,b) -> a }) (case x of { (p,q) -> q })
1372
1373 Here, b and p are dead.  But when we move the argment inside the first
1374 case RHS, and eliminate the second case, we get
1375
1376         case x of { (a,b) -> a b }
1377
1378 Urk! b is alive!  Reason: the scrutinee was a variable, and case elimination
1379 happened.
1380
1381 Indeed, this can happen anytime the case binder isn't dead:
1382         case <any> of x { (a,b) ->
1383         case x of { (p,q) -> p } }
1384 Here (a,b) both look dead, but come alive after the inner case is eliminated.
1385 The point is that we bring into the envt a binding
1386         let x = (a,b)
1387 after the outer case, and that makes (a,b) alive.  At least we do unless
1388 the case binder is guaranteed dead.
1389
1390 \begin{code}
1391 simplCaseBinder env (Var v) case_bndr
1392   | not (switchIsOn (getSwitchChecker env) NoCaseOfCase)
1393
1394 -- Failed try [see Note 2 above]
1395 --     not (isEvaldUnfolding (idUnfolding v))
1396
1397   = simplBinder env (zap case_bndr)             `thenSmpl` \ (env, case_bndr') ->
1398     returnSmpl (modifyInScope env v case_bndr', case_bndr')
1399         -- We could extend the substitution instead, but it would be
1400         -- a hack because then the substitution wouldn't be idempotent
1401         -- any more (v is an OutId).  And this does just as well.
1402   where
1403     zap b = b `setIdOccInfo` NoOccInfo
1404
1405 simplCaseBinder env other_scrut case_bndr
1406   = simplBinder env case_bndr           `thenSmpl` \ (env, case_bndr') ->
1407     returnSmpl (env, case_bndr')
1408 \end{code}
1409
1410
1411 simplAlts does two things:
1412
1413 1.  Eliminate alternatives that cannot match, including the
1414     DEFAULT alternative.
1415
1416 2.  If the DEFAULT alternative can match only one possible constructor,
1417     then make that constructor explicit.
1418     e.g.
1419         case e of x { DEFAULT -> rhs }
1420      ===>
1421         case e of x { (a,b) -> rhs }
1422     where the type is a single constructor type.  This gives better code
1423     when rhs also scrutinises x or e.
1424
1425 Here "cannot match" includes knowledge from GADTs
1426
1427 It's a good idea do do this stuff before simplifying the alternatives, to
1428 avoid simplifying alternatives we know can't happen, and to come up with
1429 the list of constructors that are handled, to put into the IdInfo of the
1430 case binder, for use when simplifying the alternatives.
1431
1432 Eliminating the default alternative in (1) isn't so obvious, but it can
1433 happen:
1434
1435 data Colour = Red | Green | Blue
1436
1437 f x = case x of
1438         Red -> ..
1439         Green -> ..
1440         DEFAULT -> h x
1441
1442 h y = case y of
1443         Blue -> ..
1444         DEFAULT -> [ case y of ... ]
1445
1446 If we inline h into f, the default case of the inlined h can't happen.
1447 If we don't notice this, we may end up filtering out *all* the cases
1448 of the inner case y, which give us nowhere to go!
1449
1450
1451 \begin{code}
1452 simplAlts :: SimplEnv
1453           -> OutExpr
1454           -> OutId                      -- Case binder
1455           -> [InAlt] -> SimplCont
1456           -> SimplM [OutAlt]            -- Includes the continuation
1457
1458 simplAlts env scrut case_bndr' alts cont'
1459   = do  { mb_alts      <- mapSmpl (simplAlt env imposs_cons case_bndr' cont') alts_wo_default
1460         ; default_alts <- simplDefault env case_bndr' imposs_deflt_cons cont' maybe_deflt
1461         ; return (mergeAlts default_alts [alt' | Just (_, alt') <- mb_alts]) }
1462         -- We need the mergeAlts in case the new default_alt
1463         -- has turned into a constructor alternative.
1464   where
1465     (alts_wo_default, maybe_deflt) = findDefault alts
1466     imposs_cons = case scrut of
1467                     Var v -> otherCons (idUnfolding v)
1468                     other -> []
1469
1470         -- "imposs_deflt_cons" are handled either by the context,
1471         -- OR by a branch in this case expression. (Don't include DEFAULT!!)
1472     imposs_deflt_cons = nub (imposs_cons ++ [con | (con,_,_) <- alts_wo_default])
1473
1474 simplDefault :: SimplEnv
1475              -> OutId           -- Case binder; need just for its type. Note that as an
1476                                 --   OutId, it has maximum information; this is important.
1477                                 --   Test simpl013 is an example
1478              -> [AltCon]        -- These cons can't happen when matching the default
1479              -> SimplCont
1480              -> Maybe InExpr
1481              -> SimplM [OutAlt] -- One branch or none; we use a list because it's what
1482                                 --   mergeAlts expects
1483
1484
1485 simplDefault env case_bndr' imposs_cons cont Nothing
1486   = return []   -- No default branch
1487 simplDefault env case_bndr' imposs_cons cont (Just rhs)
1488   |     -- This branch handles the case where we are
1489         -- scrutinisng an algebraic data type
1490     Just (tycon, inst_tys) <- splitTyConApp_maybe (idType case_bndr'),
1491     isAlgTyCon tycon,           -- It's a data type, tuple, or unboxed tuples.
1492     not (isNewTyCon tycon),     -- We can have a newtype, if we are just doing an eval:
1493                                 --      case x of { DEFAULT -> e }
1494                                 -- and we don't want to fill in a default for them!
1495     Just all_cons <- tyConDataCons_maybe tycon,
1496     not (null all_cons),        -- This is a tricky corner case.  If the data type has no constructors,
1497                                 -- which GHC allows, then the case expression will have at most a default
1498                                 -- alternative.  We don't want to eliminate that alternative, because the
1499                                 -- invariant is that there's always one alternative.  It's more convenient
1500                                 -- to leave
1501                                 --      case x of { DEFAULT -> e }
1502                                 -- as it is, rather than transform it to
1503                                 --      error "case cant match"
1504                                 -- which would be quite legitmate.  But it's a really obscure corner, and
1505                                 -- not worth wasting code on.
1506
1507     let imposs_data_cons = [con | DataAlt con <- imposs_cons]   -- We now know it's a data type
1508         poss_data_cons   = filterOut (`elem` imposs_data_cons) all_cons
1509         gadt_imposs      | all isTyVarTy inst_tys = []
1510                          | otherwise = filter (cant_match inst_tys) poss_data_cons
1511         final_poss       = filterOut (`elem` gadt_imposs) poss_data_cons
1512
1513   = case final_poss of
1514         []    -> returnSmpl []  -- Eliminate the default alternative
1515                                 -- altogether if it can't match
1516
1517         [con] ->        -- It matches exactly one constructor, so fill it in
1518                  do { con_alt <- mkDataConAlt case_bndr' con inst_tys rhs
1519                     ; Just (_, alt') <- simplAlt env [] case_bndr' cont con_alt
1520                         -- The simplAlt must succeed with Just because we have
1521                         -- already filtered out construtors that can't match
1522                     ; return [alt'] }
1523
1524         two_or_more -> simplify_default (map DataAlt gadt_imposs ++ imposs_cons)
1525
1526   | otherwise
1527   = simplify_default imposs_cons
1528   where
1529     cant_match tys data_con = not (dataConCanMatch data_con tys)
1530
1531     simplify_default imposs_cons
1532         = do { let env' = mk_rhs_env env case_bndr' (mkOtherCon imposs_cons)
1533                 -- Record the constructors that the case-binder *can't* be.
1534              ; rhs' <- simplExprC env' rhs cont
1535              ; return [(DEFAULT, [], rhs')] }
1536
1537 mkDataConAlt :: Id -> DataCon -> [OutType] -> InExpr -> SimplM InAlt
1538 -- Make a data-constructor alternative to replace the DEFAULT case
1539 -- NB: there's something a bit bogus here, because we put OutTypes into an InAlt
1540 mkDataConAlt case_bndr con tys rhs
1541   = do  { tick (FillInCaseDefault case_bndr)
1542         ; args <- mk_args con tys
1543         ; return (DataAlt con, args, rhs) }
1544   where
1545     mk_args con inst_tys
1546       = do { (tv_bndrs, inst_tys') <- mk_tv_bndrs con inst_tys
1547            ; let arg_tys = dataConInstArgTys con inst_tys'
1548            ; arg_ids <- mapM (newId FSLIT("a")) arg_tys
1549            ; returnSmpl (tv_bndrs ++ arg_ids) }
1550
1551     mk_tv_bndrs con inst_tys
1552       | isVanillaDataCon con
1553       = return ([], inst_tys)
1554       | otherwise
1555       = do { tv_uniqs <- getUniquesSmpl
1556            ; let new_tvs    = zipWith mk tv_uniqs (dataConTyVars con)
1557                  mk uniq tv = mkTyVar (mkSysTvName uniq FSLIT("t")) (tyVarKind tv)
1558            ; return (new_tvs, mkTyVarTys new_tvs) }
1559
1560 simplAlt :: SimplEnv
1561          -> [AltCon]    -- These constructors can't be present when
1562                         -- matching this alternative
1563          -> OutId       -- The case binder
1564          -> SimplCont
1565          -> InAlt
1566          -> SimplM (Maybe (TvSubstEnv, OutAlt))
1567
1568 -- Simplify an alternative, returning the type refinement for the
1569 -- alternative, if the alternative does any refinement at all
1570 -- Nothing => the alternative is inaccessible
1571
1572 simplAlt env imposs_cons case_bndr' cont' (con, bndrs, rhs)
1573   | con `elem` imposs_cons      -- This case can't match
1574   = return Nothing
1575
1576 simplAlt env handled_cons case_bndr' cont' (DEFAULT, bndrs, rhs)
1577         -- TURGID DUPLICATION, needed only for the simplAlt call
1578         -- in mkDupableAlt.  Clean this up when moving to FC
1579   = ASSERT( null bndrs )
1580     simplExprC env' rhs cont'   `thenSmpl` \ rhs' ->
1581     returnSmpl (Just (emptyVarEnv, (DEFAULT, [], rhs')))
1582   where
1583     env' = mk_rhs_env env case_bndr' (mkOtherCon handled_cons)
1584         -- Record the constructors that the case-binder *can't* be.
1585
1586 simplAlt env handled_cons case_bndr' cont' (LitAlt lit, bndrs, rhs)
1587   = ASSERT( null bndrs )
1588     simplExprC env' rhs cont'   `thenSmpl` \ rhs' ->
1589     returnSmpl (Just (emptyVarEnv, (LitAlt lit, [], rhs')))
1590   where
1591     env' = mk_rhs_env env case_bndr' (mkUnfolding False (Lit lit))
1592
1593 simplAlt env handled_cons case_bndr' cont' (DataAlt con, vs, rhs)
1594   | isVanillaDataCon con
1595   =     -- Deal with the pattern-bound variables
1596         -- Mark the ones that are in ! positions in the data constructor
1597         -- as certainly-evaluated.
1598         -- NB: it happens that simplBinders does *not* erase the OtherCon
1599         --     form of unfolding, so it's ok to add this info before
1600         --     doing simplBinders
1601     simplBinders env (add_evals con vs)         `thenSmpl` \ (env, vs') ->
1602
1603                 -- Bind the case-binder to (con args)
1604     let unf       = mkUnfolding False (mkConApp con con_args)
1605         inst_tys' = tyConAppArgs (idType case_bndr')
1606         con_args  = map Type inst_tys' ++ map varToCoreExpr vs'
1607         env'      = mk_rhs_env env case_bndr' unf
1608     in
1609     simplExprC env' rhs cont'   `thenSmpl` \ rhs' ->
1610     returnSmpl (Just (emptyVarEnv, (DataAlt con, vs', rhs')))
1611
1612   | otherwise   -- GADT case
1613   = let
1614         (tvs,ids) = span isTyVar vs
1615     in
1616     simplBinders env tvs                        `thenSmpl` \ (env1, tvs') ->
1617     case coreRefineTys con tvs' (idType case_bndr') of {
1618         Nothing         -- Inaccessible
1619             | opt_PprStyle_Debug        -- Hack: if debugging is on, generate an error case
1620                                         --       so we can see it
1621             ->  let rhs' = mkApps (Var eRROR_ID)
1622                                 [Type (substTy env (exprType rhs)),
1623                                  Lit (mkStringLit "Impossible alternative (GADT)")]
1624                 in
1625                 simplBinders env1 ids           `thenSmpl` \ (env2, ids') ->
1626                 returnSmpl (Just (emptyVarEnv, (DataAlt con, tvs' ++ ids', rhs')))
1627
1628             | otherwise -- Filter out the inaccessible branch
1629             -> return Nothing ;
1630
1631         Just refine@(tv_subst_env, _) ->        -- The normal case
1632
1633     let
1634         env2 = refineSimplEnv env1 refine
1635         -- Simplify the Ids in the refined environment, so their types
1636         -- reflect the refinement.  Usually this doesn't matter, but it helps
1637         -- in mkDupableAlt, when we want to float a lambda that uses these binders
1638         -- Furthermore, it means the binders contain maximal type information
1639     in
1640     simplBinders env2 (add_evals con ids)       `thenSmpl` \ (env3, ids') ->
1641     let unf        = mkUnfolding False con_app
1642         con_app    = mkConApp con con_args
1643         con_args   = map varToCoreExpr vs'      -- NB: no inst_tys'
1644         env_w_unf  = mk_rhs_env env3 case_bndr' unf
1645         vs'        = tvs' ++ ids'
1646     in
1647     simplExprC env_w_unf rhs cont'      `thenSmpl` \ rhs' ->
1648     returnSmpl (Just (tv_subst_env, (DataAlt con, vs', rhs'))) }
1649
1650   where
1651         -- add_evals records the evaluated-ness of the bound variables of
1652         -- a case pattern.  This is *important*.  Consider
1653         --      data T = T !Int !Int
1654         --
1655         --      case x of { T a b -> T (a+1) b }
1656         --
1657         -- We really must record that b is already evaluated so that we don't
1658         -- go and re-evaluate it when constructing the result.
1659     add_evals dc vs = cat_evals dc vs (dataConRepStrictness dc)
1660
1661     cat_evals dc vs strs
1662         = go vs strs
1663         where
1664           go [] [] = []
1665           go (v:vs) strs | isTyVar v = v : go vs strs
1666           go (v:vs) (str:strs)
1667             | isMarkedStrict str = evald_v  : go vs strs
1668             | otherwise          = zapped_v : go vs strs
1669             where
1670               zapped_v = zap_occ_info v
1671               evald_v  = zapped_v `setIdUnfolding` evaldUnfolding
1672           go _ _ = pprPanic "cat_evals" (ppr dc $$ ppr vs $$ ppr strs)
1673
1674         -- If the case binder is alive, then we add the unfolding
1675         --      case_bndr = C vs
1676         -- to the envt; so vs are now very much alive
1677     zap_occ_info | isDeadBinder case_bndr' = \id -> id
1678                  | otherwise               = \id -> id `setIdOccInfo` NoOccInfo
1679
1680 mk_rhs_env env case_bndr' case_bndr_unf
1681   = modifyInScope env case_bndr' (case_bndr' `setIdUnfolding` case_bndr_unf)
1682 \end{code}
1683
1684
1685 %************************************************************************
1686 %*                                                                      *
1687 \subsection{Known constructor}
1688 %*                                                                      *
1689 %************************************************************************
1690
1691 We are a bit careful with occurrence info.  Here's an example
1692
1693         (\x* -> case x of (a*, b) -> f a) (h v, e)
1694
1695 where the * means "occurs once".  This effectively becomes
1696         case (h v, e) of (a*, b) -> f a)
1697 and then
1698         let a* = h v; b = e in f a
1699 and then
1700         f (h v)
1701
1702 All this should happen in one sweep.
1703
1704 \begin{code}
1705 knownCon :: SimplEnv -> AltCon -> [OutExpr]
1706          -> InId -> [InAlt] -> SimplCont
1707          -> SimplM FloatsWithExpr
1708
1709 knownCon env con args bndr alts cont
1710   = tick (KnownBranch bndr)     `thenSmpl_`
1711     case findAlt con alts of
1712         (DEFAULT, bs, rhs)     -> ASSERT( null bs )
1713                                   simplNonRecX env bndr scrut   $ \ env ->
1714                                         -- This might give rise to a binding with non-atomic args
1715                                         -- like x = Node (f x) (g x)
1716                                         -- but no harm will be done
1717                                   simplExprF env rhs cont
1718                                 where
1719                                   scrut = case con of
1720                                             LitAlt lit -> Lit lit
1721                                             DataAlt dc -> mkConApp dc args
1722
1723         (LitAlt lit, bs, rhs) ->  ASSERT( null bs )
1724                                   simplNonRecX env bndr (Lit lit)       $ \ env ->
1725                                   simplExprF env rhs cont
1726
1727         (DataAlt dc, bs, rhs)
1728                 -> ASSERT( n_drop_tys + length bs == length args )
1729                    bind_args env bs (drop n_drop_tys args)      $ \ env ->
1730                    let
1731                         con_app  = mkConApp dc (take n_drop_tys args ++ con_args)
1732                         con_args = [substExpr env (varToCoreExpr b) | b <- bs]
1733                                         -- args are aready OutExprs, but bs are InIds
1734                    in
1735                    simplNonRecX env bndr con_app                $ \ env ->
1736                    simplExprF env rhs cont
1737                 where
1738                    n_drop_tys | isVanillaDataCon dc = tyConArity (dataConTyCon dc)
1739                               | otherwise           = 0
1740                         -- Vanilla data constructors lack type arguments in the pattern
1741
1742 -- Ugh!
1743 bind_args env [] _ thing_inside = thing_inside env
1744
1745 bind_args env (b:bs) (Type ty : args) thing_inside
1746   = ASSERT( isTyVar b )
1747     bind_args (extendTvSubst env b ty) bs args thing_inside
1748
1749 bind_args env (b:bs) (arg : args) thing_inside
1750   = ASSERT( isId b )
1751     simplNonRecX env b arg      $ \ env ->
1752     bind_args env bs args thing_inside
1753 \end{code}
1754
1755
1756 %************************************************************************
1757 %*                                                                      *
1758 \subsection{Duplicating continuations}
1759 %*                                                                      *
1760 %************************************************************************
1761
1762 \begin{code}
1763 prepareCaseCont :: SimplEnv
1764                 -> [InAlt] -> SimplCont
1765                 -> SimplM (FloatsWith (SimplCont,SimplCont))
1766                         -- Return a duplicatable continuation, a non-duplicable part
1767                         -- plus some extra bindings (that scope over the entire
1768                         -- continunation)
1769
1770         -- No need to make it duplicatable if there's only one alternative
1771 prepareCaseCont env [alt] cont = returnSmpl (emptyFloats env, (cont, mkBoringStop (contResultType cont)))
1772 prepareCaseCont env alts  cont = mkDupableCont env cont
1773 \end{code}
1774
1775 \begin{code}
1776 mkDupableCont :: SimplEnv -> SimplCont
1777               -> SimplM (FloatsWith (SimplCont, SimplCont))
1778
1779 mkDupableCont env cont
1780   | contIsDupable cont
1781   = returnSmpl (emptyFloats env, (cont, mkBoringStop (contResultType cont)))
1782
1783 mkDupableCont env (CoerceIt ty cont)
1784   = mkDupableCont env cont              `thenSmpl` \ (floats, (dup_cont, nondup_cont)) ->
1785     returnSmpl (floats, (CoerceIt ty dup_cont, nondup_cont))
1786
1787 mkDupableCont env cont@(ArgOf _ arg_ty _ _)
1788   =  returnSmpl (emptyFloats env, (mkBoringStop arg_ty, cont))
1789         -- Do *not* duplicate an ArgOf continuation
1790         -- Because ArgOf continuations are opaque, we gain nothing by
1791         -- propagating them into the expressions, and we do lose a lot.
1792         -- Here's an example:
1793         --      && (case x of { T -> F; F -> T }) E
1794         -- Now, && is strict so we end up simplifying the case with
1795         -- an ArgOf continuation.  If we let-bind it, we get
1796         --
1797         --      let $j = \v -> && v E
1798         --      in simplExpr (case x of { T -> F; F -> T })
1799         --                   (ArgOf (\r -> $j r)
1800         -- And after simplifying more we get
1801         --
1802         --      let $j = \v -> && v E
1803         --      in case of { T -> $j F; F -> $j T }
1804         -- Which is a Very Bad Thing
1805         --
1806         -- The desire not to duplicate is the entire reason that
1807         -- mkDupableCont returns a pair of continuations.
1808         --
1809         -- The original plan had:
1810         -- e.g.         (...strict-fn...) [...hole...]
1811         --      ==>
1812         --              let $j = \a -> ...strict-fn...
1813         --              in $j [...hole...]
1814
1815 mkDupableCont env (ApplyTo _ arg mb_se cont)
1816   =     -- e.g.         [...hole...] (...arg...)
1817         --      ==>
1818         --              let a = ...arg...
1819         --              in [...hole...] a
1820     do  { (floats, (dup_cont, nondup_cont)) <- mkDupableCont env cont
1821         ; addFloats env floats $ \ env -> do
1822         { arg1 <- simplArg env arg mb_se
1823         ; (floats2, arg2) <- mkDupableArg env arg1
1824         ; return (floats2, (ApplyTo OkToDup arg2 Nothing dup_cont, nondup_cont)) }}
1825
1826 mkDupableCont env (Select _ case_bndr alts se cont)
1827   =     -- e.g.         (case [...hole...] of { pi -> ei })
1828         --      ===>
1829         --              let ji = \xij -> ei
1830         --              in case [...hole...] of { pi -> ji xij }
1831     do  { tick (CaseOfCase case_bndr)
1832         ; let alt_env = setInScope se env
1833         ; (floats1, (dup_cont, nondup_cont)) <- mkDupableCont alt_env cont
1834                 -- NB: call mkDupableCont here, *not* prepareCaseCont
1835                 -- We must make a duplicable continuation, whereas prepareCaseCont
1836                 -- doesn't when there is a single case branch
1837         ; addFloats alt_env floats1     $ \ alt_env -> do
1838
1839         { (alt_env, case_bndr') <- simplBinder alt_env case_bndr
1840                 -- NB: simplBinder does not zap deadness occ-info, so
1841                 -- a dead case_bndr' will still advertise its deadness
1842                 -- This is really important because in
1843                 --      case e of b { (# a,b #) -> ... }
1844                 -- b is always dead, and indeed we are not allowed to bind b to (# a,b #),
1845                 -- which might happen if e was an explicit unboxed pair and b wasn't marked dead.
1846                 -- In the new alts we build, we have the new case binder, so it must retain
1847                 -- its deadness.
1848
1849         ; (floats2, alts') <- mkDupableAlts alt_env case_bndr' alts dup_cont
1850         ; return (floats2, (Select OkToDup case_bndr' alts' (zapSubstEnv se)
1851                                    (mkBoringStop (contResultType dup_cont)),
1852                             nondup_cont))
1853         }}
1854
1855 mkDupableArg :: SimplEnv -> OutExpr -> SimplM (FloatsWith OutExpr)
1856 -- Let-bind the thing if necessary
1857 mkDupableArg env arg
1858   | exprIsDupable arg
1859   = return (emptyFloats env, arg)
1860   | otherwise
1861   = do  { arg_id <- newId FSLIT("a") (exprType arg)
1862         ; tick (CaseOfCase arg_id)
1863                 -- Want to tick here so that we go round again,
1864                 -- and maybe copy or inline the code.
1865                 -- Not strictly CaseOfCase, but never mind
1866         ; return (unitFloat env arg_id arg, Var arg_id) }
1867         -- What if the arg should be case-bound?
1868         -- This has been this way for a long time, so I'll leave it,
1869         -- but I can't convince myself that it's right.
1870
1871 mkDupableAlts :: SimplEnv -> OutId -> [InAlt] -> SimplCont
1872               -> SimplM (FloatsWith [InAlt])
1873 -- Absorbs the continuation into the new alternatives
1874
1875 mkDupableAlts env case_bndr' alts dupable_cont
1876   = go env alts
1877   where
1878     go env [] = returnSmpl (emptyFloats env, [])
1879     go env (alt:alts)
1880         = do { (floats1, mb_alt') <- mkDupableAlt env case_bndr' dupable_cont alt
1881              ; addFloats env floats1    $ \ env -> do
1882              { (floats2, alts') <- go env alts
1883              ; returnSmpl (floats2, case mb_alt' of
1884                                         Just alt' -> alt' : alts'
1885                                         Nothing   -> alts'
1886                           )}}
1887
1888 mkDupableAlt env case_bndr' cont alt
1889   = simplAlt env [] case_bndr' cont alt         `thenSmpl` \ mb_stuff ->
1890     case mb_stuff of {
1891         Nothing -> returnSmpl (emptyFloats env, Nothing) ;
1892
1893         Just (reft, (con, bndrs', rhs')) ->
1894         -- Safe to say that there are no handled-cons for the DEFAULT case
1895
1896     if exprIsDupable rhs' then
1897         returnSmpl (emptyFloats env, Just (con, bndrs', rhs'))
1898         -- It is worth checking for a small RHS because otherwise we
1899         -- get extra let bindings that may cause an extra iteration of the simplifier to
1900         -- inline back in place.  Quite often the rhs is just a variable or constructor.
1901         -- The Ord instance of Maybe in PrelMaybe.lhs, for example, took several extra
1902         -- iterations because the version with the let bindings looked big, and so wasn't
1903         -- inlined, but after the join points had been inlined it looked smaller, and so
1904         -- was inlined.
1905         --
1906         -- NB: we have to check the size of rhs', not rhs.
1907         -- Duplicating a small InAlt might invalidate occurrence information
1908         -- However, if it *is* dupable, we return the *un* simplified alternative,
1909         -- because otherwise we'd need to pair it up with an empty subst-env....
1910         -- but we only have one env shared between all the alts.
1911         -- (Remember we must zap the subst-env before re-simplifying something).
1912         -- Rather than do this we simply agree to re-simplify the original (small) thing later.
1913
1914     else
1915     let
1916         rhs_ty'     = exprType rhs'
1917         used_bndrs' = filter abstract_over (case_bndr' : bndrs')
1918         abstract_over bndr
1919           | isTyVar bndr = not (bndr `elemVarEnv` reft)
1920                 -- Don't abstract over tyvar binders which are refined away
1921                 -- See Note [Refinement] below
1922           | otherwise    = not (isDeadBinder bndr)
1923                 -- The deadness info on the new Ids is preserved by simplBinders
1924     in
1925         -- If we try to lift a primitive-typed something out
1926         -- for let-binding-purposes, we will *caseify* it (!),
1927         -- with potentially-disastrous strictness results.  So
1928         -- instead we turn it into a function: \v -> e
1929         -- where v::State# RealWorld#.  The value passed to this function
1930         -- is realworld#, which generates (almost) no code.
1931
1932         -- There's a slight infelicity here: we pass the overall
1933         -- case_bndr to all the join points if it's used in *any* RHS,
1934         -- because we don't know its usage in each RHS separately
1935
1936         -- We used to say "&& isUnLiftedType rhs_ty'" here, but now
1937         -- we make the join point into a function whenever used_bndrs'
1938         -- is empty.  This makes the join-point more CPR friendly.
1939         -- Consider:    let j = if .. then I# 3 else I# 4
1940         --              in case .. of { A -> j; B -> j; C -> ... }
1941         --
1942         -- Now CPR doesn't w/w j because it's a thunk, so
1943         -- that means that the enclosing function can't w/w either,
1944         -- which is a lose.  Here's the example that happened in practice:
1945         --      kgmod :: Int -> Int -> Int
1946         --      kgmod x y = if x > 0 && y < 0 || x < 0 && y > 0
1947         --                  then 78
1948         --                  else 5
1949         --
1950         -- I have seen a case alternative like this:
1951         --      True -> \v -> ...
1952         -- It's a bit silly to add the realWorld dummy arg in this case, making
1953         --      $j = \s v -> ...
1954         --         True -> $j s
1955         -- (the \v alone is enough to make CPR happy) but I think it's rare
1956
1957     ( if not (any isId used_bndrs')
1958         then newId FSLIT("w") realWorldStatePrimTy      `thenSmpl` \ rw_id ->
1959              returnSmpl ([rw_id], [Var realWorldPrimId])
1960         else
1961              returnSmpl (used_bndrs', map varToCoreExpr used_bndrs')
1962     )                                                   `thenSmpl` \ (final_bndrs', final_args) ->
1963
1964         -- See comment about "$j" name above
1965     newId FSLIT("$j") (mkPiTypes final_bndrs' rhs_ty')  `thenSmpl` \ join_bndr ->
1966         -- Notice the funky mkPiTypes.  If the contructor has existentials
1967         -- it's possible that the join point will be abstracted over
1968         -- type varaibles as well as term variables.
1969         --  Example:  Suppose we have
1970         --      data T = forall t.  C [t]
1971         --  Then faced with
1972         --      case (case e of ...) of
1973         --          C t xs::[t] -> rhs
1974         --  We get the join point
1975         --      let j :: forall t. [t] -> ...
1976         --          j = /\t \xs::[t] -> rhs
1977         --      in
1978         --      case (case e of ...) of
1979         --          C t xs::[t] -> j t xs
1980     let
1981         -- We make the lambdas into one-shot-lambdas.  The
1982         -- join point is sure to be applied at most once, and doing so
1983         -- prevents the body of the join point being floated out by
1984         -- the full laziness pass
1985         really_final_bndrs     = map one_shot final_bndrs'
1986         one_shot v | isId v    = setOneShotLambda v
1987                    | otherwise = v
1988         join_rhs  = mkLams really_final_bndrs rhs'
1989         join_call = mkApps (Var join_bndr) final_args
1990     in
1991     returnSmpl (unitFloat env join_bndr join_rhs, Just (con, bndrs', join_call)) }
1992 \end{code}
1993
1994 Note [Refinement]
1995 ~~~~~~~~~~~~~~~~~
1996 Consider
1997         data T a where
1998           MkT :: a -> b -> T a
1999
2000         f = /\a. \(w::a).
2001            case (case ...) of
2002                   MkT a' b (p::a') (q::b) -> [p,w]
2003
2004 The danger is that we'll make a join point
2005
2006         j a' p = [p,w]
2007
2008 and that's ill-typed, because (p::a') but (w::a).
2009
2010 Solution so far: don't abstract over a', because the type refinement
2011 maps [a' -> a] .  Ultimately that won't work when real refinement goes on.
2012
2013 Then we must abstract over any refined free variables.  Hmm.  Maybe we
2014 could just abstract over *all* free variables, thereby lambda-lifting
2015 the join point?   We should try this.