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