[project @ 2001-07-12 16:25:32 by sof]
[ghc-hetmet.git] / ghc / compiler / basicTypes / IdInfo.lhs
index cde3737..29e644d 100644 (file)
@@ -11,7 +11,7 @@ module IdInfo (
        GlobalIdDetails(..), notGlobalId,       -- Not abstract
 
        IdInfo,         -- Abstract
-       vanillaIdInfo, noTyGenIdInfo, noCafOrTyGenIdInfo, noCafIdInfo,
+       vanillaIdInfo, noCafNoTyGenIdInfo,
        seqIdInfo, megaSeqIdInfo,
 
        -- Zapping
@@ -57,8 +57,14 @@ module IdInfo (
        -- Specialisation
        specInfo, setSpecInfo,
 
+       -- CG info
+       CgInfo(..), cgInfo, setCgInfo,  cgMayHaveCafRefs, pprCgInfo,
+       cgArity, cgCafInfo, vanillaCgInfo,
+       CgInfoEnv, lookupCgInfo,
+       setCgArity,
+
        -- CAF info
-       CafInfo(..), cafInfo, setCafInfo, mayHaveCafRefs, ppCafInfo,
+       CafInfo(..), ppCafInfo, setCafInfo, mayHaveCafRefs,
 
         -- Constructed Product Result Info
         CprInfo(..), cprInfo, setCprInfo, ppCprInfo, noCprInfo,
@@ -71,8 +77,10 @@ module IdInfo (
 
 
 import CoreSyn
-import Type            ( Type, usOnce )
+import Type            ( Type, usOnce, eqUsage )
 import PrimOp          ( PrimOp )
+import NameEnv         ( NameEnv, lookupNameEnv )
+import Name            ( Name )
 import Var              ( Id )
 import BasicTypes      ( OccInfo(..), isFragileOcc, isDeadOcc, seqOccInfo, isLoopBreaker,
                          InsideLam, insideLam, notInsideLam, 
@@ -80,6 +88,7 @@ import BasicTypes     ( OccInfo(..), isFragileOcc, isDeadOcc, seqOccInfo, isLoopBrea
                          Arity
                        )
 import DataCon         ( DataCon )
+import ForeignCall     ( ForeignCall )
 import FieldLabel      ( FieldLabel )
 import Type            ( usOnce, usMany )
 import Demand          -- Lots of stuff
@@ -96,8 +105,10 @@ infixl      1 `setDemandInfo`,
          `setCprInfo`,
          `setWorkerInfo`,
          `setLBVarInfo`,
+         `setOccInfo`,
+         `setCgInfo`,
          `setCafInfo`,
-         `setOccInfo`
+         `setCgArity`
        -- infixl so you can say (id `set` a `set` b)
 \end{code}
 
@@ -124,6 +135,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
     
@@ -135,6 +147,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}
 
@@ -168,7 +181,7 @@ data IdInfo
        strictnessInfo  :: StrictnessInfo,      -- Strictness properties
         workerInfo      :: WorkerInfo,          -- Pointer to Worker Function
        unfoldingInfo   :: Unfolding,           -- Its unfolding
-       cafInfo         :: CafInfo,             -- whether it refers (indirectly) to any CAFs
+       cgInfo          :: CgInfo,              -- Code generator info (arity, CAF info)
        cprInfo         :: CprInfo,             -- Function always constructs a product result
         lbvarInfo      :: LBVarInfo,           -- Info about a lambda-bound variable
        inlinePragInfo  :: InlinePragInfo,      -- Inline pragma
@@ -191,7 +204,9 @@ megaSeqIdInfo info
 -- Omitting this improves runtimes a little, presumably because
 -- some unfoldings are not calculated at all
 
-    seqCaf (cafInfo info)              `seq`
+-- CgInfo is involved in a loop, so we have to be careful not to seq it
+-- too early.
+--    seqCg (cgInfo info)                      `seq`
     seqCpr (cprInfo info)              `seq`
     seqLBVar (lbvarInfo info)          `seq`
     seqOccInfo (occInfo info) 
@@ -228,7 +243,7 @@ setUnfoldingInfo  info uf
 
 setDemandInfo    info dd = info { demandInfo = dd }
 setArityInfo     info ar = info { arityInfo = ar  }
-setCafInfo        info cf = info { cafInfo = cf }
+setCgInfo         info cg = info { cgInfo = cg }
 setCprInfo        info cp = info { cprInfo = cp }
 setLBVarInfo      info lb = info { lbvarInfo = lb }
 \end{code}
@@ -238,7 +253,7 @@ setLBVarInfo      info lb = info { lbvarInfo = lb }
 vanillaIdInfo :: IdInfo
 vanillaIdInfo 
   = IdInfo {
-           cafInfo             = MayHaveCafRefs,       -- Safe!
+           cgInfo              = noCgInfo,
            arityInfo           = UnknownArity,
            demandInfo          = wwLazy,
            specInfo            = emptyCoreRules,
@@ -252,15 +267,11 @@ vanillaIdInfo
            occInfo             = NoOccInfo
           }
 
-noTyGenIdInfo = vanillaIdInfo `setTyGenInfo` TyGenNever
+noCafNoTyGenIdInfo = vanillaIdInfo `setTyGenInfo` TyGenNever
+                                  `setCgInfo`    (CgInfo 0 NoCafRefs)
+       -- Used for built-in type Ids in MkId.
        -- Many built-in things have fixed types, so we shouldn't
        -- run around generalising them
-
-noCafIdInfo = vanillaIdInfo  `setCafInfo` NoCafRefs
-       -- Local things don't refer to Cafs
-
-noCafOrTyGenIdInfo = noTyGenIdInfo `setCafInfo` NoCafRefs
-       -- Most also guarantee not to refer to CAFs
 \end{code}
 
 
@@ -309,8 +320,8 @@ hasArity UnknownArity = False
 hasArity other       = True
 
 ppArityInfo UnknownArity        = empty
-ppArityInfo (ArityExactly arity) = hsep [ptext SLIT("__A"), int arity]
-ppArityInfo (ArityAtLeast arity) = hsep [ptext SLIT("__AL"), int arity]
+ppArityInfo (ArityExactly arity) = hsep [ptext SLIT("ArityExactly"), int arity]
+ppArityInfo (ArityAtLeast arity) = hsep [ptext SLIT("ArityAtLeast"), int arity]
 \end{code}
 
 %************************************************************************
@@ -384,8 +395,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
@@ -417,9 +426,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
@@ -445,6 +454,23 @@ There might not be a worker, even for a strict function, because:
     for w/w split
 (b) the strictness info might be "SSS" or something, so no w/w split.
 
+Sometimes the arity of a wrapper changes from the original arity from
+which it was generated, so we always emit the "original" arity into
+the interface file, as part of the worker info.
+
+How can this happen?  Sometimes we get
+       f = coerce t (\x y -> $wf x y)
+at the moment of w/w split; but the eta reducer turns it into
+       f = coerce t $wf
+which is perfectly fine except that the exposed arity so far as
+the code generator is concerned (zero) differs from the arity
+when we did the split (2).  
+
+All this arises because we use 'arity' to mean "exactly how many
+top level lambdas are there" in interface files; but during the
+compilation of this module it means "how many things can I apply
+this to".
+
 \begin{code}
 
 data WorkerInfo = NoWorker
@@ -473,14 +499,48 @@ wrapperArity (HasWorker _ a) = a
 
 %************************************************************************
 %*                                                                     *
-\subsection[CAF-IdInfo]{CAF-related information}
+\subsection[CG-IdInfo]{Code generator-related information}
 %*                                                                     *
 %************************************************************************
 
-This information is used to build Static Reference Tables (see
-simplStg/ComputeSRT.lhs).
+CgInfo encapsulates calling-convention information produced by the code 
+generator.  It is pasted into the IdInfo of each emitted Id by CoreTidy,
+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
+#ifdef DEBUG
+           | 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
+#else
+noCgInfo = panic "NoCgInfo!"
+#endif
+
+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 }
+
+cgMayHaveCafRefs (CgInfo _ caf_info) = mayHaveCafRefs caf_info
+
+seqCg c = c `seq` ()  -- fields are strict anyhow
+
+vanillaCgInfo = CgInfo 0 MayHaveCafRefs                -- Definitely safe
+
+-- CafInfo is used to build Static Reference Tables (see simplStg/SRT.lhs).
+
 data CafInfo 
        = MayHaveCafRefs                -- either:
                                        -- (1) A function or static constructor
@@ -490,19 +550,29 @@ data CafInfo
        | NoCafRefs                     -- A function or static constructor
                                        -- that refers to no CAFs.
 
--- LATER: not sure how easy this is...
---      | OneCafRef Id
+mayHaveCafRefs  MayHaveCafRefs = True
+mayHaveCafRefs _              = False
 
+seqCaf c = c `seq` ()
 
-mayHaveCafRefs MayHaveCafRefs = True
-mayHaveCafRefs _             = False
+pprCgInfo (CgInfo arity caf_info) = ppArity arity <+> ppCafInfo caf_info
 
-seqCaf c = c `seq` ()
+ppArity 0 = empty
+ppArity n = hsep [ptext SLIT("__A"), int n]
 
 ppCafInfo NoCafRefs = ptext SLIT("__C")
 ppCafInfo MayHaveCafRefs = empty
 \end{code}
 
+\begin{code}
+type CgInfoEnv = NameEnv CgInfo
+
+lookupCgInfo :: NameEnv CgInfo -> Name -> CgInfo
+lookupCgInfo env n = case lookupNameEnv env n of
+                       Just info -> info
+                       Nothing   -> pprTrace "Urk! Not in CgInfo env" (ppr n) vanillaCgInfo
+\end{code}
+
 
 %************************************************************************
 %*                                                                     *
@@ -598,7 +668,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
@@ -690,7 +760,7 @@ This got shorted out to:
      #-}
 
 And now we get an infinite loop in the rule system 
-       iterate f x -> build (\cn -> iterateFB c f x
+       iterate f x -> build (\cn -> iterateFB c f x)
                    -> iterateFB (:) f x
                    -> iterate f x