[project @ 2000-09-14 13:46:39 by simonpj]
[ghc-hetmet.git] / ghc / compiler / coreSyn / CoreUnfold.lhs
index 80f9a06..7f7f20a 100644 (file)
@@ -33,10 +33,8 @@ module CoreUnfold (
 
 import CmdLineOpts     ( opt_UF_CreationThreshold,
                          opt_UF_UseThreshold,
-                         opt_UF_ScrutConDiscount,
                          opt_UF_FunAppDiscount,
-                         opt_UF_PrimArgDiscount,
-                         opt_UF_KeenessFactor,
+                         opt_UF_KeenessFactor,
                          opt_UF_CheapOp, opt_UF_DearOp,
                          opt_UnfoldCasms, opt_PprStyle_Debug,
                          opt_D_dump_inlinings
@@ -44,24 +42,20 @@ import CmdLineOpts  ( opt_UF_CreationThreshold,
 import CoreSyn
 import PprCore         ( pprCoreExpr )
 import OccurAnal       ( occurAnalyseGlobalExpr )
-import BinderInfo      ( )
 import CoreUtils       ( exprIsValue, exprIsCheap, exprIsBottom, exprIsTrivial )
-import Id              ( Id, idType, idFlavour, idUnique, isId, idWorkerInfo,
+import Id              ( Id, idType, idFlavour, isId, idWorkerInfo,
                          idSpecialisation, idInlinePragma, idUnfolding,
                          isPrimOpId_maybe
                        )
 import VarSet
-import Name            ( isLocallyDefined )
-import Literal         ( isLitLitLit )
+import Literal         ( isLitLitLit, litIsDupable )
 import PrimOp          ( PrimOp(..), primOpIsDupable, primOpOutOfLine, ccallIsCasm )
-import IdInfo          ( ArityInfo(..), InlinePragInfo(..), OccInfo(..), IdFlavour(..), CprInfo(..), insideLam, workerExists )
-import TyCon           ( tyConFamilySize )
-import Type            ( splitAlgTyConApp_maybe, splitFunTy_maybe, isUnLiftedType )
-import Unique          ( Unique, buildIdKey, augmentIdKey )
-import Maybes          ( maybeToBool )
+import IdInfo          ( ArityInfo(..), InlinePragInfo(..), OccInfo(..), IdFlavour(..), CprInfo(..), 
+                         insideLam, workerExists, isNeverInlinePrag
+                       )
+import Type            ( splitFunTy_maybe, isUnLiftedType )
+import Unique          ( Unique, buildIdKey, augmentIdKey, hasKey )
 import Bag
-import List            ( maximumBy )
-import Util            ( isIn, lengthExceeds )
 import Outputable
 
 #if __GLASGOW_HASKELL__ >= 404
@@ -77,15 +71,18 @@ import GlaExts              ( fromInt )
 %************************************************************************
 
 \begin{code}
-mkTopUnfolding cpr_info expr = mkUnfolding True {- Top level -} cpr_info expr
+mkTopUnfolding expr = mkUnfolding True {- Top level -} expr
 
-mkUnfolding top_lvl cpr_info expr
+mkUnfolding top_lvl expr
   = CoreUnfolding (occurAnalyseGlobalExpr expr)
                  top_lvl
-                 (exprIsCheap expr)
                  (exprIsValue expr)
-                 (exprIsBottom expr)
-                 (calcUnfoldingGuidance opt_UF_CreationThreshold cpr_info expr)
+                       -- Already evaluated
+
+                 (exprIsCheap expr)
+                       -- OK to inline inside a lambda
+
+                 (calcUnfoldingGuidance opt_UF_CreationThreshold expr)
        -- Sometimes during simplification, there's a large let-bound thing     
        -- which has been substituted, and so is now dead; so 'expr' contains
        -- two copies of the thing while the occurrence-analysed expression doesn't
@@ -120,10 +117,9 @@ instance Outputable UnfoldingGuidance where
 \begin{code}
 calcUnfoldingGuidance
        :: Int                  -- bomb out if size gets bigger than this
-       -> CprInfo              -- CPR info for this RHS
        -> CoreExpr             -- expression to look at
        -> UnfoldingGuidance
-calcUnfoldingGuidance bOMB_OUT_SIZE cpr_info expr
+calcUnfoldingGuidance bOMB_OUT_SIZE expr
   = case collect_val_bndrs expr of { (inline, val_binders, body) ->
     let
        n_val_binders = length val_binders
@@ -135,16 +131,6 @@ calcUnfoldingGuidance bOMB_OUT_SIZE cpr_info expr
        --   so that INLINE things don't get inlined into entirely boring contexts,
        --   but no more.
 
--- Experimental thing commented in for now
---        max_inline_size = case cpr_info of
---                     NoCPRInfo  -> n_val_binders + 2
---                     ReturnsCPR -> n_val_binders + 1
-
-       -- However, the wrapper for a CPR'd function is particularly good to inline,
-       -- even in a boring context, because we may get to do update in place:
-       --      let x = case y of { I# y# -> I# (y# +# 1#) }
-       -- Hence the case on cpr_info
-
     in
     case (sizeExpr bOMB_OUT_SIZE val_binders body) of
 
@@ -207,7 +193,8 @@ sizeExpr (I# bOMB_OUT_SIZE) top_args expr
     size_up (App fun (Type t))  = size_up fun
     size_up (App fun arg)     = size_up_app fun [arg]
 
-    size_up (Lit lit) = sizeOne
+    size_up (Lit lit) | litIsDupable lit = sizeOne
+                     | otherwise        = sizeN opt_UF_DearOp  -- For lack of anything better
 
     size_up (Lam b e) | isId b    = lamScrutDiscount (size_up e `addSizeN` 1)
                      | otherwise = size_up e
@@ -226,41 +213,52 @@ sizeExpr (I# bOMB_OUT_SIZE) top_args expr
       where
        rhs_size = foldr (addSize . size_up . snd) sizeZero pairs
 
-       -- We want to make wrapper-style evaluation look cheap, so that
-       -- when we inline a wrapper it doesn't make call site (much) bigger
-       -- Otherwise we get nasty phase ordering stuff: 
-       --      f x = g x x
-       --      h y = ...(f e)...
-       -- If we inline g's wrapper, f looks big, and doesn't get inlined
-       -- into h; if we inline f first, while it looks small, then g's 
-       -- wrapper will get inlined later anyway.  To avoid this nasty
-       -- ordering difference, we make (case a of (x,y) -> ...) look free.
-    size_up (Case (Var v) _ [alt]) 
-       | v `elem` top_args
-       = size_up_alt alt `addSize` SizeIs 0# (unitBag (v, 1)) 0#
+    size_up (Case (Var v) _ alts) 
+       | v `elem` top_args             -- We are scrutinising an argument variable
+       = 
+{-     I'm nuking this special case; BUT see the comment with case alternatives.
+
+       (a) It's too eager.  We don't want to inline a wrapper into a
+           context with no benefit.  
+           E.g.  \ x. f (x+x)          o point in inlining (+) here!
+
+       (b) It's ineffective. Once g's wrapper is inlined, its case-expressions 
+           aren't scrutinising arguments any more
+
+           case alts of
+
+               [alt] -> size_up_alt alt `addSize` SizeIs 0# (unitBag (v, 1)) 0#
+               -- We want to make wrapper-style evaluation look cheap, so that
+               -- when we inline a wrapper it doesn't make call site (much) bigger
+               -- Otherwise we get nasty phase ordering stuff: 
+               --      f x = g x x
+               --      h y = ...(f e)...
+               -- If we inline g's wrapper, f looks big, and doesn't get inlined
+               -- into h; if we inline f first, while it looks small, then g's 
+               -- wrapper will get inlined later anyway.  To avoid this nasty
+               -- ordering difference, we make (case a of (x,y) -> ...), 
+               -- *where a is one of the arguments* look free.
+
+               other -> 
+-}
+                        alts_size (foldr addSize sizeOne alt_sizes)    -- The 1 is for the scrutinee
+                                  (foldr1 maxSize alt_sizes)
+
                -- Good to inline if an arg is scrutinised, because
                -- that may eliminate allocation in the caller
                -- And it eliminates the case itself
-       | otherwise     
-       = size_up_alt alt
-
-       -- Scrutinising one of the argument variables,
-       -- with more than one alternative
-    size_up (Case (Var v) _ alts)
-       | v `elem` top_args
-       = alts_size (foldr addSize sizeOne alt_sizes)   -- The 1 is for the scrutinee
-                   (foldr1 maxSize alt_sizes)
+
        where
-         v_in_args = v `elem` top_args
          alt_sizes = map size_up_alt alts
 
+               -- alts_size tries to compute a good discount for
+               -- the case when we are scrutinising an argument variable
          alts_size (SizeIs tot tot_disc tot_scrut)             -- Size of all alternatives
                    (SizeIs max max_disc max_scrut)             -- Size of biggest alternative
                = SizeIs tot (unitBag (v, I# (1# +# tot -# max)) `unionBags` max_disc) max_scrut
                        -- If the variable is known, we produce a discount that
                        -- will take us back to 'max', the size of rh largest alternative
                        -- The 1+ is a little discount for reduced allocation in the caller
-
          alts_size tot_size _ = tot_size
 
 
@@ -288,8 +286,8 @@ sizeExpr (I# bOMB_OUT_SIZE) top_args expr
        -- Also if the function is a constant Id (constr or primop)
        -- compute discounts specially
     size_up_fun (Var fun) args
-      | idUnique fun == buildIdKey   = buildSize
-      | idUnique fun == augmentIdKey = augmentSize
+      | fun `hasKey` buildIdKey   = buildSize
+      | fun `hasKey` augmentIdKey = augmentSize
       | otherwise 
       = case idFlavour fun of
          DataConId dc -> conSizeN (valArgCount args)
@@ -317,12 +315,13 @@ sizeExpr (I# bOMB_OUT_SIZE) top_args expr
 
     ------------ 
     size_up_alt (con, bndrs, rhs) = size_up rhs
-           -- Don't charge for args, so that wrappers look cheap
+       -- Don't charge for args, so that wrappers look cheap
+       -- (See comments about wrappers with Case)
 
     ------------
        -- We want to record if we're case'ing, or applying, an argument
     fun_discount v | v `elem` top_args = SizeIs 0# (unitBag (v, opt_UF_FunAppDiscount)) 0#
-    fun_discount other                   = sizeZero
+    fun_discount other                = sizeZero
 
     ------------
        -- These addSize things have to be here because
@@ -437,7 +436,7 @@ Just the same as smallEnoughToInline, except that it has no actual arguments.
 
 \begin{code}
 couldBeSmallEnoughToInline :: Int -> CoreExpr -> Bool
-couldBeSmallEnoughToInline threshold rhs = case calcUnfoldingGuidance threshold NoCPRInfo rhs of
+couldBeSmallEnoughToInline threshold rhs = case calcUnfoldingGuidance threshold rhs of
                                                UnfoldNever -> False
                                                other       -> True
 
@@ -446,16 +445,11 @@ certainlyWillInline :: Id -> Bool
 certainlyWillInline v
   = case idUnfolding v of
 
-       CoreUnfolding _ _ _ is_value _ (UnfoldIfGoodArgs n_vals _ size _)
+       CoreUnfolding _ _ is_value _ g@(UnfoldIfGoodArgs n_vals _ size _)
           ->    is_value 
              && size - (n_vals +1) <= opt_UF_UseThreshold
-             && not never_inline
 
        other -> False
-  where
-    never_inline = case idInlinePragma v of
-                       IMustNotBeINLINEd False Nothing -> True
-                       other                           -> False
 \end{code}
 
 @okToUnfoldInHifile@ is used when emitting unfolding info into an interface
@@ -481,7 +475,8 @@ okToUnfoldInHiFile e = opt_UnfoldCasms || go e
     go (App fun arg)          = go fun && go arg
     go (Lam _ body)           = go body
     go (Let binds body)       = and (map go (body :rhssOfBind binds))
-    go (Case scrut bndr alts) = and (map go (scrut:rhssOfAlts alts))
+    go (Case scrut bndr alts) = and (map go (scrut:rhssOfAlts alts)) &&
+                               not (any isLitLitLit [ lit | (LitAlt lit, _, _) <- alts ])
     go (Note _ body)          = go body
     go (Type _)                      = True
 
@@ -526,13 +521,13 @@ callSiteInline :: Bool                    -- True <=> the Id is black listed
 callSiteInline black_listed inline_call occ id arg_infos interesting_cont
   = case idUnfolding id of {
        NoUnfolding -> Nothing ;
-       OtherCon _  -> Nothing ;
+       OtherCon cs -> Nothing ;
        CompulsoryUnfolding unf_template | black_listed -> Nothing 
                                         | otherwise    -> Just unf_template ;
                -- Constructors have compulsory unfoldings, but
                -- may have rules, in which case they are 
                -- black listed till later
-       CoreUnfolding unf_template is_top is_cheap is_value is_bot guidance ->
+       CoreUnfolding unf_template is_top is_value is_cheap guidance ->
 
     let
        result | yes_or_no = Just unf_template
@@ -540,16 +535,13 @@ callSiteInline black_listed inline_call occ id arg_infos interesting_cont
 
        n_val_args  = length arg_infos
 
-       ok_inside_lam = is_value || is_bot || (is_cheap && not is_top)
-                               -- I'm experimenting with is_cheap && not is_top
-
        yes_or_no 
          | black_listed = False
          | otherwise    = case occ of
                                IAmDead              -> pprTrace "callSiteInline: dead" (ppr id) False
                                IAmALoopBreaker      -> False
-                               OneOcc in_lam one_br -> (not in_lam || ok_inside_lam) && consider_safe in_lam True  one_br
-                               NoOccInfo            -> ok_inside_lam                 && consider_safe True   False False
+                               OneOcc in_lam one_br -> (not in_lam || is_cheap) && consider_safe in_lam True  one_br
+                               NoOccInfo            -> is_cheap                 && consider_safe True   False False
 
        consider_safe in_lam once once_in_one_branch
                -- consider_safe decides whether it's a good idea to inline something,
@@ -622,14 +614,12 @@ callSiteInline black_listed inline_call occ id arg_infos interesting_cont
 #ifdef DEBUG
     if opt_D_dump_inlinings then
        pprTrace "Considering inlining"
-                (ppr id <+> vcat [text "black listed" <+> ppr black_listed,
+                (ppr id <+> vcat [text "black listed:" <+> ppr black_listed,
                                   text "occ info:" <+> ppr occ,
                                   text "arg infos" <+> ppr arg_infos,
                                   text "interesting continuation" <+> ppr interesting_cont,
                                   text "is value:" <+> ppr is_value,
                                   text "is cheap:" <+> ppr is_cheap,
-                                  text "is bottom:" <+> ppr is_bot,
-                                  text "is top-level:"    <+> ppr is_top,
                                   text "guidance" <+> ppr guidance,
                                   text "ANSWER =" <+> if yes_or_no then text "YES" else text "NO",
                                   if yes_or_no then
@@ -684,7 +674,7 @@ For optimisation we use phase 1,2 and nothing (i.e. no -finline-phase flag)
 in that order.  The meanings of these are determined by the @blackListed@ function
 here.
 
-The final simplification doesn't have a phase number
+The final simplification doesn't have a phase number.
 
 Pragmas
 ~~~~~~~
@@ -707,9 +697,7 @@ blackListed :: IdSet                -- Used in transformation rules
 -- place that the inline phase number is looked at.
 
 blackListed rule_vars Nothing          -- Last phase
-  = \v -> case idInlinePragma v of
-               IMustNotBeINLINEd False Nothing -> True         -- An unconditional NOINLINE pragma
-               other                           -> False
+  = \v -> isNeverInlinePrag (idInlinePragma v)
 
 blackListed rule_vars (Just phase)
   = \v -> normal_case rule_vars phase v
@@ -722,9 +710,9 @@ normal_case rule_vars phase v
          | from_INLINE -> has_rules    -- Black list until final phase
          | otherwise   -> True         -- Always blacklisted
 
-       IMustNotBeINLINEd from_inline (Just threshold)
-         | from_inline -> phase < threshold && has_rules
-         | otherwise   -> phase < threshold || has_rules
+       IMustNotBeINLINEd from_INLINE (Just threshold)
+         | from_INLINE -> (phase < threshold && has_rules)
+         | otherwise   -> (phase < threshold || has_rules)
   where
     has_rules =  v `elemVarSet` rule_vars
              || not (isEmptyCoreRules (idSpecialisation v))