ghc/compiler/simplCore/SimplUtils.lhs

   1 %
   2 % (c) The AQUA Project, Glasgow University, 1993-1998
   3 %
   4 \section[SimplUtils]{The simplifier utilities}
   5
   6 \begin{code}
   7 module SimplUtils (
   8         simplBinder, simplBinders, simplRecIds, simplLetId,
   9         tryRhsTyLam, tryEtaExpansion,
  10         mkCase,
  11
  12         -- The continuation type
  13         SimplCont(..), DupFlag(..), contIsDupable, contResultType,
  14         countValArgs, countArgs, mkRhsStop, mkStop,
  15         getContArgs, interestingCallContext, interestingArg, isStrictType, discardInline
  16
  17     ) where
  18
  19 #include "HsVersions.h"
  20
  21 import CmdLineOpts      ( switchIsOn, SimplifierSwitch(..),
  22                           opt_SimplDoLambdaEtaExpansion, opt_SimplCaseMerge, opt_DictsStrict,
  23                           opt_UF_UpdateInPlace
  24                         )
  25 import CoreSyn
  26 import CoreUtils        ( exprIsTrivial, cheapEqExpr, exprType, exprIsCheap,
  27                           etaExpand, exprEtaExpandArity, bindNonRec, mkCoerce,
  28                           findDefault
  29                         )
  30 import Subst            ( InScopeSet, mkSubst, substExpr )
  31 import qualified Subst  ( simplBndrs, simplBndr, simplLetId )
  32 import Id               ( idType, idName,
  33                           idUnfolding, idStrictness,
  34                           mkLocalId, idInfo
  35                         )
  36 import IdInfo           ( StrictnessInfo(..) )
  37 import Maybes           ( maybeToBool, catMaybes )
  38 import Name             ( setNameUnique )
  39 import Demand           ( isStrict )
  40 import SimplMonad
  41 import Type             ( Type, mkForAllTys, seqType, repType,
  42                           splitTyConApp_maybe, tyConAppArgs, mkTyVarTys,
  43                           isDictTy, isDataType, isUnLiftedType,
  44                           splitRepFunTys
  45                         )
  46 import TyCon            ( tyConDataConsIfAvailable )
  47 import DataCon          ( dataConRepArity )
  48 import VarEnv           ( SubstEnv )
  49 import Util             ( lengthExceeds, mapAccumL )
  50 import Outputable
  51 \end{code}
  52
  53
  54 %************************************************************************
  55 %*                                                                      *
  56 \subsection{The continuation data type}
  57 %*                                                                      *
  58 %************************************************************************
  59
  60 \begin{code}
  61 data SimplCont          -- Strict contexts
  62   = Stop     OutType            -- Type of the result
  63              Bool               -- True => This is the RHS of a thunk whose type suggests
  64                                 --         that update-in-place would be possible
  65                                 --         (This makes the inliner a little keener.)
  66
  67   | CoerceIt OutType                    -- The To-type, simplified
  68              SimplCont
  69
  70   | InlinePlease                        -- This continuation makes a function very
  71              SimplCont                  -- keen to inline itelf
  72
  73   | ApplyTo  DupFlag
  74              InExpr SubstEnv            -- The argument, as yet unsimplified,
  75              SimplCont                  -- and its subst-env
  76
  77   | Select   DupFlag
  78              InId [InAlt] SubstEnv      -- The case binder, alts, and subst-env
  79              SimplCont
  80
  81   | ArgOf    DupFlag            -- An arbitrary strict context: the argument
  82                                 --      of a strict function, or a primitive-arg fn
  83                                 --      or a PrimOp
  84              OutType            -- cont_ty: the type of the expression being sought by the context
  85                                 --      f (error "foo") ==> coerce t (error "foo")
  86                                 -- when f is strict
  87                                 -- We need to know the type t, to which to coerce.
  88              (OutExpr -> SimplM OutExprStuff)   -- What to do with the result
  89                                 -- The result expression in the OutExprStuff has type cont_ty
  90
  91 instance Outputable SimplCont where
  92   ppr (Stop _ _)                     = ptext SLIT("Stop")
  93   ppr (ApplyTo dup arg se cont)      = (ptext SLIT("ApplyTo") <+> ppr dup <+> ppr arg) $$ ppr cont
  94   ppr (ArgOf   dup _ _)              = ptext SLIT("ArgOf...") <+> ppr dup
  95   ppr (Select dup bndr alts se cont) = (ptext SLIT("Select") <+> ppr dup <+> ppr bndr) $$
  96                                        (nest 4 (ppr alts)) $$ ppr cont
  97   ppr (CoerceIt ty cont)             = (ptext SLIT("CoerceIt") <+> ppr ty) $$ ppr cont
  98   ppr (InlinePlease cont)            = ptext SLIT("InlinePlease") $$ ppr cont
  99
 100 data DupFlag = OkToDup | NoDup
 101
 102 instance Outputable DupFlag where
 103   ppr OkToDup = ptext SLIT("ok")
 104   ppr NoDup   = ptext SLIT("nodup")
 105
 106
 107 -------------------
 108 mkRhsStop, mkStop :: OutType -> SimplCont
 109 mkStop    ty = Stop ty False
 110 mkRhsStop ty = Stop ty (canUpdateInPlace ty)
 111
 112
 113 -------------------
 114 contIsDupable :: SimplCont -> Bool
 115 contIsDupable (Stop _ _)                 = True
 116 contIsDupable (ApplyTo  OkToDup _ _ _)   = True
 117 contIsDupable (ArgOf    OkToDup _ _)     = True
 118 contIsDupable (Select   OkToDup _ _ _ _) = True
 119 contIsDupable (CoerceIt _ cont)          = contIsDupable cont
 120 contIsDupable (InlinePlease cont)        = contIsDupable cont
 121 contIsDupable other                      = False
 122
 123 -------------------
 124 discardInline :: SimplCont -> SimplCont
 125 discardInline (InlinePlease cont)  = cont
 126 discardInline (ApplyTo d e s cont) = ApplyTo d e s (discardInline cont)
 127 discardInline cont                 = cont
 128
 129 -------------------
 130 discardableCont :: SimplCont -> Bool
 131 discardableCont (Stop _ _)          = False
 132 discardableCont (CoerceIt _ cont)   = discardableCont cont
 133 discardableCont (InlinePlease cont) = discardableCont cont
 134 discardableCont other               = True
 135
 136 discardCont :: SimplCont        -- A continuation, expecting
 137             -> SimplCont        -- Replace the continuation with a suitable coerce
 138 discardCont cont = case cont of
 139                      Stop to_ty _ -> cont
 140                      other        -> CoerceIt to_ty (mkStop to_ty)
 141                  where
 142                    to_ty = contResultType cont
 143
 144 -------------------
 145 contResultType :: SimplCont -> OutType
 146 contResultType (Stop to_ty _)        = to_ty
 147 contResultType (ArgOf _ to_ty _)     = to_ty
 148 contResultType (ApplyTo _ _ _ cont)  = contResultType cont
 149 contResultType (CoerceIt _ cont)     = contResultType cont
 150 contResultType (InlinePlease cont)   = contResultType cont
 151 contResultType (Select _ _ _ _ cont) = contResultType cont
 152
 153 -------------------
 154 countValArgs :: SimplCont -> Int
 155 countValArgs (ApplyTo _ (Type ty) se cont) = countValArgs cont
 156 countValArgs (ApplyTo _ val_arg   se cont) = 1 + countValArgs cont
 157 countValArgs other                         = 0
 158
 159 countArgs :: SimplCont -> Int
 160 countArgs (ApplyTo _ arg se cont) = 1 + countArgs cont
 161 countArgs other                   = 0
 162 \end{code}
 163
 164
 165 \begin{code}
 166 getContArgs :: OutId -> SimplCont
 167             -> SimplM ([(InExpr, SubstEnv, Bool)],      -- Arguments; the Bool is true for strict args
 168                         SimplCont,                      -- Remaining continuation
 169                         Bool)                           -- Whether we came across an InlineCall
 170 -- getContArgs id k = (args, k', inl)
 171 --      args are the leading ApplyTo items in k
 172 --      (i.e. outermost comes first)
 173 --      augmented with demand info from the functionn
 174 getContArgs fun orig_cont
 175   = getSwitchChecker    `thenSmpl` \ chkr ->
 176     let
 177                 -- Ignore strictness info if the no-case-of-case
 178                 -- flag is on.  Strictness changes evaluation order
 179                 -- and that can change full laziness
 180         stricts | switchIsOn chkr NoCaseOfCase = vanilla_stricts
 181                 | otherwise                    = computed_stricts
 182     in
 183     go [] stricts False orig_cont
 184   where
 185     ----------------------------
 186
 187         -- Type argument
 188     go acc ss inl (ApplyTo _ arg@(Type _) se cont)
 189         = go ((arg,se,False) : acc) ss inl cont
 190                 -- NB: don't bother to instantiate the function type
 191
 192         -- Value argument
 193     go acc (s:ss) inl (ApplyTo _ arg se cont)
 194         = go ((arg,se,s) : acc) ss inl cont
 195
 196         -- An Inline continuation
 197     go acc ss inl (InlinePlease cont)
 198         = go acc ss True cont
 199
 200         -- We're run out of arguments, or else we've run out of demands
 201         -- The latter only happens if the result is guaranteed bottom
 202         -- This is the case for
 203         --      * case (error "hello") of { ... }
 204         --      * (error "Hello") arg
 205         --      * f (error "Hello") where f is strict
 206         --      etc
 207     go acc ss inl cont
 208         | null ss && discardableCont cont = tick BottomFound    `thenSmpl_`
 209                                             returnSmpl (reverse acc, discardCont cont, inl)
 210         | otherwise                       = returnSmpl (reverse acc, cont,             inl)
 211
 212     ----------------------------
 213     vanilla_stricts, computed_stricts :: [Bool]
 214     vanilla_stricts  = repeat False
 215     computed_stricts = zipWith (||) fun_stricts arg_stricts
 216
 217     ----------------------------
 218     (val_arg_tys, _) = splitRepFunTys (idType fun)
 219     arg_stricts      = map isStrictType val_arg_tys ++ repeat False
 220         -- These argument types are used as a cheap and cheerful way to find
 221         -- unboxed arguments, which must be strict.  But it's an InType
 222         -- and so there might be a type variable where we expect a function
 223         -- type (the substitution hasn't happened yet).  And we don't bother
 224         -- doing the type applications for a polymorphic function.
 225         -- Hence the split*Rep*FunTys
 226
 227     ----------------------------
 228         -- If fun_stricts is finite, it means the function returns bottom
 229         -- after that number of value args have been consumed
 230         -- Otherwise it's infinite, extended with False
 231     fun_stricts
 232       = case idStrictness fun of
 233           StrictnessInfo demands result_bot
 234                 | not (demands `lengthExceeds` countValArgs orig_cont)
 235                 ->      -- Enough args, use the strictness given.
 236                         -- For bottoming functions we used to pretend that the arg
 237                         -- is lazy, so that we don't treat the arg as an
 238                         -- interesting context.  This avoids substituting
 239                         -- top-level bindings for (say) strings into
 240                         -- calls to error.  But now we are more careful about
 241                         -- inlining lone variables, so its ok (see SimplUtils.analyseCont)
 242                    if result_bot then
 243                         map isStrict demands            -- Finite => result is bottom
 244                    else
 245                         map isStrict demands ++ vanilla_stricts
 246
 247           other -> vanilla_stricts      -- Not enough args, or no strictness
 248
 249
 250 -------------------
 251 isStrictType :: Type -> Bool
 252         -- isStrictType computes whether an argument (or let RHS) should
 253         -- be computed strictly or lazily, based only on its type
 254 isStrictType ty
 255   | isUnLiftedType ty                               = True
 256   | opt_DictsStrict && isDictTy ty && isDataType ty = True
 257   | otherwise                                       = False
 258         -- Return true only for dictionary types where the dictionary
 259         -- has more than one component (else we risk poking on the component
 260         -- of a newtype dictionary)
 261
 262 -------------------
 263 interestingArg :: InScopeSet -> InExpr -> SubstEnv -> Bool
 264         -- An argument is interesting if it has *some* structure
 265         -- We are here trying to avoid unfolding a function that
 266         -- is applied only to variables that have no unfolding
 267         -- (i.e. they are probably lambda bound): f x y z
 268         -- There is little point in inlining f here.
 269 interestingArg in_scope arg subst
 270   = analyse (substExpr (mkSubst in_scope subst) arg)
 271         -- 'analyse' only looks at the top part of the result
 272         -- and substExpr is lazy, so this isn't nearly as brutal
 273         -- as it looks.
 274   where
 275     analyse (Var v)           = hasSomeUnfolding (idUnfolding v)
 276                                 -- Was: isValueUnfolding (idUnfolding v')
 277                                 -- But that seems over-pessimistic
 278     analyse (Type _)          = False
 279     analyse (App fn (Type _)) = analyse fn
 280     analyse (Note _ a)        = analyse a
 281     analyse other             = True
 282         -- Consider     let x = 3 in f x
 283         -- The substitution will contain (x -> ContEx 3), and we want to
 284         -- to say that x is an interesting argument.
 285         -- But consider also (\x. f x y) y
 286         -- The substitution will contain (x -> ContEx y), and we want to say
 287         -- that x is not interesting (assuming y has no unfolding)
 288 \end{code}
 289
 290 Comment about interestingCallContext
 291 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 292 We want to avoid inlining an expression where there can't possibly be
 293 any gain, such as in an argument position.  Hence, if the continuation
 294 is interesting (eg. a case scrutinee, application etc.) then we
 295 inline, otherwise we don't.
 296
 297 Previously some_benefit used to return True only if the variable was
 298 applied to some value arguments.  This didn't work:
 299
 300         let x = _coerce_ (T Int) Int (I# 3) in
 301         case _coerce_ Int (T Int) x of
 302                 I# y -> ....
 303
 304 we want to inline x, but can't see that it's a constructor in a case
 305 scrutinee position, and some_benefit is False.
 306
 307 Another example:
 308
 309 dMonadST = _/\_ t -> :Monad (g1 _@_ t, g2 _@_ t, g3 _@_ t)
 310
 311 ....  case dMonadST _@_ x0 of (a,b,c) -> ....
 312
 313 we'd really like to inline dMonadST here, but we *don't* want to
 314 inline if the case expression is just
 315
 316         case x of y { DEFAULT -> ... }
 317
 318 since we can just eliminate this case instead (x is in WHNF).  Similar
 319 applies when x is bound to a lambda expression.  Hence
 320 contIsInteresting looks for case expressions with just a single
 321 default case.
 322
 323 \begin{code}
 324 interestingCallContext :: Bool          -- False <=> no args at all
 325                        -> Bool          -- False <=> no value args
 326                        -> SimplCont -> Bool
 327         -- The "lone-variable" case is important.  I spent ages
 328         -- messing about with unsatisfactory varaints, but this is nice.
 329         -- The idea is that if a variable appear all alone
 330         --      as an arg of lazy fn, or rhs    Stop
 331         --      as scrutinee of a case          Select
 332         --      as arg of a strict fn           ArgOf
 333         -- then we should not inline it (unless there is some other reason,
 334         -- e.g. is is the sole occurrence).  We achieve this by making
 335         -- interestingCallContext return False for a lone variable.
 336         --
 337         -- Why?  At least in the case-scrutinee situation, turning
 338         --      let x = (a,b) in case x of y -> ...
 339         -- into
 340         --      let x = (a,b) in case (a,b) of y -> ...
 341         -- and thence to
 342         --      let x = (a,b) in let y = (a,b) in ...
 343         -- is bad if the binding for x will remain.
 344         --
 345         -- Another example: I discovered that strings
 346         -- were getting inlined straight back into applications of 'error'
 347         -- because the latter is strict.
 348         --      s = "foo"
 349         --      f = \x -> ...(error s)...
 350
 351         -- Fundamentally such contexts should not ecourage inlining becuase
 352         -- the context can ``see'' the unfolding of the variable (e.g. case or a RULE)
 353         -- so there's no gain.
 354         --
 355         -- However, even a type application or coercion isn't a lone variable.
 356         -- Consider
 357         --      case $fMonadST @ RealWorld of { :DMonad a b c -> c }
 358         -- We had better inline that sucker!  The case won't see through it.
 359         --
 360         -- For now, I'm treating treating a variable applied to types
 361         -- in a *lazy* context "lone". The motivating example was
 362         --      f = /\a. \x. BIG
 363         --      g = /\a. \y.  h (f a)
 364         -- There's no advantage in inlining f here, and perhaps
 365         -- a significant disadvantage.  Hence some_val_args in the Stop case
 366
 367 interestingCallContext some_args some_val_args cont
 368   = interesting cont
 369   where
 370     interesting (InlinePlease _)       = True
 371     interesting (Select _ _ _ _ _)     = some_args
 372     interesting (ApplyTo _ _ _ _)      = True   -- Can happen if we have (coerce t (f x)) y
 373                                                 -- Perhaps True is a bit over-keen, but I've
 374                                                 -- seen (coerce f) x, where f has an INLINE prag,
 375                                                 -- So we have to give some motivaiton for inlining it
 376     interesting (ArgOf _ _ _)          = some_val_args
 377     interesting (Stop ty upd_in_place) = some_val_args && upd_in_place
 378     interesting (CoerceIt _ cont)      = interesting cont
 379         -- If this call is the arg of a strict function, the context
 380         -- is a bit interesting.  If we inline here, we may get useful
 381         -- evaluation information to avoid repeated evals: e.g.
 382         --      x + (y * z)
 383         -- Here the contIsInteresting makes the '*' keener to inline,
 384         -- which in turn exposes a constructor which makes the '+' inline.
 385         -- Assuming that +,* aren't small enough to inline regardless.
 386         --
 387         -- It's also very important to inline in a strict context for things
 388         -- like
 389         --              foldr k z (f x)
 390         -- Here, the context of (f x) is strict, and if f's unfolding is
 391         -- a build it's *great* to inline it here.  So we must ensure that
 392         -- the context for (f x) is not totally uninteresting.
 393
 394
 395 -------------------
 396 canUpdateInPlace :: Type -> Bool
 397 -- Consider   let x = <wurble> in ...
 398 -- If <wurble> returns an explicit constructor, we might be able
 399 -- to do update in place.  So we treat even a thunk RHS context
 400 -- as interesting if update in place is possible.  We approximate
 401 -- this by seeing if the type has a single constructor with a
 402 -- small arity.  But arity zero isn't good -- we share the single copy
 403 -- for that case, so no point in sharing.
 404
 405 -- Note the repType: we want to look through newtypes for this purpose
 406
 407 canUpdateInPlace ty
 408   | not opt_UF_UpdateInPlace = False
 409   | otherwise
 410   = case splitTyConApp_maybe (repType ty) of {
 411                         Nothing         -> False ;
 412                         Just (tycon, _) ->
 413
 414                       case tyConDataConsIfAvailable tycon of
 415                         [dc]  -> arity == 1 || arity == 2
 416                               where
 417                                  arity = dataConRepArity dc
 418                         other -> False
 419                       }
 420 \end{code}
 421
 422
 423
 424 %************************************************************************
 425 %*                                                                      *
 426 \section{Dealing with a single binder}
 427 %*                                                                      *
 428 %************************************************************************
 429
 430 \begin{code}
 431 simplBinders :: [InBinder] -> ([OutBinder] -> SimplM a) -> SimplM a
 432 simplBinders bndrs thing_inside
 433   = getSubst            `thenSmpl` \ subst ->
 434     let
 435         (subst', bndrs') = Subst.simplBndrs subst bndrs
 436     in
 437     seqBndrs bndrs'     `seq`
 438     setSubst subst' (thing_inside bndrs')
 439
 440 simplBinder :: InBinder -> (OutBinder -> SimplM a) -> SimplM a
 441 simplBinder bndr thing_inside
 442   = getSubst            `thenSmpl` \ subst ->
 443     let
 444         (subst', bndr') = Subst.simplBndr subst bndr
 445     in
 446     seqBndr bndr'       `seq`
 447     setSubst subst' (thing_inside bndr')
 448
 449
 450 simplRecIds :: [InBinder] -> ([OutBinder] -> SimplM a) -> SimplM a
 451 simplRecIds ids thing_inside
 452   = getSubst            `thenSmpl` \ subst ->
 453     let
 454         (subst', ids') = mapAccumL Subst.simplLetId subst ids
 455     in
 456     seqBndrs ids'       `seq`
 457     setSubst subst' (thing_inside ids')
 458
 459 simplLetId :: InBinder -> (OutBinder -> SimplM a) -> SimplM a
 460 simplLetId id thing_inside
 461   = getSubst            `thenSmpl` \ subst ->
 462     let
 463         (subst', id') = Subst.simplLetId subst id
 464     in
 465     seqBndr id' `seq`
 466     setSubst subst' (thing_inside id')
 467
 468 seqBndrs [] = ()
 469 seqBndrs (b:bs) = seqBndr b `seq` seqBndrs bs
 470
 471 seqBndr b | isTyVar b = b `seq` ()
 472           | otherwise = seqType (idType b)      `seq`
 473                         idInfo b                `seq`
 474                         ()
 475 \end{code}
 476
 477
 478 %************************************************************************
 479 %*                                                                      *
 480 \subsection{Local tyvar-lifting}
 481 %*                                                                      *
 482 %************************************************************************
 483
 484 mkRhsTyLam tries this transformation, when the big lambda appears as
 485 the RHS of a let(rec) binding:
 486
 487         /\abc -> let(rec) x = e in b
 488    ==>
 489         let(rec) x' = /\abc -> let x = x' a b c in e
 490         in
 491         /\abc -> let x = x' a b c in b
 492
 493 This is good because it can turn things like:
 494
 495         let f = /\a -> letrec g = ... g ... in g
 496 into
 497         letrec g' = /\a -> ... g' a ...
 498         in
 499         let f = /\ a -> g' a
 500
 501 which is better.  In effect, it means that big lambdas don't impede
 502 let-floating.
 503
 504 This optimisation is CRUCIAL in eliminating the junk introduced by
 505 desugaring mutually recursive definitions.  Don't eliminate it lightly!
 506
 507 So far as the implementation is concerned:
 508
 509         Invariant: go F e = /\tvs -> F e
 510
 511         Equalities:
 512                 go F (Let x=e in b)
 513                 = Let x' = /\tvs -> F e
 514                   in
 515                   go G b
 516                 where
 517                     G = F . Let x = x' tvs
 518
 519                 go F (Letrec xi=ei in b)
 520                 = Letrec {xi' = /\tvs -> G ei}
 521                   in
 522                   go G b
 523                 where
 524                   G = F . Let {xi = xi' tvs}
 525
 526 [May 1999]  If we do this transformation *regardless* then we can
 527 end up with some pretty silly stuff.  For example,
 528
 529         let
 530             st = /\ s -> let { x1=r1 ; x2=r2 } in ...
 531         in ..
 532 becomes
 533         let y1 = /\s -> r1
 534             y2 = /\s -> r2
 535             st = /\s -> ...[y1 s/x1, y2 s/x2]
 536         in ..
 537
 538 Unless the "..." is a WHNF there is really no point in doing this.
 539 Indeed it can make things worse.  Suppose x1 is used strictly,
 540 and is of the form
 541
 542         x1* = case f y of { (a,b) -> e }
 543
 544 If we abstract this wrt the tyvar we then can't do the case inline
 545 as we would normally do.
 546
 547
 548 \begin{code}
 549 tryRhsTyLam :: OutExpr -> SimplM ([OutBind], OutExpr)
 550
 551 tryRhsTyLam rhs                         -- Only does something if there's a let
 552   | null tyvars || not (worth_it body)  -- inside a type lambda,
 553   = returnSmpl ([], rhs)                -- and a WHNF inside that
 554
 555   | otherwise
 556   = go (\x -> x) body           `thenSmpl` \ (binds, body') ->
 557     returnSmpl (binds,  mkLams tyvars body')
 558
 559   where
 560     (tyvars, body) = collectTyBinders rhs
 561
 562     worth_it e@(Let _ _) = whnf_in_middle e
 563     worth_it e           = False
 564
 565     whnf_in_middle (Let (NonRec x rhs) e) | isUnLiftedType (idType x) = False
 566     whnf_in_middle (Let _ e) = whnf_in_middle e
 567     whnf_in_middle e         = exprIsCheap e
 568
 569     go fn (Let bind@(NonRec var rhs) body)
 570       | exprIsTrivial rhs
 571       = go (fn . Let bind) body
 572
 573     go fn (Let (NonRec var rhs) body)
 574       = mk_poly tyvars_here var                         `thenSmpl` \ (var', rhs') ->
 575         go (fn . Let (mk_silly_bind var rhs')) body     `thenSmpl` \ (binds, body') ->
 576         returnSmpl (NonRec var' (mkLams tyvars_here (fn rhs)) : binds, body')
 577
 578       where
 579         tyvars_here = tyvars
 580                 --      main_tyvar_set = mkVarSet tyvars
 581                 --      var_ty = idType var
 582                 -- varSetElems (main_tyvar_set `intersectVarSet` tyVarsOfType var_ty)
 583                 -- tyvars_here was an attempt to reduce the number of tyvars
 584                 -- wrt which the new binding is abstracted.  But the naive
 585                 -- approach of abstract wrt the tyvars free in the Id's type
 586                 -- fails. Consider:
 587                 --      /\ a b -> let t :: (a,b) = (e1, e2)
 588                 --                    x :: a     = fst t
 589                 --                in ...
 590                 -- Here, b isn't free in x's type, but we must nevertheless
 591                 -- abstract wrt b as well, because t's type mentions b.
 592                 -- Since t is floated too, we'd end up with the bogus:
 593                 --      poly_t = /\ a b -> (e1, e2)
 594                 --      poly_x = /\ a   -> fst (poly_t a *b*)
 595                 -- So for now we adopt the even more naive approach of
 596                 -- abstracting wrt *all* the tyvars.  We'll see if that
 597                 -- gives rise to problems.   SLPJ June 98
 598
 599     go fn (Let (Rec prs) body)
 600        = mapAndUnzipSmpl (mk_poly tyvars_here) vars     `thenSmpl` \ (vars', rhss') ->
 601          let
 602             gn body  = fn (foldr Let body (zipWith mk_silly_bind vars rhss'))
 603             new_bind = Rec (vars' `zip` [mkLams tyvars_here (gn rhs) | rhs <- rhss])
 604          in
 605          go gn body                             `thenSmpl` \ (binds, body') ->
 606          returnSmpl (new_bind : binds, body')
 607        where
 608          (vars,rhss) = unzip prs
 609          tyvars_here = tyvars
 610                 -- varSetElems (main_tyvar_set `intersectVarSet` tyVarsOfTypes var_tys)
 611                 --       var_tys     = map idType vars
 612                 -- See notes with tyvars_here above
 613
 614     go fn body = returnSmpl ([], fn body)
 615
 616     mk_poly tyvars_here var
 617       = getUniqueSmpl           `thenSmpl` \ uniq ->
 618         let
 619             poly_name = setNameUnique (idName var) uniq         -- Keep same name
 620             poly_ty   = mkForAllTys tyvars_here (idType var)    -- But new type of course
 621             poly_id   = mkLocalId poly_name poly_ty
 622
 623                 -- In the olden days, it was crucial to copy the occInfo of the original var,
 624                 -- because we were looking at occurrence-analysed but as yet unsimplified code!
 625                 -- In particular, we mustn't lose the loop breakers.  BUT NOW we are looking
 626                 -- at already simplified code, so it doesn't matter
 627                 --
 628                 -- It's even right to retain single-occurrence or dead-var info:
 629                 -- Suppose we started with  /\a -> let x = E in B
 630                 -- where x occurs once in B. Then we transform to:
 631                 --      let x' = /\a -> E in /\a -> let x* = x' a in B
 632                 -- where x* has an INLINE prag on it.  Now, once x* is inlined,
 633                 -- the occurrences of x' will be just the occurrences originally
 634                 -- pinned on x.
 635         in
 636         returnSmpl (poly_id, mkTyApps (Var poly_id) (mkTyVarTys tyvars_here))
 637
 638     mk_silly_bind var rhs = NonRec var (Note InlineMe rhs)
 639                 -- Suppose we start with:
 640                 --
 641                 --      x = /\ a -> let g = G in E
 642                 --
 643                 -- Then we'll float to get
 644                 --
 645                 --      x = let poly_g = /\ a -> G
 646                 --          in /\ a -> let g = poly_g a in E
 647                 --
 648                 -- But now the occurrence analyser will see just one occurrence
 649                 -- of poly_g, not inside a lambda, so the simplifier will
 650                 -- PreInlineUnconditionally poly_g back into g!  Badk to square 1!
 651                 -- (I used to think that the "don't inline lone occurrences" stuff
 652                 --  would stop this happening, but since it's the *only* occurrence,
 653                 --  PreInlineUnconditionally kicks in first!)
 654                 --
 655                 -- Solution: put an INLINE note on g's RHS, so that poly_g seems
 656                 --           to appear many times.  (NB: mkInlineMe eliminates
 657                 --           such notes on trivial RHSs, so do it manually.)
 658 \end{code}
 659
 660
 661 %************************************************************************
 662 %*                                                                      *
 663 \subsection{Eta expansion}
 664 %*                                                                      *
 665 %************************************************************************
 666
 667         Try eta expansion for RHSs
 668
 669 We go for:
 670    Case 1    f = \x1..xn -> N  ==>   f = \x1..xn y1..ym -> N y1..ym
 671                  (n >= 0)
 672      OR
 673    Case 2    f = N E1..En      ==>   z1=E1
 674                  (n > 0)                 ..
 675                                      zn=En
 676                                      f = \y1..ym -> N z1..zn y1..ym
 677
 678 where (in both cases)
 679
 680         * The xi can include type variables
 681
 682         * The yi are all value variables
 683
 684         * N is a NORMAL FORM (i.e. no redexes anywhere)
 685           wanting a suitable number of extra args.
 686
 687         * the Ei must not have unlifted type
 688
 689 There is no point in looking for a combination of the two, because
 690 that would leave use with some lets sandwiched between lambdas; that's
 691 what the final test in the first equation is for.
 692
 693 In Case 1, we may have to sandwich some coerces between the lambdas
 694 to make the types work.   exprEtaExpandArity looks through coerces
 695 when computing arity; and etaExpand adds the coerces as necessary when
 696 actually computing the expansion.
 697
 698 \begin{code}
 699 tryEtaExpansion :: OutExpr -> OutType -> SimplM ([OutBind], OutExpr)
 700 tryEtaExpansion rhs rhs_ty
 701   |  not opt_SimplDoLambdaEtaExpansion          -- Not if switched off
 702   || exprIsTrivial rhs                          -- Not if RHS is trivial
 703   || final_arity == 0                           -- Not if arity is zero
 704   = returnSmpl ([], rhs)
 705
 706   | n_val_args == 0 && not arity_is_manifest
 707   =     -- Some lambdas but not enough: case 1
 708     getUniqSupplySmpl                           `thenSmpl` \ us ->
 709     returnSmpl ([], etaExpand final_arity us rhs rhs_ty)
 710
 711   | n_val_args > 0 && not (any cant_bind arg_infos)
 712   =     -- Partial application: case 2
 713     mapAndUnzipSmpl bind_z_arg arg_infos        `thenSmpl` \ (maybe_z_binds, z_args) ->
 714     getUniqSupplySmpl                           `thenSmpl` \ us ->
 715     returnSmpl (catMaybes maybe_z_binds,
 716                 etaExpand final_arity us (mkApps fun z_args) rhs_ty)
 717
 718   | otherwise
 719   = returnSmpl ([], rhs)
 720   where
 721     (fun, args)                    = collectArgs rhs
 722     n_val_args                     = valArgCount args
 723     (fun_arity, arity_is_manifest) = exprEtaExpandArity fun
 724     final_arity                    = 0 `max` (fun_arity - n_val_args)
 725     arg_infos                      = [(arg, exprType arg, exprIsTrivial arg) | arg <- args]
 726     cant_bind (_, ty, triv)        = not triv && isUnLiftedType ty
 727
 728     bind_z_arg (arg, arg_ty, trivial_arg)
 729         | trivial_arg = returnSmpl (Nothing, arg)
 730         | otherwise   = newId SLIT("z") arg_ty  $ \ z ->
 731                         returnSmpl (Just (NonRec z arg), Var z)
 732 \end{code}
 733
 734
 735 %************************************************************************
 736 %*                                                                      *
 737 \subsection{Case absorption and identity-case elimination}
 738 %*                                                                      *
 739 %************************************************************************
 740
 741 \begin{code}
 742 mkCase :: OutExpr -> OutId -> [OutAlt] -> SimplM OutExpr
 743 \end{code}
 744
 745 @mkCase@ tries the following transformation (if possible):
 746
 747 case e of b {             ==>   case e of b {
 748   p1 -> rhs1                      p1 -> rhs1
 749   ...                             ...
 750   pm -> rhsm                      pm -> rhsm
 751   _  -> case b of b' {            pn -> rhsn[b/b'] {or (alg)  let b=b' in rhsn}
 752                                                    {or (prim) case b of b' { _ -> rhsn}}
 753               pn -> rhsn          ...
 754               ...                 po -> rhso[b/b']
 755               po -> rhso          _  -> rhsd[b/b'] {or let b'=b in rhsd}
 756               _  -> rhsd
 757 }
 758
 759 which merges two cases in one case when -- the default alternative of
 760 the outer case scrutises the same variable as the outer case This
 761 transformation is called Case Merging.  It avoids that the same
 762 variable is scrutinised multiple times.
 763
 764 \begin{code}
 765 mkCase scrut outer_bndr outer_alts
 766   |  opt_SimplCaseMerge
 767   && maybeToBool maybe_case_in_default
 768
 769   = tick (CaseMerge outer_bndr)         `thenSmpl_`
 770     returnSmpl (Case scrut outer_bndr new_alts)
 771         -- Warning: don't call mkCase recursively!
 772         -- Firstly, there's no point, because inner alts have already had
 773         -- mkCase applied to them, so they won't have a case in their default
 774         -- Secondly, if you do, you get an infinite loop, because the bindNonRec
 775         -- in munge_rhs puts a case into the DEFAULT branch!
 776   where
 777     new_alts = outer_alts_without_deflt ++ munged_inner_alts
 778     maybe_case_in_default = case findDefault outer_alts of
 779                                 (outer_alts_without_default,
 780                                  Just (Case (Var scrut_var) inner_bndr inner_alts))
 781
 782                                    | outer_bndr == scrut_var
 783                                    -> Just (outer_alts_without_default, inner_bndr, inner_alts)
 784                                 other -> Nothing
 785
 786     Just (outer_alts_without_deflt, inner_bndr, inner_alts) = maybe_case_in_default
 787
 788                 --  Eliminate any inner alts which are shadowed by the outer ones
 789     outer_cons = [con | (con,_,_) <- outer_alts_without_deflt]
 790
 791     munged_inner_alts = [ (con, args, munge_rhs rhs)
 792                         | (con, args, rhs) <- inner_alts,
 793                            not (con `elem` outer_cons)  -- Eliminate shadowed inner alts
 794                         ]
 795     munge_rhs rhs = bindNonRec inner_bndr (Var outer_bndr) rhs
 796 \end{code}
 797
 798 Now the identity-case transformation:
 799
 800         case e of               ===> e
 801                 True -> True;
 802                 False -> False
 803
 804 and similar friends.
 805
 806 \begin{code}
 807 mkCase scrut case_bndr alts
 808   | all identity_alt alts
 809   = tick (CaseIdentity case_bndr)               `thenSmpl_`
 810     returnSmpl (re_note scrut)
 811   where
 812     identity_alt (con, args, rhs) = de_note rhs `cheapEqExpr` identity_rhs con args
 813
 814     identity_rhs (DataAlt con) args = mkConApp con (arg_tys ++ map varToCoreExpr args)
 815     identity_rhs (LitAlt lit)  _    = Lit lit
 816     identity_rhs DEFAULT       _    = Var case_bndr
 817
 818     arg_tys = map Type (tyConAppArgs (idType case_bndr))
 819
 820         -- We've seen this:
 821         --      case coerce T e of x { _ -> coerce T' x }
 822         -- And we definitely want to eliminate this case!
 823         -- So we throw away notes from the RHS, and reconstruct
 824         -- (at least an approximation) at the other end
 825     de_note (Note _ e) = de_note e
 826     de_note e          = e
 827
 828         -- re_note wraps a coerce if it might be necessary
 829     re_note scrut = case head alts of
 830                         (_,_,rhs1@(Note _ _)) -> mkCoerce (exprType rhs1) (idType case_bndr) scrut
 831                         other                 -> scrut
 832 \end{code}
 833
 834 The catch-all case
 835
 836 \begin{code}
 837 mkCase other_scrut case_bndr other_alts
 838   = returnSmpl (Case other_scrut case_bndr other_alts)
 839 \end{code}
 840
 841