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