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         mkLam, mkCase, mkDataConAlt,
   9
  10         -- Inlining,
  11         preInlineUnconditionally, postInlineUnconditionally, activeInline, activeRule,
  12         inlineMode,
  13
  14         -- The continuation type
  15         SimplCont(..), DupFlag(..), LetRhsFlag(..),
  16         contIsDupable, contResultType,
  17         countValArgs, countArgs, pushContArgs,
  18         mkBoringStop, mkLazyArgStop, mkRhsStop, contIsRhs, contIsRhsOrArg,
  19         getContArgs, interestingCallContext, interestingArgContext,
  20         interestingArg, isStrictType
  21
  22     ) where
  23
  24 #include "HsVersions.h"
  25
  26 import SimplEnv
  27 import DynFlags         ( SimplifierSwitch(..), SimplifierMode(..),
  28                           DynFlags, DynFlag(..), dopt )
  29 import StaticFlags      ( opt_UF_UpdateInPlace, opt_SimplNoPreInlining,
  30                           opt_RulesOff )
  31 import CoreSyn
  32 import CoreFVs          ( exprFreeVars )
  33 import CoreUtils        ( cheapEqExpr, exprType, exprIsTrivial,
  34                           etaExpand, exprEtaExpandArity, bindNonRec, mkCoerce,
  35                           findDefault, exprOkForSpeculation, exprIsHNF, mergeAlts,
  36                           applyTypeToArgs
  37                         )
  38 import Literal          ( mkStringLit )
  39 import CoreUnfold       ( smallEnoughToInline )
  40 import MkId             ( eRROR_ID, wrapNewTypeBody )
  41 import Id               ( Id, idType, isDataConWorkId, idOccInfo, isDictId,
  42                           isDeadBinder, idNewDemandInfo, isExportedId, mkSysLocal,
  43                           idUnfolding, idNewStrictness, idInlinePragma, idHasRules
  44                         )
  45 import NewDemand        ( isStrictDmd, isBotRes, splitStrictSig )
  46 import SimplMonad
  47 import Var              ( tyVarKind, mkTyVar )
  48 import Name             ( mkSysTvName )
  49 import Type             ( Type, splitFunTys, dropForAlls, isStrictType,
  50                           splitTyConApp_maybe, tyConAppArgs, mkTyVarTys )
  51 import Coercion         ( isEqPredTy
  52                         )
  53 import Coercion         ( Coercion, mkUnsafeCoercion, coercionKind )
  54 import TyCon            ( tyConDataCons_maybe, isNewTyCon )
  55 import DataCon          ( DataCon, dataConRepArity, dataConExTyVars,
  56                           dataConInstArgTys, dataConTyCon )
  57 import VarSet
  58 import BasicTypes       ( TopLevelFlag(..), isNotTopLevel, OccInfo(..), isLoopBreaker, isOneOcc,
  59                           Activation, isAlwaysActive, isActive )
  60 import Util             ( lengthExceeds )
  61 import Outputable
  62 \end{code}
  63
  64
  65 %************************************************************************
  66 %*                                                                      *
  67 \subsection{The continuation data type}
  68 %*                                                                      *
  69 %************************************************************************
  70
  71 \begin{code}
  72 data SimplCont          -- Strict contexts
  73   = Stop     OutType    -- Type of the result
  74              LetRhsFlag
  75              Bool       -- True <=> There is something interesting about
  76                         --          the context, and hence the inliner
  77                         --          should be a bit keener (see interestingCallContext)
  78                         -- Two cases:
  79                         -- (a) This is the RHS of a thunk whose type suggests
  80                         --     that update-in-place would be possible
  81                         -- (b) This is an argument of a function that has RULES
  82                         --     Inlining the call might allow the rule to fire
  83
  84   | CoerceIt OutCoercion                -- The coercion simplified
  85              SimplCont
  86
  87   | ApplyTo  DupFlag
  88              CoreExpr           -- The argument
  89              (Maybe SimplEnv)   -- (Just se) => the arg is un-simplified and this is its subst-env
  90                                 -- Nothing   => the arg is already simplified; don't repeatedly simplify it!
  91              SimplCont          -- and its environment
  92
  93   | Select   DupFlag
  94              InId [InAlt] SimplEnv      -- The case binder, alts, and subst-env
  95              SimplCont
  96
  97   | ArgOf    LetRhsFlag         -- An arbitrary strict context: the argument
  98                                 --      of a strict function, or a primitive-arg fn
  99                                 --      or a PrimOp
 100                                 -- No DupFlag, because we never duplicate it
 101              OutType            -- arg_ty: type of the argument itself
 102              OutType            -- cont_ty: the type of the expression being sought by the context
 103                                 --      f (error "foo") ==> coerce t (error "foo")
 104                                 -- when f is strict
 105                                 -- We need to know the type t, to which to coerce.
 106
 107              (SimplEnv -> OutExpr -> SimplM FloatsWithExpr)     -- What to do with the result
 108                                 -- The result expression in the OutExprStuff has type cont_ty
 109
 110 data LetRhsFlag = AnArg         -- It's just an argument not a let RHS
 111                 | AnRhs         -- It's the RHS of a let (so please float lets out of big lambdas)
 112
 113 instance Outputable LetRhsFlag where
 114   ppr AnArg = ptext SLIT("arg")
 115   ppr AnRhs = ptext SLIT("rhs")
 116
 117 instance Outputable SimplCont where
 118   ppr (Stop ty is_rhs _)             = ptext SLIT("Stop") <> brackets (ppr is_rhs) <+> ppr ty
 119   ppr (ApplyTo dup arg se cont)      = (ptext SLIT("ApplyTo") <+> ppr dup <+> ppr arg) $$ ppr cont
 120   ppr (ArgOf _ _ _ _)                = ptext SLIT("ArgOf...")
 121   ppr (Select dup bndr alts se cont) = (ptext SLIT("Select") <+> ppr dup <+> ppr bndr) $$
 122                                        (nest 4 (ppr alts)) $$ ppr cont
 123   ppr (CoerceIt co cont)             = (ptext SLIT("CoerceIt") <+> ppr co) $$ ppr cont
 124
 125 data DupFlag = OkToDup | NoDup
 126
 127 instance Outputable DupFlag where
 128   ppr OkToDup = ptext SLIT("ok")
 129   ppr NoDup   = ptext SLIT("nodup")
 130
 131
 132
 133 -------------------
 134 mkBoringStop :: OutType -> SimplCont
 135 mkBoringStop ty = Stop ty AnArg False
 136
 137 mkLazyArgStop :: OutType -> Bool -> SimplCont
 138 mkLazyArgStop ty has_rules = Stop ty AnArg (canUpdateInPlace ty || has_rules)
 139
 140 mkRhsStop :: OutType -> SimplCont
 141 mkRhsStop ty = Stop ty AnRhs (canUpdateInPlace ty)
 142
 143 contIsRhs :: SimplCont -> Bool
 144 contIsRhs (Stop _ AnRhs _)    = True
 145 contIsRhs (ArgOf AnRhs _ _ _) = True
 146 contIsRhs other               = False
 147
 148 contIsRhsOrArg (Stop _ _ _)    = True
 149 contIsRhsOrArg (ArgOf _ _ _ _) = True
 150 contIsRhsOrArg other           = False
 151
 152 -------------------
 153 contIsDupable :: SimplCont -> Bool
 154 contIsDupable (Stop _ _ _)               = True
 155 contIsDupable (ApplyTo  OkToDup _ _ _)   = True
 156 contIsDupable (Select   OkToDup _ _ _ _) = True
 157 contIsDupable (CoerceIt _ cont)          = contIsDupable cont
 158 contIsDupable other                      = False
 159
 160 -------------------
 161 discardableCont :: SimplCont -> Bool
 162 discardableCont (Stop _ _ _)        = False
 163 discardableCont (CoerceIt _ cont)   = discardableCont cont
 164 discardableCont other               = True
 165
 166 discardCont :: Type             -- The type expected
 167             -> SimplCont        -- A continuation, expecting the previous type
 168             -> SimplCont        -- Replace the continuation with a suitable coerce
 169 discardCont from_ty cont = case cont of
 170                      Stop to_ty is_rhs _ -> cont
 171                      other               -> CoerceIt co (mkBoringStop to_ty)
 172                  where
 173                    co      = mkUnsafeCoercion from_ty to_ty
 174                    to_ty   = contResultType cont
 175
 176 -------------------
 177 contResultType :: SimplCont -> OutType
 178 contResultType (Stop to_ty _ _)      = to_ty
 179 contResultType (ArgOf _ _ to_ty _)   = to_ty
 180 contResultType (ApplyTo _ _ _ cont)  = contResultType cont
 181 contResultType (CoerceIt _ cont)     = contResultType cont
 182 contResultType (Select _ _ _ _ cont) = contResultType cont
 183
 184 -------------------
 185 countValArgs :: SimplCont -> Int
 186 countValArgs (ApplyTo _ (Type ty) se cont) = countValArgs cont
 187 countValArgs (ApplyTo _ val_arg   se cont) = 1 + countValArgs cont
 188 countValArgs other                         = 0
 189
 190 countArgs :: SimplCont -> Int
 191 countArgs (ApplyTo _ arg se cont) = 1 + countArgs cont
 192 countArgs other                   = 0
 193
 194 -------------------
 195 pushContArgs ::[OutArg] -> SimplCont -> SimplCont
 196 -- Pushes args with the specified environment
 197 pushContArgs []           cont = cont
 198 pushContArgs (arg : args) cont = ApplyTo NoDup arg Nothing (pushContArgs args cont)
 199 \end{code}
 200
 201
 202 \begin{code}
 203 getContArgs :: SwitchChecker
 204             -> OutId -> SimplCont
 205             -> ([(InExpr, Maybe SimplEnv, Bool)],       -- Arguments; the Bool is true for strict args
 206                 SimplCont)                              -- Remaining continuation
 207 -- getContArgs id k = (args, k', inl)
 208 --      args are the leading ApplyTo items in k
 209 --      (i.e. outermost comes first)
 210 --      augmented with demand info from the functionn
 211 getContArgs chkr fun orig_cont
 212   = let
 213                 -- Ignore strictness info if the no-case-of-case
 214                 -- flag is on.  Strictness changes evaluation order
 215                 -- and that can change full laziness
 216         stricts | switchIsOn chkr NoCaseOfCase = vanilla_stricts
 217                 | otherwise                    = computed_stricts
 218     in
 219     go [] stricts orig_cont
 220   where
 221     ----------------------------
 222
 223         -- Type argument
 224     go acc ss (ApplyTo _ arg@(Type _) se cont)
 225         = go ((arg,se,False) : acc) ss cont
 226                 -- NB: don't bother to instantiate the function type
 227
 228         -- Value argument
 229     go acc (s:ss) (ApplyTo _ arg se cont)
 230         = go ((arg,se,s) : acc) ss cont
 231
 232         -- We're run out of arguments, or else we've run out of demands
 233         -- The latter only happens if the result is guaranteed bottom
 234         -- This is the case for
 235         --      * case (error "hello") of { ... }
 236         --      * (error "Hello") arg
 237         --      * f (error "Hello") where f is strict
 238         --      etc
 239         -- Then, especially in the first of these cases, we'd like to discard
 240         -- the continuation, leaving just the bottoming expression.  But the
 241         -- type might not be right, so we may have to add a coerce.
 242
 243     go acc ss cont
 244         | null ss && discardableCont cont = (args, discardCont hole_ty cont)
 245         | otherwise                       = (args, cont)
 246         where
 247           args = reverse acc
 248           hole_ty = applyTypeToArgs (Var fun) (idType fun)
 249                                     [substExpr se arg | (arg,se,_) <- args]
 250
 251     ----------------------------
 252     vanilla_stricts, computed_stricts :: [Bool]
 253     vanilla_stricts  = repeat False
 254     computed_stricts = zipWith (||) fun_stricts arg_stricts
 255
 256     ----------------------------
 257     (val_arg_tys, res_ty) = splitFunTys (dropForAlls (idType fun))
 258     arg_stricts      = map isStrictType val_arg_tys ++ repeat False
 259         -- These argument types are used as a cheap and cheerful way to find
 260         -- unboxed arguments, which must be strict.  But it's an InType
 261         -- and so there might be a type variable where we expect a function
 262         -- type (the substitution hasn't happened yet).  And we don't bother
 263         -- doing the type applications for a polymorphic function.
 264         -- Hence the splitFunTys*IgnoringForAlls*
 265
 266     ----------------------------
 267         -- If fun_stricts is finite, it means the function returns bottom
 268         -- after that number of value args have been consumed
 269         -- Otherwise it's infinite, extended with False
 270     fun_stricts
 271       = case splitStrictSig (idNewStrictness fun) of
 272           (demands, result_info)
 273                 | not (demands `lengthExceeds` countValArgs orig_cont)
 274                 ->      -- Enough args, use the strictness given.
 275                         -- For bottoming functions we used to pretend that the arg
 276                         -- is lazy, so that we don't treat the arg as an
 277                         -- interesting context.  This avoids substituting
 278                         -- top-level bindings for (say) strings into
 279                         -- calls to error.  But now we are more careful about
 280                         -- inlining lone variables, so its ok (see SimplUtils.analyseCont)
 281                    if isBotRes result_info then
 282                         map isStrictDmd demands         -- Finite => result is bottom
 283                    else
 284                         map isStrictDmd demands ++ vanilla_stricts
 285
 286           other -> vanilla_stricts      -- Not enough args, or no strictness
 287
 288 -------------------
 289 interestingArg :: OutExpr -> Bool
 290         -- An argument is interesting if it has *some* structure
 291         -- We are here trying to avoid unfolding a function that
 292         -- is applied only to variables that have no unfolding
 293         -- (i.e. they are probably lambda bound): f x y z
 294         -- There is little point in inlining f here.
 295 interestingArg (Var v)           = hasSomeUnfolding (idUnfolding v)
 296                                         -- Was: isValueUnfolding (idUnfolding v')
 297                                         -- But that seems over-pessimistic
 298                                  || isDataConWorkId v
 299                                         -- This accounts for an argument like
 300                                         -- () or [], which is definitely interesting
 301 interestingArg (Type _)          = False
 302 interestingArg (App fn (Type _)) = interestingArg fn
 303 interestingArg (Note _ a)        = interestingArg a
 304 interestingArg other             = True
 305         -- Consider     let x = 3 in f x
 306         -- The substitution will contain (x -> ContEx 3), and we want to
 307         -- to say that x is an interesting argument.
 308         -- But consider also (\x. f x y) y
 309         -- The substitution will contain (x -> ContEx y), and we want to say
 310         -- that x is not interesting (assuming y has no unfolding)
 311 \end{code}
 312
 313 Comment about interestingCallContext
 314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 315 We want to avoid inlining an expression where there can't possibly be
 316 any gain, such as in an argument position.  Hence, if the continuation
 317 is interesting (eg. a case scrutinee, application etc.) then we
 318 inline, otherwise we don't.
 319
 320 Previously some_benefit used to return True only if the variable was
 321 applied to some value arguments.  This didn't work:
 322
 323         let x = _coerce_ (T Int) Int (I# 3) in
 324         case _coerce_ Int (T Int) x of
 325                 I# y -> ....
 326
 327 we want to inline x, but can't see that it's a constructor in a case
 328 scrutinee position, and some_benefit is False.
 329
 330 Another example:
 331
 332 dMonadST = _/\_ t -> :Monad (g1 _@_ t, g2 _@_ t, g3 _@_ t)
 333
 334 ....  case dMonadST _@_ x0 of (a,b,c) -> ....
 335
 336 we'd really like to inline dMonadST here, but we *don't* want to
 337 inline if the case expression is just
 338
 339         case x of y { DEFAULT -> ... }
 340
 341 since we can just eliminate this case instead (x is in WHNF).  Similar
 342 applies when x is bound to a lambda expression.  Hence
 343 contIsInteresting looks for case expressions with just a single
 344 default case.
 345
 346 \begin{code}
 347 interestingCallContext :: Bool          -- False <=> no args at all
 348                        -> Bool          -- False <=> no value args
 349                        -> SimplCont -> Bool
 350         -- The "lone-variable" case is important.  I spent ages
 351         -- messing about with unsatisfactory varaints, but this is nice.
 352         -- The idea is that if a variable appear all alone
 353         --      as an arg of lazy fn, or rhs    Stop
 354         --      as scrutinee of a case          Select
 355         --      as arg of a strict fn           ArgOf
 356         -- then we should not inline it (unless there is some other reason,
 357         -- e.g. is is the sole occurrence).  We achieve this by making
 358         -- interestingCallContext return False for a lone variable.
 359         --
 360         -- Why?  At least in the case-scrutinee situation, turning
 361         --      let x = (a,b) in case x of y -> ...
 362         -- into
 363         --      let x = (a,b) in case (a,b) of y -> ...
 364         -- and thence to
 365         --      let x = (a,b) in let y = (a,b) in ...
 366         -- is bad if the binding for x will remain.
 367         --
 368         -- Another example: I discovered that strings
 369         -- were getting inlined straight back into applications of 'error'
 370         -- because the latter is strict.
 371         --      s = "foo"
 372         --      f = \x -> ...(error s)...
 373
 374         -- Fundamentally such contexts should not ecourage inlining because
 375         -- the context can ``see'' the unfolding of the variable (e.g. case or a RULE)
 376         -- so there's no gain.
 377         --
 378         -- However, even a type application or coercion isn't a lone variable.
 379         -- Consider
 380         --      case $fMonadST @ RealWorld of { :DMonad a b c -> c }
 381         -- We had better inline that sucker!  The case won't see through it.
 382         --
 383         -- For now, I'm treating treating a variable applied to types
 384         -- in a *lazy* context "lone". The motivating example was
 385         --      f = /\a. \x. BIG
 386         --      g = /\a. \y.  h (f a)
 387         -- There's no advantage in inlining f here, and perhaps
 388         -- a significant disadvantage.  Hence some_val_args in the Stop case
 389
 390 interestingCallContext some_args some_val_args cont
 391   = interesting cont
 392   where
 393     interesting (Select {})              = some_args
 394     interesting (ApplyTo {})             = True -- Can happen if we have (coerce t (f x)) y
 395                                                 -- Perhaps True is a bit over-keen, but I've
 396                                                 -- seen (coerce f) x, where f has an INLINE prag,
 397                                                 -- So we have to give some motivaiton for inlining it
 398     interesting (ArgOf {})               = some_val_args
 399     interesting (Stop ty _ interesting)  = some_val_args && interesting
 400     interesting (CoerceIt _ cont)        = interesting cont
 401         -- If this call is the arg of a strict function, the context
 402         -- is a bit interesting.  If we inline here, we may get useful
 403         -- evaluation information to avoid repeated evals: e.g.
 404         --      x + (y * z)
 405         -- Here the contIsInteresting makes the '*' keener to inline,
 406         -- which in turn exposes a constructor which makes the '+' inline.
 407         -- Assuming that +,* aren't small enough to inline regardless.
 408         --
 409         -- It's also very important to inline in a strict context for things
 410         -- like
 411         --              foldr k z (f x)
 412         -- Here, the context of (f x) is strict, and if f's unfolding is
 413         -- a build it's *great* to inline it here.  So we must ensure that
 414         -- the context for (f x) is not totally uninteresting.
 415
 416
 417 -------------------
 418 interestingArgContext :: Id -> SimplCont -> Bool
 419 -- If the argument has form (f x y), where x,y are boring,
 420 -- and f is marked INLINE, then we don't want to inline f.
 421 -- But if the context of the argument is
 422 --      g (f x y)
 423 -- where g has rules, then we *do* want to inline f, in case it
 424 -- exposes a rule that might fire.  Similarly, if the context is
 425 --      h (g (f x x))
 426 -- where h has rules, then we do want to inline f.
 427 -- The interesting_arg_ctxt flag makes this happen; if it's
 428 -- set, the inliner gets just enough keener to inline f
 429 -- regardless of how boring f's arguments are, if it's marked INLINE
 430 --
 431 -- The alternative would be to *always* inline an INLINE function,
 432 -- regardless of how boring its context is; but that seems overkill
 433 -- For example, it'd mean that wrapper functions were always inlined
 434 interestingArgContext fn cont
 435   = idHasRules fn || go cont
 436   where
 437     go (Select {})            = False
 438     go (ApplyTo {})           = False
 439     go (ArgOf {})             = True
 440     go (CoerceIt _ c)         = go c
 441     go (Stop _ _ interesting) = interesting
 442
 443 -------------------
 444 canUpdateInPlace :: Type -> Bool
 445 -- Consider   let x = <wurble> in ...
 446 -- If <wurble> returns an explicit constructor, we might be able
 447 -- to do update in place.  So we treat even a thunk RHS context
 448 -- as interesting if update in place is possible.  We approximate
 449 -- this by seeing if the type has a single constructor with a
 450 -- small arity.  But arity zero isn't good -- we share the single copy
 451 -- for that case, so no point in sharing.
 452
 453 canUpdateInPlace ty
 454   | not opt_UF_UpdateInPlace = False
 455   | otherwise
 456   = case splitTyConApp_maybe ty of
 457         Nothing         -> False
 458         Just (tycon, _) -> case tyConDataCons_maybe tycon of
 459                                 Just [dc]  -> arity == 1 || arity == 2
 460                                            where
 461                                               arity = dataConRepArity dc
 462                                 other -> False
 463 \end{code}
 464
 465
 466
 467 %************************************************************************
 468 %*                                                                      *
 469 \subsection{Decisions about inlining}
 470 %*                                                                      *
 471 %************************************************************************
 472
 473 Inlining is controlled partly by the SimplifierMode switch.  This has two
 474 settings:
 475
 476         SimplGently     (a) Simplifying before specialiser/full laziness
 477                         (b) Simplifiying inside INLINE pragma
 478                         (c) Simplifying the LHS of a rule
 479                         (d) Simplifying a GHCi expression or Template
 480                                 Haskell splice
 481
 482         SimplPhase n    Used at all other times
 483
 484 The key thing about SimplGently is that it does no call-site inlining.
 485 Before full laziness we must be careful not to inline wrappers,
 486 because doing so inhibits floating
 487     e.g. ...(case f x of ...)...
 488     ==> ...(case (case x of I# x# -> fw x#) of ...)...
 489     ==> ...(case x of I# x# -> case fw x# of ...)...
 490 and now the redex (f x) isn't floatable any more.
 491
 492 The no-inlining thing is also important for Template Haskell.  You might be
 493 compiling in one-shot mode with -O2; but when TH compiles a splice before
 494 running it, we don't want to use -O2.  Indeed, we don't want to inline
 495 anything, because the byte-code interpreter might get confused about
 496 unboxed tuples and suchlike.
 497
 498 INLINE pragmas
 499 ~~~~~~~~~~~~~~
 500 SimplGently is also used as the mode to simplify inside an InlineMe note.
 501
 502 \begin{code}
 503 inlineMode :: SimplifierMode
 504 inlineMode = SimplGently
 505 \end{code}
 506
 507 It really is important to switch off inlinings inside such
 508 expressions.  Consider the following example
 509
 510         let f = \pq -> BIG
 511         in
 512         let g = \y -> f y y
 513             {-# INLINE g #-}
 514         in ...g...g...g...g...g...
 515
 516 Now, if that's the ONLY occurrence of f, it will be inlined inside g,
 517 and thence copied multiple times when g is inlined.
 518
 519
 520 This function may be inlinined in other modules, so we
 521 don't want to remove (by inlining) calls to functions that have
 522 specialisations, or that may have transformation rules in an importing
 523 scope.
 524
 525 E.g.    {-# INLINE f #-}
 526                 f x = ...g...
 527
 528 and suppose that g is strict *and* has specialisations.  If we inline
 529 g's wrapper, we deny f the chance of getting the specialised version
 530 of g when f is inlined at some call site (perhaps in some other
 531 module).
 532
 533 It's also important not to inline a worker back into a wrapper.
 534 A wrapper looks like
 535         wraper = inline_me (\x -> ...worker... )
 536 Normally, the inline_me prevents the worker getting inlined into
 537 the wrapper (initially, the worker's only call site!).  But,
 538 if the wrapper is sure to be called, the strictness analyser will
 539 mark it 'demanded', so when the RHS is simplified, it'll get an ArgOf
 540 continuation.  That's why the keep_inline predicate returns True for
 541 ArgOf continuations.  It shouldn't do any harm not to dissolve the
 542 inline-me note under these circumstances.
 543
 544 Note that the result is that we do very little simplification
 545 inside an InlineMe.
 546
 547         all xs = foldr (&&) True xs
 548         any p = all . map p  {-# INLINE any #-}
 549
 550 Problem: any won't get deforested, and so if it's exported and the
 551 importer doesn't use the inlining, (eg passes it as an arg) then we
 552 won't get deforestation at all.  We havn't solved this problem yet!
 553
 554
 555 preInlineUnconditionally
 556 ~~~~~~~~~~~~~~~~~~~~~~~~
 557 @preInlineUnconditionally@ examines a bndr to see if it is used just
 558 once in a completely safe way, so that it is safe to discard the
 559 binding inline its RHS at the (unique) usage site, REGARDLESS of how
 560 big the RHS might be.  If this is the case we don't simplify the RHS
 561 first, but just inline it un-simplified.
 562
 563 This is much better than first simplifying a perhaps-huge RHS and then
 564 inlining and re-simplifying it.  Indeed, it can be at least quadratically
 565 better.  Consider
 566
 567         x1 = e1
 568         x2 = e2[x1]
 569         x3 = e3[x2]
 570         ...etc...
 571         xN = eN[xN-1]
 572
 573 We may end up simplifying e1 N times, e2 N-1 times, e3 N-3 times etc.
 574 This can happen with cascades of functions too:
 575
 576         f1 = \x1.e1
 577         f2 = \xs.e2[f1]
 578         f3 = \xs.e3[f3]
 579         ...etc...
 580
 581 THE MAIN INVARIANT is this:
 582
 583         ----  preInlineUnconditionally invariant -----
 584    IF preInlineUnconditionally chooses to inline x = <rhs>
 585    THEN doing the inlining should not change the occurrence
 586         info for the free vars of <rhs>
 587         ----------------------------------------------
 588
 589 For example, it's tempting to look at trivial binding like
 590         x = y
 591 and inline it unconditionally.  But suppose x is used many times,
 592 but this is the unique occurrence of y.  Then inlining x would change
 593 y's occurrence info, which breaks the invariant.  It matters: y
 594 might have a BIG rhs, which will now be dup'd at every occurrenc of x.
 595
 596
 597 Evne RHSs labelled InlineMe aren't caught here, because there might be
 598 no benefit from inlining at the call site.
 599
 600 [Sept 01] Don't unconditionally inline a top-level thing, because that
 601 can simply make a static thing into something built dynamically.  E.g.
 602         x = (a,b)
 603         main = \s -> h x
 604
 605 [Remember that we treat \s as a one-shot lambda.]  No point in
 606 inlining x unless there is something interesting about the call site.
 607
 608 But watch out: if you aren't careful, some useful foldr/build fusion
 609 can be lost (most notably in spectral/hartel/parstof) because the
 610 foldr didn't see the build.  Doing the dynamic allocation isn't a big
 611 deal, in fact, but losing the fusion can be.  But the right thing here
 612 seems to be to do a callSiteInline based on the fact that there is
 613 something interesting about the call site (it's strict).  Hmm.  That
 614 seems a bit fragile.
 615
 616 Conclusion: inline top level things gaily until Phase 0 (the last
 617 phase), at which point don't.
 618
 619 \begin{code}
 620 preInlineUnconditionally :: SimplEnv -> TopLevelFlag -> InId -> InExpr -> Bool
 621 preInlineUnconditionally env top_lvl bndr rhs
 622   | not active             = False
 623   | opt_SimplNoPreInlining = False
 624   | otherwise = case idOccInfo bndr of
 625                   IAmDead                    -> True    -- Happens in ((\x.1) v)
 626                   OneOcc in_lam True int_cxt -> try_once in_lam int_cxt
 627                   other                      -> False
 628   where
 629     phase = getMode env
 630     active = case phase of
 631                    SimplGently  -> isAlwaysActive prag
 632                    SimplPhase n -> isActive n prag
 633     prag = idInlinePragma bndr
 634
 635     try_once in_lam int_cxt     -- There's one textual occurrence
 636         | not in_lam = isNotTopLevel top_lvl || early_phase
 637         | otherwise  = int_cxt && canInlineInLam rhs
 638
 639 -- Be very careful before inlining inside a lambda, becuase (a) we must not
 640 -- invalidate occurrence information, and (b) we want to avoid pushing a
 641 -- single allocation (here) into multiple allocations (inside lambda).
 642 -- Inlining a *function* with a single *saturated* call would be ok, mind you.
 643 --      || (if is_cheap && not (canInlineInLam rhs) then pprTrace "preinline" (ppr bndr <+> ppr rhs) ok else ok)
 644 --      where
 645 --              is_cheap = exprIsCheap rhs
 646 --              ok = is_cheap && int_cxt
 647
 648         --      int_cxt         The context isn't totally boring
 649         -- E.g. let f = \ab.BIG in \y. map f xs
 650         --      Don't want to substitute for f, because then we allocate
 651         --      its closure every time the \y is called
 652         -- But: let f = \ab.BIG in \y. map (f y) xs
 653         --      Now we do want to substitute for f, even though it's not
 654         --      saturated, because we're going to allocate a closure for
 655         --      (f y) every time round the loop anyhow.
 656
 657         -- canInlineInLam => free vars of rhs are (Once in_lam) or Many,
 658         -- so substituting rhs inside a lambda doesn't change the occ info.
 659         -- Sadly, not quite the same as exprIsHNF.
 660     canInlineInLam (Lit l)              = True
 661     canInlineInLam (Lam b e)            = isRuntimeVar b || canInlineInLam e
 662     canInlineInLam (Note _ e)           = canInlineInLam e
 663     canInlineInLam _                    = False
 664
 665     early_phase = case phase of
 666                         SimplPhase 0 -> False
 667                         other        -> True
 668 -- If we don't have this early_phase test, consider
 669 --      x = length [1,2,3]
 670 -- The full laziness pass carefully floats all the cons cells to
 671 -- top level, and preInlineUnconditionally floats them all back in.
 672 -- Result is (a) static allocation replaced by dynamic allocation
 673 --           (b) many simplifier iterations because this tickles
 674 --               a related problem; only one inlining per pass
 675 --
 676 -- On the other hand, I have seen cases where top-level fusion is
 677 -- lost if we don't inline top level thing (e.g. string constants)
 678 -- Hence the test for phase zero (which is the phase for all the final
 679 -- simplifications).  Until phase zero we take no special notice of
 680 -- top level things, but then we become more leery about inlining
 681 -- them.
 682
 683 \end{code}
 684
 685 postInlineUnconditionally
 686 ~~~~~~~~~~~~~~~~~~~~~~~~~
 687 @postInlineUnconditionally@ decides whether to unconditionally inline
 688 a thing based on the form of its RHS; in particular if it has a
 689 trivial RHS.  If so, we can inline and discard the binding altogether.
 690
 691 NB: a loop breaker has must_keep_binding = True and non-loop-breakers
 692 only have *forward* references Hence, it's safe to discard the binding
 693
 694 NOTE: This isn't our last opportunity to inline.  We're at the binding
 695 site right now, and we'll get another opportunity when we get to the
 696 ocurrence(s)
 697
 698 Note that we do this unconditional inlining only for trival RHSs.
 699 Don't inline even WHNFs inside lambdas; doing so may simply increase
 700 allocation when the function is called. This isn't the last chance; see
 701 NOTE above.
 702
 703 NB: Even inline pragmas (e.g. IMustBeINLINEd) are ignored here Why?
 704 Because we don't even want to inline them into the RHS of constructor
 705 arguments. See NOTE above
 706
 707 NB: At one time even NOINLINE was ignored here: if the rhs is trivial
 708 it's best to inline it anyway.  We often get a=E; b=a from desugaring,
 709 with both a and b marked NOINLINE.  But that seems incompatible with
 710 our new view that inlining is like a RULE, so I'm sticking to the 'active'
 711 story for now.
 712
 713 \begin{code}
 714 postInlineUnconditionally
 715     :: SimplEnv -> TopLevelFlag
 716     -> InId             -- The binder (an OutId would be fine too)
 717     -> OccInfo          -- From the InId
 718     -> OutExpr
 719     -> Unfolding
 720     -> Bool
 721 postInlineUnconditionally env top_lvl bndr occ_info rhs unfolding
 722   | not active             = False
 723   | isLoopBreaker occ_info = False
 724   | isExportedId bndr      = False
 725   | exprIsTrivial rhs      = True
 726   | otherwise
 727   = case occ_info of
 728         -- The point of examining occ_info here is that for *non-values*
 729         -- that occur outside a lambda, the call-site inliner won't have
 730         -- a chance (becuase it doesn't know that the thing
 731         -- only occurs once).   The pre-inliner won't have gotten
 732         -- it either, if the thing occurs in more than one branch
 733         -- So the main target is things like
 734         --      let x = f y in
 735         --      case v of
 736         --         True  -> case x of ...
 737         --         False -> case x of ...
 738         -- I'm not sure how important this is in practice
 739       OneOcc in_lam one_br int_cxt      -- OneOcc => no work-duplication issue
 740         ->     smallEnoughToInline unfolding    -- Small enough to dup
 741                         -- ToDo: consider discount on smallEnoughToInline if int_cxt is true
 742                         --
 743                         -- NB: Do NOT inline arbitrarily big things, even if one_br is True
 744                         -- Reason: doing so risks exponential behaviour.  We simplify a big
 745                         --         expression, inline it, and simplify it again.  But if the
 746                         --         very same thing happens in the big expression, we get
 747                         --         exponential cost!
 748                         -- PRINCIPLE: when we've already simplified an expression once,
 749                         -- make sure that we only inline it if it's reasonably small.
 750
 751            &&  ((isNotTopLevel top_lvl && not in_lam) ||
 752                         -- But outside a lambda, we want to be reasonably aggressive
 753                         -- about inlining into multiple branches of case
 754                         -- e.g. let x = <non-value>
 755                         --      in case y of { C1 -> ..x..; C2 -> ..x..; C3 -> ... }
 756                         -- Inlining can be a big win if C3 is the hot-spot, even if
 757                         -- the uses in C1, C2 are not 'interesting'
 758                         -- An example that gets worse if you add int_cxt here is 'clausify'
 759
 760                 (isCheapUnfolding unfolding && int_cxt))
 761                         -- isCheap => acceptable work duplication; in_lam may be true
 762                         -- int_cxt to prevent us inlining inside a lambda without some
 763                         -- good reason.  See the notes on int_cxt in preInlineUnconditionally
 764
 765       IAmDead -> True   -- This happens; for example, the case_bndr during case of
 766                         -- known constructor:  case (a,b) of x { (p,q) -> ... }
 767                         -- Here x isn't mentioned in the RHS, so we don't want to
 768                         -- create the (dead) let-binding  let x = (a,b) in ...
 769
 770       other -> False
 771
 772 -- Here's an example that we don't handle well:
 773 --      let f = if b then Left (\x.BIG) else Right (\y.BIG)
 774 --      in \y. ....case f of {...} ....
 775 -- Here f is used just once, and duplicating the case work is fine (exprIsCheap).
 776 -- But
 777 -- * We can't preInlineUnconditionally because that woud invalidate
 778 --   the occ info for b.
 779 -- * We can't postInlineUnconditionally because the RHS is big, and
 780 --   that risks exponential behaviour
 781 -- * We can't call-site inline, because the rhs is big
 782 -- Alas!
 783
 784   where
 785     active = case getMode env of
 786                    SimplGently  -> isAlwaysActive prag
 787                    SimplPhase n -> isActive n prag
 788     prag = idInlinePragma bndr
 789
 790 activeInline :: SimplEnv -> OutId -> OccInfo -> Bool
 791 activeInline env id occ
 792   = case getMode env of
 793       SimplGently -> isOneOcc occ && isAlwaysActive prag
 794         -- No inlining at all when doing gentle stuff,
 795         -- except for local things that occur once
 796         -- The reason is that too little clean-up happens if you
 797         -- don't inline use-once things.   Also a bit of inlining is *good* for
 798         -- full laziness; it can expose constant sub-expressions.
 799         -- Example in spectral/mandel/Mandel.hs, where the mandelset
 800         -- function gets a useful let-float if you inline windowToViewport
 801
 802         -- NB: we used to have a second exception, for data con wrappers.
 803         -- On the grounds that we use gentle mode for rule LHSs, and
 804         -- they match better when data con wrappers are inlined.
 805         -- But that only really applies to the trivial wrappers (like (:)),
 806         -- and they are now constructed as Compulsory unfoldings (in MkId)
 807         -- so they'll happen anyway.
 808
 809       SimplPhase n -> isActive n prag
 810   where
 811     prag = idInlinePragma id
 812
 813 activeRule :: SimplEnv -> Maybe (Activation -> Bool)
 814 -- Nothing => No rules at all
 815 activeRule env
 816   | opt_RulesOff = Nothing
 817   | otherwise
 818   = case getMode env of
 819         SimplGently  -> Just isAlwaysActive
 820                         -- Used to be Nothing (no rules in gentle mode)
 821                         -- Main motivation for changing is that I wanted
 822                         --      lift String ===> ...
 823                         -- to work in Template Haskell when simplifying
 824                         -- splices, so we get simpler code for literal strings
 825         SimplPhase n -> Just (isActive n)
 826 \end{code}
 827
 828
 829 %************************************************************************
 830 %*                                                                      *
 831 \subsection{Rebuilding a lambda}
 832 %*                                                                      *
 833 %************************************************************************
 834
 835 \begin{code}
 836 mkLam :: SimplEnv -> [OutBinder] -> OutExpr -> SimplCont -> SimplM FloatsWithExpr
 837 \end{code}
 838
 839 Try three things
 840         a) eta reduction, if that gives a trivial expression
 841         b) eta expansion [only if there are some value lambdas]
 842         c) floating lets out through big lambdas
 843                 [only if all tyvar lambdas, and only if this lambda
 844                  is the RHS of a let]
 845
 846 \begin{code}
 847 mkLam env bndrs body cont
 848  = getDOptsSmpl  `thenSmpl` \dflags ->
 849    mkLam' dflags env bndrs body cont
 850  where
 851  mkLam' dflags env bndrs body cont
 852    | dopt Opt_DoEtaReduction dflags,
 853      Just etad_lam <- tryEtaReduce bndrs body
 854    = tick (EtaReduction (head bndrs))   `thenSmpl_`
 855      returnSmpl (emptyFloats env, etad_lam)
 856
 857    | dopt Opt_DoLambdaEtaExpansion dflags,
 858      any isRuntimeVar bndrs
 859    = tryEtaExpansion dflags body        `thenSmpl` \ body' ->
 860      returnSmpl (emptyFloats env, mkLams bndrs body')
 861
 862 {-      Sept 01: I'm experimenting with getting the
 863         full laziness pass to float out past big lambdsa
 864  | all isTyVar bndrs,   -- Only for big lambdas
 865    contIsRhs cont       -- Only try the rhs type-lambda floating
 866                         -- if this is indeed a right-hand side; otherwise
 867                         -- we end up floating the thing out, only for float-in
 868                         -- to float it right back in again!
 869  = tryRhsTyLam env bndrs body           `thenSmpl` \ (floats, body') ->
 870    returnSmpl (floats, mkLams bndrs body')
 871 -}
 872
 873    | otherwise
 874    = returnSmpl (emptyFloats env, mkLams bndrs body)
 875 \end{code}
 876
 877
 878 %************************************************************************
 879 %*                                                                      *
 880 \subsection{Eta expansion and reduction}
 881 %*                                                                      *
 882 %************************************************************************
 883
 884 We try for eta reduction here, but *only* if we get all the
 885 way to an exprIsTrivial expression.
 886 We don't want to remove extra lambdas unless we are going
 887 to avoid allocating this thing altogether
 888
 889 \begin{code}
 890 tryEtaReduce :: [OutBinder] -> OutExpr -> Maybe OutExpr
 891 tryEtaReduce bndrs body
 892         -- We don't use CoreUtils.etaReduce, because we can be more
 893         -- efficient here:
 894         --  (a) we already have the binders
 895         --  (b) we can do the triviality test before computing the free vars
 896   = go (reverse bndrs) body
 897   where
 898     go (b : bs) (App fun arg) | ok_arg b arg = go bs fun        -- Loop round
 899     go []       fun           | ok_fun fun   = Just fun         -- Success!
 900     go _        _                            = Nothing          -- Failure!
 901
 902     ok_fun fun =  exprIsTrivial fun
 903                && not (any (`elemVarSet` (exprFreeVars fun)) bndrs)
 904                && (exprIsHNF fun || all ok_lam bndrs)
 905     ok_lam v = isTyVar v || isDictId v
 906         -- The exprIsHNF is because eta reduction is not
 907         -- valid in general:  \x. bot  /=  bot
 908         -- So we need to be sure that the "fun" is a value.
 909         --
 910         -- However, we always want to reduce (/\a -> f a) to f
 911         -- This came up in a RULE: foldr (build (/\a -> g a))
 912         --      did not match      foldr (build (/\b -> ...something complex...))
 913         -- The type checker can insert these eta-expanded versions,
 914         -- with both type and dictionary lambdas; hence the slightly
 915         -- ad-hoc isDictTy
 916
 917     ok_arg b arg = varToCoreExpr b `cheapEqExpr` arg
 918 \end{code}
 919
 920
 921         Try eta expansion for RHSs
 922
 923 We go for:
 924    f = \x1..xn -> N  ==>   f = \x1..xn y1..ym -> N y1..ym
 925                                  (n >= 0)
 926
 927 where (in both cases)
 928
 929         * The xi can include type variables
 930
 931         * The yi are all value variables
 932
 933         * N is a NORMAL FORM (i.e. no redexes anywhere)
 934           wanting a suitable number of extra args.
 935
 936 We may have to sandwich some coerces between the lambdas
 937 to make the types work.   exprEtaExpandArity looks through coerces
 938 when computing arity; and etaExpand adds the coerces as necessary when
 939 actually computing the expansion.
 940
 941 \begin{code}
 942 tryEtaExpansion :: DynFlags -> OutExpr -> SimplM OutExpr
 943 -- There is at least one runtime binder in the binders
 944 tryEtaExpansion dflags body
 945   = getUniquesSmpl                      `thenSmpl` \ us ->
 946     returnSmpl (etaExpand fun_arity us body (exprType body))
 947   where
 948     fun_arity = exprEtaExpandArity dflags body
 949 \end{code}
 950
 951
 952 %************************************************************************
 953 %*                                                                      *
 954 \subsection{Floating lets out of big lambdas}
 955 %*                                                                      *
 956 %************************************************************************
 957
 958 tryRhsTyLam tries this transformation, when the big lambda appears as
 959 the RHS of a let(rec) binding:
 960
 961         /\abc -> let(rec) x = e in b
 962    ==>
 963         let(rec) x' = /\abc -> let x = x' a b c in e
 964         in
 965         /\abc -> let x = x' a b c in b
 966
 967 This is good because it can turn things like:
 968
 969         let f = /\a -> letrec g = ... g ... in g
 970 into
 971         letrec g' = /\a -> ... g' a ...
 972         in
 973         let f = /\ a -> g' a
 974
 975 which is better.  In effect, it means that big lambdas don't impede
 976 let-floating.
 977
 978 This optimisation is CRUCIAL in eliminating the junk introduced by
 979 desugaring mutually recursive definitions.  Don't eliminate it lightly!
 980
 981 So far as the implementation is concerned:
 982
 983         Invariant: go F e = /\tvs -> F e
 984
 985         Equalities:
 986                 go F (Let x=e in b)
 987                 = Let x' = /\tvs -> F e
 988                   in
 989                   go G b
 990                 where
 991                     G = F . Let x = x' tvs
 992
 993                 go F (Letrec xi=ei in b)
 994                 = Letrec {xi' = /\tvs -> G ei}
 995                   in
 996                   go G b
 997                 where
 998                   G = F . Let {xi = xi' tvs}
 999
1000 [May 1999]  If we do this transformation *regardless* then we can
1001 end up with some pretty silly stuff.  For example,
1002
1003         let
1004             st = /\ s -> let { x1=r1 ; x2=r2 } in ...
1005         in ..
1006 becomes
1007         let y1 = /\s -> r1
1008             y2 = /\s -> r2
1009             st = /\s -> ...[y1 s/x1, y2 s/x2]
1010         in ..
1011
1012 Unless the "..." is a WHNF there is really no point in doing this.
1013 Indeed it can make things worse.  Suppose x1 is used strictly,
1014 and is of the form
1015
1016         x1* = case f y of { (a,b) -> e }
1017
1018 If we abstract this wrt the tyvar we then can't do the case inline
1019 as we would normally do.
1020
1021
1022 \begin{code}
1023 {-      Trying to do this in full laziness
1024
1025 tryRhsTyLam :: SimplEnv -> [OutTyVar] -> OutExpr -> SimplM FloatsWithExpr
1026 -- Call ensures that all the binders are type variables
1027
1028 tryRhsTyLam env tyvars body             -- Only does something if there's a let
1029   |  not (all isTyVar tyvars)
1030   || not (worth_it body)                -- inside a type lambda,
1031   = returnSmpl (emptyFloats env, body)  -- and a WHNF inside that
1032
1033   | otherwise
1034   = go env (\x -> x) body
1035
1036   where
1037     worth_it e@(Let _ _) = whnf_in_middle e
1038     worth_it e           = False
1039
1040     whnf_in_middle (Let (NonRec x rhs) e) | isUnLiftedType (idType x) = False
1041     whnf_in_middle (Let _ e) = whnf_in_middle e
1042     whnf_in_middle e         = exprIsCheap e
1043
1044     main_tyvar_set = mkVarSet tyvars
1045
1046     go env fn (Let bind@(NonRec var rhs) body)
1047       | exprIsTrivial rhs
1048       = go env (fn . Let bind) body
1049
1050     go env fn (Let (NonRec var rhs) body)
1051       = mk_poly tyvars_here var                                                 `thenSmpl` \ (var', rhs') ->
1052         addAuxiliaryBind env (NonRec var' (mkLams tyvars_here (fn rhs)))        $ \ env ->
1053         go env (fn . Let (mk_silly_bind var rhs')) body
1054
1055       where
1056
1057         tyvars_here = varSetElems (main_tyvar_set `intersectVarSet` exprSomeFreeVars isTyVar rhs)
1058                 -- Abstract only over the type variables free in the rhs
1059                 -- wrt which the new binding is abstracted.  But the naive
1060                 -- approach of abstract wrt the tyvars free in the Id's type
1061                 -- fails. Consider:
1062                 --      /\ a b -> let t :: (a,b) = (e1, e2)
1063                 --                    x :: a     = fst t
1064                 --                in ...
1065                 -- Here, b isn't free in x's type, but we must nevertheless
1066                 -- abstract wrt b as well, because t's type mentions b.
1067                 -- Since t is floated too, we'd end up with the bogus:
1068                 --      poly_t = /\ a b -> (e1, e2)
1069                 --      poly_x = /\ a   -> fst (poly_t a *b*)
1070                 -- So for now we adopt the even more naive approach of
1071                 -- abstracting wrt *all* the tyvars.  We'll see if that
1072                 -- gives rise to problems.   SLPJ June 98
1073
1074     go env fn (Let (Rec prs) body)
1075        = mapAndUnzipSmpl (mk_poly tyvars_here) vars     `thenSmpl` \ (vars', rhss') ->
1076          let
1077             gn body = fn (foldr Let body (zipWith mk_silly_bind vars rhss'))
1078             pairs   = vars' `zip` [mkLams tyvars_here (gn rhs) | rhs <- rhss]
1079          in
1080          addAuxiliaryBind env (Rec pairs)               $ \ env ->
1081          go env gn body
1082        where
1083          (vars,rhss) = unzip prs
1084          tyvars_here = varSetElems (main_tyvar_set `intersectVarSet` exprsSomeFreeVars isTyVar (map snd prs))
1085                 -- See notes with tyvars_here above
1086
1087     go env fn body = returnSmpl (emptyFloats env, fn body)
1088
1089     mk_poly tyvars_here var
1090       = getUniqueSmpl           `thenSmpl` \ uniq ->
1091         let
1092             poly_name = setNameUnique (idName var) uniq         -- Keep same name
1093             poly_ty   = mkForAllTys tyvars_here (idType var)    -- But new type of course
1094             poly_id   = mkLocalId poly_name poly_ty
1095
1096                 -- In the olden days, it was crucial to copy the occInfo of the original var,
1097                 -- because we were looking at occurrence-analysed but as yet unsimplified code!
1098                 -- In particular, we mustn't lose the loop breakers.  BUT NOW we are looking
1099                 -- at already simplified code, so it doesn't matter
1100                 --
1101                 -- It's even right to retain single-occurrence or dead-var info:
1102                 -- Suppose we started with  /\a -> let x = E in B
1103                 -- where x occurs once in B. Then we transform to:
1104                 --      let x' = /\a -> E in /\a -> let x* = x' a in B
1105                 -- where x* has an INLINE prag on it.  Now, once x* is inlined,
1106                 -- the occurrences of x' will be just the occurrences originally
1107                 -- pinned on x.
1108         in
1109         returnSmpl (poly_id, mkTyApps (Var poly_id) (mkTyVarTys tyvars_here))
1110
1111     mk_silly_bind var rhs = NonRec var (Note InlineMe rhs)
1112                 -- Suppose we start with:
1113                 --
1114                 --      x = /\ a -> let g = G in E
1115                 --
1116                 -- Then we'll float to get
1117                 --
1118                 --      x = let poly_g = /\ a -> G
1119                 --          in /\ a -> let g = poly_g a in E
1120                 --
1121                 -- But now the occurrence analyser will see just one occurrence
1122                 -- of poly_g, not inside a lambda, so the simplifier will
1123                 -- PreInlineUnconditionally poly_g back into g!  Badk to square 1!
1124                 -- (I used to think that the "don't inline lone occurrences" stuff
1125                 --  would stop this happening, but since it's the *only* occurrence,
1126                 --  PreInlineUnconditionally kicks in first!)
1127                 --
1128                 -- Solution: put an INLINE note on g's RHS, so that poly_g seems
1129                 --           to appear many times.  (NB: mkInlineMe eliminates
1130                 --           such notes on trivial RHSs, so do it manually.)
1131 -}
1132 \end{code}
1133
1134 %************************************************************************
1135 %*                                                                      *
1136 \subsection{Case absorption and identity-case elimination}
1137 %*                                                                      *
1138 %************************************************************************
1139
1140 \begin{code}
1141 mkDataConAlt :: DataCon -> [OutType] -> InExpr -> SimplM InAlt
1142 -- Make a data-constructor alternative to replace the DEFAULT case
1143 -- NB: there's something a bit bogus here, because we put OutTypes into an InAlt
1144 mkDataConAlt con inst_tys rhs
1145   = do  { tv_uniqs <- getUniquesSmpl
1146         ; arg_uniqs <- getUniquesSmpl
1147         ; let tv_bndrs  = zipWith mk_tv_bndr (dataConExTyVars con) tv_uniqs
1148               arg_tys   = dataConInstArgTys con (inst_tys ++ mkTyVarTys tv_bndrs)
1149               arg_bndrs = zipWith mk_arg arg_tys arg_uniqs
1150         ; return (DataAlt con, tv_bndrs ++ arg_bndrs, rhs) }
1151   where
1152     mk_arg arg_ty uniq  -- Equality predicates get a TyVar
1153                         -- while dictionaries and others get an Id
1154       | isEqPredTy arg_ty = mk_tv arg_ty uniq
1155       | otherwise         = mk_id arg_ty uniq
1156
1157     mk_tv_bndr tv uniq = mk_tv (tyVarKind tv) uniq
1158     mk_tv kind uniq = mkTyVar (mkSysTvName uniq FSLIT("t")) kind
1159     mk_id ty   uniq = mkSysLocal FSLIT("a") uniq ty
1160 \end{code}
1161
1162 mkCase puts a case expression back together, trying various transformations first.
1163
1164 \begin{code}
1165 mkCase :: OutExpr -> OutId -> OutType
1166        -> [OutAlt]              -- Increasing order
1167        -> SimplM OutExpr
1168
1169 mkCase scrut case_bndr ty alts
1170   = getDOptsSmpl                        `thenSmpl` \dflags ->
1171     mkAlts dflags scrut case_bndr alts  `thenSmpl` \ better_alts ->
1172     mkCase1 scrut case_bndr ty better_alts
1173 \end{code}
1174
1175
1176 mkAlts tries these things:
1177
1178 1.  If several alternatives are identical, merge them into
1179     a single DEFAULT alternative.  I've occasionally seen this
1180     making a big difference:
1181
1182         case e of               =====>     case e of
1183           C _ -> f x                         D v -> ....v....
1184           D v -> ....v....                   DEFAULT -> f x
1185           DEFAULT -> f x
1186
1187    The point is that we merge common RHSs, at least for the DEFAULT case.
1188    [One could do something more elaborate but I've never seen it needed.]
1189    To avoid an expensive test, we just merge branches equal to the *first*
1190    alternative; this picks up the common cases
1191         a) all branches equal
1192         b) some branches equal to the DEFAULT (which occurs first)
1193
1194 2.  Case merging:
1195        case e of b {             ==>   case e of b {
1196          p1 -> rhs1                      p1 -> rhs1
1197          ...                             ...
1198          pm -> rhsm                      pm -> rhsm
1199          _  -> case b of b' {            pn -> let b'=b in rhsn
1200                      pn -> rhsn          ...
1201                      ...                 po -> let b'=b in rhso
1202                      po -> rhso          _  -> let b'=b in rhsd
1203                      _  -> rhsd
1204        }
1205
1206     which merges two cases in one case when -- the default alternative of
1207     the outer case scrutises the same variable as the outer case This
1208     transformation is called Case Merging.  It avoids that the same
1209     variable is scrutinised multiple times.
1210
1211
1212 The case where transformation (1) showed up was like this (lib/std/PrelCError.lhs):
1213
1214         x | p `is` 1 -> e1
1215           | p `is` 2 -> e2
1216         ...etc...
1217
1218 where @is@ was something like
1219
1220         p `is` n = p /= (-1) && p == n
1221
1222 This gave rise to a horrible sequence of cases
1223
1224         case p of
1225           (-1) -> $j p
1226           1    -> e1
1227           DEFAULT -> $j p
1228
1229 and similarly in cascade for all the join points!
1230
1231
1232
1233 \begin{code}
1234 --------------------------------------------------
1235 --      1. Merge identical branches
1236 --------------------------------------------------
1237 mkAlts dflags scrut case_bndr alts@((con1,bndrs1,rhs1) : con_alts)
1238   | all isDeadBinder bndrs1,                    -- Remember the default
1239     length filtered_alts < length con_alts      -- alternative comes first
1240   = tick (AltMerge case_bndr)                   `thenSmpl_`
1241     returnSmpl better_alts
1242   where
1243     filtered_alts        = filter keep con_alts
1244     keep (con,bndrs,rhs) = not (all isDeadBinder bndrs && rhs `cheapEqExpr` rhs1)
1245     better_alts          = (DEFAULT, [], rhs1) : filtered_alts
1246
1247
1248 --------------------------------------------------
1249 --      2.  Merge nested cases
1250 --------------------------------------------------
1251
1252 mkAlts dflags scrut outer_bndr outer_alts
1253   | dopt Opt_CaseMerge dflags,
1254     (outer_alts_without_deflt, maybe_outer_deflt)   <- findDefault outer_alts,
1255     Just (Case (Var scrut_var) inner_bndr _ inner_alts) <- maybe_outer_deflt,
1256     scruting_same_var scrut_var
1257   = let
1258         munged_inner_alts = [(con, args, munge_rhs rhs) | (con, args, rhs) <- inner_alts]
1259         munge_rhs rhs = bindCaseBndr inner_bndr (Var outer_bndr) rhs
1260
1261         new_alts = mergeAlts outer_alts_without_deflt munged_inner_alts
1262                 -- The merge keeps the inner DEFAULT at the front, if there is one
1263                 -- and eliminates any inner_alts that are shadowed by the outer_alts
1264     in
1265     tick (CaseMerge outer_bndr)                         `thenSmpl_`
1266     returnSmpl new_alts
1267         -- Warning: don't call mkAlts recursively!
1268         -- Firstly, there's no point, because inner alts have already had
1269         -- mkCase applied to them, so they won't have a case in their default
1270         -- Secondly, if you do, you get an infinite loop, because the bindCaseBndr
1271         -- in munge_rhs may put a case into the DEFAULT branch!
1272   where
1273         -- We are scrutinising the same variable if it's
1274         -- the outer case-binder, or if the outer case scrutinises a variable
1275         -- (and it's the same).  Testing both allows us not to replace the
1276         -- outer scrut-var with the outer case-binder (Simplify.simplCaseBinder).
1277     scruting_same_var = case scrut of
1278                           Var outer_scrut -> \ v -> v == outer_bndr || v == outer_scrut
1279                           other           -> \ v -> v == outer_bndr
1280
1281 ------------------------------------------------
1282 --      Catch-all
1283 ------------------------------------------------
1284
1285 mkAlts dflags scrut case_bndr other_alts = returnSmpl other_alts
1286 \end{code}
1287
1288
1289
1290 =================================================================================
1291
1292 mkCase1 tries these things
1293
1294 1.  Eliminate the case altogether if possible
1295
1296 2.  Case-identity:
1297
1298         case e of               ===> e
1299                 True  -> True;
1300                 False -> False
1301
1302     and similar friends.
1303
1304
1305 Start with a simple situation:
1306
1307         case x# of      ===>   e[x#/y#]
1308           y# -> e
1309
1310 (when x#, y# are of primitive type, of course).  We can't (in general)
1311 do this for algebraic cases, because we might turn bottom into
1312 non-bottom!
1313
1314 Actually, we generalise this idea to look for a case where we're
1315 scrutinising a variable, and we know that only the default case can
1316 match.  For example:
1317 \begin{verbatim}
1318         case x of
1319           0#    -> ...
1320           other -> ...(case x of
1321                          0#    -> ...
1322                          other -> ...) ...
1323 \end{code}
1324 Here the inner case can be eliminated.  This really only shows up in
1325 eliminating error-checking code.
1326
1327 We also make sure that we deal with this very common case:
1328
1329         case e of
1330           x -> ...x...
1331
1332 Here we are using the case as a strict let; if x is used only once
1333 then we want to inline it.  We have to be careful that this doesn't
1334 make the program terminate when it would have diverged before, so we
1335 check that
1336         - x is used strictly, or
1337         - e is already evaluated (it may so if e is a variable)
1338
1339 Lastly, we generalise the transformation to handle this:
1340
1341         case e of       ===> r
1342            True  -> r
1343            False -> r
1344
1345 We only do this for very cheaply compared r's (constructors, literals
1346 and variables).  If pedantic bottoms is on, we only do it when the
1347 scrutinee is a PrimOp which can't fail.
1348
1349 We do it *here*, looking at un-simplified alternatives, because we
1350 have to check that r doesn't mention the variables bound by the
1351 pattern in each alternative, so the binder-info is rather useful.
1352
1353 So the case-elimination algorithm is:
1354
1355         1. Eliminate alternatives which can't match
1356
1357         2. Check whether all the remaining alternatives
1358                 (a) do not mention in their rhs any of the variables bound in their pattern
1359            and  (b) have equal rhss
1360
1361         3. Check we can safely ditch the case:
1362                    * PedanticBottoms is off,
1363                 or * the scrutinee is an already-evaluated variable
1364                 or * the scrutinee is a primop which is ok for speculation
1365                         -- ie we want to preserve divide-by-zero errors, and
1366                         -- calls to error itself!
1367
1368                 or * [Prim cases] the scrutinee is a primitive variable
1369
1370                 or * [Alg cases] the scrutinee is a variable and
1371                      either * the rhs is the same variable
1372                         (eg case x of C a b -> x  ===>   x)
1373                      or     * there is only one alternative, the default alternative,
1374                                 and the binder is used strictly in its scope.
1375                                 [NB this is helped by the "use default binder where
1376                                  possible" transformation; see below.]
1377
1378
1379 If so, then we can replace the case with one of the rhss.
1380
1381 Further notes about case elimination
1382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1383 Consider:       test :: Integer -> IO ()
1384                 test = print
1385
1386 Turns out that this compiles to:
1387     Print.test
1388       = \ eta :: Integer
1389           eta1 :: State# RealWorld ->
1390           case PrelNum.< eta PrelNum.zeroInteger of wild { __DEFAULT ->
1391           case hPutStr stdout
1392                  (PrelNum.jtos eta ($w[] @ Char))
1393                  eta1
1394           of wild1 { (# new_s, a4 #) -> PrelIO.lvl23 new_s  }}
1395
1396 Notice the strange '<' which has no effect at all. This is a funny one.
1397 It started like this:
1398
1399 f x y = if x < 0 then jtos x
1400           else if y==0 then "" else jtos x
1401
1402 At a particular call site we have (f v 1).  So we inline to get
1403
1404         if v < 0 then jtos x
1405         else if 1==0 then "" else jtos x
1406
1407 Now simplify the 1==0 conditional:
1408
1409         if v<0 then jtos v else jtos v
1410
1411 Now common-up the two branches of the case:
1412
1413         case (v<0) of DEFAULT -> jtos v
1414
1415 Why don't we drop the case?  Because it's strict in v.  It's technically
1416 wrong to drop even unnecessary evaluations, and in practice they
1417 may be a result of 'seq' so we *definitely* don't want to drop those.
1418 I don't really know how to improve this situation.
1419
1420
1421 \begin{code}
1422 --------------------------------------------------
1423 --      0. Check for empty alternatives
1424 --------------------------------------------------
1425
1426 -- This isn't strictly an error.  It's possible that the simplifer might "see"
1427 -- that an inner case has no accessible alternatives before it "sees" that the
1428 -- entire branch of an outer case is inaccessible.  So we simply
1429 -- put an error case here insteadd
1430 mkCase1 scrut case_bndr ty []
1431   = pprTrace "mkCase1: null alts" (ppr case_bndr <+> ppr scrut) $
1432     return (mkApps (Var eRROR_ID)
1433                    [Type ty, Lit (mkStringLit "Impossible alternative")])
1434
1435 --------------------------------------------------
1436 --      1. Eliminate the case altogether if poss
1437 --------------------------------------------------
1438
1439 mkCase1 scrut case_bndr ty [(con,bndrs,rhs)]
1440   -- See if we can get rid of the case altogether
1441   -- See the extensive notes on case-elimination above
1442   -- mkCase made sure that if all the alternatives are equal,
1443   -- then there is now only one (DEFAULT) rhs
1444  |  all isDeadBinder bndrs,
1445
1446         -- Check that the scrutinee can be let-bound instead of case-bound
1447     exprOkForSpeculation scrut
1448                 -- OK not to evaluate it
1449                 -- This includes things like (==# a# b#)::Bool
1450                 -- so that we simplify
1451                 --      case ==# a# b# of { True -> x; False -> x }
1452                 -- to just
1453                 --      x
1454                 -- This particular example shows up in default methods for
1455                 -- comparision operations (e.g. in (>=) for Int.Int32)
1456         || exprIsHNF scrut                      -- It's already evaluated
1457         || var_demanded_later scrut             -- It'll be demanded later
1458
1459 --      || not opt_SimplPedanticBottoms)        -- Or we don't care!
1460 --      We used to allow improving termination by discarding cases, unless -fpedantic-bottoms was on,
1461 --      but that breaks badly for the dataToTag# primop, which relies on a case to evaluate
1462 --      its argument:  case x of { y -> dataToTag# y }
1463 --      Here we must *not* discard the case, because dataToTag# just fetches the tag from
1464 --      the info pointer.  So we'll be pedantic all the time, and see if that gives any
1465 --      other problems
1466 --      Also we don't want to discard 'seq's
1467   = tick (CaseElim case_bndr)                   `thenSmpl_`
1468     returnSmpl (bindCaseBndr case_bndr scrut rhs)
1469
1470   where
1471         -- The case binder is going to be evaluated later,
1472         -- and the scrutinee is a simple variable
1473     var_demanded_later (Var v) = isStrictDmd (idNewDemandInfo case_bndr)
1474     var_demanded_later other   = False
1475
1476
1477 --------------------------------------------------
1478 --      2. Identity case
1479 --------------------------------------------------
1480
1481 mkCase1 scrut case_bndr ty alts -- Identity case
1482   | all identity_alt alts
1483   = tick (CaseIdentity case_bndr)               `thenSmpl_`
1484     returnSmpl (re_note scrut)
1485   where
1486     identity_alt (con, args, rhs) = de_note rhs `cheapEqExpr` identity_rhs con args
1487
1488     identity_rhs (DataAlt con) args
1489       | isNewTyCon (dataConTyCon con)
1490       = wrapNewTypeBody (dataConTyCon con) arg_tys (varToCoreExpr $ head args)
1491       | otherwise
1492       = pprTrace "mkCase1" (ppr con) $ mkConApp con (arg_ty_exprs ++ varsToCoreExprs args)
1493     identity_rhs (LitAlt lit)  _    = Lit lit
1494     identity_rhs DEFAULT       _    = Var case_bndr
1495
1496     arg_tys = (tyConAppArgs (idType case_bndr))
1497     arg_ty_exprs = map Type arg_tys
1498
1499         -- We've seen this:
1500         --      case coerce T e of x { _ -> coerce T' x }
1501         -- And we definitely want to eliminate this case!
1502         -- So we throw away notes from the RHS, and reconstruct
1503         -- (at least an approximation) at the other end
1504     de_note (Note _ e) = de_note e
1505     de_note e          = e
1506
1507         -- re_note wraps a coerce if it might be necessary
1508     re_note scrut = case head alts of
1509                         (_,_,rhs1@(Note _ _)) ->
1510                             let co = mkUnsafeCoercion (idType case_bndr) (exprType rhs1) in
1511                                -- this unsafeCoercion is bad, make this better
1512                             mkCoerce co scrut
1513                         other                 -> scrut
1514
1515
1516
1517 --------------------------------------------------
1518 --      Catch-all
1519 --------------------------------------------------
1520 mkCase1 scrut bndr ty alts = returnSmpl (Case scrut bndr ty alts)
1521 \end{code}
1522
1523
1524 When adding auxiliary bindings for the case binder, it's worth checking if
1525 its dead, because it often is, and occasionally these mkCase transformations
1526 cascade rather nicely.
1527
1528 \begin{code}
1529 bindCaseBndr bndr rhs body
1530   | isDeadBinder bndr = body
1531   | otherwise         = bindNonRec bndr rhs body
1532 \end{code}