[project @ 2002-12-05 23:49:43 by mthomas]
[ghc-hetmet.git] / ghc / compiler / basicTypes / IdInfo.lhs
index b39b60c..fdaef1a 100644 (file)
@@ -11,7 +11,7 @@ module IdInfo (
        GlobalIdDetails(..), notGlobalId,       -- Not abstract
 
        IdInfo,         -- Abstract
-       vanillaIdInfo, noCafNoTyGenIdInfo,
+       vanillaIdInfo, noCafIdInfo, hasCafIdInfo,
        seqIdInfo, megaSeqIdInfo,
 
        -- Zapping
@@ -25,7 +25,7 @@ module IdInfo (
 
        -- New demand and strictness info
        newStrictnessInfo, setNewStrictnessInfo, 
-       newDemandInfo, setNewDemandInfo,
+       newDemandInfo, setNewDemandInfo, pprNewStrictness,
 
        -- Strictness; imported from Demand
        StrictnessInfo(..),
@@ -33,11 +33,6 @@ module IdInfo (
        ppStrictnessInfo,isBottomingStrictness, 
        setAllStrictnessInfo,
 
-        -- Usage generalisation
-        TyGenInfo(..),
-        tyGenInfo, setTyGenInfo,
-        noTyGenInfo, isNoTyGenInfo, ppTyGenInfo, tyGenInfoString,
-
         -- Worker
         WorkerInfo(..), workerExists, wrapperArity, workerId,
         workerInfo, setWorkerInfo, ppWorkerInfo,
@@ -45,7 +40,7 @@ module IdInfo (
        -- Unfolding
        unfoldingInfo, setUnfoldingInfo, 
 
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
        -- Old DemandInfo and StrictnessInfo
        demandInfo, setDemandInfo, 
        strictnessInfo, setStrictnessInfo,
@@ -99,17 +94,19 @@ import BasicTypes   ( OccInfo(..), isFragileOcc, isDeadOcc, seqOccInfo, isLoopBrea
 import DataCon         ( DataCon )
 import ForeignCall     ( ForeignCall )
 import FieldLabel      ( FieldLabel )
-import Type            ( usOnce, usMany )
+import Type            ( usOnce )
 import Demand          hiding( Demand, seqDemand )
 import qualified Demand
 import NewDemand
 import Outputable      
-import Util            ( seqList, listLengthCmp )
+import Maybe           ( isJust )
+#ifdef OLD_STRICTNESS
+import Util            ( listLengthCmp )
 import List            ( replicate )
+#endif
 
 -- infixl so you can say (id `set` a `set` b)
-infixl         1 `setTyGenInfo`,
-         `setSpecInfo`,
+infixl         1 `setSpecInfo`,
          `setArityInfo`,
          `setInlinePragInfo`,
          `setUnfoldingInfo`,
@@ -121,7 +118,7 @@ infixl      1 `setTyGenInfo`,
          `setNewStrictnessInfo`,
          `setAllStrictnessInfo`,
          `setNewDemandInfo`
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
          , `setCprInfo`
          , `setDemandInfo`
          , `setStrictnessInfo`
@@ -141,7 +138,7 @@ To be removed later
 -- Set old and new strictness info
 setAllStrictnessInfo info Nothing
   = info { newStrictnessInfo = Nothing
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
          , strictnessInfo = NoStrictnessInfo
          , cprInfo = NoCPRInfo
 #endif
@@ -149,7 +146,7 @@ setAllStrictnessInfo info Nothing
 
 setAllStrictnessInfo info (Just sig)
   = info { newStrictnessInfo = Just sig
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
          , strictnessInfo = oldStrictnessFromNew sig
          , cprInfo = cprInfoFromNewStrictness sig
 #endif
@@ -158,7 +155,10 @@ setAllStrictnessInfo info (Just sig)
 seqNewStrictnessInfo Nothing = ()
 seqNewStrictnessInfo (Just ty) = seqStrictSig ty
 
-#ifdef DEBUG
+pprNewStrictness Nothing = empty
+pprNewStrictness (Just sig) = ftext FSLIT("Str:") <+> ppr sig
+
+#ifdef OLD_STRICTNESS
 oldStrictnessFromNew :: StrictSig -> Demand.StrictnessInfo
 oldStrictnessFromNew sig = mkStrictnessInfo (map oldDemand dmds, isBotRes res_info)
                         where
@@ -188,7 +188,7 @@ mk_strict_sig name arity dmd_ty
     mkStrictSig dmd_ty
 
 newRes True  _                 = BotRes
-newRes False ReturnsCPR = RetCPR
+newRes False ReturnsCPR = retCPR
 newRes False NoCPRInfo  = TopRes
 
 newDemand :: Demand.Demand -> NewDemand.Demand
@@ -211,7 +211,13 @@ oldDemand (Eval (Prod ds)) = WwUnpack True (map oldDemand ds)
 oldDemand (Eval (Poly _))  = WwStrict
 oldDemand (Call _)         = WwStrict
 
-#endif /* DEBUG */
+#endif /* OLD_STRICTNESS */
+\end{code}
+
+
+\begin{code}
+seqNewDemandInfo Nothing    = ()
+seqNewDemandInfo (Just dmd) = seqDemand dmd
 \end{code}
 
 
@@ -279,8 +285,7 @@ data IdInfo
   = IdInfo {
        arityInfo       :: !ArityInfo,          -- Its arity
        specInfo        :: CoreRules,           -- Specialisations of this function which exist
-        tyGenInfo       :: TyGenInfo,           -- Restrictions on usage-generalisation of this Id
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
        cprInfo         :: CprInfo,             -- Function always constructs a product result
        demandInfo      :: Demand.Demand,       -- Whether or not it is definitely demanded
        strictnessInfo  :: StrictnessInfo,      -- Strictness properties
@@ -296,7 +301,10 @@ data IdInfo
                                                -- know whether whether this is the first visit,
                                                -- so it can assign botSig.  Other customers want
                                                -- topSig.  So Nothing is good.
-       newDemandInfo     :: Demand
+
+       newDemandInfo     :: Maybe Demand       -- Similarly we want to know if there's no
+                                               -- known demand yet, for when we are looking for
+                                               -- CPR info
     }
 
 seqIdInfo :: IdInfo -> ()
@@ -305,17 +313,16 @@ seqIdInfo (IdInfo {}) = ()
 megaSeqIdInfo :: IdInfo -> ()
 megaSeqIdInfo info
   = seqRules (specInfo info)                   `seq`
-    seqTyGenInfo (tyGenInfo info)               `seq`
     seqWorker (workerInfo info)                        `seq`
 
 -- Omitting this improves runtimes a little, presumably because
 -- some unfoldings are not calculated at all
 --    seqUnfolding (unfoldingInfo info)                `seq`
 
-    seqDemand (newDemandInfo info)             `seq`
+    seqNewDemandInfo (newDemandInfo info)      `seq`
     seqNewStrictnessInfo (newStrictnessInfo info) `seq`
 
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
     Demand.seqDemand (demandInfo info)         `seq`
     seqStrictnessInfo (strictnessInfo info)    `seq`
     seqCpr (cprInfo info)                      `seq`
@@ -333,10 +340,9 @@ Setters
 \begin{code}
 setWorkerInfo     info wk = wk `seq` info { workerInfo = wk }
 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 }
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
 setStrictnessInfo info st = st `seq` info { strictnessInfo = st }
 #endif
        -- Try to avoid spack leaks by seq'ing
@@ -352,14 +358,14 @@ 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, newDemandInfo = Top }
+  = info { unfoldingInfo = uf, newDemandInfo = Nothing }
 
   | otherwise
        -- We do *not* seq on the unfolding info, For some reason, doing so 
        -- actually increases residency significantly. 
   = info { unfoldingInfo = uf }
 
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
 setDemandInfo    info dd = info { demandInfo = dd }
 setCprInfo        info cp = info { cprInfo = cp }
 #endif
@@ -380,27 +386,26 @@ vanillaIdInfo
   = IdInfo {
            cgInfo              = noCgInfo,
            arityInfo           = unknownArity,
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
            cprInfo             = NoCPRInfo,
            demandInfo          = wwLazy,
            strictnessInfo      = NoStrictnessInfo,
 #endif
            specInfo            = emptyCoreRules,
-            tyGenInfo          = noTyGenInfo,
            workerInfo          = NoWorker,
            unfoldingInfo       = noUnfolding,
            lbvarInfo           = NoLBVarInfo,
            inlinePragInfo      = AlwaysActive,
            occInfo             = NoOccInfo,
-           newDemandInfo       = topDmd,
+           newDemandInfo       = Nothing,
            newStrictnessInfo   = Nothing
           }
 
-noCafNoTyGenIdInfo = vanillaIdInfo `setTyGenInfo` TyGenNever
-                                  `setCgInfo`    CgInfo NoCafRefs
+hasCafIdInfo = vanillaIdInfo `setCgInfo`    CgInfo MayHaveCafRefs
+noCafIdInfo  = vanillaIdInfo `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
+       -- These must have a valid CgInfo set, so you can't
+       --      use vanillaIdInfo!
 \end{code}
 
 
@@ -448,81 +453,6 @@ type InlinePragInfo = Activation
 
 
 %************************************************************************
-%*                                                                    *
-\subsection[TyGen-IdInfo]{Type generalisation info about an @Id@}
-%*                                                                    *
-%************************************************************************
-
-Certain passes (notably usage inference) may change the type of an
-identifier, modifying all in-scope uses of that identifier
-appropriately to maintain type safety.
-
-However, some identifiers must not have their types changed in this
-way, because their types are conjured up in the front end of the
-compiler rather than being read from the interface file.  Default
-methods, dictionary functions, record selectors, and others are in
-this category.  (see comment at TcClassDcl.tcClassSig).
-
-To indicate this property, such identifiers are marked TyGenNever.
-
-Furthermore, if the usage inference generates a usage-specialised
-variant of a function, we must NOT re-infer a fully-generalised type
-at the next inference.  This finer property is indicated by a
-TyGenUInfo on the identifier.
-
-\begin{code}
-data TyGenInfo
-  = NoTyGenInfo              -- no restriction on type generalisation
-
-  | TyGenUInfo [Maybe Type]  -- restrict generalisation of this Id to
-                             -- preserve specified usage annotations
-
-  | TyGenNever               -- never generalise the type of this Id
-\end{code}
-
-For TyGenUInfo, the list has one entry for each usage annotation on
-the type of the Id, in left-to-right pre-order (annotations come
-before the type they annotate).  Nothing means no restriction; Just
-usOnce or Just usMany forces that annotation to that value.  Other
-usage annotations are illegal.
-
-\begin{code}
-seqTyGenInfo :: TyGenInfo -> ()
-seqTyGenInfo  NoTyGenInfo    = ()
-seqTyGenInfo (TyGenUInfo us) = seqList us ()
-seqTyGenInfo  TyGenNever     = ()
-
-noTyGenInfo :: TyGenInfo
-noTyGenInfo = NoTyGenInfo
-
-isNoTyGenInfo :: TyGenInfo -> Bool
-isNoTyGenInfo NoTyGenInfo = True
-isNoTyGenInfo _           = False
-
--- NB: There's probably no need to write this information out to the interface file.
--- Why?  Simply because imported identifiers never get their types re-inferred.
--- But it's definitely nice to see in dumps, it for debugging purposes.
-
-ppTyGenInfo :: TyGenInfo -> SDoc
-ppTyGenInfo  NoTyGenInfo    = empty
-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 `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
-  ppr = ppTyGenInfo
-
-instance Show TyGenInfo where
-  showsPrec p c = showsPrecSDoc p (ppr c)
-\end{code}
-
-
-%************************************************************************
 %*                                                                     *
 \subsection[worker-IdInfo]{Worker info about an @Id@}
 %*                                                                     *
@@ -592,7 +522,7 @@ but only as a thunk --- the information is only actually produced further
 downstream, by the code generator.
 
 \begin{code}
-#ifndef DEBUG
+#ifndef OLD_STRICTNESS
 newtype CgInfo = CgInfo CafInfo        -- We are back to only having CafRefs in CgInfo
 noCgInfo = panic "NoCgInfo!"
 #else
@@ -671,7 +601,7 @@ function has the CPR property and which components of the result are
 also CPRs.   
 
 \begin{code}
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
 data CprInfo
   = NoCPRInfo
   | ReturnsCPR -- Yes, this function returns a constructed product
@@ -765,28 +695,29 @@ part of an unsaturated lambda
 \begin{code}
 zapLamInfo :: IdInfo -> Maybe IdInfo
 zapLamInfo info@(IdInfo {occInfo = occ, newDemandInfo = demand})
-  | is_safe_occ && not (isStrictDmd demand)
+  | is_safe_occ occ && is_safe_dmd demand
   = Nothing
   | otherwise
-  = Just (info {occInfo = safe_occ,
-               newDemandInfo = Top})
+  = Just (info {occInfo = safe_occ, newDemandInfo = Nothing})
   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
-    is_safe_occ = case occ of
-                       OneOcc in_lam once -> in_lam
-                       other              -> True
+    is_safe_occ (OneOcc in_lam once) = in_lam
+    is_safe_occ other               = True
 
     safe_occ = case occ of
                 OneOcc _ once -> OneOcc insideLam once
                 other         -> occ
+
+    is_safe_dmd Nothing    = True
+    is_safe_dmd (Just dmd) = not (isStrictDmd dmd)
 \end{code}
 
 \begin{code}
 zapDemandInfo :: IdInfo -> Maybe IdInfo
-zapDemandInfo info@(IdInfo {newDemandInfo = demand})
-  | not (isStrictDmd demand) = Nothing
-  | otherwise               = Just (info {newDemandInfo = Top})
+zapDemandInfo info@(IdInfo {newDemandInfo = dmd})
+  | isJust dmd = Just (info {newDemandInfo = Nothing})
+  | otherwise  = Nothing
 \end{code}
 
 
@@ -849,7 +780,7 @@ copyIdInfo :: IdInfo        -- f_local
           -> IdInfo    -- f (the exported one)
           -> IdInfo    -- New info for f
 copyIdInfo f_local f = f { newStrictnessInfo = newStrictnessInfo f_local,
-#ifdef DEBUG
+#ifdef OLD_STRICTNESS
                           strictnessInfo = strictnessInfo f_local,
                           cprInfo        = cprInfo        f_local,
 #endif