X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FId.lhs;h=13443a9852ee5e2fb9ebf3f76894d46fe44e2511;hb=db7041f72b7c7d0114e47b7305058fae48fb0ade;hp=9d3028c6a9146d60a25ef0238fa6359203878a70;hpb=30eb950d8588f78d5a6ba77233105e0f3ce2da3b;p=ghc-hetmet.git diff --git a/ghc/compiler/basicTypes/Id.lhs b/ghc/compiler/basicTypes/Id.lhs index 9d3028c..13443a9 100644 --- a/ghc/compiler/basicTypes/Id.lhs +++ b/ghc/compiler/basicTypes/Id.lhs @@ -1,758 +1,467 @@ - -% (c) The GRASP/AQUA Project, Glasgow University, 1992-1996 +% +% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998 % \section[Id]{@Ids@: Value and constructor identifiers} \begin{code} module Id ( - -- TYPES - GenId, -- Abstract - Id, - IdDetails(..), -- Exposed only to MkId - StrictnessMark(..), - ConTag, fIRST_TAG, - DataCon, DictFun, DictVar, - - -- Construction and modification - mkId, mkIdWithNewUniq, mkIdWithNewName, mkIdWithNewType, - mkTemplateLocals, - setIdVisibility, mkVanillaId, - - -- DESTRUCTION (excluding pragmatic info) - idPrimRep, - idType, - idUnique, - idName, - - -- Extracting pieces of particular sorts of Ids - dataConRepType, - dataConArgTys, - dataConNumFields, - dataConFieldLabels, - dataConRawArgTys, - dataConSig, - dataConStrictMarks, - dataConTag, - dataConTyCon, + Id, DictId, + + -- Simple construction + mkId, mkVanillaId, mkSysLocal, mkUserLocal, + mkTemplateLocals, mkTemplateLocalsNum, mkWildId, mkTemplateLocal, + -- Taking an Id apart + idName, idType, idUnique, idInfo, + idPrimRep, isId, recordSelectorFieldLabel, - -- PREDICATES - omitIfaceSigForId, - cmpId, + -- Modifying an Id + setIdName, setIdUnique, setIdType, setIdNoDiscard, + setIdInfo, lazySetIdInfo, modifyIdInfo, maybeModifyIdInfo, + zapFragileIdInfo, zapLamIdInfo, + + -- Predicates + isImplicitId, isDeadBinder, externallyVisibleId, - idHasNoFreeTyVars, - idWantsToBeINLINEd, getInlinePragma, - idMustBeINLINEd, idMustNotBeINLINEd, + isSpecPragmaId, isRecordSelector, + isPrimOpId, isPrimOpId_maybe, isDictFunId, + isDataConId, isDataConId_maybe, + isDataConWrapId, isDataConWrapId_maybe, isBottomingId, - - isDataCon, isAlgCon, isNewCon, isTupleCon, - isNullaryDataCon, - - isRecordSelector, isSpecPragmaId, - isPrimitiveId_maybe, - - -- PRINTING and RENUMBERING - pprId, - showId, - - -- UNFOLDING, ARITY, UPDATE, AND STRICTNESS STUFF (etc) - idInfo, - addIdUnfolding, - addIdArity, - addIdDemandInfo, - addIdStrictness, - addIdUpdateInfo, - getIdArity, - getIdDemandInfo, - getIdStrictness, - getIdUnfolding, - getIdUpdateInfo, - replaceIdInfo, - addInlinePragma, nukeNoInlinePragma, addNoInlinePragma, - getIdSpecialisation, - setIdSpecialisation, - - -- IdEnvs AND IdSets - IdEnv, GenIdSet, IdSet, - addOneToIdEnv, - addOneToIdSet, - combineIdEnvs, - delManyFromIdEnv, - delOneFromIdEnv, - elementOfIdSet, - emptyIdSet, - growIdEnv, - growIdEnvList, - idSetToList, - intersectIdSets, - isEmptyIdSet, - isNullIdEnv, - lookupIdEnv, lookupIdSubst, - lookupNoFailIdEnv, - mapIdEnv, - minusIdSet, - mkIdEnv, elemIdEnv, - mkIdSet, - modifyIdEnv, - modifyIdEnv_Directly, - nullIdEnv, - rngIdEnv, - unionIdSets, - unionManyIdSets, - unitIdEnv, - unitIdSet - ) where - -#include "HsVersions.h" - -import {-# SOURCE #-} CoreUnfold ( Unfolding ) - -import CmdLineOpts ( opt_PprStyle_All ) -import Bag -import IdInfo -import Name ( nameUnique, isLocalName, mkSysLocalName, - isWiredInName, setNameVisibility, changeUnique, - ExportFlag(..), Provenance, - OccName(..), Name, Module, - NamedThing(..) - ) -import PrimOp ( PrimOp ) -import PrelMods ( pREL_TUP, pREL_BASE ) -import FieldLabel ( fieldLabelName, FieldLabel(..) ) -import SrcLoc ( mkBuiltinSrcLoc ) -import TysWiredIn ( tupleTyCon ) -import TyCon ( TyCon, isDataTyCon, isNewTyCon ) -import Type ( mkSigmaTy, mkTyVarTys, mkFunTys, - mkTyConApp, instantiateTy, mkForAllTys, - tyVarsOfType, instantiateTy, typePrimRep, - instantiateTauTy, - ThetaType, TauType, Type, GenType - ) -import TyVar ( TyVar, alphaTyVars, isEmptyTyVarSet, - TyVarEnv, zipTyVarEnv, mkTyVarEnv - ) -import UniqFM -import UniqSet -- practically all of it -import Unique ( Unique, Uniquable(..), getBuiltinUniques ) -import Outputable -import SrcLoc ( SrcLoc ) -import Util ( nOfThem, assoc ) -import GlaExts ( Int# ) -\end{code} + isExportedId, isLocalId, + hasNoBinding, -Here are the @Id@ and @IdDetails@ datatypes; also see the notes that -follow. + -- Inline pragma stuff + idInlinePragma, setInlinePragma, modifyInlinePragma, -Every @Id@ has a @Unique@, to uniquify it and for fast comparison, a -@Type@, and an @IdInfo@ (non-essential info about it, e.g., -strictness). The essential info about different kinds of @Ids@ is -in its @IdDetails@. - -ToDo: possibly cache other stuff in the single-constructor @Id@ type. - -\begin{code} -data GenId ty = Id { - idUnique :: Unique, -- Key for fast comparison - idName :: Name, - idType :: ty, -- Id's type; used all the time; - idDetails :: IdDetails, -- Stuff about individual kinds of Ids. - idInfo :: IdInfo -- Properties of this Id deduced by compiler - } - -type Id = GenId Type - -data StrictnessMark = MarkedStrict | NotMarkedStrict - -data IdDetails - - ---------------- Local values - - = VanillaId Bool -- Ordinary Id - -- True <=> no free type vars - - | PrimitiveId PrimOp -- The Id for a primitive operation - - - ---------------- Data constructors - - | AlgConId -- Used for both data and newtype constructors. - -- You can tell the difference by looking at the TyCon - ConTag - [StrictnessMark] -- Strict args; length = arity - [FieldLabel] -- Field labels for this constructor; - --length = 0 (not a record) or arity - - [TyVar] ThetaType -- Type vars and context for the data type decl - [TyVar] ThetaType -- Ditto for the context of the constructor, - -- the existentially quantified stuff - [Type] TyCon -- Args and result tycon - -- the type is: - -- forall tyvars1 ++ tyvars2. theta1 ++ theta2 => - -- unitype_1 -> ... -> unitype_n -> tycon tyvars - - | TupleConId Int -- Its arity - - | RecordSelId FieldLabel - - | SpecPragmaId -- This guy 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. + -- One shot lambda stuff + isOneShotLambda, setOneShotLambda, clearOneShotLambda, + -- IdInfo stuff + setIdUnfolding, + setIdArityInfo, + setIdDemandInfo, + setIdStrictness, + setIdTyGenInfo, + setIdWorkerInfo, + setIdSpecialisation, + setIdCafInfo, + setIdCprInfo, + setIdOccInfo, + + idArity, idArityInfo, + idFlavour, + idDemandInfo, + idStrictness, + idTyGenInfo, + idWorkerInfo, + idUnfolding, + idSpecialisation, + idCafInfo, + idCprInfo, + idLBVarInfo, + idOccInfo, -type ConTag = Int -type DictVar = Id -type DictFun = Id -type DataCon = Id -\end{code} + ) where +#include "HsVersions.h" -%************************************************************************ -%* * -\subsection{Construction} -%* * -%************************************************************************ -\begin{code} -mkId :: Name -> ty -> IdDetails -> IdInfo -> GenId ty -mkId name ty details info - = Id {idName = name, idUnique = nameUnique name, idType = ty, - idDetails = details, idInfo = info} - -mkVanillaId :: Name -> (GenType flexi) -> IdInfo -> GenId (GenType flexi) -mkVanillaId name ty info - = Id {idName = name, idUnique = nameUnique name, idType = ty, - idDetails = VanillaId (isEmptyTyVarSet (tyVarsOfType ty)), - idInfo = info} - -mkIdWithNewUniq :: Id -> Unique -> Id -mkIdWithNewUniq id uniq = id {idUnique = uniq, idName = changeUnique (idName id) uniq} - -mkIdWithNewName :: Id -> Name -> Id -mkIdWithNewName id new_name - = id {idUnique = uniqueOf new_name, idName = new_name} - -mkIdWithNewType :: GenId ty1 -> ty2 -> GenId ty2 -mkIdWithNewType id ty = id {idType = ty} -\end{code} +import CoreSyn ( Unfolding, CoreRules ) +import BasicTypes ( Arity ) +import Var ( Id, DictId, + isId, mkIdVar, + idName, idType, idUnique, idInfo, + setIdName, setVarType, setIdUnique, + setIdInfo, lazySetIdInfo, modifyIdInfo, + maybeModifyIdInfo, + externallyVisibleId + ) +import Type ( Type, typePrimRep, addFreeTyVars, + usOnce, seqType, splitTyConApp_maybe ) +import IdInfo -Make some local @Ids@ for a template @CoreExpr@. These have bogus -@Uniques@, but that's OK because the templates are supposed to be -instantiated before use. +import Demand ( Demand ) +import Name ( Name, OccName, + mkSysLocalName, mkLocalName, + getOccName + ) +import OccName ( UserFS ) +import PrimRep ( PrimRep ) +import TysPrim ( statePrimTyCon ) +import FieldLabel ( FieldLabel ) +import SrcLoc ( SrcLoc ) +import Unique ( Unique, mkBuiltinUnique, getBuiltinUniques, + getNumBuiltinUniques ) +import Outputable -\begin{code} -mkTemplateLocals :: [Type] -> [Id] -mkTemplateLocals tys - = zipWith3 mk (getBuiltinUniques (length tys)) tys [1..] - where - mk uniq ty n = mkVanillaId (mkSysLocalName uniq (_PK_ ("x"++show n)) mkBuiltinSrcLoc) - ty noIdInfo +infixl 1 `setIdUnfolding`, + `setIdArityInfo`, + `setIdDemandInfo`, + `setIdStrictness`, + `setIdTyGenInfo`, + `setIdWorkerInfo`, + `setIdSpecialisation`, + `setInlinePragma`, + `idCafInfo`, + `idCprInfo` + + -- infixl so you can say (id `set` a `set` b) \end{code} -\begin{code} --- See notes with setNameVisibility (Name.lhs) -setIdVisibility :: Maybe Module -> Unique -> Id -> Id -setIdVisibility maybe_mod u id - = id {idName = setNameVisibility maybe_mod u (idName id)} - -replaceIdInfo :: GenId ty -> IdInfo -> GenId ty -replaceIdInfo id info = id {idInfo = info} -\end{code} %************************************************************************ %* * -\subsection[Id-general-funs]{General @Id@-related functions} +\subsection{Simple Id construction} %* * %************************************************************************ -\begin{code} -fIRST_TAG :: ConTag -fIRST_TAG = 1 -- Tags allocated from here for real constructors - --- isDataCon returns False for @newtype@ constructors -isDataCon (Id {idDetails = AlgConId _ _ _ _ _ _ _ _ tc}) = isDataTyCon tc -isDataCon (Id {idDetails = TupleConId _}) = True -isDataCon other = False - -isNewCon (Id {idDetails = AlgConId _ _ _ _ _ _ _ _ tc}) = isNewTyCon tc -isNewCon other = False - --- isAlgCon returns True for @data@ or @newtype@ constructors -isAlgCon (Id {idDetails = AlgConId _ _ _ _ _ _ _ _ _}) = True -isAlgCon (Id {idDetails = TupleConId _}) = True -isAlgCon other = False - -isTupleCon (Id {idDetails = TupleConId _}) = True -isTupleCon other = False -\end{code} +Absolutely all Ids are made by mkId. It + a) Pins free-tyvar-info onto the Id's type, + where it can easily be found. + b) Ensures that exported Ids are \begin{code} -idHasNoFreeTyVars :: Id -> Bool - -idHasNoFreeTyVars (Id {idDetails = details}) - = chk details - where - chk (AlgConId _ _ _ _ _ _ _ _ _) = True - chk (TupleConId _) = True - chk (RecordSelId _) = True - chk (VanillaId no_free_tvs) = no_free_tvs - chk (PrimitiveId _) = True - chk SpecPragmaId = False -- Play safe - --- omitIfaceSigForId tells whether an Id's info is implied by other declarations, --- so we don't need to put its signature in an interface file, even if it's mentioned --- in some other interface unfolding. - -omitIfaceSigForId - :: Id - -> Bool - -omitIfaceSigForId (Id {idName = name, idDetails = details}) - | isWiredInName name - = True - - | otherwise - = case details of - (PrimitiveId _) -> True -- Ditto, for primitives - - -- This group is Ids that are implied by their type or class decl; - -- remember that all type and class decls appear in the interface file. - -- The dfun id must *not* be omitted, because it carries version info for - -- the instance decl - (AlgConId _ _ _ _ _ _ _ _ _) -> True - (TupleConId _) -> True - (RecordSelId _) -> True - - other -> False -- Don't omit! - -- NB DefaultMethodIds are not omitted +mkId :: Name -> Type -> IdInfo -> Id +mkId name ty info = mkIdVar name (addFreeTyVars ty) info \end{code} \begin{code} -isBottomingId id = bottomIsGuaranteed (strictnessInfo (idInfo id)) +mkVanillaId :: Name -> Type -> Id +mkVanillaId name ty = mkId name ty vanillaIdInfo -isPrimitiveId_maybe (Id {idDetails = PrimitiveId primop}) = Just primop -isPrimitiveId_maybe other = Nothing +-- SysLocal: for an Id being created by the compiler out of thin air... +-- UserLocal: an Id with a name the user might recognize... +mkUserLocal :: OccName -> Unique -> Type -> SrcLoc -> Id +mkSysLocal :: UserFS -> Unique -> Type -> Id -isSpecPragmaId (Id {idDetails = SpecPragmaId}) = True -isSpecPragmaId _ = False +mkSysLocal fs uniq ty = mkVanillaId (mkSysLocalName uniq fs) ty +mkUserLocal occ uniq ty loc = mkVanillaId (mkLocalName uniq occ loc) ty \end{code} -@externallyVisibleId@: is it true that another module might be -able to ``see'' this Id in a code generation sense. That -is, another .o file might refer to this Id. - -In tidyCorePgm (SimplCore.lhs) we carefully set each top level thing's -local-ness precisely so that the test here would be easy +Make some local @Ids@ for a template @CoreExpr@. These have bogus +@Uniques@, but that's OK because the templates are supposed to be +instantiated before use. \begin{code} -externallyVisibleId :: Id -> Bool -externallyVisibleId id = not (isLocalName (idName id)) - -- not local => global => externally visible -\end{code} +-- "Wild Id" typically used when you need a binder that you don't expect to use +mkWildId :: Type -> Id +mkWildId ty = mkSysLocal SLIT("wild") (mkBuiltinUnique 1) ty - -\begin{code} -idPrimRep id = typePrimRep (idType id) +-- "Template locals" typically used in unfoldings +mkTemplateLocals :: [Type] -> [Id] +mkTemplateLocals tys = zipWith (mkSysLocal SLIT("tpl")) + (getBuiltinUniques (length tys)) + tys + +mkTemplateLocalsNum :: Int -> [Type] -> [Id] +-- The Int gives the starting point for unique allocation +mkTemplateLocalsNum n tys = zipWith (mkSysLocal SLIT("tpl")) + (getNumBuiltinUniques n (length tys)) + tys + +mkTemplateLocal :: Int -> Type -> Id +mkTemplateLocal i ty = mkSysLocal SLIT("tpl") (mkBuiltinUnique i) ty \end{code} %************************************************************************ %* * -\subsection[Id-arities]{Arity-related functions} +\subsection[Id-general-funs]{General @Id@-related functions} %* * %************************************************************************ -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} -getIdArity :: Id -> ArityInfo -getIdArity id = arityInfo (idInfo id) +setIdType :: Id -> Type -> Id + -- Add free tyvar info to the type +setIdType id ty = seqType ty `seq` setVarType id (addFreeTyVars ty) -addIdArity :: Id -> ArityInfo -> Id -addIdArity id@(Id {idInfo = info}) arity - = id {idInfo = arity `setArityInfo` info} +idPrimRep :: Id -> PrimRep +idPrimRep id = typePrimRep (idType id) \end{code} + %************************************************************************ %* * -\subsection[constructor-funs]{@DataCon@-related functions (incl.~tuples)} +\subsection{Special Ids} %* * %************************************************************************ - -dataConNumFields gives the number of actual fields in the -{\em representation} of the data constructor. This may be more than appear -in the source code; the extra ones are the existentially quantified -dictionaries - \begin{code} -dataConNumFields id - = ASSERT( if (isDataCon id) then True else - pprTrace "dataConNumFields" (ppr id) False ) - case (dataConSig id) of { (_, _, _, con_theta, arg_tys, _) -> - length con_theta + length arg_tys } +idFlavour :: Id -> IdFlavour +idFlavour id = flavourInfo (idInfo id) -isNullaryDataCon con = dataConNumFields con == 0 -- function of convenience +setIdNoDiscard :: Id -> Id +setIdNoDiscard id -- Make an Id into a NoDiscardId, unless it is already + = modifyIdInfo setNoDiscardInfo id +recordSelectorFieldLabel :: Id -> FieldLabel +recordSelectorFieldLabel id = case idFlavour id of + RecordSelId lbl -> lbl + +isRecordSelector id = case idFlavour id of + RecordSelId lbl -> True + other -> False + +isPrimOpId id = case idFlavour id of + PrimOpId op -> True + other -> False + +isPrimOpId_maybe id = case idFlavour id of + PrimOpId op -> Just op + other -> Nothing + +isDataConId id = case idFlavour id of + DataConId _ -> True + other -> False + +isDataConId_maybe id = case idFlavour id of + DataConId con -> Just con + other -> Nothing + +isDataConWrapId_maybe id = case idFlavour id of + DataConWrapId con -> Just con + other -> Nothing + +isDataConWrapId id = case idFlavour id of + DataConWrapId con -> True + other -> False + +isSpecPragmaId id = case idFlavour id of + SpecPragmaId -> True + other -> False + +hasNoBinding id = case idFlavour id of + DataConId _ -> True + PrimOpId _ -> True + other -> False + -- hasNoBinding returns True of an Id which may not have a + -- binding, even though it is defined in this module. Notably, + -- the constructors of a dictionary are in this situation. + +isDictFunId id = case idFlavour id of + DictFunId -> True + other -> False + +-- Don't drop a binding for an exported Id, +-- if it otherwise looks dead. +-- Perhaps a better name would be isDiscardableId +isExportedId :: Id -> Bool +isExportedId id = case idFlavour id of + VanillaId -> False + other -> True + +isLocalId :: Id -> Bool +-- True of Ids that are locally defined, but are not constants +-- like data constructors, record selectors, and the like. +-- See comments with CoreFVs.isLocalVar +isLocalId id +#ifdef DEBUG + | not (isId id) = pprTrace "isLocalid" (ppr id) False + | otherwise +#endif + = case idFlavour id of + VanillaId -> True + ExportedId -> True + SpecPragmaId -> True + other -> False \end{code} -\begin{code} -dataConTag :: DataCon -> ConTag -- will panic if not a DataCon -dataConTag (Id {idDetails = AlgConId tag _ _ _ _ _ _ _ _}) = tag -dataConTag (Id {idDetails = TupleConId _}) = fIRST_TAG - -dataConTyCon :: DataCon -> TyCon -- will panic if not a DataCon -dataConTyCon (Id {idDetails = AlgConId _ _ _ _ _ _ _ _ tycon}) = tycon -dataConTyCon (Id {idDetails = TupleConId a}) = tupleTyCon a - -dataConSig :: DataCon -> ([TyVar], ThetaType, [TyVar], ThetaType, [TauType], TyCon) - -- will panic if not a DataCon - -dataConSig (Id {idDetails = AlgConId _ _ _ tyvars theta con_tyvars con_theta arg_tys tycon}) - = (tyvars, theta, con_tyvars, con_theta, arg_tys, tycon) - -dataConSig (Id {idDetails = TupleConId arity}) - = (tyvars, [], [], [], tyvar_tys, tupleTyCon arity) - where - tyvars = take arity alphaTyVars - tyvar_tys = mkTyVarTys tyvars - - --- dataConRepType returns the type of the representation of a contructor --- This may differ from the type of the contructor Id itself for two reasons: --- a) the constructor Id may be overloaded, but the dictionary isn't stored --- e.g. data Eq a => T a = MkT a a --- --- b) the constructor may store an unboxed version of a strict field. --- --- Here's an example illustrating both: --- data Ord a => T a = MkT Int! a --- Here --- T :: Ord a => Int -> a -> T a --- but the rep type is --- Trep :: Int# -> a -> T a --- Actually, the unboxed part isn't implemented yet! - -dataConRepType :: Id -> Type -dataConRepType (Id {idDetails = AlgConId _ _ _ tyvars theta con_tyvars con_theta arg_tys tycon}) - = mkForAllTys (tyvars++con_tyvars) - (mkFunTys arg_tys (mkTyConApp tycon (mkTyVarTys tyvars))) -dataConRepType other_id - = ASSERT( isDataCon other_id ) - idType other_id - -dataConFieldLabels :: DataCon -> [FieldLabel] -dataConFieldLabels (Id {idDetails = AlgConId _ _ fields _ _ _ _ _ _}) = fields -dataConFieldLabels (Id {idDetails = TupleConId _}) = [] -#ifdef DEBUG -dataConFieldLabels x@(Id {idDetails = idt}) = - panic ("dataConFieldLabel: " ++ - (case idt of - VanillaId _ -> "l" - PrimitiveId _ -> "p" - RecordSelId _ -> "r")) -#endif +isImplicitId tells whether an Id's info is implied by other +declarations, so we don't need to put its signature in an interface +file, even if it's mentioned in some other interface unfolding. -dataConStrictMarks :: DataCon -> [StrictnessMark] -dataConStrictMarks (Id {idDetails = AlgConId _ stricts _ _ _ _ _ _ _}) = stricts -dataConStrictMarks (Id {idDetails = TupleConId arity}) = nOfThem arity NotMarkedStrict - -dataConRawArgTys :: DataCon -> [TauType] -- a function of convenience -dataConRawArgTys con = case (dataConSig con) of { (_,_, _, _, arg_tys,_) -> arg_tys } - -dataConArgTys :: DataCon - -> [Type] -- Instantiated at these types - -> [Type] -- Needs arguments of these types -dataConArgTys con_id inst_tys - = map (instantiateTy tenv) arg_tys - where - (tyvars, _, _, _, arg_tys, _) = dataConSig con_id - tenv = zipTyVarEnv tyvars inst_tys +\begin{code} +isImplicitId :: Id -> Bool +isImplicitId id + = case idFlavour id of + RecordSelId _ -> True -- Includes dictionary selectors + PrimOpId _ -> True + DataConId _ -> True + DataConWrapId _ -> True + -- These are are implied by their type or class decl; + -- remember that all type and class decls appear in the interface file. + -- The dfun id must *not* be omitted, because it carries version info for + -- the instance decl + other -> False \end{code} \begin{code} -recordSelectorFieldLabel :: Id -> FieldLabel -recordSelectorFieldLabel (Id {idDetails = RecordSelId lbl}) = lbl - -isRecordSelector (Id {idDetails = RecordSelId lbl}) = True -isRecordSelector other = False +isDeadBinder :: Id -> Bool +isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr) + | otherwise = False -- TyVars count as not dead \end{code} %************************************************************************ %* * -\subsection[unfolding-Ids]{Functions related to @Ids@' unfoldings} +\subsection{IdInfo stuff} %* * %************************************************************************ \begin{code} -getIdUnfolding :: Id -> Unfolding + --------------------------------- + -- ARITY +idArityInfo :: Id -> ArityInfo +idArityInfo id = arityInfo (idInfo id) -getIdUnfolding id = unfoldingInfo (idInfo id) +idArity :: Id -> Arity +idArity id = arityLowerBound (idArityInfo id) -addIdUnfolding :: Id -> Unfolding -> Id -addIdUnfolding id@(Id {idInfo = info}) unfolding - = id {idInfo = unfolding `setUnfoldingInfo` info} -\end{code} +setIdArityInfo :: Id -> ArityInfo -> Id +setIdArityInfo id arity = modifyIdInfo (`setArityInfo` arity) id -The inline pragma tells us to be very keen to inline this Id, but it's still -OK not to if optimisation is switched off. + --------------------------------- + -- STRICTNESS +idStrictness :: Id -> StrictnessInfo +idStrictness id = strictnessInfo (idInfo id) -\begin{code} -getInlinePragma :: Id -> InlinePragInfo -getInlinePragma id = inlinePragInfo (idInfo id) +setIdStrictness :: Id -> StrictnessInfo -> Id +setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id -idWantsToBeINLINEd :: Id -> Bool +-- isBottomingId returns true if an application to n args would diverge +isBottomingId :: Id -> Bool +isBottomingId id = isBottomingStrictness (idStrictness id) -idWantsToBeINLINEd id = case getInlinePragma id of - IWantToBeINLINEd -> True - IMustBeINLINEd -> True - other -> False + --------------------------------- + -- TYPE GENERALISATION +idTyGenInfo :: Id -> TyGenInfo +idTyGenInfo id = tyGenInfo (idInfo id) -idMustNotBeINLINEd id = case getInlinePragma id of - IMustNotBeINLINEd -> True - other -> False +setIdTyGenInfo :: Id -> TyGenInfo -> Id +setIdTyGenInfo id tygen_info = modifyIdInfo (`setTyGenInfo` tygen_info) id -idMustBeINLINEd id = case getInlinePragma id of - IMustBeINLINEd -> True - other -> False + --------------------------------- + -- WORKER ID +idWorkerInfo :: Id -> WorkerInfo +idWorkerInfo id = workerInfo (idInfo id) -addInlinePragma :: Id -> Id -addInlinePragma id@(Id {idInfo = info}) - = id {idInfo = setInlinePragInfo IWantToBeINLINEd info} +setIdWorkerInfo :: Id -> WorkerInfo -> Id +setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id -nukeNoInlinePragma :: Id -> Id -nukeNoInlinePragma id@(Id {idInfo = info}) - = case inlinePragInfo info of - IMustNotBeINLINEd -> id {idInfo = setInlinePragInfo NoPragmaInfo info} - other -> id + --------------------------------- + -- UNFOLDING +idUnfolding :: Id -> Unfolding +idUnfolding id = unfoldingInfo (idInfo id) -addNoInlinePragma :: Id -> Id -addNoInlinePragma id@(Id {idInfo = info}) - = id {idInfo = IMustNotBeINLINEd `setInlinePragInfo` info} +setIdUnfolding :: Id -> Unfolding -> Id +setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id -mustInlineInfo = IMustBeINLINEd `setInlinePragInfo` noIdInfo -wantToInlineInfo = IWantToBeINLINEd `setInlinePragInfo` noIdInfo -\end{code} + --------------------------------- + -- DEMAND +idDemandInfo :: Id -> Demand +idDemandInfo id = demandInfo (idInfo id) +setIdDemandInfo :: Id -> Demand -> Id +setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id + --------------------------------- + -- SPECIALISATION +idSpecialisation :: Id -> CoreRules +idSpecialisation id = specInfo (idInfo id) -%************************************************************************ -%* * -\subsection[IdInfo-funs]{Functions related to @Ids@' @IdInfos@} -%* * -%************************************************************************ +setIdSpecialisation :: Id -> CoreRules -> Id +setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id -\begin{code} -getIdDemandInfo :: Id -> DemandInfo -getIdDemandInfo id = demandInfo (idInfo id) + --------------------------------- + -- CAF INFO +idCafInfo :: Id -> CafInfo +idCafInfo id = cafInfo (idInfo id) -addIdDemandInfo :: Id -> DemandInfo -> Id -addIdDemandInfo id@(Id {idInfo = info}) demand_info - = id {idInfo = demand_info `setDemandInfo` info} -\end{code}p +setIdCafInfo :: Id -> CafInfo -> Id +setIdCafInfo id caf_info = modifyIdInfo (`setCafInfo` caf_info) id -\begin{code} -getIdUpdateInfo :: Id -> UpdateInfo -getIdUpdateInfo id = updateInfo (idInfo id) + --------------------------------- + -- CPR INFO +idCprInfo :: Id -> CprInfo +idCprInfo id = cprInfo (idInfo id) -addIdUpdateInfo :: Id -> UpdateInfo -> Id -addIdUpdateInfo id@(Id {idInfo = info}) upd_info - = id {idInfo = upd_info `setUpdateInfo` info} -\end{code} +setIdCprInfo :: Id -> CprInfo -> Id +setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id -\begin{code} -getIdSpecialisation :: Id -> IdSpecEnv -getIdSpecialisation id = specInfo (idInfo id) + --------------------------------- + -- Occcurrence INFO +idOccInfo :: Id -> OccInfo +idOccInfo id = occInfo (idInfo id) -setIdSpecialisation :: Id -> IdSpecEnv -> Id -setIdSpecialisation id@(Id {idInfo = info}) spec_info - = id {idInfo = spec_info `setSpecInfo` info} +setIdOccInfo :: Id -> OccInfo -> Id +setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id \end{code} -\begin{code} -getIdStrictness :: Id -> StrictnessInfo -getIdStrictness id = strictnessInfo (idInfo id) -addIdStrictness :: Id -> StrictnessInfo -> Id -addIdStrictness id@(Id {idInfo = info}) strict_info - = id {idInfo = strict_info `setStrictnessInfo` info} -\end{code} - -%************************************************************************ -%* * -\subsection[Id-comparison]{Comparison functions for @Id@s} -%* * -%************************************************************************ - -Comparison: equality and ordering---this stuff gets {\em hammered}. - -\begin{code} -cmpId (Id {idUnique = u1}) (Id {idUnique = u2}) = compare u1 u2 -\end{code} + --------------------------------- + -- INLINING +The inline pragma tells us to be very keen to inline this Id, but it's still +OK not to if optimisation is switched off. \begin{code} -instance Eq (GenId ty) where - a == b = case (a `compare` b) of { EQ -> True; _ -> False } - a /= b = case (a `compare` b) of { EQ -> False; _ -> True } - -instance Ord (GenId ty) where - a <= b = case (a `compare` b) of { LT -> True; EQ -> True; GT -> False } - a < b = case (a `compare` b) of { LT -> True; EQ -> False; GT -> False } - a >= b = case (a `compare` b) of { LT -> False; EQ -> True; GT -> True } - a > b = case (a `compare` b) of { LT -> False; EQ -> False; GT -> True } - compare a b = cmpId a b -\end{code} +idInlinePragma :: Id -> InlinePragInfo +idInlinePragma id = inlinePragInfo (idInfo id) -%************************************************************************ -%* * -\subsection[Id-other-instances]{Other instance declarations for @Id@s} -%* * -%************************************************************************ +setInlinePragma :: Id -> InlinePragInfo -> Id +setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id -\begin{code} -instance Outputable ty => Outputable (GenId ty) where - ppr id = pprId id - -showId :: Id -> String -showId id = showSDoc (pprId id) +modifyInlinePragma :: Id -> (InlinePragInfo -> InlinePragInfo) -> Id +modifyInlinePragma id fn = modifyIdInfo (\info -> info `setInlinePragInfo` (fn (inlinePragInfo info))) id \end{code} -Default printing code (not used for interfaces): -\begin{code} -pprId :: Outputable ty => GenId ty -> SDoc - -pprId Id {idUnique = u, idName = n, idInfo = info} - = hcat [ppr n, pp_prags] - where - pp_prags sty - | opt_PprStyle_All && not (codeStyle sty) - = (case inlinePragInfo info of - IMustNotBeINLINEd -> text "{n}" - IWantToBeINLINEd -> text "{i}" - IMustBeINLINEd -> text "{I}" - other -> empty) sty - - | otherwise - = empty sty - -\end{code} + --------------------------------- + -- ONE-SHOT LAMBDAS \begin{code} -instance Uniquable (GenId ty) where - uniqueOf = idUnique - -instance NamedThing (GenId ty) where - getName = idName +idLBVarInfo :: Id -> LBVarInfo +idLBVarInfo id = lbvarInfo (idInfo id) + +isOneShotLambda :: Id -> Bool +isOneShotLambda id = analysis || hack + where analysis = case idLBVarInfo id of + LBVarInfo u | u == usOnce -> True + other -> False + hack = case splitTyConApp_maybe (idType id) of + Just (tycon,_) | tycon == statePrimTyCon -> True + other -> False + + -- The last clause is a gross hack. It claims that + -- every function over realWorldStatePrimTy is a one-shot + -- function. This is pretty true in practice, and makes a big + -- difference. For example, consider + -- a `thenST` \ r -> ...E... + -- The early full laziness pass, if it doesn't know that r is one-shot + -- will pull out E (let's say it doesn't mention r) to give + -- let lvl = E in a `thenST` \ r -> ...lvl... + -- When `thenST` gets inlined, we end up with + -- let lvl = E in \s -> case a s of (r, s') -> ...lvl... + -- and we don't re-inline E. + -- + -- It would be better to spot that r was one-shot to start with, but + -- I don't want to rely on that. + -- + -- Another good example is in fill_in in PrelPack.lhs. We should be able to + -- spot that fill_in has arity 2 (and when Keith is done, we will) but we can't yet. + +setOneShotLambda :: Id -> Id +setOneShotLambda id = modifyIdInfo (`setLBVarInfo` LBVarInfo usOnce) id + +clearOneShotLambda :: Id -> Id +clearOneShotLambda id + | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id + | otherwise = id + +-- But watch out: this may change the type of something else +-- f = \x -> e +-- If we change the one-shot-ness of x, f's type changes \end{code} -Note: The code generator doesn't carry a @UniqueSupply@, so it uses -the @Uniques@ out of local @Ids@ given to it. - -%************************************************************************ -%* * -\subsection{@IdEnv@s and @IdSet@s} -%* * -%************************************************************************ - \begin{code} -type IdEnv elt = UniqFM elt - -nullIdEnv :: IdEnv a - -mkIdEnv :: [(GenId ty, a)] -> IdEnv a -unitIdEnv :: GenId ty -> a -> IdEnv a -addOneToIdEnv :: IdEnv a -> GenId ty -> a -> IdEnv a -growIdEnv :: IdEnv a -> IdEnv a -> IdEnv a -growIdEnvList :: IdEnv a -> [(GenId ty, a)] -> IdEnv a - -delManyFromIdEnv :: IdEnv a -> [GenId ty] -> IdEnv a -delOneFromIdEnv :: IdEnv a -> GenId ty -> IdEnv a -combineIdEnvs :: (a -> a -> a) -> IdEnv a -> IdEnv a -> IdEnv a -mapIdEnv :: (a -> b) -> IdEnv a -> IdEnv b -modifyIdEnv :: (a -> a) -> IdEnv a -> GenId ty -> IdEnv a -rngIdEnv :: IdEnv a -> [a] - -isNullIdEnv :: IdEnv a -> Bool -lookupIdEnv :: IdEnv a -> GenId ty -> Maybe a -lookupNoFailIdEnv :: IdEnv a -> GenId ty -> a -elemIdEnv :: Id -> IdEnv a -> Bool -\end{code} +zapFragileIdInfo :: Id -> Id +zapFragileIdInfo id = maybeModifyIdInfo zapFragileInfo id -\begin{code} -elemIdEnv = elemUFM -addOneToIdEnv = addToUFM -combineIdEnvs = plusUFM_C -delManyFromIdEnv = delListFromUFM -delOneFromIdEnv = delFromUFM -growIdEnv = plusUFM -lookupIdEnv = lookupUFM -mapIdEnv = mapUFM -mkIdEnv = listToUFM -nullIdEnv = emptyUFM -rngIdEnv = eltsUFM -unitIdEnv = unitUFM -isNullIdEnv = isNullUFM - -growIdEnvList env pairs = plusUFM env (listToUFM pairs) -lookupNoFailIdEnv env id = case (lookupIdEnv env id) of { Just xx -> xx } - -lookupIdSubst :: IdEnv Id -> Id -> Id -lookupIdSubst env id = case lookupIdEnv env id of - Just id' -> id' -- Return original if - Nothing -> id -- it isn't in subst - --- modifyIdEnv: Look up a thing in the IdEnv, then mash it with the --- modify function, and put it back. - -modifyIdEnv mangle_fn env key - = case (lookupIdEnv env key) of - Nothing -> env - Just xx -> addOneToIdEnv env key (mangle_fn xx) - -modifyIdEnv_Directly mangle_fn env key - = case (lookupUFM_Directly env key) of - Nothing -> env - Just xx -> addToUFM_Directly env key (mangle_fn xx) +zapLamIdInfo :: Id -> Id +zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id \end{code} -\begin{code} -type GenIdSet ty = UniqSet (GenId ty) -type IdSet = UniqSet (GenId Type) - -emptyIdSet :: GenIdSet ty -intersectIdSets :: GenIdSet ty -> GenIdSet ty -> GenIdSet ty -unionIdSets :: GenIdSet ty -> GenIdSet ty -> GenIdSet ty -unionManyIdSets :: [GenIdSet ty] -> GenIdSet ty -idSetToList :: GenIdSet ty -> [GenId ty] -unitIdSet :: GenId ty -> GenIdSet ty -addOneToIdSet :: GenIdSet ty -> GenId ty -> GenIdSet ty -elementOfIdSet :: GenId ty -> GenIdSet ty -> Bool -minusIdSet :: GenIdSet ty -> GenIdSet ty -> GenIdSet ty -isEmptyIdSet :: GenIdSet ty -> Bool -mkIdSet :: [GenId ty] -> GenIdSet ty - -emptyIdSet = emptyUniqSet -unitIdSet = unitUniqSet -addOneToIdSet = addOneToUniqSet -intersectIdSets = intersectUniqSets -unionIdSets = unionUniqSets -unionManyIdSets = unionManyUniqSets -idSetToList = uniqSetToList -elementOfIdSet = elementOfUniqSet -minusIdSet = minusUniqSet -isEmptyIdSet = isEmptyUniqSet -mkIdSet = mkUniqSet -\end{code}