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