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,
46 WhetherHasOrphans, IsBootInterface, Usage(..),
47 Dependencies(..), noDependencies,
48 NameCache(..), OrigNameCache, OrigIParamCache,
49 Avails, availsToNameSet, availName, availNames,
50 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
53 Deprecations, DeprecTxt, lookupDeprec, plusDeprecs,
55 PackageInstEnv, PackageRuleBase,
58 Linkable(..), isObjectLinkable,
59 Unlinked(..), CompiledByteCode,
60 isObject, nameOfObject, isInterpretable, byteCodeOfObject
63 #include "HsVersions.h"
66 import ByteCodeAsm ( CompiledByteCode )
69 import RdrName ( GlobalRdrEnv, emptyGlobalRdrEnv,
70 LocalRdrEnv, emptyLocalRdrEnv, GlobalRdrElt(..),
71 unQualOK, ImpDeclSpec(..), Provenance(..),
72 ImportSpec(..), lookupGlobalRdrEnv )
73 import Name ( Name, NamedThing, getName, nameOccName, nameModule )
76 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
79 import InstEnv ( InstEnv, Instance )
80 import Rules ( RuleBase )
81 import CoreSyn ( CoreBind )
83 import Type ( TyThing(..) )
85 import Class ( Class, classSelIds, classTyCon )
86 import TyCon ( TyCon, tyConSelIds, tyConDataCons, isNewTyCon, newTyConCo )
87 import DataCon ( dataConImplicitIds )
88 import PrelNames ( gHC_PRIM )
89 import Packages ( PackageId )
90 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..) )
91 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
92 import BasicTypes ( Version, initialVersion, IPName,
93 Fixity, defaultFixity, DeprecTxt )
95 import IfaceSyn ( IfaceInst, IfaceRule, IfaceDecl(ifName) )
97 import FiniteMap ( FiniteMap )
98 import CoreSyn ( CoreRule )
99 import Maybes ( orElse, expectJust )
101 import SrcLoc ( SrcSpan, Located )
102 import UniqFM ( lookupUFM, eltsUFM, emptyUFM )
103 import UniqSupply ( UniqSupply )
104 import FastString ( FastString )
106 import DATA_IOREF ( IORef, readIORef )
107 import StringBuffer ( StringBuffer )
108 import Time ( ClockTime )
112 %************************************************************************
114 \subsection{Compilation environment}
116 %************************************************************************
120 -- | The Session is a handle to the complete state of a compilation
121 -- session. A compilation session consists of a set of modules
122 -- constituting the current program or library, the context for
123 -- interactive evaluation, and various caches.
124 newtype Session = Session (IORef HscEnv)
127 HscEnv is like Session, except that some of the fields are immutable.
128 An HscEnv is used to compile a single module from plain Haskell source
129 code (after preprocessing) to either C, assembly or C--. Things like
130 the module graph don't change during a single compilation.
132 Historical note: "hsc" used to be the name of the compiler binary,
133 when there was a separate driver and compiler. To compile a single
134 module, the driver would invoke hsc on the source code... so nowadays
135 we think of hsc as the layer of the compiler that deals with compiling
141 hsc_dflags :: DynFlags,
142 -- The dynamic flag settings
144 hsc_targets :: [Target],
145 -- The targets (or roots) of the current session
147 hsc_mod_graph :: ModuleGraph,
148 -- The module graph of the current session
150 hsc_IC :: InteractiveContext,
151 -- The context for evaluating interactive statements
153 hsc_HPT :: HomePackageTable,
154 -- The home package table describes already-compiled
155 -- home-packge modules, *excluding* the module we
156 -- are compiling right now.
157 -- (In one-shot mode the current module is the only
158 -- home-package module, so hsc_HPT is empty. All other
159 -- modules count as "external-package" modules.
160 -- However, even in GHCi mode, hi-boot interfaces are
161 -- demand-loadeded into the external-package table.)
163 -- hsc_HPT is not mutable because we only demand-load
164 -- external packages; the home package is eagerly
165 -- loaded, module by module, by the compilation manager.
167 -- The HPT may contain modules compiled earlier by --make
168 -- but not actually below the current module in the dependency
169 -- graph. (This changes a previous invariant: changed Jan 05.)
171 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
172 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
173 -- These are side-effected by compiling to reflect
174 -- sucking in interface files. They cache the state of
175 -- external interface files, in effect.
177 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
178 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
179 -- The finder's cache. This caches the location of modules,
180 -- so we don't have to search the filesystem multiple times.
182 hsc_global_rdr_env :: GlobalRdrEnv,
183 hsc_global_type_env :: TypeEnv
186 hscEPS :: HscEnv -> IO ExternalPackageState
187 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
189 -- | A compilation target.
191 -- A target may be supplied with the actual text of the
192 -- module. If so, use this instead of the file contents (this
193 -- is for use in an IDE where the file hasn't been saved by
195 data Target = Target TargetId (Maybe (StringBuffer,ClockTime))
198 = TargetModule ModuleName
199 -- ^ A module name: search for the file
200 | TargetFile FilePath (Maybe Phase)
201 -- ^ A filename: preprocess & parse it to find the module name.
202 -- If specified, the Phase indicates how to compile this file
203 -- (which phase to start from). Nothing indicates the starting phase
204 -- should be determined from the suffix of the filename.
207 pprTarget :: Target -> SDoc
208 pprTarget (Target id _) = pprTargetId id
210 pprTargetId (TargetModule m) = ppr m
211 pprTargetId (TargetFile f _) = text f
213 type HomePackageTable = ModuleNameEnv HomeModInfo
214 -- Domain = modules in the home package
215 -- "home" package name cached here for convenience
216 type PackageIfaceTable = ModuleEnv ModIface
217 -- Domain = modules in the imported packages
219 emptyHomePackageTable = emptyUFM
220 emptyPackageIfaceTable = emptyModuleEnv
223 = HomeModInfo { hm_iface :: !ModIface,
224 hm_details :: !ModDetails,
225 hm_linkable :: !(Maybe Linkable) }
226 -- hm_linkable might be Nothing if:
227 -- a) this is an .hs-boot module
228 -- b) temporarily during compilation if we pruned away
229 -- the old linkable because it was out of date.
230 -- after a complete compilation (GHC.load), all hm_linkable
231 -- fields in the HPT will be Just.
233 -- When re-linking a module (hscNoRecomp), we construct
234 -- the HomModInfo by building a new ModDetails from the
235 -- old ModIface (only).
237 -- | Find the 'ModIface' for a 'Module'
244 lookupIfaceByModule dflags hpt pit mod
245 -- in one-shot, we don't use the HPT
246 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
247 = fmap hm_iface (lookupUFM hpt (moduleName mod))
249 = lookupModuleEnv pit mod
250 where this_pkg = thisPackage dflags
255 hptInstances :: HscEnv -> (ModuleName -> Bool) -> [Instance]
256 -- Find all the instance declarations that are in modules imported
257 -- by this one, directly or indirectly, and are in the Home Package Table
258 -- This ensures that we don't see instances from modules --make compiled
259 -- before this one, but which are not below this one
260 hptInstances hsc_env want_this_module
262 | mod_info <- eltsUFM (hsc_HPT hsc_env)
263 , want_this_module (moduleName (mi_module (hm_iface mod_info)))
264 , ispec <- md_insts (hm_details mod_info) ]
266 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
267 -- Get rules from modules "below" this one (in the dependency sense)
268 -- C.f Inst.hptInstances
269 hptRules hsc_env deps
270 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
273 hpt = hsc_HPT hsc_env
276 | -- Find each non-hi-boot module below me
279 -- unsavoury: when compiling the base package with --make, we
280 -- sometimes try to look up RULES for GHC.Prim. GHC.Prim won't
281 -- be in the HPT, because we never compile it; it's in the EPT
282 -- instead. ToDo: clean up, and remove this slightly bogus
284 , mod /= moduleName gHC_PRIM
286 -- Look it up in the HPT
287 , let mod_info = case lookupUFM hpt mod of
288 Nothing -> pprPanic "hptRules" (ppr mod <+> ppr deps)
292 , rule <- md_rules (hm_details mod_info) ]
295 %************************************************************************
297 \subsection{The Finder cache}
299 %************************************************************************
302 -- | The 'FinderCache' maps home module names to the result of
303 -- searching for that module. It records the results of searching for
304 -- modules along the search path. On @:load@, we flush the entire
305 -- contents of this cache.
307 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
308 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
310 type FinderCache = ModuleNameEnv FindResult
312 -- | The result of searching for an imported module.
314 = Found ModLocation Module
315 -- the module was found
316 | NoPackage PackageId
317 -- the requested package was not found
318 | FoundMultiple [PackageId]
319 -- *error*: both in multiple packages
320 | PackageHidden PackageId
321 -- for an explicit source import: the package containing the module is
323 | ModuleHidden PackageId
324 -- for an explicit source import: the package containing the module is
325 -- exposed, but the module itself is hidden.
326 | NotFound [FilePath] (Maybe PackageId)
327 -- the module was not found, the specified places were searched
328 | NotFoundInPackage PackageId
329 -- the module was not found in this package
331 -- | Cache that remembers where we found a particular module. Contains both
332 -- home modules and package modules. On @:load@, only home modules are
333 -- purged from this cache.
334 type ModLocationCache = ModuleEnv ModLocation
337 %************************************************************************
339 \subsection{Symbol tables and Module details}
341 %************************************************************************
343 A @ModIface@ plus a @ModDetails@ summarises everything we know
344 about a compiled module. The @ModIface@ is the stuff *before* linking,
345 and can be written out to an interface file. (The @ModDetails@ is after
346 linking; it is the "linked" form of the mi_decls field.)
348 When we *read* an interface file, we also construct a @ModIface@ from it,
349 except that the mi_decls part is empty; when reading we consolidate
350 the declarations into a single indexed map in the @PersistentRenamerState@.
355 mi_module :: !Module,
356 mi_mod_vers :: !Version, -- Module version: changes when anything changes
358 mi_orphan :: !WhetherHasOrphans, -- Whether this module has orphans
359 mi_boot :: !IsBootInterface, -- Read from an hi-boot file?
361 mi_deps :: Dependencies,
362 -- This is consulted for directly-imported modules,
363 -- but not for anything else (hence lazy)
365 -- Usages; kept sorted so that it's easy to decide
366 -- whether to write a new iface file (changing usages
367 -- doesn't affect the version of this module)
368 mi_usages :: [Usage],
369 -- NOT STRICT! we read this field lazily from the interface file
370 -- It is *only* consulted by the recompilation checker
373 -- Kept sorted by (mod,occ), to make version comparisons easier
374 mi_exports :: ![IfaceExport],
375 mi_exp_vers :: !Version, -- Version number of export list
378 mi_fixities :: [(OccName,Fixity)],
379 -- NOT STRICT! we read this field lazily from the interface file
382 mi_deprecs :: IfaceDeprecs,
383 -- NOT STRICT! we read this field lazily from the interface file
385 -- Type, class and variable declarations
386 -- The version of an Id changes if its fixity or deprecations change
387 -- (as well as its type of course)
388 -- Ditto data constructors, class operations, except that
389 -- the version of the parent class/tycon changes
390 mi_decls :: [(Version,IfaceDecl)], -- Sorted
392 mi_globals :: !(Maybe GlobalRdrEnv),
393 -- Binds all the things defined at the top level in
394 -- the *original source* code for this module. which
395 -- is NOT the same as mi_exports, nor mi_decls (which
396 -- may contains declarations for things not actually
397 -- defined by the user). Used for GHCi and for inspecting
398 -- the contents of modules via the GHC API only.
400 -- (We need the source file to figure out the
401 -- top-level environment, if we didn't compile this module
402 -- from source then this field contains Nothing).
404 -- Strictly speaking this field should live in the
405 -- HomeModInfo, but that leads to more plumbing.
407 -- Instance declarations and rules
408 mi_insts :: [IfaceInst], -- Sorted
409 mi_rules :: [IfaceRule], -- Sorted
410 mi_rule_vers :: !Version, -- Version number for rules and instances combined
412 -- Cached environments for easy lookup
413 -- These are computed (lazily) from other fields
414 -- and are not put into the interface file
415 mi_dep_fn :: Name -> Maybe DeprecTxt, -- Cached lookup for mi_deprecs
416 mi_fix_fn :: OccName -> Fixity, -- Cached lookup for mi_fixities
417 mi_ver_fn :: OccName -> Maybe Version -- Cached lookup for mi_decls
418 -- The Nothing in mi_ver_fn means that the thing
419 -- isn't in decls. It's useful to know that when
420 -- seeing if we are up to date wrt the old interface
423 -- Should be able to construct ModDetails from mi_decls in ModIface
426 -- The next three fields are created by the typechecker
427 md_exports :: NameSet,
428 md_types :: !TypeEnv,
429 md_insts :: ![Instance], -- Dfun-ids for the instances in this module
430 md_rules :: ![CoreRule] -- Domain may include Ids from other modules
433 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
434 md_exports = emptyNameSet,
438 -- A ModGuts is carried through the compiler, accumulating stuff as it goes
439 -- There is only one ModGuts at any time, the one for the module
440 -- being compiled right now. Once it is compiled, a ModIface and
441 -- ModDetails are extracted and the ModGuts is dicarded.
445 mg_module :: !Module,
446 mg_boot :: IsBootInterface, -- Whether it's an hs-boot module
447 mg_exports :: !NameSet, -- What it exports
448 mg_deps :: !Dependencies, -- What is below it, directly or otherwise
449 mg_dir_imps :: ![Module], -- Directly-imported modules; used to
450 -- generate initialisation code
451 mg_usages :: ![Usage], -- Version info for what it needed
453 mg_rdr_env :: !GlobalRdrEnv, -- Top-level lexical environment
454 mg_fix_env :: !FixityEnv, -- Fixity env, for things declared in this module
455 mg_deprecs :: !Deprecations, -- Deprecations declared in the module
457 mg_types :: !TypeEnv,
458 mg_insts :: ![Instance], -- Instances
459 mg_rules :: ![CoreRule], -- Rules from this module
460 mg_binds :: ![CoreBind], -- Bindings for this module
461 mg_foreign :: !ForeignStubs
464 -- The ModGuts takes on several slightly different forms:
466 -- After simplification, the following fields change slightly:
467 -- mg_rules Orphan rules only (local ones now attached to binds)
468 -- mg_binds With rules attached
471 ---------------------------------------------------------
472 -- The Tidy pass forks the information about this module:
473 -- * one lot goes to interface file generation (ModIface)
474 -- and later compilations (ModDetails)
475 -- * the other lot goes to code generation (CgGuts)
478 cg_module :: !Module,
480 cg_tycons :: [TyCon],
481 -- Algebraic data types (including ones that started
482 -- life as classes); generate constructors and info
483 -- tables Includes newtypes, just for the benefit of
486 cg_binds :: [CoreBind],
487 -- The tidied main bindings, including
488 -- previously-implicit bindings for record and class
489 -- selectors, and data construtor wrappers. But *not*
490 -- data constructor workers; reason: we we regard them
491 -- as part of the code-gen of tycons
493 cg_dir_imps :: ![Module],
494 -- Directly-imported modules; used to generate
495 -- initialisation code
497 cg_foreign :: !ForeignStubs,
498 cg_dep_pkgs :: ![PackageId] -- Used to generate #includes for C code gen
501 -----------------------------------
504 imp_direct :: ![(Module,Bool)], -- Explicitly-imported modules
505 -- Boolean is true if we imported the whole
506 -- module (apart, perhaps, from hiding some)
507 imp_pkg_mods :: !ModuleSet, -- Non-home-package modules on which we depend,
508 -- directly or indirectly
509 imp_home_names :: !NameSet -- Home package things on which we depend,
510 -- directly or indirectly
513 -----------------------------------
514 data ForeignStubs = NoStubs
516 SDoc -- Header file prototypes for
517 -- "foreign exported" functions
518 SDoc -- C stubs to use when calling
519 -- "foreign exported" functions
520 [FastString] -- Headers that need to be included
521 -- into C code generated for this module
522 [Id] -- Foreign-exported binders
523 -- we have to generate code to register these
528 emptyModIface :: Module -> ModIface
530 = ModIface { mi_module = mod,
531 mi_mod_vers = initialVersion,
534 mi_deps = noDependencies,
537 mi_exp_vers = initialVersion,
539 mi_deprecs = NoDeprecs,
543 mi_globals = Nothing,
544 mi_rule_vers = initialVersion,
545 mi_dep_fn = emptyIfaceDepCache,
546 mi_fix_fn = emptyIfaceFixCache,
547 mi_ver_fn = emptyIfaceVerCache
552 %************************************************************************
554 \subsection{The interactive context}
556 %************************************************************************
559 data InteractiveContext
560 = InteractiveContext {
561 ic_toplev_scope :: [Module], -- Include the "top-level" scope of
564 ic_exports :: [Module], -- Include just the exports of these
567 ic_rn_gbl_env :: GlobalRdrEnv, -- The cached GlobalRdrEnv, built from
568 -- ic_toplev_scope and ic_exports
570 ic_rn_local_env :: LocalRdrEnv, -- Lexical context for variables bound
571 -- during interaction
573 ic_type_env :: TypeEnv -- Ditto for types
576 emptyInteractiveContext
577 = InteractiveContext { ic_toplev_scope = [],
579 ic_rn_gbl_env = emptyGlobalRdrEnv,
580 ic_rn_local_env = emptyLocalRdrEnv,
581 ic_type_env = emptyTypeEnv }
583 icPrintUnqual :: InteractiveContext -> PrintUnqualified
584 icPrintUnqual ictxt = mkPrintUnqualified (ic_rn_gbl_env ictxt)
587 %************************************************************************
589 Building a PrintUnqualified
591 %************************************************************************
594 mkPrintUnqualified :: GlobalRdrEnv -> PrintUnqualified
595 mkPrintUnqualified env = (qual_name, qual_mod)
598 | null gres = Just (moduleName mod)
599 -- it isn't in scope at all, this probably shouldn't happen,
600 -- but we'll qualify it by the original module anyway.
601 | any unQualOK gres = Nothing
602 | (Imported is : _) <- map gre_prov gres, (idecl : _) <- is
603 = Just (is_as (is_decl idecl))
604 | otherwise = panic "mkPrintUnqualified"
606 gres = [ gre | gre <- lookupGlobalRdrEnv env occ,
607 nameModule (gre_name gre) == mod ]
609 qual_mod mod = Nothing -- For now...
613 %************************************************************************
617 %************************************************************************
620 implicitTyThings :: TyThing -> [TyThing]
621 -- If you change this, make sure you change LoadIface.ifaceDeclSubBndrs in sync
623 implicitTyThings (AnId id) = []
625 -- For type constructors, add the data cons (and their extras),
626 -- and the selectors and generic-programming Ids too
628 -- Newtypes don't have a worker Id, so don't generate that?
629 implicitTyThings (ATyCon tc) = implicitNewCoTyCon tc ++
630 map AnId (tyConSelIds tc) ++
631 concatMap (extras_plus . ADataCon) (tyConDataCons tc)
633 -- For classes, add the class TyCon too (and its extras)
634 -- and the class selector Ids
635 implicitTyThings (AClass cl) = map AnId (classSelIds cl) ++
636 extras_plus (ATyCon (classTyCon cl))
639 -- For data cons add the worker and wrapper (if any)
640 implicitTyThings (ADataCon dc) = map AnId (dataConImplicitIds dc)
642 -- For newtypes, add the implicit coercion tycon
643 implicitNewCoTyCon tc | isNewTyCon tc = [ATyCon (newTyConCo tc)]
646 extras_plus thing = thing : implicitTyThings thing
648 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
649 extendTypeEnvWithIds env ids
650 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
653 %************************************************************************
657 %************************************************************************
660 type TypeEnv = NameEnv TyThing
662 emptyTypeEnv :: TypeEnv
663 typeEnvElts :: TypeEnv -> [TyThing]
664 typeEnvClasses :: TypeEnv -> [Class]
665 typeEnvTyCons :: TypeEnv -> [TyCon]
666 typeEnvIds :: TypeEnv -> [Id]
667 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
669 emptyTypeEnv = emptyNameEnv
670 typeEnvElts env = nameEnvElts env
671 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
672 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
673 typeEnvIds env = [id | AnId id <- typeEnvElts env]
675 mkTypeEnv :: [TyThing] -> TypeEnv
676 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
678 lookupTypeEnv = lookupNameEnv
680 -- Extend the type environment
681 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
682 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
684 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
685 extendTypeEnvList env things = foldl extendTypeEnv env things
689 lookupType :: DynFlags
695 lookupType dflags hpt pte name
696 -- in one-shot, we don't use the HPT
697 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
698 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
699 lookupNameEnv (md_types (hm_details hm)) name
701 = lookupNameEnv pte name
702 where mod = nameModule name
703 this_pkg = thisPackage dflags
708 tyThingTyCon (ATyCon tc) = tc
709 tyThingTyCon other = pprPanic "tyThingTyCon" (ppr other)
711 tyThingClass (AClass cls) = cls
712 tyThingClass other = pprPanic "tyThingClass" (ppr other)
714 tyThingDataCon (ADataCon dc) = dc
715 tyThingDataCon other = pprPanic "tyThingDataCon" (ppr other)
717 tyThingId (AnId id) = id
718 tyThingId other = pprPanic "tyThingId" (ppr other)
721 %************************************************************************
723 \subsection{Auxiliary types}
725 %************************************************************************
727 These types are defined here because they are mentioned in ModDetails,
728 but they are mostly elaborated elsewhere
731 mkIfaceVerCache :: [(Version,IfaceDecl)] -> OccName -> Maybe Version
732 mkIfaceVerCache pairs
733 = \occ -> lookupOccEnv env occ
735 env = foldl add emptyOccEnv pairs
736 add env (v,d) = extendOccEnv env (ifName d) v
738 emptyIfaceVerCache :: OccName -> Maybe Version
739 emptyIfaceVerCache occ = Nothing
741 ------------------ Deprecations -------------------------
744 | DeprecAll DeprecTxt -- Whole module deprecated
745 | DeprecSome a -- Some specific things deprecated
748 type IfaceDeprecs = Deprecs [(OccName,DeprecTxt)]
749 type Deprecations = Deprecs (NameEnv (OccName,DeprecTxt))
750 -- Keep the OccName so we can flatten the NameEnv to
751 -- get an IfaceDeprecs from a Deprecations
752 -- Only an OccName is needed, because a deprecation always
753 -- applies to things defined in the module in which the
754 -- deprecation appears.
756 mkIfaceDepCache:: IfaceDeprecs -> Name -> Maybe DeprecTxt
757 mkIfaceDepCache NoDeprecs = \n -> Nothing
758 mkIfaceDepCache (DeprecAll t) = \n -> Just t
759 mkIfaceDepCache (DeprecSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
761 emptyIfaceDepCache :: Name -> Maybe DeprecTxt
762 emptyIfaceDepCache n = Nothing
764 lookupDeprec :: Deprecations -> Name -> Maybe DeprecTxt
765 lookupDeprec NoDeprecs name = Nothing
766 lookupDeprec (DeprecAll txt) name = Just txt
767 lookupDeprec (DeprecSome env) name = case lookupNameEnv env name of
768 Just (_, txt) -> Just txt
771 plusDeprecs :: Deprecations -> Deprecations -> Deprecations
772 plusDeprecs d NoDeprecs = d
773 plusDeprecs NoDeprecs d = d
774 plusDeprecs d (DeprecAll t) = DeprecAll t
775 plusDeprecs (DeprecAll t) d = DeprecAll t
776 plusDeprecs (DeprecSome v1) (DeprecSome v2) = DeprecSome (v1 `plusNameEnv` v2)
781 type Avails = [AvailInfo]
782 type AvailInfo = GenAvailInfo Name
783 type RdrAvailInfo = GenAvailInfo OccName
785 data GenAvailInfo name = Avail name -- An ordinary identifier
786 | AvailTC name -- The name of the type or class
787 [name] -- The available pieces of type/class.
788 -- NB: If the type or class is itself
789 -- to be in scope, it must be in this list.
790 -- Thus, typically: AvailTC Eq [Eq, ==, /=]
792 -- Equality used when deciding if the interface has changed
794 type IfaceExport = (Module, [GenAvailInfo OccName])
796 availsToNameSet :: [AvailInfo] -> NameSet
797 availsToNameSet avails = foldl add emptyNameSet avails
799 add set avail = addListToNameSet set (availNames avail)
801 availName :: GenAvailInfo name -> name
802 availName (Avail n) = n
803 availName (AvailTC n _) = n
805 availNames :: GenAvailInfo name -> [name]
806 availNames (Avail n) = [n]
807 availNames (AvailTC n ns) = ns
809 instance Outputable n => Outputable (GenAvailInfo n) where
812 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
813 pprAvail (AvailTC n ns) = ppr n <> case {- filter (/= n) -} ns of
815 ns' -> braces (hsep (punctuate comma (map ppr ns')))
817 pprAvail (Avail n) = ppr n
821 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
822 mkIfaceFixCache pairs
823 = \n -> lookupOccEnv env n `orElse` defaultFixity
827 emptyIfaceFixCache :: OccName -> Fixity
828 emptyIfaceFixCache n = defaultFixity
830 -- This fixity environment is for source code only
831 type FixityEnv = NameEnv FixItem
833 -- We keep the OccName in the range so that we can generate an interface from it
834 data FixItem = FixItem OccName Fixity SrcSpan
836 instance Outputable FixItem where
837 ppr (FixItem occ fix loc) = ppr fix <+> ppr occ <+> parens (ppr loc)
839 emptyFixityEnv :: FixityEnv
840 emptyFixityEnv = emptyNameEnv
842 lookupFixity :: FixityEnv -> Name -> Fixity
843 lookupFixity env n = case lookupNameEnv env n of
844 Just (FixItem _ fix _) -> fix
845 Nothing -> defaultFixity
849 %************************************************************************
851 \subsection{WhatsImported}
853 %************************************************************************
856 type WhetherHasOrphans = Bool
858 -- * an instance decl in a module other than the defn module for
859 -- one of the tycons or classes in the instance head
860 -- * a transformation rule in a module other than the one defining
861 -- the function in the head of the rule.
863 type IsBootInterface = Bool
865 -- Dependency info about modules and packages below this one
866 -- in the import hierarchy. See TcRnTypes.ImportAvails for details.
868 -- Invariant: the dependencies of a module M never includes M
869 -- Invariant: the lists are unordered, with no duplicates
871 = Deps { dep_mods :: [(ModuleName,IsBootInterface)], -- Home-package module dependencies
872 dep_pkgs :: [PackageId], -- External package dependencies
873 dep_orphs :: [Module] } -- Orphan modules (whether home or external pkg)
875 -- Equality used only for old/new comparison in MkIface.addVersionInfo
877 noDependencies :: Dependencies
878 noDependencies = Deps [] [] []
881 = Usage { usg_name :: ModuleName, -- Name of the module
882 usg_mod :: Version, -- Module version
883 usg_entities :: [(OccName,Version)], -- Sorted by occurrence name
884 usg_exports :: Maybe Version, -- Export-list version, if we depend on it
885 usg_rules :: Version -- Orphan-rules version (for non-orphan
886 -- modules this will always be initialVersion)
888 -- This type doesn't let you say "I imported f but none of the rules in
889 -- the module". If you use anything in the module you get its rule version
890 -- So if the rules change, you'll recompile, even if you don't use them.
891 -- This is easy to implement, and it's safer: you might not have used the rules last
892 -- time round, but if someone has added a new rule you might need it this time
894 -- The export list field is (Just v) if we depend on the export list:
895 -- i.e. we imported the module directly, whether or not we
896 -- enumerated the things we imported, or just imported everything
897 -- We need to recompile if M's exports change, because
898 -- if the import was import M, we might now have a name clash in the
900 -- if the import was import M(x) M might no longer export x
901 -- The only way we don't depend on the export list is if we have
903 -- And of course, for modules that aren't imported directly we don't
904 -- depend on their export lists
908 %************************************************************************
910 The External Package State
912 %************************************************************************
915 type PackageTypeEnv = TypeEnv
916 type PackageRuleBase = RuleBase
917 type PackageInstEnv = InstEnv
919 data ExternalPackageState
921 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
922 -- In OneShot mode (only), home-package modules
923 -- accumulate in the external package state, and are
924 -- sucked in lazily. For these home-pkg modules
925 -- (only) we need to record which are boot modules.
926 -- We set this field after loading all the
927 -- explicitly-imported interfaces, but before doing
930 -- The ModuleName part is not necessary, but it's useful for
931 -- debug prints, and it's convenient because this field comes
932 -- direct from TcRnTypes.ImportAvails.imp_dep_mods
934 eps_PIT :: !PackageIfaceTable,
935 -- The ModuleIFaces for modules in external packages
936 -- whose interfaces we have opened
937 -- The declarations in these interface files are held in
938 -- eps_decls, eps_inst_env, eps_rules (below), not in the
939 -- mi_decls fields of the iPIT.
940 -- What _is_ in the iPIT is:
947 eps_PTE :: !PackageTypeEnv, -- Domain = external-package modules
949 eps_inst_env :: !PackageInstEnv, -- The total InstEnv accumulated from
950 -- all the external-package modules
951 eps_rule_base :: !PackageRuleBase, -- Ditto RuleEnv
953 eps_stats :: !EpsStats
956 -- "In" means read from iface files
957 -- "Out" means actually sucked in and type-checked
958 data EpsStats = EpsStats { n_ifaces_in
959 , n_decls_in, n_decls_out
960 , n_rules_in, n_rules_out
961 , n_insts_in, n_insts_out :: !Int }
963 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
964 -- Add stats for one newly-read interface
965 addEpsInStats stats n_decls n_insts n_rules
966 = stats { n_ifaces_in = n_ifaces_in stats + 1
967 , n_decls_in = n_decls_in stats + n_decls
968 , n_insts_in = n_insts_in stats + n_insts
969 , n_rules_in = n_rules_in stats + n_rules }
972 The NameCache makes sure that there is just one Unique assigned for
973 each original name; i.e. (module-name, occ-name) pair. The Name is
974 always stored as a Global, and has the SrcLoc of its binding location.
975 Actually that's not quite right. When we first encounter the original
976 name, we might not be at its binding site (e.g. we are reading an
977 interface file); so we give it 'noSrcLoc' then. Later, when we find
978 its binding site, we fix it up.
982 = NameCache { nsUniqs :: UniqSupply,
984 nsNames :: OrigNameCache,
985 -- Ensures that one original name gets one unique
986 nsIPs :: OrigIParamCache
987 -- Ensures that one implicit parameter name gets one unique
990 type OrigNameCache = ModuleEnv (OccEnv Name)
991 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
996 %************************************************************************
998 The module graph and ModSummary type
999 A ModSummary is a node in the compilation manager's
1000 dependency graph, and it's also passed to hscMain
1002 %************************************************************************
1004 A ModuleGraph contains all the nodes from the home package (only).
1005 There will be a node for each source module, plus a node for each hi-boot
1009 type ModuleGraph = [ModSummary] -- The module graph,
1010 -- NOT NECESSARILY IN TOPOLOGICAL ORDER
1012 emptyMG :: ModuleGraph
1015 -- The nodes of the module graph are
1016 -- EITHER a regular Haskell source module
1017 -- OR a hi-boot source module
1021 ms_mod :: Module, -- Identity of the module
1022 ms_hsc_src :: HscSource, -- Source is Haskell, hs-boot, external core
1023 ms_location :: ModLocation, -- Location
1024 ms_hs_date :: ClockTime, -- Timestamp of source file
1025 ms_obj_date :: Maybe ClockTime, -- Timestamp of object, maybe
1026 ms_srcimps :: [Located ModuleName], -- Source imports
1027 ms_imps :: [Located ModuleName], -- Non-source imports
1028 ms_hspp_file :: FilePath, -- Filename of preprocessed source.
1029 ms_hspp_opts :: DynFlags, -- Cached flags from OPTIONS, INCLUDE
1030 -- and LANGUAGE pragmas.
1031 ms_hspp_buf :: Maybe StringBuffer -- The actual preprocessed source, maybe.
1034 -- The ModLocation contains both the original source filename and the
1035 -- filename of the cleaned-up source file after all preprocessing has been
1036 -- done. The point is that the summariser will have to cpp/unlit/whatever
1037 -- all files anyway, and there's no point in doing this twice -- just
1038 -- park the result in a temp file, put the name of it in the location,
1039 -- and let @compile@ read from that file on the way back up.
1041 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1042 -- the ms_hs_date and imports can, of course, change
1044 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1045 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1046 msHiFilePath ms = ml_hi_file (ms_location ms)
1047 msObjFilePath ms = ml_obj_file (ms_location ms)
1049 isBootSummary :: ModSummary -> Bool
1050 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1052 instance Outputable ModSummary where
1054 = sep [text "ModSummary {",
1055 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1056 text "ms_mod =" <+> ppr (ms_mod ms)
1057 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1058 text "ms_imps =" <+> ppr (ms_imps ms),
1059 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1063 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1064 showModMsg target recomp mod_summary
1065 = showSDoc (hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1066 char '(', text (msHsFilePath mod_summary) <> comma,
1068 HscInterpreted | recomp
1069 -> text "interpreted"
1070 HscNothing -> text "nothing"
1071 _other -> text (msObjFilePath mod_summary),
1074 mod = moduleName (ms_mod mod_summary)
1075 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1079 %************************************************************************
1081 \subsection{Linkable stuff}
1083 %************************************************************************
1085 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1086 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1089 data Linkable = LM {
1090 linkableTime :: ClockTime, -- Time at which this linkable was built
1091 -- (i.e. when the bytecodes were produced,
1092 -- or the mod date on the files)
1093 linkableModule :: Module, -- Should be Module, but see below
1094 linkableUnlinked :: [Unlinked]
1097 isObjectLinkable :: Linkable -> Bool
1098 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1099 where unlinked = linkableUnlinked l
1100 -- A linkable with no Unlinked's is treated as a BCO. We can
1101 -- generate a linkable with no Unlinked's as a result of
1102 -- compiling a module in HscNothing mode, and this choice
1103 -- happens to work well with checkStability in module GHC.
1105 instance Outputable Linkable where
1106 ppr (LM when_made mod unlinkeds)
1107 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1108 $$ nest 3 (ppr unlinkeds)
1110 -------------------------------------------
1115 | BCOs CompiledByteCode
1118 data CompiledByteCode = NoByteCode
1121 instance Outputable Unlinked where
1122 ppr (DotO path) = text "DotO" <+> text path
1123 ppr (DotA path) = text "DotA" <+> text path
1124 ppr (DotDLL path) = text "DotDLL" <+> text path
1126 ppr (BCOs bcos) = text "BCOs" <+> ppr bcos
1128 ppr (BCOs bcos) = text "No byte code"
1131 isObject (DotO _) = True
1132 isObject (DotA _) = True
1133 isObject (DotDLL _) = True
1136 isInterpretable = not . isObject
1138 nameOfObject (DotO fn) = fn
1139 nameOfObject (DotA fn) = fn
1140 nameOfObject (DotDLL fn) = fn
1141 nameOfObject other = pprPanic "nameOfObject" (ppr other)
1143 byteCodeOfObject (BCOs bc) = bc
1144 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)