2 % (c) The University of Glasgow, 2000
4 \section[HscTypes]{Types for the per-module compiler}
8 -- * Sessions and compilation state
9 Session(..), HscEnv(..), hscEPS,
10 FinderCache, FindResult(..), ModLocationCache,
11 Target(..), TargetId(..), pprTarget, pprTargetId,
14 ModDetails(..), emptyModDetails,
15 ModGuts(..), CgGuts(..), ModImports(..), ForeignStubs(..),
17 ModSummary(..), showModMsg, isBootSummary,
18 msHsFilePath, msHiFilePath, msObjFilePath,
20 HscSource(..), isHsBoot, hscSourceString, -- Re-exported from DriverPhases
22 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
23 hptInstances, hptRules,
25 ExternalPackageState(..), EpsStats(..), addEpsInStats,
26 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
27 lookupIfaceByModule, emptyModIface,
29 InteractiveContext(..), emptyInteractiveContext,
30 icPrintUnqual, mkPrintUnqualified,
32 ModIface(..), mkIfaceDepCache, mkIfaceVerCache, mkIfaceFixCache,
35 Deprecs(..), IfaceDeprecs,
37 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
41 TyThing(..), tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
42 TypeEnv, lookupType, mkTypeEnv, emptyTypeEnv,
43 extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
44 typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
47 WhetherHasOrphans, IsBootInterface, Usage(..),
48 Dependencies(..), noDependencies,
49 NameCache(..), OrigNameCache, OrigIParamCache,
50 Avails, availsToNameSet, availName, availNames,
51 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
54 Deprecations, DeprecTxt, lookupDeprec, plusDeprecs,
56 PackageInstEnv, PackageRuleBase,
59 Linkable(..), isObjectLinkable,
60 Unlinked(..), CompiledByteCode,
61 isObject, nameOfObject, isInterpretable, byteCodeOfObject
64 #include "HsVersions.h"
67 import ByteCodeAsm ( CompiledByteCode )
70 import RdrName ( GlobalRdrEnv, emptyGlobalRdrEnv,
71 LocalRdrEnv, emptyLocalRdrEnv, GlobalRdrElt(..),
72 unQualOK, ImpDeclSpec(..), Provenance(..),
73 ImportSpec(..), lookupGlobalRdrEnv )
74 import Name ( Name, NamedThing, getName, nameOccName, nameModule )
77 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
80 import InstEnv ( InstEnv, Instance )
81 import FamInstEnv ( FamInstEnv, FamInst )
82 import Rules ( RuleBase )
83 import CoreSyn ( CoreBind )
85 import Type ( TyThing(..) )
87 import Class ( Class, classSelIds, classATs, classTyCon )
88 import TyCon ( TyCon, tyConSelIds, tyConDataCons,
89 newTyConCo_maybe, tyConFamilyCoercion_maybe )
90 import DataCon ( DataCon, dataConImplicitIds )
91 import PrelNames ( gHC_PRIM )
92 import Packages ( PackageId )
93 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..) )
94 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
95 import BasicTypes ( Version, initialVersion, IPName,
96 Fixity, defaultFixity, DeprecTxt )
98 import IfaceSyn ( IfaceInst, IfaceFamInst, IfaceRule,
101 import FiniteMap ( FiniteMap )
102 import CoreSyn ( CoreRule )
103 import Maybes ( orElse, expectJust )
105 import SrcLoc ( SrcSpan, Located )
106 import UniqFM ( lookupUFM, eltsUFM, emptyUFM )
107 import UniqSupply ( UniqSupply )
108 import FastString ( FastString )
110 import DATA_IOREF ( IORef, readIORef )
111 import StringBuffer ( StringBuffer )
112 import Maybes ( catMaybes, seqMaybe )
113 import Time ( ClockTime )
117 %************************************************************************
119 \subsection{Compilation environment}
121 %************************************************************************
125 -- | The Session is a handle to the complete state of a compilation
126 -- session. A compilation session consists of a set of modules
127 -- constituting the current program or library, the context for
128 -- interactive evaluation, and various caches.
129 newtype Session = Session (IORef HscEnv)
132 HscEnv is like Session, except that some of the fields are immutable.
133 An HscEnv is used to compile a single module from plain Haskell source
134 code (after preprocessing) to either C, assembly or C--. Things like
135 the module graph don't change during a single compilation.
137 Historical note: "hsc" used to be the name of the compiler binary,
138 when there was a separate driver and compiler. To compile a single
139 module, the driver would invoke hsc on the source code... so nowadays
140 we think of hsc as the layer of the compiler that deals with compiling
146 hsc_dflags :: DynFlags,
147 -- The dynamic flag settings
149 hsc_targets :: [Target],
150 -- The targets (or roots) of the current session
152 hsc_mod_graph :: ModuleGraph,
153 -- The module graph of the current session
155 hsc_IC :: InteractiveContext,
156 -- The context for evaluating interactive statements
158 hsc_HPT :: HomePackageTable,
159 -- The home package table describes already-compiled
160 -- home-packge modules, *excluding* the module we
161 -- are compiling right now.
162 -- (In one-shot mode the current module is the only
163 -- home-package module, so hsc_HPT is empty. All other
164 -- modules count as "external-package" modules.
165 -- However, even in GHCi mode, hi-boot interfaces are
166 -- demand-loadeded into the external-package table.)
168 -- hsc_HPT is not mutable because we only demand-load
169 -- external packages; the home package is eagerly
170 -- loaded, module by module, by the compilation manager.
172 -- The HPT may contain modules compiled earlier by --make
173 -- but not actually below the current module in the dependency
174 -- graph. (This changes a previous invariant: changed Jan 05.)
176 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
177 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
178 -- These are side-effected by compiling to reflect
179 -- sucking in interface files. They cache the state of
180 -- external interface files, in effect.
182 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
183 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
184 -- The finder's cache. This caches the location of modules,
185 -- so we don't have to search the filesystem multiple times.
187 hsc_global_rdr_env :: GlobalRdrEnv,
188 hsc_global_type_env :: TypeEnv
191 hscEPS :: HscEnv -> IO ExternalPackageState
192 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
194 -- | A compilation target.
196 -- A target may be supplied with the actual text of the
197 -- module. If so, use this instead of the file contents (this
198 -- is for use in an IDE where the file hasn't been saved by
200 data Target = Target TargetId (Maybe (StringBuffer,ClockTime))
203 = TargetModule ModuleName
204 -- ^ A module name: search for the file
205 | TargetFile FilePath (Maybe Phase)
206 -- ^ A filename: preprocess & parse it to find the module name.
207 -- If specified, the Phase indicates how to compile this file
208 -- (which phase to start from). Nothing indicates the starting phase
209 -- should be determined from the suffix of the filename.
212 pprTarget :: Target -> SDoc
213 pprTarget (Target id _) = pprTargetId id
215 pprTargetId (TargetModule m) = ppr m
216 pprTargetId (TargetFile f _) = text f
218 type HomePackageTable = ModuleNameEnv HomeModInfo
219 -- Domain = modules in the home package
220 -- "home" package name cached here for convenience
221 type PackageIfaceTable = ModuleEnv ModIface
222 -- Domain = modules in the imported packages
224 emptyHomePackageTable = emptyUFM
225 emptyPackageIfaceTable = emptyModuleEnv
228 = HomeModInfo { hm_iface :: !ModIface,
229 hm_details :: !ModDetails,
230 hm_linkable :: !(Maybe Linkable) }
231 -- hm_linkable might be Nothing if:
232 -- a) this is an .hs-boot module
233 -- b) temporarily during compilation if we pruned away
234 -- the old linkable because it was out of date.
235 -- after a complete compilation (GHC.load), all hm_linkable
236 -- fields in the HPT will be Just.
238 -- When re-linking a module (hscNoRecomp), we construct
239 -- the HomModInfo by building a new ModDetails from the
240 -- old ModIface (only).
242 -- | Find the 'ModIface' for a 'Module'
249 lookupIfaceByModule dflags hpt pit mod
250 | modulePackageId mod == thisPackage dflags
251 = -- The module comes from the home package, so look first
252 -- in the HPT. If it's not from the home package it's wrong to look
253 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
254 fmap hm_iface (lookupUFM hpt (moduleName mod))
255 `seqMaybe` lookupModuleEnv pit mod
257 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
259 -- If the module does come from the home package, why do we look in the PIT as well?
260 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
261 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
262 -- module is in the PIT, namely GHC.Prim when compiling the base package.
263 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a packake
264 -- of its own, but it doesn't seem worth the bother.
269 hptInstances :: HscEnv -> (ModuleName -> Bool) -> [Instance]
270 -- Find all the instance declarations that are in modules imported
271 -- by this one, directly or indirectly, and are in the Home Package Table
272 -- This ensures that we don't see instances from modules --make compiled
273 -- before this one, but which are not below this one
274 hptInstances hsc_env want_this_module
276 | mod_info <- eltsUFM (hsc_HPT hsc_env)
277 , want_this_module (moduleName (mi_module (hm_iface mod_info)))
278 , ispec <- md_insts (hm_details mod_info) ]
280 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
281 -- Get rules from modules "below" this one (in the dependency sense)
282 -- C.f Inst.hptInstances
283 hptRules hsc_env deps
284 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
287 hpt = hsc_HPT hsc_env
290 | -- Find each non-hi-boot module below me
293 -- unsavoury: when compiling the base package with --make, we
294 -- sometimes try to look up RULES for GHC.Prim. GHC.Prim won't
295 -- be in the HPT, because we never compile it; it's in the EPT
296 -- instead. ToDo: clean up, and remove this slightly bogus
298 , mod /= moduleName gHC_PRIM
300 -- Look it up in the HPT
301 , let mod_info = case lookupUFM hpt mod of
302 Nothing -> pprPanic "hptRules" (ppr mod <+> ppr deps)
306 , rule <- md_rules (hm_details mod_info) ]
309 %************************************************************************
311 \subsection{The Finder cache}
313 %************************************************************************
316 -- | The 'FinderCache' maps home module names to the result of
317 -- searching for that module. It records the results of searching for
318 -- modules along the search path. On @:load@, we flush the entire
319 -- contents of this cache.
321 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
322 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
324 type FinderCache = ModuleNameEnv FindResult
326 -- | The result of searching for an imported module.
328 = Found ModLocation Module
329 -- the module was found
330 | NoPackage PackageId
331 -- the requested package was not found
332 | FoundMultiple [PackageId]
333 -- *error*: both in multiple packages
334 | PackageHidden PackageId
335 -- for an explicit source import: the package containing the module is
337 | ModuleHidden PackageId
338 -- for an explicit source import: the package containing the module is
339 -- exposed, but the module itself is hidden.
340 | NotFound [FilePath] (Maybe PackageId)
341 -- the module was not found, the specified places were searched
342 | NotFoundInPackage PackageId
343 -- the module was not found in this package
345 -- | Cache that remembers where we found a particular module. Contains both
346 -- home modules and package modules. On @:load@, only home modules are
347 -- purged from this cache.
348 type ModLocationCache = ModuleEnv ModLocation
351 %************************************************************************
353 \subsection{Symbol tables and Module details}
355 %************************************************************************
357 A @ModIface@ plus a @ModDetails@ summarises everything we know
358 about a compiled module. The @ModIface@ is the stuff *before* linking,
359 and can be written out to an interface file. (The @ModDetails@ is after
360 linking; it is the "linked" form of the mi_decls field.)
362 When we *read* an interface file, we also construct a @ModIface@ from it,
363 except that the mi_decls part is empty; when reading we consolidate
364 the declarations into a single indexed map in the @PersistentRenamerState@.
369 mi_module :: !Module,
370 mi_mod_vers :: !Version, -- Module version: changes when anything changes
372 mi_orphan :: !WhetherHasOrphans, -- Whether this module has orphans
373 mi_boot :: !IsBootInterface, -- Read from an hi-boot file?
375 mi_deps :: Dependencies,
376 -- This is consulted for directly-imported modules,
377 -- but not for anything else (hence lazy)
379 -- Usages; kept sorted so that it's easy to decide
380 -- whether to write a new iface file (changing usages
381 -- doesn't affect the version of this module)
382 mi_usages :: [Usage],
383 -- NOT STRICT! we read this field lazily from the interface file
384 -- It is *only* consulted by the recompilation checker
387 -- Kept sorted by (mod,occ), to make version comparisons easier
388 mi_exports :: ![IfaceExport],
389 mi_exp_vers :: !Version, -- Version number of export list
392 mi_fixities :: [(OccName,Fixity)],
393 -- NOT STRICT! we read this field lazily from the interface file
396 mi_deprecs :: IfaceDeprecs,
397 -- NOT STRICT! we read this field lazily from the interface file
399 -- Type, class and variable declarations
400 -- The version of an Id changes if its fixity or deprecations change
401 -- (as well as its type of course)
402 -- Ditto data constructors, class operations, except that
403 -- the version of the parent class/tycon changes
404 mi_decls :: [(Version,IfaceDecl)], -- Sorted
406 mi_globals :: !(Maybe GlobalRdrEnv),
407 -- Binds all the things defined at the top level in
408 -- the *original source* code for this module. which
409 -- is NOT the same as mi_exports, nor mi_decls (which
410 -- may contains declarations for things not actually
411 -- defined by the user). Used for GHCi and for inspecting
412 -- the contents of modules via the GHC API only.
414 -- (We need the source file to figure out the
415 -- top-level environment, if we didn't compile this module
416 -- from source then this field contains Nothing).
418 -- Strictly speaking this field should live in the
419 -- HomeModInfo, but that leads to more plumbing.
421 -- Instance declarations and rules
422 mi_insts :: [IfaceInst], -- Sorted
423 mi_fam_insts :: [IfaceFamInst], -- Sorted
424 mi_rules :: [IfaceRule], -- Sorted
425 mi_rule_vers :: !Version, -- Version number for rules and
426 -- instances combined
428 -- Cached environments for easy lookup
429 -- These are computed (lazily) from other fields
430 -- and are not put into the interface file
431 mi_dep_fn :: Name -> Maybe DeprecTxt, -- Cached lookup for mi_deprecs
432 mi_fix_fn :: OccName -> Fixity, -- Cached lookup for mi_fixities
433 mi_ver_fn :: OccName -> Maybe Version -- Cached lookup for mi_decls
434 -- The Nothing in mi_ver_fn means that the thing
435 -- isn't in decls. It's useful to know that when
436 -- seeing if we are up to date wrt the old interface
439 -- Should be able to construct ModDetails from mi_decls in ModIface
442 -- The next three fields are created by the typechecker
443 md_exports :: NameSet,
444 md_types :: !TypeEnv,
445 md_fam_insts :: ![FamInst], -- Cached value extracted from md_types
446 md_insts :: ![Instance], -- Dfun-ids for the instances in this
449 md_rules :: ![CoreRule] -- Domain may include Ids from other
454 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
455 md_exports = emptyNameSet,
460 -- A ModGuts is carried through the compiler, accumulating stuff as it goes
461 -- There is only one ModGuts at any time, the one for the module
462 -- being compiled right now. Once it is compiled, a ModIface and
463 -- ModDetails are extracted and the ModGuts is dicarded.
467 mg_module :: !Module,
468 mg_boot :: IsBootInterface, -- Whether it's an hs-boot module
469 mg_exports :: !NameSet, -- What it exports
470 mg_deps :: !Dependencies, -- What is below it, directly or
472 mg_dir_imps :: ![Module], -- Directly-imported modules; used to
473 -- generate initialisation code
474 mg_usages :: ![Usage], -- Version info for what it needed
476 mg_rdr_env :: !GlobalRdrEnv, -- Top-level lexical environment
477 mg_fix_env :: !FixityEnv, -- Fixity env, for things declared in
479 mg_deprecs :: !Deprecations, -- Deprecations declared in the module
481 mg_types :: !TypeEnv,
482 mg_insts :: ![Instance], -- Instances
483 mg_fam_insts :: ![FamInst], -- Instances
484 mg_rules :: ![CoreRule], -- Rules from this module
485 mg_binds :: ![CoreBind], -- Bindings for this module
486 mg_foreign :: !ForeignStubs
489 -- The ModGuts takes on several slightly different forms:
491 -- After simplification, the following fields change slightly:
492 -- mg_rules Orphan rules only (local ones now attached to binds)
493 -- mg_binds With rules attached
496 ---------------------------------------------------------
497 -- The Tidy pass forks the information about this module:
498 -- * one lot goes to interface file generation (ModIface)
499 -- and later compilations (ModDetails)
500 -- * the other lot goes to code generation (CgGuts)
503 cg_module :: !Module,
505 cg_tycons :: [TyCon],
506 -- Algebraic data types (including ones that started
507 -- life as classes); generate constructors and info
508 -- tables Includes newtypes, just for the benefit of
511 cg_binds :: [CoreBind],
512 -- The tidied main bindings, including
513 -- previously-implicit bindings for record and class
514 -- selectors, and data construtor wrappers. But *not*
515 -- data constructor workers; reason: we we regard them
516 -- as part of the code-gen of tycons
518 cg_dir_imps :: ![Module],
519 -- Directly-imported modules; used to generate
520 -- initialisation code
522 cg_foreign :: !ForeignStubs,
523 cg_dep_pkgs :: ![PackageId] -- Used to generate #includes for C code gen
526 -----------------------------------
529 imp_direct :: ![(Module,Bool)], -- Explicitly-imported modules
530 -- Boolean is true if we imported the whole
531 -- module (apart, perhaps, from hiding some)
532 imp_pkg_mods :: !ModuleSet, -- Non-home-package modules on which we depend,
533 -- directly or indirectly
534 imp_home_names :: !NameSet -- Home package things on which we depend,
535 -- directly or indirectly
538 -----------------------------------
539 data ForeignStubs = NoStubs
541 SDoc -- Header file prototypes for
542 -- "foreign exported" functions
543 SDoc -- C stubs to use when calling
544 -- "foreign exported" functions
545 [FastString] -- Headers that need to be included
546 -- into C code generated for this module
547 [Id] -- Foreign-exported binders
548 -- we have to generate code to register these
553 emptyModIface :: Module -> ModIface
555 = ModIface { mi_module = mod,
556 mi_mod_vers = initialVersion,
559 mi_deps = noDependencies,
562 mi_exp_vers = initialVersion,
564 mi_deprecs = NoDeprecs,
569 mi_globals = Nothing,
570 mi_rule_vers = initialVersion,
571 mi_dep_fn = emptyIfaceDepCache,
572 mi_fix_fn = emptyIfaceFixCache,
573 mi_ver_fn = emptyIfaceVerCache
578 %************************************************************************
580 \subsection{The interactive context}
582 %************************************************************************
585 data InteractiveContext
586 = InteractiveContext {
587 ic_toplev_scope :: [Module], -- Include the "top-level" scope of
590 ic_exports :: [Module], -- Include just the exports of these
593 ic_rn_gbl_env :: GlobalRdrEnv, -- The cached GlobalRdrEnv, built from
594 -- ic_toplev_scope and ic_exports
596 ic_rn_local_env :: LocalRdrEnv, -- Lexical context for variables bound
597 -- during interaction
599 ic_type_env :: TypeEnv -- Ditto for types
602 emptyInteractiveContext
603 = InteractiveContext { ic_toplev_scope = [],
605 ic_rn_gbl_env = emptyGlobalRdrEnv,
606 ic_rn_local_env = emptyLocalRdrEnv,
607 ic_type_env = emptyTypeEnv }
609 icPrintUnqual :: InteractiveContext -> PrintUnqualified
610 icPrintUnqual ictxt = mkPrintUnqualified (ic_rn_gbl_env ictxt)
613 %************************************************************************
615 Building a PrintUnqualified
617 %************************************************************************
620 mkPrintUnqualified :: GlobalRdrEnv -> PrintUnqualified
621 mkPrintUnqualified env = (qual_name, qual_mod)
624 | null gres = Just (moduleName mod)
625 -- it isn't in scope at all, this probably shouldn't happen,
626 -- but we'll qualify it by the original module anyway.
627 | any unQualOK gres = Nothing
628 | (Imported is : _) <- map gre_prov gres, (idecl : _) <- is
629 = Just (is_as (is_decl idecl))
630 | otherwise = panic "mkPrintUnqualified"
632 gres = [ gre | gre <- lookupGlobalRdrEnv env occ,
633 nameModule (gre_name gre) == mod ]
635 qual_mod mod = Nothing -- For now...
639 %************************************************************************
643 %************************************************************************
646 implicitTyThings :: TyThing -> [TyThing]
647 -- If you change this, make sure you change LoadIface.ifaceDeclSubBndrs in sync
649 implicitTyThings (AnId id) = []
651 -- For type constructors, add the data cons (and their extras),
652 -- and the selectors and generic-programming Ids too
654 -- Newtypes don't have a worker Id, so don't generate that?
655 implicitTyThings (ATyCon tc) = implicitCoTyCon tc ++
656 map AnId (tyConSelIds tc) ++
657 concatMap (extras_plus . ADataCon)
660 -- For classes, add the class TyCon too (and its extras)
661 -- and the class selector Ids and the associated types (they don't
662 -- have extras as these are only the family decls)
663 implicitTyThings (AClass cl) = map AnId (classSelIds cl) ++
664 map ATyCon (classATs cl) ++
665 extras_plus (ATyCon (classTyCon cl))
667 -- For data cons add the worker and wrapper (if any)
668 implicitTyThings (ADataCon dc) = map AnId (dataConImplicitIds dc)
670 -- For newtypes and indexed data types, add the implicit coercion tycon
672 = map ATyCon . catMaybes $ [newTyConCo_maybe tc,
673 tyConFamilyCoercion_maybe tc]
675 extras_plus thing = thing : implicitTyThings thing
677 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
678 extendTypeEnvWithIds env ids
679 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
682 %************************************************************************
686 %************************************************************************
689 type TypeEnv = NameEnv TyThing
691 emptyTypeEnv :: TypeEnv
692 typeEnvElts :: TypeEnv -> [TyThing]
693 typeEnvClasses :: TypeEnv -> [Class]
694 typeEnvTyCons :: TypeEnv -> [TyCon]
695 typeEnvIds :: TypeEnv -> [Id]
696 typeEnvDataCons :: TypeEnv -> [DataCon]
697 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
699 emptyTypeEnv = emptyNameEnv
700 typeEnvElts env = nameEnvElts env
701 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
702 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
703 typeEnvIds env = [id | AnId id <- typeEnvElts env]
704 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
706 mkTypeEnv :: [TyThing] -> TypeEnv
707 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
709 lookupTypeEnv = lookupNameEnv
711 -- Extend the type environment
712 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
713 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
715 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
716 extendTypeEnvList env things = foldl extendTypeEnv env things
720 lookupType :: DynFlags
726 lookupType dflags hpt pte name
727 -- in one-shot, we don't use the HPT
728 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
729 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
730 lookupNameEnv (md_types (hm_details hm)) name
732 = lookupNameEnv pte name
733 where mod = nameModule name
734 this_pkg = thisPackage dflags
738 tyThingTyCon (ATyCon tc) = tc
739 tyThingTyCon other = pprPanic "tyThingTyCon" (ppr other)
741 tyThingClass (AClass cls) = cls
742 tyThingClass other = pprPanic "tyThingClass" (ppr other)
744 tyThingDataCon (ADataCon dc) = dc
745 tyThingDataCon other = pprPanic "tyThingDataCon" (ppr other)
747 tyThingId (AnId id) = id
748 tyThingId other = pprPanic "tyThingId" (ppr other)
751 %************************************************************************
753 \subsection{Auxiliary types}
755 %************************************************************************
757 These types are defined here because they are mentioned in ModDetails,
758 but they are mostly elaborated elsewhere
761 mkIfaceVerCache :: [(Version,IfaceDecl)] -> OccName -> Maybe Version
762 mkIfaceVerCache pairs
763 = \occ -> lookupOccEnv env occ
765 env = foldl add emptyOccEnv pairs
766 add env (v,d) = extendOccEnv env (ifName d) v
768 emptyIfaceVerCache :: OccName -> Maybe Version
769 emptyIfaceVerCache occ = Nothing
771 ------------------ Deprecations -------------------------
774 | DeprecAll DeprecTxt -- Whole module deprecated
775 | DeprecSome a -- Some specific things deprecated
778 type IfaceDeprecs = Deprecs [(OccName,DeprecTxt)]
779 type Deprecations = Deprecs (NameEnv (OccName,DeprecTxt))
780 -- Keep the OccName so we can flatten the NameEnv to
781 -- get an IfaceDeprecs from a Deprecations
782 -- Only an OccName is needed, because a deprecation always
783 -- applies to things defined in the module in which the
784 -- deprecation appears.
786 mkIfaceDepCache:: IfaceDeprecs -> Name -> Maybe DeprecTxt
787 mkIfaceDepCache NoDeprecs = \n -> Nothing
788 mkIfaceDepCache (DeprecAll t) = \n -> Just t
789 mkIfaceDepCache (DeprecSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
791 emptyIfaceDepCache :: Name -> Maybe DeprecTxt
792 emptyIfaceDepCache n = Nothing
794 lookupDeprec :: Deprecations -> Name -> Maybe DeprecTxt
795 lookupDeprec NoDeprecs name = Nothing
796 lookupDeprec (DeprecAll txt) name = Just txt
797 lookupDeprec (DeprecSome env) name = case lookupNameEnv env name of
798 Just (_, txt) -> Just txt
801 plusDeprecs :: Deprecations -> Deprecations -> Deprecations
802 plusDeprecs d NoDeprecs = d
803 plusDeprecs NoDeprecs d = d
804 plusDeprecs d (DeprecAll t) = DeprecAll t
805 plusDeprecs (DeprecAll t) d = DeprecAll t
806 plusDeprecs (DeprecSome v1) (DeprecSome v2) = DeprecSome (v1 `plusNameEnv` v2)
811 type Avails = [AvailInfo]
812 type AvailInfo = GenAvailInfo Name
813 type RdrAvailInfo = GenAvailInfo OccName
815 data GenAvailInfo name = Avail name -- An ordinary identifier
816 | AvailTC name -- The name of the type or class
817 [name] -- The available pieces of type/class.
818 -- NB: If the type or class is itself
819 -- to be in scope, it must be in this list.
820 -- Thus, typically: AvailTC Eq [Eq, ==, /=]
822 -- Equality used when deciding if the interface has changed
824 type IfaceExport = (Module, [GenAvailInfo OccName])
826 availsToNameSet :: [AvailInfo] -> NameSet
827 availsToNameSet avails = foldl add emptyNameSet avails
829 add set avail = addListToNameSet set (availNames avail)
831 availName :: GenAvailInfo name -> name
832 availName (Avail n) = n
833 availName (AvailTC n _) = n
835 availNames :: GenAvailInfo name -> [name]
836 availNames (Avail n) = [n]
837 availNames (AvailTC n ns) = ns
839 instance Outputable n => Outputable (GenAvailInfo n) where
842 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
843 pprAvail (AvailTC n ns) = ppr n <> case {- filter (/= n) -} ns of
845 ns' -> braces (hsep (punctuate comma (map ppr ns')))
847 pprAvail (Avail n) = ppr n
851 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
852 mkIfaceFixCache pairs
853 = \n -> lookupOccEnv env n `orElse` defaultFixity
857 emptyIfaceFixCache :: OccName -> Fixity
858 emptyIfaceFixCache n = defaultFixity
860 -- This fixity environment is for source code only
861 type FixityEnv = NameEnv FixItem
863 -- We keep the OccName in the range so that we can generate an interface from it
864 data FixItem = FixItem OccName Fixity SrcSpan
866 instance Outputable FixItem where
867 ppr (FixItem occ fix loc) = ppr fix <+> ppr occ <+> parens (ppr loc)
869 emptyFixityEnv :: FixityEnv
870 emptyFixityEnv = emptyNameEnv
872 lookupFixity :: FixityEnv -> Name -> Fixity
873 lookupFixity env n = case lookupNameEnv env n of
874 Just (FixItem _ fix _) -> fix
875 Nothing -> defaultFixity
879 %************************************************************************
881 \subsection{WhatsImported}
883 %************************************************************************
886 type WhetherHasOrphans = Bool
888 -- * an instance decl in a module other than the defn module for
889 -- one of the tycons or classes in the instance head
890 -- * a transformation rule in a module other than the one defining
891 -- the function in the head of the rule.
893 type IsBootInterface = Bool
895 -- Dependency info about modules and packages below this one
896 -- in the import hierarchy. See TcRnTypes.ImportAvails for details.
898 -- Invariant: the dependencies of a module M never includes M
899 -- Invariant: the lists are unordered, with no duplicates
901 = Deps { dep_mods :: [(ModuleName,IsBootInterface)], -- Home-package module dependencies
902 dep_pkgs :: [PackageId], -- External package dependencies
903 dep_orphs :: [Module] } -- Orphan modules (whether home or external pkg)
905 -- Equality used only for old/new comparison in MkIface.addVersionInfo
907 noDependencies :: Dependencies
908 noDependencies = Deps [] [] []
911 = Usage { usg_name :: ModuleName, -- Name of the module
912 usg_mod :: Version, -- Module version
913 usg_entities :: [(OccName,Version)], -- Sorted by occurrence name
914 usg_exports :: Maybe Version, -- Export-list version, if we depend on it
915 usg_rules :: Version -- Orphan-rules version (for non-orphan
916 -- modules this will always be initialVersion)
918 -- This type doesn't let you say "I imported f but none of the rules in
919 -- the module". If you use anything in the module you get its rule version
920 -- So if the rules change, you'll recompile, even if you don't use them.
921 -- This is easy to implement, and it's safer: you might not have used the rules last
922 -- time round, but if someone has added a new rule you might need it this time
924 -- The export list field is (Just v) if we depend on the export list:
925 -- i.e. we imported the module directly, whether or not we
926 -- enumerated the things we imported, or just imported everything
927 -- We need to recompile if M's exports change, because
928 -- if the import was import M, we might now have a name clash in the
930 -- if the import was import M(x) M might no longer export x
931 -- The only way we don't depend on the export list is if we have
933 -- And of course, for modules that aren't imported directly we don't
934 -- depend on their export lists
938 %************************************************************************
940 The External Package State
942 %************************************************************************
945 type PackageTypeEnv = TypeEnv
946 type PackageRuleBase = RuleBase
947 type PackageInstEnv = InstEnv
948 type PackageFamInstEnv = FamInstEnv
950 data ExternalPackageState
952 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
953 -- In OneShot mode (only), home-package modules
954 -- accumulate in the external package state, and are
955 -- sucked in lazily. For these home-pkg modules
956 -- (only) we need to record which are boot modules.
957 -- We set this field after loading all the
958 -- explicitly-imported interfaces, but before doing
961 -- The ModuleName part is not necessary, but it's useful for
962 -- debug prints, and it's convenient because this field comes
963 -- direct from TcRnTypes.ImportAvails.imp_dep_mods
965 eps_PIT :: !PackageIfaceTable,
966 -- The ModuleIFaces for modules in external packages
967 -- whose interfaces we have opened
968 -- The declarations in these interface files are held in
969 -- eps_decls, eps_inst_env, eps_fam_inst_env, eps_rules
970 -- (below), not in the mi_decls fields of the iPIT.
971 -- What _is_ in the iPIT is:
978 eps_PTE :: !PackageTypeEnv, -- Domain = external-package modules
980 eps_inst_env :: !PackageInstEnv, -- The total InstEnv accumulated
981 -- from all the external-package
983 eps_fam_inst_env :: !PackageFamInstEnv,-- Ditto FamInstEnv
984 eps_rule_base :: !PackageRuleBase, -- Ditto RuleEnv
986 eps_stats :: !EpsStats
989 -- "In" means read from iface files
990 -- "Out" means actually sucked in and type-checked
991 data EpsStats = EpsStats { n_ifaces_in
992 , n_decls_in, n_decls_out
993 , n_rules_in, n_rules_out
994 , n_insts_in, n_insts_out :: !Int }
996 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
997 -- Add stats for one newly-read interface
998 addEpsInStats stats n_decls n_insts n_rules
999 = stats { n_ifaces_in = n_ifaces_in stats + 1
1000 , n_decls_in = n_decls_in stats + n_decls
1001 , n_insts_in = n_insts_in stats + n_insts
1002 , n_rules_in = n_rules_in stats + n_rules }
1005 The NameCache makes sure that there is just one Unique assigned for
1006 each original name; i.e. (module-name, occ-name) pair. The Name is
1007 always stored as a Global, and has the SrcLoc of its binding location.
1008 Actually that's not quite right. When we first encounter the original
1009 name, we might not be at its binding site (e.g. we are reading an
1010 interface file); so we give it 'noSrcLoc' then. Later, when we find
1011 its binding site, we fix it up.
1015 = NameCache { nsUniqs :: UniqSupply,
1016 -- Supply of uniques
1017 nsNames :: OrigNameCache,
1018 -- Ensures that one original name gets one unique
1019 nsIPs :: OrigIParamCache
1020 -- Ensures that one implicit parameter name gets one unique
1023 type OrigNameCache = ModuleEnv (OccEnv Name)
1024 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1029 %************************************************************************
1031 The module graph and ModSummary type
1032 A ModSummary is a node in the compilation manager's
1033 dependency graph, and it's also passed to hscMain
1035 %************************************************************************
1037 A ModuleGraph contains all the nodes from the home package (only).
1038 There will be a node for each source module, plus a node for each hi-boot
1042 type ModuleGraph = [ModSummary] -- The module graph,
1043 -- NOT NECESSARILY IN TOPOLOGICAL ORDER
1045 emptyMG :: ModuleGraph
1048 -- The nodes of the module graph are
1049 -- EITHER a regular Haskell source module
1050 -- OR a hi-boot source module
1054 ms_mod :: Module, -- Identity of the module
1055 ms_hsc_src :: HscSource, -- Source is Haskell, hs-boot, external core
1056 ms_location :: ModLocation, -- Location
1057 ms_hs_date :: ClockTime, -- Timestamp of source file
1058 ms_obj_date :: Maybe ClockTime, -- Timestamp of object, maybe
1059 ms_srcimps :: [Located ModuleName], -- Source imports
1060 ms_imps :: [Located ModuleName], -- Non-source imports
1061 ms_hspp_file :: FilePath, -- Filename of preprocessed source.
1062 ms_hspp_opts :: DynFlags, -- Cached flags from OPTIONS, INCLUDE
1063 -- and LANGUAGE pragmas.
1064 ms_hspp_buf :: Maybe StringBuffer -- The actual preprocessed source, maybe.
1067 -- The ModLocation contains both the original source filename and the
1068 -- filename of the cleaned-up source file after all preprocessing has been
1069 -- done. The point is that the summariser will have to cpp/unlit/whatever
1070 -- all files anyway, and there's no point in doing this twice -- just
1071 -- park the result in a temp file, put the name of it in the location,
1072 -- and let @compile@ read from that file on the way back up.
1074 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1075 -- the ms_hs_date and imports can, of course, change
1077 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1078 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1079 msHiFilePath ms = ml_hi_file (ms_location ms)
1080 msObjFilePath ms = ml_obj_file (ms_location ms)
1082 isBootSummary :: ModSummary -> Bool
1083 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1085 instance Outputable ModSummary where
1087 = sep [text "ModSummary {",
1088 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1089 text "ms_mod =" <+> ppr (ms_mod ms)
1090 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1091 text "ms_imps =" <+> ppr (ms_imps ms),
1092 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1096 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1097 showModMsg target recomp mod_summary
1098 = showSDoc (hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1099 char '(', text (msHsFilePath mod_summary) <> comma,
1101 HscInterpreted | recomp
1102 -> text "interpreted"
1103 HscNothing -> text "nothing"
1104 _other -> text (msObjFilePath mod_summary),
1107 mod = moduleName (ms_mod mod_summary)
1108 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1112 %************************************************************************
1114 \subsection{Linkable stuff}
1116 %************************************************************************
1118 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1119 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1122 data Linkable = LM {
1123 linkableTime :: ClockTime, -- Time at which this linkable was built
1124 -- (i.e. when the bytecodes were produced,
1125 -- or the mod date on the files)
1126 linkableModule :: Module, -- Should be Module, but see below
1127 linkableUnlinked :: [Unlinked]
1130 isObjectLinkable :: Linkable -> Bool
1131 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1132 where unlinked = linkableUnlinked l
1133 -- A linkable with no Unlinked's is treated as a BCO. We can
1134 -- generate a linkable with no Unlinked's as a result of
1135 -- compiling a module in HscNothing mode, and this choice
1136 -- happens to work well with checkStability in module GHC.
1138 instance Outputable Linkable where
1139 ppr (LM when_made mod unlinkeds)
1140 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1141 $$ nest 3 (ppr unlinkeds)
1143 -------------------------------------------
1148 | BCOs CompiledByteCode
1151 data CompiledByteCode = NoByteCode
1154 instance Outputable Unlinked where
1155 ppr (DotO path) = text "DotO" <+> text path
1156 ppr (DotA path) = text "DotA" <+> text path
1157 ppr (DotDLL path) = text "DotDLL" <+> text path
1159 ppr (BCOs bcos) = text "BCOs" <+> ppr bcos
1161 ppr (BCOs bcos) = text "No byte code"
1164 isObject (DotO _) = True
1165 isObject (DotA _) = True
1166 isObject (DotDLL _) = True
1169 isInterpretable = not . isObject
1171 nameOfObject (DotO fn) = fn
1172 nameOfObject (DotA fn) = fn
1173 nameOfObject (DotDLL fn) = fn
1174 nameOfObject other = pprPanic "nameOfObject" (ppr other)
1176 byteCodeOfObject (BCOs bc) = bc
1177 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)