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