[project @ 1999-06-08 16:46:44 by simonpj]
[ghc-hetmet.git] / ghc / compiler / coreSyn / CoreUtils.lhs
index 838a61f..49bbf15 100644 (file)
@@ -1,60 +1,50 @@
 %
-% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996
+% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 \section[CoreUtils]{Utility functions on @Core@ syntax}
 
 \begin{code}
 module CoreUtils (
-       coreExprType, coreAltsType, coreExprCc,
-
-       mkCoreIfThenElse,
-       argToExpr,
-       unTagBinders, unTagBindersAlts,
-       
-       maybeErrorApp,
-       nonErrorRHSs,
-       squashableDictishCcExpr
+       coreExprType, coreAltsType,
+
+       exprIsBottom, exprIsDupable, exprIsTrivial, exprIsWHNF, exprIsCheap, exprIsValue,
+       exprOkForSpeculation,
+       FormSummary(..), mkFormSummary, whnfOrBottom, exprArity,
+       cheapEqExpr, eqExpr, applyTypeToArgs
     ) where
 
 #include "HsVersions.h"
 
-import CoreSyn
 
-import CostCentre      ( isDictCC, CostCentre, noCostCentre )
-import MkId            ( mkSysLocal )
-import Id              ( idType, isBottomingId,
-                         mkIdWithNewUniq,
-                         dataConRepType,
-                         addOneToIdEnv, growIdEnvList, lookupIdEnv,
-                         isNullIdEnv, IdEnv, Id
-                       )
-import Literal         ( literalType, Literal(..) )
-import Maybes          ( catMaybes, maybeToBool )
-import PprCore
-import PrimOp          ( primOpType, PrimOp(..) )
-import SrcLoc          ( noSrcLoc )
-import TyVar           ( cloneTyVar,
-                         isEmptyTyVarEnv, addToTyVarEnv, TyVarEnv,
-                         TyVar, GenTyVar
+import CoreSyn
+import PprCore         ( pprCoreExpr )
+import Var             ( IdOrTyVar, isId, isTyVar )
+import VarSet
+import VarEnv
+import Name            ( isLocallyDefined )
+import Const           ( Con, isWHNFCon, conIsTrivial, conIsCheap, conIsDupable,
+                         conType, conOkForSpeculation, conStrictness
                        )
-import Type            ( mkFunTy, mkForAllTy, mkTyVarTy,
-                         splitFunTy_maybe, applyTys, isUnpointedType,
-                         splitSigmaTy, splitFunTys, instantiateTy,
-                         Type
+import Id              ( Id, idType, setIdType, idUnique, idAppIsBottom,
+                         getIdArity,
+                         getIdSpecialisation, setIdSpecialisation,
+                         getInlinePragma, setInlinePragma,
+                         getIdUnfolding, setIdUnfolding, idInfo
                        )
-import TysWiredIn      ( trueDataCon, falseDataCon )
-import Unique          ( Unique )
-import BasicTypes      ( Unused )
-import UniqSupply      ( returnUs, thenUs,
-                         mapUs, mapAndUnzipUs, getUnique,
-                         UniqSM, UniqSupply
+import IdInfo          ( arityLowerBound, InlinePragInfo(..), lbvarInfo, LBVarInfo(..) )
+import Type            ( Type, mkFunTy, mkForAllTy,
+                         splitFunTy_maybe, tyVarsOfType, tyVarsOfTypes,
+                          isNotUsgTy, mkUsgTy, unUsgTy, UsageAnn(..),
+                         tidyTyVar, applyTys, isUnLiftedType
                        )
-import Util            ( zipEqual )
+import Demand          ( isPrim, isLazy )
+import Unique          ( buildIdKey, augmentIdKey )
+import Util            ( zipWithEqual, mapAccumL )
 import Outputable
-
-type TypeEnv = TyVarEnv Type
+import TysPrim         ( alphaTy )     -- Debugging only
 \end{code}
 
+
 %************************************************************************
 %*                                                                     *
 \subsection{Find the type of a Core atom/expression}
@@ -64,350 +54,412 @@ type TypeEnv = TyVarEnv Type
 \begin{code}
 coreExprType :: CoreExpr -> Type
 
-coreExprType (Var var) = idType   var
-coreExprType (Lit lit) = literalType lit
-
-coreExprType (Let _ body)      = coreExprType body
-coreExprType (Case _ alts)     = coreAltsType alts
-
+coreExprType (Var var)             = idType var
+coreExprType (Let _ body)          = coreExprType body
+coreExprType (Case _ _ alts)        = coreAltsType alts
 coreExprType (Note (Coerce ty _) e) = ty
+coreExprType (Note (TermUsg u) e)   = mkUsgTy u (unUsgTy (coreExprType e))
 coreExprType (Note other_note e)    = coreExprType e
+coreExprType e@(Con con args)       = applyTypeToArgs e (conType con) args
 
--- a Con is a fully-saturated application of a data constructor
--- a Prim is <ditto> of a PrimOp
+coreExprType (Lam binder expr)
+  | isId binder    = (case (lbvarInfo . idInfo) binder of
+                       IsOneShotLambda -> mkUsgTy UsOnce
+                       otherwise       -> id) $
+                     idType binder `mkFunTy` coreExprType expr
+  | isTyVar binder = mkForAllTy binder (coreExprType expr)
 
-coreExprType (Con con args) = 
---                           pprTrace "appTyArgs" (hsep [ppr con, semi, 
---                                                        ppr con_ty, semi,
---                                                        ppr args]) $
-                             applyTypeToArgs con_ty args
-                           where
-                               con_ty = dataConRepType con
+coreExprType e@(App _ _)
+  = case collectArgs e of
+       (fun, args) -> applyTypeToArgs e (coreExprType fun) args
 
-coreExprType (Prim op args) = applyTypeToArgs (primOpType op) args
+coreExprType other = pprTrace "coreExprType" (pprCoreExpr other) alphaTy
 
-coreExprType (Lam (ValBinder binder) expr)
-  = idType binder `mkFunTy` coreExprType expr
-
-coreExprType (Lam (TyBinder tyvar) expr)
-  = mkForAllTy tyvar (coreExprType expr)
-
-coreExprType (App expr (TyArg ty))
-  =    -- Gather type args; more efficient to instantiate the type all at once
-    go expr [ty]
-  where
-    go (App expr (TyArg ty)) tys = go expr (ty:tys)
-    go expr                 tys = applyTys (coreExprType expr) tys
-
-coreExprType (App expr val_arg)
-  = ASSERT(isValArg val_arg)
-    let
-       fun_ty = coreExprType expr
-    in
-    case (splitFunTy_maybe fun_ty) of
-         Just (_, result_ty) -> result_ty
-#ifdef DEBUG
-         Nothing -> pprPanic "coreExprType:\n"
-                       (vcat [ppr fun_ty,  ppr (App expr val_arg)])
-#endif
+coreAltsType :: [CoreAlt] -> Type
+coreAltsType ((_,_,rhs) : _) = coreExprType rhs
 \end{code}
 
 \begin{code}
-coreAltsType :: CoreCaseAlts -> Type
-
-coreAltsType (AlgAlts [] deflt)         = default_ty deflt
-coreAltsType (AlgAlts ((_,_,rhs1):_) _) = coreExprType rhs1
-
-coreAltsType (PrimAlts [] deflt)       = default_ty deflt
-coreAltsType (PrimAlts ((_,rhs1):_) _) = coreExprType rhs1
-
-default_ty NoDefault           = panic "coreExprType:Case:default_ty"
-default_ty (BindDefault _ rhs) = coreExprType rhs
-\end{code}
+-- The first argument is just for debugging
+applyTypeToArgs :: CoreExpr -> Type -> [CoreExpr] -> Type
+applyTypeToArgs e op_ty [] = op_ty
 
-\begin{code}
-applyTypeToArgs op_ty (TyArg ty : args)
+applyTypeToArgs e op_ty (Type ty : args)
   =    -- Accumulate type arguments so we can instantiate all at once
-    applyTypeToArgs (applyTys op_ty tys) rest_args
+    ASSERT2( all isNotUsgTy tys, ppr e <+> text "of" <+> ppr op_ty <+> text "to" <+> ppr (Type ty : args) <+> text "i.e." <+> ppr tys )
+    applyTypeToArgs e (applyTys op_ty tys) rest_args
   where
-    (tys, rest_args)         = go [ty] args
-    go tys (TyArg ty : args) = go (ty:tys) args
-    go tys rest_args        = (reverse tys, rest_args)
+    (tys, rest_args)        = go [ty] args
+    go tys (Type ty : args) = go (ty:tys) args
+    go tys rest_args       = (reverse tys, rest_args)
 
-applyTypeToArgs op_ty (val_or_lit_arg:args)
+applyTypeToArgs e op_ty (other_arg : args)
   = case (splitFunTy_maybe op_ty) of
-       Just (_, res_ty) -> applyTypeToArgs res_ty args
-
-applyTypeToArgs op_ty [] = op_ty
+       Just (_, res_ty) -> applyTypeToArgs e res_ty args
+       Nothing -> pprPanic "applyTypeToArgs" (pprCoreExpr e)
 \end{code}
 
-coreExprCc gets the cost centre enclosing an expression, if any.
-It looks inside lambdas because (scc "foo" \x.e) = \x.scc "foo" e
-
-\begin{code}
-coreExprCc :: GenCoreExpr val_bdr val_occ flexi -> CostCentre
-coreExprCc (Note (SCC cc) e)   = cc
-coreExprCc (Note other_note e) = coreExprCc e
-coreExprCc (Lam _ e)           = coreExprCc e
-coreExprCc other               = noCostCentre
-\end{code}
 
 %************************************************************************
 %*                                                                     *
-\subsection{Routines to manufacture bits of @CoreExpr@}
+\subsection{Figuring out things about expressions}
 %*                                                                     *
 %************************************************************************
 
 \begin{code}
-mkCoreIfThenElse (Var bool) then_expr else_expr
-    | bool == trueDataCon   = then_expr
-    | bool == falseDataCon  = else_expr
-
-mkCoreIfThenElse guard then_expr else_expr
-  = Case guard
-      (AlgAlts [ (trueDataCon,  [], then_expr),
-                (falseDataCon, [], else_expr) ]
-       NoDefault )
+data FormSummary
+  = VarForm            -- Expression is a variable (or scc var, etc)
+
+  | ValueForm          -- Expression is a value: i.e. a value-lambda,constructor, or literal
+                       --      May 1999: I'm experimenting with allowing "cheap" non-values
+                       --      here.
+
+  | BottomForm         -- Expression is guaranteed to be bottom. We're more gung
+                       -- ho about inlining such things, because it can't waste work
+  | OtherForm          -- Anything else
+
+instance Outputable FormSummary where
+   ppr VarForm    = ptext SLIT("Var")
+   ppr ValueForm  = ptext SLIT("Value")
+   ppr BottomForm = ptext SLIT("Bot")
+   ppr OtherForm  = ptext SLIT("Other")
+
+whnfOrBottom :: FormSummary -> Bool
+whnfOrBottom VarForm    = True
+whnfOrBottom ValueForm  = True
+whnfOrBottom BottomForm = True
+whnfOrBottom OtherForm  = False
 \end{code}
 
-For making @Apps@ and @Lets@, we must take appropriate evasive
-action if the thing being bound has unboxed type.  @mkCoApp@ requires
-a name supply to do its work.
+\begin{code}
+mkFormSummary :: CoreExpr -> FormSummary
+       -- Used exclusively by CoreUnfold.mkUnfolding
+       -- Returns ValueForm for cheap things, not just values
+mkFormSummary expr
+  = go (0::Int) expr   -- The "n" is the number of *value* arguments so far
+  where
+    go n (Con con _) | isWHNFCon con = ValueForm
+                    | otherwise     = OtherForm
 
-@mkCoApps@, @mkCoCon@ and @mkCoPrim@ also handle the
-arguments-must-be-atoms constraint.
+    go n (Note _ e)         = go n e
 
-\begin{code}
-data CoreArgOrExpr
-  = AnArg   CoreArg
-  | AnExpr  CoreExpr
+    go n (Let (NonRec b r) e) | exprIsCheap r = go n e -- let f = f' alpha in (f,g) 
+                                                       -- should be treated as a value
+    go n (Let _            e)                = OtherForm
 
-mkCoApps :: CoreExpr -> [CoreArgOrExpr] -> UniqSM CoreExpr
-mkCoCon  :: Id       -> [CoreArgOrExpr] -> UniqSM CoreExpr
-mkCoPrim :: PrimOp   -> [CoreArgOrExpr] -> UniqSM CoreExpr
+       -- We want selectors to look like values
+       -- e.g.  case x of { (a,b) -> a }
+       -- should give a ValueForm, so that it will be inlined vigorously
+       -- [June 99. I can't remember why this is a good idea.  It means that
+       -- all overloading selectors get inlined at their usage sites, which is
+       -- not at all necessarily a good thing.  So I'm rescinding this decision for now.]
+--    go n expr@(Case _ _ _) | exprIsCheap expr = ValueForm
 
-mkCoApps fun args = co_thing (mkGenApp fun) args
-mkCoCon  con args = co_thing (Con  con)     args
-mkCoPrim  op args = co_thing (Prim op)      args 
+    go n expr@(Case _ _ _)  = OtherForm
 
-co_thing :: ([CoreArg] -> CoreExpr)
-        -> [CoreArgOrExpr]
-        -> UniqSM CoreExpr
+    go 0 (Lam x e) | isId x    = ValueForm     -- NB: \x.bottom /= bottom!
+                  | otherwise = go 0 e
+    go n (Lam x e) | isId x    = go (n-1) e    -- Applied lambda
+                  | otherwise = go n e
 
-co_thing thing arg_exprs
-  = mapAndUnzipUs expr_to_arg arg_exprs `thenUs` \ (args, maybe_binds) ->
-    returnUs (mkCoLetsUnboxedToCase (catMaybes maybe_binds) (thing args))
-  where
-    expr_to_arg :: CoreArgOrExpr
-               -> UniqSM (CoreArg, Maybe CoreBinding)
-
-    expr_to_arg (AnArg  arg)     = returnUs (arg,      Nothing)
-    expr_to_arg (AnExpr (Var v)) = returnUs (VarArg v, Nothing)
-    expr_to_arg (AnExpr (Lit l)) = returnUs (LitArg l, Nothing)
-    expr_to_arg (AnExpr other_expr)
-      = let
-           e_ty = coreExprType other_expr
-       in
-       getUnique `thenUs` \ uniq ->
-       let
-           new_var  = mkSysLocal SLIT("a") uniq e_ty noSrcLoc
-       in
-       returnUs (VarArg new_var, Just (NonRec new_var other_expr))
+    go n (App fun (Type _)) = go n fun         -- Ignore type args
+    go n (App fun arg)      = go (n+1) fun
+
+    go n (Var f) | idAppIsBottom f n = BottomForm
+    go 0 (Var f)                    = VarForm
+    go n (Var f) | n < arityLowerBound (getIdArity f) = ValueForm
+                | otherwise                          = OtherForm
 \end{code}
 
-\begin{code}
-argToExpr ::
-  GenCoreArg val_occ flexi -> GenCoreExpr val_bdr val_occ flexi
+@exprIsTrivial@        is true of expressions we are unconditionally 
+               happy to duplicate; simple variables and constants,
+               and type applications.
 
-argToExpr (VarArg v)   = Var v
-argToExpr (LitArg lit) = Lit lit
-\end{code}
+@exprIsBottom@ is true of expressions that are guaranteed to diverge
 
-All the following functions operate on binders, perform a uniform
-transformation on them; ie. the function @(\ x -> (x,False))@
-annotates all binders with False.
 
 \begin{code}
-unTagBinders :: GenCoreExpr (Id,tag) bdee flexi -> GenCoreExpr Id bdee flexi
-unTagBinders expr = bop_expr fst expr
-
-unTagBindersAlts :: GenCoreCaseAlts (Id,tag) bdee flexi -> GenCoreCaseAlts Id bdee flexi
-unTagBindersAlts alts = bop_alts fst alts
+exprIsTrivial (Type _)      = True
+exprIsTrivial (Var v)       = True
+exprIsTrivial (App e arg)    = isTypeArg arg && exprIsTrivial e
+exprIsTrivial (Note _ e)     = exprIsTrivial e
+exprIsTrivial (Con con args) = conIsTrivial con && all isTypeArg args
+exprIsTrivial (Lam b body)   | isTyVar b = exprIsTrivial body
+exprIsTrivial other         = False
 \end{code}
 
+
+@exprIsDupable@        is true of expressions that can be duplicated at a modest
+               cost in space.  This will only happen in different case
+               branches, so there's no issue about duplicating work.
+               Its only purpose is to avoid fruitless let-binding
+               and then inlining of case join points
+
+
 \begin{code}
-bop_expr  :: (a -> b) -> GenCoreExpr a bdee flexi -> GenCoreExpr b bdee flexi
-
-bop_expr f (Var b)          = Var b
-bop_expr f (Lit lit)        = Lit lit
-bop_expr f (Con con args)    = Con con args
-bop_expr f (Prim op args)    = Prim op args
-bop_expr f (Lam binder expr) = Lam  (bop_binder f binder) (bop_expr f expr)
-bop_expr f (App expr arg)    = App  (bop_expr f expr) arg
-bop_expr f (Note note expr)  = Note note (bop_expr f expr)
-bop_expr f (Let bind expr)   = Let  (bop_bind f bind) (bop_expr f expr)
-bop_expr f (Case expr alts)  = Case (bop_expr f expr) (bop_alts f alts)
-
-bop_binder f (ValBinder   v) = ValBinder (f v)
-bop_binder f (TyBinder    t) = TyBinder    t
-
-bop_bind f (NonRec b e)        = NonRec (f b) (bop_expr f e)
-bop_bind f (Rec pairs) = Rec [(f b, bop_expr f e) | (b, e) <- pairs]
-
-bop_alts f (AlgAlts alts deflt)
-  = AlgAlts  [ (con, [f b | b <- binders], bop_expr f e)
-            | (con, binders, e) <- alts ]
-            (bop_deflt f deflt)
-
-bop_alts f (PrimAlts alts deflt)
-  = PrimAlts [ (lit, bop_expr f e) | (lit, e) <- alts ]
-            (bop_deflt f deflt)
-
-bop_deflt f (NoDefault)                 = NoDefault
-bop_deflt f (BindDefault b expr) = BindDefault (f b) (bop_expr f expr)
+exprIsDupable (Type _)      = True
+exprIsDupable (Con con args) = conIsDupable con && 
+                              all exprIsDupable args &&
+                              valArgCount args <= dupAppSize
+
+exprIsDupable (Note _ e)     = exprIsDupable e
+exprIsDupable expr          = case collectArgs expr of  
+                                 (Var f, args) ->  valArgCount args <= dupAppSize
+                                 other         ->  False
+
+dupAppSize :: Int
+dupAppSize = 4         -- Size of application we are prepared to duplicate
 \end{code}
 
-OLD (but left here because of the nice example): @singleAlt@ checks
-whether a bunch of case alternatives is actually just one alternative.
-It specifically {\em ignores} alternatives which consist of just a
-call to @error@, because they won't result in any code duplication.
+@exprIsCheap@ looks at a Core expression and returns \tr{True} if
+it is obviously in weak head normal form, or is cheap to get to WHNF.
+[Note that that's not the same as exprIsDupable; an expression might be
+big, and hence not dupable, but still cheap.]
+By ``cheap'' we mean a computation we're willing to push inside a lambda 
+in order to bring a couple of lambdas together.  That might mean it gets
+evaluated more than once, instead of being shared.  The main examples of things
+which aren't WHNF but are ``cheap'' are:
 
-Example:
-\begin{verbatim}
-       case (case <something> of
-               True  -> <rhs>
-               False -> error "Foo") of
-       <alts>
+  *    case e of
+         pi -> ei
 
-===>
+       where e, and all the ei are cheap; and
 
-       case <something> of
-          True ->  case <rhs> of
-                   <alts>
-          False -> case error "Foo" of
-                   <alts>
+  *    let x = e
+       in b
 
-===>
+       where e and b are cheap; and
 
-       case <something> of
-          True ->  case <rhs> of
-                   <alts>
-          False -> error "Foo"
-\end{verbatim}
-Notice that the \tr{<alts>} don't get duplicated.
+  *    op x1 ... xn
 
-\begin{code}
-nonErrorRHSs :: GenCoreCaseAlts a Id Unused -> [GenCoreExpr a Id Unused]
+       where op is a cheap primitive operator
 
-nonErrorRHSs alts
-  = filter not_error_app (find_rhss alts)
-  where
-    find_rhss (AlgAlts  as deflt) = [rhs | (_,_,rhs) <- as] ++ deflt_rhs deflt
-    find_rhss (PrimAlts as deflt) = [rhs | (_,rhs)   <- as] ++ deflt_rhs deflt
+Notice that a variable is considered 'cheap': we can push it inside a lambda,
+because sharing will make sure it is only evaluated once.
 
-    deflt_rhs NoDefault           = []
-    deflt_rhs (BindDefault _ rhs) = [rhs]
+\begin{code}
+exprIsCheap :: CoreExpr -> Bool
+exprIsCheap (Type _)           = True
+exprIsCheap (Var _)            = True
+exprIsCheap (Con con args)     = conIsCheap con && all exprIsCheap args
+exprIsCheap (Note _ e)         = exprIsCheap e
+exprIsCheap (Lam x e)          = if isId x then True else exprIsCheap e
+exprIsCheap (Let bind body)    = all exprIsCheap (rhssOfBind bind) && exprIsCheap body
+exprIsCheap (Case scrut _ alts) = exprIsCheap scrut && 
+                                 all (\(_,_,rhs) -> exprIsCheap rhs) alts
+
+exprIsCheap other_expr   -- look for manifest partial application
+  = case collectArgs other_expr of
+       (f, args) -> isPap f (valArgCount args) && all exprIsCheap args
+\end{code}
 
-    not_error_app rhs
-      = case (maybeErrorApp rhs Nothing) of
-         Just _  -> False
-         Nothing -> True
+\begin{code}
+isPap :: CoreExpr              -- Function
+      -> Int                   -- Number of value args
+      -> Bool
+isPap (Var f) n_val_args 
+  =    idAppIsBottom f n_val_args 
+                               -- Application of a function which
+                               -- always gives bottom; we treat this as
+                               -- a WHNF, because it certainly doesn't
+                               -- need to be shared!
+
+    || n_val_args == 0                 -- Just a type application of
+                               -- a variable (f t1 t2 t3)
+                               -- counts as WHNF
+
+    || n_val_args < arityLowerBound (getIdArity f)
+               
+isPap fun n_val_args = False
 \end{code}
 
-maybeErrorApp checks whether an expression is of the form
+exprOkForSpeculation returns True of an UNLIFTED-TYPE expression that it is safe
+to evaluate even if normal order eval might not evaluate the expression 
+at all.  E.G.
+       let x = case y# +# 1# of { r# -> I# r# }
+       in E
+==>
+       case y# +# 1# of { r# -> 
+       let x = I# r#
+       in E 
+       }
 
-       error ty args
+We can only do this if the (y+1) is ok for speculation: it has no
+side effects, and can't diverge or raise an exception.
 
-If so, it returns
+\begin{code}
+exprOkForSpeculation :: CoreExpr -> Bool
+exprOkForSpeculation (Var v)        = True     -- Unlifted type => already evaluated
+
+exprOkForSpeculation (Note _ e)          = exprOkForSpeculation e
+exprOkForSpeculation (Let (NonRec b r) e) = isUnLiftedType (idType b) && 
+                                           exprOkForSpeculation r && 
+                                           exprOkForSpeculation e
+exprOkForSpeculation (Let (Rec _) _) = False
+exprOkForSpeculation (Case _ _ _)    = False   -- Conservative
+exprOkForSpeculation (App _ _)       = False
+
+exprOkForSpeculation (Con con args)
+  = conOkForSpeculation con &&
+    and (zipWith ok (filter isValArg args) (fst (conStrictness con)))
+  where
+    ok arg demand | isLazy demand = True
+                 | isPrim demand = exprOkForSpeculation arg
+                 | otherwise     = False
 
-       Just (error ty' args)
+exprOkForSpeculation other = panic "exprOkForSpeculation"
+       -- Lam, Type
+\end{code}
 
-where ty' is supplied as an argument to maybeErrorApp.
 
-Here's where it is useful:
+\begin{code}
+exprIsBottom :: CoreExpr -> Bool       -- True => definitely bottom
+exprIsBottom e = go 0 e
+              where
+               -- n is the number of args
+                go n (Note _ e)   = go n e
+                go n (Let _ e)    = go n e
+                go n (Case e _ _) = go 0 e     -- Just check the scrut
+                go n (App e _)    = go (n+1) e
+                go n (Var v)      = idAppIsBottom v n
+                go n (Con _ _)    = False
+                go n (Lam _ _)    = False
+\end{code}
 
-               case (error ty "Foo" e1 e2) of <alts>
- ===>
-               error ty' "Foo"
+@exprIsValue@ returns true for expressions that are evaluated.
+It does not treat variables as evaluated.
 
-where ty' is the type of any of the alternatives.  You might think
-this never occurs, but see the comments on the definition of
-@singleAlt@.
+\begin{code}
+exprIsValue :: CoreExpr -> Bool                -- True => Value-lambda, constructor, PAP
+exprIsValue (Type ty)    = True        -- Types are honorary Values; we don't mind
+                                       -- copying them
+exprIsValue (Var v)              = False
+exprIsValue (Lam b e)            = isId b || exprIsValue e
+exprIsValue (Note _ e)           = exprIsValue e
+exprIsValue (Let _ e)     = False
+exprIsValue (Case _ _ _)  = False
+exprIsValue (Con con _)   = isWHNFCon con 
+exprIsValue e@(App _ _)   = case collectArgs e of  
+                                 (Var v, args) -> fun_arity > valArgCount args
+                                               where
+                                                  fun_arity  = arityLowerBound (getIdArity v)
+                                 _             -> False
+\end{code}
 
-Note: we *avoid* the case where ty' might end up as a primitive type:
-this is very uncool (totally wrong).
+exprIsWHNF reports True for head normal forms.  Note that does not necessarily
+mean *normal* forms; constructors might have non-trivial argument expressions, for
+example.  We use a let binding for WHNFs, rather than a case binding, even if it's
+used strictly.  We try to expose WHNFs by floating lets out of the RHS of lets.
 
-NOTICE: in the example above we threw away e1 and e2, but not the
-string "Foo".  How did we know to do that?
+       We treat applications of buildId and augmentId as honorary WHNFs, 
+       because we want them to get exposed.
+       [May 99: I've disabled this because it looks jolly dangerous:
+        we'll substitute inside lambda with potential big loss of sharing.]
 
-Answer: for now anyway, we only handle the case of a function whose
-type is of form
+\begin{code}
+exprIsWHNF :: CoreExpr -> Bool -- True => Variable, value-lambda, constructor, PAP
+exprIsWHNF (Type ty)         = True    -- Types are honorary WHNFs; we don't mind
+                                       -- copying them
+exprIsWHNF (Var v)           = True
+exprIsWHNF (Lam b e)         = isId b || exprIsWHNF e
+exprIsWHNF (Note _ e)        = exprIsWHNF e
+exprIsWHNF (Let _ e)          = False
+exprIsWHNF (Case _ _ _)       = False
+exprIsWHNF (Con con _)        = isWHNFCon con 
+exprIsWHNF e@(App _ _)        = case collectArgs e of  
+                                 (Var v, args) -> n_val_args == 0
+                                               || fun_arity > n_val_args
+--  [May 99: disabled. See note above]         || v_uniq == buildIdKey
+--                                             || v_uniq == augmentIdKey
+                                               where
+                                                  n_val_args = valArgCount args
+                                                  fun_arity  = arityLowerBound (getIdArity v)
+                                                  v_uniq     = idUnique v
+
+                                 _             -> False
+\end{code}
 
-       bottomingFn :: forall a. t1 -> ... -> tn -> a
-                             ^---------------------^ NB!
+\begin{code}
+exprArity :: CoreExpr -> Int   -- How many value lambdas are at the top
+exprArity (Lam b e) | isTyVar b = exprArity e
+                   | otherwise = 1 + exprArity e
+exprArity other                        = 0
+\end{code}
 
-Furthermore, we only count a bottomingApp if the function is applied
-to more than n args.  If so, we transform:
 
-       bottomingFn ty e1 ... en en+1 ... em
-to
-       bottomingFn ty' e1 ... en
+%************************************************************************
+%*                                                                     *
+\subsection{Equality}
+%*                                                                     *
+%************************************************************************
 
-That is, we discard en+1 .. em
+@cheapEqExpr@ is a cheap equality test which bales out fast!
+       True  => definitely equal
+       False => may or may not be equal
 
 \begin{code}
-maybeErrorApp
-       :: GenCoreExpr a Id Unused      -- Expr to look at
-       -> Maybe Type                   -- Just ty => a result type *already cloned*;
-                                       -- Nothing => don't know result ty; we
-                                       -- *pretend* that the result ty won't be
-                                       -- primitive -- somebody later must
-                                       -- ensure this.
-       -> Maybe (GenCoreExpr b Id Unused)
-
-maybeErrorApp expr result_ty_maybe
-  = case (collectArgs expr) of
-      (Var fun, [ty], other_args)
-       | isBottomingId fun
-       && maybeToBool result_ty_maybe -- we *know* the result type
-                                      -- (otherwise: live a fairy-tale existence...)
-       && not (isUnpointedType result_ty) ->
-
-       case (splitSigmaTy (idType fun)) of
-         ([tyvar], [], tau_ty) ->
-             case (splitFunTys tau_ty) of { (arg_tys, res_ty) ->
-             let
-                 n_args_to_keep = length arg_tys
-                 args_to_keep   = take n_args_to_keep other_args
-             in
-             if  (res_ty == mkTyVarTy tyvar)
-              && n_args_to_keep <= length other_args
-             then
-                   -- Phew!  We're in business
-                 Just (mkGenApp (Var fun) (TyArg result_ty : args_to_keep))
-             else
-                 Nothing
-             }
-
-         other -> Nothing  -- Function type wrong shape
-      other -> Nothing
-  where
-    Just result_ty = result_ty_maybe
+cheapEqExpr :: Expr b -> Expr b -> Bool
+
+cheapEqExpr (Var v1) (Var v2) = v1==v2
+cheapEqExpr (Con con1 args1) (Con con2 args2)
+  = con1 == con2 && 
+    and (zipWithEqual "cheapEqExpr" cheapEqExpr args1 args2)
+
+cheapEqExpr (App f1 a1) (App f2 a2)
+  = f1 `cheapEqExpr` f2 && a1 `cheapEqExpr` a2
+
+cheapEqExpr (Type t1) (Type t2) = t1 == t2
+
+cheapEqExpr _ _ = False
 \end{code}
 
-\begin{code}
-squashableDictishCcExpr :: CostCentre -> GenCoreExpr a b c -> Bool
 
-squashableDictishCcExpr cc expr
-  = if not (isDictCC cc) then
-       False -- that was easy...
-    else
-       squashable expr -- note: quite like the "atomic_rhs" stuff in simplifier
+\begin{code}
+eqExpr :: CoreExpr -> CoreExpr -> Bool
+       -- Works ok at more general type, but only needed at CoreExpr
+eqExpr e1 e2
+  = eq emptyVarEnv e1 e2
   where
-    squashable (Var _)      = True
-    squashable (Con  _ _)   = True -- I think so... WDP 94/09
-    squashable (Prim _ _)   = True -- ditto
-    squashable (App f a)
-      | notValArg a        = squashable f
-    squashable other       = False
+  -- The "env" maps variables in e1 to variables in ty2
+  -- So when comparing lambdas etc, 
+  -- we in effect substitute v2 for v1 in e1 before continuing
+    eq env (Var v1) (Var v2) = case lookupVarEnv env v1 of
+                                 Just v1' -> v1' == v2
+                                 Nothing  -> v1  == v2
+
+    eq env (Con c1 es1) (Con c2 es2) = c1 == c2 && eq_list env es1 es2
+    eq env (App f1 a1)  (App f2 a2)  = eq env f1 f2 && eq env a1 a2
+    eq env (Lam v1 e1)  (Lam v2 e2)  = eq (extendVarEnv env v1 v2) e1 e2
+    eq env (Let (NonRec v1 r1) e1)
+          (Let (NonRec v2 r2) e2)   = eq env r1 r2 && eq (extendVarEnv env v1 v2) e1 e2
+    eq env (Let (Rec ps1) e1)
+          (Let (Rec ps2) e2)        = length ps1 == length ps2 &&
+                                      and (zipWith eq_rhs ps1 ps2) &&
+                                      eq env' e1 e2
+                                    where
+                                      env' = extendVarEnvList env [(v1,v2) | ((v1,_),(v2,_)) <- zip ps1 ps2]
+                                      eq_rhs (_,r1) (_,r2) = eq env' r1 r2
+    eq env (Case e1 v1 a1)
+          (Case e2 v2 a2)           = eq env e1 e2 &&
+                                      length a1 == length a2 &&
+                                      and (zipWith (eq_alt env') a1 a2)
+                                    where
+                                      env' = extendVarEnv env v1 v2
+
+    eq env (Note n1 e1) (Note n2 e2) = eq_note env n1 n2 && eq env e1 e2
+    eq env (Type t1)    (Type t2)    = t1 == t2
+    eq env e1          e2           = False
+                                        
+    eq_list env []      []       = True
+    eq_list env (e1:es1) (e2:es2) = eq env e1 e2 && eq_list env es1 es2
+    eq_list env es1      es2      = False
+    
+    eq_alt env (c1,vs1,r1) (c2,vs2,r2) = c1==c2 &&
+                                        eq (extendVarEnvList env (vs1 `zip` vs2)) r1 r2
+
+    eq_note env (SCC cc1)      (SCC cc2)      = cc1 == cc2
+    eq_note env (Coerce f1 t1) (Coerce f2 t2) = f1==f2 && t1==t2
+    eq_note env InlineCall     InlineCall     = True
+    eq_note env other1        other2         = False
 \end{code}
+