X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FId.lhs;h=13443a9852ee5e2fb9ebf3f76894d46fe44e2511;hb=db7041f72b7c7d0114e47b7305058fae48fb0ade;hp=201c4ac5a3c610b3352779aff40c7f6060ddd306;hpb=7a3bd641457666e10d0a47be9f22762e03defbf0;p=ghc-hetmet.git diff --git a/ghc/compiler/basicTypes/Id.lhs b/ghc/compiler/basicTypes/Id.lhs index 201c4ac..13443a9 100644 --- a/ghc/compiler/basicTypes/Id.lhs +++ b/ghc/compiler/basicTypes/Id.lhs @@ -1,1526 +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} -#include "HsVersions.h" - module Id ( - -- TYPES - GenId(..), -- *naughtily* used in some places (e.g., TcHsSyn) - SYN_IE(Id), IdDetails, - StrictnessMark(..), - SYN_IE(ConTag), fIRST_TAG, - SYN_IE(DataCon), SYN_IE(DictFun), SYN_IE(DictVar), - - -- CONSTRUCTION - mkConstMethodId, - mkDataCon, - mkDefaultMethodId, - mkDictFunId, - mkIdWithNewUniq, - mkImported, - mkInstId, - mkMethodSelId, - mkRecordSelId, - mkSuperDictSelId, - mkSysLocal, - mkTemplateLocals, - mkTupleCon, - mkUserId, - mkUserLocal, - mkWorkerId, - mkPrimitiveId, - setIdVisibility, - - -- DESTRUCTION (excluding pragmatic info) - idPrimRep, - idType, - idUnique, - - dataConRepType, - dataConArgTys, - dataConArity, - 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 - wantIdSigInIface, - cmpEqDataCon, - cmpId, - cmpId_withSpecDataCon, + -- Modifying an Id + setIdName, setIdUnique, setIdType, setIdNoDiscard, + setIdInfo, lazySetIdInfo, modifyIdInfo, maybeModifyIdInfo, + zapFragileIdInfo, zapLamIdInfo, + + -- Predicates + isImplicitId, isDeadBinder, externallyVisibleId, - idHasNoFreeTyVars, - idWantsToBeINLINEd, - idMustBeINLINEd, + isSpecPragmaId, isRecordSelector, + isPrimOpId, isPrimOpId_maybe, isDictFunId, + isDataConId, isDataConId_maybe, + isDataConWrapId, isDataConWrapId_maybe, isBottomingId, - isConstMethodId, - isConstMethodId_maybe, - isDataCon, - isDefaultMethodId, - isDefaultMethodId_maybe, - isDictFunId, - isImportedId, - isRecordSelector, - isMethodSelId_maybe, - isNullaryDataCon, - isSpecPragmaId, - isSuperDictSelId_maybe, - isPrimitiveId_maybe, - isSysLocalId, - isTupleCon, - isWorkerId, - isWrapperId, - toplevelishId, - unfoldingUnfriendlyId, - - -- SUBSTITUTION - applyTypeEnvToId, - apply_to_Id, - - -- PRINTING and RENUMBERING - addId, - nmbrDataCon, - nmbrId, - pprId, - showId, - - -- Specialialisation - getIdSpecialisation, - addIdSpecialisation, - - -- UNFOLDING, ARITY, UPDATE, AND STRICTNESS STUFF (etc) - addIdUnfolding, - addIdArity, - addIdDemandInfo, - addIdStrictness, - addIdUpdateInfo, - getIdArity, - getIdDemandInfo, - getIdInfo, - getIdStrictness, - getIdUnfolding, - getIdUpdateInfo, - getPragmaInfo, - replaceIdInfo, - addInlinePragma, - - -- IdEnvs AND IdSets - SYN_IE(IdEnv), SYN_IE(GenIdSet), SYN_IE(IdSet), - addOneToIdEnv, - addOneToIdSet, - combineIdEnvs, - delManyFromIdEnv, - delOneFromIdEnv, - elementOfIdSet, - emptyIdSet, - growIdEnv, - growIdEnvList, - idSetToList, - intersectIdSets, - isEmptyIdSet, - isNullIdEnv, - lookupIdEnv, - lookupNoFailIdEnv, - mapIdEnv, - minusIdSet, - mkIdEnv, - mkIdSet, - modifyIdEnv, - modifyIdEnv_Directly, - nullIdEnv, - rngIdEnv, - unionIdSets, - unionManyIdSets, - unitIdEnv, - unitIdSet - ) where - -IMP_Ubiq() -IMPORT_DELOOPER(IdLoop) -- for paranoia checking -IMPORT_DELOOPER(TyLoop) -- for paranoia checking - -import Bag -import Class ( classOpString, SYN_IE(Class), GenClass, SYN_IE(ClassOp), GenClassOp ) -import IdInfo -import Maybes ( maybeToBool ) -import Name ( nameUnique, mkLocalName, mkSysLocalName, isLocalName, - mkCompoundName, mkInstDeclName, mkWiredInIdName, mkGlobalName, - isLocallyDefinedName, occNameString, modAndOcc, - isLocallyDefined, changeUnique, isWiredInName, - nameString, getOccString, setNameVisibility, - isExported, ExportFlag(..), DefnInfo, Provenance, - OccName(..), Name - ) -import PrelMods ( pREL_TUP, pREL_BASE ) -import Lex ( mkTupNameStr ) -import FieldLabel ( fieldLabelName, FieldLabel(..){-instances-} ) -import PragmaInfo ( PragmaInfo(..) ) -import PprEnv -- ( SYN_IE(NmbrM), NmbrEnv(..) ) -import PprType ( getTypeString, specMaybeTysSuffix, - nmbrType, nmbrTyVar, - GenType, GenTyVar - ) -import PprStyle -import Pretty -import MatchEnv ( MatchEnv ) -import SrcLoc ( mkBuiltinSrcLoc ) -import TysWiredIn ( tupleTyCon ) -import TyCon ( TyCon, tyConDataCons ) -import Type ( mkSigmaTy, mkTyVarTys, mkFunTys, mkDictTy, - applyTyCon, instantiateTy, mkForAllTys, - tyVarsOfType, applyTypeEnvToTy, typePrimRep, - GenType, SYN_IE(ThetaType), SYN_IE(TauType), SYN_IE(Type) - ) -import TyVar ( alphaTyVars, isEmptyTyVarSet, SYN_IE(TyVarEnv) ) -import Usage ( SYN_IE(UVar) ) -import UniqFM -import UniqSet -- practically all of it -import Unique ( getBuiltinUniques, pprUnique, showUnique, - incrUnique, - Unique{-instance Ord3-} - ) -import Util ( mapAccumL, nOfThem, zipEqual, assoc, - panic, panic#, pprPanic, assertPanic - ) -\end{code} - -Here are the @Id@ and @IdDetails@ datatypes; also see the notes that -follow. - -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 - Unique -- Key for fast comparison - Name - ty -- Id's type; used all the time; - IdDetails -- Stuff about individual kinds of Ids. - PragmaInfo -- Properties of this Id requested by programmer - -- eg specialise-me, inline-me - IdInfo -- Properties of this Id deduced by compiler - -type Id = GenId Type - -data StrictnessMark = MarkedStrict | NotMarkedStrict - -data IdDetails - - ---------------- Local values - - = LocalId Bool -- Local name; mentioned by the user - -- True <=> no free type vars - - | SysLocalId Bool -- Local name; made up by the compiler - -- as for LocalId - - | PrimitiveId PrimOp -- The Id for a primitive operation - - | SpecPragmaId -- Local name; introduced by the compiler - (Maybe Id) -- for explicit specid in pragma - Bool -- as for LocalId - - ---------------- Global values - - | ImportedId -- Global name (Imported or Implicit); Id imported from an interface - - ---------------- Data constructors - - | DataConId ConTag - [StrictnessMark] -- Strict args; length = arity - [FieldLabel] -- Field labels for this constructor - - [TyVar] [(Class,Type)] [Type] TyCon - -- the type is: - -- forall tyvars . theta_ty => - -- unitype_1 -> ... -> unitype_n -> tycon tyvars - - | TupleConId Int -- Its arity - - | RecordSelId FieldLabel - - ---------------- Things to do with overloading - - | SuperDictSelId -- Selector for superclass dictionary - Class -- The class (input dict) - Class -- The superclass (result dict) - - | MethodSelId Class -- An overloaded class operation, with - -- a fully polymorphic type. Its code - -- just selects a method from the - -- dictionary. The class. - ClassOp -- The operation - - -- NB: The IdInfo for a MethodSelId has all the info about its - -- related "constant method Ids", which are just - -- specialisations of this general one. - - | DefaultMethodId -- Default method for a particular class op - Class -- same class, info as MethodSelId - ClassOp -- (surprise, surprise) - Bool -- True <=> I *know* this default method Id - -- is a generated one that just says - -- `error "No default method for "'. - - -- see below - | DictFunId Class -- A DictFun is uniquely identified - Type -- by its class and type; this type has free type vars, - -- whose identity is irrelevant. Eg Class = Eq - -- Type = Tree a - -- The "a" is irrelevant. As it is too painful to - -- actually do comparisons that way, we kindly supply - -- a Unique for that purpose. - - -- see below - | ConstMethodId -- A method which depends only on the type of the - -- instance, and not on any further dictionaries etc. - Class -- Uniquely identified by: - Type -- (class, type, classop) triple - ClassOp - Module -- module where instance came from - - | InstId -- An instance of a dictionary, class operation, - -- or overloaded value (Local name) - Bool -- as for LocalId - - | SpecId -- A specialisation of another Id - Id -- Id of which this is a specialisation - [Maybe Type] -- Types at which it is specialised; - -- A "Nothing" says this type ain't relevant. - Bool -- True <=> no free type vars; it's not enough - -- to know about the unspec version, because - -- we may specialise to a type w/ free tyvars - -- (i.e., in one of the "Maybe Type" dudes). - --- Scheduled for deletion: SLPJ Nov 96 --- Nobody seems to depend on knowing this. - | WorkerId -- A "worker" for some other Id - Id -- Id for which this is a worker - -type ConTag = Int -type DictVar = Id -type DictFun = Id -type DataCon = Id -\end{code} - -DictFunIds are generated from instance decls. -\begin{verbatim} - class Foo a where - op :: a -> a -> Bool - - instance Foo a => Foo [a] where - op = ... -\end{verbatim} -generates the dict fun id decl -\begin{verbatim} - dfun.Foo.[*] = \d -> ... -\end{verbatim} -The dfun id is uniquely named by the (class, type) pair. Notice, it -isn't a (class,tycon) pair any more, because we may get manually or -automatically generated specialisations of the instance decl: -\begin{verbatim} - instance Foo [Int] where - op = ... -\end{verbatim} -generates -\begin{verbatim} - dfun.Foo.[Int] = ... -\end{verbatim} -The type variables in the name are irrelevant; we print them as stars. - - -Constant method ids are generated from instance decls where -there is no context; that is, no dictionaries are needed to -construct the method. Example -\begin{verbatim} - instance Foo Int where - op = ... -\end{verbatim} -Then we get a constant method -\begin{verbatim} - Foo.op.Int = ... -\end{verbatim} - -It is possible, albeit unusual, to have a constant method -for an instance decl which has type vars: -\begin{verbatim} - instance Foo [a] where - op [] ys = True - op (x:xs) ys = False -\end{verbatim} -We get the constant method -\begin{verbatim} - Foo.op.[*] = ... -\end{verbatim} -So a constant method is identified by a class/op/type triple. -The type variables in the type are irrelevant. - - -For Ids whose names must be known/deducible in other modules, we have -to conjure up their worker's names (and their worker's worker's -names... etc) in a known systematic way. - - -%************************************************************************ -%* * -\subsection[Id-documentation]{Documentation} -%* * -%************************************************************************ - -[A BIT DATED [WDP]] - -The @Id@ datatype describes {\em values}. The basic things we want to -know: (1)~a value's {\em type} (@idType@ is a very common -operation in the compiler); and (2)~what ``flavour'' of value it might -be---for example, it can be terribly useful to know that a value is a -class method. - -\begin{description} -%---------------------------------------------------------------------- -\item[@DataConId@:] For the data constructors declared by a @data@ -declaration. Their type is kept in {\em two} forms---as a regular -@Type@ (in the usual place), and also in its constituent pieces (in -the ``details''). We are frequently interested in those pieces. - -%---------------------------------------------------------------------- -\item[@TupleConId@:] This is just a special shorthand for @DataCons@ for -the infinite family of tuples. - -%---------------------------------------------------------------------- -\item[@ImportedId@:] These are values defined outside this module. -{\em Everything} we want to know about them must be stored here (or in -their @IdInfo@). - -%---------------------------------------------------------------------- -\item[@MethodSelId@:] A selector from a dictionary; it may select either -a method or a dictionary for one of the class's superclasses. - -%---------------------------------------------------------------------- -\item[@DictFunId@:] - -@mkDictFunId [a,b..] theta C T@ is the function derived from the -instance declaration - - instance theta => C (T a b ..) where - ... - -It builds function @Id@ which maps dictionaries for theta, -to a dictionary for C (T a b ..). - -*Note* that with the ``Mark Jones optimisation'', the theta may -include dictionaries for the immediate superclasses of C at the type -(T a b ..). - -%---------------------------------------------------------------------- -\item[@InstId@:] - -%---------------------------------------------------------------------- -\item[@SpecId@:] - -%---------------------------------------------------------------------- -\item[@WorkerId@:] - -%---------------------------------------------------------------------- -\item[@LocalId@:] A purely-local value, e.g., a function argument, -something defined in a @where@ clauses, ... --- but which appears in -the original program text. - -%---------------------------------------------------------------------- -\item[@SysLocalId@:] Same as a @LocalId@, except does {\em not} appear in -the original program text; these are introduced by the compiler in -doing its thing. - -%---------------------------------------------------------------------- -\item[@SpecPragmaId@:] Introduced by the compiler to record -Specialisation pragmas. It is dead code which MUST NOT be removed -before specialisation. -\end{description} - -Further remarks: -\begin{enumerate} -%---------------------------------------------------------------------- -\item - -@DataCons@ @TupleCons@, @Importeds@, @SuperDictSelIds@, -@MethodSelIds@, @DictFunIds@, and @DefaultMethodIds@ have the following -properties: -\begin{itemize} -\item -They have no free type variables, so if you are making a -type-variable substitution you don't need to look inside them. -\item -They are constants, so they are not free variables. (When the STG -machine makes a closure, it puts all the free variables in the -closure; the above are not required.) -\end{itemize} -Note that @InstIds@, @Locals@ and @SysLocals@ {\em may} have the above -properties, but they may not. -\end{enumerate} - -%************************************************************************ -%* * -\subsection[Id-general-funs]{General @Id@-related functions} -%* * -%************************************************************************ - -\begin{code} -isDataCon (Id _ _ _ (DataConId _ _ _ _ _ _ _) _ _) = True -isDataCon (Id _ _ _ (TupleConId _) _ _) = True -isDataCon (Id _ _ _ (SpecId unspec _ _) _ _) = isDataCon unspec -isDataCon other = False - -isTupleCon (Id _ _ _ (TupleConId _) _ _) = True -isTupleCon (Id _ _ _ (SpecId unspec _ _) _ _) = isTupleCon unspec -isTupleCon other = False - -{-LATER: -isSpecId_maybe (Id _ _ _ (SpecId unspec ty_maybes _) _ _) - = ASSERT(not (maybeToBool (isSpecId_maybe unspec))) - Just (unspec, ty_maybes) -isSpecId_maybe other_id - = Nothing - -isSpecPragmaId_maybe (Id _ _ _ (SpecPragmaId specid _) _ _) - = Just specid -isSpecPragmaId_maybe other_id - = Nothing --} -\end{code} - -@toplevelishId@ tells whether an @Id@ {\em may} be defined in a nested -@let(rec)@ (returns @False@), or whether it is {\em sure} to be -defined at top level (returns @True@). This is used to decide whether -the @Id@ is a candidate free variable. NB: you are only {\em sure} -about something if it returns @True@! - -\begin{code} -toplevelishId :: Id -> Bool -idHasNoFreeTyVars :: Id -> Bool - -toplevelishId (Id _ _ _ details _ _) - = chk details - where - chk (DataConId _ _ _ _ _ _ _) = True - chk (TupleConId _) = True - chk (RecordSelId _) = True - chk ImportedId = True - chk (SuperDictSelId _ _) = True - chk (MethodSelId _ _) = True - chk (DefaultMethodId _ _ _) = True - chk (DictFunId _ _) = True - chk (ConstMethodId _ _ _ _) = True - chk (SpecId unspec _ _) = toplevelishId unspec - -- depends what the unspecialised thing is - chk (WorkerId unwrkr) = toplevelishId unwrkr - chk (InstId _) = False -- these are local - chk (LocalId _) = False - chk (SysLocalId _) = False - chk (SpecPragmaId _ _) = False - chk (PrimitiveId _) = True - -idHasNoFreeTyVars (Id _ _ _ details _ info) - = chk details - where - chk (DataConId _ _ _ _ _ _ _) = True - chk (TupleConId _) = True - chk (RecordSelId _) = True - chk ImportedId = True - chk (SuperDictSelId _ _) = True - chk (MethodSelId _ _) = True - chk (DefaultMethodId _ _ _) = True - chk (DictFunId _ _) = True - chk (ConstMethodId _ _ _ _) = True - chk (WorkerId unwrkr) = idHasNoFreeTyVars unwrkr - chk (SpecId _ _ no_free_tvs) = no_free_tvs - chk (InstId no_free_tvs) = no_free_tvs - chk (LocalId no_free_tvs) = no_free_tvs - chk (SysLocalId no_free_tvs) = no_free_tvs - chk (SpecPragmaId _ no_free_tvs) = no_free_tvs - chk (PrimitiveId _) = True - --- wantIdSigInIface decides whether to put an Id's type signature and --- IdInfo in an interface file -wantIdSigInIface - :: Bool -- True <=> the thing is mentioned somewhere else in the - -- interface file - -> Bool -- True <=> omit anything that doesn't *have* to go - -> Id - -> Bool - -wantIdSigInIface mentioned_already omit_iface_prags (Id _ name _ details _ _) - = chk details - where - chk (LocalId _) = isExported name && - not (isWiredInName name) -- User-declared thing! - chk ImportedId = False -- Never put imports in interface file - chk (PrimitiveId _) = False -- 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 - chk (DataConId _ _ _ _ _ _ _) = False - chk (TupleConId _) = False -- Ditto - chk (RecordSelId _) = False -- Ditto - chk (SuperDictSelId _ _) = False -- Ditto - chk (MethodSelId _ _) = False -- Ditto - chk (ConstMethodId _ _ _ _) = False -- Scheduled for nuking - chk (DefaultMethodId _ _ _) = False -- Hmm. No, for now - - -- DictFunIds are more interesting, they may have IdInfo we can't - -- get from the instance declaration. We emit them if we're gung ho. - -- No need to check the export flag; instance decls are always exposed - chk (DictFunId _ _) = not omit_iface_prags - - -- This group are only called out by being mentioned somewhere else - chk (WorkerId unwrkr) = mentioned_already - chk (SpecId _ _ _) = mentioned_already - chk (InstId _) = mentioned_already - chk (SysLocalId _) = mentioned_already - chk (SpecPragmaId _ _) = mentioned_already -\end{code} - -\begin{code} -isImportedId (Id _ _ _ ImportedId _ _) = True -isImportedId other = False - -isBottomingId (Id _ _ _ _ _ info) = bottomIsGuaranteed (strictnessInfo info) - -isSysLocalId (Id _ _ _ (SysLocalId _) _ _) = True -isSysLocalId other = False - -isSpecPragmaId (Id _ _ _ (SpecPragmaId _ _) _ _) = True -isSpecPragmaId other = False - -isMethodSelId_maybe (Id _ _ _ (MethodSelId cls op) _ _) = Just (cls,op) -isMethodSelId_maybe _ = Nothing - -isDefaultMethodId (Id _ _ _ (DefaultMethodId _ _ _) _ _) = True -isDefaultMethodId other = False - -isDefaultMethodId_maybe (Id _ _ _ (DefaultMethodId cls clsop err) _ _) - = Just (cls, clsop, err) -isDefaultMethodId_maybe other = Nothing + isExportedId, isLocalId, + hasNoBinding, + + -- Inline pragma stuff + idInlinePragma, setInlinePragma, modifyInlinePragma, + + + -- 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, -isDictFunId (Id _ _ _ (DictFunId _ _) _ _) = True -isDictFunId other = False - -isConstMethodId (Id _ _ _ (ConstMethodId _ _ _ _) _ _) = True -isConstMethodId other = False - -isConstMethodId_maybe (Id _ _ _ (ConstMethodId cls ty clsop _) _ _) - = Just (cls, ty, clsop) -isConstMethodId_maybe other = Nothing - -isSuperDictSelId_maybe (Id _ _ _ (SuperDictSelId c sc) _ _) = Just (c, sc) -isSuperDictSelId_maybe other_id = Nothing - -isWorkerId (Id _ _ _ (WorkerId _) _ _) = True -isWorkerId other = False - -isWrapperId id = workerExists (getIdStrictness id) - -isPrimitiveId_maybe (Id _ _ _ (PrimitiveId primop) _ _) = Just primop -isPrimitiveId_maybe other = Nothing -\end{code} - -Tell them who my wrapper function is. -\begin{code} -{-LATER: -myWrapperMaybe :: Id -> Maybe Id - -myWrapperMaybe (Id _ _ _ (WorkerId my_wrapper) _ _) = Just my_wrapper -myWrapperMaybe other_id = Nothing --} -\end{code} - -\begin{code} -unfoldingUnfriendlyId -- return True iff it is definitely a bad - :: Id -- idea to export an unfolding that - -> Bool -- mentions this Id. Reason: it cannot - -- possibly be seen in another module. - -unfoldingUnfriendlyId id = not (externallyVisibleId id) -\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 + ) where -\begin{code} -externallyVisibleId :: Id -> Bool -externallyVisibleId id@(Id _ name _ _ _ _) = not (isLocalName name) - -- not local => global => externally visible -\end{code} +#include "HsVersions.h" -CLAIM (not ASSERTed) for @applyTypeEnvToId@ and @applySubstToId@: -`Top-levelish Ids'' cannot have any free type variables, so applying -the type-env cannot have any effect. (NB: checked in CoreLint?) -The special casing is in @applyTypeEnvToId@, not @apply_to_Id@, as the -former ``should be'' the usual crunch point. +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 ) -\begin{code} -type TypeEnv = TyVarEnv Type +import IdInfo -applyTypeEnvToId :: TypeEnv -> Id -> Id +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 -applyTypeEnvToId type_env id@(Id _ _ ty _ _ _) - | idHasNoFreeTyVars id - = id - | otherwise - = apply_to_Id ( \ ty -> - applyTypeEnvToTy type_env ty - ) id -\end{code} +infixl 1 `setIdUnfolding`, + `setIdArityInfo`, + `setIdDemandInfo`, + `setIdStrictness`, + `setIdTyGenInfo`, + `setIdWorkerInfo`, + `setIdSpecialisation`, + `setInlinePragma`, + `idCafInfo`, + `idCprInfo` -\begin{code} -apply_to_Id :: (Type -> Type) -> Id -> Id - -apply_to_Id ty_fn (Id u n ty details prag info) - = let - new_ty = ty_fn ty - in - Id u n new_ty (apply_to_details details) prag (apply_to_IdInfo ty_fn info) - where - apply_to_details (SpecId unspec ty_maybes no_ftvs) - = let - new_unspec = apply_to_Id ty_fn unspec - new_maybes = map apply_to_maybe ty_maybes - in - SpecId new_unspec new_maybes (no_free_tvs ty) - -- ToDo: gratuitous recalc no_ftvs???? (also InstId) - where - apply_to_maybe Nothing = Nothing - apply_to_maybe (Just ty) = Just (ty_fn ty) - - apply_to_details (WorkerId unwrkr) - = let - new_unwrkr = apply_to_Id ty_fn unwrkr - in - WorkerId new_unwrkr - - apply_to_details other = other + -- infixl so you can say (id `set` a `set` b) \end{code} -Sadly, I don't think the one using the magic typechecker substitution -can be done with @apply_to_Id@. Here we go.... -Strictness is very important here. We can't leave behind thunks -with pointers to the substitution: it {\em must} be single-threaded. - -\begin{code} -{-LATER: -applySubstToId :: Subst -> Id -> (Subst, Id) - -applySubstToId subst id@(Id u n ty info details) - -- *cannot* have a "idHasNoFreeTyVars" get-out clause - -- because, in the typechecker, we are still - -- *concocting* the types. - = case (applySubstToTy subst ty) of { (s2, new_ty) -> - case (applySubstToIdInfo s2 info) of { (s3, new_info) -> - case (apply_to_details s3 new_ty details) of { (s4, new_details) -> - (s4, Id u n new_ty new_info new_details) }}} - where - apply_to_details subst _ (InstId inst no_ftvs) - = case (applySubstToInst subst inst) of { (s2, new_inst) -> - (s2, InstId new_inst no_ftvs{-ToDo:right???-}) } - - apply_to_details subst new_ty (SpecId unspec ty_maybes _) - = case (applySubstToId subst unspec) of { (s2, new_unspec) -> - case (mapAccumL apply_to_maybe s2 ty_maybes) of { (s3, new_maybes) -> - (s3, SpecId new_unspec new_maybes (no_free_tvs new_ty)) }} - -- NB: recalc no_ftvs (I think it's necessary (?) WDP 95/04) - where - apply_to_maybe subst Nothing = (subst, Nothing) - apply_to_maybe subst (Just ty) - = case (applySubstToTy subst ty) of { (s2, new_ty) -> - (s2, Just new_ty) } - - apply_to_details subst _ (WorkerId unwrkr) - = case (applySubstToId subst unwrkr) of { (s2, new_unwrkr) -> - (s2, WorkerId new_unwrkr) } - - apply_to_details subst _ other = (subst, other) --} -\end{code} %************************************************************************ %* * -\subsection[Id-type-funs]{Type-related @Id@ functions} +\subsection{Simple Id construction} %* * %************************************************************************ -\begin{code} -idType :: GenId ty -> ty - -idType (Id _ _ ty _ _ _) = ty -\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} -{-LATER: -getMentionedTyConsAndClassesFromId :: Id -> (Bag TyCon, Bag Class) - -getMentionedTyConsAndClassesFromId id - = getMentionedTyConsAndClassesFromType (idType id) --} +mkId :: Name -> Type -> IdInfo -> Id +mkId name ty info = mkIdVar name (addFreeTyVars ty) info \end{code} \begin{code} -idPrimRep i = typePrimRep (idType i) -\end{code} - -%************************************************************************ -%* * -\subsection[Id-overloading]{Functions related to overloading} -%* * -%************************************************************************ - -\begin{code} -mkSuperDictSelId u clas sc ty - = addStandardIdInfo $ - Id u name ty details NoPragmaInfo noIdInfo - where - name = mkCompoundName name_fn u (getName clas) - details = SuperDictSelId clas sc - name_fn clas_str = SLIT("scsel_") _APPEND_ clas_str _APPEND_ mod _APPEND_ occNameString occ - (mod,occ) = modAndOcc sc - - -- For method selectors the clean thing to do is - -- to give the method selector the same name as the class op itself. -mkMethodSelId op_name rec_c op ty - = addStandardIdInfo $ - Id (uniqueOf op_name) op_name ty (MethodSelId rec_c op) NoPragmaInfo noIdInfo - -mkDefaultMethodId op_name uniq rec_c op gen ty - = Id uniq dm_name ty details NoPragmaInfo noIdInfo - where - dm_name = mkCompoundName name_fn uniq op_name - details = DefaultMethodId rec_c op gen - name_fn op_str = SLIT("dm_") _APPEND_ op_str - -mkDictFunId dfun_name full_ty clas ity - = Id (nameUnique dfun_name) dfun_name full_ty details NoPragmaInfo noIdInfo - where - details = DictFunId clas ity - -mkConstMethodId uniq clas op ity full_ty from_here locn mod info - = Id uniq name full_ty details NoPragmaInfo info - where - name = mkInstDeclName uniq mod (VarOcc occ_name) locn from_here - details = ConstMethodId clas ity op mod - occ_name = classOpString op _APPEND_ - SLIT("_cm_") _APPEND_ renum_type_string full_ty ity - -mkWorkerId u unwrkr ty info - = Id u name ty details NoPragmaInfo info - where - name = mkCompoundName name_fn u (getName unwrkr) - details = WorkerId unwrkr - name_fn wkr_str = wkr_str _APPEND_ SLIT("_wrk") - -mkInstId u ty name - = Id u (changeUnique name u) ty (InstId (no_free_tvs ty)) NoPragmaInfo noIdInfo - -{-LATER: -getConstMethodId clas op ty - = -- constant-method info is hidden in the IdInfo of - -- the class-op id (as mentioned up above). - let - sel_id = getMethodSelId clas op - in - case (lookupConstMethodId (getIdSpecialisation sel_id) ty) of - Just xx -> xx - Nothing -> pprError "ERROR: getConstMethodId:" (ppAboves [ - ppCat [ppr PprDebug ty, ppr PprDebug ops, ppr PprDebug op_ids, - ppr PprDebug sel_id], - ppStr "(This can arise if an interface pragma refers to an instance", - ppStr "but there is no imported interface which *defines* that instance.", - ppStr "The info above, however ugly, should indicate what else you need to import." - ]) --} - - -renum_type_string full_ty ity - = initNmbr ( - nmbrType full_ty `thenNmbr` \ _ -> -- so all the tyvars get added to renumbering... - nmbrType ity `thenNmbr` \ rn_ity -> - returnNmbr (getTypeString rn_ity) - ) -\end{code} - -%************************************************************************ -%* * -\subsection[local-funs]{@LocalId@-related functions} -%* * -%************************************************************************ - -\begin{code} -mkImported n ty info = Id (nameUnique n) n ty ImportedId NoPragmaInfo info - -mkPrimitiveId n ty primop - = addStandardIdInfo $ - Id (nameUnique n) n ty (PrimitiveId primop) NoPragmaInfo noIdInfo -\end{code} - -\begin{code} -type MyTy a b = GenType (GenTyVar a) b -type MyId a b = GenId (MyTy a b) - -no_free_tvs ty = isEmptyTyVarSet (tyVarsOfType ty) +mkVanillaId :: Name -> Type -> Id +mkVanillaId name ty = mkId name ty vanillaIdInfo -- SysLocal: for an Id being created by the compiler out of thin air... -- UserLocal: an Id with a name the user might recognize... -mkSysLocal :: FAST_STRING -> Unique -> MyTy a b -> SrcLoc -> MyId a b -mkUserLocal :: OccName -> Unique -> MyTy a b -> SrcLoc -> MyId a b - -mkSysLocal str uniq ty loc - = Id uniq (mkSysLocalName uniq str loc) ty (SysLocalId (no_free_tvs ty)) NoPragmaInfo noIdInfo +mkUserLocal :: OccName -> Unique -> Type -> SrcLoc -> Id +mkSysLocal :: UserFS -> Unique -> Type -> Id -mkUserLocal occ uniq ty loc - = Id uniq (mkLocalName uniq occ loc) ty (LocalId (no_free_tvs ty)) NoPragmaInfo noIdInfo - -mkUserId :: Name -> MyTy a b -> PragmaInfo -> MyId a b -mkUserId name ty pragma_info - = Id (nameUnique name) name ty (LocalId (no_free_tvs ty)) pragma_info noIdInfo -\end{code} - - -\begin{code} -{-LATER: - --- for a SpecPragmaId being created by the compiler out of thin air... -mkSpecPragmaId :: OccName -> Unique -> Type -> Maybe Id -> SrcLoc -> Id -mkSpecPragmaId str uniq ty specid loc - = Id uniq (mkShortName str loc) ty noIdInfo (SpecPragmaId specid (no_free_tvs ty)) - --- for new SpecId -mkSpecId u unspec ty_maybes ty info - = ASSERT(not (maybeToBool (isSpecId_maybe unspec))) - Id u n ty info (SpecId unspec ty_maybes (no_free_tvs ty)) - --- Specialised version of constructor: only used in STG and code generation --- Note: The specialsied Id has the same unique as the unspeced Id - -mkSameSpecCon ty_maybes unspec@(Id u n ty info details) - = ASSERT(isDataCon unspec) - ASSERT(not (maybeToBool (isSpecId_maybe unspec))) - Id u n new_ty info (SpecId unspec ty_maybes (no_free_tvs new_ty)) - where - new_ty = specialiseTy ty ty_maybes 0 - -localiseId :: Id -> Id -localiseId id@(Id u n ty info details) - = Id u (mkShortName name loc) ty info (LocalId (no_free_tvs ty)) - where - name = getOccName id - loc = getSrcLoc id --} - --- See notes with setNameVisibility (Name.lhs) -setIdVisibility :: Module -> Id -> Id -setIdVisibility mod (Id uniq name ty details prag info) - = Id uniq (setNameVisibility mod name) ty details prag info - -mkIdWithNewUniq :: Id -> Unique -> Id -mkIdWithNewUniq (Id _ n ty details prag info) u - = Id u (changeUnique n u) ty details prag info +mkSysLocal fs uniq ty = mkVanillaId (mkSysLocalName uniq fs) ty +mkUserLocal occ uniq ty loc = mkVanillaId (mkLocalName uniq occ loc) ty \end{code} 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} -mkTemplateLocals :: [Type] -> [Id] -mkTemplateLocals tys - = zipWith (\ u -> \ ty -> mkSysLocal SLIT("tpl") u ty mkBuiltinSrcLoc) - (getBuiltinUniques (length tys)) - tys -\end{code} \begin{code} -getIdInfo :: GenId ty -> IdInfo -getPragmaInfo :: GenId ty -> PragmaInfo - -getIdInfo (Id _ _ _ _ _ info) = info -getPragmaInfo (Id _ _ _ _ info _) = info +-- "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 -replaceIdInfo :: Id -> IdInfo -> Id +-- "Template locals" typically used in unfoldings +mkTemplateLocals :: [Type] -> [Id] +mkTemplateLocals tys = zipWith (mkSysLocal SLIT("tpl")) + (getBuiltinUniques (length tys)) + tys -replaceIdInfo (Id u n ty details pinfo _) info = Id u n ty details pinfo info +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 -{-LATER: -selectIdInfoForSpecId :: Id -> IdInfo -selectIdInfoForSpecId unspec - = ASSERT(not (maybeToBool (isSpecId_maybe unspec))) - noIdInfo `addUnfoldInfo` getIdUnfolding unspec --} +mkTemplateLocal :: Int -> Type -> Id +mkTemplateLocal i ty = mkSysLocal SLIT("tpl") (mkBuiltinUnique i) ty \end{code} -%************************************************************************ -%* * -\subsection[Id-arities]{Arity-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@(Id _ _ _ _ _ id_info) - = --ASSERT( not (isDataCon id)) - arityInfo id_info - -dataConArity, dataConNumFields :: DataCon -> Int - -dataConArity id@(Id _ _ _ _ _ id_info) - = ASSERT(isDataCon id) - case arityInfo id_info of - ArityExactly a -> a - other -> pprPanic "dataConArity:Nothing:" (pprId PprDebug id) - -dataConNumFields id - = ASSERT(isDataCon id) - case (dataConSig id) of { (_, _, arg_tys, _) -> - length arg_tys } - -isNullaryDataCon con = dataConNumFields con == 0 -- function of convenience - -addIdArity :: Id -> ArityInfo -> Id -addIdArity (Id u n ty details pinfo info) arity - = Id u n ty details pinfo (info `addArityInfo` arity) -\end{code} %************************************************************************ %* * -\subsection[constructor-funs]{@DataCon@-related functions (incl.~tuples)} +\subsection[Id-general-funs]{General @Id@-related functions} %* * %************************************************************************ \begin{code} -mkDataCon :: Name - -> [StrictnessMark] -> [FieldLabel] - -> [TyVar] -> ThetaType -> [TauType] -> TyCon - -> Id - -- can get the tag and all the pieces of the type from the Type - -mkDataCon n stricts fields tvs ctxt args_tys tycon - = ASSERT(length stricts == length args_tys) - addStandardIdInfo data_con - where - -- NB: data_con self-recursion; should be OK as tags are not - -- looked at until late in the game. - data_con - = Id (nameUnique n) - n - data_con_ty - (DataConId data_con_tag stricts fields tvs ctxt args_tys tycon) - IWantToBeINLINEd -- Always inline constructors if possible - noIdInfo - - data_con_tag = assoc "mkDataCon" (data_con_family `zip` [fIRST_TAG..]) data_con - data_con_family = tyConDataCons tycon - - data_con_ty - = mkSigmaTy tvs ctxt - (mkFunTys args_tys (applyTyCon tycon (mkTyVarTys tvs))) - - -mkTupleCon :: Arity -> Name -> Type -> Id -mkTupleCon arity name ty - = addStandardIdInfo tuple_id - where - tuple_id = Id (nameUnique name) name ty - (TupleConId arity) - IWantToBeINLINEd -- Always inline constructors if possible - noIdInfo - -fIRST_TAG :: ConTag -fIRST_TAG = 1 -- Tags allocated from here for real constructors -\end{code} +setIdType :: Id -> Type -> Id + -- Add free tyvar info to the type +setIdType id ty = seqType ty `seq` setVarType id (addFreeTyVars ty) -\begin{code} -dataConTag :: DataCon -> ConTag -- will panic if not a DataCon -dataConTag (Id _ _ _ (DataConId tag _ _ _ _ _ _) _ _) = tag -dataConTag (Id _ _ _ (TupleConId _) _ _) = fIRST_TAG -dataConTag (Id _ _ _ (SpecId unspec _ _) _ _) = dataConTag unspec - -dataConTyCon :: DataCon -> TyCon -- will panic if not a DataCon -dataConTyCon (Id _ _ _ (DataConId _ _ _ _ _ _ tycon) _ _) = tycon -dataConTyCon (Id _ _ _ (TupleConId a) _ _) = tupleTyCon a - -dataConSig :: DataCon -> ([TyVar], ThetaType, [TauType], TyCon) - -- will panic if not a DataCon - -dataConSig (Id _ _ _ (DataConId _ _ _ tyvars theta_ty arg_tys tycon) _ _) - = (tyvars, theta_ty, arg_tys, tycon) - -dataConSig (Id _ _ _ (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 --- 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 :: GenId (GenType tv u) -> GenType tv u -dataConRepType con - = mkForAllTys tyvars tau - where - (tyvars, theta, tau) = splitSigmaTy (idType con) - -dataConFieldLabels :: DataCon -> [FieldLabel] -dataConFieldLabels (Id _ _ _ (DataConId _ _ fields _ _ _ _) _ _) = fields -dataConFieldLabels (Id _ _ _ (TupleConId _) _ _) = [] - -dataConStrictMarks :: DataCon -> [StrictnessMark] -dataConStrictMarks (Id _ _ _ (DataConId _ stricts _ _ _ _ _) _ _) = stricts -dataConStrictMarks (Id _ _ _ (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 = zipEqual "dataConArgTys" tyvars inst_tys -\end{code} - -\begin{code} -mkRecordSelId field_label selector_ty - = addStandardIdInfo $ -- Record selectors have a standard unfolding - Id (nameUnique name) - name - selector_ty - (RecordSelId field_label) - NoPragmaInfo - noIdInfo - where - name = fieldLabelName field_label - -recordSelectorFieldLabel :: Id -> FieldLabel -recordSelectorFieldLabel (Id _ _ _ (RecordSelId lbl) _ _) = lbl - -isRecordSelector (Id _ _ _ (RecordSelId lbl) _ _) = True -isRecordSelector other = False +idPrimRep :: Id -> PrimRep +idPrimRep id = typePrimRep (idType id) \end{code} -Data type declarations are of the form: -\begin{verbatim} -data Foo a b = C1 ... | C2 ... | ... | Cn ... -\end{verbatim} -For each constructor @Ci@, we want to generate a curried function; so, e.g., for -@C1 x y z@, we want a function binding: -\begin{verbatim} -fun_C1 = /\ a -> /\ b -> \ [x, y, z] -> Con C1 [a, b] [x, y, z] -\end{verbatim} -Notice the ``big lambdas'' and type arguments to @Con@---we are producing -2nd-order polymorphic lambda calculus with explicit types. - %************************************************************************ %* * -\subsection[unfolding-Ids]{Functions related to @Ids@' unfoldings} +\subsection{Special Ids} %* * %************************************************************************ \begin{code} -getIdUnfolding :: Id -> Unfolding +idFlavour :: Id -> IdFlavour +idFlavour id = flavourInfo (idInfo id) -getIdUnfolding (Id _ _ _ _ _ info) = unfoldInfo info +setIdNoDiscard :: Id -> Id +setIdNoDiscard id -- Make an Id into a NoDiscardId, unless it is already + = modifyIdInfo setNoDiscardInfo id -addIdUnfolding :: Id -> Unfolding -> Id -addIdUnfolding id@(Id u n ty details prag info) unfolding - = Id u n ty details prag (info `addUnfoldInfo` unfolding) +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} -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} -idWantsToBeINLINEd :: Id -> Bool -idWantsToBeINLINEd (Id _ _ _ _ IWantToBeINLINEd _) = True -idWantsToBeINLINEd _ = False +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. -addInlinePragma :: Id -> Id -addInlinePragma (Id u sn ty details _ info) - = Id u sn ty details IWantToBeINLINEd info +\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} - -The predicate @idMustBeINLINEd@ says that this Id absolutely must be inlined. -It's only true for primitives, because we don't want to make a closure for each of them. - \begin{code} -idMustBeINLINEd (Id _ _ _ (PrimitiveId primop) _ _) = True -idMustBeINLINEd other = False +isDeadBinder :: Id -> Bool +isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr) + | otherwise = False -- TyVars count as not dead \end{code} %************************************************************************ %* * -\subsection[IdInfo-funs]{Functions related to @Ids@' @IdInfos@} +\subsection{IdInfo stuff} %* * %************************************************************************ \begin{code} -getIdDemandInfo :: Id -> DemandInfo -getIdDemandInfo (Id _ _ _ _ _ info) = demandInfo info + --------------------------------- + -- ARITY +idArityInfo :: Id -> ArityInfo +idArityInfo id = arityInfo (idInfo id) -addIdDemandInfo :: Id -> DemandInfo -> Id -addIdDemandInfo (Id u n ty details prags info) demand_info - = Id u n ty details prags (info `addDemandInfo` demand_info) -\end{code} +idArity :: Id -> Arity +idArity id = arityLowerBound (idArityInfo id) -\begin{code} -getIdUpdateInfo :: Id -> UpdateInfo -getIdUpdateInfo (Id _ _ _ _ _ info) = updateInfo info +setIdArityInfo :: Id -> ArityInfo -> Id +setIdArityInfo id arity = modifyIdInfo (`setArityInfo` arity) id -addIdUpdateInfo :: Id -> UpdateInfo -> Id -addIdUpdateInfo (Id u n ty details prags info) upd_info - = Id u n ty details prags (info `addUpdateInfo` upd_info) -\end{code} + --------------------------------- + -- STRICTNESS +idStrictness :: Id -> StrictnessInfo +idStrictness id = strictnessInfo (idInfo id) -\begin{code} -{- LATER: -getIdArgUsageInfo :: Id -> ArgUsageInfo -getIdArgUsageInfo (Id u n ty info details) = argUsageInfo info - -addIdArgUsageInfo :: Id -> ArgUsageInfo -> Id -addIdArgUsageInfo (Id u n ty info details) au_info - = Id u n ty (info `addArgusageInfo` au_info) details --} -\end{code} +setIdStrictness :: Id -> StrictnessInfo -> Id +setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id -\begin{code} -{- LATER: -getIdFBTypeInfo :: Id -> FBTypeInfo -getIdFBTypeInfo (Id u n ty info details) = fbTypeInfo info - -addIdFBTypeInfo :: Id -> FBTypeInfo -> Id -addIdFBTypeInfo (Id u n ty info details) upd_info - = Id u n ty (info `addFBTypeInfo` upd_info) details --} -\end{code} +-- isBottomingId returns true if an application to n args would diverge +isBottomingId :: Id -> Bool +isBottomingId id = isBottomingStrictness (idStrictness id) -\begin{code} -getIdSpecialisation :: Id -> SpecEnv -getIdSpecialisation (Id _ _ _ _ _ info) = specInfo info + --------------------------------- + -- TYPE GENERALISATION +idTyGenInfo :: Id -> TyGenInfo +idTyGenInfo id = tyGenInfo (idInfo id) -addIdSpecialisation :: Id -> SpecEnv -> Id -addIdSpecialisation (Id u n ty details prags info) spec_info - = Id u n ty details prags (info `addSpecInfo` spec_info) -\end{code} +setIdTyGenInfo :: Id -> TyGenInfo -> Id +setIdTyGenInfo id tygen_info = modifyIdInfo (`setTyGenInfo` tygen_info) id -Strictness: we snaffle the info out of the IdInfo. + --------------------------------- + -- WORKER ID +idWorkerInfo :: Id -> WorkerInfo +idWorkerInfo id = workerInfo (idInfo id) -\begin{code} -getIdStrictness :: Id -> StrictnessInfo Id +setIdWorkerInfo :: Id -> WorkerInfo -> Id +setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id -getIdStrictness (Id _ _ _ _ _ info) = strictnessInfo info + --------------------------------- + -- UNFOLDING +idUnfolding :: Id -> Unfolding +idUnfolding id = unfoldingInfo (idInfo id) -addIdStrictness :: Id -> StrictnessInfo Id -> Id -addIdStrictness (Id u n ty details prags info) strict_info - = Id u n ty details prags (info `addStrictnessInfo` strict_info) -\end{code} +setIdUnfolding :: Id -> Unfolding -> Id +setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id -%************************************************************************ -%* * -\subsection[Id-comparison]{Comparison functions for @Id@s} -%* * -%************************************************************************ + --------------------------------- + -- DEMAND +idDemandInfo :: Id -> Demand +idDemandInfo id = demandInfo (idInfo id) -Comparison: equality and ordering---this stuff gets {\em hammered}. +setIdDemandInfo :: Id -> Demand -> Id +setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id -\begin{code} -cmpId (Id u1 _ _ _ _ _) (Id u2 _ _ _ _ _) = cmp u1 u2 --- short and very sweet -\end{code} + --------------------------------- + -- SPECIALISATION +idSpecialisation :: Id -> CoreRules +idSpecialisation id = specInfo (idInfo id) -\begin{code} -instance Ord3 (GenId ty) where - cmp = cmpId - -instance Eq (GenId ty) where - a == b = case (a `cmp` b) of { EQ_ -> True; _ -> False } - a /= b = case (a `cmp` b) of { EQ_ -> False; _ -> True } - -instance Ord (GenId ty) where - a <= b = case (a `cmp` b) of { LT_ -> True; EQ_ -> True; GT__ -> False } - a < b = case (a `cmp` b) of { LT_ -> True; EQ_ -> False; GT__ -> False } - a >= b = case (a `cmp` b) of { LT_ -> False; EQ_ -> True; GT__ -> True } - a > b = case (a `cmp` b) of { LT_ -> False; EQ_ -> False; GT__ -> True } - _tagCmp a b = case (a `cmp` b) of { LT_ -> _LT; EQ_ -> _EQ; GT__ -> _GT } -\end{code} +setIdSpecialisation :: Id -> CoreRules -> Id +setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id -@cmpId_withSpecDataCon@ ensures that any spectys are taken into -account when comparing two data constructors. We need to do this -because a specialised data constructor has the same Unique as its -unspecialised counterpart. + --------------------------------- + -- CAF INFO +idCafInfo :: Id -> CafInfo +idCafInfo id = cafInfo (idInfo id) -\begin{code} -cmpId_withSpecDataCon :: Id -> Id -> TAG_ +setIdCafInfo :: Id -> CafInfo -> Id +setIdCafInfo id caf_info = modifyIdInfo (`setCafInfo` caf_info) id -cmpId_withSpecDataCon id1 id2 - | eq_ids && isDataCon id1 && isDataCon id2 - = cmpEqDataCon id1 id2 + --------------------------------- + -- CPR INFO +idCprInfo :: Id -> CprInfo +idCprInfo id = cprInfo (idInfo id) - | otherwise - = cmp_ids - where - cmp_ids = cmpId id1 id2 - eq_ids = case cmp_ids of { EQ_ -> True; other -> False } +setIdCprInfo :: Id -> CprInfo -> Id +setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id -cmpEqDataCon (Id _ _ _ (SpecId _ mtys1 _) _ _) (Id _ _ _ (SpecId _ mtys2 _) _ _) - = panic# "Id.cmpEqDataCon:cmpUniTypeMaybeList mtys1 mtys2" + --------------------------------- + -- Occcurrence INFO +idOccInfo :: Id -> OccInfo +idOccInfo id = occInfo (idInfo id) -cmpEqDataCon _ (Id _ _ _ (SpecId _ _ _) _ _) = LT_ -cmpEqDataCon (Id _ _ _ (SpecId _ _ _) _ _) _ = GT_ -cmpEqDataCon _ _ = EQ_ +setIdOccInfo :: Id -> OccInfo -> Id +setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id \end{code} -%************************************************************************ -%* * -\subsection[Id-other-instances]{Other instance declarations for @Id@s} -%* * -%************************************************************************ + + --------------------------------- + -- 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 Outputable ty => Outputable (GenId ty) where - ppr sty id = pprId sty id +idInlinePragma :: Id -> InlinePragInfo +idInlinePragma id = inlinePragInfo (idInfo id) --- and a SPECIALIZEd one: -instance Outputable {-Id, i.e.:-}(GenId Type) where - ppr sty id = pprId sty id +setInlinePragma :: Id -> InlinePragInfo -> Id +setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id -showId :: PprStyle -> Id -> String -showId sty id = ppShow 80 (pprId sty 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 => PprStyle -> GenId ty -> Pretty - -pprId sty (Id u n _ _ _ _) = ppr sty n - -- WDP 96/05/06: We can re-elaborate this as we go along... -\end{code} + --------------------------------- + -- ONE-SHOT LAMBDAS \begin{code} -idUnique (Id u _ _ _ _ _) = u +idLBVarInfo :: Id -> LBVarInfo +idLBVarInfo id = lbvarInfo (idInfo id) -instance Uniquable (GenId ty) where - uniqueOf = idUnique +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 -instance NamedThing (GenId ty) where - getName this_id@(Id u n _ details _ _) = n -\end{code} + -- 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. -Note: The code generator doesn't carry a @UniqueSupply@, so it uses -the @Uniques@ out of local @Ids@ given to it. +setOneShotLambda :: Id -> Id +setOneShotLambda id = modifyIdInfo (`setLBVarInfo` LBVarInfo usOnce) id -%************************************************************************ -%* * -\subsection{@IdEnv@s and @IdSet@s} -%* * -%************************************************************************ +clearOneShotLambda :: Id -> Id +clearOneShotLambda id + | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id + | otherwise = id -\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 +-- 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} \begin{code} -addOneToIdEnv = addToUFM -combineIdEnvs = plusUFM_C -delManyFromIdEnv = delListFromUFM -delOneFromIdEnv = delFromUFM -growIdEnv = plusUFM -lookupIdEnv = lookupUFM -mapIdEnv = mapUFM -mkIdEnv = listToUFM -nullIdEnv = emptyUFM -rngIdEnv = eltsUFM -unitIdEnv = unitUFM - -growIdEnvList env pairs = plusUFM env (listToUFM pairs) -isNullIdEnv env = sizeUFM env == 0 -lookupNoFailIdEnv env id = case (lookupIdEnv env id) of { Just xx -> xx } - --- 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) -\end{code} +zapFragileIdInfo :: Id -> Id +zapFragileIdInfo id = maybeModifyIdInfo zapFragileInfo id -\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 +zapLamIdInfo :: Id -> Id +zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id \end{code} -\begin{code} -addId, nmbrId, nmbrDataCon :: Id -> NmbrM Id - -addId id@(Id u n ty det prag info) nenv@(NmbrEnv ui ut uu idenv tvenv uvenv) - = case (lookupUFM_Directly idenv u) of - Just xx -> trace "addId: already in map!" $ - (nenv, xx) - Nothing -> - if toplevelishId id then - trace "addId: can't add toplevelish!" $ - (nenv, id) - else -- alloc a new unique for this guy - -- and add an entry in the idenv - -- NB: *** KNOT-TYING *** - let - nenv_plus_id = NmbrEnv (incrUnique ui) ut uu - (addToUFM_Directly idenv u new_id) - tvenv uvenv - - (nenv2, new_ty) = nmbrType ty nenv_plus_id - (nenv3, new_det) = nmbr_details det nenv2 - - new_id = Id ui n new_ty new_det prag info - in - (nenv3, new_id) - -nmbrId id@(Id u n ty det prag info) nenv@(NmbrEnv ui ut uu idenv tvenv uvenv) - = case (lookupUFM_Directly idenv u) of - Just xx -> (nenv, xx) - Nothing -> - if not (toplevelishId id) then - trace "nmbrId: lookup failed" $ - (nenv, id) - else - let - (nenv2, new_ty) = nmbrType ty nenv - (nenv3, new_det) = nmbr_details det nenv2 - - new_id = Id u n new_ty new_det prag info - in - (nenv3, new_id) - - -- used when renumbering TyCons to produce data decls... -nmbrDataCon id@(Id _ _ _ (TupleConId _) _ _) nenv - = (nenv, id) -- nothing to do for tuples - -nmbrDataCon id@(Id u n ty (DataConId tag marks fields tvs theta arg_tys tc) prag info) nenv@(NmbrEnv ui ut uu idenv tvenv uvenv) - = case (lookupUFM_Directly idenv u) of - Just xx -> trace "nmbrDataCon: in env???\n" (nenv, xx) - Nothing -> - let - (nenv2, new_fields) = (mapNmbr nmbrField fields) nenv - (nenv3, new_arg_tys) = (mapNmbr nmbrType arg_tys) nenv2 - - new_det = DataConId tag marks new_fields (bottom "tvs") (bottom "theta") new_arg_tys tc - new_id = Id u n (bottom "ty") new_det prag info - in - (nenv3, new_id) - where - bottom msg = panic ("nmbrDataCon"++msg) - ------------- -nmbr_details :: IdDetails -> NmbrM IdDetails - -nmbr_details (DataConId tag marks fields tvs theta arg_tys tc) - = mapNmbr nmbrTyVar tvs `thenNmbr` \ new_tvs -> - mapNmbr nmbrField fields `thenNmbr` \ new_fields -> - mapNmbr nmbr_theta theta `thenNmbr` \ new_theta -> - mapNmbr nmbrType arg_tys `thenNmbr` \ new_arg_tys -> - returnNmbr (DataConId tag marks new_fields new_tvs new_theta new_arg_tys tc) - where - nmbr_theta (c,t) - = --nmbrClass c `thenNmbr` \ new_c -> - nmbrType t `thenNmbr` \ new_t -> - returnNmbr (c, new_t) - - -- ToDo:add more cases as needed -nmbr_details other_details = returnNmbr other_details - ------------- -nmbrField (FieldLabel n ty tag) - = nmbrType ty `thenNmbr` \ new_ty -> - returnNmbr (FieldLabel n new_ty tag) -\end{code}