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