2 % (c) The University of Glasgow, 2006
4 \section[HscTypes]{Types for the per-module compiler}
8 -- * Sessions and compilation state
9 Session(..), withSession, modifySession,
11 FinderCache, FindResult(..), ModLocationCache,
12 Target(..), TargetId(..), pprTarget, pprTargetId,
15 ModDetails(..), emptyModDetails,
16 ModGuts(..), CgGuts(..), ModImports(..), ForeignStubs(..),
18 ModSummary(..), ms_mod_name, showModMsg, isBootSummary,
19 msHsFilePath, msHiFilePath, msObjFilePath,
21 HscSource(..), isHsBoot, hscSourceString, -- Re-exported from DriverPhases
23 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
24 hptInstances, hptRules,
26 ExternalPackageState(..), EpsStats(..), addEpsInStats,
27 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
28 lookupIfaceByModule, emptyModIface,
30 InteractiveContext(..), emptyInteractiveContext,
31 icPrintUnqual, mkPrintUnqualified, extendInteractiveContext,
33 ModIface(..), mkIfaceDepCache, mkIfaceVerCache, mkIfaceFixCache,
36 Deprecs(..), IfaceDeprecs,
38 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
40 implicitTyThings, isImplicitTyThing,
42 TyThing(..), tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
43 TypeEnv, lookupType, mkTypeEnv, emptyTypeEnv,
44 extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
45 typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
48 WhetherHasOrphans, IsBootInterface, Usage(..),
49 Dependencies(..), noDependencies,
50 NameCache(..), OrigNameCache, OrigIParamCache,
51 Avails, availsToNameSet, availsToNameEnv, availName, availNames,
52 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
55 Deprecations, DeprecTxt, plusDeprecs,
57 PackageInstEnv, PackageRuleBase,
60 Linkable(..), isObjectLinkable,
61 Unlinked(..), CompiledByteCode,
62 isObject, nameOfObject, isInterpretable, byteCodeOfObject,
63 HpcInfo(..), noHpcInfo,
66 ModBreaks (..), BreakIndex, emptyModBreaks
69 #include "HsVersions.h"
72 import ByteCodeAsm ( CompiledByteCode )
73 import {-# SOURCE #-} InteractiveEval ( Resume )
76 import RdrName ( GlobalRdrEnv, emptyGlobalRdrEnv, GlobalRdrElt(..),
77 unQualOK, ImpDeclSpec(..), Provenance(..),
78 ImportSpec(..), lookupGlobalRdrEnv )
79 import Name ( Name, NamedThing, getName, nameOccName, nameModule )
82 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
85 import InstEnv ( InstEnv, Instance )
86 import FamInstEnv ( FamInstEnv, FamInst )
87 import Rules ( RuleBase )
88 import CoreSyn ( CoreBind )
91 import Type ( TyThing(..) )
93 import Class ( Class, classSelIds, classATs, classTyCon )
95 import DataCon ( DataCon, dataConImplicitIds )
96 import PrelNames ( gHC_PRIM )
97 import Packages ( PackageId )
98 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..) )
99 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
100 import BasicTypes ( Version, initialVersion, IPName,
101 Fixity, defaultFixity, DeprecTxt )
103 import FiniteMap ( FiniteMap )
104 import CoreSyn ( CoreRule )
105 import Maybes ( orElse, expectJust, catMaybes, seqMaybe )
108 import SrcLoc ( SrcSpan, Located )
109 import UniqFM ( lookupUFM, eltsUFM, emptyUFM )
110 import UniqSupply ( UniqSupply )
111 import FastString ( FastString )
113 import StringBuffer ( StringBuffer )
115 import System.Time ( ClockTime )
117 import Data.Array ( Array, array )
121 %************************************************************************
123 \subsection{Compilation environment}
125 %************************************************************************
129 -- | The Session is a handle to the complete state of a compilation
130 -- session. A compilation session consists of a set of modules
131 -- constituting the current program or library, the context for
132 -- interactive evaluation, and various caches.
133 newtype Session = Session (IORef HscEnv)
135 withSession :: Session -> (HscEnv -> IO a) -> IO a
136 withSession (Session ref) f = do h <- readIORef ref; f h
138 modifySession :: Session -> (HscEnv -> HscEnv) -> IO ()
139 modifySession (Session ref) f = do h <- readIORef ref; writeIORef ref $! f h
142 HscEnv is like Session, except that some of the fields are immutable.
143 An HscEnv is used to compile a single module from plain Haskell source
144 code (after preprocessing) to either C, assembly or C--. Things like
145 the module graph don't change during a single compilation.
147 Historical note: "hsc" used to be the name of the compiler binary,
148 when there was a separate driver and compiler. To compile a single
149 module, the driver would invoke hsc on the source code... so nowadays
150 we think of hsc as the layer of the compiler that deals with compiling
156 hsc_dflags :: DynFlags,
157 -- The dynamic flag settings
159 hsc_targets :: [Target],
160 -- The targets (or roots) of the current session
162 hsc_mod_graph :: ModuleGraph,
163 -- The module graph of the current session
165 hsc_IC :: InteractiveContext,
166 -- The context for evaluating interactive statements
168 hsc_HPT :: HomePackageTable,
169 -- The home package table describes already-compiled
170 -- home-packge modules, *excluding* the module we
171 -- are compiling right now.
172 -- (In one-shot mode the current module is the only
173 -- home-package module, so hsc_HPT is empty. All other
174 -- modules count as "external-package" modules.
175 -- However, even in GHCi mode, hi-boot interfaces are
176 -- demand-loadeded into the external-package table.)
178 -- hsc_HPT is not mutable because we only demand-load
179 -- external packages; the home package is eagerly
180 -- loaded, module by module, by the compilation manager.
182 -- The HPT may contain modules compiled earlier by --make
183 -- but not actually below the current module in the dependency
184 -- graph. (This changes a previous invariant: changed Jan 05.)
186 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
187 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
188 -- These are side-effected by compiling to reflect
189 -- sucking in interface files. They cache the state of
190 -- external interface files, in effect.
192 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
193 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
194 -- The finder's cache. This caches the location of modules,
195 -- so we don't have to search the filesystem multiple times.
197 hsc_global_rdr_env :: GlobalRdrEnv,
198 hsc_global_type_env :: TypeEnv
201 hscEPS :: HscEnv -> IO ExternalPackageState
202 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
204 -- | A compilation target.
206 -- A target may be supplied with the actual text of the
207 -- module. If so, use this instead of the file contents (this
208 -- is for use in an IDE where the file hasn't been saved by
210 data Target = Target TargetId (Maybe (StringBuffer,ClockTime))
213 = TargetModule ModuleName
214 -- ^ A module name: search for the file
215 | TargetFile FilePath (Maybe Phase)
216 -- ^ A filename: preprocess & parse it to find the module name.
217 -- If specified, the Phase indicates how to compile this file
218 -- (which phase to start from). Nothing indicates the starting phase
219 -- should be determined from the suffix of the filename.
222 pprTarget :: Target -> SDoc
223 pprTarget (Target id _) = pprTargetId id
225 instance Outputable Target where
228 pprTargetId (TargetModule m) = ppr m
229 pprTargetId (TargetFile f _) = text f
231 instance Outputable TargetId where
234 type HomePackageTable = ModuleNameEnv HomeModInfo
235 -- Domain = modules in the home package
236 -- "home" package name cached here for convenience
237 type PackageIfaceTable = ModuleEnv ModIface
238 -- Domain = modules in the imported packages
240 emptyHomePackageTable = emptyUFM
241 emptyPackageIfaceTable = emptyModuleEnv
244 = HomeModInfo { hm_iface :: !ModIface,
245 hm_details :: !ModDetails,
246 hm_linkable :: !(Maybe Linkable) }
247 -- hm_linkable might be Nothing if:
248 -- a) this is an .hs-boot module
249 -- b) temporarily during compilation if we pruned away
250 -- the old linkable because it was out of date.
251 -- after a complete compilation (GHC.load), all hm_linkable
252 -- fields in the HPT will be Just.
254 -- When re-linking a module (hscNoRecomp), we construct
255 -- the HomModInfo by building a new ModDetails from the
256 -- old ModIface (only).
258 -- | Find the 'ModIface' for a 'Module'
265 lookupIfaceByModule dflags hpt pit mod
266 | modulePackageId mod == thisPackage dflags
267 = -- The module comes from the home package, so look first
268 -- in the HPT. If it's not from the home package it's wrong to look
269 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
270 fmap hm_iface (lookupUFM hpt (moduleName mod))
271 `seqMaybe` lookupModuleEnv pit mod
273 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
275 -- If the module does come from the home package, why do we look in the PIT as well?
276 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
277 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
278 -- module is in the PIT, namely GHC.Prim when compiling the base package.
279 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a packake
280 -- of its own, but it doesn't seem worth the bother.
285 hptInstances :: HscEnv -> (ModuleName -> Bool) -> [Instance]
286 -- Find all the instance declarations that are in modules imported
287 -- by this one, directly or indirectly, and are in the Home Package Table
288 -- This ensures that we don't see instances from modules --make compiled
289 -- before this one, but which are not below this one
290 hptInstances hsc_env want_this_module
292 | mod_info <- eltsUFM (hsc_HPT hsc_env)
293 , want_this_module (moduleName (mi_module (hm_iface mod_info)))
294 , ispec <- md_insts (hm_details mod_info) ]
296 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
297 -- Get rules from modules "below" this one (in the dependency sense)
298 -- C.f Inst.hptInstances
299 hptRules hsc_env deps
300 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
303 hpt = hsc_HPT hsc_env
306 | -- Find each non-hi-boot module below me
309 -- unsavoury: when compiling the base package with --make, we
310 -- sometimes try to look up RULES for GHC.Prim. GHC.Prim won't
311 -- be in the HPT, because we never compile it; it's in the EPT
312 -- instead. ToDo: clean up, and remove this slightly bogus
314 , mod /= moduleName gHC_PRIM
316 -- Look it up in the HPT
317 , let rules = case lookupUFM hpt mod of
318 Just info -> md_rules (hm_details info)
319 Nothing -> pprTrace "WARNING in hptRules" msg []
320 msg = vcat [ptext SLIT("missing module") <+> ppr mod,
321 ptext SLIT("Probable cause: out-of-date interface files")]
322 -- This really shouldn't happen, but see Trac #962
328 %************************************************************************
330 \subsection{The Finder cache}
332 %************************************************************************
335 -- | The 'FinderCache' maps home module names to the result of
336 -- searching for that module. It records the results of searching for
337 -- modules along the search path. On @:load@, we flush the entire
338 -- contents of this cache.
340 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
341 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
343 type FinderCache = ModuleNameEnv FindResult
345 -- | The result of searching for an imported module.
347 = Found ModLocation Module
348 -- the module was found
349 | NoPackage PackageId
350 -- the requested package was not found
351 | FoundMultiple [PackageId]
352 -- *error*: both in multiple packages
353 | PackageHidden PackageId
354 -- for an explicit source import: the package containing the module is
356 | ModuleHidden PackageId
357 -- for an explicit source import: the package containing the module is
358 -- exposed, but the module itself is hidden.
359 | NotFound [FilePath] (Maybe PackageId)
360 -- the module was not found, the specified places were searched
361 | NotFoundInPackage PackageId
362 -- the module was not found in this package
364 -- | Cache that remembers where we found a particular module. Contains both
365 -- home modules and package modules. On @:load@, only home modules are
366 -- purged from this cache.
367 type ModLocationCache = ModuleEnv ModLocation
370 %************************************************************************
372 \subsection{Symbol tables and Module details}
374 %************************************************************************
376 A @ModIface@ plus a @ModDetails@ summarises everything we know
377 about a compiled module. The @ModIface@ is the stuff *before* linking,
378 and can be written out to an interface file. (The @ModDetails@ is after
379 linking; it is the "linked" form of the mi_decls field.)
381 When we *read* an interface file, we also construct a @ModIface@ from it,
382 except that the mi_decls part is empty; when reading we consolidate
383 the declarations into a single indexed map in the @PersistentRenamerState@.
388 mi_module :: !Module,
389 mi_mod_vers :: !Version, -- Module version: changes when anything changes
391 mi_orphan :: !WhetherHasOrphans, -- Whether this module has orphans
392 mi_finsts :: !WhetherHasFamInst, -- Whether module has family insts
393 mi_boot :: !IsBootInterface, -- Read from an hi-boot file?
395 mi_deps :: Dependencies,
396 -- This is consulted for directly-imported modules,
397 -- but not for anything else (hence lazy)
399 -- Usages; kept sorted so that it's easy to decide
400 -- whether to write a new iface file (changing usages
401 -- doesn't affect the version of this module)
402 mi_usages :: [Usage],
403 -- NOT STRICT! we read this field lazily from the interface file
404 -- It is *only* consulted by the recompilation checker
407 -- Kept sorted by (mod,occ), to make version comparisons easier
408 mi_exports :: ![IfaceExport],
409 mi_exp_vers :: !Version, -- Version number of export list
412 mi_fixities :: [(OccName,Fixity)],
413 -- NOT STRICT! we read this field lazily from the interface file
416 mi_deprecs :: IfaceDeprecs,
417 -- NOT STRICT! we read this field lazily from the interface file
419 -- Type, class and variable declarations
420 -- The version of an Id changes if its fixity or deprecations change
421 -- (as well as its type of course)
422 -- Ditto data constructors, class operations, except that
423 -- the version of the parent class/tycon changes
424 mi_decls :: [(Version,IfaceDecl)], -- Sorted
426 mi_globals :: !(Maybe GlobalRdrEnv),
427 -- Binds all the things defined at the top level in
428 -- the *original source* code for this module. which
429 -- is NOT the same as mi_exports, nor mi_decls (which
430 -- may contains declarations for things not actually
431 -- defined by the user). Used for GHCi and for inspecting
432 -- the contents of modules via the GHC API only.
434 -- (We need the source file to figure out the
435 -- top-level environment, if we didn't compile this module
436 -- from source then this field contains Nothing).
438 -- Strictly speaking this field should live in the
439 -- HomeModInfo, but that leads to more plumbing.
441 -- Instance declarations and rules
442 mi_insts :: [IfaceInst], -- Sorted
443 mi_fam_insts :: [IfaceFamInst], -- Sorted
444 mi_rules :: [IfaceRule], -- Sorted
445 mi_rule_vers :: !Version, -- Version number for rules and
446 -- instances (for classes and families)
449 -- Cached environments for easy lookup
450 -- These are computed (lazily) from other fields
451 -- and are not put into the interface file
452 mi_dep_fn :: Name -> Maybe DeprecTxt, -- Cached lookup for mi_deprecs
453 mi_fix_fn :: OccName -> Fixity, -- Cached lookup for mi_fixities
454 mi_ver_fn :: OccName -> Maybe (OccName, Version)
455 -- Cached lookup for mi_decls
456 -- The Nothing in mi_ver_fn means that the thing
457 -- isn't in decls. It's useful to know that when
458 -- seeing if we are up to date wrt the old interface
459 -- The 'OccName' is the parent of the name, if it has one.
462 -- Should be able to construct ModDetails from mi_decls in ModIface
465 -- The next two fields are created by the typechecker
466 md_exports :: [AvailInfo],
467 md_types :: !TypeEnv,
468 md_insts :: ![Instance], -- Dfun-ids for the instances in this module
469 md_fam_insts :: ![FamInst],
470 md_rules :: ![CoreRule], -- Domain may include Ids from other modules
471 md_modBreaks :: !ModBreaks -- breakpoint information for this module
474 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
479 md_modBreaks = emptyModBreaks }
481 -- A ModGuts is carried through the compiler, accumulating stuff as it goes
482 -- There is only one ModGuts at any time, the one for the module
483 -- being compiled right now. Once it is compiled, a ModIface and
484 -- ModDetails are extracted and the ModGuts is dicarded.
488 mg_module :: !Module,
489 mg_boot :: IsBootInterface, -- Whether it's an hs-boot module
490 mg_exports :: ![AvailInfo], -- What it exports
491 mg_deps :: !Dependencies, -- What is below it, directly or
493 mg_dir_imps :: ![Module], -- Directly-imported modules; used to
494 -- generate initialisation code
495 mg_usages :: ![Usage], -- Version info for what it needed
497 mg_rdr_env :: !GlobalRdrEnv, -- Top-level lexical environment
498 mg_fix_env :: !FixityEnv, -- Fixity env, for things declared in
501 mg_fam_inst_env :: FamInstEnv, -- Type-family instance enviroment
502 -- for *home-package* modules (including
503 -- this one). c.f. tcg_fam_inst_env
505 mg_types :: !TypeEnv,
506 mg_insts :: ![Instance], -- Instances
507 mg_fam_insts :: ![FamInst], -- Instances
508 mg_rules :: ![CoreRule], -- Rules from this module
509 mg_binds :: ![CoreBind], -- Bindings for this module
510 mg_foreign :: !ForeignStubs,
511 mg_deprecs :: !Deprecations, -- Deprecations declared in the module
512 mg_hpc_info :: !HpcInfo, -- info about coverage tick boxes
513 mg_modBreaks :: !ModBreaks
516 -- The ModGuts takes on several slightly different forms:
518 -- After simplification, the following fields change slightly:
519 -- mg_rules Orphan rules only (local ones now attached to binds)
520 -- mg_binds With rules attached
523 ---------------------------------------------------------
524 -- The Tidy pass forks the information about this module:
525 -- * one lot goes to interface file generation (ModIface)
526 -- and later compilations (ModDetails)
527 -- * the other lot goes to code generation (CgGuts)
530 cg_module :: !Module,
532 cg_tycons :: [TyCon],
533 -- Algebraic data types (including ones that started
534 -- life as classes); generate constructors and info
535 -- tables Includes newtypes, just for the benefit of
538 cg_binds :: [CoreBind],
539 -- The tidied main bindings, including
540 -- previously-implicit bindings for record and class
541 -- selectors, and data construtor wrappers. But *not*
542 -- data constructor workers; reason: we we regard them
543 -- as part of the code-gen of tycons
545 cg_dir_imps :: ![Module],
546 -- Directly-imported modules; used to generate
547 -- initialisation code
549 cg_foreign :: !ForeignStubs,
550 cg_dep_pkgs :: ![PackageId], -- Used to generate #includes for C code gen
551 cg_hpc_info :: !HpcInfo -- info about coverage tick boxes
554 -----------------------------------
557 imp_direct :: ![(Module,Bool)], -- Explicitly-imported modules
558 -- Boolean is true if we imported the whole
559 -- module (apart, perhaps, from hiding some)
560 imp_pkg_mods :: !ModuleSet, -- Non-home-package modules on which we depend,
561 -- directly or indirectly
562 imp_home_names :: !NameSet -- Home package things on which we depend,
563 -- directly or indirectly
566 -----------------------------------
567 data ForeignStubs = NoStubs
569 SDoc -- Header file prototypes for
570 -- "foreign exported" functions
571 SDoc -- C stubs to use when calling
572 -- "foreign exported" functions
573 [FastString] -- Headers that need to be included
574 -- into C code generated for this module
575 [Id] -- Foreign-exported binders
576 -- we have to generate code to register these
581 emptyModIface :: Module -> ModIface
583 = ModIface { mi_module = mod,
584 mi_mod_vers = initialVersion,
588 mi_deps = noDependencies,
591 mi_exp_vers = initialVersion,
593 mi_deprecs = NoDeprecs,
598 mi_globals = Nothing,
599 mi_rule_vers = initialVersion,
600 mi_dep_fn = emptyIfaceDepCache,
601 mi_fix_fn = emptyIfaceFixCache,
602 mi_ver_fn = emptyIfaceVerCache
607 %************************************************************************
609 \subsection{The interactive context}
611 %************************************************************************
614 data InteractiveContext
615 = InteractiveContext {
616 ic_toplev_scope :: [Module], -- Include the "top-level" scope of
619 ic_exports :: [Module], -- Include just the exports of these
622 ic_rn_gbl_env :: GlobalRdrEnv, -- The cached GlobalRdrEnv, built from
623 -- ic_toplev_scope and ic_exports
625 ic_tmp_ids :: [Id], -- Names bound during interaction.
626 -- Earlier Ids shadow
627 -- later ones with the same OccName.
629 ic_tyvars :: TyVarSet -- skolem type variables free in
630 -- ic_tmp_ids. These arise at
631 -- breakpoints in a polymorphic
632 -- context, where we have only partial
636 , ic_resume :: [Resume] -- the stack of breakpoint contexts
641 emptyInteractiveContext
642 = InteractiveContext { ic_toplev_scope = [],
644 ic_rn_gbl_env = emptyGlobalRdrEnv,
646 ic_tyvars = emptyVarSet
652 icPrintUnqual :: InteractiveContext -> PrintUnqualified
653 icPrintUnqual ictxt = mkPrintUnqualified (ic_rn_gbl_env ictxt)
656 extendInteractiveContext
657 :: InteractiveContext
660 -> InteractiveContext
661 extendInteractiveContext ictxt ids tyvars
662 = ictxt { ic_tmp_ids = ids ++ ic_tmp_ids ictxt,
663 ic_tyvars = ic_tyvars ictxt `unionVarSet` tyvars }
666 %************************************************************************
668 Building a PrintUnqualified
670 %************************************************************************
673 mkPrintUnqualified :: GlobalRdrEnv -> PrintUnqualified
674 mkPrintUnqualified env = (qual_name, qual_mod)
677 | null gres = Just (moduleName mod)
678 -- it isn't in scope at all, this probably shouldn't happen,
679 -- but we'll qualify it by the original module anyway.
680 | any unQualOK gres = Nothing
681 | (Imported is : _) <- map gre_prov gres, (idecl : _) <- is
682 = Just (is_as (is_decl idecl))
683 | otherwise = panic "mkPrintUnqualified"
685 gres = [ gre | gre <- lookupGlobalRdrEnv env occ,
686 nameModule (gre_name gre) == mod ]
688 qual_mod mod = Nothing -- For now...
692 %************************************************************************
696 %************************************************************************
699 implicitTyThings :: TyThing -> [TyThing]
700 -- If you change this, make sure you change LoadIface.ifaceDeclSubBndrs in sync
702 implicitTyThings (AnId id) = []
704 -- For type constructors, add the data cons (and their extras),
705 -- and the selectors and generic-programming Ids too
707 -- Newtypes don't have a worker Id, so don't generate that?
708 implicitTyThings (ATyCon tc) = implicitCoTyCon tc ++
709 map AnId (tyConSelIds tc) ++
710 concatMap (extras_plus . ADataCon)
713 -- For classes, add the class selector Ids, and assoicated TyCons
714 -- and the class TyCon too (and its extras)
715 implicitTyThings (AClass cl)
716 = map AnId (classSelIds cl) ++
717 map ATyCon (classATs cl) ++
718 -- No extras_plus for the classATs, because they
719 -- are only the family decls; they have no implicit things
720 extras_plus (ATyCon (classTyCon cl))
722 -- For data cons add the worker and wrapper (if any)
723 implicitTyThings (ADataCon dc) = map AnId (dataConImplicitIds dc)
725 -- | returns 'True' if there should be no interface-file declaration
726 -- for this thing on its own: either it is built-in, or it is part
727 -- of some other declaration, or it is generated implicitly by some
728 -- other declaration.
729 isImplicitTyThing :: TyThing -> Bool
730 isImplicitTyThing (ADataCon _) = True
731 isImplicitTyThing (AnId id) = isImplicitId id
732 isImplicitTyThing (AClass _) = False
733 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
735 -- For newtypes and indexed data types, add the implicit coercion tycon
737 = map ATyCon . catMaybes $ [newTyConCo_maybe tc,
738 tyConFamilyCoercion_maybe tc]
740 extras_plus thing = thing : implicitTyThings thing
742 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
743 extendTypeEnvWithIds env ids
744 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
747 %************************************************************************
751 %************************************************************************
754 type TypeEnv = NameEnv TyThing
756 emptyTypeEnv :: TypeEnv
757 typeEnvElts :: TypeEnv -> [TyThing]
758 typeEnvClasses :: TypeEnv -> [Class]
759 typeEnvTyCons :: TypeEnv -> [TyCon]
760 typeEnvIds :: TypeEnv -> [Id]
761 typeEnvDataCons :: TypeEnv -> [DataCon]
762 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
764 emptyTypeEnv = emptyNameEnv
765 typeEnvElts env = nameEnvElts env
766 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
767 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
768 typeEnvIds env = [id | AnId id <- typeEnvElts env]
769 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
771 mkTypeEnv :: [TyThing] -> TypeEnv
772 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
774 lookupTypeEnv = lookupNameEnv
776 -- Extend the type environment
777 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
778 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
780 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
781 extendTypeEnvList env things = foldl extendTypeEnv env things
785 lookupType :: DynFlags
791 lookupType dflags hpt pte name
792 -- in one-shot, we don't use the HPT
793 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
794 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
795 lookupNameEnv (md_types (hm_details hm)) name
797 = lookupNameEnv pte name
798 where mod = nameModule name
799 this_pkg = thisPackage dflags
803 tyThingTyCon (ATyCon tc) = tc
804 tyThingTyCon other = pprPanic "tyThingTyCon" (ppr other)
806 tyThingClass (AClass cls) = cls
807 tyThingClass other = pprPanic "tyThingClass" (ppr other)
809 tyThingDataCon (ADataCon dc) = dc
810 tyThingDataCon other = pprPanic "tyThingDataCon" (ppr other)
812 tyThingId (AnId id) = id
813 tyThingId other = pprPanic "tyThingId" (ppr other)
816 %************************************************************************
818 \subsection{Auxiliary types}
820 %************************************************************************
822 These types are defined here because they are mentioned in ModDetails,
823 but they are mostly elaborated elsewhere
826 mkIfaceVerCache :: [(Version,IfaceDecl)]
827 -> (OccName -> Maybe (OccName, Version))
828 mkIfaceVerCache pairs
829 = \occ -> lookupOccEnv env occ
831 env = foldr add_decl emptyOccEnv pairs
832 add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
835 env1 = extendOccEnv env0 decl_name (decl_name, v)
836 add_imp bndr env = extendOccEnv env bndr (decl_name, v)
838 emptyIfaceVerCache :: OccName -> Maybe (OccName, Version)
839 emptyIfaceVerCache occ = Nothing
841 ------------------ Deprecations -------------------------
844 | DeprecAll DeprecTxt -- Whole module deprecated
845 | DeprecSome a -- Some specific things deprecated
848 type IfaceDeprecs = Deprecs [(OccName,DeprecTxt)]
849 type Deprecations = Deprecs (NameEnv (OccName,DeprecTxt))
850 -- Keep the OccName so we can flatten the NameEnv to
851 -- get an IfaceDeprecs from a Deprecations
852 -- Only an OccName is needed, because a deprecation always
853 -- applies to things defined in the module in which the
854 -- deprecation appears.
856 mkIfaceDepCache:: IfaceDeprecs -> Name -> Maybe DeprecTxt
857 mkIfaceDepCache NoDeprecs = \n -> Nothing
858 mkIfaceDepCache (DeprecAll t) = \n -> Just t
859 mkIfaceDepCache (DeprecSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
861 emptyIfaceDepCache :: Name -> Maybe DeprecTxt
862 emptyIfaceDepCache n = Nothing
864 plusDeprecs :: Deprecations -> Deprecations -> Deprecations
865 plusDeprecs d NoDeprecs = d
866 plusDeprecs NoDeprecs d = d
867 plusDeprecs d (DeprecAll t) = DeprecAll t
868 plusDeprecs (DeprecAll t) d = DeprecAll t
869 plusDeprecs (DeprecSome v1) (DeprecSome v2) = DeprecSome (v1 `plusNameEnv` v2)
874 type Avails = [AvailInfo]
875 type AvailInfo = GenAvailInfo Name
876 type RdrAvailInfo = GenAvailInfo OccName
878 data GenAvailInfo name = Avail name -- An ordinary identifier
879 | AvailTC name -- The name of the type or class
880 [name] -- The available pieces of type/class.
881 -- NB: If the type or class is itself
882 -- to be in scope, it must be in this list.
883 -- Thus, typically: AvailTC Eq [Eq, ==, /=]
885 -- Equality used when deciding if the interface has changed
887 type IfaceExport = (Module, [GenAvailInfo OccName])
889 availsToNameSet :: [AvailInfo] -> NameSet
890 availsToNameSet avails = foldr add emptyNameSet avails
891 where add avail set = addListToNameSet set (availNames avail)
893 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
894 availsToNameEnv avails = foldr add emptyNameEnv avails
895 where add avail env = extendNameEnvList env
896 (zip (availNames avail) (repeat avail))
898 availName :: GenAvailInfo name -> name
899 availName (Avail n) = n
900 availName (AvailTC n _) = n
902 availNames :: GenAvailInfo name -> [name]
903 availNames (Avail n) = [n]
904 availNames (AvailTC n ns) = ns
906 instance Outputable n => Outputable (GenAvailInfo n) where
909 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
910 pprAvail (Avail n) = ppr n
911 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
915 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
916 mkIfaceFixCache pairs
917 = \n -> lookupOccEnv env n `orElse` defaultFixity
921 emptyIfaceFixCache :: OccName -> Fixity
922 emptyIfaceFixCache n = defaultFixity
924 -- This fixity environment is for source code only
925 type FixityEnv = NameEnv FixItem
927 -- We keep the OccName in the range so that we can generate an interface from it
928 data FixItem = FixItem OccName Fixity SrcSpan
930 instance Outputable FixItem where
931 ppr (FixItem occ fix loc) = ppr fix <+> ppr occ <+> parens (ppr loc)
933 emptyFixityEnv :: FixityEnv
934 emptyFixityEnv = emptyNameEnv
936 lookupFixity :: FixityEnv -> Name -> Fixity
937 lookupFixity env n = case lookupNameEnv env n of
938 Just (FixItem _ fix _) -> fix
939 Nothing -> defaultFixity
943 %************************************************************************
945 \subsection{WhatsImported}
947 %************************************************************************
950 type WhetherHasOrphans = Bool
952 -- * an instance decl in a module other than the defn module for
953 -- one of the tycons or classes in the instance head
954 -- * a transformation rule in a module other than the one defining
955 -- the function in the head of the rule.
957 type WhetherHasFamInst = Bool -- This module defines family instances?
959 type IsBootInterface = Bool
961 -- Dependency info about modules and packages below this one
962 -- in the import hierarchy. See TcRnTypes.ImportAvails for details.
963 -- The orphan modules in `dep_orphs' do *not* include family instance orphans,
964 -- as they are anyway included in `dep_finsts'.
966 -- Invariant: the dependencies of a module M never includes M
967 -- Invariant: the lists are unordered, with no duplicates
969 = Deps { dep_mods :: [(ModuleName, -- Home-package module dependencies
971 , dep_pkgs :: [PackageId] -- External package dependencies
972 , dep_orphs :: [Module] -- Orphan modules (whether home or
974 , dep_finsts :: [Module] -- Modules that contain family
975 -- instances (whether home or
979 -- Equality used only for old/new comparison in MkIface.addVersionInfo
981 noDependencies :: Dependencies
982 noDependencies = Deps [] [] [] []
985 = Usage { usg_name :: ModuleName, -- Name of the module
986 usg_mod :: Version, -- Module version
987 usg_entities :: [(OccName,Version)], -- Sorted by occurrence name
988 -- NB. usages are for parent names only, eg. tycon but not constructors.
989 usg_exports :: Maybe Version, -- Export-list version, if we depend on it
990 usg_rules :: Version -- Orphan-rules version (for non-orphan
991 -- modules this will always be initialVersion)
993 -- This type doesn't let you say "I imported f but none of the rules in
994 -- the module". If you use anything in the module you get its rule version
995 -- So if the rules change, you'll recompile, even if you don't use them.
996 -- This is easy to implement, and it's safer: you might not have used the rules last
997 -- time round, but if someone has added a new rule you might need it this time
999 -- The export list field is (Just v) if we depend on the export list:
1000 -- i.e. we imported the module directly, whether or not we
1001 -- enumerated the things we imported, or just imported everything
1002 -- We need to recompile if M's exports change, because
1003 -- if the import was import M, we might now have a name clash in the
1004 -- importing module.
1005 -- if the import was import M(x) M might no longer export x
1006 -- The only way we don't depend on the export list is if we have
1008 -- And of course, for modules that aren't imported directly we don't
1009 -- depend on their export lists
1013 %************************************************************************
1015 The External Package State
1017 %************************************************************************
1020 type PackageTypeEnv = TypeEnv
1021 type PackageRuleBase = RuleBase
1022 type PackageInstEnv = InstEnv
1023 type PackageFamInstEnv = FamInstEnv
1025 data ExternalPackageState
1027 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1028 -- In OneShot mode (only), home-package modules
1029 -- accumulate in the external package state, and are
1030 -- sucked in lazily. For these home-pkg modules
1031 -- (only) we need to record which are boot modules.
1032 -- We set this field after loading all the
1033 -- explicitly-imported interfaces, but before doing
1036 -- The ModuleName part is not necessary, but it's useful for
1037 -- debug prints, and it's convenient because this field comes
1038 -- direct from TcRnTypes.ImportAvails.imp_dep_mods
1040 eps_PIT :: !PackageIfaceTable,
1041 -- The ModuleIFaces for modules in external packages
1042 -- whose interfaces we have opened
1043 -- The declarations in these interface files are held in
1044 -- eps_decls, eps_inst_env, eps_fam_inst_env, eps_rules
1045 -- (below), not in the mi_decls fields of the iPIT.
1046 -- What _is_ in the iPIT is:
1053 eps_PTE :: !PackageTypeEnv, -- Domain = external-package modules
1055 eps_inst_env :: !PackageInstEnv, -- The total InstEnv accumulated
1056 -- from all the external-package
1058 eps_fam_inst_env :: !PackageFamInstEnv,-- Ditto FamInstEnv
1059 eps_rule_base :: !PackageRuleBase, -- Ditto RuleEnv
1061 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- identifies family
1062 -- instances of each mod
1064 eps_stats :: !EpsStats
1067 -- "In" means read from iface files
1068 -- "Out" means actually sucked in and type-checked
1069 data EpsStats = EpsStats { n_ifaces_in
1070 , n_decls_in, n_decls_out
1071 , n_rules_in, n_rules_out
1072 , n_insts_in, n_insts_out :: !Int }
1074 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1075 -- Add stats for one newly-read interface
1076 addEpsInStats stats n_decls n_insts n_rules
1077 = stats { n_ifaces_in = n_ifaces_in stats + 1
1078 , n_decls_in = n_decls_in stats + n_decls
1079 , n_insts_in = n_insts_in stats + n_insts
1080 , n_rules_in = n_rules_in stats + n_rules }
1083 The NameCache makes sure that there is just one Unique assigned for
1084 each original name; i.e. (module-name, occ-name) pair. The Name is
1085 always stored as a Global, and has the SrcLoc of its binding location.
1086 Actually that's not quite right. When we first encounter the original
1087 name, we might not be at its binding site (e.g. we are reading an
1088 interface file); so we give it 'noSrcLoc' then. Later, when we find
1089 its binding site, we fix it up.
1093 = NameCache { nsUniqs :: UniqSupply,
1094 -- Supply of uniques
1095 nsNames :: OrigNameCache,
1096 -- Ensures that one original name gets one unique
1097 nsIPs :: OrigIParamCache
1098 -- Ensures that one implicit parameter name gets one unique
1101 type OrigNameCache = ModuleEnv (OccEnv Name)
1102 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1107 %************************************************************************
1109 The module graph and ModSummary type
1110 A ModSummary is a node in the compilation manager's
1111 dependency graph, and it's also passed to hscMain
1113 %************************************************************************
1115 A ModuleGraph contains all the nodes from the home package (only).
1116 There will be a node for each source module, plus a node for each hi-boot
1120 type ModuleGraph = [ModSummary] -- The module graph,
1121 -- NOT NECESSARILY IN TOPOLOGICAL ORDER
1123 emptyMG :: ModuleGraph
1126 -- The nodes of the module graph are
1127 -- EITHER a regular Haskell source module
1128 -- OR a hi-boot source module
1132 ms_mod :: Module, -- Identity of the module
1133 ms_hsc_src :: HscSource, -- Source is Haskell, hs-boot, external core
1134 ms_location :: ModLocation, -- Location
1135 ms_hs_date :: ClockTime, -- Timestamp of source file
1136 ms_obj_date :: Maybe ClockTime, -- Timestamp of object, maybe
1137 ms_srcimps :: [Located ModuleName], -- Source imports
1138 ms_imps :: [Located ModuleName], -- Non-source imports
1139 ms_hspp_file :: FilePath, -- Filename of preprocessed source.
1140 ms_hspp_opts :: DynFlags, -- Cached flags from OPTIONS, INCLUDE
1141 -- and LANGUAGE pragmas.
1142 ms_hspp_buf :: Maybe StringBuffer -- The actual preprocessed source, maybe.
1145 ms_mod_name :: ModSummary -> ModuleName
1146 ms_mod_name = moduleName . ms_mod
1148 -- The ModLocation contains both the original source filename and the
1149 -- filename of the cleaned-up source file after all preprocessing has been
1150 -- done. The point is that the summariser will have to cpp/unlit/whatever
1151 -- all files anyway, and there's no point in doing this twice -- just
1152 -- park the result in a temp file, put the name of it in the location,
1153 -- and let @compile@ read from that file on the way back up.
1155 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1156 -- the ms_hs_date and imports can, of course, change
1158 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1159 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1160 msHiFilePath ms = ml_hi_file (ms_location ms)
1161 msObjFilePath ms = ml_obj_file (ms_location ms)
1163 isBootSummary :: ModSummary -> Bool
1164 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1166 instance Outputable ModSummary where
1168 = sep [text "ModSummary {",
1169 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1170 text "ms_mod =" <+> ppr (ms_mod ms)
1171 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1172 text "ms_imps =" <+> ppr (ms_imps ms),
1173 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1177 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1178 showModMsg target recomp mod_summary
1179 = showSDoc (hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1180 char '(', text (msHsFilePath mod_summary) <> comma,
1182 HscInterpreted | recomp
1183 -> text "interpreted"
1184 HscNothing -> text "nothing"
1185 _other -> text (msObjFilePath mod_summary),
1188 mod = moduleName (ms_mod mod_summary)
1189 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1193 %************************************************************************
1195 \subsection{Hpc Support}
1197 %************************************************************************
1200 data HpcInfo = HpcInfo
1201 { hpcInfoTickCount :: Int
1202 , hpcInfoHash :: Int
1206 noHpcInfo :: HpcInfo
1207 noHpcInfo = NoHpcInfo
1210 %************************************************************************
1212 \subsection{Linkable stuff}
1214 %************************************************************************
1216 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1217 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1220 data Linkable = LM {
1221 linkableTime :: ClockTime, -- Time at which this linkable was built
1222 -- (i.e. when the bytecodes were produced,
1223 -- or the mod date on the files)
1224 linkableModule :: Module, -- Should be Module, but see below
1225 linkableUnlinked :: [Unlinked]
1228 isObjectLinkable :: Linkable -> Bool
1229 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1230 where unlinked = linkableUnlinked l
1231 -- A linkable with no Unlinked's is treated as a BCO. We can
1232 -- generate a linkable with no Unlinked's as a result of
1233 -- compiling a module in HscNothing mode, and this choice
1234 -- happens to work well with checkStability in module GHC.
1236 instance Outputable Linkable where
1237 ppr (LM when_made mod unlinkeds)
1238 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1239 $$ nest 3 (ppr unlinkeds)
1241 -------------------------------------------
1246 | BCOs CompiledByteCode
1249 data CompiledByteCode = NoByteCode
1252 instance Outputable Unlinked where
1253 ppr (DotO path) = text "DotO" <+> text path
1254 ppr (DotA path) = text "DotA" <+> text path
1255 ppr (DotDLL path) = text "DotDLL" <+> text path
1257 ppr (BCOs bcos) = text "BCOs" <+> ppr bcos
1259 ppr (BCOs bcos) = text "No byte code"
1262 isObject (DotO _) = True
1263 isObject (DotA _) = True
1264 isObject (DotDLL _) = True
1267 isInterpretable = not . isObject
1269 nameOfObject (DotO fn) = fn
1270 nameOfObject (DotA fn) = fn
1271 nameOfObject (DotDLL fn) = fn
1272 nameOfObject other = pprPanic "nameOfObject" (ppr other)
1274 byteCodeOfObject (BCOs bc) = bc
1275 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)
1278 %************************************************************************
1280 \subsection{Breakpoint Support}
1282 %************************************************************************
1285 type BreakIndex = Int
1287 -- | all the information about the breakpoints for a given module
1290 { modBreaks_flags :: BreakArray
1291 -- The array of flags, one per breakpoint,
1292 -- indicating which breakpoints are enabled.
1293 , modBreaks_locs :: !(Array BreakIndex SrcSpan)
1294 -- An array giving the source span of each breakpoint.
1295 , modBreaks_vars :: !(Array BreakIndex [OccName])
1296 -- An array giving the names of the free variables at each breakpoint.
1299 emptyModBreaks :: ModBreaks
1300 emptyModBreaks = ModBreaks
1301 { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
1302 -- Todo: can we avoid this?
1303 , modBreaks_locs = array (0,-1) []
1304 , modBreaks_vars = array (0,-1) []