[project @ 2001-10-23 22:25:46 by sof]
[ghc-hetmet.git] / ghc / compiler / basicTypes / IdInfo.lhs
index 5ebfad2..1aecb54 100644 (file)
@@ -19,9 +19,13 @@ module IdInfo (
        shortableIdInfo, copyIdInfo,
 
        -- Arity
-       ArityInfo(..),
-       exactArity, atLeastArity, unknownArity, hasArity,
-       arityInfo, setArityInfo, ppArityInfo, arityLowerBound,
+       ArityInfo,
+       unknownArity, 
+       arityInfo, setArityInfo, ppArityInfo, 
+
+       -- New demand and strictness info
+       newStrictnessInfo, setNewStrictnessInfo, mkNewStrictnessInfo,
+       newDemandInfo, setNewDemandInfo, newDemand, oldDemand,
 
        -- Strictness; imported from Demand
        StrictnessInfo(..),
@@ -45,9 +49,8 @@ module IdInfo (
        demandInfo, setDemandInfo, 
 
        -- Inline prags
-       InlinePragInfo(..), 
-       inlinePragInfo, setInlinePragInfo, pprInlinePragInfo,
-       isNeverInlinePrag, neverInlinePrag,
+       InlinePragInfo, 
+       inlinePragInfo, setInlinePragInfo, 
 
        -- Occurrence info
        OccInfo(..), isFragileOcc, isDeadOcc, isLoopBreaker,
@@ -58,10 +61,9 @@ module IdInfo (
        specInfo, setSpecInfo,
 
        -- CG info
-       CgInfo(..), cgInfo, setCgInfo,  cgMayHaveCafRefs, pprCgInfo,
-       cgArity, cgCafInfo, vanillaCgInfo,
+       CgInfo(..), cgInfo, setCgInfo,  pprCgInfo,
+       cgCafInfo, vanillaCgInfo,
        CgInfoEnv, lookupCgInfo,
-       setCgArity,
 
        -- CAF info
        CafInfo(..), ppCafInfo, setCafInfo, mayHaveCafRefs,
@@ -77,7 +79,7 @@ module IdInfo (
 
 
 import CoreSyn
-import Type            ( Type, usOnce )
+import Type            ( Type, usOnce, eqUsage )
 import PrimOp          ( PrimOp )
 import NameEnv         ( NameEnv, lookupNameEnv )
 import Name            ( Name )
@@ -85,14 +87,22 @@ import Var              ( Id )
 import BasicTypes      ( OccInfo(..), isFragileOcc, isDeadOcc, seqOccInfo, isLoopBreaker,
                          InsideLam, insideLam, notInsideLam, 
                          OneBranch, oneBranch, notOneBranch,
-                         Arity
+                         Arity,
+                         Activation(..)
                        )
 import DataCon         ( DataCon )
+import ForeignCall     ( ForeignCall )
 import FieldLabel      ( FieldLabel )
 import Type            ( usOnce, usMany )
-import Demand          -- Lots of stuff
+import Demand          hiding( Demand )
+import qualified Demand
+import NewDemand       ( Demand(..), Keepity(..), DmdResult(..),
+                         lazyDmd, topDmd, dmdTypeDepth, isStrictDmd,
+                         StrictSig, mkStrictSig, mkTopDmdType
+                       )
 import Outputable      
 import Util            ( seqList )
+import List            ( replicate )
 
 infixl         1 `setDemandInfo`,
          `setTyGenInfo`,
@@ -107,12 +117,63 @@ infixl    1 `setDemandInfo`,
          `setOccInfo`,
          `setCgInfo`,
          `setCafInfo`,
-         `setCgArity`
+         `setNewStrictnessInfo`,
+         `setNewDemandInfo`
        -- infixl so you can say (id `set` a `set` b)
 \end{code}
 
 %************************************************************************
 %*                                                                     *
+\subsection{New strictness info}
+%*                                                                     *
+%************************************************************************
+
+To be removed later
+
+\begin{code}
+mkNewStrictnessInfo :: Id -> Arity -> Demand.StrictnessInfo -> CprInfo -> StrictSig
+mkNewStrictnessInfo id arity (Demand.StrictnessInfo ds res) cpr
+  | length ds <= arity
+       -- Sometimes the old strictness analyser has more
+       -- demands than the arity justifies
+  = mk_strict_sig id arity $
+    mkTopDmdType (map newDemand ds) (newRes res cpr)
+
+mkNewStrictnessInfo id arity other cpr
+  =    -- Either no strictness info, or arity is too small
+       -- In either case we can't say anything useful
+    mk_strict_sig id arity $
+    mkTopDmdType (replicate arity lazyDmd) (newRes False cpr)
+
+mk_strict_sig id arity dmd_ty
+  = WARN( arity /= dmdTypeDepth dmd_ty, ppr id <+> (ppr arity $$ ppr dmd_ty) )
+    mkStrictSig dmd_ty
+
+newRes True  _                 = BotRes
+newRes False ReturnsCPR = RetCPR
+newRes False NoCPRInfo  = TopRes
+
+newDemand :: Demand.Demand -> NewDemand.Demand
+newDemand (WwLazy True)      = Abs
+newDemand (WwLazy False)     = Lazy
+newDemand WwStrict          = Eval
+newDemand (WwUnpack unpk ds) = Seq Drop (map newDemand ds)
+newDemand WwPrim            = Lazy
+newDemand WwEnum            = Eval
+
+oldDemand :: NewDemand.Demand -> Demand.Demand
+oldDemand Abs       = WwLazy True
+oldDemand Lazy      = WwLazy False
+oldDemand Bot       = WwStrict
+oldDemand Err       = WwStrict
+oldDemand Eval      = WwStrict
+oldDemand (Seq _ ds) = WwUnpack True (map oldDemand ds)
+oldDemand (Call _)   = WwStrict
+\end{code}
+
+
+%************************************************************************
+%*                                                                     *
 \subsection{GlobalIdDetails
 %*                                                                     *
 %************************************************************************
@@ -134,6 +195,7 @@ data GlobalIdDetails
                                --     Id back to the data con]
 
   | PrimOpId PrimOp            -- The Id for a primitive operator
+  | FCallId ForeignCall                -- The Id for a foreign call
 
   | NotGlobalId                        -- Used as a convenient extra return value from globalIdDetails
     
@@ -145,6 +207,7 @@ instance Outputable GlobalIdDetails where
     ppr (DataConId _)     = ptext SLIT("[DataCon]")
     ppr (DataConWrapId _) = ptext SLIT("[DataConWrapper]")
     ppr (PrimOpId _)      = ptext SLIT("[PrimOp]")
+    ppr (FCallId _)       = ptext SLIT("[ForeignCall]")
     ppr (RecordSelId _)   = ptext SLIT("[RecSel]")
 \end{code}
 
@@ -172,7 +235,7 @@ case.  KSW 1999-04).
 data IdInfo
   = IdInfo {
        arityInfo       :: ArityInfo,           -- Its arity
-       demandInfo      :: Demand,              -- Whether or not it is definitely demanded
+       demandInfo      :: Demand.Demand,       -- Whether or not it is definitely demanded
        specInfo        :: CoreRules,           -- Specialisations of this function which exist
         tyGenInfo       :: TyGenInfo,           -- Restrictions on usage-generalisation of this Id
        strictnessInfo  :: StrictnessInfo,      -- Strictness properties
@@ -182,7 +245,13 @@ data IdInfo
        cprInfo         :: CprInfo,             -- Function always constructs a product result
         lbvarInfo      :: LBVarInfo,           -- Info about a lambda-bound variable
        inlinePragInfo  :: InlinePragInfo,      -- Inline pragma
-       occInfo         :: OccInfo              -- How it occurs
+       occInfo         :: OccInfo,             -- How it occurs
+
+       newStrictnessInfo :: Maybe StrictSig,   -- Reason for Maybe: the DmdAnal phase needs to
+                                               -- know whether whether this is the first visit,
+                                               -- so it can assign botSig.  Other customers want
+                                               -- topSig.  So Nothing is good.
+       newDemandInfo     :: Demand
     }
 
 seqIdInfo :: IdInfo -> ()
@@ -213,7 +282,7 @@ Setters
 
 \begin{code}
 setWorkerInfo     info wk = wk `seq` info { workerInfo = wk }
-setSpecInfo      info sp = PSEQ sp (info { specInfo = sp })
+setSpecInfo      info sp = sp `seq` info { specInfo = sp }
 setTyGenInfo      info tg = tg `seq` info { tyGenInfo = tg }
 setInlinePragInfo info pr = pr `seq` info { inlinePragInfo = pr }
 setOccInfo       info oc = oc `seq` info { occInfo = oc }
@@ -221,7 +290,7 @@ setStrictnessInfo info st = st `seq` info { strictnessInfo = st }
        -- Try to avoid spack leaks by seq'ing
 
 setUnfoldingInfo  info uf 
-  | isEvaldUnfolding uf && isStrict (demandInfo info)
+  | isEvaldUnfolding uf
        -- If the unfolding is a value, the demand info may
        -- go pear-shaped, so we nuke it.  Example:
        --      let x = (a,b) in
@@ -231,7 +300,7 @@ setUnfoldingInfo  info uf
        --      let x = (a,b) in h a b x
        -- and now x is not demanded (I'm assuming h is lazy)
        -- This really happens.  The solution here is a bit ad hoc...
-  = info { unfoldingInfo = uf, demandInfo = wwLazy }
+  = info { unfoldingInfo = uf, newDemandInfo = Lazy }
 
   | otherwise
        -- We do *not* seq on the unfolding info, For some reason, doing so 
@@ -243,6 +312,9 @@ setArityInfo          info ar = info { arityInfo = ar  }
 setCgInfo         info cg = info { cgInfo = cg }
 setCprInfo        info cp = info { cprInfo = cp }
 setLBVarInfo      info lb = info { lbvarInfo = lb }
+
+setNewDemandInfo     info dd = info { newDemandInfo = dd }
+setNewStrictnessInfo info dd = info { newStrictnessInfo = dd }
 \end{code}
 
 
@@ -251,7 +323,7 @@ vanillaIdInfo :: IdInfo
 vanillaIdInfo 
   = IdInfo {
            cgInfo              = noCgInfo,
-           arityInfo           = UnknownArity,
+           arityInfo           = unknownArity,
            demandInfo          = wwLazy,
            specInfo            = emptyCoreRules,
             tyGenInfo          = noTyGenInfo,
@@ -260,12 +332,14 @@ vanillaIdInfo
            unfoldingInfo       = noUnfolding,
            cprInfo             = NoCPRInfo,
            lbvarInfo           = NoLBVarInfo,
-           inlinePragInfo      = NoInlinePragInfo,
-           occInfo             = NoOccInfo
+           inlinePragInfo      = AlwaysActive,
+           occInfo             = NoOccInfo,
+           newDemandInfo       = topDmd,
+           newStrictnessInfo   = Nothing
           }
 
 noCafNoTyGenIdInfo = vanillaIdInfo `setTyGenInfo` TyGenNever
-                                  `setCgInfo`    (CgInfo 0 NoCafRefs)
+                                  `setCgInfo`    CgInfo NoCafRefs
        -- Used for built-in type Ids in MkId.
        -- Many built-in things have fixed types, so we shouldn't
        -- run around generalising them
@@ -283,42 +357,22 @@ of their arities; so it should not be asking...    (but other things
 besides the code-generator need arity info!)
 
 \begin{code}
-data ArityInfo
-  = UnknownArity       -- No idea
+type ArityInfo = Arity
+       -- A partial application of this Id to up to n-1 value arguments
+       -- does essentially no work.  That is not necessarily the
+       -- same as saying that it has n leading lambdas, because coerces
+       -- may get in the way.
 
-  | ArityExactly Arity -- Arity is exactly this.  We use this when importing a
-                       -- function; it's already been compiled and we know its
-                       -- arity for sure.
-
-  | ArityAtLeast Arity -- A partial application of this Id to up to n-1 value arguments
-                       -- does essentially no work.  That is not necessarily the
-                       -- same as saying that it has n leading lambdas, because coerces
-                       -- may get in the way.
-
-                       -- functions in the module being compiled.  Their arity
-                       -- might increase later in the compilation process, if
-                       -- an extra lambda floats up to the binding site.
-  deriving( Eq )
+       -- The arity might increase later in the compilation process, if
+       -- an extra lambda floats up to the binding site.
 
 seqArity :: ArityInfo -> ()
-seqArity a = arityLowerBound a `seq` ()
-
-exactArity   = ArityExactly
-atLeastArity = ArityAtLeast
-unknownArity = UnknownArity
+seqArity a = a `seq` ()
 
-arityLowerBound :: ArityInfo -> Arity
-arityLowerBound UnknownArity     = 0
-arityLowerBound (ArityAtLeast n) = n
-arityLowerBound (ArityExactly n) = n
+unknownArity = 0 :: Arity
 
-hasArity :: ArityInfo -> Bool
-hasArity UnknownArity = False
-hasArity other       = True
-
-ppArityInfo UnknownArity        = empty
-ppArityInfo (ArityExactly arity) = hsep [ptext SLIT("ArityExactly"), int arity]
-ppArityInfo (ArityAtLeast arity) = hsep [ptext SLIT("ArityAtLeast"), int arity]
+ppArityInfo 0 = empty
+ppArityInfo n = hsep [ptext SLIT("Arity"), int n]
 \end{code}
 
 %************************************************************************
@@ -328,36 +382,13 @@ ppArityInfo (ArityAtLeast arity) = hsep [ptext SLIT("ArityAtLeast"), int arity]
 %************************************************************************
 
 \begin{code}
-data InlinePragInfo
-  = NoInlinePragInfo
-  | IMustNotBeINLINEd Bool             -- True <=> came from an INLINE prag, False <=> came from a NOINLINE prag
-                     (Maybe Int)       -- Phase number from pragma, if any
-  deriving( Eq )
-       -- The True, Nothing case doesn't need to be recorded
-
-       -- SEE COMMENTS WITH CoreUnfold.blackListed on the
-       -- exact significance of the IMustNotBeINLINEd pragma
-
-isNeverInlinePrag :: InlinePragInfo -> Bool
-isNeverInlinePrag (IMustNotBeINLINEd _ Nothing) = True
-isNeverInlinePrag other                                = False
-
-neverInlinePrag :: InlinePragInfo
-neverInlinePrag = IMustNotBeINLINEd True{-should be False? --SDM -} Nothing
-
-instance Outputable InlinePragInfo where
-  -- This is now parsed in interface files
-  ppr NoInlinePragInfo = empty
-  ppr other_prag       = ptext SLIT("__U") <> pprInlinePragInfo other_prag
-
-pprInlinePragInfo NoInlinePragInfo                  = empty
-pprInlinePragInfo (IMustNotBeINLINEd True Nothing)   = empty
-pprInlinePragInfo (IMustNotBeINLINEd True (Just n))  = brackets (int n)
-pprInlinePragInfo (IMustNotBeINLINEd False Nothing)  = brackets (char '!')
-pprInlinePragInfo (IMustNotBeINLINEd False (Just n)) = brackets (char '!' <> int n)
-                                                       
-instance Show InlinePragInfo where
-  showsPrec p prag = showsPrecSDoc p (ppr prag)
+type InlinePragInfo = Activation
+       -- Tells when the inlining is active
+       -- When it is active the thing may be inlined, depending on how
+       -- big it is.
+       --
+       -- If there was an INLINE pragma, then as a separate matter, the
+       -- RHS will have been made to look small with a CoreSyn Inline Note
 \end{code}
 
 
@@ -392,8 +423,6 @@ data TyGenInfo
                              -- preserve specified usage annotations
 
   | TyGenNever               -- never generalise the type of this Id
-
-  deriving ( Eq )
 \end{code}
 
 For TyGenUInfo, the list has one entry for each usage annotation on
@@ -425,9 +454,9 @@ ppTyGenInfo (TyGenUInfo us) = ptext SLIT("__G") <+> text (tyGenInfoString us)
 ppTyGenInfo  TyGenNever     = ptext SLIT("__G N")
 
 tyGenInfoString us = map go us
-  where go  Nothing               = 'x'  -- for legibility, choose
-        go (Just u) | u == usOnce = '1'  -- chars with identity
-                    | u == usMany = 'M'  -- Z-encoding.
+  where go  Nothing                     = 'x'  -- for legibility, choose
+        go (Just u) | u `eqUsage` usOnce = '1'  -- chars with identity
+                    | u `eqUsage` usMany = 'M'  -- Z-encoding.
         go other = pprPanic "IdInfo.tyGenInfoString: unexpected annotation" (ppr other)
 
 instance Outputable TyGenInfo where
@@ -508,29 +537,24 @@ but only as a thunk --- the information is only actually produced further
 downstream, by the code generator.
 
 \begin{code}
-data CgInfo = CgInfo 
-               !Arity          -- Exact arity for calling purposes
-               !CafInfo
-
-cgArity   (CgInfo arity _)    = arity
-cgCafInfo (CgInfo _ caf_info) = caf_info
-
-setCafInfo info caf_info = 
-  case cgInfo info of { CgInfo arity _  -> 
-       info `setCgInfo` CgInfo arity caf_info }
-
-setCgArity info arity = 
-  case cgInfo info of { CgInfo _ caf_info  -> 
-       info `setCgInfo` CgInfo arity caf_info }
+#ifndef DEBUG
+newtype CgInfo = CgInfo CafInfo        -- We are back to only having CafRefs in CgInfo
+noCgInfo = panic "NoCgInfo!"
+#else
+data CgInfo = CgInfo CafInfo
+           | NoCgInfo          -- In debug mode we don't want a black hole here
+                               -- See Id.idCgInfo
+       -- noCgInfo is used for local Ids, which shouldn't need any CgInfo
+noCgInfo = NoCgInfo
+#endif
 
-       -- Used for local Ids, which shouldn't need any CgInfo
-noCgInfo = panic "noCgInfo!"
+cgCafInfo (CgInfo caf_info) = caf_info
 
-cgMayHaveCafRefs (CgInfo _ caf_info) = mayHaveCafRefs caf_info
+setCafInfo info caf_info = info `setCgInfo` CgInfo caf_info 
 
 seqCg c = c `seq` ()  -- fields are strict anyhow
 
-vanillaCgInfo = CgInfo 0 MayHaveCafRefs                -- Definitely safe
+vanillaCgInfo = CgInfo MayHaveCafRefs          -- Definitely safe
 
 -- CafInfo is used to build Static Reference Tables (see simplStg/SRT.lhs).
 
@@ -548,7 +572,7 @@ mayHaveCafRefs _           = False
 
 seqCaf c = c `seq` ()
 
-pprCgInfo (CgInfo arity caf_info) = ppArity arity <+> ppCafInfo caf_info
+pprCgInfo (CgInfo caf_info) = ppCafInfo caf_info
 
 ppArity 0 = empty
 ppArity n = hsep [ptext SLIT("__A"), int n]
@@ -661,7 +685,7 @@ noLBVarInfo = NoLBVarInfo
 -- not safe to print or parse LBVarInfo because it is not really a
 -- property of the definition, but a property of the context.
 pprLBVarInfo NoLBVarInfo     = empty
-pprLBVarInfo (LBVarInfo u)   | u == usOnce
+pprLBVarInfo (LBVarInfo u)   | u `eqUsage` usOnce
                              = getPprStyle $ \ sty ->
                                if ifaceStyle sty
                                then empty
@@ -688,12 +712,12 @@ part of an unsaturated lambda
 
 \begin{code}
 zapLamInfo :: IdInfo -> Maybe IdInfo
-zapLamInfo info@(IdInfo {occInfo = occ, demandInfo = demand})
-  | is_safe_occ && not (isStrict demand)
+zapLamInfo info@(IdInfo {occInfo = occ, newDemandInfo = demand})
+  | is_safe_occ && not (isStrictDmd demand)
   = Nothing
   | otherwise
   = Just (info {occInfo = safe_occ,
-               demandInfo = wwLazy})
+               newDemandInfo = Lazy})
   where
        -- The "unsafe" occ info is the ones that say I'm not in a lambda
        -- because that might not be true for an unsaturated lambda
@@ -708,9 +732,9 @@ zapLamInfo info@(IdInfo {occInfo = occ, demandInfo = demand})
 
 \begin{code}
 zapDemandInfo :: IdInfo -> Maybe IdInfo
-zapDemandInfo info@(IdInfo {demandInfo = demand})
-  | not (isStrict demand) = Nothing
-  | otherwise            = Just (info {demandInfo = wwLazy})
+zapDemandInfo info@(IdInfo {newDemandInfo = demand})
+  | not (isStrictDmd demand) = Nothing
+  | otherwise               = Just (info {newDemandInfo = Lazy})
 \end{code}