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