compiler/coreSyn/CoreUtils.lhs

   1 %
   2 % (c) The University of Glasgow 2006
   3 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   4 %
   5
   6 Utility functions on @Core@ syntax
   7
   8 \begin{code}
   9 {-# OPTIONS -fno-warn-incomplete-patterns #-}
  10 -- The above warning supression flag is a temporary kludge.
  11 -- While working on this module you are encouraged to remove it and fix
  12 -- any warnings in the module. See
  13 --     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
  14 -- for details
  15
  16 -- | Commonly useful utilites for manipulating the Core language
  17 module CoreUtils (
  18         -- * Constructing expressions
  19         mkSCC, mkCoerce, mkCoerceI,
  20         bindNonRec, needsCaseBinding,
  21         mkAltExpr, mkPiType, mkPiTypes,
  22
  23         -- * Taking expressions apart
  24         findDefault, findAlt, isDefaultAlt, mergeAlts, trimConArgs,
  25
  26         -- * Properties of expressions
  27         exprType, coreAltType, coreAltsType,
  28         exprIsDupable, exprIsTrivial, exprIsCheap, exprIsExpandable,
  29         exprIsHNF, exprOkForSpeculation, exprIsBig, exprIsConLike,
  30         rhsIsStatic,
  31
  32         -- * Expression and bindings size
  33         coreBindsSize, exprSize,
  34
  35         -- * Hashing
  36         hashExpr,
  37
  38         -- * Equality
  39         cheapEqExpr,
  40
  41         -- * Manipulating data constructors and types
  42         applyTypeToArgs, applyTypeToArg,
  43         dataConOrigInstPat, dataConRepInstPat, dataConRepFSInstPat
  44     ) where
  45
  46 #include "HsVersions.h"
  47
  48 import CoreSyn
  49 import PprCore
  50 import Var
  51 import SrcLoc
  52 import VarEnv
  53 import VarSet
  54 import Name
  55 import Module
  56 #if mingw32_TARGET_OS
  57 import Packages
  58 #endif
  59 import Literal
  60 import DataCon
  61 import PrimOp
  62 import Id
  63 import IdInfo
  64 import Type
  65 import Coercion
  66 import TyCon
  67 import CostCentre
  68 import Unique
  69 import Outputable
  70 import TysPrim
  71 import FastString
  72 import Maybes
  73 import Util
  74 import Data.Word
  75 import Data.Bits
  76 \end{code}
  77
  78
  79 %************************************************************************
  80 %*                                                                      *
  81 \subsection{Find the type of a Core atom/expression}
  82 %*                                                                      *
  83 %************************************************************************
  84
  85 \begin{code}
  86 exprType :: CoreExpr -> Type
  87 -- ^ Recover the type of a well-typed Core expression. Fails when
  88 -- applied to the actual 'CoreSyn.Type' expression as it cannot
  89 -- really be said to have a type
  90 exprType (Var var)           = idType var
  91 exprType (Lit lit)           = literalType lit
  92 exprType (Let _ body)        = exprType body
  93 exprType (Case _ _ ty _)     = ty
  94 exprType (Cast _ co)         = snd (coercionKind co)
  95 exprType (Note _ e)          = exprType e
  96 exprType (Lam binder expr)   = mkPiType binder (exprType expr)
  97 exprType e@(App _ _)
  98   = case collectArgs e of
  99         (fun, args) -> applyTypeToArgs e (exprType fun) args
 100
 101 exprType other = pprTrace "exprType" (pprCoreExpr other) alphaTy
 102
 103 coreAltType :: CoreAlt -> Type
 104 -- ^ Returns the type of the alternatives right hand side
 105 coreAltType (_,bs,rhs)
 106   | any bad_binder bs = expandTypeSynonyms ty
 107   | otherwise         = ty    -- Note [Existential variables and silly type synonyms]
 108   where
 109     ty           = exprType rhs
 110     free_tvs     = tyVarsOfType ty
 111     bad_binder b = isTyVar b && b `elemVarSet` free_tvs
 112
 113 coreAltsType :: [CoreAlt] -> Type
 114 -- ^ Returns the type of the first alternative, which should be the same as for all alternatives
 115 coreAltsType (alt:_) = coreAltType alt
 116 coreAltsType []      = panic "corAltsType"
 117 \end{code}
 118
 119 Note [Existential variables and silly type synonyms]
 120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 121 Consider
 122         data T = forall a. T (Funny a)
 123         type Funny a = Bool
 124         f :: T -> Bool
 125         f (T x) = x
 126
 127 Now, the type of 'x' is (Funny a), where 'a' is existentially quantified.
 128 That means that 'exprType' and 'coreAltsType' may give a result that *appears*
 129 to mention an out-of-scope type variable.  See Trac #3409 for a more real-world
 130 example.
 131
 132 Various possibilities suggest themselves:
 133
 134  - Ignore the problem, and make Lint not complain about such variables
 135
 136  - Expand all type synonyms (or at least all those that discard arguments)
 137       This is tricky, because at least for top-level things we want to
 138       retain the type the user originally specified.
 139
 140  - Expand synonyms on the fly, when the problem arises. That is what
 141    we are doing here.  It's not too expensive, I think.
 142
 143 \begin{code}
 144 mkPiType  :: Var   -> Type -> Type
 145 -- ^ Makes a @(->)@ type or a forall type, depending
 146 -- on whether it is given a type variable or a term variable.
 147 mkPiTypes :: [Var] -> Type -> Type
 148 -- ^ 'mkPiType' for multiple type or value arguments
 149
 150 mkPiType v ty
 151    | isId v    = mkFunTy (idType v) ty
 152    | otherwise = mkForAllTy v ty
 153
 154 mkPiTypes vs ty = foldr mkPiType ty vs
 155 \end{code}
 156
 157 \begin{code}
 158 applyTypeToArg :: Type -> CoreExpr -> Type
 159 -- ^ Determines the type resulting from applying an expression to a function with the given type
 160 applyTypeToArg fun_ty (Type arg_ty) = applyTy fun_ty arg_ty
 161 applyTypeToArg fun_ty _             = funResultTy fun_ty
 162
 163 applyTypeToArgs :: CoreExpr -> Type -> [CoreExpr] -> Type
 164 -- ^ A more efficient version of 'applyTypeToArg' when we have several arguments.
 165 -- The first argument is just for debugging, and gives some context
 166 applyTypeToArgs _ op_ty [] = op_ty
 167
 168 applyTypeToArgs e op_ty (Type ty : args)
 169   =     -- Accumulate type arguments so we can instantiate all at once
 170     go [ty] args
 171   where
 172     go rev_tys (Type ty : args) = go (ty:rev_tys) args
 173     go rev_tys rest_args        = applyTypeToArgs e op_ty' rest_args
 174                                 where
 175                                   op_ty' = applyTysD msg op_ty (reverse rev_tys)
 176                                   msg = ptext (sLit "applyTypeToArgs") <+>
 177                                         panic_msg e op_ty
 178
 179 applyTypeToArgs e op_ty (_ : args)
 180   = case (splitFunTy_maybe op_ty) of
 181         Just (_, res_ty) -> applyTypeToArgs e res_ty args
 182         Nothing -> pprPanic "applyTypeToArgs" (panic_msg e op_ty)
 183
 184 panic_msg :: CoreExpr -> Type -> SDoc
 185 panic_msg e op_ty = pprCoreExpr e $$ ppr op_ty
 186 \end{code}
 187
 188 %************************************************************************
 189 %*                                                                      *
 190 \subsection{Attaching notes}
 191 %*                                                                      *
 192 %************************************************************************
 193
 194 \begin{code}
 195 -- | Wrap the given expression in the coercion, dropping identity coercions and coalescing nested coercions
 196 mkCoerceI :: CoercionI -> CoreExpr -> CoreExpr
 197 mkCoerceI IdCo e = e
 198 mkCoerceI (ACo co) e = mkCoerce co e
 199
 200 -- | Wrap the given expression in the coercion safely, coalescing nested coercions
 201 mkCoerce :: Coercion -> CoreExpr -> CoreExpr
 202 mkCoerce co (Cast expr co2)
 203   = ASSERT(let { (from_ty, _to_ty) = coercionKind co;
 204                  (_from_ty2, to_ty2) = coercionKind co2} in
 205            from_ty `coreEqType` to_ty2 )
 206     mkCoerce (mkTransCoercion co2 co) expr
 207
 208 mkCoerce co expr
 209   = let (from_ty, _to_ty) = coercionKind co in
 210 --    if to_ty `coreEqType` from_ty
 211 --    then expr
 212 --    else
 213         ASSERT2(from_ty `coreEqType` (exprType expr), text "Trying to coerce" <+> text "(" <> ppr expr $$ text "::" <+> ppr (exprType expr) <> text ")" $$ ppr co $$ pprEqPred (coercionKind co))
 214          (Cast expr co)
 215 \end{code}
 216
 217 \begin{code}
 218 -- | Wraps the given expression in the cost centre unless
 219 -- in a way that maximises their utility to the user
 220 mkSCC :: CostCentre -> Expr b -> Expr b
 221         -- Note: Nested SCC's *are* preserved for the benefit of
 222         --       cost centre stack profiling
 223 mkSCC _  (Lit lit)          = Lit lit
 224 mkSCC cc (Lam x e)          = Lam x (mkSCC cc e)  -- Move _scc_ inside lambda
 225 mkSCC cc (Note (SCC cc') e) = Note (SCC cc) (Note (SCC cc') e)
 226 mkSCC cc (Note n e)         = Note n (mkSCC cc e) -- Move _scc_ inside notes
 227 mkSCC cc (Cast e co)        = Cast (mkSCC cc e) co -- Move _scc_ inside cast
 228 mkSCC cc expr               = Note (SCC cc) expr
 229 \end{code}
 230
 231
 232 %************************************************************************
 233 %*                                                                      *
 234 \subsection{Other expression construction}
 235 %*                                                                      *
 236 %************************************************************************
 237
 238 \begin{code}
 239 bindNonRec :: Id -> CoreExpr -> CoreExpr -> CoreExpr
 240 -- ^ @bindNonRec x r b@ produces either:
 241 --
 242 -- > let x = r in b
 243 --
 244 -- or:
 245 --
 246 -- > case r of x { _DEFAULT_ -> b }
 247 --
 248 -- depending on whether we have to use a @case@ or @let@
 249 -- binding for the expression (see 'needsCaseBinding').
 250 -- It's used by the desugarer to avoid building bindings
 251 -- that give Core Lint a heart attack, although actually
 252 -- the simplifier deals with them perfectly well. See
 253 -- also 'MkCore.mkCoreLet'
 254 bindNonRec bndr rhs body
 255   | needsCaseBinding (idType bndr) rhs = Case rhs bndr (exprType body) [(DEFAULT, [], body)]
 256   | otherwise                          = Let (NonRec bndr rhs) body
 257
 258 -- | Tests whether we have to use a @case@ rather than @let@ binding for this expression
 259 -- as per the invariants of 'CoreExpr': see "CoreSyn#let_app_invariant"
 260 needsCaseBinding :: Type -> CoreExpr -> Bool
 261 needsCaseBinding ty rhs = isUnLiftedType ty && not (exprOkForSpeculation rhs)
 262         -- Make a case expression instead of a let
 263         -- These can arise either from the desugarer,
 264         -- or from beta reductions: (\x.e) (x +# y)
 265 \end{code}
 266
 267 \begin{code}
 268 mkAltExpr :: AltCon     -- ^ Case alternative constructor
 269           -> [CoreBndr] -- ^ Things bound by the pattern match
 270           -> [Type]     -- ^ The type arguments to the case alternative
 271           -> CoreExpr
 272 -- ^ This guy constructs the value that the scrutinee must have
 273 -- given that you are in one particular branch of a case
 274 mkAltExpr (DataAlt con) args inst_tys
 275   = mkConApp con (map Type inst_tys ++ varsToCoreExprs args)
 276 mkAltExpr (LitAlt lit) [] []
 277   = Lit lit
 278 mkAltExpr (LitAlt _) _ _ = panic "mkAltExpr LitAlt"
 279 mkAltExpr DEFAULT _ _ = panic "mkAltExpr DEFAULT"
 280 \end{code}
 281
 282
 283 %************************************************************************
 284 %*                                                                      *
 285 \subsection{Taking expressions apart}
 286 %*                                                                      *
 287 %************************************************************************
 288
 289 The default alternative must be first, if it exists at all.
 290 This makes it easy to find, though it makes matching marginally harder.
 291
 292 \begin{code}
 293 -- | Extract the default case alternative
 294 findDefault :: [CoreAlt] -> ([CoreAlt], Maybe CoreExpr)
 295 findDefault ((DEFAULT,args,rhs) : alts) = ASSERT( null args ) (alts, Just rhs)
 296 findDefault alts                        =                     (alts, Nothing)
 297
 298 isDefaultAlt :: CoreAlt -> Bool
 299 isDefaultAlt (DEFAULT, _, _) = True
 300 isDefaultAlt _               = False
 301
 302
 303 -- | Find the case alternative corresponding to a particular
 304 -- constructor: panics if no such constructor exists
 305 findAlt :: AltCon -> [CoreAlt] -> Maybe CoreAlt
 306     -- A "Nothing" result *is* legitmiate
 307     -- See Note [Unreachable code]
 308 findAlt con alts
 309   = case alts of
 310         (deflt@(DEFAULT,_,_):alts) -> go alts (Just deflt)
 311         _                          -> go alts Nothing
 312   where
 313     go []                     deflt = deflt
 314     go (alt@(con1,_,_) : alts) deflt
 315       = case con `cmpAltCon` con1 of
 316           LT -> deflt   -- Missed it already; the alts are in increasing order
 317           EQ -> Just alt
 318           GT -> ASSERT( not (con1 == DEFAULT) ) go alts deflt
 319
 320 ---------------------------------
 321 mergeAlts :: [CoreAlt] -> [CoreAlt] -> [CoreAlt]
 322 -- ^ Merge alternatives preserving order; alternatives in
 323 -- the first argument shadow ones in the second
 324 mergeAlts [] as2 = as2
 325 mergeAlts as1 [] = as1
 326 mergeAlts (a1:as1) (a2:as2)
 327   = case a1 `cmpAlt` a2 of
 328         LT -> a1 : mergeAlts as1      (a2:as2)
 329         EQ -> a1 : mergeAlts as1      as2       -- Discard a2
 330         GT -> a2 : mergeAlts (a1:as1) as2
 331
 332
 333 ---------------------------------
 334 trimConArgs :: AltCon -> [CoreArg] -> [CoreArg]
 335 -- ^ Given:
 336 --
 337 -- > case (C a b x y) of
 338 -- >        C b x y -> ...
 339 --
 340 -- We want to drop the leading type argument of the scrutinee
 341 -- leaving the arguments to match agains the pattern
 342
 343 trimConArgs DEFAULT      args = ASSERT( null args ) []
 344 trimConArgs (LitAlt _)   args = ASSERT( null args ) []
 345 trimConArgs (DataAlt dc) args = dropList (dataConUnivTyVars dc) args
 346 \end{code}
 347
 348 Note [Unreachable code]
 349 ~~~~~~~~~~~~~~~~~~~~~~~
 350 It is possible (although unusual) for GHC to find a case expression
 351 that cannot match.  For example:
 352
 353      data Col = Red | Green | Blue
 354      x = Red
 355      f v = case x of
 356               Red -> ...
 357               _ -> ...(case x of { Green -> e1; Blue -> e2 })...
 358
 359 Suppose that for some silly reason, x isn't substituted in the case
 360 expression.  (Perhaps there's a NOINLINE on it, or profiling SCC stuff
 361 gets in the way; cf Trac #3118.)  Then the full-lazines pass might produce
 362 this
 363
 364      x = Red
 365      lvl = case x of { Green -> e1; Blue -> e2 })
 366      f v = case x of
 367              Red -> ...
 368              _ -> ...lvl...
 369
 370 Now if x gets inlined, we won't be able to find a matching alternative
 371 for 'Red'.  That's because 'lvl' is unreachable.  So rather than crashing
 372 we generate (error "Inaccessible alternative").
 373
 374 Similar things can happen (augmented by GADTs) when the Simplifier
 375 filters down the matching alternatives in Simplify.rebuildCase.
 376
 377
 378 %************************************************************************
 379 %*                                                                      *
 380              exprIsTrivial
 381 %*                                                                      *
 382 %************************************************************************
 383
 384 Note [exprIsTrivial]
 385 ~~~~~~~~~~~~~~~~~~~~
 386 @exprIsTrivial@ is true of expressions we are unconditionally happy to
 387                 duplicate; simple variables and constants, and type
 388                 applications.  Note that primop Ids aren't considered
 389                 trivial unless
 390
 391 Note [Variable are trivial]
 392 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 393 There used to be a gruesome test for (hasNoBinding v) in the
 394 Var case:
 395         exprIsTrivial (Var v) | hasNoBinding v = idArity v == 0
 396 The idea here is that a constructor worker, like \$wJust, is
 397 really short for (\x -> \$wJust x), becuase \$wJust has no binding.
 398 So it should be treated like a lambda.  Ditto unsaturated primops.
 399 But now constructor workers are not "have-no-binding" Ids.  And
 400 completely un-applied primops and foreign-call Ids are sufficiently
 401 rare that I plan to allow them to be duplicated and put up with
 402 saturating them.
 403
 404 Note [SCCs are trivial]
 405 ~~~~~~~~~~~~~~~~~~~~~~~
 406 We used not to treat (_scc_ "foo" x) as trivial, because it really
 407 generates code, (and a heap object when it's a function arg) to
 408 capture the cost centre.  However, the profiling system discounts the
 409 allocation costs for such "boxing thunks" whereas the extra costs of
 410 *not* inlining otherwise-trivial bindings can be high, and are hard to
 411 discount.
 412
 413 \begin{code}
 414 exprIsTrivial :: CoreExpr -> Bool
 415 exprIsTrivial (Var _)          = True        -- See Note [Variables are trivial]
 416 exprIsTrivial (Type _)         = True
 417 exprIsTrivial (Lit lit)        = litIsTrivial lit
 418 exprIsTrivial (App e arg)      = not (isRuntimeArg arg) && exprIsTrivial e
 419 exprIsTrivial (Note _       e) = exprIsTrivial e  -- See Note [SCCs are trivial]
 420 exprIsTrivial (Cast e _)       = exprIsTrivial e
 421 exprIsTrivial (Lam b body)     = not (isRuntimeVar b) && exprIsTrivial body
 422 exprIsTrivial _                = False
 423 \end{code}
 424
 425
 426 %************************************************************************
 427 %*                                                                      *
 428              exprIsDupable
 429 %*                                                                      *
 430 %************************************************************************
 431
 432 Note [exprIsDupable]
 433 ~~~~~~~~~~~~~~~~~~~~
 434 @exprIsDupable@ is true of expressions that can be duplicated at a modest
 435                 cost in code size.  This will only happen in different case
 436                 branches, so there's no issue about duplicating work.
 437
 438                 That is, exprIsDupable returns True of (f x) even if
 439                 f is very very expensive to call.
 440
 441                 Its only purpose is to avoid fruitless let-binding
 442                 and then inlining of case join points
 443
 444
 445 \begin{code}
 446 exprIsDupable :: CoreExpr -> Bool
 447 exprIsDupable (Type _)   = True
 448 exprIsDupable (Var _)    = True
 449 exprIsDupable (Lit lit)  = litIsDupable lit
 450 exprIsDupable (Note _ e) = exprIsDupable e
 451 exprIsDupable (Cast e _) = exprIsDupable e
 452 exprIsDupable expr
 453   = go expr 0
 454   where
 455     go (Var _)   _      = True
 456     go (App f a) n_args =  n_args < dupAppSize
 457                         && exprIsDupable a
 458                         && go f (n_args+1)
 459     go _         _      = False
 460
 461 dupAppSize :: Int
 462 dupAppSize = 4          -- Size of application we are prepared to duplicate
 463 \end{code}
 464
 465 %************************************************************************
 466 %*                                                                      *
 467              exprIsCheap, exprIsExpandable
 468 %*                                                                      *
 469 %************************************************************************
 470
 471 Note [exprIsCheap]
 472 ~~~~~~~~~~~~~~~~~~
 473 @exprIsCheap@ looks at a Core expression and returns \tr{True} if
 474 it is obviously in weak head normal form, or is cheap to get to WHNF.
 475 [Note that that's not the same as exprIsDupable; an expression might be
 476 big, and hence not dupable, but still cheap.]
 477
 478 By ``cheap'' we mean a computation we're willing to:
 479         push inside a lambda, or
 480         inline at more than one place
 481 That might mean it gets evaluated more than once, instead of being
 482 shared.  The main examples of things which aren't WHNF but are
 483 ``cheap'' are:
 484
 485   *     case e of
 486           pi -> ei
 487         (where e, and all the ei are cheap)
 488
 489   *     let x = e in b
 490         (where e and b are cheap)
 491
 492   *     op x1 ... xn
 493         (where op is a cheap primitive operator)
 494
 495   *     error "foo"
 496         (because we are happy to substitute it inside a lambda)
 497
 498 Notice that a variable is considered 'cheap': we can push it inside a lambda,
 499 because sharing will make sure it is only evaluated once.
 500
 501 \begin{code}
 502 exprIsCheap' :: (Id -> Bool) -> CoreExpr -> Bool
 503 exprIsCheap' _          (Lit _)           = True
 504 exprIsCheap' _          (Type _)          = True
 505 exprIsCheap' _          (Var _)           = True
 506 exprIsCheap' is_conlike (Note _ e)        = exprIsCheap' is_conlike e
 507 exprIsCheap' is_conlike (Cast e _)        = exprIsCheap' is_conlike e
 508 exprIsCheap' is_conlike (Lam x e)         = isRuntimeVar x
 509                                             || exprIsCheap' is_conlike e
 510 exprIsCheap' is_conlike (Case e _ _ alts) = exprIsCheap' is_conlike e &&
 511                                 and [exprIsCheap' is_conlike rhs | (_,_,rhs) <- alts]
 512         -- Experimentally, treat (case x of ...) as cheap
 513         -- (and case __coerce x etc.)
 514         -- This improves arities of overloaded functions where
 515         -- there is only dictionary selection (no construction) involved
 516 exprIsCheap' is_conlike (Let (NonRec x _) e)
 517       | isUnLiftedType (idType x) = exprIsCheap' is_conlike e
 518       | otherwise                 = False
 519         -- strict lets always have cheap right hand sides,
 520         -- and do no allocation.
 521
 522 exprIsCheap' is_conlike other_expr      -- Applications and variables
 523   = go other_expr []
 524   where
 525         -- Accumulate value arguments, then decide
 526     go (App f a) val_args | isRuntimeArg a = go f (a:val_args)
 527                           | otherwise      = go f val_args
 528
 529     go (Var _) [] = True        -- Just a type application of a variable
 530                                 -- (f t1 t2 t3) counts as WHNF
 531     go (Var f) args
 532         = case idDetails f of
 533                 RecSelId {}  -> go_sel args
 534                 ClassOpId {} -> go_sel args
 535                 PrimOpId op  -> go_primop op args
 536
 537                 _ | is_conlike f -> go_pap args
 538                   | length args < idArity f -> go_pap args
 539
 540                 _ -> isBottomingId f
 541                         -- Application of a function which
 542                         -- always gives bottom; we treat this as cheap
 543                         -- because it certainly doesn't need to be shared!
 544
 545     go _ _ = False
 546
 547     --------------
 548     go_pap args = all exprIsTrivial args
 549         -- For constructor applications and primops, check that all
 550         -- the args are trivial.  We don't want to treat as cheap, say,
 551         --      (1:2:3:4:5:[])
 552         -- We'll put up with one constructor application, but not dozens
 553
 554     --------------
 555     go_primop op args = primOpIsCheap op && all (exprIsCheap' is_conlike) args
 556         -- In principle we should worry about primops
 557         -- that return a type variable, since the result
 558         -- might be applied to something, but I'm not going
 559         -- to bother to check the number of args
 560
 561     --------------
 562     go_sel [arg] = exprIsCheap' is_conlike arg  -- I'm experimenting with making record selection
 563     go_sel _     = False                -- look cheap, so we will substitute it inside a
 564                                         -- lambda.  Particularly for dictionary field selection.
 565                 -- BUT: Take care with (sel d x)!  The (sel d) might be cheap, but
 566                 --      there's no guarantee that (sel d x) will be too.  Hence (n_val_args == 1)
 567
 568 exprIsCheap :: CoreExpr -> Bool
 569 exprIsCheap = exprIsCheap' isDataConWorkId
 570
 571 exprIsExpandable :: CoreExpr -> Bool
 572 exprIsExpandable = exprIsCheap' isConLikeId     -- See Note [CONLIKE pragma] in BasicTypes
 573 \end{code}
 574
 575 %************************************************************************
 576 %*                                                                      *
 577              exprOkForSpeculation
 578 %*                                                                      *
 579 %************************************************************************
 580
 581 \begin{code}
 582 -- | 'exprOkForSpeculation' returns True of an expression that is:
 583 --
 584 --  * Safe to evaluate even if normal order eval might not
 585 --    evaluate the expression at all, or
 586 --
 587 --  * Safe /not/ to evaluate even if normal order would do so
 588 --
 589 -- Precisely, it returns @True@ iff:
 590 --
 591 --  * The expression guarantees to terminate,
 592 --
 593 --  * soon,
 594 --
 595 --  * without raising an exception,
 596 --
 597 --  * without causing a side effect (e.g. writing a mutable variable)
 598 --
 599 -- Note that if @exprIsHNF e@, then @exprOkForSpecuation e@.
 600 -- As an example of the considerations in this test, consider:
 601 --
 602 -- > let x = case y# +# 1# of { r# -> I# r# }
 603 -- > in E
 604 --
 605 -- being translated to:
 606 --
 607 -- > case y# +# 1# of { r# ->
 608 -- >    let x = I# r#
 609 -- >    in E
 610 -- > }
 611 --
 612 -- We can only do this if the @y + 1@ is ok for speculation: it has no
 613 -- side effects, and can't diverge or raise an exception.
 614 exprOkForSpeculation :: CoreExpr -> Bool
 615 exprOkForSpeculation (Lit _)     = True
 616 exprOkForSpeculation (Type _)    = True
 617     -- Tick boxes are *not* suitable for speculation
 618 exprOkForSpeculation (Var v)     = isUnLiftedType (idType v)
 619                                  && not (isTickBoxOp v)
 620 exprOkForSpeculation (Note _ e)  = exprOkForSpeculation e
 621 exprOkForSpeculation (Cast e _)  = exprOkForSpeculation e
 622 exprOkForSpeculation other_expr
 623   = case collectArgs other_expr of
 624         (Var f, args) -> spec_ok (idDetails f) args
 625         _             -> False
 626
 627   where
 628     spec_ok (DataConWorkId _) _
 629       = True    -- The strictness of the constructor has already
 630                 -- been expressed by its "wrapper", so we don't need
 631                 -- to take the arguments into account
 632
 633     spec_ok (PrimOpId op) args
 634       | isDivOp op,             -- Special case for dividing operations that fail
 635         [arg1, Lit lit] <- args -- only if the divisor is zero
 636       = not (isZeroLit lit) && exprOkForSpeculation arg1
 637                 -- Often there is a literal divisor, and this
 638                 -- can get rid of a thunk in an inner looop
 639
 640       | otherwise
 641       = primOpOkForSpeculation op &&
 642         all exprOkForSpeculation args
 643                                 -- A bit conservative: we don't really need
 644                                 -- to care about lazy arguments, but this is easy
 645
 646     spec_ok (DFunId new_type) _ = not new_type
 647          -- DFuns terminate, unless the dict is implemented with a newtype
 648          -- in which case they may not
 649
 650     spec_ok _ _ = False
 651
 652 -- | True of dyadic operators that can fail only if the second arg is zero!
 653 isDivOp :: PrimOp -> Bool
 654 -- This function probably belongs in PrimOp, or even in
 655 -- an automagically generated file.. but it's such a
 656 -- special case I thought I'd leave it here for now.
 657 isDivOp IntQuotOp        = True
 658 isDivOp IntRemOp         = True
 659 isDivOp WordQuotOp       = True
 660 isDivOp WordRemOp        = True
 661 isDivOp FloatDivOp       = True
 662 isDivOp DoubleDivOp      = True
 663 isDivOp _                = False
 664 \end{code}
 665
 666 %************************************************************************
 667 %*                                                                      *
 668              exprIsHNF, exprIsConLike
 669 %*                                                                      *
 670 %************************************************************************
 671
 672 \begin{code}
 673 -- Note [exprIsHNF]
 674 -- ~~~~~~~~~~~~~~~~
 675 -- | exprIsHNF returns true for expressions that are certainly /already/
 676 -- evaluated to /head/ normal form.  This is used to decide whether it's ok
 677 -- to change:
 678 --
 679 -- > case x of _ -> e
 680 --
 681 --    into:
 682 --
 683 -- > e
 684 --
 685 -- and to decide whether it's safe to discard a 'seq'.
 686 --
 687 -- So, it does /not/ treat variables as evaluated, unless they say they are.
 688 -- However, it /does/ treat partial applications and constructor applications
 689 -- as values, even if their arguments are non-trivial, provided the argument
 690 -- type is lifted. For example, both of these are values:
 691 --
 692 -- > (:) (f x) (map f xs)
 693 -- > map (...redex...)
 694 --
 695 -- because 'seq' on such things completes immediately.
 696 --
 697 -- For unlifted argument types, we have to be careful:
 698 --
 699 -- > C (f x :: Int#)
 700 --
 701 -- Suppose @f x@ diverges; then @C (f x)@ is not a value. However this can't
 702 -- happen: see "CoreSyn#let_app_invariant". This invariant states that arguments of
 703 -- unboxed type must be ok-for-speculation (or trivial).
 704 exprIsHNF :: CoreExpr -> Bool           -- True => Value-lambda, constructor, PAP
 705 exprIsHNF = exprIsHNFlike isDataConWorkId isEvaldUnfolding
 706 \end{code}
 707
 708 \begin{code}
 709 -- | Similar to 'exprIsHNF' but includes CONLIKE functions as well as
 710 -- data constructors. Conlike arguments are considered interesting by the
 711 -- inliner.
 712 exprIsConLike :: CoreExpr -> Bool       -- True => lambda, conlike, PAP
 713 exprIsConLike = exprIsHNFlike isConLikeId isConLikeUnfolding
 714
 715 -- | Returns true for values or value-like expressions. These are lambdas,
 716 -- constructors / CONLIKE functions (as determined by the function argument)
 717 -- or PAPs.
 718 --
 719 exprIsHNFlike :: (Var -> Bool) -> (Unfolding -> Bool) -> CoreExpr -> Bool
 720 exprIsHNFlike is_con is_con_unf = is_hnf_like
 721   where
 722     is_hnf_like (Var v) -- NB: There are no value args at this point
 723       =  is_con v       -- Catches nullary constructors,
 724                         --      so that [] and () are values, for example
 725       || idArity v > 0  -- Catches (e.g.) primops that don't have unfoldings
 726       || is_con_unf (idUnfolding v)
 727         -- Check the thing's unfolding; it might be bound to a value
 728         -- A worry: what if an Id's unfolding is just itself:
 729         -- then we could get an infinite loop...
 730
 731     is_hnf_like (Lit _)          = True
 732     is_hnf_like (Type _)         = True       -- Types are honorary Values;
 733                                               -- we don't mind copying them
 734     is_hnf_like (Lam b e)        = isRuntimeVar b || is_hnf_like e
 735     is_hnf_like (Note _ e)       = is_hnf_like e
 736     is_hnf_like (Cast e _)       = is_hnf_like e
 737     is_hnf_like (App e (Type _)) = is_hnf_like e
 738     is_hnf_like (App e a)        = app_is_value e [a]
 739     is_hnf_like _                = False
 740
 741     -- There is at least one value argument
 742     app_is_value :: CoreExpr -> [CoreArg] -> Bool
 743     app_is_value (Var fun) args
 744       = idArity fun > valArgCount args    -- Under-applied function
 745         || is_con fun                     --  or constructor-like
 746     app_is_value (Note _ f) as = app_is_value f as
 747     app_is_value (Cast f _) as = app_is_value f as
 748     app_is_value (App f a)  as = app_is_value f (a:as)
 749     app_is_value _          _  = False
 750 \end{code}
 751
 752
 753 %************************************************************************
 754 %*                                                                      *
 755              Instantiating data constructors
 756 %*                                                                      *
 757 %************************************************************************
 758
 759 These InstPat functions go here to avoid circularity between DataCon and Id
 760
 761 \begin{code}
 762 dataConRepInstPat, dataConOrigInstPat :: [Unique] -> DataCon -> [Type] -> ([TyVar], [CoVar], [Id])
 763 dataConRepFSInstPat :: [FastString] -> [Unique] -> DataCon -> [Type] -> ([TyVar], [CoVar], [Id])
 764
 765 dataConRepInstPat   = dataConInstPat dataConRepArgTys (repeat ((fsLit "ipv")))
 766 dataConRepFSInstPat = dataConInstPat dataConRepArgTys
 767 dataConOrigInstPat  = dataConInstPat dc_arg_tys       (repeat ((fsLit "ipv")))
 768   where
 769     dc_arg_tys dc = map mkPredTy (dataConEqTheta dc) ++ map mkPredTy (dataConDictTheta dc) ++ dataConOrigArgTys dc
 770         -- Remember to include the existential dictionaries
 771
 772 dataConInstPat :: (DataCon -> [Type])      -- function used to find arg tys
 773                   -> [FastString]          -- A long enough list of FSs to use for names
 774                   -> [Unique]              -- An equally long list of uniques, at least one for each binder
 775                   -> DataCon
 776                   -> [Type]                -- Types to instantiate the universally quantified tyvars
 777                -> ([TyVar], [CoVar], [Id]) -- Return instantiated variables
 778 -- dataConInstPat arg_fun fss us con inst_tys returns a triple
 779 -- (ex_tvs, co_tvs, arg_ids),
 780 --
 781 --   ex_tvs are intended to be used as binders for existential type args
 782 --
 783 --   co_tvs are intended to be used as binders for coercion args and the kinds
 784 --     of these vars have been instantiated by the inst_tys and the ex_tys
 785 --     The co_tvs include both GADT equalities (dcEqSpec) and
 786 --     programmer-specified equalities (dcEqTheta)
 787 --
 788 --   arg_ids are indended to be used as binders for value arguments,
 789 --     and their types have been instantiated with inst_tys and ex_tys
 790 --     The arg_ids include both dicts (dcDictTheta) and
 791 --     programmer-specified arguments (after rep-ing) (deRepArgTys)
 792 --
 793 -- Example.
 794 --  The following constructor T1
 795 --
 796 --  data T a where
 797 --    T1 :: forall b. Int -> b -> T(a,b)
 798 --    ...
 799 --
 800 --  has representation type
 801 --   forall a. forall a1. forall b. (a ~ (a1,b)) =>
 802 --     Int -> b -> T a
 803 --
 804 --  dataConInstPat fss us T1 (a1',b') will return
 805 --
 806 --  ([a1'', b''], [c :: (a1', b')~(a1'', b'')], [x :: Int, y :: b''])
 807 --
 808 --  where the double-primed variables are created with the FastStrings and
 809 --  Uniques given as fss and us
 810 dataConInstPat arg_fun fss uniqs con inst_tys
 811   = (ex_bndrs, co_bndrs, arg_ids)
 812   where
 813     univ_tvs = dataConUnivTyVars con
 814     ex_tvs   = dataConExTyVars con
 815     arg_tys  = arg_fun con
 816     eq_spec  = dataConEqSpec con
 817     eq_theta = dataConEqTheta con
 818     eq_preds = eqSpecPreds eq_spec ++ eq_theta
 819
 820     n_ex = length ex_tvs
 821     n_co = length eq_preds
 822
 823       -- split the Uniques and FastStrings
 824     (ex_uniqs, uniqs')   = splitAt n_ex uniqs
 825     (co_uniqs, id_uniqs) = splitAt n_co uniqs'
 826
 827     (ex_fss, fss')     = splitAt n_ex fss
 828     (co_fss, id_fss)   = splitAt n_co fss'
 829
 830       -- Make existential type variables
 831     ex_bndrs = zipWith3 mk_ex_var ex_uniqs ex_fss ex_tvs
 832     mk_ex_var uniq fs var = mkTyVar new_name kind
 833       where
 834         new_name = mkSysTvName uniq fs
 835         kind     = tyVarKind var
 836
 837       -- Make the instantiating substitution
 838     subst = zipOpenTvSubst (univ_tvs ++ ex_tvs) (inst_tys ++ map mkTyVarTy ex_bndrs)
 839
 840       -- Make new coercion vars, instantiating kind
 841     co_bndrs = zipWith3 mk_co_var co_uniqs co_fss eq_preds
 842     mk_co_var uniq fs eq_pred = mkCoVar new_name co_kind
 843        where
 844          new_name = mkSysTvName uniq fs
 845          co_kind  = substTy subst (mkPredTy eq_pred)
 846
 847       -- make value vars, instantiating types
 848     mk_id_var uniq fs ty = mkUserLocal (mkVarOccFS fs) uniq (substTy subst ty) noSrcSpan
 849     arg_ids = zipWith3 mk_id_var id_uniqs id_fss arg_tys
 850
 851 \end{code}
 852
 853 %************************************************************************
 854 %*                                                                      *
 855          Equality
 856 %*                                                                      *
 857 %************************************************************************
 858
 859 \begin{code}
 860 -- | A cheap equality test which bales out fast!
 861 --      If it returns @True@ the arguments are definitely equal,
 862 --      otherwise, they may or may not be equal.
 863 --
 864 -- See also 'exprIsBig'
 865 cheapEqExpr :: Expr b -> Expr b -> Bool
 866
 867 cheapEqExpr (Var v1)   (Var v2)   = v1==v2
 868 cheapEqExpr (Lit lit1) (Lit lit2) = lit1 == lit2
 869 cheapEqExpr (Type t1)  (Type t2)  = t1 `coreEqType` t2
 870
 871 cheapEqExpr (App f1 a1) (App f2 a2)
 872   = f1 `cheapEqExpr` f2 && a1 `cheapEqExpr` a2
 873
 874 cheapEqExpr (Cast e1 t1) (Cast e2 t2)
 875   = e1 `cheapEqExpr` e2 && t1 `coreEqCoercion` t2
 876
 877 cheapEqExpr _ _ = False
 878
 879 exprIsBig :: Expr b -> Bool
 880 -- ^ Returns @True@ of expressions that are too big to be compared by 'cheapEqExpr'
 881 exprIsBig (Lit _)      = False
 882 exprIsBig (Var _)      = False
 883 exprIsBig (Type _)     = False
 884 exprIsBig (Lam _ e)    = exprIsBig e
 885 exprIsBig (App f a)    = exprIsBig f || exprIsBig a
 886 exprIsBig (Cast e _)   = exprIsBig e    -- Hopefully coercions are not too big!
 887 exprIsBig _            = True
 888 \end{code}
 889
 890
 891
 892 %************************************************************************
 893 %*                                                                      *
 894 \subsection{The size of an expression}
 895 %*                                                                      *
 896 %************************************************************************
 897
 898 \begin{code}
 899 coreBindsSize :: [CoreBind] -> Int
 900 coreBindsSize bs = foldr ((+) . bindSize) 0 bs
 901
 902 exprSize :: CoreExpr -> Int
 903 -- ^ A measure of the size of the expressions, strictly greater than 0
 904 -- It also forces the expression pretty drastically as a side effect
 905 exprSize (Var v)         = v `seq` 1
 906 exprSize (Lit lit)       = lit `seq` 1
 907 exprSize (App f a)       = exprSize f + exprSize a
 908 exprSize (Lam b e)       = varSize b + exprSize e
 909 exprSize (Let b e)       = bindSize b + exprSize e
 910 exprSize (Case e b t as) = seqType t `seq` exprSize e + varSize b + 1 + foldr ((+) . altSize) 0 as
 911 exprSize (Cast e co)     = (seqType co `seq` 1) + exprSize e
 912 exprSize (Note n e)      = noteSize n + exprSize e
 913 exprSize (Type t)        = seqType t `seq` 1
 914
 915 noteSize :: Note -> Int
 916 noteSize (SCC cc)       = cc `seq` 1
 917 noteSize (CoreNote s)   = s `seq` 1  -- hdaume: core annotations
 918
 919 varSize :: Var -> Int
 920 varSize b  | isTyVar b = 1
 921            | otherwise = seqType (idType b)             `seq`
 922                          megaSeqIdInfo (idInfo b)       `seq`
 923                          1
 924
 925 varsSize :: [Var] -> Int
 926 varsSize = sum . map varSize
 927
 928 bindSize :: CoreBind -> Int
 929 bindSize (NonRec b e) = varSize b + exprSize e
 930 bindSize (Rec prs)    = foldr ((+) . pairSize) 0 prs
 931
 932 pairSize :: (Var, CoreExpr) -> Int
 933 pairSize (b,e) = varSize b + exprSize e
 934
 935 altSize :: CoreAlt -> Int
 936 altSize (c,bs,e) = c `seq` varsSize bs + exprSize e
 937 \end{code}
 938
 939
 940 %************************************************************************
 941 %*                                                                      *
 942 \subsection{Hashing}
 943 %*                                                                      *
 944 %************************************************************************
 945
 946 \begin{code}
 947 hashExpr :: CoreExpr -> Int
 948 -- ^ Two expressions that hash to the same @Int@ may be equal (but may not be)
 949 -- Two expressions that hash to the different Ints are definitely unequal.
 950 --
 951 -- The emphasis is on a crude, fast hash, rather than on high precision.
 952 --
 953 -- But unequal here means \"not identical\"; two alpha-equivalent
 954 -- expressions may hash to the different Ints.
 955 --
 956 -- We must be careful that @\\x.x@ and @\\y.y@ map to the same hash code,
 957 -- (at least if we want the above invariant to be true).
 958
 959 hashExpr e = fromIntegral (hash_expr (1,emptyVarEnv) e .&. 0x7fffffff)
 960              -- UniqFM doesn't like negative Ints
 961
 962 type HashEnv = (Int, VarEnv Int)  -- Hash code for bound variables
 963
 964 hash_expr :: HashEnv -> CoreExpr -> Word32
 965 -- Word32, because we're expecting overflows here, and overflowing
 966 -- signed types just isn't cool.  In C it's even undefined.
 967 hash_expr env (Note _ e)              = hash_expr env e
 968 hash_expr env (Cast e _)              = hash_expr env e
 969 hash_expr env (Var v)                 = hashVar env v
 970 hash_expr _   (Lit lit)               = fromIntegral (hashLiteral lit)
 971 hash_expr env (App f e)               = hash_expr env f * fast_hash_expr env e
 972 hash_expr env (Let (NonRec b r) e)    = hash_expr (extend_env env b) e * fast_hash_expr env r
 973 hash_expr env (Let (Rec ((b,_):_)) e) = hash_expr (extend_env env b) e
 974 hash_expr env (Case e _ _ _)          = hash_expr env e
 975 hash_expr env (Lam b e)               = hash_expr (extend_env env b) e
 976 hash_expr _   (Type _)                = WARN(True, text "hash_expr: type") 1
 977 -- Shouldn't happen.  Better to use WARN than trace, because trace
 978 -- prevents the CPR optimisation kicking in for hash_expr.
 979
 980 fast_hash_expr :: HashEnv -> CoreExpr -> Word32
 981 fast_hash_expr env (Var v)      = hashVar env v
 982 fast_hash_expr env (Type t)     = fast_hash_type env t
 983 fast_hash_expr _   (Lit lit)    = fromIntegral (hashLiteral lit)
 984 fast_hash_expr env (Cast e _)   = fast_hash_expr env e
 985 fast_hash_expr env (Note _ e)   = fast_hash_expr env e
 986 fast_hash_expr env (App _ a)    = fast_hash_expr env a  -- A bit idiosyncratic ('a' not 'f')!
 987 fast_hash_expr _   _            = 1
 988
 989 fast_hash_type :: HashEnv -> Type -> Word32
 990 fast_hash_type env ty
 991   | Just tv <- getTyVar_maybe ty            = hashVar env tv
 992   | Just (tc,tys) <- splitTyConApp_maybe ty = let hash_tc = fromIntegral (hashName (tyConName tc))
 993                                               in foldr (\t n -> fast_hash_type env t + n) hash_tc tys
 994   | otherwise                               = 1
 995
 996 extend_env :: HashEnv -> Var -> (Int, VarEnv Int)
 997 extend_env (n,env) b = (n+1, extendVarEnv env b n)
 998
 999 hashVar :: HashEnv -> Var -> Word32
1000 hashVar (_,env) v
1001  = fromIntegral (lookupVarEnv env v `orElse` hashName (idName v))
1002 \end{code}
1003
1004 %************************************************************************
1005 %*                                                                      *
1006 \subsection{Determining non-updatable right-hand-sides}
1007 %*                                                                      *
1008 %************************************************************************
1009
1010 Top-level constructor applications can usually be allocated
1011 statically, but they can't if the constructor, or any of the
1012 arguments, come from another DLL (because we can't refer to static
1013 labels in other DLLs).
1014
1015 If this happens we simply make the RHS into an updatable thunk,
1016 and 'execute' it rather than allocating it statically.
1017
1018 \begin{code}
1019 -- | This function is called only on *top-level* right-hand sides.
1020 -- Returns @True@ if the RHS can be allocated statically in the output,
1021 -- with no thunks involved at all.
1022 rhsIsStatic :: PackageId -> CoreExpr -> Bool
1023 -- It's called (i) in TidyPgm.hasCafRefs to decide if the rhs is, or
1024 -- refers to, CAFs; (ii) in CoreToStg to decide whether to put an
1025 -- update flag on it and (iii) in DsExpr to decide how to expand
1026 -- list literals
1027 --
1028 -- The basic idea is that rhsIsStatic returns True only if the RHS is
1029 --      (a) a value lambda
1030 --      (b) a saturated constructor application with static args
1031 --
1032 -- BUT watch out for
1033 --  (i) Any cross-DLL references kill static-ness completely
1034 --      because they must be 'executed' not statically allocated
1035 --      ("DLL" here really only refers to Windows DLLs, on other platforms,
1036 --      this is not necessary)
1037 --
1038 -- (ii) We treat partial applications as redexes, because in fact we
1039 --      make a thunk for them that runs and builds a PAP
1040 --      at run-time.  The only appliations that are treated as
1041 --      static are *saturated* applications of constructors.
1042
1043 -- We used to try to be clever with nested structures like this:
1044 --              ys = (:) w ((:) w [])
1045 -- on the grounds that CorePrep will flatten ANF-ise it later.
1046 -- But supporting this special case made the function much more
1047 -- complicated, because the special case only applies if there are no
1048 -- enclosing type lambdas:
1049 --              ys = /\ a -> Foo (Baz ([] a))
1050 -- Here the nested (Baz []) won't float out to top level in CorePrep.
1051 --
1052 -- But in fact, even without -O, nested structures at top level are
1053 -- flattened by the simplifier, so we don't need to be super-clever here.
1054 --
1055 -- Examples
1056 --
1057 --      f = \x::Int. x+7        TRUE
1058 --      p = (True,False)        TRUE
1059 --
1060 --      d = (fst p, False)      FALSE because there's a redex inside
1061 --                              (this particular one doesn't happen but...)
1062 --
1063 --      h = D# (1.0## /## 2.0##)        FALSE (redex again)
1064 --      n = /\a. Nil a                  TRUE
1065 --
1066 --      t = /\a. (:) (case w a of ...) (Nil a)  FALSE (redex)
1067 --
1068 --
1069 -- This is a bit like CoreUtils.exprIsHNF, with the following differences:
1070 --    a) scc "foo" (\x -> ...) is updatable (so we catch the right SCC)
1071 --
1072 --    b) (C x xs), where C is a contructor is updatable if the application is
1073 --         dynamic
1074 --
1075 --    c) don't look through unfolding of f in (f x).
1076
1077 rhsIsStatic _this_pkg rhs = is_static False rhs
1078   where
1079   is_static :: Bool     -- True <=> in a constructor argument; must be atomic
1080           -> CoreExpr -> Bool
1081
1082   is_static False (Lam b e) = isRuntimeVar b || is_static False e
1083
1084   is_static _      (Note (SCC _) _) = False
1085   is_static in_arg (Note _ e)       = is_static in_arg e
1086   is_static in_arg (Cast e _)       = is_static in_arg e
1087
1088   is_static _      (Lit lit)
1089     = case lit of
1090         MachLabel _ _ _ -> False
1091         _             -> True
1092         -- A MachLabel (foreign import "&foo") in an argument
1093         -- prevents a constructor application from being static.  The
1094         -- reason is that it might give rise to unresolvable symbols
1095         -- in the object file: under Linux, references to "weak"
1096         -- symbols from the data segment give rise to "unresolvable
1097         -- relocation" errors at link time This might be due to a bug
1098         -- in the linker, but we'll work around it here anyway.
1099         -- SDM 24/2/2004
1100
1101   is_static in_arg other_expr = go other_expr 0
1102    where
1103     go (Var f) n_val_args
1104 #if mingw32_TARGET_OS
1105         | not (isDllName _this_pkg (idName f))
1106 #endif
1107         =  saturated_data_con f n_val_args
1108         || (in_arg && n_val_args == 0)
1109                 -- A naked un-applied variable is *not* deemed a static RHS
1110                 -- E.g.         f = g
1111                 -- Reason: better to update so that the indirection gets shorted
1112                 --         out, and the true value will be seen
1113                 -- NB: if you change this, you'll break the invariant that THUNK_STATICs
1114                 --     are always updatable.  If you do so, make sure that non-updatable
1115                 --     ones have enough space for their static link field!
1116
1117     go (App f a) n_val_args
1118         | isTypeArg a                    = go f n_val_args
1119         | not in_arg && is_static True a = go f (n_val_args + 1)
1120         -- The (not in_arg) checks that we aren't in a constructor argument;
1121         -- if we are, we don't allow (value) applications of any sort
1122         --
1123         -- NB. In case you wonder, args are sometimes not atomic.  eg.
1124         --   x = D# (1.0## /## 2.0##)
1125         -- can't float because /## can fail.
1126
1127     go (Note (SCC _) _) _          = False
1128     go (Note _ f)       n_val_args = go f n_val_args
1129     go (Cast e _)       n_val_args = go e n_val_args
1130
1131     go _                _          = False
1132
1133     saturated_data_con f n_val_args
1134         = case isDataConWorkId_maybe f of
1135             Just dc -> n_val_args == dataConRepArity dc
1136             Nothing -> False
1137 \end{code}