2 % (c) The University of Glasgow, 2006
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,
39 implicitTyThings, isImplicitTyThing,
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, availsToNameEnv, availName, availNames,
51 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
54 Deprecations, DeprecTxt, plusDeprecs,
56 PackageInstEnv, PackageRuleBase,
59 Linkable(..), isObjectLinkable,
60 Unlinked(..), CompiledByteCode,
61 isObject, nameOfObject, isInterpretable, byteCodeOfObject,
65 #include "HsVersions.h"
67 import Breakpoints ( SiteNumber, Coord, noDbgSites )
69 import ByteCodeAsm ( CompiledByteCode )
72 import RdrName ( GlobalRdrEnv, emptyGlobalRdrEnv,
73 LocalRdrEnv, emptyLocalRdrEnv, GlobalRdrElt(..),
74 unQualOK, ImpDeclSpec(..), Provenance(..),
75 ImportSpec(..), lookupGlobalRdrEnv )
76 import Name ( Name, NamedThing, getName, nameOccName, nameModule )
79 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
82 import InstEnv ( InstEnv, Instance )
83 import FamInstEnv ( FamInstEnv, FamInst )
84 import Rules ( RuleBase )
85 import CoreSyn ( CoreBind )
86 import Id ( Id, isImplicitId )
87 import Type ( TyThing(..) )
89 import Class ( Class, classSelIds, classATs, classTyCon )
91 import DataCon ( DataCon, dataConImplicitIds )
92 import PrelNames ( gHC_PRIM )
93 import Packages ( PackageId )
94 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..) )
95 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
96 import BasicTypes ( Version, initialVersion, IPName,
97 Fixity, defaultFixity, DeprecTxt )
99 import FiniteMap ( FiniteMap )
100 import CoreSyn ( CoreRule )
101 import Maybes ( orElse, expectJust, catMaybes, seqMaybe )
103 import SrcLoc ( SrcSpan, Located )
104 import UniqFM ( lookupUFM, eltsUFM, emptyUFM )
105 import UniqSupply ( UniqSupply )
106 import FastString ( FastString )
108 import StringBuffer ( StringBuffer )
110 import System.Time ( ClockTime )
111 import Data.IORef ( IORef, readIORef )
115 %************************************************************************
117 \subsection{Compilation environment}
119 %************************************************************************
123 -- | The Session is a handle to the complete state of a compilation
124 -- session. A compilation session consists of a set of modules
125 -- constituting the current program or library, the context for
126 -- interactive evaluation, and various caches.
127 newtype Session = Session (IORef HscEnv)
130 HscEnv is like Session, except that some of the fields are immutable.
131 An HscEnv is used to compile a single module from plain Haskell source
132 code (after preprocessing) to either C, assembly or C--. Things like
133 the module graph don't change during a single compilation.
135 Historical note: "hsc" used to be the name of the compiler binary,
136 when there was a separate driver and compiler. To compile a single
137 module, the driver would invoke hsc on the source code... so nowadays
138 we think of hsc as the layer of the compiler that deals with compiling
144 hsc_dflags :: DynFlags,
145 -- The dynamic flag settings
147 hsc_targets :: [Target],
148 -- The targets (or roots) of the current session
150 hsc_mod_graph :: ModuleGraph,
151 -- The module graph of the current session
153 hsc_IC :: InteractiveContext,
154 -- The context for evaluating interactive statements
156 hsc_HPT :: HomePackageTable,
157 -- The home package table describes already-compiled
158 -- home-packge modules, *excluding* the module we
159 -- are compiling right now.
160 -- (In one-shot mode the current module is the only
161 -- home-package module, so hsc_HPT is empty. All other
162 -- modules count as "external-package" modules.
163 -- However, even in GHCi mode, hi-boot interfaces are
164 -- demand-loadeded into the external-package table.)
166 -- hsc_HPT is not mutable because we only demand-load
167 -- external packages; the home package is eagerly
168 -- loaded, module by module, by the compilation manager.
170 -- The HPT may contain modules compiled earlier by --make
171 -- but not actually below the current module in the dependency
172 -- graph. (This changes a previous invariant: changed Jan 05.)
174 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
175 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
176 -- These are side-effected by compiling to reflect
177 -- sucking in interface files. They cache the state of
178 -- external interface files, in effect.
180 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
181 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
182 -- The finder's cache. This caches the location of modules,
183 -- so we don't have to search the filesystem multiple times.
185 hsc_global_rdr_env :: GlobalRdrEnv,
186 hsc_global_type_env :: TypeEnv
189 hscEPS :: HscEnv -> IO ExternalPackageState
190 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
192 -- | A compilation target.
194 -- A target may be supplied with the actual text of the
195 -- module. If so, use this instead of the file contents (this
196 -- is for use in an IDE where the file hasn't been saved by
198 data Target = Target TargetId (Maybe (StringBuffer,ClockTime))
201 = TargetModule ModuleName
202 -- ^ A module name: search for the file
203 | TargetFile FilePath (Maybe Phase)
204 -- ^ A filename: preprocess & parse it to find the module name.
205 -- If specified, the Phase indicates how to compile this file
206 -- (which phase to start from). Nothing indicates the starting phase
207 -- should be determined from the suffix of the filename.
210 pprTarget :: Target -> SDoc
211 pprTarget (Target id _) = pprTargetId id
213 instance Outputable Target where
216 pprTargetId (TargetModule m) = ppr m
217 pprTargetId (TargetFile f _) = text f
219 instance Outputable TargetId where
222 type HomePackageTable = ModuleNameEnv HomeModInfo
223 -- Domain = modules in the home package
224 -- "home" package name cached here for convenience
225 type PackageIfaceTable = ModuleEnv ModIface
226 -- Domain = modules in the imported packages
228 emptyHomePackageTable = emptyUFM
229 emptyPackageIfaceTable = emptyModuleEnv
232 = HomeModInfo { hm_iface :: !ModIface,
233 hm_details :: !ModDetails,
234 hm_linkable :: !(Maybe Linkable) }
235 -- hm_linkable might be Nothing if:
236 -- a) this is an .hs-boot module
237 -- b) temporarily during compilation if we pruned away
238 -- the old linkable because it was out of date.
239 -- after a complete compilation (GHC.load), all hm_linkable
240 -- fields in the HPT will be Just.
242 -- When re-linking a module (hscNoRecomp), we construct
243 -- the HomModInfo by building a new ModDetails from the
244 -- old ModIface (only).
246 -- | Find the 'ModIface' for a 'Module'
253 lookupIfaceByModule dflags hpt pit mod
254 | modulePackageId mod == thisPackage dflags
255 = -- The module comes from the home package, so look first
256 -- in the HPT. If it's not from the home package it's wrong to look
257 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
258 fmap hm_iface (lookupUFM hpt (moduleName mod))
259 `seqMaybe` lookupModuleEnv pit mod
261 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
263 -- If the module does come from the home package, why do we look in the PIT as well?
264 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
265 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
266 -- module is in the PIT, namely GHC.Prim when compiling the base package.
267 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a packake
268 -- of its own, but it doesn't seem worth the bother.
273 hptInstances :: HscEnv -> (ModuleName -> Bool) -> [Instance]
274 -- Find all the instance declarations that are in modules imported
275 -- by this one, directly or indirectly, and are in the Home Package Table
276 -- This ensures that we don't see instances from modules --make compiled
277 -- before this one, but which are not below this one
278 hptInstances hsc_env want_this_module
280 | mod_info <- eltsUFM (hsc_HPT hsc_env)
281 , want_this_module (moduleName (mi_module (hm_iface mod_info)))
282 , ispec <- md_insts (hm_details mod_info) ]
284 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
285 -- Get rules from modules "below" this one (in the dependency sense)
286 -- C.f Inst.hptInstances
287 hptRules hsc_env deps
288 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
291 hpt = hsc_HPT hsc_env
294 | -- Find each non-hi-boot module below me
297 -- unsavoury: when compiling the base package with --make, we
298 -- sometimes try to look up RULES for GHC.Prim. GHC.Prim won't
299 -- be in the HPT, because we never compile it; it's in the EPT
300 -- instead. ToDo: clean up, and remove this slightly bogus
302 , mod /= moduleName gHC_PRIM
304 -- Look it up in the HPT
305 , let rules = case lookupUFM hpt mod of
306 Just info -> md_rules (hm_details info)
307 Nothing -> pprTrace "WARNING in hptRules" msg []
308 msg = vcat [ptext SLIT("missing module") <+> ppr mod,
309 ptext SLIT("Probable cause: out-of-date interface files")]
310 -- This really shouldn't happen, but see Trac #962
316 %************************************************************************
318 \subsection{The Finder cache}
320 %************************************************************************
323 -- | The 'FinderCache' maps home module names to the result of
324 -- searching for that module. It records the results of searching for
325 -- modules along the search path. On @:load@, we flush the entire
326 -- contents of this cache.
328 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
329 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
331 type FinderCache = ModuleNameEnv FindResult
333 -- | The result of searching for an imported module.
335 = Found ModLocation Module
336 -- the module was found
337 | NoPackage PackageId
338 -- the requested package was not found
339 | FoundMultiple [PackageId]
340 -- *error*: both in multiple packages
341 | PackageHidden PackageId
342 -- for an explicit source import: the package containing the module is
344 | ModuleHidden PackageId
345 -- for an explicit source import: the package containing the module is
346 -- exposed, but the module itself is hidden.
347 | NotFound [FilePath] (Maybe PackageId)
348 -- the module was not found, the specified places were searched
349 | NotFoundInPackage PackageId
350 -- the module was not found in this package
352 -- | Cache that remembers where we found a particular module. Contains both
353 -- home modules and package modules. On @:load@, only home modules are
354 -- purged from this cache.
355 type ModLocationCache = ModuleEnv ModLocation
358 %************************************************************************
360 \subsection{Symbol tables and Module details}
362 %************************************************************************
364 A @ModIface@ plus a @ModDetails@ summarises everything we know
365 about a compiled module. The @ModIface@ is the stuff *before* linking,
366 and can be written out to an interface file. (The @ModDetails@ is after
367 linking; it is the "linked" form of the mi_decls field.)
369 When we *read* an interface file, we also construct a @ModIface@ from it,
370 except that the mi_decls part is empty; when reading we consolidate
371 the declarations into a single indexed map in the @PersistentRenamerState@.
376 mi_module :: !Module,
377 mi_mod_vers :: !Version, -- Module version: changes when anything changes
379 mi_orphan :: !WhetherHasOrphans, -- Whether this module has orphans
380 mi_finsts :: !WhetherHasFamInst, -- Whether module has family insts
381 mi_boot :: !IsBootInterface, -- Read from an hi-boot file?
383 mi_deps :: Dependencies,
384 -- This is consulted for directly-imported modules,
385 -- but not for anything else (hence lazy)
387 -- Usages; kept sorted so that it's easy to decide
388 -- whether to write a new iface file (changing usages
389 -- doesn't affect the version of this module)
390 mi_usages :: [Usage],
391 -- NOT STRICT! we read this field lazily from the interface file
392 -- It is *only* consulted by the recompilation checker
395 -- Kept sorted by (mod,occ), to make version comparisons easier
396 mi_exports :: ![IfaceExport],
397 mi_exp_vers :: !Version, -- Version number of export list
400 mi_fixities :: [(OccName,Fixity)],
401 -- NOT STRICT! we read this field lazily from the interface file
404 mi_deprecs :: IfaceDeprecs,
405 -- NOT STRICT! we read this field lazily from the interface file
407 -- Type, class and variable declarations
408 -- The version of an Id changes if its fixity or deprecations change
409 -- (as well as its type of course)
410 -- Ditto data constructors, class operations, except that
411 -- the version of the parent class/tycon changes
412 mi_decls :: [(Version,IfaceDecl)], -- Sorted
414 mi_globals :: !(Maybe GlobalRdrEnv),
415 -- Binds all the things defined at the top level in
416 -- the *original source* code for this module. which
417 -- is NOT the same as mi_exports, nor mi_decls (which
418 -- may contains declarations for things not actually
419 -- defined by the user). Used for GHCi and for inspecting
420 -- the contents of modules via the GHC API only.
422 -- (We need the source file to figure out the
423 -- top-level environment, if we didn't compile this module
424 -- from source then this field contains Nothing).
426 -- Strictly speaking this field should live in the
427 -- HomeModInfo, but that leads to more plumbing.
429 -- Instance declarations and rules
430 mi_insts :: [IfaceInst], -- Sorted
431 mi_fam_insts :: [IfaceFamInst], -- Sorted
432 mi_rules :: [IfaceRule], -- Sorted
433 mi_rule_vers :: !Version, -- Version number for rules and
434 -- instances (for classes and families)
437 -- Cached environments for easy lookup
438 -- These are computed (lazily) from other fields
439 -- and are not put into the interface file
440 mi_dep_fn :: Name -> Maybe DeprecTxt, -- Cached lookup for mi_deprecs
441 mi_fix_fn :: OccName -> Fixity, -- Cached lookup for mi_fixities
442 mi_ver_fn :: OccName -> Maybe (OccName, Version)
443 -- Cached lookup for mi_decls
444 -- The Nothing in mi_ver_fn means that the thing
445 -- isn't in decls. It's useful to know that when
446 -- seeing if we are up to date wrt the old interface
447 -- The 'OccName' is the parent of the name, if it has one.
450 -- Should be able to construct ModDetails from mi_decls in ModIface
453 -- The next two fields are created by the typechecker
454 md_exports :: [AvailInfo],
455 md_types :: !TypeEnv,
456 md_insts :: ![Instance], -- Dfun-ids for the instances in this module
457 md_fam_insts :: ![FamInst],
458 md_rules :: ![CoreRule], -- Domain may include Ids from other modules
459 md_dbg_sites :: ![(SiteNumber, Coord)] -- Breakpoint sites inserted by the renamer
462 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
467 md_dbg_sites = noDbgSites}
469 -- A ModGuts is carried through the compiler, accumulating stuff as it goes
470 -- There is only one ModGuts at any time, the one for the module
471 -- being compiled right now. Once it is compiled, a ModIface and
472 -- ModDetails are extracted and the ModGuts is dicarded.
476 mg_module :: !Module,
477 mg_boot :: IsBootInterface, -- Whether it's an hs-boot module
478 mg_exports :: ![AvailInfo], -- What it exports
479 mg_deps :: !Dependencies, -- What is below it, directly or
481 mg_dir_imps :: ![Module], -- Directly-imported modules; used to
482 -- generate initialisation code
483 mg_usages :: ![Usage], -- Version info for what it needed
485 mg_rdr_env :: !GlobalRdrEnv, -- Top-level lexical environment
486 mg_fix_env :: !FixityEnv, -- Fixity env, for things declared in
489 mg_fam_inst_env :: FamInstEnv, -- Type-family instance enviroment
490 -- for *home-package* modules (including
491 -- this one). c.f. tcg_fam_inst_env
493 mg_types :: !TypeEnv,
494 mg_insts :: ![Instance], -- Instances
495 mg_fam_insts :: ![FamInst], -- Instances
496 mg_rules :: ![CoreRule], -- Rules from this module
497 mg_binds :: ![CoreBind], -- Bindings for this module
498 mg_foreign :: !ForeignStubs,
499 mg_deprecs :: !Deprecations, -- Deprecations declared in the module
500 mg_hpc_info :: !HpcInfo, -- info about coverage tick boxes
501 mg_dbg_sites :: ![(SiteNumber, Coord)] -- Bkpts inserted by the renamer
504 -- The ModGuts takes on several slightly different forms:
506 -- After simplification, the following fields change slightly:
507 -- mg_rules Orphan rules only (local ones now attached to binds)
508 -- mg_binds With rules attached
511 ---------------------------------------------------------
512 -- The Tidy pass forks the information about this module:
513 -- * one lot goes to interface file generation (ModIface)
514 -- and later compilations (ModDetails)
515 -- * the other lot goes to code generation (CgGuts)
518 cg_module :: !Module,
520 cg_tycons :: [TyCon],
521 -- Algebraic data types (including ones that started
522 -- life as classes); generate constructors and info
523 -- tables Includes newtypes, just for the benefit of
526 cg_binds :: [CoreBind],
527 -- The tidied main bindings, including
528 -- previously-implicit bindings for record and class
529 -- selectors, and data construtor wrappers. But *not*
530 -- data constructor workers; reason: we we regard them
531 -- as part of the code-gen of tycons
533 cg_dir_imps :: ![Module],
534 -- Directly-imported modules; used to generate
535 -- initialisation code
537 cg_foreign :: !ForeignStubs,
538 cg_dep_pkgs :: ![PackageId], -- Used to generate #includes for C code gen
539 cg_hpc_info :: !HpcInfo -- info about coverage tick boxes
542 -----------------------------------
545 imp_direct :: ![(Module,Bool)], -- Explicitly-imported modules
546 -- Boolean is true if we imported the whole
547 -- module (apart, perhaps, from hiding some)
548 imp_pkg_mods :: !ModuleSet, -- Non-home-package modules on which we depend,
549 -- directly or indirectly
550 imp_home_names :: !NameSet -- Home package things on which we depend,
551 -- directly or indirectly
554 -----------------------------------
555 data ForeignStubs = NoStubs
557 SDoc -- Header file prototypes for
558 -- "foreign exported" functions
559 SDoc -- C stubs to use when calling
560 -- "foreign exported" functions
561 [FastString] -- Headers that need to be included
562 -- into C code generated for this module
563 [Id] -- Foreign-exported binders
564 -- we have to generate code to register these
569 emptyModIface :: Module -> ModIface
571 = ModIface { mi_module = mod,
572 mi_mod_vers = initialVersion,
576 mi_deps = noDependencies,
579 mi_exp_vers = initialVersion,
581 mi_deprecs = NoDeprecs,
586 mi_globals = Nothing,
587 mi_rule_vers = initialVersion,
588 mi_dep_fn = emptyIfaceDepCache,
589 mi_fix_fn = emptyIfaceFixCache,
590 mi_ver_fn = emptyIfaceVerCache
595 %************************************************************************
597 \subsection{The interactive context}
599 %************************************************************************
602 data InteractiveContext
603 = InteractiveContext {
604 ic_toplev_scope :: [Module], -- Include the "top-level" scope of
607 ic_exports :: [Module], -- Include just the exports of these
610 ic_rn_gbl_env :: GlobalRdrEnv, -- The cached GlobalRdrEnv, built from
611 -- ic_toplev_scope and ic_exports
613 ic_rn_local_env :: LocalRdrEnv, -- Lexical context for variables bound
614 -- during interaction
616 ic_type_env :: TypeEnv -- Ditto for types
619 emptyInteractiveContext
620 = InteractiveContext { ic_toplev_scope = [],
622 ic_rn_gbl_env = emptyGlobalRdrEnv,
623 ic_rn_local_env = emptyLocalRdrEnv,
624 ic_type_env = emptyTypeEnv }
626 icPrintUnqual :: InteractiveContext -> PrintUnqualified
627 icPrintUnqual ictxt = mkPrintUnqualified (ic_rn_gbl_env ictxt)
630 %************************************************************************
632 Building a PrintUnqualified
634 %************************************************************************
637 mkPrintUnqualified :: GlobalRdrEnv -> PrintUnqualified
638 mkPrintUnqualified env = (qual_name, qual_mod)
641 | null gres = Just (moduleName mod)
642 -- it isn't in scope at all, this probably shouldn't happen,
643 -- but we'll qualify it by the original module anyway.
644 | any unQualOK gres = Nothing
645 | (Imported is : _) <- map gre_prov gres, (idecl : _) <- is
646 = Just (is_as (is_decl idecl))
647 | otherwise = panic "mkPrintUnqualified"
649 gres = [ gre | gre <- lookupGlobalRdrEnv env occ,
650 nameModule (gre_name gre) == mod ]
652 qual_mod mod = Nothing -- For now...
656 %************************************************************************
660 %************************************************************************
663 implicitTyThings :: TyThing -> [TyThing]
664 -- If you change this, make sure you change LoadIface.ifaceDeclSubBndrs in sync
666 implicitTyThings (AnId id) = []
668 -- For type constructors, add the data cons (and their extras),
669 -- and the selectors and generic-programming Ids too
671 -- Newtypes don't have a worker Id, so don't generate that?
672 implicitTyThings (ATyCon tc) = implicitCoTyCon tc ++
673 map AnId (tyConSelIds tc) ++
674 concatMap (extras_plus . ADataCon)
677 -- For classes, add the class TyCon too (and its extras)
678 -- and the class selector Ids and the associated types (they don't
679 -- have extras as these are only the family decls)
680 implicitTyThings (AClass cl) = map AnId (classSelIds cl) ++
681 map ATyCon (classATs cl) ++
682 extras_plus (ATyCon (classTyCon cl))
684 -- For data cons add the worker and wrapper (if any)
685 implicitTyThings (ADataCon dc) = map AnId (dataConImplicitIds dc)
687 -- | returns 'True' if there should be no interface-file declaration
688 -- for this thing on its own: either it is built-in, or it is part
689 -- of some other declaration, or it is generated implicitly by some
690 -- other declaration.
691 isImplicitTyThing :: TyThing -> Bool
692 isImplicitTyThing (ADataCon _) = True
693 isImplicitTyThing (AnId id) = isImplicitId id
694 isImplicitTyThing (AClass _) = False
695 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
697 -- For newtypes and indexed data types, add the implicit coercion tycon
699 = map ATyCon . catMaybes $ [newTyConCo_maybe tc,
700 tyConFamilyCoercion_maybe tc]
702 extras_plus thing = thing : implicitTyThings thing
704 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
705 extendTypeEnvWithIds env ids
706 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
709 %************************************************************************
713 %************************************************************************
716 type TypeEnv = NameEnv TyThing
718 emptyTypeEnv :: TypeEnv
719 typeEnvElts :: TypeEnv -> [TyThing]
720 typeEnvClasses :: TypeEnv -> [Class]
721 typeEnvTyCons :: TypeEnv -> [TyCon]
722 typeEnvIds :: TypeEnv -> [Id]
723 typeEnvDataCons :: TypeEnv -> [DataCon]
724 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
726 emptyTypeEnv = emptyNameEnv
727 typeEnvElts env = nameEnvElts env
728 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
729 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
730 typeEnvIds env = [id | AnId id <- typeEnvElts env]
731 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
733 mkTypeEnv :: [TyThing] -> TypeEnv
734 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
736 lookupTypeEnv = lookupNameEnv
738 -- Extend the type environment
739 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
740 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
742 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
743 extendTypeEnvList env things = foldl extendTypeEnv env things
747 lookupType :: DynFlags
753 lookupType dflags hpt pte name
754 -- in one-shot, we don't use the HPT
755 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
756 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
757 lookupNameEnv (md_types (hm_details hm)) name
759 = lookupNameEnv pte name
760 where mod = nameModule name
761 this_pkg = thisPackage dflags
765 tyThingTyCon (ATyCon tc) = tc
766 tyThingTyCon other = pprPanic "tyThingTyCon" (ppr other)
768 tyThingClass (AClass cls) = cls
769 tyThingClass other = pprPanic "tyThingClass" (ppr other)
771 tyThingDataCon (ADataCon dc) = dc
772 tyThingDataCon other = pprPanic "tyThingDataCon" (ppr other)
774 tyThingId (AnId id) = id
775 tyThingId other = pprPanic "tyThingId" (ppr other)
778 %************************************************************************
780 \subsection{Auxiliary types}
782 %************************************************************************
784 These types are defined here because they are mentioned in ModDetails,
785 but they are mostly elaborated elsewhere
788 mkIfaceVerCache :: [(Version,IfaceDecl)]
789 -> (OccName -> Maybe (OccName, Version))
790 mkIfaceVerCache pairs
791 = \occ -> lookupOccEnv env occ
793 env = foldr add_decl emptyOccEnv pairs
794 add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
797 env1 = extendOccEnv env0 decl_name (decl_name, v)
798 add_imp bndr env = extendOccEnv env bndr (decl_name, v)
800 emptyIfaceVerCache :: OccName -> Maybe (OccName, Version)
801 emptyIfaceVerCache occ = Nothing
803 ------------------ Deprecations -------------------------
806 | DeprecAll DeprecTxt -- Whole module deprecated
807 | DeprecSome a -- Some specific things deprecated
810 type IfaceDeprecs = Deprecs [(OccName,DeprecTxt)]
811 type Deprecations = Deprecs (NameEnv (OccName,DeprecTxt))
812 -- Keep the OccName so we can flatten the NameEnv to
813 -- get an IfaceDeprecs from a Deprecations
814 -- Only an OccName is needed, because a deprecation always
815 -- applies to things defined in the module in which the
816 -- deprecation appears.
818 mkIfaceDepCache:: IfaceDeprecs -> Name -> Maybe DeprecTxt
819 mkIfaceDepCache NoDeprecs = \n -> Nothing
820 mkIfaceDepCache (DeprecAll t) = \n -> Just t
821 mkIfaceDepCache (DeprecSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
823 emptyIfaceDepCache :: Name -> Maybe DeprecTxt
824 emptyIfaceDepCache n = Nothing
826 plusDeprecs :: Deprecations -> Deprecations -> Deprecations
827 plusDeprecs d NoDeprecs = d
828 plusDeprecs NoDeprecs d = d
829 plusDeprecs d (DeprecAll t) = DeprecAll t
830 plusDeprecs (DeprecAll t) d = DeprecAll t
831 plusDeprecs (DeprecSome v1) (DeprecSome v2) = DeprecSome (v1 `plusNameEnv` v2)
836 type Avails = [AvailInfo]
837 type AvailInfo = GenAvailInfo Name
838 type RdrAvailInfo = GenAvailInfo OccName
840 data GenAvailInfo name = Avail name -- An ordinary identifier
841 | AvailTC name -- The name of the type or class
842 [name] -- The available pieces of type/class.
843 -- NB: If the type or class is itself
844 -- to be in scope, it must be in this list.
845 -- Thus, typically: AvailTC Eq [Eq, ==, /=]
847 -- Equality used when deciding if the interface has changed
849 type IfaceExport = (Module, [GenAvailInfo OccName])
851 availsToNameSet :: [AvailInfo] -> NameSet
852 availsToNameSet avails = foldr add emptyNameSet avails
853 where add avail set = addListToNameSet set (availNames avail)
855 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
856 availsToNameEnv avails = foldr add emptyNameEnv avails
857 where add avail env = extendNameEnvList env
858 (zip (availNames avail) (repeat avail))
860 availName :: GenAvailInfo name -> name
861 availName (Avail n) = n
862 availName (AvailTC n _) = n
864 availNames :: GenAvailInfo name -> [name]
865 availNames (Avail n) = [n]
866 availNames (AvailTC n ns) = ns
868 instance Outputable n => Outputable (GenAvailInfo n) where
871 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
872 pprAvail (Avail n) = ppr n
873 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
877 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
878 mkIfaceFixCache pairs
879 = \n -> lookupOccEnv env n `orElse` defaultFixity
883 emptyIfaceFixCache :: OccName -> Fixity
884 emptyIfaceFixCache n = defaultFixity
886 -- This fixity environment is for source code only
887 type FixityEnv = NameEnv FixItem
889 -- We keep the OccName in the range so that we can generate an interface from it
890 data FixItem = FixItem OccName Fixity SrcSpan
892 instance Outputable FixItem where
893 ppr (FixItem occ fix loc) = ppr fix <+> ppr occ <+> parens (ppr loc)
895 emptyFixityEnv :: FixityEnv
896 emptyFixityEnv = emptyNameEnv
898 lookupFixity :: FixityEnv -> Name -> Fixity
899 lookupFixity env n = case lookupNameEnv env n of
900 Just (FixItem _ fix _) -> fix
901 Nothing -> defaultFixity
905 %************************************************************************
907 \subsection{WhatsImported}
909 %************************************************************************
912 type WhetherHasOrphans = Bool
914 -- * an instance decl in a module other than the defn module for
915 -- one of the tycons or classes in the instance head
916 -- * a transformation rule in a module other than the one defining
917 -- the function in the head of the rule.
919 type WhetherHasFamInst = Bool -- This module defines family instances?
921 type IsBootInterface = Bool
923 -- Dependency info about modules and packages below this one
924 -- in the import hierarchy. See TcRnTypes.ImportAvails for details.
925 -- The orphan modules in `dep_orphs' do *not* include family instance orphans,
926 -- as they are anyway included in `dep_finsts'.
928 -- Invariant: the dependencies of a module M never includes M
929 -- Invariant: the lists are unordered, with no duplicates
931 = Deps { dep_mods :: [(ModuleName, -- Home-package module dependencies
933 , dep_pkgs :: [PackageId] -- External package dependencies
934 , dep_orphs :: [Module] -- Orphan modules (whether home or
936 , dep_finsts :: [Module] -- Modules that contain family
937 -- instances (whether home or
941 -- Equality used only for old/new comparison in MkIface.addVersionInfo
943 noDependencies :: Dependencies
944 noDependencies = Deps [] [] [] []
947 = Usage { usg_name :: ModuleName, -- Name of the module
948 usg_mod :: Version, -- Module version
949 usg_entities :: [(OccName,Version)], -- Sorted by occurrence name
950 -- NB. usages are for parent names only, eg. tycon but not constructors.
951 usg_exports :: Maybe Version, -- Export-list version, if we depend on it
952 usg_rules :: Version -- Orphan-rules version (for non-orphan
953 -- modules this will always be initialVersion)
955 -- This type doesn't let you say "I imported f but none of the rules in
956 -- the module". If you use anything in the module you get its rule version
957 -- So if the rules change, you'll recompile, even if you don't use them.
958 -- This is easy to implement, and it's safer: you might not have used the rules last
959 -- time round, but if someone has added a new rule you might need it this time
961 -- The export list field is (Just v) if we depend on the export list:
962 -- i.e. we imported the module directly, whether or not we
963 -- enumerated the things we imported, or just imported everything
964 -- We need to recompile if M's exports change, because
965 -- if the import was import M, we might now have a name clash in the
967 -- if the import was import M(x) M might no longer export x
968 -- The only way we don't depend on the export list is if we have
970 -- And of course, for modules that aren't imported directly we don't
971 -- depend on their export lists
975 %************************************************************************
977 The External Package State
979 %************************************************************************
982 type PackageTypeEnv = TypeEnv
983 type PackageRuleBase = RuleBase
984 type PackageInstEnv = InstEnv
985 type PackageFamInstEnv = FamInstEnv
987 data ExternalPackageState
989 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
990 -- In OneShot mode (only), home-package modules
991 -- accumulate in the external package state, and are
992 -- sucked in lazily. For these home-pkg modules
993 -- (only) we need to record which are boot modules.
994 -- We set this field after loading all the
995 -- explicitly-imported interfaces, but before doing
998 -- The ModuleName part is not necessary, but it's useful for
999 -- debug prints, and it's convenient because this field comes
1000 -- direct from TcRnTypes.ImportAvails.imp_dep_mods
1002 eps_PIT :: !PackageIfaceTable,
1003 -- The ModuleIFaces for modules in external packages
1004 -- whose interfaces we have opened
1005 -- The declarations in these interface files are held in
1006 -- eps_decls, eps_inst_env, eps_fam_inst_env, eps_rules
1007 -- (below), not in the mi_decls fields of the iPIT.
1008 -- What _is_ in the iPIT is:
1015 eps_PTE :: !PackageTypeEnv, -- Domain = external-package modules
1017 eps_inst_env :: !PackageInstEnv, -- The total InstEnv accumulated
1018 -- from all the external-package
1020 eps_fam_inst_env :: !PackageFamInstEnv,-- Ditto FamInstEnv
1021 eps_rule_base :: !PackageRuleBase, -- Ditto RuleEnv
1023 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- identifies family
1024 -- instances of each mod
1026 eps_stats :: !EpsStats
1029 -- "In" means read from iface files
1030 -- "Out" means actually sucked in and type-checked
1031 data EpsStats = EpsStats { n_ifaces_in
1032 , n_decls_in, n_decls_out
1033 , n_rules_in, n_rules_out
1034 , n_insts_in, n_insts_out :: !Int }
1036 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1037 -- Add stats for one newly-read interface
1038 addEpsInStats stats n_decls n_insts n_rules
1039 = stats { n_ifaces_in = n_ifaces_in stats + 1
1040 , n_decls_in = n_decls_in stats + n_decls
1041 , n_insts_in = n_insts_in stats + n_insts
1042 , n_rules_in = n_rules_in stats + n_rules }
1045 The NameCache makes sure that there is just one Unique assigned for
1046 each original name; i.e. (module-name, occ-name) pair. The Name is
1047 always stored as a Global, and has the SrcLoc of its binding location.
1048 Actually that's not quite right. When we first encounter the original
1049 name, we might not be at its binding site (e.g. we are reading an
1050 interface file); so we give it 'noSrcLoc' then. Later, when we find
1051 its binding site, we fix it up.
1055 = NameCache { nsUniqs :: UniqSupply,
1056 -- Supply of uniques
1057 nsNames :: OrigNameCache,
1058 -- Ensures that one original name gets one unique
1059 nsIPs :: OrigIParamCache
1060 -- Ensures that one implicit parameter name gets one unique
1063 type OrigNameCache = ModuleEnv (OccEnv Name)
1064 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1069 %************************************************************************
1071 The module graph and ModSummary type
1072 A ModSummary is a node in the compilation manager's
1073 dependency graph, and it's also passed to hscMain
1075 %************************************************************************
1077 A ModuleGraph contains all the nodes from the home package (only).
1078 There will be a node for each source module, plus a node for each hi-boot
1082 type ModuleGraph = [ModSummary] -- The module graph,
1083 -- NOT NECESSARILY IN TOPOLOGICAL ORDER
1085 emptyMG :: ModuleGraph
1088 -- The nodes of the module graph are
1089 -- EITHER a regular Haskell source module
1090 -- OR a hi-boot source module
1094 ms_mod :: Module, -- Identity of the module
1095 ms_hsc_src :: HscSource, -- Source is Haskell, hs-boot, external core
1096 ms_location :: ModLocation, -- Location
1097 ms_hs_date :: ClockTime, -- Timestamp of source file
1098 ms_obj_date :: Maybe ClockTime, -- Timestamp of object, maybe
1099 ms_srcimps :: [Located ModuleName], -- Source imports
1100 ms_imps :: [Located ModuleName], -- Non-source imports
1101 ms_hspp_file :: FilePath, -- Filename of preprocessed source.
1102 ms_hspp_opts :: DynFlags, -- Cached flags from OPTIONS, INCLUDE
1103 -- and LANGUAGE pragmas.
1104 ms_hspp_buf :: Maybe StringBuffer -- The actual preprocessed source, maybe.
1107 -- The ModLocation contains both the original source filename and the
1108 -- filename of the cleaned-up source file after all preprocessing has been
1109 -- done. The point is that the summariser will have to cpp/unlit/whatever
1110 -- all files anyway, and there's no point in doing this twice -- just
1111 -- park the result in a temp file, put the name of it in the location,
1112 -- and let @compile@ read from that file on the way back up.
1114 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1115 -- the ms_hs_date and imports can, of course, change
1117 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1118 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1119 msHiFilePath ms = ml_hi_file (ms_location ms)
1120 msObjFilePath ms = ml_obj_file (ms_location ms)
1122 isBootSummary :: ModSummary -> Bool
1123 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1125 instance Outputable ModSummary where
1127 = sep [text "ModSummary {",
1128 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1129 text "ms_mod =" <+> ppr (ms_mod ms)
1130 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1131 text "ms_imps =" <+> ppr (ms_imps ms),
1132 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1136 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1137 showModMsg target recomp mod_summary
1138 = showSDoc (hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1139 char '(', text (msHsFilePath mod_summary) <> comma,
1141 HscInterpreted | recomp
1142 -> text "interpreted"
1143 HscNothing -> text "nothing"
1144 _other -> text (msObjFilePath mod_summary),
1147 mod = moduleName (ms_mod mod_summary)
1148 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1152 %************************************************************************
1154 \subsection{Hpc Support}
1156 %************************************************************************
1159 type HpcInfo = Int -- just the number of ticks in a module
1161 noHpcInfo :: HpcInfo
1162 noHpcInfo = 0 -- default = 0
1165 %************************************************************************
1167 \subsection{Linkable stuff}
1169 %************************************************************************
1171 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1172 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1175 data Linkable = LM {
1176 linkableTime :: ClockTime, -- Time at which this linkable was built
1177 -- (i.e. when the bytecodes were produced,
1178 -- or the mod date on the files)
1179 linkableModule :: Module, -- Should be Module, but see below
1180 linkableUnlinked :: [Unlinked]
1183 isObjectLinkable :: Linkable -> Bool
1184 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1185 where unlinked = linkableUnlinked l
1186 -- A linkable with no Unlinked's is treated as a BCO. We can
1187 -- generate a linkable with no Unlinked's as a result of
1188 -- compiling a module in HscNothing mode, and this choice
1189 -- happens to work well with checkStability in module GHC.
1191 instance Outputable Linkable where
1192 ppr (LM when_made mod unlinkeds)
1193 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1194 $$ nest 3 (ppr unlinkeds)
1196 -------------------------------------------
1201 | BCOs CompiledByteCode
1204 data CompiledByteCode = NoByteCode
1207 instance Outputable Unlinked where
1208 ppr (DotO path) = text "DotO" <+> text path
1209 ppr (DotA path) = text "DotA" <+> text path
1210 ppr (DotDLL path) = text "DotDLL" <+> text path
1212 ppr (BCOs bcos) = text "BCOs" <+> ppr bcos
1214 ppr (BCOs bcos) = text "No byte code"
1217 isObject (DotO _) = True
1218 isObject (DotA _) = True
1219 isObject (DotDLL _) = True
1222 isInterpretable = not . isObject
1224 nameOfObject (DotO fn) = fn
1225 nameOfObject (DotA fn) = fn
1226 nameOfObject (DotDLL fn) = fn
1227 nameOfObject other = pprPanic "nameOfObject" (ppr other)
1229 byteCodeOfObject (BCOs bc) = bc
1230 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)