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