ghc/compiler/basicTypes/Id.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
   3 %
   4 \section[Id]{@Ids@: Value and constructor identifiers}
   5
   6 \begin{code}
   7 module Id (
   8         Id, DictId,
   9
  10         -- Simple construction
  11         mkGlobalId, mkLocalId, mkSpecPragmaId, mkLocalIdWithInfo,
  12         mkSysLocal, mkSysLocalUnencoded, mkUserLocal, mkVanillaGlobal,
  13         mkTemplateLocals, mkTemplateLocalsNum, mkWildId, mkTemplateLocal,
  14         mkWorkerId, mkExportedLocalId,
  15
  16         -- Taking an Id apart
  17         idName, idType, idUnique, idInfo,
  18         isId, globalIdDetails, idPrimRep,
  19         recordSelectorFieldLabel,
  20
  21         -- Modifying an Id
  22         setIdName, setIdUnique, Id.setIdType, setIdExported, setIdNotExported,
  23         setIdInfo, lazySetIdInfo, modifyIdInfo, maybeModifyIdInfo,
  24         zapLamIdInfo, zapDemandIdInfo,
  25
  26         -- Predicates
  27         isImplicitId, isDeadBinder,
  28         isSpecPragmaId, isExportedId, isLocalId, isGlobalId,
  29         isRecordSelector,
  30         isPrimOpId, isPrimOpId_maybe,
  31         isFCallId, isFCallId_maybe,
  32         isDataConWorkId, isDataConWorkId_maybe,
  33         isBottomingId, idIsFrom,
  34         hasNoBinding,
  35
  36         -- Inline pragma stuff
  37         idInlinePragma, setInlinePragma, modifyInlinePragma,
  38
  39
  40         -- One shot lambda stuff
  41         isOneShotBndr, isOneShotLambda, isStateHackType,
  42         setOneShotLambda, clearOneShotLambda,
  43
  44         -- IdInfo stuff
  45         setIdUnfolding,
  46         setIdArity,
  47         setIdNewDemandInfo,
  48         setIdNewStrictness, zapIdNewStrictness,
  49         setIdWorkerInfo,
  50         setIdSpecialisation,
  51         setIdCafInfo,
  52         setIdOccInfo,
  53
  54 #ifdef OLD_STRICTNESS
  55         idDemandInfo,
  56         idStrictness,
  57         idCprInfo,
  58         setIdStrictness,
  59         setIdDemandInfo,
  60         setIdCprInfo,
  61 #endif
  62
  63         idArity,
  64         idNewDemandInfo, idNewDemandInfo_maybe,
  65         idNewStrictness, idNewStrictness_maybe,
  66         idWorkerInfo,
  67         idUnfolding,
  68         idSpecialisation, idCoreRules,
  69         idCafInfo,
  70         idLBVarInfo,
  71         idOccInfo,
  72
  73 #ifdef OLD_STRICTNESS
  74         newStrictnessFromOld    -- Temporary
  75 #endif
  76
  77     ) where
  78
  79 #include "HsVersions.h"
  80
  81
  82 import CoreSyn          ( Unfolding, CoreRules, IdCoreRule(..), rulesRules )
  83 import BasicTypes       ( Arity )
  84 import Var              ( Id, DictId,
  85                           isId, isExportedId, isSpecPragmaId, isLocalId,
  86                           idName, idType, idUnique, idInfo, isGlobalId,
  87                           setIdName, setIdType, setIdUnique,
  88                           setIdExported, setIdNotExported,
  89                           setIdInfo, lazySetIdInfo, modifyIdInfo,
  90                           maybeModifyIdInfo,
  91                           globalIdDetails
  92                         )
  93 import qualified Var    ( mkLocalId, mkGlobalId, mkSpecPragmaId, mkExportedLocalId )
  94 import TyCon            ( FieldLabel, TyCon )
  95 import Type             ( Type, typePrimRep, addFreeTyVars, seqType,
  96                           splitTyConApp_maybe, PrimRep )
  97 import TysPrim          ( statePrimTyCon )
  98 import IdInfo
  99
 100 #ifdef OLD_STRICTNESS
 101 import qualified Demand ( Demand )
 102 #endif
 103 import DataCon          ( isUnboxedTupleCon )
 104 import NewDemand        ( Demand, StrictSig, topDmd, topSig, isBottomingSig )
 105 import Name             ( Name, OccName, nameIsLocalOrFrom,
 106                           mkSystemVarName, mkSystemVarNameEncoded, mkInternalName,
 107                           getOccName, getSrcLoc
 108                         )
 109 import Module           ( Module )
 110 import OccName          ( EncodedFS, mkWorkerOcc )
 111 import Maybes           ( orElse )
 112 import SrcLoc           ( SrcLoc )
 113 import Outputable
 114 import Unique           ( Unique, mkBuiltinUnique )
 115 import CmdLineOpts      ( opt_NoStateHack )
 116
 117 -- infixl so you can say (id `set` a `set` b)
 118 infixl  1 `setIdUnfolding`,
 119           `setIdArity`,
 120           `setIdNewDemandInfo`,
 121           `setIdNewStrictness`,
 122           `setIdWorkerInfo`,
 123           `setIdSpecialisation`,
 124           `setInlinePragma`,
 125           `idCafInfo`
 126 #ifdef OLD_STRICTNESS
 127           ,`idCprInfo`
 128           ,`setIdStrictness`
 129           ,`setIdDemandInfo`
 130 #endif
 131 \end{code}
 132
 133
 134
 135 %************************************************************************
 136 %*                                                                      *
 137 \subsection{Simple Id construction}
 138 %*                                                                      *
 139 %************************************************************************
 140
 141 Absolutely all Ids are made by mkId.  It is just like Var.mkId,
 142 but in addition it pins free-tyvar-info onto the Id's type,
 143 where it can easily be found.
 144
 145 \begin{code}
 146 mkLocalIdWithInfo :: Name -> Type -> IdInfo -> Id
 147 mkLocalIdWithInfo name ty info = Var.mkLocalId name (addFreeTyVars ty) info
 148
 149 mkSpecPragmaId :: Name -> Type -> Id
 150 mkSpecPragmaId name ty = Var.mkSpecPragmaId name (addFreeTyVars ty) vanillaIdInfo
 151
 152 mkExportedLocalId :: Name -> Type -> Id
 153 mkExportedLocalId name ty = Var.mkExportedLocalId name (addFreeTyVars ty) vanillaIdInfo
 154
 155 mkGlobalId :: GlobalIdDetails -> Name -> Type -> IdInfo -> Id
 156 mkGlobalId details name ty info = Var.mkGlobalId details name (addFreeTyVars ty) info
 157 \end{code}
 158
 159 \begin{code}
 160 mkLocalId :: Name -> Type -> Id
 161 mkLocalId name ty = mkLocalIdWithInfo name ty vanillaIdInfo
 162
 163 -- SysLocal: for an Id being created by the compiler out of thin air...
 164 -- UserLocal: an Id with a name the user might recognize...
 165 mkUserLocal :: OccName -> Unique -> Type -> SrcLoc -> Id
 166 mkSysLocal  :: EncodedFS  -> Unique -> Type -> Id
 167 mkVanillaGlobal :: Name -> Type -> IdInfo -> Id
 168
 169 -- for SysLocal, we assume the base name is already encoded, to avoid
 170 -- re-encoding the same string over and over again.
 171 mkSysLocal fs uniq ty = mkLocalId (mkSystemVarNameEncoded uniq fs) ty
 172
 173 -- version to use when the faststring needs to be encoded
 174 mkSysLocalUnencoded fs uniq ty = mkLocalId (mkSystemVarName uniq fs)  ty
 175
 176 mkUserLocal occ uniq ty loc = mkLocalId (mkInternalName    uniq occ loc) ty
 177 mkVanillaGlobal             = mkGlobalId VanillaGlobal
 178 \end{code}
 179
 180 Make some local @Ids@ for a template @CoreExpr@.  These have bogus
 181 @Uniques@, but that's OK because the templates are supposed to be
 182 instantiated before use.
 183
 184 \begin{code}
 185 -- "Wild Id" typically used when you need a binder that you don't expect to use
 186 mkWildId :: Type -> Id
 187 mkWildId ty = mkSysLocal FSLIT("wild") (mkBuiltinUnique 1) ty
 188
 189 mkWorkerId :: Unique -> Id -> Type -> Id
 190 -- A worker gets a local name.  CoreTidy will externalise it if necessary.
 191 mkWorkerId uniq unwrkr ty
 192   = mkLocalId wkr_name ty
 193   where
 194     wkr_name = mkInternalName uniq (mkWorkerOcc (getOccName unwrkr)) (getSrcLoc unwrkr)
 195
 196 -- "Template locals" typically used in unfoldings
 197 mkTemplateLocals :: [Type] -> [Id]
 198 mkTemplateLocals tys = zipWith mkTemplateLocal [1..] tys
 199
 200 mkTemplateLocalsNum :: Int -> [Type] -> [Id]
 201 -- The Int gives the starting point for unique allocation
 202 mkTemplateLocalsNum n tys = zipWith mkTemplateLocal [n..] tys
 203
 204 mkTemplateLocal :: Int -> Type -> Id
 205 mkTemplateLocal i ty = mkSysLocal FSLIT("tpl") (mkBuiltinUnique i) ty
 206 \end{code}
 207
 208
 209 %************************************************************************
 210 %*                                                                      *
 211 \subsection[Id-general-funs]{General @Id@-related functions}
 212 %*                                                                      *
 213 %************************************************************************
 214
 215 \begin{code}
 216 setIdType :: Id -> Type -> Id
 217         -- Add free tyvar info to the type
 218 setIdType id ty = seqType ty `seq` Var.setIdType id (addFreeTyVars ty)
 219
 220 idPrimRep :: Id -> PrimRep
 221 idPrimRep id = typePrimRep (idType id)
 222 \end{code}
 223
 224
 225 %************************************************************************
 226 %*                                                                      *
 227 \subsection{Special Ids}
 228 %*                                                                      *
 229 %************************************************************************
 230
 231 The @SpecPragmaId@ exists only to make Ids that are
 232 on the *LHS* of bindings created by SPECIALISE pragmas;
 233 eg:             s = f Int d
 234 The SpecPragmaId is never itself mentioned; it
 235 exists solely so that the specialiser will find
 236 the call to f, and make specialised version of it.
 237 The SpecPragmaId binding is discarded by the specialiser
 238 when it gathers up overloaded calls.
 239 Meanwhile, it is not discarded as dead code.
 240
 241
 242 \begin{code}
 243 recordSelectorFieldLabel :: Id -> (TyCon, FieldLabel)
 244 recordSelectorFieldLabel id = case globalIdDetails id of
 245                                  RecordSelId tycon lbl -> (tycon,lbl)
 246                                  other -> panic "recordSelectorFieldLabel"
 247
 248 isRecordSelector id = case globalIdDetails id of
 249                         RecordSelId _ _ -> True
 250                         other           -> False
 251
 252 isPrimOpId id = case globalIdDetails id of
 253                     PrimOpId op -> True
 254                     other       -> False
 255
 256 isPrimOpId_maybe id = case globalIdDetails id of
 257                             PrimOpId op -> Just op
 258                             other       -> Nothing
 259
 260 isFCallId id = case globalIdDetails id of
 261                     FCallId call -> True
 262                     other        -> False
 263
 264 isFCallId_maybe id = case globalIdDetails id of
 265                             FCallId call -> Just call
 266                             other        -> Nothing
 267
 268 isDataConWorkId id = case globalIdDetails id of
 269                         DataConWorkId _ -> True
 270                         other           -> False
 271
 272 isDataConWorkId_maybe id = case globalIdDetails id of
 273                           DataConWorkId con -> Just con
 274                           other             -> Nothing
 275
 276 -- hasNoBinding returns True of an Id which may not have a
 277 -- binding, even though it is defined in this module.
 278 -- Data constructor workers used to be things of this kind, but
 279 -- they aren't any more.  Instead, we inject a binding for
 280 -- them at the CorePrep stage.
 281 -- EXCEPT: unboxed tuples, which definitely have no binding
 282 hasNoBinding id = case globalIdDetails id of
 283                         PrimOpId _       -> True
 284                         FCallId _        -> True
 285                         DataConWorkId dc -> isUnboxedTupleCon dc
 286                         other            -> False
 287
 288 isImplicitId :: Id -> Bool
 289         -- isImplicitId tells whether an Id's info is implied by other
 290         -- declarations, so we don't need to put its signature in an interface
 291         -- file, even if it's mentioned in some other interface unfolding.
 292 isImplicitId id
 293   = case globalIdDetails id of
 294         RecordSelId _ _ -> True
 295         FCallId _       -> True
 296         PrimOpId _      -> True
 297         ClassOpId _     -> True
 298         DataConWorkId _ -> True
 299         DataConWrapId _ -> True
 300                 -- These are are implied by their type or class decl;
 301                 -- remember that all type and class decls appear in the interface file.
 302                 -- The dfun id is not an implicit Id; it must *not* be omitted, because
 303                 -- it carries version info for the instance decl
 304         other           -> False
 305
 306 idIsFrom :: Module -> Id -> Bool
 307 idIsFrom mod id = nameIsLocalOrFrom mod (idName id)
 308 \end{code}
 309
 310 \begin{code}
 311 isDeadBinder :: Id -> Bool
 312 isDeadBinder bndr | isId bndr = isDeadOcc (idOccInfo bndr)
 313                   | otherwise = False   -- TyVars count as not dead
 314 \end{code}
 315
 316
 317 %************************************************************************
 318 %*                                                                      *
 319 \subsection{IdInfo stuff}
 320 %*                                                                      *
 321 %************************************************************************
 322
 323 \begin{code}
 324         ---------------------------------
 325         -- ARITY
 326 idArity :: Id -> Arity
 327 idArity id = arityInfo (idInfo id)
 328
 329 setIdArity :: Id -> Arity -> Id
 330 setIdArity id arity = modifyIdInfo (`setArityInfo` arity) id
 331
 332 #ifdef OLD_STRICTNESS
 333         ---------------------------------
 334         -- (OLD) STRICTNESS
 335 idStrictness :: Id -> StrictnessInfo
 336 idStrictness id = strictnessInfo (idInfo id)
 337
 338 setIdStrictness :: Id -> StrictnessInfo -> Id
 339 setIdStrictness id strict_info = modifyIdInfo (`setStrictnessInfo` strict_info) id
 340 #endif
 341
 342 -- isBottomingId returns true if an application to n args would diverge
 343 isBottomingId :: Id -> Bool
 344 isBottomingId id = isBottomingSig (idNewStrictness id)
 345
 346 idNewStrictness_maybe :: Id -> Maybe StrictSig
 347 idNewStrictness :: Id -> StrictSig
 348
 349 idNewStrictness_maybe id = newStrictnessInfo (idInfo id)
 350 idNewStrictness       id = idNewStrictness_maybe id `orElse` topSig
 351
 352 setIdNewStrictness :: Id -> StrictSig -> Id
 353 setIdNewStrictness id sig = modifyIdInfo (`setNewStrictnessInfo` Just sig) id
 354
 355 zapIdNewStrictness :: Id -> Id
 356 zapIdNewStrictness id = modifyIdInfo (`setNewStrictnessInfo` Nothing) id
 357
 358         ---------------------------------
 359         -- WORKER ID
 360 idWorkerInfo :: Id -> WorkerInfo
 361 idWorkerInfo id = workerInfo (idInfo id)
 362
 363 setIdWorkerInfo :: Id -> WorkerInfo -> Id
 364 setIdWorkerInfo id work_info = modifyIdInfo (`setWorkerInfo` work_info) id
 365
 366         ---------------------------------
 367         -- UNFOLDING
 368 idUnfolding :: Id -> Unfolding
 369 idUnfolding id = unfoldingInfo (idInfo id)
 370
 371 setIdUnfolding :: Id -> Unfolding -> Id
 372 setIdUnfolding id unfolding = modifyIdInfo (`setUnfoldingInfo` unfolding) id
 373
 374 #ifdef OLD_STRICTNESS
 375         ---------------------------------
 376         -- (OLD) DEMAND
 377 idDemandInfo :: Id -> Demand.Demand
 378 idDemandInfo id = demandInfo (idInfo id)
 379
 380 setIdDemandInfo :: Id -> Demand.Demand -> Id
 381 setIdDemandInfo id demand_info = modifyIdInfo (`setDemandInfo` demand_info) id
 382 #endif
 383
 384 idNewDemandInfo_maybe :: Id -> Maybe NewDemand.Demand
 385 idNewDemandInfo       :: Id -> NewDemand.Demand
 386
 387 idNewDemandInfo_maybe id = newDemandInfo (idInfo id)
 388 idNewDemandInfo       id = newDemandInfo (idInfo id) `orElse` NewDemand.topDmd
 389
 390 setIdNewDemandInfo :: Id -> NewDemand.Demand -> Id
 391 setIdNewDemandInfo id dmd = modifyIdInfo (`setNewDemandInfo` Just dmd) id
 392
 393         ---------------------------------
 394         -- SPECIALISATION
 395 idSpecialisation :: Id -> CoreRules
 396 idSpecialisation id = specInfo (idInfo id)
 397
 398 idCoreRules :: Id -> [IdCoreRule]
 399 idCoreRules id = [IdCoreRule id False rule | rule <- rulesRules (idSpecialisation id)]
 400
 401 setIdSpecialisation :: Id -> CoreRules -> Id
 402 setIdSpecialisation id spec_info = modifyIdInfo (`setSpecInfo` spec_info) id
 403
 404         ---------------------------------
 405         -- CAF INFO
 406 idCafInfo :: Id -> CafInfo
 407 #ifdef OLD_STRICTNESS
 408 idCafInfo id = case cgInfo (idInfo id) of
 409                   NoCgInfo -> pprPanic "idCafInfo" (ppr id)
 410                   info     -> cgCafInfo info
 411 #else
 412 idCafInfo id = cafInfo (idInfo id)
 413 #endif
 414
 415 setIdCafInfo :: Id -> CafInfo -> Id
 416 setIdCafInfo id caf_info = modifyIdInfo (`setCafInfo` caf_info) id
 417
 418         ---------------------------------
 419         -- CPR INFO
 420 #ifdef OLD_STRICTNESS
 421 idCprInfo :: Id -> CprInfo
 422 idCprInfo id = cprInfo (idInfo id)
 423
 424 setIdCprInfo :: Id -> CprInfo -> Id
 425 setIdCprInfo id cpr_info = modifyIdInfo (`setCprInfo` cpr_info) id
 426 #endif
 427
 428         ---------------------------------
 429         -- Occcurrence INFO
 430 idOccInfo :: Id -> OccInfo
 431 idOccInfo id = occInfo (idInfo id)
 432
 433 setIdOccInfo :: Id -> OccInfo -> Id
 434 setIdOccInfo id occ_info = modifyIdInfo (`setOccInfo` occ_info) id
 435 \end{code}
 436
 437
 438         ---------------------------------
 439         -- INLINING
 440 The inline pragma tells us to be very keen to inline this Id, but it's still
 441 OK not to if optimisation is switched off.
 442
 443 \begin{code}
 444 idInlinePragma :: Id -> InlinePragInfo
 445 idInlinePragma id = inlinePragInfo (idInfo id)
 446
 447 setInlinePragma :: Id -> InlinePragInfo -> Id
 448 setInlinePragma id prag = modifyIdInfo (`setInlinePragInfo` prag) id
 449
 450 modifyInlinePragma :: Id -> (InlinePragInfo -> InlinePragInfo) -> Id
 451 modifyInlinePragma id fn = modifyIdInfo (\info -> info `setInlinePragInfo` (fn (inlinePragInfo info))) id
 452 \end{code}
 453
 454
 455         ---------------------------------
 456         -- ONE-SHOT LAMBDAS
 457 \begin{code}
 458 idLBVarInfo :: Id -> LBVarInfo
 459 idLBVarInfo id = lbvarInfo (idInfo id)
 460
 461 isOneShotBndr :: Id -> Bool
 462 -- This one is the "business end", called externally.
 463 -- Its main purpose is to encapsulate the Horrible State Hack
 464 isOneShotBndr id = isOneShotLambda id || (isStateHackType (idType id))
 465
 466 isStateHackType :: Type -> Bool
 467 isStateHackType ty
 468   | opt_NoStateHack
 469   = False
 470   | otherwise
 471   = case splitTyConApp_maybe ty of
 472         Just (tycon,_) -> tycon == statePrimTyCon
 473         other          -> False
 474         -- This is a gross hack.  It claims that
 475         -- every function over realWorldStatePrimTy is a one-shot
 476         -- function.  This is pretty true in practice, and makes a big
 477         -- difference.  For example, consider
 478         --      a `thenST` \ r -> ...E...
 479         -- The early full laziness pass, if it doesn't know that r is one-shot
 480         -- will pull out E (let's say it doesn't mention r) to give
 481         --      let lvl = E in a `thenST` \ r -> ...lvl...
 482         -- When `thenST` gets inlined, we end up with
 483         --      let lvl = E in \s -> case a s of (r, s') -> ...lvl...
 484         -- and we don't re-inline E.
 485         --
 486         -- It would be better to spot that r was one-shot to start with, but
 487         -- I don't want to rely on that.
 488         --
 489         -- Another good example is in fill_in in PrelPack.lhs.  We should be able to
 490         -- spot that fill_in has arity 2 (and when Keith is done, we will) but we can't yet.
 491
 492
 493 -- The OneShotLambda functions simply fiddle with the IdInfo flag
 494 isOneShotLambda :: Id -> Bool
 495 isOneShotLambda id = case idLBVarInfo id of
 496                        IsOneShotLambda  -> True
 497                        NoLBVarInfo      -> False
 498
 499 setOneShotLambda :: Id -> Id
 500 setOneShotLambda id = modifyIdInfo (`setLBVarInfo` IsOneShotLambda) id
 501
 502 clearOneShotLambda :: Id -> Id
 503 clearOneShotLambda id
 504   | isOneShotLambda id = modifyIdInfo (`setLBVarInfo` NoLBVarInfo) id
 505   | otherwise          = id
 506
 507 -- But watch out: this may change the type of something else
 508 --      f = \x -> e
 509 -- If we change the one-shot-ness of x, f's type changes
 510 \end{code}
 511
 512 \begin{code}
 513 zapLamIdInfo :: Id -> Id
 514 zapLamIdInfo id = maybeModifyIdInfo zapLamInfo id
 515
 516 zapDemandIdInfo id = maybeModifyIdInfo zapDemandInfo id
 517 \end{code}
 518