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