Restore old names of comparison primops
[ghc.git] / 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
12 import SimplMonad
13 import Type hiding      ( substTy, extendTvSubst, substTyVar )
14 import SimplEnv
15 import SimplUtils
16 import FamInstEnv       ( FamInstEnv )
17 import Literal          ( litIsLifted ) --, mkMachInt ) -- temporalily commented out. See #8326
18 import Id
19 import MkId             ( seqId, realWorldPrimId )
20 import MkCore           ( mkImpossibleExpr, castBottomExpr )
21 import IdInfo
22 import Name             ( mkSystemVarName, isExternalName )
23 import Coercion hiding  ( substCo, substTy, substCoVar, extendTvSubst )
24 import OptCoercion      ( optCoercion )
25 import FamInstEnv       ( topNormaliseType )
26 import DataCon          ( DataCon, dataConWorkId, dataConRepStrictness
27                         , isMarkedStrict ) --, dataConTyCon, dataConTag, fIRST_TAG )
28 --import TyCon            ( isEnumerationTyCon ) -- temporalily commented out. See #8326
29 import CoreMonad        ( Tick(..), SimplifierMode(..) )
30 import CoreSyn
31 import Demand           ( StrictSig(..), dmdTypeDepth )
32 import PprCore          ( pprParendExpr, pprCoreExpr )
33 import CoreUnfold
34 import CoreUtils
35 import CoreArity
36 --import PrimOp           ( tagToEnumKey ) -- temporalily commented out. See #8326
37 import Rules            ( lookupRule, getRules )
38 import TysPrim          ( realWorldStatePrimTy ) --, intPrimTy ) -- temporalily commented out. See #8326
39 import BasicTypes       ( TopLevelFlag(..), isTopLevel, RecFlag(..) )
40 import MonadUtils       ( foldlM, mapAccumLM, liftIO )
41 import Maybes           ( orElse )
42 --import Unique           ( hasKey ) -- temporalily commented out. See #8326
43 import Control.Monad
44 import Data.List        ( mapAccumL )
45 import Outputable
46 import FastString
47 import Pair
48 import Util
49 import ErrUtils
50 \end{code}
51
52
53 The guts of the simplifier is in this module, but the driver loop for
54 the simplifier is in SimplCore.lhs.
55
56
57 -----------------------------------------
58         *** IMPORTANT NOTE ***
59 -----------------------------------------
60 The simplifier used to guarantee that the output had no shadowing, but
61 it does not do so any more.   (Actually, it never did!)  The reason is
62 documented with simplifyArgs.
63
64
65 -----------------------------------------
66         *** IMPORTANT NOTE ***
67 -----------------------------------------
68 Many parts of the simplifier return a bunch of "floats" as well as an
69 expression. This is wrapped as a datatype SimplUtils.FloatsWith.
70
71 All "floats" are let-binds, not case-binds, but some non-rec lets may
72 be unlifted (with RHS ok-for-speculation).
73
74
75
76 -----------------------------------------
77         ORGANISATION OF FUNCTIONS
78 -----------------------------------------
79 simplTopBinds
80   - simplify all top-level binders
81   - for NonRec, call simplRecOrTopPair
82   - for Rec,    call simplRecBind
83
84
85         ------------------------------
86 simplExpr (applied lambda)      ==> simplNonRecBind
87 simplExpr (Let (NonRec ...) ..) ==> simplNonRecBind
88 simplExpr (Let (Rec ...)    ..) ==> simplify binders; simplRecBind
89
90         ------------------------------
91 simplRecBind    [binders already simplfied]
92   - use simplRecOrTopPair on each pair in turn
93
94 simplRecOrTopPair [binder already simplified]
95   Used for: recursive bindings (top level and nested)
96             top-level non-recursive bindings
97   Returns:
98   - check for PreInlineUnconditionally
99   - simplLazyBind
100
101 simplNonRecBind
102   Used for: non-top-level non-recursive bindings
103             beta reductions (which amount to the same thing)
104   Because it can deal with strict arts, it takes a
105         "thing-inside" and returns an expression
106
107   - check for PreInlineUnconditionally
108   - simplify binder, including its IdInfo
109   - if strict binding
110         simplStrictArg
111         mkAtomicArgs
112         completeNonRecX
113     else
114         simplLazyBind
115         addFloats
116
117 simplNonRecX:   [given a *simplified* RHS, but an *unsimplified* binder]
118   Used for: binding case-binder and constr args in a known-constructor case
119   - check for PreInLineUnconditionally
120   - simplify binder
121   - completeNonRecX
122
123         ------------------------------
124 simplLazyBind:  [binder already simplified, RHS not]
125   Used for: recursive bindings (top level and nested)
126             top-level non-recursive bindings
127             non-top-level, but *lazy* non-recursive bindings
128         [must not be strict or unboxed]
129   Returns floats + an augmented environment, not an expression
130   - substituteIdInfo and add result to in-scope
131         [so that rules are available in rec rhs]
132   - simplify rhs
133   - mkAtomicArgs
134   - float if exposes constructor or PAP
135   - completeBind
136
137
138 completeNonRecX:        [binder and rhs both simplified]
139   - if the the thing needs case binding (unlifted and not ok-for-spec)
140         build a Case
141    else
142         completeBind
143         addFloats
144
145 completeBind:   [given a simplified RHS]
146         [used for both rec and non-rec bindings, top level and not]
147   - try PostInlineUnconditionally
148   - add unfolding [this is the only place we add an unfolding]
149   - add arity
150
151
152
153 Right hand sides and arguments
154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
155 In many ways we want to treat
156         (a) the right hand side of a let(rec), and
157         (b) a function argument
158 in the same way.  But not always!  In particular, we would
159 like to leave these arguments exactly as they are, so they
160 will match a RULE more easily.
161
162         f (g x, h x)
163         g (+ x)
164
165 It's harder to make the rule match if we ANF-ise the constructor,
166 or eta-expand the PAP:
167
168         f (let { a = g x; b = h x } in (a,b))
169         g (\y. + x y)
170
171 On the other hand if we see the let-defns
172
173         p = (g x, h x)
174         q = + x
175
176 then we *do* want to ANF-ise and eta-expand, so that p and q
177 can be safely inlined.
178
179 Even floating lets out is a bit dubious.  For let RHS's we float lets
180 out if that exposes a value, so that the value can be inlined more vigorously.
181 For example
182
183         r = let x = e in (x,x)
184
185 Here, if we float the let out we'll expose a nice constructor. We did experiments
186 that showed this to be a generally good thing.  But it was a bad thing to float
187 lets out unconditionally, because that meant they got allocated more often.
188
189 For function arguments, there's less reason to expose a constructor (it won't
190 get inlined).  Just possibly it might make a rule match, but I'm pretty skeptical.
191 So for the moment we don't float lets out of function arguments either.
192
193
194 Eta expansion
195 ~~~~~~~~~~~~~~
196 For eta expansion, we want to catch things like
197
198         case e of (a,b) -> \x -> case a of (p,q) -> \y -> r
199
200 If the \x was on the RHS of a let, we'd eta expand to bring the two
201 lambdas together.  And in general that's a good thing to do.  Perhaps
202 we should eta expand wherever we find a (value) lambda?  Then the eta
203 expansion at a let RHS can concentrate solely on the PAP case.
204
205
206 %************************************************************************
207 %*                                                                      *
208 \subsection{Bindings}
209 %*                                                                      *
210 %************************************************************************
211
212 \begin{code}
213 simplTopBinds :: SimplEnv -> [InBind] -> SimplM SimplEnv
214
215 simplTopBinds env0 binds0
216   = do  {       -- Put all the top-level binders into scope at the start
217                 -- so that if a transformation rule has unexpectedly brought
218                 -- anything into scope, then we don't get a complaint about that.
219                 -- It's rather as if the top-level binders were imported.
220                 -- See note [Glomming] in OccurAnal.
221         ; env1 <- simplRecBndrs env0 (bindersOfBinds binds0)
222         ; dflags <- getDynFlags
223         ; let dump_flag = dopt Opt_D_verbose_core2core dflags
224         ; env2 <- simpl_binds dump_flag env1 binds0
225         ; freeTick SimplifierDone
226         ; return env2 }
227   where
228         -- We need to track the zapped top-level binders, because
229         -- they should have their fragile IdInfo zapped (notably occurrence info)
230         -- That's why we run down binds and bndrs' simultaneously.
231         --
232         -- The dump-flag emits a trace for each top-level binding, which
233         -- helps to locate the tracing for inlining and rule firing
234     simpl_binds :: Bool -> SimplEnv -> [InBind] -> SimplM SimplEnv
235     simpl_binds _    env []           = return env
236     simpl_binds dump env (bind:binds) = do { env' <- trace_bind dump bind $
237                                                      simpl_bind env bind
238                                            ; simpl_binds dump env' binds }
239
240     trace_bind True  bind = pprTrace "SimplBind" (ppr (bindersOf bind))
241     trace_bind False _    = \x -> x
242
243     simpl_bind env (Rec pairs)  = simplRecBind      env  TopLevel pairs
244     simpl_bind env (NonRec b r) = simplRecOrTopPair env' TopLevel NonRecursive b b' r
245         where
246           (env', b') = addBndrRules env b (lookupRecBndr env b)
247 \end{code}
248
249
250 %************************************************************************
251 %*                                                                      *
252 \subsection{Lazy bindings}
253 %*                                                                      *
254 %************************************************************************
255
256 simplRecBind is used for
257         * recursive bindings only
258
259 \begin{code}
260 simplRecBind :: SimplEnv -> TopLevelFlag
261              -> [(InId, InExpr)]
262              -> SimplM SimplEnv
263 simplRecBind env0 top_lvl pairs0
264   = do  { let (env_with_info, triples) = mapAccumL add_rules env0 pairs0
265         ; env1 <- go (zapFloats env_with_info) triples
266         ; return (env0 `addRecFloats` env1) }
267         -- addFloats adds the floats from env1,
268         -- _and_ updates env0 with the in-scope set from env1
269   where
270     add_rules :: SimplEnv -> (InBndr,InExpr) -> (SimplEnv, (InBndr, OutBndr, InExpr))
271         -- Add the (substituted) rules to the binder
272     add_rules env (bndr, rhs) = (env', (bndr, bndr', rhs))
273         where
274           (env', bndr') = addBndrRules env bndr (lookupRecBndr env bndr)
275
276     go env [] = return env
277
278     go env ((old_bndr, new_bndr, rhs) : pairs)
279         = do { env' <- simplRecOrTopPair env top_lvl Recursive old_bndr new_bndr rhs
280              ; go env' pairs }
281 \end{code}
282
283 simplOrTopPair is used for
284         * recursive bindings (whether top level or not)
285         * top-level non-recursive bindings
286
287 It assumes the binder has already been simplified, but not its IdInfo.
288
289 \begin{code}
290 simplRecOrTopPair :: SimplEnv
291                   -> TopLevelFlag -> RecFlag
292                   -> InId -> OutBndr -> InExpr  -- Binder and rhs
293                   -> SimplM SimplEnv    -- Returns an env that includes the binding
294
295 simplRecOrTopPair env top_lvl is_rec old_bndr new_bndr rhs
296   = do dflags <- getDynFlags
297        -- Check for unconditional inline
298        if preInlineUnconditionally dflags env top_lvl old_bndr rhs
299            then do tick (PreInlineUnconditionally old_bndr)
300                    return (extendIdSubst env old_bndr (mkContEx env rhs))
301            else simplLazyBind env top_lvl is_rec old_bndr new_bndr rhs env
302 \end{code}
303
304
305 simplLazyBind is used for
306   * [simplRecOrTopPair] recursive bindings (whether top level or not)
307   * [simplRecOrTopPair] top-level non-recursive bindings
308   * [simplNonRecE]      non-top-level *lazy* non-recursive bindings
309
310 Nota bene:
311     1. It assumes that the binder is *already* simplified,
312        and is in scope, and its IdInfo too, except unfolding
313
314     2. It assumes that the binder type is lifted.
315
316     3. It does not check for pre-inline-unconditionallly;
317        that should have been done already.
318
319 \begin{code}
320 simplLazyBind :: SimplEnv
321               -> TopLevelFlag -> RecFlag
322               -> InId -> OutId          -- Binder, both pre-and post simpl
323                                         -- The OutId has IdInfo, except arity, unfolding
324               -> InExpr -> SimplEnv     -- The RHS and its environment
325               -> SimplM SimplEnv
326
327 simplLazyBind env top_lvl is_rec bndr bndr1 rhs rhs_se
328   = -- pprTrace "simplLazyBind" ((ppr bndr <+> ppr bndr1) $$ ppr rhs $$ ppr (seIdSubst rhs_se)) $
329     do  { let   rhs_env     = rhs_se `setInScope` env
330                 (tvs, body) = case collectTyBinders rhs of
331                                 (tvs, body) | not_lam body -> (tvs,body)
332                                             | otherwise    -> ([], rhs)
333                 not_lam (Lam _ _) = False
334                 not_lam _         = True
335                         -- Do not do the "abstract tyyvar" thing if there's
336                         -- a lambda inside, because it defeats eta-reduction
337                         --    f = /\a. \x. g a x
338                         -- should eta-reduce
339
340
341         ; (body_env, tvs') <- simplBinders rhs_env tvs
342                 -- See Note [Floating and type abstraction] in SimplUtils
343
344         -- Simplify the RHS
345         ; let   body_out_ty :: OutType
346                 body_out_ty = substTy body_env (exprType body)
347         ; (body_env1, body1) <- simplExprF body_env body (mkRhsStop body_out_ty)
348         -- ANF-ise a constructor or PAP rhs
349         ; (body_env2, body2) <- prepareRhs top_lvl body_env1 bndr1 body1
350
351         ; (env', rhs')
352             <-  if not (doFloatFromRhs top_lvl is_rec False body2 body_env2)
353                 then                            -- No floating, revert to body1
354                      do { rhs' <- mkLam env tvs' (wrapFloats body_env1 body1)
355                         ; return (env, rhs') }
356
357                 else if null tvs then           -- Simple floating
358                      do { tick LetFloatFromLet
359                         ; return (addFloats env body_env2, body2) }
360
361                 else                            -- Do type-abstraction first
362                      do { tick LetFloatFromLet
363                         ; (poly_binds, body3) <- abstractFloats tvs' body_env2 body2
364                         ; rhs' <- mkLam env tvs' body3
365                         ; env' <- foldlM (addPolyBind top_lvl) env poly_binds
366                         ; return (env', rhs') }
367
368         ; completeBind env' top_lvl bndr bndr1 rhs' }
369 \end{code}
370
371 A specialised variant of simplNonRec used when the RHS is already simplified,
372 notably in knownCon.  It uses case-binding where necessary.
373
374 \begin{code}
375 simplNonRecX :: SimplEnv
376              -> InId            -- Old binder
377              -> OutExpr         -- Simplified RHS
378              -> SimplM SimplEnv
379
380 simplNonRecX env bndr new_rhs
381   | isDeadBinder bndr   -- Not uncommon; e.g. case (a,b) of c { (p,q) -> p }
382   = return env          --               Here c is dead, and we avoid creating
383                         --               the binding c = (a,b)
384   | Coercion co <- new_rhs
385   = return (extendCvSubst env bndr co)
386   | otherwise           --               the binding b = (a,b)
387   = do  { (env', bndr') <- simplBinder env bndr
388         ; completeNonRecX NotTopLevel env' (isStrictId bndr) bndr bndr' new_rhs }
389                 -- simplNonRecX is only used for NotTopLevel things
390
391 completeNonRecX :: TopLevelFlag -> SimplEnv
392                 -> Bool
393                 -> InId                 -- Old binder
394                 -> OutId                -- New binder
395                 -> OutExpr              -- Simplified RHS
396                 -> SimplM SimplEnv
397
398 completeNonRecX top_lvl env is_strict old_bndr new_bndr new_rhs
399   = do  { (env1, rhs1) <- prepareRhs top_lvl (zapFloats env) new_bndr new_rhs
400         ; (env2, rhs2) <-
401                 if doFloatFromRhs NotTopLevel NonRecursive is_strict rhs1 env1
402                 then do { tick LetFloatFromLet
403                         ; return (addFloats env env1, rhs1) }   -- Add the floats to the main env
404                 else return (env, wrapFloats env1 rhs1)         -- Wrap the floats around the RHS
405         ; completeBind env2 NotTopLevel old_bndr new_bndr rhs2 }
406 \end{code}
407
408 {- No, no, no!  Do not try preInlineUnconditionally in completeNonRecX
409    Doing so risks exponential behaviour, because new_rhs has been simplified once already
410    In the cases described by the folowing commment, postInlineUnconditionally will
411    catch many of the relevant cases.
412         -- This happens; for example, the case_bndr during case of
413         -- known constructor:  case (a,b) of x { (p,q) -> ... }
414         -- Here x isn't mentioned in the RHS, so we don't want to
415         -- create the (dead) let-binding  let x = (a,b) in ...
416         --
417         -- Similarly, single occurrences can be inlined vigourously
418         -- e.g.  case (f x, g y) of (a,b) -> ....
419         -- If a,b occur once we can avoid constructing the let binding for them.
420
421    Furthermore in the case-binding case preInlineUnconditionally risks extra thunks
422         -- Consider     case I# (quotInt# x y) of
423         --                I# v -> let w = J# v in ...
424         -- If we gaily inline (quotInt# x y) for v, we end up building an
425         -- extra thunk:
426         --                let w = J# (quotInt# x y) in ...
427         -- because quotInt# can fail.
428
429   | preInlineUnconditionally env NotTopLevel bndr new_rhs
430   = thing_inside (extendIdSubst env bndr (DoneEx new_rhs))
431 -}
432
433 ----------------------------------
434 prepareRhs takes a putative RHS, checks whether it's a PAP or
435 constructor application and, if so, converts it to ANF, so that the
436 resulting thing can be inlined more easily.  Thus
437         x = (f a, g b)
438 becomes
439         t1 = f a
440         t2 = g b
441         x = (t1,t2)
442
443 We also want to deal well cases like this
444         v = (f e1 `cast` co) e2
445 Here we want to make e1,e2 trivial and get
446         x1 = e1; x2 = e2; v = (f x1 `cast` co) v2
447 That's what the 'go' loop in prepareRhs does
448
449 \begin{code}
450 prepareRhs :: TopLevelFlag -> SimplEnv -> OutId -> OutExpr -> SimplM (SimplEnv, OutExpr)
451 -- Adds new floats to the env iff that allows us to return a good RHS
452 prepareRhs top_lvl env id (Cast rhs co)    -- Note [Float coercions]
453   | Pair ty1 _ty2 <- coercionKind co       -- Do *not* do this if rhs has an unlifted type
454   , not (isUnLiftedType ty1)            -- see Note [Float coercions (unlifted)]
455   = do  { (env', rhs') <- makeTrivialWithInfo top_lvl env sanitised_info rhs
456         ; return (env', Cast rhs' co) }
457   where
458     sanitised_info = vanillaIdInfo `setStrictnessInfo` strictnessInfo info
459                                    `setDemandInfo` demandInfo info
460     info = idInfo id
461
462 prepareRhs top_lvl env0 _ rhs0
463   = do  { (_is_exp, env1, rhs1) <- go 0 env0 rhs0
464         ; return (env1, rhs1) }
465   where
466     go n_val_args env (Cast rhs co)
467         = do { (is_exp, env', rhs') <- go n_val_args env rhs
468              ; return (is_exp, env', Cast rhs' co) }
469     go n_val_args env (App fun (Type ty))
470         = do { (is_exp, env', rhs') <- go n_val_args env fun
471              ; return (is_exp, env', App rhs' (Type ty)) }
472     go n_val_args env (App fun arg)
473         = do { (is_exp, env', fun') <- go (n_val_args+1) env fun
474              ; case is_exp of
475                 True -> do { (env'', arg') <- makeTrivial top_lvl env' arg
476                            ; return (True, env'', App fun' arg') }
477                 False -> return (False, env, App fun arg) }
478     go n_val_args env (Var fun)
479         = return (is_exp, env, Var fun)
480         where
481           is_exp = isExpandableApp fun n_val_args   -- The fun a constructor or PAP
482                         -- See Note [CONLIKE pragma] in BasicTypes
483                         -- The definition of is_exp should match that in
484                         -- OccurAnal.occAnalApp
485
486     go _ env other
487         = return (False, env, other)
488 \end{code}
489
490
491 Note [Float coercions]
492 ~~~~~~~~~~~~~~~~~~~~~~
493 When we find the binding
494         x = e `cast` co
495 we'd like to transform it to
496         x' = e
497         x = x `cast` co         -- A trivial binding
498 There's a chance that e will be a constructor application or function, or something
499 like that, so moving the coerion to the usage site may well cancel the coersions
500 and lead to further optimisation.  Example:
501
502      data family T a :: *
503      data instance T Int = T Int
504
505      foo :: Int -> Int -> Int
506      foo m n = ...
507         where
508           x = T m
509           go 0 = 0
510           go n = case x of { T m -> go (n-m) }
511                 -- This case should optimise
512
513 Note [Preserve strictness when floating coercions]
514 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
515 In the Note [Float coercions] transformation, keep the strictness info.
516 Eg
517         f = e `cast` co    -- f has strictness SSL
518 When we transform to
519         f' = e             -- f' also has strictness SSL
520         f = f' `cast` co   -- f still has strictness SSL
521
522 Its not wrong to drop it on the floor, but better to keep it.
523
524 Note [Float coercions (unlifted)]
525 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
526 BUT don't do [Float coercions] if 'e' has an unlifted type.
527 This *can* happen:
528
529      foo :: Int = (error (# Int,Int #) "urk")
530                   `cast` CoUnsafe (# Int,Int #) Int
531
532 If do the makeTrivial thing to the error call, we'll get
533     foo = case error (# Int,Int #) "urk" of v -> v `cast` ...
534 But 'v' isn't in scope!
535
536 These strange casts can happen as a result of case-of-case
537         bar = case (case x of { T -> (# 2,3 #); F -> error "urk" }) of
538                 (# p,q #) -> p+q
539
540
541 \begin{code}
542 makeTrivialArg :: SimplEnv -> ArgSpec -> SimplM (SimplEnv, ArgSpec)
543 makeTrivialArg env (ValArg e)  = do { (env', e') <- makeTrivial NotTopLevel env e
544                                     ; return (env', ValArg e') }
545 makeTrivialArg env (CastBy co) = return (env, CastBy co)
546
547 makeTrivial :: TopLevelFlag -> SimplEnv -> OutExpr -> SimplM (SimplEnv, OutExpr)
548 -- Binds the expression to a variable, if it's not trivial, returning the variable
549 makeTrivial top_lvl env expr = makeTrivialWithInfo top_lvl env vanillaIdInfo expr
550
551 makeTrivialWithInfo :: TopLevelFlag -> SimplEnv -> IdInfo
552                     -> OutExpr -> SimplM (SimplEnv, OutExpr)
553 -- Propagate strictness and demand info to the new binder
554 -- Note [Preserve strictness when floating coercions]
555 -- Returned SimplEnv has same substitution as incoming one
556 makeTrivialWithInfo top_lvl env info expr
557   | exprIsTrivial expr                          -- Already trivial
558   || not (bindingOk top_lvl expr expr_ty)       -- Cannot trivialise
559                                                 --   See Note [Cannot trivialise]
560   = return (env, expr)
561   | otherwise           -- See Note [Take care] below
562   = do  { uniq <- getUniqueM
563         ; let name = mkSystemVarName uniq (fsLit "a")
564               var = mkLocalIdWithInfo name expr_ty info
565         ; env'  <- completeNonRecX top_lvl env False var var expr
566         ; expr' <- simplVar env' var
567         ; return (env', expr') }
568         -- The simplVar is needed becase we're constructing a new binding
569         --     a = rhs
570         -- And if rhs is of form (rhs1 |> co), then we might get
571         --     a1 = rhs1
572         --     a = a1 |> co
573         -- and now a's RHS is trivial and can be substituted out, and that
574         -- is what completeNonRecX will do
575         -- To put it another way, it's as if we'd simplified
576         --    let var = e in var
577   where
578     expr_ty = exprType expr
579
580 bindingOk :: TopLevelFlag -> CoreExpr -> Type -> Bool
581 -- True iff we can have a binding of this expression at this level
582 -- Precondition: the type is the type of the expression
583 bindingOk top_lvl _ expr_ty
584   | isTopLevel top_lvl = not (isUnLiftedType expr_ty)
585   | otherwise          = True
586 \end{code}
587
588 Note [Cannot trivialise]
589 ~~~~~~~~~~~~~~~~~~~~~~~~
590 Consider tih
591    f :: Int -> Addr#
592
593    foo :: Bar
594    foo = Bar (f 3)
595
596 Then we can't ANF-ise foo, even though we'd like to, because
597 we can't make a top-level binding for the Addr# (f 3). And if
598 so we don't want to turn it into
599    foo = let x = f 3 in Bar x
600 because we'll just end up inlining x back, and that makes the
601 simplifier loop.  Better not to ANF-ise it at all.
602
603 A case in point is literal strings (a MachStr is not regarded as
604 trivial):
605
606    foo = Ptr "blob"#
607
608 We don't want to ANF-ise this.
609
610 %************************************************************************
611 %*                                                                      *
612 \subsection{Completing a lazy binding}
613 %*                                                                      *
614 %************************************************************************
615
616 completeBind
617   * deals only with Ids, not TyVars
618   * takes an already-simplified binder and RHS
619   * is used for both recursive and non-recursive bindings
620   * is used for both top-level and non-top-level bindings
621
622 It does the following:
623   - tries discarding a dead binding
624   - tries PostInlineUnconditionally
625   - add unfolding [this is the only place we add an unfolding]
626   - add arity
627
628 It does *not* attempt to do let-to-case.  Why?  Because it is used for
629   - top-level bindings (when let-to-case is impossible)
630   - many situations where the "rhs" is known to be a WHNF
631                 (so let-to-case is inappropriate).
632
633 Nor does it do the atomic-argument thing
634
635 \begin{code}
636 completeBind :: SimplEnv
637              -> TopLevelFlag            -- Flag stuck into unfolding
638              -> InId                    -- Old binder
639              -> OutId -> OutExpr        -- New binder and RHS
640              -> SimplM SimplEnv
641 -- completeBind may choose to do its work
642 --      * by extending the substitution (e.g. let x = y in ...)
643 --      * or by adding to the floats in the envt
644
645 completeBind env top_lvl old_bndr new_bndr new_rhs
646  | isCoVar old_bndr
647  = case new_rhs of
648      Coercion co -> return (extendCvSubst env old_bndr co)
649      _           -> return (addNonRec env new_bndr new_rhs)
650
651  | otherwise
652  = ASSERT( isId new_bndr )
653    do { let old_info = idInfo old_bndr
654             old_unf  = unfoldingInfo old_info
655             occ_info = occInfo old_info
656
657         -- Do eta-expansion on the RHS of the binding
658         -- See Note [Eta-expanding at let bindings] in SimplUtils
659       ; (new_arity, final_rhs) <- tryEtaExpand env new_bndr new_rhs
660
661         -- Simplify the unfolding
662       ; new_unfolding <- simplUnfolding env top_lvl old_bndr final_rhs old_unf
663
664       ; dflags <- getDynFlags
665       ; if postInlineUnconditionally dflags env top_lvl new_bndr occ_info
666                                      final_rhs new_unfolding
667
668                         -- Inline and discard the binding
669         then do  { tick (PostInlineUnconditionally old_bndr)
670                  ; return (extendIdSubst env old_bndr (DoneEx final_rhs)) }
671                 -- Use the substitution to make quite, quite sure that the
672                 -- substitution will happen, since we are going to discard the binding
673         else
674    do { let info1 = idInfo new_bndr `setArityInfo` new_arity
675
676               -- Unfolding info: Note [Setting the new unfolding]
677             info2 = info1 `setUnfoldingInfo` new_unfolding
678
679               -- Demand info: Note [Setting the demand info]
680               --
681               -- We also have to nuke demand info if for some reason
682               -- eta-expansion *reduces* the arity of the binding to less
683               -- than that of the strictness sig. This can happen: see Note [Arity decrease].
684             info3 | isEvaldUnfolding new_unfolding
685                     || (case strictnessInfo info2 of
686                           StrictSig dmd_ty -> new_arity < dmdTypeDepth dmd_ty)
687                   = zapDemandInfo info2 `orElse` info2
688                   | otherwise
689                   = info2
690
691             final_id = new_bndr `setIdInfo` info3
692
693       ; -- pprTrace "Binding" (ppr final_id <+> ppr new_unfolding) $
694         return (addNonRec env final_id final_rhs) } }
695                 -- The addNonRec adds it to the in-scope set too
696
697 ------------------------------
698 addPolyBind :: TopLevelFlag -> SimplEnv -> OutBind -> SimplM SimplEnv
699 -- Add a new binding to the environment, complete with its unfolding
700 -- but *do not* do postInlineUnconditionally, because we have already
701 -- processed some of the scope of the binding
702 -- We still want the unfolding though.  Consider
703 --      let
704 --            x = /\a. let y = ... in Just y
705 --      in body
706 -- Then we float the y-binding out (via abstractFloats and addPolyBind)
707 -- but 'x' may well then be inlined in 'body' in which case we'd like the
708 -- opportunity to inline 'y' too.
709 --
710 -- INVARIANT: the arity is correct on the incoming binders
711
712 addPolyBind top_lvl env (NonRec poly_id rhs)
713   = do  { unfolding <- simplUnfolding env top_lvl poly_id rhs noUnfolding
714                         -- Assumes that poly_id did not have an INLINE prag
715                         -- which is perhaps wrong.  ToDo: think about this
716         ; let final_id = setIdInfo poly_id $
717                          idInfo poly_id `setUnfoldingInfo` unfolding
718
719         ; return (addNonRec env final_id rhs) }
720
721 addPolyBind _ env bind@(Rec _)
722   = return (extendFloats env bind)
723         -- Hack: letrecs are more awkward, so we extend "by steam"
724         -- without adding unfoldings etc.  At worst this leads to
725         -- more simplifier iterations
726
727 ------------------------------
728 simplUnfolding :: SimplEnv-> TopLevelFlag
729                -> InId
730                -> OutExpr
731                -> Unfolding -> SimplM Unfolding
732 -- Note [Setting the new unfolding]
733 simplUnfolding env _ _ _ df@(DFunUnfolding { df_bndrs = bndrs, df_args = args })
734   = do { (env', bndrs') <- simplBinders env bndrs
735        ; args' <- mapM (simplExpr env') args
736        ; return (df { df_bndrs = bndrs', df_args  = args' }) }
737
738 simplUnfolding env top_lvl id _
739     (CoreUnfolding { uf_tmpl = expr, uf_arity = arity
740                    , uf_src = src, uf_guidance = guide })
741   | isStableSource src
742   = do { expr' <- simplExpr rule_env expr
743        ; let is_top_lvl = isTopLevel top_lvl
744        ; case guide of
745            UnfWhen sat_ok _    -- Happens for INLINE things
746               -> let guide' = UnfWhen sat_ok (inlineBoringOk expr')
747                      -- Refresh the boring-ok flag, in case expr'
748                      -- has got small. This happens, notably in the inlinings
749                      -- for dfuns for single-method classes; see
750                      -- Note [Single-method classes] in TcInstDcls.
751                      -- A test case is Trac #4138
752                  in return (mkCoreUnfolding src is_top_lvl expr' arity guide')
753                  -- See Note [Top-level flag on inline rules] in CoreUnfold
754
755            _other              -- Happens for INLINABLE things
756               -> let bottoming = isBottomingId id
757                  in bottoming `seq` -- See Note [Force bottoming field]
758                     do dflags <- getDynFlags
759                        return (mkUnfolding dflags src is_top_lvl bottoming expr')
760                 -- If the guidance is UnfIfGoodArgs, this is an INLINABLE
761                 -- unfolding, and we need to make sure the guidance is kept up
762                 -- to date with respect to any changes in the unfolding.
763        }
764   where
765     act      = idInlineActivation id
766     rule_env = updMode (updModeForInlineRules act) env
767                -- See Note [Simplifying inside InlineRules] in SimplUtils
768
769 simplUnfolding _ top_lvl id new_rhs _
770   = let bottoming = isBottomingId id
771     in bottoming `seq`  -- See Note [Force bottoming field]
772        do dflags <- getDynFlags
773           return (mkUnfolding dflags InlineRhs (isTopLevel top_lvl) bottoming new_rhs)
774           -- We make an  unfolding *even for loop-breakers*.
775           -- Reason: (a) It might be useful to know that they are WHNF
776           --         (b) In TidyPgm we currently assume that, if we want to
777           --             expose the unfolding then indeed we *have* an unfolding
778           --             to expose.  (We could instead use the RHS, but currently
779           --             we don't.)  The simple thing is always to have one.
780 \end{code}
781
782 Note [Force bottoming field]
783 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
784 We need to force bottoming, or the new unfolding holds
785 on to the old unfolding (which is part of the id).
786
787 Note [Arity decrease]
788 ~~~~~~~~~~~~~~~~~~~~~
789 Generally speaking the arity of a binding should not decrease.  But it *can*
790 legitimately happen because of RULES.  Eg
791         f = g Int
792 where g has arity 2, will have arity 2.  But if there's a rewrite rule
793         g Int --> h
794 where h has arity 1, then f's arity will decrease.  Here's a real-life example,
795 which is in the output of Specialise:
796
797      Rec {
798         $dm {Arity 2} = \d.\x. op d
799         {-# RULES forall d. $dm Int d = $s$dm #-}
800
801         dInt = MkD .... opInt ...
802         opInt {Arity 1} = $dm dInt
803
804         $s$dm {Arity 0} = \x. op dInt }
805
806 Here opInt has arity 1; but when we apply the rule its arity drops to 0.
807 That's why Specialise goes to a little trouble to pin the right arity
808 on specialised functions too.
809
810 Note [Setting the new unfolding]
811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
812 * If there's an INLINE pragma, we simplify the RHS gently.  Maybe we
813   should do nothing at all, but simplifying gently might get rid of
814   more crap.
815
816 * If not, we make an unfolding from the new RHS.  But *only* for
817   non-loop-breakers. Making loop breakers not have an unfolding at all
818   means that we can avoid tests in exprIsConApp, for example.  This is
819   important: if exprIsConApp says 'yes' for a recursive thing, then we
820   can get into an infinite loop
821
822 If there's an InlineRule on a loop breaker, we hang on to the inlining.
823 It's pretty dodgy, but the user did say 'INLINE'.  May need to revisit
824 this choice.
825
826 Note [Setting the demand info]
827 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
828 If the unfolding is a value, the demand info may
829 go pear-shaped, so we nuke it.  Example:
830      let x = (a,b) in
831      case x of (p,q) -> h p q x
832 Here x is certainly demanded. But after we've nuked
833 the case, we'll get just
834      let x = (a,b) in h a b x
835 and now x is not demanded (I'm assuming h is lazy)
836 This really happens.  Similarly
837      let f = \x -> e in ...f..f...
838 After inlining f at some of its call sites the original binding may
839 (for example) be no longer strictly demanded.
840 The solution here is a bit ad hoc...
841
842
843 %************************************************************************
844 %*                                                                      *
845 \subsection[Simplify-simplExpr]{The main function: simplExpr}
846 %*                                                                      *
847 %************************************************************************
848
849 The reason for this OutExprStuff stuff is that we want to float *after*
850 simplifying a RHS, not before.  If we do so naively we get quadratic
851 behaviour as things float out.
852
853 To see why it's important to do it after, consider this (real) example:
854
855         let t = f x
856         in fst t
857 ==>
858         let t = let a = e1
859                     b = e2
860                 in (a,b)
861         in fst t
862 ==>
863         let a = e1
864             b = e2
865             t = (a,b)
866         in
867         a       -- Can't inline a this round, cos it appears twice
868 ==>
869         e1
870
871 Each of the ==> steps is a round of simplification.  We'd save a
872 whole round if we float first.  This can cascade.  Consider
873
874         let f = g d
875         in \x -> ...f...
876 ==>
877         let f = let d1 = ..d.. in \y -> e
878         in \x -> ...f...
879 ==>
880         let d1 = ..d..
881         in \x -> ...(\y ->e)...
882
883 Only in this second round can the \y be applied, and it
884 might do the same again.
885
886
887 \begin{code}
888 simplExpr :: SimplEnv -> CoreExpr -> SimplM CoreExpr
889 simplExpr env expr = simplExprC env expr (mkBoringStop expr_out_ty)
890   where
891     expr_out_ty :: OutType
892     expr_out_ty = substTy env (exprType expr)
893
894 simplExprC :: SimplEnv -> CoreExpr -> SimplCont -> SimplM CoreExpr
895         -- Simplify an expression, given a continuation
896 simplExprC env expr cont
897   = -- pprTrace "simplExprC" (ppr expr $$ ppr cont {- $$ ppr (seIdSubst env) -} $$ ppr (seFloats env) ) $
898     do  { (env', expr') <- simplExprF (zapFloats env) expr cont
899         ; -- pprTrace "simplExprC ret" (ppr expr $$ ppr expr') $
900           -- pprTrace "simplExprC ret3" (ppr (seInScope env')) $
901           -- pprTrace "simplExprC ret4" (ppr (seFloats env')) $
902           return (wrapFloats env' expr') }
903
904 --------------------------------------------------
905 simplExprF :: SimplEnv -> InExpr -> SimplCont
906            -> SimplM (SimplEnv, OutExpr)
907
908 simplExprF env e cont
909   = {- pprTrace "simplExprF" (vcat
910       [ ppr e
911       , text "cont =" <+> ppr cont
912       , text "inscope =" <+> ppr (seInScope env)
913       , text "tvsubst =" <+> ppr (seTvSubst env)
914       , text "idsubst =" <+> ppr (seIdSubst env)
915       , text "cvsubst =" <+> ppr (seCvSubst env)
916       {- , ppr (seFloats env) -}
917       ]) $ -}
918     simplExprF1 env e cont
919
920 simplExprF1 :: SimplEnv -> InExpr -> SimplCont
921             -> SimplM (SimplEnv, OutExpr)
922 simplExprF1 env (Var v)        cont = simplIdF env v cont
923 simplExprF1 env (Lit lit)      cont = rebuild env (Lit lit) cont
924 simplExprF1 env (Tick t expr)  cont = simplTick env t expr cont
925 simplExprF1 env (Cast body co) cont = simplCast env body co cont
926 simplExprF1 env (Coercion co)  cont = simplCoercionF env co cont
927 simplExprF1 env (Type ty)      cont = ASSERT( contIsRhsOrArg cont )
928                                       rebuild env (Type (substTy env ty)) cont
929 simplExprF1 env (App fun arg)  cont = simplExprF env fun $
930                                       ApplyTo NoDup arg env cont
931
932 simplExprF1 env expr@(Lam {}) cont
933   = simplLam env zapped_bndrs body cont
934         -- The main issue here is under-saturated lambdas
935         --   (\x1. \x2. e) arg1
936         -- Here x1 might have "occurs-once" occ-info, because occ-info
937         -- is computed assuming that a group of lambdas is applied
938         -- all at once.  If there are too few args, we must zap the
939         -- occ-info, UNLESS the remaining binders are one-shot
940   where
941     (bndrs, body) = collectBinders expr
942     zapped_bndrs | need_to_zap = map zap bndrs
943                  | otherwise   = bndrs
944
945     need_to_zap = any zappable_bndr (drop n_args bndrs)
946     n_args = countArgs cont
947         -- NB: countArgs counts all the args (incl type args)
948         -- and likewise drop counts all binders (incl type lambdas)
949
950     zappable_bndr b = isId b && not (isOneShotBndr b)
951     zap b | isTyVar b = b
952           | otherwise = zapLamIdInfo b
953
954 simplExprF1 env (Case scrut bndr alts_ty alts) cont
955   | sm_case_case (getMode env)
956   =     -- Simplify the scrutinee with a Select continuation
957     simplExprF env scrut (Select NoDup bndr alts env cont)
958
959   | otherwise
960   =     -- If case-of-case is off, simply simplify the case expression
961         -- in a vanilla Stop context, and rebuild the result around it
962     do  { case_expr' <- simplExprC env scrut
963                              (Select NoDup bndr alts env (mkBoringStop alts_out_ty))
964         ; rebuild env case_expr' cont }
965   where
966     alts_out_ty = substTy env alts_ty
967
968 simplExprF1 env (Let (Rec pairs) body) cont
969   = do  { env' <- simplRecBndrs env (map fst pairs)
970                 -- NB: bndrs' don't have unfoldings or rules
971                 -- We add them as we go down
972
973         ; env'' <- simplRecBind env' NotTopLevel pairs
974         ; simplExprF env'' body cont }
975
976 simplExprF1 env (Let (NonRec bndr rhs) body) cont
977   = simplNonRecE env bndr (rhs, env) ([], body) cont
978
979 ---------------------------------
980 simplType :: SimplEnv -> InType -> SimplM OutType
981         -- Kept monadic just so we can do the seqType
982 simplType env ty
983   = -- pprTrace "simplType" (ppr ty $$ ppr (seTvSubst env)) $
984     seqType new_ty `seq` return new_ty
985   where
986     new_ty = substTy env ty
987
988 ---------------------------------
989 simplCoercionF :: SimplEnv -> InCoercion -> SimplCont
990                -> SimplM (SimplEnv, OutExpr)
991 simplCoercionF env co cont
992   = do { co' <- simplCoercion env co
993        ; rebuild env (Coercion co') cont }
994
995 simplCoercion :: SimplEnv -> InCoercion -> SimplM OutCoercion
996 simplCoercion env co
997   = let opt_co = optCoercion (getCvSubst env) co
998     in seqCo opt_co `seq` return opt_co
999
1000 -----------------------------------
1001 -- | Push a TickIt context outwards past applications and cases, as
1002 -- long as this is a non-scoping tick, to let case and application
1003 -- optimisations apply.
1004
1005 simplTick :: SimplEnv -> Tickish Id -> InExpr -> SimplCont
1006           -> SimplM (SimplEnv, OutExpr)
1007 simplTick env tickish expr cont
1008   -- A scoped tick turns into a continuation, so that we can spot
1009   -- (scc t (\x . e)) in simplLam and eliminate the scc.  If we didn't do
1010   -- it this way, then it would take two passes of the simplifier to
1011   -- reduce ((scc t (\x . e)) e').
1012   -- NB, don't do this with counting ticks, because if the expr is
1013   -- bottom, then rebuildCall will discard the continuation.
1014
1015 -- XXX: we cannot do this, because the simplifier assumes that
1016 -- the context can be pushed into a case with a single branch. e.g.
1017 --    scc<f>  case expensive of p -> e
1018 -- becomes
1019 --    case expensive of p -> scc<f> e
1020 --
1021 -- So I'm disabling this for now.  It just means we will do more
1022 -- simplifier iterations that necessary in some cases.
1023
1024 --  | tickishScoped tickish && not (tickishCounts tickish)
1025 --  = simplExprF env expr (TickIt tickish cont)
1026
1027   -- For non-scoped ticks, we push the continuation inside the
1028   -- tick.  This has the effect of moving the tick to the outside of a
1029   -- case or application context, allowing the normal case and
1030   -- application optimisations to fire.
1031   | not (tickishScoped tickish)
1032   = do { (env', expr') <- simplExprF env expr cont
1033        ; return (env', mkTick tickish expr')
1034        }
1035
1036   -- For breakpoints, we cannot do any floating of bindings around the
1037   -- tick, because breakpoints cannot be split into tick/scope pairs.
1038   | not (tickishCanSplit tickish)
1039   = no_floating_past_tick
1040
1041   | interesting_cont, Just expr' <- push_tick_inside tickish expr
1042     -- see Note [case-of-scc-of-case]
1043   = simplExprF env expr' cont
1044
1045   | otherwise
1046   = no_floating_past_tick -- was: wrap_floats, see below
1047
1048  where
1049   interesting_cont = case cont of
1050                         Select {} -> True
1051                         _ -> False
1052
1053   push_tick_inside t expr0
1054      | not (tickishCanSplit t) = Nothing
1055      | otherwise
1056        = case expr0 of
1057            Tick t' expr
1058               -- scc t (tick t' E)
1059               --   Pull the tick to the outside
1060               -- This one is important for #5363
1061               | not (tickishScoped t')
1062                  -> Just (Tick t' (Tick t expr))
1063
1064               -- scc t (scc t' E)
1065               --   Try to push t' into E first, and if that works,
1066               --   try to push t in again
1067               | Just expr' <- push_tick_inside t' expr
1068                  -> push_tick_inside t expr'
1069
1070               | otherwise -> Nothing
1071
1072            Case scrut bndr ty alts
1073               -> Just (Case (mkTick t scrut) bndr ty alts')
1074              where t_scope = mkNoTick t -- drop the tick on the dup'd ones
1075                    alts'   = [ (c,bs, mkTick t_scope e) | (c,bs,e) <- alts]
1076            _other -> Nothing
1077     where
1078
1079   no_floating_past_tick =
1080     do { let (inc,outc) = splitCont cont
1081        ; (env', expr') <- simplExprF (zapFloats env) expr inc
1082        ; let tickish' = simplTickish env tickish
1083        ; (env'', expr'') <- rebuild (zapFloats env')
1084                                     (wrapFloats env' expr')
1085                                     (TickIt tickish' outc)
1086        ; return (addFloats env env'', expr'')
1087        }
1088
1089 -- Alternative version that wraps outgoing floats with the tick.  This
1090 -- results in ticks being duplicated, as we don't make any attempt to
1091 -- eliminate the tick if we re-inline the binding (because the tick
1092 -- semantics allows unrestricted inlining of HNFs), so I'm not doing
1093 -- this any more.  FloatOut will catch any real opportunities for
1094 -- floating.
1095 --
1096 --  wrap_floats =
1097 --    do { let (inc,outc) = splitCont cont
1098 --       ; (env', expr') <- simplExprF (zapFloats env) expr inc
1099 --       ; let tickish' = simplTickish env tickish
1100 --       ; let wrap_float (b,rhs) = (zapIdStrictness (setIdArity b 0),
1101 --                                   mkTick (mkNoTick tickish') rhs)
1102 --              -- when wrapping a float with mkTick, we better zap the Id's
1103 --              -- strictness info and arity, because it might be wrong now.
1104 --       ; let env'' = addFloats env (mapFloats env' wrap_float)
1105 --       ; rebuild env'' expr' (TickIt tickish' outc)
1106 --       }
1107
1108
1109   simplTickish env tickish
1110     | Breakpoint n ids <- tickish
1111           = Breakpoint n (map (getDoneId . substId env) ids)
1112     | otherwise = tickish
1113
1114   -- push type application and coercion inside a tick
1115   splitCont :: SimplCont -> (SimplCont, SimplCont)
1116   splitCont (ApplyTo f (Type t) env c) = (ApplyTo f (Type t) env inc, outc)
1117     where (inc,outc) = splitCont c
1118   splitCont (CoerceIt co c) = (CoerceIt co inc, outc)
1119     where (inc,outc) = splitCont c
1120   splitCont other = (mkBoringStop (contInputType other), other)
1121
1122   getDoneId (DoneId id) = id
1123   getDoneId (DoneEx e)  = getIdFromTrivialExpr e -- Note [substTickish] in CoreSubst
1124   getDoneId other = pprPanic "getDoneId" (ppr other)
1125
1126 -- Note [case-of-scc-of-case]
1127 -- It's pretty important to be able to transform case-of-case when
1128 -- there's an SCC in the way.  For example, the following comes up
1129 -- in nofib/real/compress/Encode.hs:
1130 --
1131 --        case scctick<code_string.r1>
1132 --             case $wcode_string_r13s wild_XC w1_s137 w2_s138 l_aje
1133 --             of _ { (# ww1_s13f, ww2_s13g, ww3_s13h #) ->
1134 --             (ww1_s13f, ww2_s13g, ww3_s13h)
1135 --             }
1136 --        of _ { (ww_s12Y, ww1_s12Z, ww2_s130) ->
1137 --        tick<code_string.f1>
1138 --        (ww_s12Y,
1139 --         ww1_s12Z,
1140 --         PTTrees.PT
1141 --           @ GHC.Types.Char @ GHC.Types.Int wild2_Xj ww2_s130 r_ajf)
1142 --        }
1143 --
1144 -- We really want this case-of-case to fire, because then the 3-tuple
1145 -- will go away (indeed, the CPR optimisation is relying on this
1146 -- happening).  But the scctick is in the way - we need to push it
1147 -- inside to expose the case-of-case.  So we perform this
1148 -- transformation on the inner case:
1149 --
1150 --   scctick c (case e of { p1 -> e1; ...; pn -> en })
1151 --    ==>
1152 --   case (scctick c e) of { p1 -> scc c e1; ...; pn -> scc c en }
1153 --
1154 -- So we've moved a constant amount of work out of the scc to expose
1155 -- the case.  We only do this when the continuation is interesting: in
1156 -- for now, it has to be another Case (maybe generalise this later).
1157 \end{code}
1158
1159
1160 %************************************************************************
1161 %*                                                                      *
1162 \subsection{The main rebuilder}
1163 %*                                                                      *
1164 %************************************************************************
1165
1166 \begin{code}
1167 rebuild :: SimplEnv -> OutExpr -> SimplCont -> SimplM (SimplEnv, OutExpr)
1168 -- At this point the substitution in the SimplEnv should be irrelevant
1169 -- only the in-scope set and floats should matter
1170 rebuild env expr cont
1171   = case cont of
1172       Stop {}                       -> return (env, expr)
1173       CoerceIt co cont              -> rebuild env (mkCast expr co) cont
1174                                     -- NB: mkCast implements the (Coercion co |> g) optimisation
1175       Select _ bndr alts se cont    -> rebuildCase (se `setFloats` env) expr bndr alts cont
1176       StrictArg info _ cont         -> rebuildCall env (info `addArgTo` expr) cont
1177       StrictBind b bs body se cont  -> do { env' <- simplNonRecX (se `setFloats` env) b expr
1178                                           ; simplLam env' bs body cont }
1179       ApplyTo dup_flag arg se cont  -- See Note [Avoid redundant simplification]
1180         | isSimplified dup_flag     -> rebuild env (App expr arg) cont
1181         | otherwise                 -> do { arg' <- simplExpr (se `setInScope` env) arg
1182                                           ; rebuild env (App expr arg') cont }
1183       TickIt t cont                 -> rebuild env (mkTick t expr) cont
1184 \end{code}
1185
1186
1187 %************************************************************************
1188 %*                                                                      *
1189 \subsection{Lambdas}
1190 %*                                                                      *
1191 %************************************************************************
1192
1193 \begin{code}
1194 simplCast :: SimplEnv -> InExpr -> Coercion -> SimplCont
1195           -> SimplM (SimplEnv, OutExpr)
1196 simplCast env body co0 cont0
1197   = do  { co1 <- simplCoercion env co0
1198         ; -- pprTrace "simplCast" (ppr co1) $
1199           simplExprF env body (addCoerce co1 cont0) }
1200   where
1201        addCoerce co cont = add_coerce co (coercionKind co) cont
1202
1203        add_coerce _co (Pair s1 k1) cont     -- co :: ty~ty
1204          | s1 `eqType` k1 = cont    -- is a no-op
1205
1206        add_coerce co1 (Pair s1 _k2) (CoerceIt co2 cont)
1207          | (Pair _l1 t1) <- coercionKind co2
1208                 --      e |> (g1 :: S1~L) |> (g2 :: L~T1)
1209                 -- ==>
1210                 --      e,                       if S1=T1
1211                 --      e |> (g1 . g2 :: S1~T1)  otherwise
1212                 --
1213                 -- For example, in the initial form of a worker
1214                 -- we may find  (coerce T (coerce S (\x.e))) y
1215                 -- and we'd like it to simplify to e[y/x] in one round
1216                 -- of simplification
1217          , s1 `eqType` t1  = cont            -- The coerces cancel out
1218          | otherwise       = CoerceIt (mkTransCo co1 co2) cont
1219
1220        add_coerce co (Pair s1s2 _t1t2) (ApplyTo dup (Type arg_ty) arg_se cont)
1221                 -- (f |> g) ty  --->   (f ty) |> (g @ ty)
1222                 -- This implements the PushT rule from the paper
1223          | Just (tyvar,_) <- splitForAllTy_maybe s1s2
1224          = ASSERT( isTyVar tyvar )
1225            ApplyTo Simplified (Type arg_ty') (zapSubstEnv arg_se) (addCoerce new_cast cont)
1226          where
1227            new_cast = mkInstCo co arg_ty'
1228            arg_ty' | isSimplified dup = arg_ty
1229                    | otherwise        = substTy (arg_se `setInScope` env) arg_ty
1230
1231        add_coerce co (Pair s1s2 t1t2) (ApplyTo dup arg arg_se cont)
1232          | isFunTy s1s2   -- This implements the Push rule from the paper
1233          , isFunTy t1t2   -- Check t1t2 to ensure 'arg' is a value arg
1234                 --      (e |> (g :: s1s2 ~ t1->t2)) f
1235                 -- ===>
1236                 --      (e (f |> (arg g :: t1~s1))
1237                 --      |> (res g :: s2->t2)
1238                 --
1239                 -- t1t2 must be a function type, t1->t2, because it's applied
1240                 -- to something but s1s2 might conceivably not be
1241                 --
1242                 -- When we build the ApplyTo we can't mix the out-types
1243                 -- with the InExpr in the argument, so we simply substitute
1244                 -- to make it all consistent.  It's a bit messy.
1245                 -- But it isn't a common case.
1246                 --
1247                 -- Example of use: Trac #995
1248          = ApplyTo dup new_arg (zapSubstEnv arg_se) (addCoerce co2 cont)
1249          where
1250            -- we split coercion t1->t2 ~ s1->s2 into t1 ~ s1 and
1251            -- t2 ~ s2 with left and right on the curried form:
1252            --    (->) t1 t2 ~ (->) s1 s2
1253            [co1, co2] = decomposeCo 2 co
1254            new_arg    = mkCast arg' (mkSymCo co1)
1255            arg'       = substExpr (text "move-cast") arg_se' arg
1256            arg_se'    = arg_se `setInScope` env
1257
1258        add_coerce co _ cont = CoerceIt co cont
1259 \end{code}
1260
1261
1262 %************************************************************************
1263 %*                                                                      *
1264 \subsection{Lambdas}
1265 %*                                                                      *
1266 %************************************************************************
1267
1268 Note [Zap unfolding when beta-reducing]
1269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1270 Lambda-bound variables can have stable unfoldings, such as
1271    $j = \x. \b{Unf=Just x}. e
1272 See Note [Case binders and join points] below; the unfolding for lets
1273 us optimise e better.  However when we beta-reduce it we want to
1274 revert to using the actual value, otherwise we can end up in the
1275 stupid situation of
1276           let x = blah in
1277           let b{Unf=Just x} = y
1278           in ...b...
1279 Here it'd be far better to drop the unfolding and use the actual RHS.
1280
1281 \begin{code}
1282 simplLam :: SimplEnv -> [InId] -> InExpr -> SimplCont
1283          -> SimplM (SimplEnv, OutExpr)
1284
1285 simplLam env [] body cont = simplExprF env body cont
1286
1287         -- Beta reduction
1288 simplLam env (bndr:bndrs) body (ApplyTo _ arg arg_se cont)
1289   = do  { tick (BetaReduction bndr)
1290         ; simplNonRecE env (zap_unfolding bndr) (arg, arg_se) (bndrs, body) cont }
1291   where
1292     zap_unfolding bndr  -- See Note [Zap unfolding when beta-reducing]
1293       | isId bndr, isStableUnfolding (realIdUnfolding bndr)
1294       = setIdUnfolding bndr NoUnfolding
1295       | otherwise = bndr
1296
1297       -- discard a non-counting tick on a lambda.  This may change the
1298       -- cost attribution slightly (moving the allocation of the
1299       -- lambda elsewhere), but we don't care: optimisation changes
1300       -- cost attribution all the time.
1301 simplLam env bndrs body (TickIt tickish cont)
1302   | not (tickishCounts tickish)
1303   = simplLam env bndrs body cont
1304
1305         -- Not enough args, so there are real lambdas left to put in the result
1306 simplLam env bndrs body cont
1307   = do  { (env', bndrs') <- simplLamBndrs env bndrs
1308         ; body' <- simplExpr env' body
1309         ; new_lam <- mkLam env' bndrs' body'
1310         ; rebuild env' new_lam cont }
1311
1312 ------------------
1313 simplNonRecE :: SimplEnv
1314              -> InBndr                  -- The binder
1315              -> (InExpr, SimplEnv)      -- Rhs of binding (or arg of lambda)
1316              -> ([InBndr], InExpr)      -- Body of the let/lambda
1317                                         --      \xs.e
1318              -> SimplCont
1319              -> SimplM (SimplEnv, OutExpr)
1320
1321 -- simplNonRecE is used for
1322 --  * non-top-level non-recursive lets in expressions
1323 --  * beta reduction
1324 --
1325 -- It deals with strict bindings, via the StrictBind continuation,
1326 -- which may abort the whole process
1327 --
1328 -- The "body" of the binding comes as a pair of ([InId],InExpr)
1329 -- representing a lambda; so we recurse back to simplLam
1330 -- Why?  Because of the binder-occ-info-zapping done before
1331 --       the call to simplLam in simplExprF (Lam ...)
1332
1333         -- First deal with type applications and type lets
1334         --   (/\a. e) (Type ty)   and   (let a = Type ty in e)
1335 simplNonRecE env bndr (Type ty_arg, rhs_se) (bndrs, body) cont
1336   = ASSERT( isTyVar bndr )
1337     do  { ty_arg' <- simplType (rhs_se `setInScope` env) ty_arg
1338         ; simplLam (extendTvSubst env bndr ty_arg') bndrs body cont }
1339
1340 simplNonRecE env bndr (rhs, rhs_se) (bndrs, body) cont
1341   = do dflags <- getDynFlags
1342        case () of
1343          _
1344           | preInlineUnconditionally dflags env NotTopLevel bndr rhs ->
1345             do  { tick (PreInlineUnconditionally bndr)
1346                 ; -- pprTrace "preInlineUncond" (ppr bndr <+> ppr rhs) $
1347                   simplLam (extendIdSubst env bndr (mkContEx rhs_se rhs)) bndrs body cont }
1348
1349           | isStrictId bndr ->           -- Includes coercions
1350             do  { simplExprF (rhs_se `setFloats` env) rhs
1351                              (StrictBind bndr bndrs body env cont) }
1352
1353           | otherwise ->
1354             ASSERT( not (isTyVar bndr) )
1355             do  { (env1, bndr1) <- simplNonRecBndr env bndr
1356                 ; let (env2, bndr2) = addBndrRules env1 bndr bndr1
1357                 ; env3 <- simplLazyBind env2 NotTopLevel NonRecursive bndr bndr2 rhs rhs_se
1358                 ; simplLam env3 bndrs body cont }
1359 \end{code}
1360
1361 %************************************************************************
1362 %*                                                                      *
1363                      Variables
1364 %*                                                                      *
1365 %************************************************************************
1366
1367 \begin{code}
1368 simplVar :: SimplEnv -> InVar -> SimplM OutExpr
1369 -- Look up an InVar in the environment
1370 simplVar env var
1371   | isTyVar var = return (Type (substTyVar env var))
1372   | isCoVar var = return (Coercion (substCoVar env var))
1373   | otherwise
1374   = case substId env var of
1375         DoneId var1          -> return (Var var1)
1376         DoneEx e             -> return e
1377         ContEx tvs cvs ids e -> simplExpr (setSubstEnv env tvs cvs ids) e
1378
1379 simplIdF :: SimplEnv -> InId -> SimplCont -> SimplM (SimplEnv, OutExpr)
1380 simplIdF env var cont
1381   = case substId env var of
1382         DoneEx e             -> simplExprF (zapSubstEnv env) e cont
1383         ContEx tvs cvs ids e -> simplExprF (setSubstEnv env tvs cvs ids) e cont
1384         DoneId var1          -> completeCall env var1 cont
1385                 -- Note [zapSubstEnv]
1386                 -- The template is already simplified, so don't re-substitute.
1387                 -- This is VITAL.  Consider
1388                 --      let x = e in
1389                 --      let y = \z -> ...x... in
1390                 --      \ x -> ...y...
1391                 -- We'll clone the inner \x, adding x->x' in the id_subst
1392                 -- Then when we inline y, we must *not* replace x by x' in
1393                 -- the inlined copy!!
1394
1395 ---------------------------------------------------------
1396 --      Dealing with a call site
1397
1398 completeCall :: SimplEnv -> OutId -> SimplCont -> SimplM (SimplEnv, OutExpr)
1399 completeCall env var cont
1400   = do  {   ------------- Try inlining ----------------
1401           dflags <- getDynFlags
1402         ; let  (lone_variable, arg_infos, call_cont) = contArgs cont
1403                n_val_args = length arg_infos
1404                interesting_cont = interestingCallContext call_cont
1405                unfolding    = activeUnfolding env var
1406                maybe_inline = callSiteInline dflags var unfolding
1407                                              lone_variable arg_infos interesting_cont
1408         ; case maybe_inline of {
1409             Just expr      -- There is an inlining!
1410               ->  do { checkedTick (UnfoldingDone var)
1411                      ; dump_inline dflags expr cont
1412                      ; simplExprF (zapSubstEnv env) expr cont }
1413
1414             ; Nothing -> do               -- No inlining!
1415
1416         { rule_base <- getSimplRules
1417         ; let info = mkArgInfo var (getRules rule_base var) n_val_args call_cont
1418         ; rebuildCall env info cont
1419     }}}
1420   where
1421     dump_inline dflags unfolding cont
1422       | not (dopt Opt_D_dump_inlinings dflags) = return ()
1423       | not (dopt Opt_D_verbose_core2core dflags)
1424       = when (isExternalName (idName var)) $
1425             liftIO $ printInfoForUser dflags alwaysQualify $
1426                 sep [text "Inlining done:", nest 4 (ppr var)]
1427       | otherwise
1428       = liftIO $ printInfoForUser dflags alwaysQualify $
1429            sep [text "Inlining done: " <> ppr var,
1430                 nest 4 (vcat [text "Inlined fn: " <+> nest 2 (ppr unfolding),
1431                               text "Cont:  " <+> ppr cont])]
1432
1433 rebuildCall :: SimplEnv
1434             -> ArgInfo
1435             -> SimplCont
1436             -> SimplM (SimplEnv, OutExpr)
1437 rebuildCall env (ArgInfo { ai_fun = fun, ai_args = rev_args, ai_strs = [] }) cont
1438   -- When we run out of strictness args, it means
1439   -- that the call is definitely bottom; see SimplUtils.mkArgInfo
1440   -- Then we want to discard the entire strict continuation.  E.g.
1441   --    * case (error "hello") of { ... }
1442   --    * (error "Hello") arg
1443   --    * f (error "Hello") where f is strict
1444   --    etc
1445   -- Then, especially in the first of these cases, we'd like to discard
1446   -- the continuation, leaving just the bottoming expression.  But the
1447   -- type might not be right, so we may have to add a coerce.
1448   | not (contIsTrivial cont)     -- Only do this if there is a non-trivial
1449   = return (env, castBottomExpr res cont_ty)  -- contination to discard, else we do it
1450   where                                       -- again and again!
1451     res     = argInfoExpr fun rev_args
1452     cont_ty = contResultType cont
1453
1454 rebuildCall env info (CoerceIt co cont) 
1455   = rebuildCall env (addCastTo info co) cont
1456
1457 rebuildCall env info (ApplyTo dup_flag (Type arg_ty) se cont)
1458   = do { arg_ty' <- if isSimplified dup_flag then return arg_ty
1459                     else simplType (se `setInScope` env) arg_ty
1460        ; rebuildCall env (info `addArgTo` Type arg_ty') cont }
1461
1462 rebuildCall env info@(ArgInfo { ai_encl = encl_rules, ai_type = fun_ty
1463                               , ai_strs = str:strs, ai_discs = disc:discs })
1464             (ApplyTo dup_flag arg arg_se cont)
1465   | isSimplified dup_flag     -- See Note [Avoid redundant simplification]
1466   = rebuildCall env (addArgTo info' arg) cont
1467
1468   | str                 -- Strict argument
1469   = -- pprTrace "Strict Arg" (ppr arg $$ ppr (seIdSubst env) $$ ppr (seInScope env)) $
1470     simplExprF (arg_se `setFloats` env) arg
1471                (StrictArg info' cci cont)
1472                 -- Note [Shadowing]
1473
1474   | otherwise                           -- Lazy argument
1475         -- DO NOT float anything outside, hence simplExprC
1476         -- There is no benefit (unlike in a let-binding), and we'd
1477         -- have to be very careful about bogus strictness through
1478         -- floating a demanded let.
1479   = do  { arg' <- simplExprC (arg_se `setInScope` env) arg
1480                              (mkLazyArgStop (funArgTy fun_ty) cci)
1481         ; rebuildCall env (addArgTo info' arg') cont }
1482   where
1483     info' = info { ai_strs = strs, ai_discs = discs }
1484     cci | encl_rules || disc > 0 = ArgCtxt encl_rules  -- Be keener here
1485         | otherwise              = BoringCtxt          -- Nothing interesting
1486
1487 rebuildCall env (ArgInfo { ai_fun = fun, ai_args = rev_args, ai_rules = rules }) cont
1488   | null rules
1489   = rebuild env (argInfoExpr fun rev_args) cont      -- No rules, common case
1490
1491   | otherwise
1492   = do {  -- We've accumulated a simplified call in <fun,rev_args>
1493           -- so try rewrite rules; see Note [RULEs apply to simplified arguments]
1494           -- See also Note [Rules for recursive functions]
1495         ; let env' = zapSubstEnv env
1496               (args, cont') = argInfoValArgs env' rev_args cont
1497         ; mb_rule <- tryRules env' rules fun args cont'
1498         ; case mb_rule of {
1499              Just (rule_rhs, cont'') -> simplExprF env' rule_rhs cont''
1500
1501                  -- Rules don't match
1502            ; Nothing -> rebuild env (argInfoExpr fun rev_args) cont      -- No rules
1503     } }
1504 \end{code}
1505
1506 Note [RULES apply to simplified arguments]
1507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1508 It's very desirable to try RULES once the arguments have been simplified, because
1509 doing so ensures that rule cascades work in one pass.  Consider
1510    {-# RULES g (h x) = k x
1511              f (k x) = x #-}
1512    ...f (g (h x))...
1513 Then we want to rewrite (g (h x)) to (k x) and only then try f's rules. If
1514 we match f's rules against the un-simplified RHS, it won't match.  This
1515 makes a particularly big difference when superclass selectors are involved:
1516         op ($p1 ($p2 (df d)))
1517 We want all this to unravel in one sweeep.
1518
1519 Note [Avoid redundant simplification]
1520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1521 Because RULES apply to simplified arguments, there's a danger of repeatedly
1522 simplifying already-simplified arguments.  An important example is that of
1523         (>>=) d e1 e2
1524 Here e1, e2 are simplified before the rule is applied, but don't really
1525 participate in the rule firing. So we mark them as Simplified to avoid
1526 re-simplifying them.
1527
1528 Note [Shadowing]
1529 ~~~~~~~~~~~~~~~~
1530 This part of the simplifier may break the no-shadowing invariant
1531 Consider
1532         f (...(\a -> e)...) (case y of (a,b) -> e')
1533 where f is strict in its second arg
1534 If we simplify the innermost one first we get (...(\a -> e)...)
1535 Simplifying the second arg makes us float the case out, so we end up with
1536         case y of (a,b) -> f (...(\a -> e)...) e'
1537 So the output does not have the no-shadowing invariant.  However, there is
1538 no danger of getting name-capture, because when the first arg was simplified
1539 we used an in-scope set that at least mentioned all the variables free in its
1540 static environment, and that is enough.
1541
1542 We can't just do innermost first, or we'd end up with a dual problem:
1543         case x of (a,b) -> f e (...(\a -> e')...)
1544
1545 I spent hours trying to recover the no-shadowing invariant, but I just could
1546 not think of an elegant way to do it.  The simplifier is already knee-deep in
1547 continuations.  We have to keep the right in-scope set around; AND we have
1548 to get the effect that finding (error "foo") in a strict arg position will
1549 discard the entire application and replace it with (error "foo").  Getting
1550 all this at once is TOO HARD!
1551
1552
1553 %************************************************************************
1554 %*                                                                      *
1555                 Rewrite rules
1556 %*                                                                      *
1557 %************************************************************************
1558
1559 \begin{code}
1560 tryRules :: SimplEnv -> [CoreRule]
1561          -> Id -> [OutExpr] -> SimplCont
1562          -> SimplM (Maybe (CoreExpr, SimplCont))
1563 -- The SimplEnv already has zapSubstEnv applied to it
1564
1565 tryRules env rules fn args call_cont
1566   | null rules
1567   = return Nothing
1568 {- Disabled until we fix #8326
1569   | fn `hasKey` tagToEnumKey   -- See Note [Optimising tagToEnum#]
1570   , [_type_arg, val_arg] <- args
1571   , Select dup bndr ((_,[],rhs1) : rest_alts) se cont <- call_cont
1572   , isDeadBinder bndr
1573   = do { dflags <- getDynFlags
1574        ; let enum_to_tag :: CoreAlt -> CoreAlt
1575                 -- Takes   K -> e  into   tagK# -> e
1576                 -- where tagK# is the tag of constructor K
1577              enum_to_tag (DataAlt con, [], rhs) 
1578                = ASSERT( isEnumerationTyCon (dataConTyCon con) )
1579                 (LitAlt tag, [], rhs)
1580               where
1581                 tag = mkMachInt dflags (toInteger (dataConTag con - fIRST_TAG))
1582              enum_to_tag alt = pprPanic "tryRules: tagToEnum" (ppr alt)
1583  
1584              new_alts = (DEFAULT, [], rhs1) : map enum_to_tag rest_alts
1585              new_bndr = setIdType bndr intPrimTy   
1586                  -- The binder is dead, but should have the right type
1587       ; return (Just (val_arg, Select dup new_bndr new_alts se cont)) }
1588 -}
1589   | otherwise
1590   = do { dflags <- getDynFlags
1591        ; case lookupRule dflags (getUnfoldingInRuleMatch env) (activeRule env) 
1592                          fn args rules of {
1593            Nothing               -> return Nothing ;   -- No rule matches
1594            Just (rule, rule_rhs) ->
1595              do { checkedTick (RuleFired (ru_name rule))
1596                 ; dump dflags rule rule_rhs
1597                 ; let cont' = pushSimplifiedArgs env
1598                                                  (drop (ruleArity rule) args) 
1599                                                  call_cont
1600                       -- (ruleArity rule) says how many args the rule consumed
1601                 ; return (Just (rule_rhs, cont')) }}}
1602   where
1603     dump dflags rule rule_rhs
1604       | dopt Opt_D_dump_rule_rewrites dflags
1605       = log_rule dflags Opt_D_dump_rule_rewrites "Rule fired" $ vcat
1606           [ text "Rule:" <+> ftext (ru_name rule)
1607           , text "Before:" <+> hang (ppr fn) 2 (sep (map pprParendExpr args))
1608           , text "After: " <+> pprCoreExpr rule_rhs
1609           , text "Cont:  " <+> ppr call_cont ]
1610
1611       | dopt Opt_D_dump_rule_firings dflags
1612       = log_rule dflags Opt_D_dump_rule_firings "Rule fired:" $
1613           ftext (ru_name rule)
1614
1615       | otherwise
1616       = return ()
1617
1618     log_rule dflags flag hdr details = liftIO . dumpSDoc dflags flag "" $
1619       sep [text hdr, nest 4 details]
1620 \end{code}
1621
1622 Note [Optimising tagToEnum#]
1623 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1624 If we have an enumeration data type:
1625
1626   data Foo = A | B | C
1627
1628 Then we want to transform
1629
1630    case tagToEnum# x of   ==>    case x of
1631      A -> e1                       DEFAULT -> e1
1632      B -> e2                       1#      -> e2
1633      C -> e3                       2#      -> e3
1634
1635 thereby getting rid of the tagToEnum# altogether.  If there was a DEFAULT
1636 alternative we retain it (remember it comes first).  If not the case must
1637 be exhaustive, and we reflect that in the transformed version by adding
1638 a DEFAULT.  Otherwise Lint complains that the new case is not exhaustive.
1639 See #8317.
1640
1641 Note [Rules for recursive functions]
1642 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1643 You might think that we shouldn't apply rules for a loop breaker:
1644 doing so might give rise to an infinite loop, because a RULE is
1645 rather like an extra equation for the function:
1646      RULE:           f (g x) y = x+y
1647      Eqn:            f a     y = a-y
1648
1649 But it's too drastic to disable rules for loop breakers.
1650 Even the foldr/build rule would be disabled, because foldr
1651 is recursive, and hence a loop breaker:
1652      foldr k z (build g) = g k z
1653 So it's up to the programmer: rules can cause divergence
1654
1655
1656 %************************************************************************
1657 %*                                                                      *
1658                 Rebuilding a case expression
1659 %*                                                                      *
1660 %************************************************************************
1661
1662 Note [Case elimination]
1663 ~~~~~~~~~~~~~~~~~~~~~~~
1664 The case-elimination transformation discards redundant case expressions.
1665 Start with a simple situation:
1666
1667         case x# of      ===>   let y# = x# in e
1668           y# -> e
1669
1670 (when x#, y# are of primitive type, of course).  We can't (in general)
1671 do this for algebraic cases, because we might turn bottom into
1672 non-bottom!
1673
1674 The code in SimplUtils.prepareAlts has the effect of generalise this
1675 idea to look for a case where we're scrutinising a variable, and we
1676 know that only the default case can match.  For example:
1677
1678         case x of
1679           0#      -> ...
1680           DEFAULT -> ...(case x of
1681                          0#      -> ...
1682                          DEFAULT -> ...) ...
1683
1684 Here the inner case is first trimmed to have only one alternative, the
1685 DEFAULT, after which it's an instance of the previous case.  This
1686 really only shows up in eliminating error-checking code.
1687
1688 Note that SimplUtils.mkCase combines identical RHSs.  So
1689
1690         case e of       ===> case e of DEFAULT -> r
1691            True  -> r
1692            False -> r
1693
1694 Now again the case may be elminated by the CaseElim transformation.
1695 This includes things like (==# a# b#)::Bool so that we simplify
1696       case ==# a# b# of { True -> x; False -> x }
1697 to just
1698       x
1699 This particular example shows up in default methods for
1700 comparision operations (e.g. in (>=) for Int.Int32)
1701
1702 Note [Case elimination: lifted case]
1703 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1704 We also make sure that we deal with this very common case,
1705 where x has a lifted type:
1706
1707         case e of
1708           x -> ...x...
1709
1710 Here we are using the case as a strict let; if x is used only once
1711 then we want to inline it.  We have to be careful that this doesn't
1712 make the program terminate when it would have diverged before, so we
1713 check that
1714         (a) 'e' is already evaluated (it may so if e is a variable)
1715             Specifically we check (exprIsHNF e)
1716 or
1717         (b) 'x' is not used at all and e is ok-for-speculation
1718
1719 For the (b), consider
1720    case (case a ># b of { True -> (p,q); False -> (q,p) }) of
1721      r -> blah
1722 The scrutinee is ok-for-speculation (it looks inside cases), but we do
1723 not want to transform to
1724    let r = case a ># b of { True -> (p,q); False -> (q,p) }
1725    in blah
1726 because that builds an unnecessary thunk.
1727
1728 Note [Case binder next]
1729 ~~~~~~~~~~~~~~~~~~~~~~~
1730 If we have 
1731    case e of f { _ -> f e1 e2 }
1732 then we can safely do CaseElim.   The main criterion is that the
1733 case-binder is evaluated *next*.  Previously we just asked that
1734 the case-binder is used strictly; but that can change
1735     case x of { _ -> error "bad" }
1736     --> error "bad"
1737 which is very puzzling if 'x' is later bound to (error "good").
1738 Where the order of evaluation is specified (via seq or case)
1739 we should respect it.  
1740 See also Note [Empty case alternatives] in CoreSyn.
1741
1742 So instead we use case_bndr_evald_next to see when f is the *next*
1743 thing to be eval'd.  This came up when fixing Trac #7542.
1744 See also Note [Eta reduction of an eval'd function] in CoreUtils.
1745
1746   For reference, the old code was an extra disjunct in elim_lifted
1747        || (strict_case_bndr && scrut_is_var scrut)
1748       strict_case_bndr = isStrictDmd (idDemandInfo case_bndr)
1749       scrut_is_var (Cast s _) = scrut_is_var s
1750       scrut_is_var (Var _)    = True
1751       scrut_is_var _          = False
1752
1753       -- True if evaluation of the case_bndr is the next
1754       -- thing to be eval'd.  Then dropping the case
1755
1756 Note [Case elimination: unlifted case]
1757 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1758 Consider
1759    case a +# b of r -> ...r...
1760 Then we do case-elimination (to make a let) followed by inlining,
1761 to get
1762         .....(a +# b)....
1763 If we have
1764    case indexArray# a i of r -> ...r...
1765 we might like to do the same, and inline the (indexArray# a i).
1766 But indexArray# is not okForSpeculation, so we don't build a let
1767 in rebuildCase (lest it get floated *out*), so the inlining doesn't
1768 happen either.
1769
1770 This really isn't a big deal I think. The let can be
1771
1772
1773 Further notes about case elimination
1774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1775 Consider:       test :: Integer -> IO ()
1776                 test = print
1777
1778 Turns out that this compiles to:
1779     Print.test
1780       = \ eta :: Integer
1781           eta1 :: State# RealWorld ->
1782           case PrelNum.< eta PrelNum.zeroInteger of wild { __DEFAULT ->
1783           case hPutStr stdout
1784                  (PrelNum.jtos eta ($w[] @ Char))
1785                  eta1
1786           of wild1 { (# new_s, a4 #) -> PrelIO.lvl23 new_s  }}
1787
1788 Notice the strange '<' which has no effect at all. This is a funny one.
1789 It started like this:
1790
1791 f x y = if x < 0 then jtos x
1792           else if y==0 then "" else jtos x
1793
1794 At a particular call site we have (f v 1).  So we inline to get
1795
1796         if v < 0 then jtos x
1797         else if 1==0 then "" else jtos x
1798
1799 Now simplify the 1==0 conditional:
1800
1801         if v<0 then jtos v else jtos v
1802
1803 Now common-up the two branches of the case:
1804
1805         case (v<0) of DEFAULT -> jtos v
1806
1807 Why don't we drop the case?  Because it's strict in v.  It's technically
1808 wrong to drop even unnecessary evaluations, and in practice they
1809 may be a result of 'seq' so we *definitely* don't want to drop those.
1810 I don't really know how to improve this situation.
1811
1812 \begin{code}
1813 ---------------------------------------------------------
1814 --      Eliminate the case if possible
1815
1816 rebuildCase, reallyRebuildCase
1817    :: SimplEnv
1818    -> OutExpr          -- Scrutinee
1819    -> InId             -- Case binder
1820    -> [InAlt]          -- Alternatives (inceasing order)
1821    -> SimplCont
1822    -> SimplM (SimplEnv, OutExpr)
1823
1824 --------------------------------------------------
1825 --      1. Eliminate the case if there's a known constructor
1826 --------------------------------------------------
1827
1828 rebuildCase env scrut case_bndr alts cont
1829   | Lit lit <- scrut    -- No need for same treatment as constructors
1830                         -- because literals are inlined more vigorously
1831   , not (litIsLifted lit)
1832   = do  { tick (KnownBranch case_bndr)
1833         ; case findAlt (LitAlt lit) alts of
1834             Nothing           -> missingAlt env case_bndr alts cont
1835             Just (_, bs, rhs) -> simple_rhs bs rhs }
1836
1837   | Just (con, ty_args, other_args) <- exprIsConApp_maybe (getUnfoldingInRuleMatch env) scrut
1838         -- Works when the scrutinee is a variable with a known unfolding
1839         -- as well as when it's an explicit constructor application
1840   = do  { tick (KnownBranch case_bndr)
1841         ; case findAlt (DataAlt con) alts of
1842             Nothing  -> missingAlt env case_bndr alts cont
1843             Just (DEFAULT, bs, rhs) -> simple_rhs bs rhs
1844             Just (_, bs, rhs)       -> knownCon env scrut con ty_args other_args
1845                                                 case_bndr bs rhs cont
1846         }
1847   where
1848     simple_rhs bs rhs = ASSERT( null bs )
1849                         do { env' <- simplNonRecX env case_bndr scrut
1850                            ; simplExprF env' rhs cont }
1851
1852
1853 --------------------------------------------------
1854 --      2. Eliminate the case if scrutinee is evaluated
1855 --------------------------------------------------
1856
1857 rebuildCase env scrut case_bndr [(_, bndrs, rhs)] cont
1858   -- See if we can get rid of the case altogether
1859   -- See Note [Case elimination]
1860   -- mkCase made sure that if all the alternatives are equal,
1861   -- then there is now only one (DEFAULT) rhs
1862  | all isDeadBinder bndrs       -- bndrs are [InId]
1863
1864  , if isUnLiftedType (idType case_bndr)
1865    then elim_unlifted        -- Satisfy the let-binding invariant
1866    else elim_lifted
1867   = do  { -- pprTrace "case elim" (vcat [ppr case_bndr, ppr (exprIsHNF scrut),
1868           --                            ppr ok_for_spec,
1869           --                            ppr scrut]) $
1870           tick (CaseElim case_bndr)
1871         ; env' <- simplNonRecX env case_bndr scrut
1872           -- If case_bndr is dead, simplNonRecX will discard
1873         ; simplExprF env' rhs cont }
1874   where
1875     elim_lifted   -- See Note [Case elimination: lifted case]
1876       = exprIsHNF scrut
1877      || (is_plain_seq && ok_for_spec)
1878               -- Note: not the same as exprIsHNF
1879      || case_bndr_evald_next rhs
1880
1881     elim_unlifted
1882       | is_plain_seq = exprOkForSideEffects scrut
1883             -- The entire case is dead, so we can drop it,
1884             -- _unless_ the scrutinee has side effects
1885       | otherwise    = ok_for_spec
1886             -- The case-binder is alive, but we may be able
1887             -- turn the case into a let, if the expression is ok-for-spec
1888             -- See Note [Case elimination: unlifted case]
1889
1890     ok_for_spec      = exprOkForSpeculation scrut
1891     is_plain_seq     = isDeadBinder case_bndr -- Evaluation *only* for effect
1892
1893     case_bndr_evald_next :: CoreExpr -> Bool
1894       -- See Note [Case binder next]
1895     case_bndr_evald_next (Var v)         = v == case_bndr
1896     case_bndr_evald_next (Cast e _)      = case_bndr_evald_next e
1897     case_bndr_evald_next (App e _)       = case_bndr_evald_next e
1898     case_bndr_evald_next (Case e _ _ _)  = case_bndr_evald_next e
1899     case_bndr_evald_next _               = False
1900       -- Could add a case for Let,
1901       -- but I'm worried it could become expensive
1902
1903 --------------------------------------------------
1904 --      3. Try seq rules; see Note [User-defined RULES for seq] in MkId
1905 --------------------------------------------------
1906
1907 rebuildCase env scrut case_bndr alts@[(_, bndrs, rhs)] cont
1908   | all isDeadBinder (case_bndr : bndrs)  -- So this is just 'seq'
1909   = do { let rhs' = substExpr (text "rebuild-case") env rhs
1910              env' = zapSubstEnv env
1911              out_args = [Type (substTy env (idType case_bndr)),
1912                          Type (exprType rhs'), scrut, rhs']
1913                       -- Lazily evaluated, so we don't do most of this
1914
1915        ; rule_base <- getSimplRules
1916        ; mb_rule <- tryRules env' (getRules rule_base seqId) seqId out_args cont
1917        ; case mb_rule of
1918            Just (rule_rhs, cont') -> simplExprF env' rule_rhs cont'
1919            Nothing                -> reallyRebuildCase env scrut case_bndr alts cont }
1920
1921 rebuildCase env scrut case_bndr alts cont
1922   = reallyRebuildCase env scrut case_bndr alts cont
1923
1924 --------------------------------------------------
1925 --      3. Catch-all case
1926 --------------------------------------------------
1927
1928 reallyRebuildCase env scrut case_bndr alts cont
1929   = do  {       -- Prepare the continuation;
1930                 -- The new subst_env is in place
1931           (env', dup_cont, nodup_cont) <- prepareCaseCont env alts cont
1932
1933         -- Simplify the alternatives
1934         ; (scrut', case_bndr', alts') <- simplAlts env' scrut case_bndr alts dup_cont
1935
1936         ; dflags <- getDynFlags
1937         ; let alts_ty' = contResultType dup_cont
1938         ; case_expr <- mkCase dflags scrut' case_bndr' alts_ty' alts'
1939
1940         -- Notice that rebuild gets the in-scope set from env', not alt_env
1941         -- (which in any case is only build in simplAlts)
1942         -- The case binder *not* scope over the whole returned case-expression
1943         ; rebuild env' case_expr nodup_cont }
1944 \end{code}
1945
1946 simplCaseBinder checks whether the scrutinee is a variable, v.  If so,
1947 try to eliminate uses of v in the RHSs in favour of case_bndr; that
1948 way, there's a chance that v will now only be used once, and hence
1949 inlined.
1950
1951 Historical note: we use to do the "case binder swap" in the Simplifier
1952 so there were additional complications if the scrutinee was a variable.
1953 Now the binder-swap stuff is done in the occurrence analyer; see
1954 OccurAnal Note [Binder swap].
1955
1956 Note [knownCon occ info]
1957 ~~~~~~~~~~~~~~~~~~~~~~~~
1958 If the case binder is not dead, then neither are the pattern bound
1959 variables:
1960         case <any> of x { (a,b) ->
1961         case x of { (p,q) -> p } }
1962 Here (a,b) both look dead, but come alive after the inner case is eliminated.
1963 The point is that we bring into the envt a binding
1964         let x = (a,b)
1965 after the outer case, and that makes (a,b) alive.  At least we do unless
1966 the case binder is guaranteed dead.
1967
1968 Note [Case alternative occ info]
1969 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1970 When we are simply reconstructing a case (the common case), we always
1971 zap the occurrence info on the binders in the alternatives.  Even
1972 if the case binder is dead, the scrutinee is usually a variable, and *that*
1973 can bring the case-alternative binders back to life.  
1974 See Note [Add unfolding for scrutinee]
1975
1976 Note [Improving seq]
1977 ~~~~~~~~~~~~~~~~~~~
1978 Consider
1979         type family F :: * -> *
1980         type instance F Int = Int
1981
1982         ... case e of x { DEFAULT -> rhs } ...
1983
1984 where x::F Int.  Then we'd like to rewrite (F Int) to Int, getting
1985
1986         case e `cast` co of x'::Int
1987            I# x# -> let x = x' `cast` sym co
1988                     in rhs
1989
1990 so that 'rhs' can take advantage of the form of x'.
1991
1992 Notice that Note [Case of cast] (in OccurAnal) may then apply to the result.
1993
1994 Nota Bene: We only do the [Improving seq] transformation if the
1995 case binder 'x' is actually used in the rhs; that is, if the case
1996 is *not* a *pure* seq.
1997   a) There is no point in adding the cast to a pure seq.
1998   b) There is a good reason not to: doing so would interfere
1999      with seq rules (Note [Built-in RULES for seq] in MkId).
2000      In particular, this [Improving seq] thing *adds* a cast
2001      while [Built-in RULES for seq] *removes* one, so they
2002      just flip-flop.
2003
2004 You might worry about
2005    case v of x { __DEFAULT ->
2006       ... case (v `cast` co) of y { I# -> ... }}
2007 This is a pure seq (since x is unused), so [Improving seq] won't happen.
2008 But it's ok: the simplifier will replace 'v' by 'x' in the rhs to get
2009    case v of x { __DEFAULT ->
2010       ... case (x `cast` co) of y { I# -> ... }}
2011 Now the outer case is not a pure seq, so [Improving seq] will happen,
2012 and then the inner case will disappear.
2013
2014 The need for [Improving seq] showed up in Roman's experiments.  Example:
2015   foo :: F Int -> Int -> Int
2016   foo t n = t `seq` bar n
2017      where
2018        bar 0 = 0
2019        bar n = bar (n - case t of TI i -> i)
2020 Here we'd like to avoid repeated evaluating t inside the loop, by
2021 taking advantage of the `seq`.
2022
2023 At one point I did transformation in LiberateCase, but it's more
2024 robust here.  (Otherwise, there's a danger that we'll simply drop the
2025 'seq' altogether, before LiberateCase gets to see it.)
2026
2027 \begin{code}
2028 simplAlts :: SimplEnv
2029           -> OutExpr
2030           -> InId                       -- Case binder
2031           -> [InAlt]                    -- Non-empty
2032           -> SimplCont
2033           -> SimplM (OutExpr, OutId, [OutAlt])  -- Includes the continuation
2034 -- Like simplExpr, this just returns the simplified alternatives;
2035 -- it does not return an environment
2036 -- The returned alternatives can be empty, none are possible
2037
2038 simplAlts env scrut case_bndr alts cont'
2039   = do  { let env0 = zapFloats env
2040
2041         ; (env1, case_bndr1) <- simplBinder env0 case_bndr
2042
2043         ; fam_envs <- getFamEnvs
2044         ; (alt_env', scrut', case_bndr') <- improveSeq fam_envs env1 scrut
2045                                                        case_bndr case_bndr1 alts
2046
2047         ; (imposs_deflt_cons, in_alts) <- prepareAlts scrut' case_bndr' alts
2048           -- NB: it's possible that the returned in_alts is empty: this is handled
2049           -- by the caller (rebuildCase) in the missingAlt function
2050
2051         ; alts' <- mapM (simplAlt alt_env' (Just scrut') imposs_deflt_cons case_bndr' cont') in_alts
2052         ; -- pprTrace "simplAlts" (ppr case_bndr $$ ppr alts_ty $$ ppr alts_ty' $$ ppr alts $$ ppr cont') $
2053           return (scrut', case_bndr', alts') }
2054
2055
2056 ------------------------------------
2057 improveSeq :: (FamInstEnv, FamInstEnv) -> SimplEnv
2058            -> OutExpr -> InId -> OutId -> [InAlt]
2059            -> SimplM (SimplEnv, OutExpr, OutId)
2060 -- Note [Improving seq]
2061 improveSeq fam_envs env scrut case_bndr case_bndr1 [(DEFAULT,_,_)]
2062   | not (isDeadBinder case_bndr) -- Not a pure seq!  See Note [Improving seq]
2063   , Just (co, ty2) <- topNormaliseType fam_envs (idType case_bndr1)
2064   = do { case_bndr2 <- newId (fsLit "nt") ty2
2065         ; let rhs  = DoneEx (Var case_bndr2 `Cast` mkSymCo co)
2066               env2 = extendIdSubst env case_bndr rhs
2067         ; return (env2, scrut `Cast` co, case_bndr2) }
2068
2069 improveSeq _ env scrut _ case_bndr1 _
2070   = return (env, scrut, case_bndr1)
2071
2072
2073 ------------------------------------
2074 simplAlt :: SimplEnv
2075          -> Maybe OutExpr  -- The scrutinee
2076          -> [AltCon]       -- These constructors can't be present when
2077                            -- matching the DEFAULT alternative
2078          -> OutId          -- The case binder
2079          -> SimplCont
2080          -> InAlt
2081          -> SimplM OutAlt
2082
2083 simplAlt env _ imposs_deflt_cons case_bndr' cont' (DEFAULT, bndrs, rhs)
2084   = ASSERT( null bndrs )
2085     do  { let env' = addBinderUnfolding env case_bndr'
2086                                         (mkOtherCon imposs_deflt_cons)
2087                 -- Record the constructors that the case-binder *can't* be.
2088         ; rhs' <- simplExprC env' rhs cont'
2089         ; return (DEFAULT, [], rhs') }
2090
2091 simplAlt env scrut' _ case_bndr' cont' (LitAlt lit, bndrs, rhs)
2092   = ASSERT( null bndrs )
2093     do  { env' <- addAltUnfoldings env scrut' case_bndr' (Lit lit)
2094         ; rhs' <- simplExprC env' rhs cont'
2095         ; return (LitAlt lit, [], rhs') }
2096
2097 simplAlt env scrut' _ case_bndr' cont' (DataAlt con, vs, rhs)
2098   = do  {       -- Deal with the pattern-bound variables
2099                 -- Mark the ones that are in ! positions in the
2100                 -- data constructor as certainly-evaluated.
2101                 -- NB: simplLamBinders preserves this eval info
2102         ; let vs_with_evals = add_evals (dataConRepStrictness con)
2103         ; (env', vs') <- simplLamBndrs env vs_with_evals
2104
2105                 -- Bind the case-binder to (con args)
2106         ; let inst_tys' = tyConAppArgs (idType case_bndr')
2107               con_app :: OutExpr
2108               con_app   = mkConApp2 con inst_tys' vs'
2109
2110         ; env'' <- addAltUnfoldings env' scrut' case_bndr' con_app
2111         ; rhs' <- simplExprC env'' rhs cont'
2112         ; return (DataAlt con, vs', rhs') }
2113   where
2114         -- add_evals records the evaluated-ness of the bound variables of
2115         -- a case pattern.  This is *important*.  Consider
2116         --      data T = T !Int !Int
2117         --
2118         --      case x of { T a b -> T (a+1) b }
2119         --
2120         -- We really must record that b is already evaluated so that we don't
2121         -- go and re-evaluate it when constructing the result.
2122         -- See Note [Data-con worker strictness] in MkId.lhs
2123     add_evals the_strs
2124         = go vs the_strs
2125         where
2126           go [] [] = []
2127           go (v:vs') strs | isTyVar v = v : go vs' strs
2128           go (v:vs') (str:strs)
2129             | isMarkedStrict str = evald_v  : go vs' strs
2130             | otherwise          = zapped_v : go vs' strs
2131             where
2132               zapped_v = zapIdOccInfo v   -- See Note [Case alternative occ info]
2133               evald_v  = zapped_v `setIdUnfolding` evaldUnfolding
2134           go _ _ = pprPanic "cat_evals" (ppr con $$ ppr vs $$ ppr the_strs)
2135
2136
2137 addAltUnfoldings :: SimplEnv -> Maybe OutExpr -> OutId -> OutExpr -> SimplM SimplEnv
2138 addAltUnfoldings env scrut case_bndr con_app
2139   = do { dflags <- getDynFlags
2140        ; let con_app_unf = mkSimpleUnfolding dflags con_app
2141              env1 = addBinderUnfolding env case_bndr con_app_unf
2142
2143              -- See Note [Add unfolding for scrutinee]
2144              env2 = case scrut of
2145                       Just (Var v)           -> addBinderUnfolding env1 v con_app_unf
2146                       Just (Cast (Var v) co) -> addBinderUnfolding env1 v $
2147                                                 mkSimpleUnfolding dflags (Cast con_app (mkSymCo co))
2148                       _                      -> env1
2149               
2150        ; traceSmpl "addAltUnf" (vcat [ppr case_bndr <+> ppr scrut, ppr con_app])
2151        ; return env2 }
2152
2153 addBinderUnfolding :: SimplEnv -> Id -> Unfolding -> SimplEnv
2154 addBinderUnfolding env bndr unf
2155   | debugIsOn, Just tmpl <- maybeUnfoldingTemplate unf
2156   = WARN( not (eqType (idType bndr) (exprType tmpl)), 
2157           ppr bndr $$ ppr (idType bndr) $$ ppr tmpl $$ ppr (exprType tmpl) ) 
2158     modifyInScope env (bndr `setIdUnfolding` unf)
2159
2160   | otherwise
2161   = modifyInScope env (bndr `setIdUnfolding` unf)
2162
2163 zapBndrOccInfo :: Bool -> Id -> Id
2164 -- Consider  case e of b { (a,b) -> ... }
2165 -- Then if we bind b to (a,b) in "...", and b is not dead,
2166 -- then we must zap the deadness info on a,b
2167 zapBndrOccInfo keep_occ_info pat_id
2168   | keep_occ_info = pat_id
2169   | otherwise     = zapIdOccInfo pat_id
2170 \end{code}
2171
2172 Note [Add unfolding for scrutinee]
2173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2174 In general it's unlikely that a variable scrutinee will appear
2175 in the case alternatives   case x of { ...x unlikely to appear... }
2176 because the binder-swap in OccAnal has got rid of all such occcurrences
2177 See Note [Binder swap] in OccAnal.
2178
2179 BUT it is still VERY IMPORTANT to add a suitable unfolding for a
2180 variable scrutinee, in simplAlt.  Here's why
2181    case x of y
2182      (a,b) -> case b of c
2183                 I# v -> ...(f y)...
2184 There is no occurrence of 'b' in the (...(f y)...).  But y gets
2185 the unfolding (a,b), and *that* mentions b.  If f has a RULE
2186     RULE f (p, I# q) = ...
2187 we want that rule to match, so we must extend the in-scope env with a
2188 suitable unfolding for 'y'.  It's *essential* for rule matching; but
2189 it's also good for case-elimintation -- suppose that 'f' was inlined
2190 and did multi-level case analysis, then we'd solve it in one
2191 simplifier sweep instead of two.
2192
2193 Exactly the same issue arises in SpecConstr;
2194 see Note [Add scrutinee to ValueEnv too] in SpecConstr
2195
2196 HOWEVER, given
2197   case x of y { Just a -> r1; Nothing -> r2 }
2198 we do not want to add the unfolding x -> y to 'x', which might seem cool,
2199 since 'y' itself has different unfoldings in r1 and r2.  Reason: if we
2200 did that, we'd have to zap y's deadness info and that is a very useful
2201 piece of information.  
2202
2203 So instead we add the unfolding x -> Just a, and x -> Nothing in the
2204 respective RHSs.
2205
2206
2207 %************************************************************************
2208 %*                                                                      *
2209 \subsection{Known constructor}
2210 %*                                                                      *
2211 %************************************************************************
2212
2213 We are a bit careful with occurrence info.  Here's an example
2214
2215         (\x* -> case x of (a*, b) -> f a) (h v, e)
2216
2217 where the * means "occurs once".  This effectively becomes
2218         case (h v, e) of (a*, b) -> f a)
2219 and then
2220         let a* = h v; b = e in f a
2221 and then
2222         f (h v)
2223
2224 All this should happen in one sweep.
2225
2226 \begin{code}
2227 knownCon :: SimplEnv
2228          -> OutExpr                             -- The scrutinee
2229          -> DataCon -> [OutType] -> [OutExpr]   -- The scrutinee (in pieces)
2230          -> InId -> [InBndr] -> InExpr          -- The alternative
2231          -> SimplCont
2232          -> SimplM (SimplEnv, OutExpr)
2233
2234 knownCon env scrut dc dc_ty_args dc_args bndr bs rhs cont
2235   = do  { env'  <- bind_args env bs dc_args
2236         ; env'' <- bind_case_bndr env'
2237         ; simplExprF env'' rhs cont }
2238   where
2239     zap_occ = zapBndrOccInfo (isDeadBinder bndr)    -- bndr is an InId
2240
2241                   -- Ugh!
2242     bind_args env' [] _  = return env'
2243
2244     bind_args env' (b:bs') (Type ty : args)
2245       = ASSERT( isTyVar b )
2246         bind_args (extendTvSubst env' b ty) bs' args
2247
2248     bind_args env' (b:bs') (arg : args)
2249       = ASSERT( isId b )
2250         do { let b' = zap_occ b
2251              -- Note that the binder might be "dead", because it doesn't
2252              -- occur in the RHS; and simplNonRecX may therefore discard
2253              -- it via postInlineUnconditionally.
2254              -- Nevertheless we must keep it if the case-binder is alive,
2255              -- because it may be used in the con_app.  See Note [knownCon occ info]
2256            ; env'' <- simplNonRecX env' b' arg
2257            ; bind_args env'' bs' args }
2258
2259     bind_args _ _ _ =
2260       pprPanic "bind_args" $ ppr dc $$ ppr bs $$ ppr dc_args $$
2261                              text "scrut:" <+> ppr scrut
2262
2263        -- It's useful to bind bndr to scrut, rather than to a fresh
2264        -- binding      x = Con arg1 .. argn
2265        -- because very often the scrut is a variable, so we avoid
2266        -- creating, and then subsequently eliminating, a let-binding
2267        -- BUT, if scrut is a not a variable, we must be careful
2268        -- about duplicating the arg redexes; in that case, make
2269        -- a new con-app from the args
2270     bind_case_bndr env
2271       | isDeadBinder bndr   = return env
2272       | exprIsTrivial scrut = return (extendIdSubst env bndr (DoneEx scrut))
2273       | otherwise           = do { dc_args <- mapM (simplVar env) bs
2274                                          -- dc_ty_args are aready OutTypes,
2275                                          -- but bs are InBndrs
2276                                  ; let con_app = Var (dataConWorkId dc)
2277                                                  `mkTyApps` dc_ty_args
2278                                                  `mkApps`   dc_args
2279                                  ; simplNonRecX env bndr con_app }
2280
2281 -------------------
2282 missingAlt :: SimplEnv -> Id -> [InAlt] -> SimplCont -> SimplM (SimplEnv, OutExpr)
2283                 -- This isn't strictly an error, although it is unusual.
2284                 -- It's possible that the simplifer might "see" that
2285                 -- an inner case has no accessible alternatives before
2286                 -- it "sees" that the entire branch of an outer case is
2287                 -- inaccessible.  So we simply put an error case here instead.
2288 missingAlt env case_bndr _ cont
2289   = WARN( True, ptext (sLit "missingAlt") <+> ppr case_bndr )
2290     return (env, mkImpossibleExpr (contResultType cont))
2291 \end{code}
2292
2293
2294 %************************************************************************
2295 %*                                                                      *
2296 \subsection{Duplicating continuations}
2297 %*                                                                      *
2298 %************************************************************************
2299
2300 \begin{code}
2301 prepareCaseCont :: SimplEnv
2302                 -> [InAlt] -> SimplCont
2303                 -> SimplM (SimplEnv, SimplCont, SimplCont)
2304 -- We are considering
2305 --     K[case _ of { p1 -> r1; ...; pn -> rn }]
2306 -- where K is some enclosing continuation for the case
2307 -- Goal: split K into two pieces Kdup,Knodup so that
2308 --       a) Kdup can be duplicated
2309 --       b) Knodup[Kdup[e]] = K[e]
2310 -- The idea is that we'll transform thus:
2311 --          Knodup[ (case _ of { p1 -> Kdup[r1]; ...; pn -> Kdup[rn] }
2312 --
2313 -- We also return some extra bindings in SimplEnv (that scope over
2314 -- the entire continuation)
2315
2316 prepareCaseCont env alts cont
2317   | many_alts alts = mkDupableCont env cont
2318   | otherwise      = return (env, cont, mkBoringStop (contResultType cont))
2319   where
2320     many_alts :: [InAlt] -> Bool  -- True iff strictly > 1 non-bottom alternative
2321     many_alts []  = False         -- See Note [Bottom alternatives]
2322     many_alts [_] = False
2323     many_alts (alt:alts)
2324       | is_bot_alt alt = many_alts alts
2325       | otherwise      = not (all is_bot_alt alts)
2326
2327     is_bot_alt (_,_,rhs) = exprIsBottom rhs
2328 \end{code}
2329
2330 Note [Bottom alternatives]
2331 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2332 When we have
2333      case (case x of { A -> error .. ; B -> e; C -> error ..)
2334        of alts
2335 then we can just duplicate those alts because the A and C cases
2336 will disappear immediately.  This is more direct than creating
2337 join points and inlining them away; and in some cases we would
2338 not even create the join points (see Note [Single-alternative case])
2339 and we would keep the case-of-case which is silly.  See Trac #4930.
2340
2341 \begin{code}
2342 mkDupableCont :: SimplEnv -> SimplCont
2343               -> SimplM (SimplEnv, SimplCont, SimplCont)
2344
2345 mkDupableCont env cont
2346   | contIsDupable cont
2347   = return (env, cont, mkBoringStop (contResultType cont))
2348
2349 mkDupableCont _   (Stop {}) = panic "mkDupableCont"     -- Handled by previous eqn
2350
2351 mkDupableCont env (CoerceIt ty cont)
2352   = do  { (env', dup, nodup) <- mkDupableCont env cont
2353         ; return (env', CoerceIt ty dup, nodup) }
2354
2355 -- Duplicating ticks for now, not sure if this is good or not
2356 mkDupableCont env cont@(TickIt{})
2357   = return (env, mkBoringStop (contInputType cont), cont)
2358
2359 mkDupableCont env cont@(StrictBind {})
2360   =  return (env, mkBoringStop (contInputType cont), cont)
2361         -- See Note [Duplicating StrictBind]
2362
2363 mkDupableCont env (StrictArg info cci cont)
2364         -- See Note [Duplicating StrictArg]
2365   = do { (env', dup, nodup) <- mkDupableCont env cont
2366        ; (env'', args')     <- mapAccumLM makeTrivialArg env' (ai_args info)
2367        ; return (env'', StrictArg (info { ai_args = args' }) cci dup, nodup) }
2368
2369 mkDupableCont env (ApplyTo _ arg se cont)
2370   =     -- e.g.         [...hole...] (...arg...)
2371         --      ==>
2372         --              let a = ...arg...
2373         --              in [...hole...] a
2374     do  { (env', dup_cont, nodup_cont) <- mkDupableCont env cont
2375         ; arg' <- simplExpr (se `setInScope` env') arg
2376         ; (env'', arg'') <- makeTrivial NotTopLevel env' arg'
2377         ; let app_cont = ApplyTo OkToDup arg'' (zapSubstEnv env'') dup_cont
2378         ; return (env'', app_cont, nodup_cont) }
2379
2380 mkDupableCont env cont@(Select _ case_bndr [(_, bs, _rhs)] _ _)
2381 --  See Note [Single-alternative case]
2382 --  | not (exprIsDupable rhs && contIsDupable case_cont)
2383 --  | not (isDeadBinder case_bndr)
2384   | all isDeadBinder bs  -- InIds
2385     && not (isUnLiftedType (idType case_bndr))
2386     -- Note [Single-alternative-unlifted]
2387   = return (env, mkBoringStop (contInputType cont), cont)
2388
2389 mkDupableCont env (Select _ case_bndr alts se cont)
2390   =     -- e.g.         (case [...hole...] of { pi -> ei })
2391         --      ===>
2392         --              let ji = \xij -> ei
2393         --              in case [...hole...] of { pi -> ji xij }
2394     do  { tick (CaseOfCase case_bndr)
2395         ; (env', dup_cont, nodup_cont) <- prepareCaseCont env alts cont
2396                 -- NB: We call prepareCaseCont here.  If there is only one
2397                 -- alternative, then dup_cont may be big, but that's ok
2398                 -- because we push it into the single alternative, and then
2399                 -- use mkDupableAlt to turn that simplified alternative into
2400                 -- a join point if it's too big to duplicate.
2401                 -- And this is important: see Note [Fusing case continuations]
2402
2403         ; let alt_env = se `setInScope` env'
2404
2405         ; (alt_env', case_bndr') <- simplBinder alt_env case_bndr
2406         ; alts' <- mapM (simplAlt alt_env' Nothing [] case_bndr' dup_cont) alts
2407         -- Safe to say that there are no handled-cons for the DEFAULT case
2408                 -- NB: simplBinder does not zap deadness occ-info, so
2409                 -- a dead case_bndr' will still advertise its deadness
2410                 -- This is really important because in
2411                 --      case e of b { (# p,q #) -> ... }
2412                 -- b is always dead, and indeed we are not allowed to bind b to (# p,q #),
2413                 -- which might happen if e was an explicit unboxed pair and b wasn't marked dead.
2414                 -- In the new alts we build, we have the new case binder, so it must retain
2415                 -- its deadness.
2416         -- NB: we don't use alt_env further; it has the substEnv for
2417         --     the alternatives, and we don't want that
2418
2419         ; (env'', alts'') <- mkDupableAlts env' case_bndr' alts'
2420         ; return (env'',  -- Note [Duplicated env]
2421                   Select OkToDup case_bndr' alts'' (zapSubstEnv env'')
2422                          (mkBoringStop (contInputType nodup_cont)),
2423                   nodup_cont) }
2424
2425
2426 mkDupableAlts :: SimplEnv -> OutId -> [InAlt]
2427               -> SimplM (SimplEnv, [InAlt])
2428 -- Absorbs the continuation into the new alternatives
2429
2430 mkDupableAlts env case_bndr' the_alts
2431   = go env the_alts
2432   where
2433     go env0 [] = return (env0, [])
2434     go env0 (alt:alts)
2435         = do { (env1, alt') <- mkDupableAlt env0 case_bndr' alt
2436              ; (env2, alts') <- go env1 alts
2437              ; return (env2, alt' : alts' ) }
2438
2439 mkDupableAlt :: SimplEnv -> OutId -> (AltCon, [CoreBndr], CoreExpr)
2440               -> SimplM (SimplEnv, (AltCon, [CoreBndr], CoreExpr))
2441 mkDupableAlt env case_bndr (con, bndrs', rhs') = do
2442   dflags <- getDynFlags
2443   if exprIsDupable dflags rhs'  -- Note [Small alternative rhs]
2444    then return (env, (con, bndrs', rhs'))
2445    else
2446     do  { let rhs_ty'  = exprType rhs'
2447               scrut_ty = idType case_bndr
2448               case_bndr_w_unf
2449                 = case con of
2450                       DEFAULT    -> case_bndr
2451                       DataAlt dc -> setIdUnfolding case_bndr unf
2452                           where
2453                                  -- See Note [Case binders and join points]
2454                              unf = mkInlineUnfolding Nothing rhs
2455                              rhs = mkConApp2 dc (tyConAppArgs scrut_ty) bndrs'
2456
2457                       LitAlt {} -> WARN( True, ptext (sLit "mkDupableAlt")
2458                                                 <+> ppr case_bndr <+> ppr con )
2459                                    case_bndr
2460                            -- The case binder is alive but trivial, so why has
2461                            -- it not been substituted away?
2462
2463               used_bndrs' | isDeadBinder case_bndr = filter abstract_over bndrs'
2464                           | otherwise              = bndrs' ++ [case_bndr_w_unf]
2465
2466               abstract_over bndr
2467                   | isTyVar bndr = True -- Abstract over all type variables just in case
2468                   | otherwise    = not (isDeadBinder bndr)
2469                         -- The deadness info on the new Ids is preserved by simplBinders
2470
2471         ; (final_bndrs', final_args)    -- Note [Join point abstraction]
2472                 <- if (any isId used_bndrs')
2473                    then return (used_bndrs', varsToCoreExprs used_bndrs')
2474                     else do { rw_id <- newId (fsLit "w") realWorldStatePrimTy
2475                             ; return ([rw_id], [Var realWorldPrimId]) }
2476
2477         ; join_bndr <- newId (fsLit "$j") (mkPiTypes final_bndrs' rhs_ty')
2478                 -- Note [Funky mkPiTypes]
2479
2480         ; let   -- We make the lambdas into one-shot-lambdas.  The
2481                 -- join point is sure to be applied at most once, and doing so
2482                 -- prevents the body of the join point being floated out by
2483                 -- the full laziness pass
2484                 really_final_bndrs     = map one_shot final_bndrs'
2485                 one_shot v | isId v    = setOneShotLambda v
2486                            | otherwise = v
2487                 join_rhs   = mkLams really_final_bndrs rhs'
2488                 join_arity = exprArity join_rhs
2489                 join_call  = mkApps (Var join_bndr) final_args
2490
2491         ; env' <- addPolyBind NotTopLevel env (NonRec (join_bndr `setIdArity` join_arity) join_rhs)
2492         ; return (env', (con, bndrs', join_call)) }
2493                 -- See Note [Duplicated env]
2494 \end{code}
2495
2496 Note [Fusing case continuations]
2497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2498 It's important to fuse two successive case continuations when the
2499 first has one alternative.  That's why we call prepareCaseCont here.
2500 Consider this, which arises from thunk splitting (see Note [Thunk
2501 splitting] in WorkWrap):
2502
2503       let
2504         x* = case (case v of {pn -> rn}) of
2505                I# a -> I# a
2506       in body
2507
2508 The simplifier will find
2509     (Var v) with continuation
2510             Select (pn -> rn) (
2511             Select [I# a -> I# a] (
2512             StrictBind body Stop
2513
2514 So we'll call mkDupableCont on
2515    Select [I# a -> I# a] (StrictBind body Stop)
2516 There is just one alternative in the first Select, so we want to
2517 simplify the rhs (I# a) with continuation (StricgtBind body Stop)
2518 Supposing that body is big, we end up with
2519           let $j a = <let x = I# a in body>
2520           in case v of { pn -> case rn of
2521                                  I# a -> $j a }
2522 This is just what we want because the rn produces a box that
2523 the case rn cancels with.
2524
2525 See Trac #4957 a fuller example.
2526
2527 Note [Case binders and join points]
2528 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2529 Consider this
2530    case (case .. ) of c {
2531      I# c# -> ....c....
2532
2533 If we make a join point with c but not c# we get
2534   $j = \c -> ....c....
2535
2536 But if later inlining scrutines the c, thus
2537
2538   $j = \c -> ... case c of { I# y -> ... } ...
2539
2540 we won't see that 'c' has already been scrutinised.  This actually
2541 happens in the 'tabulate' function in wave4main, and makes a significant
2542 difference to allocation.
2543
2544 An alternative plan is this:
2545
2546    $j = \c# -> let c = I# c# in ...c....
2547
2548 but that is bad if 'c' is *not* later scrutinised.
2549
2550 So instead we do both: we pass 'c' and 'c#' , and record in c's inlining
2551 (an InlineRule) that it's really I# c#, thus
2552
2553    $j = \c# -> \c[=I# c#] -> ...c....
2554
2555 Absence analysis may later discard 'c'.
2556
2557 NB: take great care when doing strictness analysis;
2558     see Note [Lamba-bound unfoldings] in DmdAnal.
2559
2560 Also note that we can still end up passing stuff that isn't used.  Before
2561 strictness analysis we have
2562    let $j x y c{=(x,y)} = (h c, ...)
2563    in ...
2564 After strictness analysis we see that h is strict, we end up with
2565    let $j x y c{=(x,y)} = ($wh x y, ...)
2566 and c is unused.
2567
2568 Note [Duplicated env]
2569 ~~~~~~~~~~~~~~~~~~~~~
2570 Some of the alternatives are simplified, but have not been turned into a join point
2571 So they *must* have an zapped subst-env.  So we can't use completeNonRecX to
2572 bind the join point, because it might to do PostInlineUnconditionally, and
2573 we'd lose that when zapping the subst-env.  We could have a per-alt subst-env,
2574 but zapping it (as we do in mkDupableCont, the Select case) is safe, and
2575 at worst delays the join-point inlining.
2576
2577 Note [Small alternative rhs]
2578 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2579 It is worth checking for a small RHS because otherwise we
2580 get extra let bindings that may cause an extra iteration of the simplifier to
2581 inline back in place.  Quite often the rhs is just a variable or constructor.
2582 The Ord instance of Maybe in PrelMaybe.lhs, for example, took several extra
2583 iterations because the version with the let bindings looked big, and so wasn't
2584 inlined, but after the join points had been inlined it looked smaller, and so
2585 was inlined.
2586
2587 NB: we have to check the size of rhs', not rhs.
2588 Duplicating a small InAlt might invalidate occurrence information
2589 However, if it *is* dupable, we return the *un* simplified alternative,
2590 because otherwise we'd need to pair it up with an empty subst-env....
2591 but we only have one env shared between all the alts.
2592 (Remember we must zap the subst-env before re-simplifying something).
2593 Rather than do this we simply agree to re-simplify the original (small) thing later.
2594
2595 Note [Funky mkPiTypes]
2596 ~~~~~~~~~~~~~~~~~~~~~~
2597 Notice the funky mkPiTypes.  If the contructor has existentials
2598 it's possible that the join point will be abstracted over
2599 type varaibles as well as term variables.
2600  Example:  Suppose we have
2601         data T = forall t.  C [t]
2602  Then faced with
2603         case (case e of ...) of
2604             C t xs::[t] -> rhs
2605  We get the join point
2606         let j :: forall t. [t] -> ...
2607             j = /\t \xs::[t] -> rhs
2608         in
2609         case (case e of ...) of
2610             C t xs::[t] -> j t xs
2611
2612 Note [Join point abstaction]
2613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2614 If we try to lift a primitive-typed something out
2615 for let-binding-purposes, we will *caseify* it (!),
2616 with potentially-disastrous strictness results.  So
2617 instead we turn it into a function: \v -> e
2618 where v::State# RealWorld#.  The value passed to this function
2619 is realworld#, which generates (almost) no code.
2620
2621 There's a slight infelicity here: we pass the overall
2622 case_bndr to all the join points if it's used in *any* RHS,
2623 because we don't know its usage in each RHS separately
2624
2625 We used to say "&& isUnLiftedType rhs_ty'" here, but now
2626 we make the join point into a function whenever used_bndrs'
2627 is empty.  This makes the join-point more CPR friendly.
2628 Consider:       let j = if .. then I# 3 else I# 4
2629                 in case .. of { A -> j; B -> j; C -> ... }
2630
2631 Now CPR doesn't w/w j because it's a thunk, so
2632 that means that the enclosing function can't w/w either,
2633 which is a lose.  Here's the example that happened in practice:
2634         kgmod :: Int -> Int -> Int
2635         kgmod x y = if x > 0 && y < 0 || x < 0 && y > 0
2636                     then 78
2637                     else 5
2638
2639 I have seen a case alternative like this:
2640         True -> \v -> ...
2641 It's a bit silly to add the realWorld dummy arg in this case, making
2642         $j = \s v -> ...
2643            True -> $j s
2644 (the \v alone is enough to make CPR happy) but I think it's rare
2645
2646 Note [Duplicating StrictArg]
2647 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2648 The original plan had (where E is a big argument)
2649 e.g.    f E [..hole..]
2650         ==>     let $j = \a -> f E a
2651                 in $j [..hole..]
2652
2653 But this is terrible! Here's an example:
2654         && E (case x of { T -> F; F -> T })
2655 Now, && is strict so we end up simplifying the case with
2656 an ArgOf continuation.  If we let-bind it, we get
2657         let $j = \v -> && E v
2658         in simplExpr (case x of { T -> F; F -> T })
2659                      (ArgOf (\r -> $j r)
2660 And after simplifying more we get
2661         let $j = \v -> && E v
2662         in case x of { T -> $j F; F -> $j T }
2663 Which is a Very Bad Thing
2664
2665 What we do now is this
2666         f E [..hole..]
2667         ==>     let a = E
2668                 in f a [..hole..]
2669 Now if the thing in the hole is a case expression (which is when
2670 we'll call mkDupableCont), we'll push the function call into the
2671 branches, which is what we want.  Now RULES for f may fire, and
2672 call-pattern specialisation.  Here's an example from Trac #3116
2673      go (n+1) (case l of
2674                  1  -> bs'
2675                  _  -> Chunk p fpc (o+1) (l-1) bs')
2676 If we can push the call for 'go' inside the case, we get
2677 call-pattern specialisation for 'go', which is *crucial* for
2678 this program.
2679
2680 Here is the (&&) example:
2681         && E (case x of { T -> F; F -> T })
2682   ==>   let a = E in
2683         case x of { T -> && a F; F -> && a T }
2684 Much better!
2685
2686 Notice that
2687   * Arguments to f *after* the strict one are handled by
2688     the ApplyTo case of mkDupableCont.  Eg
2689         f [..hole..] E
2690
2691   * We can only do the let-binding of E because the function
2692     part of a StrictArg continuation is an explicit syntax
2693     tree.  In earlier versions we represented it as a function
2694     (CoreExpr -> CoreEpxr) which we couldn't take apart.
2695
2696 Do *not* duplicate StrictBind and StritArg continuations.  We gain
2697 nothing by propagating them into the expressions, and we do lose a
2698 lot.
2699
2700 The desire not to duplicate is the entire reason that
2701 mkDupableCont returns a pair of continuations.
2702
2703 Note [Duplicating StrictBind]
2704 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2705 Unlike StrictArg, there doesn't seem anything to gain from
2706 duplicating a StrictBind continuation, so we don't.
2707
2708
2709 Note [Single-alternative cases]
2710 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2711 This case is just like the ArgOf case.  Here's an example:
2712         data T a = MkT !a
2713         ...(MkT (abs x))...
2714 Then we get
2715         case (case x of I# x' ->
2716               case x' <# 0# of
2717                 True  -> I# (negate# x')
2718                 False -> I# x') of y {
2719           DEFAULT -> MkT y
2720 Because the (case x) has only one alternative, we'll transform to
2721         case x of I# x' ->
2722         case (case x' <# 0# of
2723                 True  -> I# (negate# x')
2724                 False -> I# x') of y {
2725           DEFAULT -> MkT y
2726 But now we do *NOT* want to make a join point etc, giving
2727         case x of I# x' ->
2728         let $j = \y -> MkT y
2729         in case x' <# 0# of
2730                 True  -> $j (I# (negate# x'))
2731                 False -> $j (I# x')
2732 In this case the $j will inline again, but suppose there was a big
2733 strict computation enclosing the orginal call to MkT.  Then, it won't
2734 "see" the MkT any more, because it's big and won't get duplicated.
2735 And, what is worse, nothing was gained by the case-of-case transform.
2736
2737 So, in circumstances like these, we don't want to build join points
2738 and push the outer case into the branches of the inner one. Instead,
2739 don't duplicate the continuation.
2740
2741 When should we use this strategy?  We should not use it on *every*
2742 single-alternative case:
2743   e.g.  case (case ....) of (a,b) -> (# a,b #)
2744 Here we must push the outer case into the inner one!
2745 Other choices:
2746
2747    * Match [(DEFAULT,_,_)], but in the common case of Int,
2748      the alternative-filling-in code turned the outer case into
2749                 case (...) of y { I# _ -> MkT y }
2750
2751    * Match on single alternative plus (not (isDeadBinder case_bndr))
2752      Rationale: pushing the case inwards won't eliminate the construction.
2753      But there's a risk of
2754                 case (...) of y { (a,b) -> let z=(a,b) in ... }
2755      Now y looks dead, but it'll come alive again.  Still, this
2756      seems like the best option at the moment.
2757
2758    * Match on single alternative plus (all (isDeadBinder bndrs))
2759      Rationale: this is essentially  seq.
2760
2761    * Match when the rhs is *not* duplicable, and hence would lead to a
2762      join point.  This catches the disaster-case above.  We can test
2763      the *un-simplified* rhs, which is fine.  It might get bigger or
2764      smaller after simplification; if it gets smaller, this case might
2765      fire next time round.  NB also that we must test contIsDupable
2766      case_cont *too, because case_cont might be big!
2767
2768      HOWEVER: I found that this version doesn't work well, because
2769      we can get         let x = case (...) of { small } in ...case x...
2770      When x is inlined into its full context, we find that it was a bad
2771      idea to have pushed the outer case inside the (...) case.
2772
2773 Note [Single-alternative-unlifted]
2774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2775 Here's another single-alternative where we really want to do case-of-case:
2776
2777 data Mk1 = Mk1 Int# | Mk2 Int#
2778
2779 M1.f =
2780     \r [x_s74 y_s6X]
2781         case
2782             case y_s6X of tpl_s7m {
2783               M1.Mk1 ipv_s70 -> ipv_s70;
2784               M1.Mk2 ipv_s72 -> ipv_s72;
2785             }
2786         of
2787         wild_s7c
2788         { __DEFAULT ->
2789               case
2790                   case x_s74 of tpl_s7n {
2791                     M1.Mk1 ipv_s77 -> ipv_s77;
2792                     M1.Mk2 ipv_s79 -> ipv_s79;
2793                   }
2794               of
2795               wild1_s7b
2796               { __DEFAULT -> ==# [wild1_s7b wild_s7c];
2797               };
2798         };
2799
2800 So the outer case is doing *nothing at all*, other than serving as a
2801 join-point.  In this case we really want to do case-of-case and decide
2802 whether to use a real join point or just duplicate the continuation:
2803
2804     let $j s7c = case x of
2805                    Mk1 ipv77 -> (==) s7c ipv77
2806                    Mk1 ipv79 -> (==) s7c ipv79
2807     in
2808     case y of
2809       Mk1 ipv70 -> $j ipv70
2810       Mk2 ipv72 -> $j ipv72
2811
2812 Hence: check whether the case binder's type is unlifted, because then
2813 the outer case is *not* a seq.