X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FIdInfo.lhs;h=91ecbe26fc13dea5956437cfffbba54c8d9464b5;hb=09518039f8f793e6464c1703506089a107926d11;hp=47ce3a8129065cae7faa2641df50557fa97fe038;hpb=e7d21ee4f8ac907665a7e170c71d59e13a01da09;p=ghc-hetmet.git diff --git a/ghc/compiler/basicTypes/IdInfo.lhs b/ghc/compiler/basicTypes/IdInfo.lhs index 47ce3a8..91ecbe2 100644 --- a/ghc/compiler/basicTypes/IdInfo.lhs +++ b/ghc/compiler/basicTypes/IdInfo.lhs @@ -1,5 +1,5 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1993-1995 +% (c) The GRASP/AQUA Project, Glasgow University, 1993-1998 % \section[IdInfo]{@IdInfos@: Non-essential information about @Ids@} @@ -7,339 +7,304 @@ Haskell. [WDP 94/11]) \begin{code} -#include "HsVersions.h" - module IdInfo ( - IdInfo, -- abstract - noIdInfo, - boringIdInfo, - ppIdInfo, - applySubstToIdInfo, apply_to_IdInfo, -- not for general use, please - - OptIdInfo(..), -- class; for convenience only, really - -- all the *Infos herein are instances of it - - -- component "id infos"; also abstract: - ArityInfo, - mkArityInfo, unknownArity, arityMaybe, - - DemandInfo, - mkDemandInfo, - willBeDemanded, - - SpecEnv, SpecInfo(..), - nullSpecEnv, mkSpecEnv, addOneToSpecEnv, - lookupSpecId, lookupSpecEnv, lookupConstMethodId, - - SrcLoc, - getSrcLocIdInfo, - - StrictnessInfo(..), -- non-abstract - Demand(..), -- non-abstract - wwLazy, wwStrict, wwUnpack, wwPrim, wwEnum, ---UNUSED: isStrict, absentArg, - indicatesWorker, nonAbsentArgs, - mkStrictnessInfo, mkBottomStrictnessInfo, - getWrapperArgTypeCategories, - getWorkerId, - workerExists, - bottomIsGuaranteed, - - UnfoldingDetails(..), -- non-abstract! re-exported - UnfoldingGuidance(..), -- non-abstract; ditto - mkUnfolding, ---OLD: mkUnfolding_NoGuideGiven, -- a convenient interface; for imported things only - iWantToBeINLINEd, mkMagicUnfolding, ---UNUSED: haveUnfolding, - noInfo_UF, getInfo_UF, addInfo_UF, -- to avoid instance virus ---UNUSED: clearInfo_UF, - - UpdateInfo, - mkUpdateInfo, - UpdateSpec(..), - updateInfoMaybe, - - DeforestInfo(..), - - ArgUsageInfo, - ArgUsage(..), - ArgUsageType(..), - mkArgUsageInfo, - getArgUsage, - - FBTypeInfo, - FBType(..), - FBConsum(..), - FBProd(..), - mkFBTypeInfo, - getFBType, - - -- and to make the interface self-sufficient... - Bag, BasicLit, BinderInfo, CoreAtom, CoreExpr, Id, - IdEnv(..), UniqFM, Unique, IdVal, FormSummary, - InstTemplate, MagicUnfoldingFun, Maybe, UniType, UniqSM(..), - SimplifiableBinder(..), SimplifiableCoreExpr(..), - PlainCoreExpr(..), PlainCoreAtom(..), PprStyle, Pretty(..), - PrettyRep, UniqueSupply, InExpr(..), OutAtom(..), OutExpr(..), - OutId(..), Subst - - -- and to make sure pragmas work... - IF_ATTACK_PRAGMAS(COMMA mkUnknownSrcLoc) - ) where + IdInfo, -- Abstract -IMPORT_Trace -- ToDo: rm (debugging) + vanillaIdInfo, constantIdInfo, mkIdInfo, seqIdInfo, megaSeqIdInfo, -import AbsPrel ( mkFunTy, nilDataCon{-HACK-} - IF_ATTACK_PRAGMAS(COMMA tagOf_PrimOp) - IF_ATTACK_PRAGMAS(COMMA pprPrimOp) - ) -import AbsUniType -import Bag ( emptyBag, Bag ) -import CmdLineOpts ( GlobalSwitch(..) ) -import Id ( getIdUniType, getDataConSig, - getInstantiatedDataConSig, getIdInfo, - externallyVisibleId, isDataCon, - unfoldingUnfriendlyId, isWorkerId, - isWrapperId, DataCon(..) - IF_ATTACK_PRAGMAS(COMMA applyTypeEnvToId) - IF_ATTACK_PRAGMAS(COMMA getIdStrictness) -- profiling - ) -import IdEnv -- ( nullIdEnv, lookupIdEnv ) -import Inst ( apply_to_Inst, applySubstToInst, Inst ) -import MagicUFs -import Maybes -import Outputable -import PlainCore -import Pretty -import SimplEnv -- UnfoldingDetails(..), UnfoldingGuidance(..) -import SrcLoc -import Subst ( applySubstToTy, Subst ) -import OccurAnal ( occurAnalyseGlobalExpr ) -import TaggedCore -- SimplifiableCore* ... -import Unique -import Util -import WwLib ( mAX_WORKER_ARGS ) -\end{code} + -- Zapping + zapLamInfo, zapDemandInfo, + zapSpecPragInfo, shortableIdInfo, copyIdInfo, -An @IdInfo@ gives {\em optional} information about an @Id@. If -present it never lies, but it may not be present, in which case there -is always a conservative assumption which can be made. + -- Flavour + IdFlavour(..), flavourInfo, makeConstantFlavour, + setNoDiscardInfo, setFlavourInfo, + ppFlavourInfo, -Two @Id@s may have different info even though they have the same -@Unique@ (and are hence the same @Id@); for example, one might lack -the properties attached to the other. + -- Arity + ArityInfo(..), + exactArity, atLeastArity, unknownArity, hasArity, + arityInfo, setArityInfo, ppArityInfo, arityLowerBound, -The @IdInfo@ gives information about the value, or definition, of the -@Id@. It does {\em not} contain information about the @Id@'s usage -(except for @DemandInfo@? ToDo). + -- Strictness; imported from Demand + StrictnessInfo(..), + mkStrictnessInfo, noStrictnessInfo, + ppStrictnessInfo,isBottomingStrictness, + strictnessInfo, setStrictnessInfo, -\begin{code} -data IdInfo - = IdInfo - ArityInfo -- Its arity + -- Usage generalisation + TyGenInfo(..), + tyGenInfo, setTyGenInfo, + noTyGenInfo, isNoTyGenInfo, ppTyGenInfo, tyGenInfoString, - DemandInfo -- Whether or not it is definitely - -- demanded + -- Worker + WorkerInfo(..), workerExists, wrapperArity, workerId, + workerInfo, setWorkerInfo, ppWorkerInfo, - SpecEnv -- Specialisations of this function which exist + -- Unfolding + unfoldingInfo, setUnfoldingInfo, - StrictnessInfo -- Strictness properties, notably - -- how to conjure up "worker" functions + -- DemandInfo + demandInfo, setDemandInfo, - UnfoldingDetails -- Its unfolding; for locally-defined - -- things, this can *only* be NoUnfoldingDetails - -- or IWantToBeINLINEd (i.e., INLINE pragma). + -- Inline prags + InlinePragInfo(..), + inlinePragInfo, setInlinePragInfo, pprInlinePragInfo, + isNeverInlinePrag, neverInlinePrag, - UpdateInfo -- Which args should be updated + -- Occurrence info + OccInfo(..), isFragileOcc, isDeadOcc, isLoopBreaker, + InsideLam, OneBranch, insideLam, notInsideLam, oneBranch, notOneBranch, + occInfo, setOccInfo, - DeforestInfo -- Whether its definition should be - -- unfolded during deforestation + -- Specialisation + specInfo, setSpecInfo, - ArgUsageInfo -- how this Id uses its arguments + -- CAF info + CafInfo(..), cafInfo, setCafInfo, mayHaveCafRefs, ppCafInfo, - FBTypeInfo -- the Foldr/Build W/W property of this function. + -- Constructed Product Result Info + CprInfo(..), cprInfo, setCprInfo, ppCprInfo, noCprInfo, - SrcLoc -- Source location of definition + -- Lambda-bound variable info + LBVarInfo(..), lbvarInfo, setLBVarInfo, noLBVarInfo, hasNoLBVarInfo + ) where - -- ToDo: SrcLoc is in FullNames too (could rm?) but it - -- is needed here too for things like ConstMethodIds and the - -- like, which don't have full-names of their own Mind you, - -- perhaps the FullName for a constant method could give the - -- class/type involved? -\end{code} +#include "HsVersions.h" -\begin{code} -noIdInfo = IdInfo noInfo noInfo noInfo noInfo noInfo_UF - noInfo noInfo noInfo noInfo mkUnknownSrcLoc - --- "boring" means: nothing to put an interface -boringIdInfo (IdInfo UnknownArity - UnknownDemand - nullSpecEnv - strictness - unfolding - NoUpdateInfo - Don'tDeforest - _ {- arg_usage: currently no interface effect -} - _ {- no f/b w/w -} - _ {- src_loc: no effect on interfaces-}) - | boring_strictness strictness - && boring_unfolding unfolding - = True - where - boring_strictness NoStrictnessInfo = True - boring_strictness BottomGuaranteed = False - boring_strictness (StrictnessInfo wrap_args _) = all_present_WwLazies wrap_args - boring_unfolding NoUnfoldingDetails = True - boring_unfolding _ = False +import CoreSyn +import Type ( Type, usOnce ) +import PrimOp ( PrimOp ) +import Var ( Id ) +import BasicTypes ( OccInfo(..), isFragileOcc, isDeadOcc, seqOccInfo, isLoopBreaker, + InsideLam, insideLam, notInsideLam, + OneBranch, oneBranch, notOneBranch, + Arity + ) +import DataCon ( DataCon ) +import FieldLabel ( FieldLabel ) +import Type ( usOnce, usMany ) +import Demand -- Lots of stuff +import Outputable +import Util ( seqList ) + +infixl 1 `setDemandInfo`, + `setTyGenInfo`, + `setStrictnessInfo`, + `setSpecInfo`, + `setArityInfo`, + `setInlinePragInfo`, + `setUnfoldingInfo`, + `setCprInfo`, + `setWorkerInfo`, + `setLBVarInfo`, + `setCafInfo`, + `setOccInfo` + -- infixl so you can say (id `set` a `set` b) +\end{code} -boringIdInfo _ = False +An @IdInfo@ gives {\em optional} information about an @Id@. If +present it never lies, but it may not be present, in which case there +is always a conservative assumption which can be made. -pp_NONE = ppPStr SLIT("_N_") -\end{code} + There is one exception: the 'flavour' is *not* optional. + You must not discard it. + It used to be in Var.lhs, but that seems unclean. -Simply turgid. But BE CAREFUL: don't @apply_to_Id@ if that @Id@ -will in turn @apply_to_IdInfo@ of the self-same @IdInfo@. (A very -nasty loop, friends...) -\begin{code} -apply_to_IdInfo ty_fn - (IdInfo arity demand spec strictness unfold update deforest arg_usage fb_ww srcloc) - = let - new_spec = apply_spec spec - - -- NOT a good idea: - -- apply_strict strictness `thenLft` \ new_strict -> - -- apply_wrap wrap `thenLft` \ new_wrap -> - in - IdInfo arity demand - new_spec strictness unfold - update deforest arg_usage fb_ww srcloc - where - apply_spec (SpecEnv is) - = SpecEnv (map do_one is) - where - do_one (SpecInfo ty_maybes ds spec_id) - = --apply_to_Id ty_fn spec_id `thenLft` \ new_spec_id -> - SpecInfo (map apply_to_maybe ty_maybes) ds spec_id - where - apply_to_maybe Nothing = Nothing - apply_to_maybe (Just ty) = Just (ty_fn ty) - -{- NOT a good idea; - apply_strict info@NoStrictnessInfo = returnLft info - apply_strict BottomGuaranteed = ??? - apply_strict (StrictnessInfo wrap_arg_info id_maybe) - = (case id_maybe of - Nothing -> returnLft Nothing - Just xx -> applySubstToId subst xx `thenLft` \ new_xx -> - returnLft (Just new_xx) - ) `thenLft` \ new_id_maybe -> - returnLft (StrictnessInfo wrap_arg_info new_id_maybe) --} -\end{code} +Two @Id@s may have different info even though they have the same +@Unique@ (and are hence the same @Id@); for example, one might lack +the properties attached to the other. -Variant of the same thing for the typechecker. -\begin{code} -applySubstToIdInfo s0 - (IdInfo arity demand spec strictness unfold update deforest arg_usage fb_ww srcloc) - = case (apply_spec s0 spec) of { (s1, new_spec) -> - (s1, IdInfo arity demand new_spec strictness unfold update deforest arg_usage fb_ww srcloc) } - where - apply_spec s0 (SpecEnv is) - = case (mapAccumL do_one s0 is) of { (s1, new_is) -> - (s1, SpecEnv new_is) } - where - do_one s0 (SpecInfo ty_maybes ds spec_id) - = case (mapAccumL apply_to_maybe s0 ty_maybes) of { (s1, new_maybes) -> - (s1, SpecInfo new_maybes ds spec_id) } - where - apply_to_maybe s0 Nothing = (s0, Nothing) - apply_to_maybe s0 (Just ty) - = case (applySubstToTy s0 ty) of { (s1, new_ty) -> - (s1, Just new_ty) } -\end{code} +The @IdInfo@ gives information about the value, or definition, of the +@Id@. It does {\em not} contain information about the @Id@'s usage +(except for @DemandInfo@? ToDo). (@lbvarInfo@ is also a marginal +case. KSW 1999-04). \begin{code} -ppIdInfo :: PprStyle - -> Id -- The Id for which we're printing this IdInfo - -> Bool -- True <=> print specialisations, please - -> (Id -> Id) -- to look up "better Ids" w/ better IdInfos; - -> IdEnv UnfoldingDetails - -- inlining info for top-level fns in this module - -> IdInfo -- see MkIface notes - -> Pretty - -ppIdInfo sty for_this_id specs_please better_id_fn inline_env - i@(IdInfo arity demand specialise strictness unfold update deforest arg_usage fbtype srcloc) - | boringIdInfo i - = ppPStr SLIT("_NI_") +data IdInfo + = IdInfo { + flavourInfo :: IdFlavour, -- NOT OPTIONAL + arityInfo :: ArityInfo, -- Its arity + demandInfo :: 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 + workerInfo :: WorkerInfo, -- Pointer to Worker Function + unfoldingInfo :: Unfolding, -- Its unfolding + cafInfo :: CafInfo, -- whether it refers (indirectly) to any CAFs + 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 + } + +seqIdInfo :: IdInfo -> () +seqIdInfo (IdInfo {}) = () + +megaSeqIdInfo :: IdInfo -> () +megaSeqIdInfo info + = seqFlavour (flavourInfo info) `seq` + seqArity (arityInfo info) `seq` + seqDemand (demandInfo info) `seq` + seqRules (specInfo info) `seq` + seqTyGenInfo (tyGenInfo info) `seq` + seqStrictnessInfo (strictnessInfo info) `seq` + seqWorker (workerInfo info) `seq` + +-- seqUnfolding (unfoldingInfo info) `seq` +-- Omitting this improves runtimes a little, presumably because +-- some unfoldings are not calculated at all + + seqCaf (cafInfo info) `seq` + seqCpr (cprInfo info) `seq` + seqLBVar (lbvarInfo info) `seq` + seqOccInfo (occInfo info) +\end{code} + +Setters + +\begin{code} +setFlavourInfo info fl = fl `seq` info { flavourInfo = fl } +setWorkerInfo info wk = wk `seq` info { workerInfo = wk } +setSpecInfo info sp = PSEQ sp (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 } +setStrictnessInfo info st = st `seq` info { strictnessInfo = st } + -- Try to avoid spack leaks by seq'ing + +setUnfoldingInfo info uf + | isEvaldUnfolding uf && isStrict (demandInfo info) + -- If the unfolding is a value, the demand info may + -- go pear-shaped, so we nuke it. Example: + -- let x = (a,b) in + -- case x of (p,q) -> h p q x + -- Here x is certainly demanded. But after we've nuked + -- the case, we'll get just + -- 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 } | otherwise - = let - stuff = ppCat [ - -- order is important!: - ppInfo sty better_id_fn arity, - ppInfo sty better_id_fn update, - ppInfo sty better_id_fn deforest, - pp_strictness sty (Just for_this_id) - better_id_fn inline_env strictness, - pp_unfolding sty for_this_id inline_env unfold, - if specs_please - then pp_specs sty (not (isDataCon for_this_id)) - better_id_fn inline_env specialise - else pp_NONE, - - -- DemandInfo needn't be printed since it has no effect on interfaces - ppInfo sty better_id_fn demand, - ppInfo sty better_id_fn fbtype - ] - in - case sty of - PprInterface sw_chker -> if sw_chker OmitInterfacePragmas - then ppNil - else stuff - _ -> stuff + -- We do *not* seq on the unfolding info, For some reason, doing so + -- actually increases residency significantly. + = info { unfoldingInfo = uf } + +setDemandInfo info dd = info { demandInfo = dd } +setArityInfo info ar = info { arityInfo = ar } +setCafInfo info cf = info { cafInfo = cf } +setCprInfo info cp = info { cprInfo = cp } +setLBVarInfo info lb = info { lbvarInfo = lb } + +setNoDiscardInfo info = case flavourInfo info of + VanillaId -> info { flavourInfo = ExportedId } + other -> info +zapSpecPragInfo info = case flavourInfo info of + SpecPragmaId -> info { flavourInfo = VanillaId } + other -> info +\end{code} + + +\begin{code} +vanillaIdInfo :: IdInfo + -- Used for locally-defined Ids + -- We are going to calculate correct CAF information at the end +vanillaIdInfo = mkIdInfo VanillaId NoCafRefs + +constantIdInfo :: IdInfo + -- Used for imported Ids + -- The default is that they *do* have CAFs; an interface-file pragma + -- may say "oh no it doesn't", but in the absence of such a pragma + -- we'd better assume it does +constantIdInfo = mkIdInfo ConstantId MayHaveCafRefs + +mkIdInfo :: IdFlavour -> CafInfo -> IdInfo +mkIdInfo flv caf + = IdInfo { + flavourInfo = flv, + cafInfo = caf, + arityInfo = UnknownArity, + demandInfo = wwLazy, + specInfo = emptyCoreRules, + tyGenInfo = noTyGenInfo, + workerInfo = NoWorker, + strictnessInfo = NoStrictnessInfo, + unfoldingInfo = noUnfolding, + cprInfo = NoCPRInfo, + lbvarInfo = NoLBVarInfo, + inlinePragInfo = NoInlinePragInfo, + occInfo = NoOccInfo + } \end{code} -\begin{code} -{- OLD: -pp_info_op :: String -> Pretty -- like pprNonOp - -pp_info_op name - = if isAvarop name || isAconop name - then ppBesides [ppLparen, ppStr name, ppRparen] - else ppStr name --} -\end{code} %************************************************************************ %* * -\subsection[OptIdInfo-class]{The @OptIdInfo@ class (keeps things tidier)} +\subsection{Flavour} %* * %************************************************************************ \begin{code} -class OptIdInfo a where - noInfo :: a - getInfo :: IdInfo -> a - addInfo :: IdInfo -> a -> IdInfo - -- By default, "addInfo" will not overwrite - -- "info" with "non-info"; look at any instance - -- to see an example. - ppInfo :: PprStyle -> (Id -> Id) -> a -> Pretty -\end{code} +data IdFlavour + = VanillaId -- Locally defined, not exported + | ExportedId -- Locally defined, exported + | SpecPragmaId -- Locally defined, RHS holds specialised call + + | ConstantId -- Imported from elsewhere, or a default method Id. + + | DictFunId -- We flag dictionary functions so that we can + -- conveniently extract the DictFuns from a set of + -- bindings when building a module's interface + + | DataConId DataCon -- The Id for a data constructor *worker* + | DataConWrapId DataCon -- The Id for a data constructor *wrapper* + -- [the only reasons we need to know is so that + -- a) we can suppress printing a definition in the interface file + -- b) when typechecking a pattern we can get from the + -- Id back to the data con] + | PrimOpId PrimOp -- The Id for a primitive operator + | RecordSelId FieldLabel -- The Id for a record selector + + +makeConstantFlavour :: IdFlavour -> IdFlavour +makeConstantFlavour flavour = new_flavour + where new_flavour = case flavour of + VanillaId -> ConstantId + ExportedId -> ConstantId + ConstantId -> ConstantId -- e.g. Default methods + DictFunId -> DictFunId + flavour -> pprTrace "makeConstantFlavour" + (ppFlavourInfo flavour) + flavour + + +ppFlavourInfo :: IdFlavour -> SDoc +ppFlavourInfo VanillaId = empty +ppFlavourInfo ExportedId = ptext SLIT("[Exported]") +ppFlavourInfo SpecPragmaId = ptext SLIT("[SpecPrag]") +ppFlavourInfo ConstantId = ptext SLIT("[Constant]") +ppFlavourInfo DictFunId = ptext SLIT("[DictFun]") +ppFlavourInfo (DataConId _) = ptext SLIT("[DataCon]") +ppFlavourInfo (DataConWrapId _) = ptext SLIT("[DataConWrapper]") +ppFlavourInfo (PrimOpId _) = ptext SLIT("[PrimOp]") +ppFlavourInfo (RecordSelId _) = ptext SLIT("[RecSel]") + +seqFlavour :: IdFlavour -> () +seqFlavour f = f `seq` () +\end{code} + +The @SpecPragmaId@ exists only to make Ids that are +on the *LHS* of bindings created by SPECIALISE pragmas; +eg: s = f Int d +The SpecPragmaId is never itself mentioned; it +exists solely so that the specialiser will find +the call to f, and make specialised version of it. +The SpecPragmaId binding is discarded by the specialiser +when it gathers up overloaded calls. +Meanwhile, it is not discarded as dead code. -%************************************************************************ -%* * -\subsection[srcloc-IdInfo]{Source-location info in an @IdInfo@} -%* * -%************************************************************************ - -Not used much, but... -\begin{code} -getSrcLocIdInfo (IdInfo _ _ _ _ _ _ _ _ _ src_loc) = src_loc -\end{code} %************************************************************************ %* * @@ -347,826 +312,449 @@ getSrcLocIdInfo (IdInfo _ _ _ _ _ _ _ _ _ src_loc) = src_loc %* * %************************************************************************ -\begin{code} -data ArityInfo - = UnknownArity -- no idea - | ArityExactly Int -- arity is exactly this -\end{code} +For locally-defined Ids, the code generator maintains its own notion +of their arities; so it should not be asking... (but other things +besides the code-generator need arity info!) \begin{code} -mkArityInfo = ArityExactly -unknownArity = UnknownArity - -arityMaybe :: ArityInfo -> Maybe Int - -arityMaybe UnknownArity = Nothing -arityMaybe (ArityExactly i) = Just i -\end{code} - -\begin{code} -instance OptIdInfo ArityInfo where - noInfo = UnknownArity - - getInfo (IdInfo arity _ _ _ _ _ _ _ _ _) = arity - - addInfo id_info UnknownArity = id_info - addInfo (IdInfo _ a c d e f g h i j) arity = IdInfo arity a c d e f g h i j +data ArityInfo + = UnknownArity -- No idea - ppInfo sty _ UnknownArity = ifPprInterface sty pp_NONE - ppInfo sty _ (ArityExactly arity) = ppCat [ppPStr SLIT("_A_"), ppInt arity] -\end{code} + | 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. -%************************************************************************ -%* * -\subsection[demand-IdInfo]{Demand info about an @Id@} -%* * -%************************************************************************ + | 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. -Whether a value is certain to be demanded or not. (This is the -information that is computed by the ``front-end'' of the strictness -analyser.) + -- 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 ) -This information is only used within a module, it is not exported -(obviously). +seqArity :: ArityInfo -> () +seqArity a = arityLowerBound a `seq` () -\begin{code} -data DemandInfo - = UnknownDemand - | DemandedAsPer Demand -\end{code} +exactArity = ArityExactly +atLeastArity = ArityAtLeast +unknownArity = UnknownArity -\begin{code} -mkDemandInfo :: Demand -> DemandInfo -mkDemandInfo demand = DemandedAsPer demand +arityLowerBound :: ArityInfo -> Arity +arityLowerBound UnknownArity = 0 +arityLowerBound (ArityAtLeast n) = n +arityLowerBound (ArityExactly n) = n -willBeDemanded :: DemandInfo -> Bool -willBeDemanded (DemandedAsPer demand) = isStrict demand -willBeDemanded _ = False -\end{code} +hasArity :: ArityInfo -> Bool +hasArity UnknownArity = False +hasArity other = True -\begin{code} -instance OptIdInfo DemandInfo where - noInfo = UnknownDemand - - getInfo (IdInfo _ demand _ _ _ _ _ _ _ _) = demand - -{- DELETED! If this line is in, there is no way to - nuke a DemandInfo, and we have to be able to do that - when floating let-bindings around - addInfo id_info UnknownDemand = id_info --} - addInfo (IdInfo a _ c d e f g h i j) demand = IdInfo a demand c d e f g h i j - - ppInfo (PprInterface _) _ _ = ppNil - ppInfo sty _ UnknownDemand = ppStr "{-# L #-}" - ppInfo sty _ (DemandedAsPer info) - = ppCat [ppStr "{-#", ppStr (showList [info] ""), ppStr "#-}"] +ppArityInfo UnknownArity = empty +ppArityInfo (ArityExactly arity) = hsep [ptext SLIT("__A"), int arity] +ppArityInfo (ArityAtLeast arity) = hsep [ptext SLIT("__AL"), int arity] \end{code} %************************************************************************ %* * -\subsection[specialisation-IdInfo]{Specialisation info about an @Id@} +\subsection{Inline-pragma information} %* * %************************************************************************ -The details of one specialisation, held in an @Id@'s -@SpecEnv@ are as follows: \begin{code} -data SpecInfo - = SpecInfo [Maybe UniType] -- Instance types; no free type variables in here - Int -- No. of dictionaries to eat - Id -- Specialised version -\end{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 -For example, if \tr{f} has this @SpecInfo@: -\begin{verbatim} - SpecInfo [Just t1, Nothing, Just t3] 2 f' -\end{verbatim} -then -\begin{verbatim} - f t1 t2 t3 d1 d2 ===> f t2 -\end{verbatim} -The \tr{Nothings} identify type arguments in which the specialised -version is polymorphic. + -- SEE COMMENTS WITH CoreUnfold.blackListed on the + -- exact significance of the IMustNotBeINLINEd pragma -\begin{code} -data SpecEnv = SpecEnv [SpecInfo] - -mkSpecEnv = SpecEnv -nullSpecEnv = SpecEnv [] -addOneToSpecEnv (SpecEnv xs) x = SpecEnv (x : xs) - -lookupConstMethodId :: SpecEnv -> UniType -> Maybe Id - -- slight variant on "lookupSpecEnv" below - -lookupConstMethodId (SpecEnv spec_infos) spec_ty - = firstJust (map try spec_infos) - where - try (SpecInfo (Just ty:nothings) _ const_meth_id) - = ASSERT(all nothing_is_nothing nothings) - case (cmpUniType True{-properly-} ty spec_ty) of - EQ_ -> Just const_meth_id - _ -> Nothing +isNeverInlinePrag :: InlinePragInfo -> Bool +isNeverInlinePrag (IMustNotBeINLINEd _ Nothing) = True +isNeverInlinePrag other = False - nothing_is_nothing Nothing = True -- debugging only - nothing_is_nothing _ = panic "nothing_is_nothing!" +neverInlinePrag :: InlinePragInfo +neverInlinePrag = IMustNotBeINLINEd True{-should be False? --SDM -} Nothing -lookupSpecId :: Id -- *un*specialised Id - -> [Maybe UniType] -- types to which it is to be specialised - -> Id -- specialised Id +instance Outputable InlinePragInfo where + -- This is now parsed in interface files + ppr NoInlinePragInfo = empty + ppr other_prag = ptext SLIT("__U") <> pprInlinePragInfo other_prag -lookupSpecId unspec_id ty_maybes - = case (getInfo (getIdInfo unspec_id)) of { SpecEnv spec_infos -> - - case (firstJust (map try spec_infos)) of - Just id -> id - Nothing -> error ("ERROR: There is some confusion about a value specialised to a type;\ndetails follow (and more info in the User's Guide):\n\t"++(ppShow 80 (ppr PprDebug unspec_id))) - } - where - try (SpecInfo template_maybes _ id) - | and (zipWith same template_maybes ty_maybes) - && length template_maybes == length ty_maybes = Just id - | otherwise = Nothing - - same Nothing Nothing = True - same (Just ty1) (Just ty2) = ty1 == ty2 - same _ _ = False - -lookupSpecEnv :: SpecEnv - -> [UniType] - -> Maybe (Id, - [UniType], - Int) - -lookupSpecEnv (SpecEnv []) _ = Nothing -- rather common case - -lookupSpecEnv spec_env [] = Nothing -- another common case - - -- This can happen even if there is a non-empty spec_env, because - -- of eta reduction. For example, we might have a defn - -- - -- f = /\a -> \d -> g a d - -- which gets transformed to - -- f = g - -- - -- Now g isn't applied to any arguments - -lookupSpecEnv se@(SpecEnv spec_infos) spec_tys - = select_match spec_infos - where - select_match [] -- no matching spec_infos - = Nothing - select_match (SpecInfo ty_maybes toss spec_id : rest) - = case (match ty_maybes spec_tys) of - Nothing -> select_match rest - Just tys_left -> select_next [(spec_id,tys_left,toss)] (length tys_left) toss rest - - -- Ambiguity can only arise as a result of specialisations with - -- an explicit spec_id. The best match is deemed to be the match - -- with least polymorphism i.e. has the least number of tys left. - -- This is a non-critical approximation. The only type arguments - -- where there may be some discretion is for non-overloaded boxed - -- types. Unboxed types must be matched and we insist that we - -- always specialise on overloaded types (and discard all the dicts). - - select_next best _ toss [] - = case best of - [match] -> Just match -- Unique best match - ambig -> pprPanic "Ambiguous Specialisation:\n" - (ppAboves [ppStr "(check specialisations with explicit spec ids)", - ppCat (ppStr "between spec ids:" : - map (ppr PprDebug) [id | (id, _, _) <- ambig]), - pp_stuff]) - - select_next best tnum dnum (SpecInfo ty_maybes toss spec_id : rest) - = ASSERT(dnum == toss) - case (match ty_maybes spec_tys) of - Nothing -> select_next best tnum dnum rest - Just tys_left -> - let tys_len = length tys_left in - case _tagCmp tnum tys_len of - _LT -> select_next [(spec_id,tys_left,toss)] tys_len dnum rest -- better match - _EQ -> select_next ((spec_id,tys_left,toss):best) tnum dnum rest -- equivalent match - _GT -> select_next best tnum dnum rest -- worse match - - - match [{-out of templates-}] [] = Just [] - - match (Nothing:ty_maybes) (spec_ty:spec_tys) - = case (isUnboxedDataType spec_ty) of - True -> Nothing -- Can only match boxed type against - -- type argument which has not been - -- specialised on - False -> case match ty_maybes spec_tys of - Nothing -> Nothing - Just tys -> Just (spec_ty:tys) - - match (Just ty:ty_maybes) (spec_ty:spec_tys) - = case (cmpUniType True{-properly-} ty spec_ty) of - EQ_ -> match ty_maybes spec_tys - other -> Nothing - - match [] _ = pprPanic "lookupSpecEnv1\n" pp_stuff - -- This is a Real Problem - - match _ [] = pprPanic "lookupSpecEnv2\n" pp_stuff - -- Partial eta abstraction might make this happen; - -- meanwhile let's leave in the check - - pp_stuff = ppAbove (pp_specs PprDebug True (\x->x) nullIdEnv se) (ppr PprDebug spec_tys) +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) \end{code} -\begin{code} -instance OptIdInfo SpecEnv where - noInfo = nullSpecEnv - - getInfo (IdInfo _ _ spec _ _ _ _ _ _ _) = spec - - addInfo (IdInfo a b (SpecEnv old_spec) d e f g h i j) (SpecEnv new_spec) - = IdInfo a b (SpecEnv (new_spec ++ old_spec)) d e f g h i j - -- We *add* the new specialisation info rather than just replacing it - -- so that we don't lose old specialisation details. - - ppInfo sty better_id_fn spec_env - = pp_specs sty True better_id_fn nullIdEnv spec_env - -pp_specs sty _ _ _ (SpecEnv []) = pp_NONE -pp_specs sty print_spec_ids better_id_fn inline_env (SpecEnv specs) - = ppBeside (ppPStr SLIT("_SPECIALISE_ ")) (pp_the_list [ - ppCat [ppLbrack, ppIntersperse pp'SP{-'-} (map pp_maybe ty_maybes), ppRbrack, - ppInt numds, - let - better_spec_id = better_id_fn spec_id - spec_id_info = getIdInfo better_spec_id - in - if not print_spec_ids || boringIdInfo spec_id_info then - ppNil - else - ppCat [ppChar '{', - ppIdInfo sty better_spec_id True{-wrkr specs too!-} better_id_fn inline_env spec_id_info, - ppChar '}'] - ] - | (SpecInfo ty_maybes numds spec_id) <- specs ]) - where - pp_the_list [p] = p - pp_the_list (p:ps) = ppBesides [p, pp'SP{-'-}, pp_the_list ps] - - pp_maybe Nothing = ifPprInterface sty pp_NONE - pp_maybe (Just t) = pprParendUniType sty t -\end{code} - %************************************************************************ -%* * -\subsection[strictness-IdInfo]{Strictness info about an @Id@} -%* * +%* * +\subsection[TyGen-IdInfo]{Type generalisation info about an @Id@} +%* * %************************************************************************ -We specify the strictness of a function by giving information about -each of the ``wrapper's'' arguments (see the description about -worker/wrapper-style transformations in the PJ/Launchbury paper on -unboxed types). +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). -The list of @Demands@ specifies: (a)~the strictness properties -of a function's arguments; (b)~the {\em existence} of a ``worker'' -version of the function; and (c)~the type signature of that worker (if -it exists); i.e. its calling convention. +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 StrictnessInfo - = NoStrictnessInfo +data TyGenInfo + = NoTyGenInfo -- no restriction on type generalisation - | BottomGuaranteed -- This Id guarantees never to return; - -- it is bottom regardless of its arguments. - -- Useful for "error" and other disguised - -- variants thereof. + | TyGenUInfo [Maybe Type] -- restrict generalisation of this Id to + -- preserve specified usage annotations - | StrictnessInfo [Demand] -- the main stuff; see below. - (Maybe Id) -- worker's Id, if applicable. -\end{code} + | TyGenNever -- never generalise the type of this Id -This type is also actually used in the strictness analyser: -\begin{code} -data Demand - = WwLazy -- Argument is lazy as far as we know - MaybeAbsent -- (does not imply worker's existence [etc]). - -- If MaybeAbsent == True, then it is - -- *definitely* lazy. (NB: Absence implies - -- a worker...) - - | WwStrict -- Argument is strict but that's all we know - -- (does not imply worker's existence or any - -- calling-convention magic) - - | WwUnpack -- Argument is strict & a single-constructor - [Demand] -- type; its constituent parts (whose StrictInfos - -- are in the list) should be passed - -- as arguments to the worker. - - | WwPrim -- Argument is of primitive type, therefore - -- strict; doesn't imply existence of a worker; - -- argument should be passed as is to worker. - - | WwEnum -- Argument is strict & an enumeration type; - -- an Int# representing the tag (start counting - -- at zero) should be passed to the worker. - deriving (Eq, Ord) - -- we need Eq/Ord to cross-chk update infos in interfaces - -type MaybeAbsent = Bool -- True <=> not even used - --- versions that don't worry about Absence: -wwLazy = WwLazy False -wwStrict = WwStrict -wwUnpack xs = WwUnpack xs -wwPrim = WwPrim -wwEnum = WwEnum + deriving ( Eq ) \end{code} -\begin{code} -mkStrictnessInfo :: [Demand] -> Maybe Id -> StrictnessInfo - -mkStrictnessInfo [] _ = NoStrictnessInfo -mkStrictnessInfo xs wrkr = StrictnessInfo xs wrkr +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. -mkBottomStrictnessInfo = BottomGuaranteed +\begin{code} +seqTyGenInfo :: TyGenInfo -> () +seqTyGenInfo NoTyGenInfo = () +seqTyGenInfo (TyGenUInfo us) = seqList us () +seqTyGenInfo TyGenNever = () -bottomIsGuaranteed BottomGuaranteed = True -bottomIsGuaranteed other = False +noTyGenInfo :: TyGenInfo +noTyGenInfo = NoTyGenInfo -getWrapperArgTypeCategories - :: UniType -- wrapper's type - -> StrictnessInfo -- strictness info about its args - -> Maybe String +isNoTyGenInfo :: TyGenInfo -> Bool +isNoTyGenInfo NoTyGenInfo = True +isNoTyGenInfo _ = False -getWrapperArgTypeCategories _ NoStrictnessInfo = Nothing -getWrapperArgTypeCategories _ BottomGuaranteed - = trace "getWrapperArgTypeCategories:BottomGuaranteed!" Nothing -- wrong -getWrapperArgTypeCategories _ (StrictnessInfo [] _) = Nothing +-- 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. -getWrapperArgTypeCategories ty (StrictnessInfo arg_info _) - = Just (mkWrapperArgTypeCategories ty arg_info) +ppTyGenInfo :: TyGenInfo -> SDoc +ppTyGenInfo NoTyGenInfo = empty +ppTyGenInfo (TyGenUInfo us) = ptext SLIT("__G") <+> text (tyGenInfoString us) +ppTyGenInfo TyGenNever = ptext SLIT("__G N") -workerExists :: StrictnessInfo -> Bool -workerExists (StrictnessInfo _ (Just worker_id)) = True -workerExists other = False +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. + go other = pprPanic "IdInfo.tyGenInfoString: unexpected annotation" (ppr other) -getWorkerId :: StrictnessInfo -> Id +instance Outputable TyGenInfo where + ppr = ppTyGenInfo -getWorkerId (StrictnessInfo _ (Just worker_id)) = worker_id -#ifdef DEBUG -getWorkerId junk = pprPanic "getWorkerId: Nothing" (ppInfo PprDebug (\x->x) junk) -#endif +instance Show TyGenInfo where + showsPrec p c = showsPrecSDoc p (ppr c) \end{code} -\begin{code} -isStrict :: Demand -> Bool - -isStrict WwStrict = True -isStrict (WwUnpack _) = True -isStrict WwPrim = True -isStrict WwEnum = True -isStrict _ = False -{- UNUSED: -absentArg :: Demand -> Bool +%************************************************************************ +%* * +\subsection[worker-IdInfo]{Worker info about an @Id@} +%* * +%************************************************************************ -absentArg (WwLazy absentp) = absentp -absentArg other = False --} +If this Id has a worker then we store a reference to it. Worker +functions are generated by the worker/wrapper pass. This uses +information from the strictness and CPR analyses. -nonAbsentArgs :: [Demand] -> Int +There might not be a worker, even for a strict function, because: +(a) the function might be small enough to inline, so no need + for w/w split +(b) the strictness info might be "SSS" or something, so no w/w split. -nonAbsentArgs cmpts - = foldr tick_non 0 cmpts - where - tick_non (WwLazy True) acc = acc - tick_non other acc = acc + 1 +\begin{code} -all_present_WwLazies :: [Demand] -> Bool -all_present_WwLazies infos - = and (map is_L infos) - where - is_L (WwLazy False) = True -- False <=> "Absent" args do *not* count! - is_L _ = False -- (as they imply a worker) -\end{code} +data WorkerInfo = NoWorker + | HasWorker Id Arity + -- The Arity is the arity of the *wrapper* at the moment of the + -- w/w split. See comments in MkIface.ifaceId, with the 'Worker' code. -WDP 95/04: It is no longer enough to look at a list of @Demands@ for -an ``Unpack'' or an ``Absent'' and declare a worker. We also have to -check that @mAX_WORKER_ARGS@ hasn't been exceeded. Therefore, -@indicatesWorker@ mirrors the process used in @mk_ww_arg_processing@ -in \tr{WwLib.lhs}. A worker is ``indicated'' when we hit an Unpack -or an Absent {\em that we accept}. -\begin{code} -indicatesWorker :: [Demand] -> Bool +seqWorker :: WorkerInfo -> () +seqWorker (HasWorker id _) = id `seq` () +seqWorker NoWorker = () -indicatesWorker dems - = fake_mk_ww (mAX_WORKER_ARGS - nonAbsentArgs dems) dems - where - fake_mk_ww _ [] = False - fake_mk_ww _ (WwLazy True : _) = True -- we accepted an Absent - fake_mk_ww extra_args (WwUnpack cmpnts : dems) - | extra_args_now > 0 = True -- we accepted an Unpack - where - extra_args_now = extra_args + 1 - nonAbsentArgs cmpnts - - fake_mk_ww extra_args (_ : dems) - = fake_mk_ww extra_args dems -\end{code} +ppWorkerInfo NoWorker = empty +ppWorkerInfo (HasWorker wk_id _) = ptext SLIT("__P") <+> ppr wk_id -\begin{code} -mkWrapperArgTypeCategories - :: UniType -- wrapper's type - -> [Demand] -- info about its arguments - -> String -- a string saying lots about the args - -mkWrapperArgTypeCategories wrapper_ty wrap_info - = case (splitTypeWithDictsAsArgs wrapper_ty) of { (_,arg_tys,_) -> - map do_one (wrap_info `zip` (map showTypeCategory arg_tys)) - } - where - -- ToDo: this needs FIXING UP (it was a hack anyway...) - do_one (WwPrim, _) = 'P' - do_one (WwEnum, _) = 'E' - do_one (WwStrict, arg_ty_char) = arg_ty_char - do_one (WwUnpack _, arg_ty_char) - = if arg_ty_char `elem` "CIJFDTS" - then toLower arg_ty_char - else if arg_ty_char == '+' then 't' - else trace ("mkWrapp..:funny char:"++[arg_ty_char]) '-' - do_one (other_wrap_info, _) = '-' -\end{code} +noWorkerInfo = NoWorker -Whether a worker exists depends on whether the worker has an -absent argument, a @WwUnpack@ argument, (or @WwEnum@ ToDo???) arguments. +workerExists :: WorkerInfo -> Bool +workerExists NoWorker = False +workerExists (HasWorker _ _) = True -If a @WwUnpack@ argument is for an {\em abstract} type (or one that -will be abstract outside this module), which might happen for an -imported function, then we can't (or don't want to...) unpack the arg -as the worker requires. Hence we have to give up altogether, and call -the wrapper only; so under these circumstances we return \tr{False}. +workerId :: WorkerInfo -> Id +workerId (HasWorker id _) = id -\begin{code} -instance Text Demand where - readList str = read_em [{-acc-}] str - where - read_em acc [] = [(reverse acc, "")] - -- lower case indicates absence... - read_em acc ('L' : xs) = read_em (WwLazy False : acc) xs - read_em acc ('A' : xs) = read_em (WwLazy True : acc) xs - read_em acc ('S' : xs) = read_em (WwStrict : acc) xs - read_em acc ('P' : xs) = read_em (WwPrim : acc) xs - read_em acc ('E' : xs) = read_em (WwEnum : acc) xs - - read_em acc (')' : xs) = [(reverse acc, xs)] - read_em acc ( 'U' : '(' : xs) - = case (read_em [] xs) of - [(stuff, rest)] -> read_em (WwUnpack stuff : acc) rest - _ -> panic ("Text.Demand:"++str++"::"++xs) - - read_em acc other = panic ("IdInfo.readem:"++other) - - showList wrap_args rest = (concat (map show1 wrap_args)) ++ rest - where - show1 (WwLazy False) = "L" - show1 (WwLazy True) = "A" - show1 WwStrict = "S" - show1 WwPrim = "P" - show1 WwEnum = "E" - show1 (WwUnpack args)= "U(" ++ (concat (map show1 args)) ++ ")" - -instance Outputable Demand where - ppr sty si = ppStr (showList [si] "") - -instance OptIdInfo StrictnessInfo where - noInfo = NoStrictnessInfo - - getInfo (IdInfo _ _ _ strict _ _ _ _ _ _) = strict - - addInfo id_info NoStrictnessInfo = id_info - addInfo (IdInfo a b d _ e f g h i j) strict = IdInfo a b d strict e f g h i j - - ppInfo sty better_id_fn strictness_info - = pp_strictness sty Nothing better_id_fn nullIdEnv strictness_info +wrapperArity :: WorkerInfo -> Arity +wrapperArity (HasWorker _ a) = a \end{code} -We'll omit the worker info if the thing has an explicit unfolding -already. -\begin{code} -pp_strictness sty _ _ _ NoStrictnessInfo = ifPprInterface sty pp_NONE - -pp_strictness sty _ _ _ BottomGuaranteed = ppPStr SLIT("_S_ _!_") - -pp_strictness sty for_this_id_maybe better_id_fn inline_env - info@(StrictnessInfo wrapper_args wrkr_maybe) - = let - (have_wrkr, wrkr_id) = case wrkr_maybe of - Nothing -> (False, panic "ppInfo(Strictness)") - Just xx -> (True, xx) - - wrkr_to_print = better_id_fn wrkr_id - wrkr_info = getIdInfo wrkr_to_print - - -- if we aren't going to be able to *read* the strictness info - -- in TcPragmas, we need not even print it. - wrapper_args_to_use - = if not (indicatesWorker wrapper_args) then - wrapper_args -- no worker/wrappering in any case - else - case for_this_id_maybe of - Nothing -> wrapper_args - Just id -> if externallyVisibleId id - && (unfoldingUnfriendlyId id || not have_wrkr) then - -- pprTrace "IdInfo: unworker-ising:" (ppCat [ppr PprDebug have_wrkr, ppr PprDebug id]) ( - map un_workerise wrapper_args - -- ) - else - wrapper_args - - id_is_worker - = case for_this_id_maybe of - Nothing -> False - Just id -> isWorkerId id - - am_printing_iface - = case sty of - PprInterface _ -> True - _ -> False - - pp_basic_info - = ppBesides [ppStr "_S_ \"", - ppStr (showList wrapper_args_to_use ""), ppStr "\""] - - pp_with_worker - = ppBesides [ ppSP, ppChar '{', - ppIdInfo sty wrkr_to_print True{-wrkr specs, yes!-} better_id_fn inline_env wrkr_info, - ppChar '}' ] - in - if all_present_WwLazies wrapper_args_to_use then -- too boring - ifPprInterface sty pp_NONE - - else if id_is_worker && am_printing_iface then - pp_NONE -- we don't put worker strictness in interfaces - -- (it can be deduced) - - else if not (indicatesWorker wrapper_args_to_use) - || not have_wrkr - || boringIdInfo wrkr_info then - ppBeside pp_basic_info ppNil - else - ppBeside pp_basic_info pp_with_worker - where - un_workerise (WwLazy _) = WwLazy False -- avoid absence - un_workerise (WwUnpack _) = WwStrict - un_workerise other = other -\end{code} %************************************************************************ %* * -\subsection[unfolding-IdInfo]{Unfolding info about an @Id@} +\subsection[CAF-IdInfo]{CAF-related information} %* * %************************************************************************ -\begin{code} -mkUnfolding :: UnfoldingGuidance -> PlainCoreExpr -> UnfoldingDetails -iWantToBeINLINEd :: UnfoldingGuidance -> UnfoldingDetails -mkMagicUnfolding :: FAST_STRING -> UnfoldingDetails - -mkUnfolding guide expr - = GeneralForm False (mkFormSummary NoStrictnessInfo{-NB:lying-} expr) - (BSCC("OccurExpr") occurAnalyseGlobalExpr expr ESCC) - guide -\end{code} +This information is used to build Static Reference Tables (see +simplStg/ComputeSRT.lhs). \begin{code} -iWantToBeINLINEd guide = IWantToBeINLINEd guide +data CafInfo + = MayHaveCafRefs -- either: + -- (1) A function or static constructor + -- that refers to one or more CAFs, + -- (2) A real live CAF -mkMagicUnfolding tag = MagicForm tag (mkMagicUnfoldingFun tag) + | NoCafRefs -- A function or static constructor + -- that refers to no CAFs. -{- UNUSED: -haveUnfolding NoUnfoldingDetails = False -haveUnfolding (IWantToBeINLINEd _) = False -- don't have the unfolding *YET* -haveUnfolding _ = True --} -\end{code} +-- LATER: not sure how easy this is... +-- | OneCafRef Id -\begin{code} -noInfo_UF = NoUnfoldingDetails -getInfo_UF (IdInfo _ _ _ _ unfolding _ _ _ _ _) = unfolding +mayHaveCafRefs MayHaveCafRefs = True +mayHaveCafRefs _ = False -addInfo_UF id_info@(IdInfo a b c d e f g h i j) NoUnfoldingDetails = id_info -addInfo_UF (IdInfo a b d e xxx f g h i j) uf = IdInfo a b d e uf f g h i j +seqCaf c = c `seq` () ---UNUSED:clearInfo_UF (IdInfo a b d e xxx f g h i j) = IdInfo a b d e noInfo_UF f g h i j +ppCafInfo NoCafRefs = ptext SLIT("__C") +ppCafInfo MayHaveCafRefs = empty \end{code} -\begin{code} -pp_unfolding sty for_this_id inline_env uf_details - = case (lookupIdEnv inline_env for_this_id) of - Nothing -> pp uf_details - Just dt -> pp dt - where - pp NoUnfoldingDetails = pp_NONE - - pp (IWantToBeINLINEd guide) -- not in interfaces - = if isWrapperId for_this_id - then pp_NONE -- wrapper: don't complain or mutter - else ppCat [ppStr "{-IWantToBeINLINEd", ppr sty guide, ppStr "-}", pp_NONE] - - pp (MagicForm tag _) - = ppCat [ppPStr SLIT("_MF_"), ppPStr tag] - - pp (GeneralForm _ _ template guide) - = let - untagged = unTagBinders template - in - if untagged `isWrapperFor` for_this_id - then -- pprTrace "IdInfo:isWrapperFor:" (ppAbove (ppr PprDebug for_this_id) (ppr PprDebug untagged)) - pp_NONE - else ppCat [ppPStr SLIT("_F_"), ppr sty guide, pprCoreUnfolding untagged] - -\end{code} %************************************************************************ %* * -\subsection[update-IdInfo]{Update-analysis info about an @Id@} +\subsection[cpr-IdInfo]{Constructed Product Result info about an @Id@} %* * %************************************************************************ -\begin{code} -data UpdateInfo - = NoUpdateInfo - | SomeUpdateInfo UpdateSpec - deriving (Eq, Ord) - -- we need Eq/Ord to cross-chk update infos in interfaces - --- the form in which we pass update-analysis info between modules: -type UpdateSpec = [Int] -\end{code} +If the @Id@ is a function then it may have CPR info. A CPR analysis +phase detects whether: -\begin{code} -mkUpdateInfo = SomeUpdateInfo +\begin{enumerate} +\item +The function's return value has a product type, i.e. an algebraic type +with a single constructor. Examples of such types are tuples and boxed +primitive values. +\item +The function always 'constructs' the value that it is returning. It +must do this on every path through, and it's OK if it calls another +function which constructs the result. +\end{enumerate} -updateInfoMaybe NoUpdateInfo = Nothing -updateInfoMaybe (SomeUpdateInfo []) = Nothing -updateInfoMaybe (SomeUpdateInfo u) = Just u -\end{code} - -Text instance so that the update annotations can be read in. +If this is the case then we store a template which tells us the +function has the CPR property and which components of the result are +also CPRs. \begin{code} -instance Text UpdateInfo where - readsPrec p s | null s = panic "IdInfo: empty update pragma?!" - | otherwise = [(SomeUpdateInfo (map ok_digit s),"")] - where - ok_digit c | c >= '0' && c <= '2' = ord c - ord '0' - | otherwise = panic "IdInfo: not a digit while reading update pragma" - -instance OptIdInfo UpdateInfo where - noInfo = NoUpdateInfo +data CprInfo + = NoCPRInfo + | ReturnsCPR -- Yes, this function returns a constructed product + -- Implicitly, this means "after the function has been applied + -- to all its arguments", so the worker/wrapper builder in + -- WwLib.mkWWcpr checks that that it is indeed saturated before + -- making use of the CPR info - getInfo (IdInfo _ _ _ _ _ update _ _ _ _) = update - - addInfo id_info NoUpdateInfo = id_info - addInfo (IdInfo a b d e f _ g h i j) upd_info = IdInfo a b d e f upd_info g h i j - - ppInfo sty better_id_fn NoUpdateInfo = ifPprInterface sty pp_NONE - ppInfo sty better_id_fn (SomeUpdateInfo []) = ifPprInterface sty pp_NONE - ppInfo sty better_id_fn (SomeUpdateInfo spec) - = ppBeside (ppPStr SLIT("_U_ ")) (ppBesides (map ppInt spec)) + -- We used to keep nested info about sub-components, but + -- we never used it so I threw it away \end{code} -%************************************************************************ -%* * -\subsection[deforest-IdInfo]{Deforestation info about an @Id@} -%* * -%************************************************************************ - -The deforest info says whether this Id is to be unfolded during -deforestation. Therefore, when the deforest pragma is true, we must -also have the unfolding information available for this Id. - \begin{code} -data DeforestInfo - = Don'tDeforest -- just a bool, might extend this - | DoDeforest -- later. - -- deriving (Eq, Ord) -\end{code} +seqCpr :: CprInfo -> () +seqCpr ReturnsCPR = () +seqCpr NoCPRInfo = () -\begin{code} -instance OptIdInfo DeforestInfo where - noInfo = Don'tDeforest +noCprInfo = NoCPRInfo - getInfo (IdInfo _ _ _ _ _ _ deforest _ _ _) = deforest +ppCprInfo NoCPRInfo = empty +ppCprInfo ReturnsCPR = ptext SLIT("__M") - addInfo id_info Don'tDeforest = id_info - addInfo (IdInfo a b d e f g _ h i j) deforest = - IdInfo a b d e f g deforest h i j +instance Outputable CprInfo where + ppr = ppCprInfo - ppInfo sty better_id_fn Don'tDeforest - = ifPprInterface sty pp_NONE - ppInfo sty better_id_fn DoDeforest - = ppPStr SLIT("_DEFOREST_") +instance Show CprInfo where + showsPrec p c = showsPrecSDoc p (ppr c) \end{code} + %************************************************************************ %* * -\subsection[argUsage-IdInfo]{Argument Usage info about an @Id@} +\subsection[lbvar-IdInfo]{Lambda-bound var info about an @Id@} %* * %************************************************************************ -\begin{code} -data ArgUsageInfo - = NoArgUsageInfo - | SomeArgUsageInfo ArgUsageType - -- ??? deriving (Eq, Ord) - -data ArgUsage = ArgUsage Int -- number of arguments (is linear!) - | UnknownArgUsage -type ArgUsageType = [ArgUsage] -- c_1 -> ... -> BLOB -\end{code} +If the @Id@ is a lambda-bound variable then it may have lambda-bound +var info. The usage analysis (UsageSP) detects whether the lambda +binding this var is a ``one-shot'' lambda; that is, whether it is +applied at most once. + +This information may be useful in optimisation, as computations may +safely be floated inside such a lambda without risk of duplicating +work. \begin{code} -mkArgUsageInfo = SomeArgUsageInfo +data LBVarInfo + = NoLBVarInfo + + | LBVarInfo Type -- The lambda that binds this Id has this usage + -- annotation (i.e., if ==usOnce, then the + -- lambda is applied at most once). + -- The annotation's kind must be `$' + -- HACK ALERT! placing this info here is a short-term hack, + -- but it minimises changes to the rest of the compiler. + -- Hack agreed by SLPJ/KSW 1999-04. -getArgUsage :: ArgUsageInfo -> ArgUsageType -getArgUsage NoArgUsageInfo = [] -getArgUsage (SomeArgUsageInfo u) = u +seqLBVar l = l `seq` () \end{code} \begin{code} -instance OptIdInfo ArgUsageInfo where - noInfo = NoArgUsageInfo +hasNoLBVarInfo NoLBVarInfo = True +hasNoLBVarInfo other = False - getInfo (IdInfo _ _ _ _ _ _ _ au _ _) = au +noLBVarInfo = NoLBVarInfo - addInfo id_info NoArgUsageInfo = id_info - addInfo (IdInfo a b d e f g h _ i j) au_info = IdInfo a b d e f g h au_info i j +-- 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 + = getPprStyle $ \ sty -> + if ifaceStyle sty + then empty + else ptext SLIT("OneShot") + | otherwise + = empty - ppInfo sty better_id_fn NoArgUsageInfo = ifPprInterface sty pp_NONE - ppInfo sty better_id_fn (SomeArgUsageInfo []) = ifPprInterface sty pp_NONE - ppInfo sty better_id_fn (SomeArgUsageInfo aut) - = ppBeside (ppPStr SLIT("_L_ ")) (ppArgUsageType aut) +instance Outputable LBVarInfo where + ppr = pprLBVarInfo +instance Show LBVarInfo where + showsPrec p c = showsPrecSDoc p (ppr c) +\end{code} -ppArgUsage (ArgUsage n) = ppInt n -ppArgUsage (UnknownArgUsage) = ppChar '-' -ppArgUsageType aut = ppBesides - [ ppChar '"' , - ppIntersperse ppComma (map ppArgUsage aut), - ppChar '"' ] -\end{code} %************************************************************************ %* * -\subsection[FBType-IdInfo]{Type of an expression through Foldr/build's eyes} +\subsection{Bulk operations on IdInfo} %* * %************************************************************************ -\begin{code} -data FBTypeInfo - = NoFBTypeInfo - | SomeFBTypeInfo FBType - -- ??? deriving (Eq, Ord) - -data FBType = FBType [FBConsum] FBProd deriving (Eq) - -data FBConsum = FBGoodConsum | FBBadConsum deriving(Eq) -data FBProd = FBGoodProd | FBBadProd deriving(Eq) -\end{code} +@zapLamInfo@ is used for lambda binders that turn out to to be +part of an unsaturated lambda \begin{code} -mkFBTypeInfo = SomeFBTypeInfo - -getFBType :: FBTypeInfo -> Maybe FBType -getFBType NoFBTypeInfo = Nothing -getFBType (SomeFBTypeInfo u) = Just u -\end{code} - -\begin{code} -instance OptIdInfo FBTypeInfo where - noInfo = NoFBTypeInfo - - getInfo (IdInfo _ _ _ _ _ _ _ _ fb _) = fb - - addInfo id_info NoFBTypeInfo = id_info - addInfo (IdInfo a b d e f g h i _ j) fb_info = IdInfo a b d e f g h i fb_info j - - ppInfo (PprInterface _) better_id_fn NoFBTypeInfo = ppNil - ppInfo sty better_id_fn NoFBTypeInfo = ifPprInterface sty pp_NONE - ppInfo sty better_id_fn (SomeFBTypeInfo (FBType cons prod)) - = ppBeside (ppPStr SLIT("_F_ ")) (ppFBType cons prod) - ---ppFBType (FBType n) = ppBesides [ppInt n] ---ppFBType (UnknownFBType) = ppBesides [ppStr "-"] --- - -ppFBType cons prod = ppBesides - ([ ppChar '"' ] ++ map ppCons cons ++ [ ppChar '-', ppProd prod, ppChar '"' ]) +zapLamInfo :: IdInfo -> Maybe IdInfo +zapLamInfo info@(IdInfo {occInfo = occ, demandInfo = demand}) + | is_safe_occ && not (isStrict demand) + = Nothing + | otherwise + = Just (info {occInfo = safe_occ, + demandInfo = wwLazy}) where - ppCons FBGoodConsum = ppChar 'G' - ppCons FBBadConsum = ppChar 'B' - ppProd FBGoodProd = ppChar 'G' - ppProd FBBadProd = ppChar 'B' + -- 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 + + safe_occ = case occ of + OneOcc _ once -> OneOcc insideLam once + other -> occ +\end{code} + +\begin{code} +zapDemandInfo :: IdInfo -> Maybe IdInfo +zapDemandInfo info@(IdInfo {demandInfo = demand}) + | not (isStrict demand) = Nothing + | otherwise = Just (info {demandInfo = wwLazy}) +\end{code} + + +copyIdInfo is used when shorting out a top-level binding + f_local = BIG + f = f_local +where f is exported. We are going to swizzle it around to + f = BIG + f_local = f + +BUT (a) we must be careful about messing up rules + (b) we must ensure f's IdInfo ends up right + +(a) Messing up the rules +~~~~~~~~~~~~~~~~~~~~ +The example that went bad on me was this one: + + iterate :: (a -> a) -> a -> [a] + iterate = iterateList + + iterateFB c f x = x `c` iterateFB c f (f x) + iterateList f x = x : iterateList f (f x) + + {-# RULES + "iterate" forall f x. iterate f x = build (\c _n -> iterateFB c f x) + "iterateFB" iterateFB (:) = iterateList + #-} + +This got shorted out to: + + iterateList :: (a -> a) -> a -> [a] + iterateList = iterate + + iterateFB c f x = x `c` iterateFB c f (f x) + iterate f x = x : iterate f (f x) + + {-# RULES + "iterate" forall f x. iterate f x = build (\c _n -> iterateFB c f x) + "iterateFB" iterateFB (:) = iterate + #-} + +And now we get an infinite loop in the rule system + iterate f x -> build (\cn -> iterateFB c f x + -> iterateFB (:) f x + -> iterate f x + +Tiresome solution: don't do shorting out if f has rewrite rules. +Hence shortableIdInfo. + +(b) Keeping the IdInfo right +~~~~~~~~~~~~~~~~~~~~~~~~ +We want to move strictness/worker info from f_local to f, but keep the rest. +Hence copyIdInfo. + +\begin{code} +shortableIdInfo :: IdInfo -> Bool +shortableIdInfo info = isEmptyCoreRules (specInfo info) + +copyIdInfo :: IdInfo -- f_local + -> IdInfo -- f (the exported one) + -> IdInfo -- New info for f +copyIdInfo f_local f = f { strictnessInfo = strictnessInfo f_local, + workerInfo = workerInfo f_local, + cprInfo = cprInfo f_local + } \end{code}