2 % (c) The University of Glasgow, 2006
4 \section[HscTypes]{Types for the per-module compiler}
7 -- | Types for the per-module compiler
11 FinderCache, FindResult(..), ModLocationCache,
12 Target(..), TargetId(..), pprTarget, pprTargetId,
15 -- * Information about modules
16 ModDetails(..), emptyModDetails,
17 ModGuts(..), CgGuts(..), ForeignStubs(..), appendStubC,
20 ModSummary(..), ms_mod_name, showModMsg, isBootSummary,
21 msHsFilePath, msHiFilePath, msObjFilePath,
23 -- * Information about the module being compiled
24 HscSource(..), isHsBoot, hscSourceString, -- Re-exported from DriverPhases
26 -- * State relating to modules in this package
27 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
28 hptInstances, hptRules, hptVectInfo,
31 -- * State relating to known packages
32 ExternalPackageState(..), EpsStats(..), addEpsInStats,
33 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
34 lookupIfaceByModule, emptyModIface,
36 PackageInstEnv, PackageRuleBase,
42 -- * Interactive context
43 InteractiveContext(..), emptyInteractiveContext,
44 icPrintUnqual, extendInteractiveContext,
45 substInteractiveContext,
46 mkPrintUnqualified, pprModulePrefix,
49 ModIface(..), mkIfaceWarnCache, mkIfaceHashCache, mkIfaceFixCache,
53 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
55 -- * TyThings and type environments
57 tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
58 implicitTyThings, isImplicitTyThing,
60 TypeEnv, lookupType, lookupTypeHscEnv, mkTypeEnv, emptyTypeEnv,
61 extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
62 typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
68 -- * Information on imports and exports
69 WhetherHasOrphans, IsBootInterface, Usage(..),
70 Dependencies(..), noDependencies,
71 NameCache(..), OrigNameCache, OrigIParamCache,
72 Avails, availsToNameSet, availsToNameEnv, availName, availNames,
73 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
77 Warnings(..), WarningTxt(..), plusWarns,
80 Linkable(..), isObjectLinkable, linkableObjs,
81 Unlinked(..), CompiledByteCode,
82 isObject, nameOfObject, isInterpretable, byteCodeOfObject,
85 HpcInfo(..), emptyHpcInfo, isHpcUsed, AnyHpcUsage,
88 ModBreaks (..), BreakIndex, emptyModBreaks,
90 -- * Vectorisation information
91 VectInfo(..), IfaceVectInfo(..), noVectInfo, plusVectInfo,
94 -- * Compilation errors and warnings
95 SourceError, GhcApiError, mkSrcErr, srcErrorMessages, mkApiErr,
96 throwOneError, handleSourceError,
97 handleFlagWarnings, printOrThrowWarnings,
100 #include "HsVersions.h"
103 import ByteCodeAsm ( CompiledByteCode )
104 import {-# SOURCE #-} InteractiveEval ( Resume )
113 import InstEnv ( InstEnv, Instance )
114 import FamInstEnv ( FamInstEnv, FamInst )
115 import Rules ( RuleBase )
116 import CoreSyn ( CoreBind )
123 import Class ( Class, classAllSelIds, classATs, classTyCon )
125 import DataCon ( DataCon, dataConImplicitIds, dataConWrapId )
126 import PrelNames ( gHC_PRIM )
127 import Packages hiding ( Version(..) )
128 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..), dopt,
130 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
131 import BasicTypes ( IPName, defaultFixity, WarningTxt(..) )
132 import OptimizationFuel ( OptFuelState )
134 import CoreSyn ( CoreRule, CoreVect )
135 import Maybes ( orElse, expectJust, catMaybes )
138 import SrcLoc ( SrcSpan, Located(..) )
139 import UniqFM ( lookupUFM, eltsUFM, emptyUFM )
140 import UniqSupply ( UniqSupply )
142 import StringBuffer ( StringBuffer )
145 import Data.Dynamic ( Typeable )
146 import qualified Data.Dynamic as Dyn
150 import System.FilePath
151 import System.Time ( ClockTime )
153 import Data.Array ( Array, array )
155 import Data.Map (Map)
156 import Control.Monad ( mplus, guard, liftM, when )
159 -- -----------------------------------------------------------------------------
162 -- When the compiler (HscMain) discovers errors, it throws an
163 -- exception in the IO monad.
165 mkSrcErr :: ErrorMessages -> SourceError
166 srcErrorMessages :: SourceError -> ErrorMessages
167 mkApiErr :: SDoc -> GhcApiError
169 throwOneError :: MonadIO m => ErrMsg -> m ab
170 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
172 -- | A source error is an error that is caused by one or more errors in the
173 -- source code. A 'SourceError' is thrown by many functions in the
174 -- compilation pipeline. Inside GHC these errors are merely printed via
175 -- 'log_action', but API clients may treat them differently, for example,
176 -- insert them into a list box. If you want the default behaviour, use the
179 -- > handleSourceError printExceptionAndWarnings $ do
180 -- > ... api calls that may fail ...
182 -- The 'SourceError's error messages can be accessed via 'srcErrorMessages'.
183 -- This list may be empty if the compiler failed due to @-Werror@
184 -- ('Opt_WarnIsError').
186 -- See 'printExceptionAndWarnings' for more information on what to take care
187 -- of when writing a custom error handler.
188 data SourceError = SourceError ErrorMessages
190 instance Show SourceError where
191 show (SourceError msgs) = unlines . map show . bagToList $ msgs
192 -- ToDo: is there some nicer way to print this?
194 sourceErrorTc :: Dyn.TyCon
195 sourceErrorTc = Dyn.mkTyCon "SourceError"
196 {-# NOINLINE sourceErrorTc #-}
197 instance Typeable SourceError where
198 typeOf _ = Dyn.mkTyConApp sourceErrorTc []
200 instance Exception SourceError
202 mkSrcErr = SourceError
204 -- | Perform the given action and call the exception handler if the action
205 -- throws a 'SourceError'. See 'SourceError' for more information.
206 handleSourceError :: (ExceptionMonad m) =>
207 (SourceError -> m a) -- ^ exception handler
208 -> m a -- ^ action to perform
210 handleSourceError handler act =
211 gcatch act (\(e :: SourceError) -> handler e)
213 srcErrorMessages (SourceError msgs) = msgs
215 -- | XXX: what exactly is an API error?
216 data GhcApiError = GhcApiError SDoc
218 instance Show GhcApiError where
219 show (GhcApiError msg) = showSDoc msg
221 ghcApiErrorTc :: Dyn.TyCon
222 ghcApiErrorTc = Dyn.mkTyCon "GhcApiError"
223 {-# NOINLINE ghcApiErrorTc #-}
224 instance Typeable GhcApiError where
225 typeOf _ = Dyn.mkTyConApp ghcApiErrorTc []
227 instance Exception GhcApiError
229 mkApiErr = GhcApiError
231 -- | Given a bag of warnings, turn them into an exception if
232 -- -Werror is enabled, or print them out otherwise.
233 printOrThrowWarnings :: DynFlags -> Bag WarnMsg -> IO ()
234 printOrThrowWarnings dflags warns
235 | dopt Opt_WarnIsError dflags
236 = when (not (isEmptyBag warns)) $ do
237 throwIO $ mkSrcErr $ warns `snocBag` warnIsErrorMsg
239 = printBagOfWarnings dflags warns
241 handleFlagWarnings :: DynFlags -> [Located String] -> IO ()
242 handleFlagWarnings dflags warns
243 = when (dopt Opt_WarnDeprecatedFlags dflags) $ do
244 -- It would be nicer if warns :: [Located Message], but that
245 -- has circular import problems.
246 let bag = listToBag [ mkPlainWarnMsg loc (text warn)
247 | L loc warn <- warns ]
249 printOrThrowWarnings dflags bag
253 -- | Hscenv is like 'Session', except that some of the fields are immutable.
254 -- An HscEnv is used to compile a single module from plain Haskell source
255 -- code (after preprocessing) to either C, assembly or C--. Things like
256 -- the module graph don't change during a single compilation.
258 -- Historical note: \"hsc\" used to be the name of the compiler binary,
259 -- when there was a separate driver and compiler. To compile a single
260 -- module, the driver would invoke hsc on the source code... so nowadays
261 -- we think of hsc as the layer of the compiler that deals with compiling
265 hsc_dflags :: DynFlags,
266 -- ^ The dynamic flag settings
268 hsc_targets :: [Target],
269 -- ^ The targets (or roots) of the current session
271 hsc_mod_graph :: ModuleGraph,
272 -- ^ The module graph of the current session
274 hsc_IC :: InteractiveContext,
275 -- ^ The context for evaluating interactive statements
277 hsc_HPT :: HomePackageTable,
278 -- ^ The home package table describes already-compiled
279 -- home-package modules, /excluding/ the module we
280 -- are compiling right now.
281 -- (In one-shot mode the current module is the only
282 -- home-package module, so hsc_HPT is empty. All other
283 -- modules count as \"external-package\" modules.
284 -- However, even in GHCi mode, hi-boot interfaces are
285 -- demand-loaded into the external-package table.)
287 -- 'hsc_HPT' is not mutable because we only demand-load
288 -- external packages; the home package is eagerly
289 -- loaded, module by module, by the compilation manager.
291 -- The HPT may contain modules compiled earlier by @--make@
292 -- but not actually below the current module in the dependency
295 -- (This changes a previous invariant: changed Jan 05.)
297 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
298 -- ^ Information about the currently loaded external packages.
299 -- This is mutable because packages will be demand-loaded during
300 -- a compilation run as required.
302 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
303 -- ^ As with 'hsc_EPS', this is side-effected by compiling to
304 -- reflect sucking in interface files. They cache the state of
305 -- external interface files, in effect.
307 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
308 -- ^ The cached result of performing finding in the file system
309 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
310 -- ^ This caches the location of modules, so we don't have to
311 -- search the filesystem multiple times. See also 'hsc_FC'.
313 hsc_OptFuel :: OptFuelState,
314 -- ^ Settings to control the use of \"optimization fuel\":
315 -- by limiting the number of transformations,
316 -- we can use binary search to help find compiler bugs.
318 hsc_type_env_var :: Maybe (Module, IORef TypeEnv)
319 -- ^ Used for one-shot compilation only, to initialise
320 -- the 'IfGblEnv'. See 'TcRnTypes.tcg_type_env_var' for
321 -- 'TcRunTypes.TcGblEnv'
324 hscEPS :: HscEnv -> IO ExternalPackageState
325 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
327 -- | A compilation target.
329 -- A target may be supplied with the actual text of the
330 -- module. If so, use this instead of the file contents (this
331 -- is for use in an IDE where the file hasn't been saved by
334 { targetId :: TargetId -- ^ module or filename
335 , targetAllowObjCode :: Bool -- ^ object code allowed?
336 , targetContents :: Maybe (StringBuffer,ClockTime)
337 -- ^ in-memory text buffer?
341 = TargetModule ModuleName
342 -- ^ A module name: search for the file
343 | TargetFile FilePath (Maybe Phase)
344 -- ^ A filename: preprocess & parse it to find the module name.
345 -- If specified, the Phase indicates how to compile this file
346 -- (which phase to start from). Nothing indicates the starting phase
347 -- should be determined from the suffix of the filename.
350 pprTarget :: Target -> SDoc
351 pprTarget (Target id obj _) =
352 (if obj then char '*' else empty) <> pprTargetId id
354 instance Outputable Target where
357 pprTargetId :: TargetId -> SDoc
358 pprTargetId (TargetModule m) = ppr m
359 pprTargetId (TargetFile f _) = text f
361 instance Outputable TargetId where
364 -- | Helps us find information about modules in the home package
365 type HomePackageTable = ModuleNameEnv HomeModInfo
366 -- Domain = modules in the home package that have been fully compiled
367 -- "home" package name cached here for convenience
369 -- | Helps us find information about modules in the imported packages
370 type PackageIfaceTable = ModuleEnv ModIface
371 -- Domain = modules in the imported packages
373 emptyHomePackageTable :: HomePackageTable
374 emptyHomePackageTable = emptyUFM
376 emptyPackageIfaceTable :: PackageIfaceTable
377 emptyPackageIfaceTable = emptyModuleEnv
379 -- | Information about modules in the package being compiled
382 hm_iface :: !ModIface,
383 -- ^ The basic loaded interface file: every loaded module has one of
384 -- these, even if it is imported from another package
385 hm_details :: !ModDetails,
386 -- ^ Extra information that has been created from the 'ModIface' for
387 -- the module, typically during typechecking
388 hm_linkable :: !(Maybe Linkable)
389 -- ^ The actual artifact we would like to link to access things in
392 -- 'hm_linkable' might be Nothing:
394 -- 1. If this is an .hs-boot module
396 -- 2. Temporarily during compilation if we pruned away
397 -- the old linkable because it was out of date.
399 -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
400 -- in the 'HomePackageTable' will be @Just@.
402 -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
403 -- 'HomeModInfo' by building a new 'ModDetails' from the old
404 -- 'ModIface' (only).
407 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
408 -- and external package module information
415 lookupIfaceByModule dflags hpt pit mod
416 | modulePackageId mod == thisPackage dflags
417 = -- The module comes from the home package, so look first
418 -- in the HPT. If it's not from the home package it's wrong to look
419 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
420 fmap hm_iface (lookupUFM hpt (moduleName mod))
421 `mplus` lookupModuleEnv pit mod
423 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
425 -- If the module does come from the home package, why do we look in the PIT as well?
426 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
427 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
428 -- module is in the PIT, namely GHC.Prim when compiling the base package.
429 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a package
430 -- of its own, but it doesn't seem worth the bother.
435 hptInstances :: HscEnv -> (ModuleName -> Bool) -> ([Instance], [FamInst])
436 -- ^ Find all the instance declarations (of classes and families) that are in
437 -- modules imported by this one, directly or indirectly, and are in the Home
438 -- Package Table. This ensures that we don't see instances from modules @--make@
439 -- compiled before this one, but which are not below this one.
440 hptInstances hsc_env want_this_module
441 = let (insts, famInsts) = unzip $ flip hptAllThings hsc_env $ \mod_info -> do
442 guard (want_this_module (moduleName (mi_module (hm_iface mod_info))))
443 let details = hm_details mod_info
444 return (md_insts details, md_fam_insts details)
445 in (concat insts, concat famInsts)
447 hptVectInfo :: HscEnv -> VectInfo
448 -- ^ Get the combined VectInfo of all modules in the home package table. In
449 -- contrast to instances and rules, we don't care whether the modules are
450 -- \"below\" us in the dependency sense. The VectInfo of those modules not \"below\"
451 -- us does not affect the compilation of the current module.
452 hptVectInfo = concatVectInfo . hptAllThings ((: []) . md_vect_info . hm_details)
454 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
455 -- ^ Get rules from modules \"below\" this one (in the dependency sense)
456 hptRules = hptSomeThingsBelowUs (md_rules . hm_details) False
459 hptAnns :: HscEnv -> Maybe [(ModuleName, IsBootInterface)] -> [Annotation]
460 -- ^ Get annotations from modules \"below\" this one (in the dependency sense)
461 hptAnns hsc_env (Just deps) = hptSomeThingsBelowUs (md_anns . hm_details) False hsc_env deps
462 hptAnns hsc_env Nothing = hptAllThings (md_anns . hm_details) hsc_env
464 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
465 hptAllThings extract hsc_env = concatMap extract (eltsUFM (hsc_HPT hsc_env))
467 hptSomeThingsBelowUs :: (HomeModInfo -> [a]) -> Bool -> HscEnv -> [(ModuleName, IsBootInterface)] -> [a]
468 -- Get things from modules \"below\" this one (in the dependency sense)
469 -- C.f Inst.hptInstances
470 hptSomeThingsBelowUs extract include_hi_boot hsc_env deps
471 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
474 hpt = hsc_HPT hsc_env
477 | -- Find each non-hi-boot module below me
478 (mod, is_boot_mod) <- deps
479 , include_hi_boot || not is_boot_mod
481 -- unsavoury: when compiling the base package with --make, we
482 -- sometimes try to look up RULES etc for GHC.Prim. GHC.Prim won't
483 -- be in the HPT, because we never compile it; it's in the EPT
484 -- instead. ToDo: clean up, and remove this slightly bogus
486 , mod /= moduleName gHC_PRIM
488 -- Look it up in the HPT
489 , let things = case lookupUFM hpt mod of
490 Just info -> extract info
491 Nothing -> pprTrace "WARNING in hptSomeThingsBelowUs" msg []
492 msg = vcat [ptext (sLit "missing module") <+> ppr mod,
493 ptext (sLit "Probable cause: out-of-date interface files")]
494 -- This really shouldn't happen, but see Trac #962
499 hptObjs :: HomePackageTable -> [FilePath]
500 hptObjs hpt = concat (map (maybe [] linkableObjs . hm_linkable) (eltsUFM hpt))
503 %************************************************************************
505 \subsection{Dealing with Annotations}
507 %************************************************************************
510 prepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv
511 -- ^ Deal with gathering annotations in from all possible places
512 -- and combining them into a single 'AnnEnv'
513 prepareAnnotations hsc_env mb_guts
514 = do { eps <- hscEPS hsc_env
515 ; let -- Extract annotations from the module being compiled if supplied one
516 mb_this_module_anns = fmap (mkAnnEnv . mg_anns) mb_guts
517 -- Extract dependencies of the module if we are supplied one,
518 -- otherwise load annotations from all home package table
519 -- entries regardless of dependency ordering.
520 home_pkg_anns = (mkAnnEnv . hptAnns hsc_env) $ fmap (dep_mods . mg_deps) mb_guts
521 other_pkg_anns = eps_ann_env eps
522 ann_env = foldl1' plusAnnEnv $ catMaybes [mb_this_module_anns,
529 %************************************************************************
531 \subsection{The Finder cache}
533 %************************************************************************
536 -- | The 'FinderCache' maps home module names to the result of
537 -- searching for that module. It records the results of searching for
538 -- modules along the search path. On @:load@, we flush the entire
539 -- contents of this cache.
541 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
542 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
544 type FinderCache = ModuleNameEnv FindResult
546 -- | The result of searching for an imported module.
548 = Found ModLocation Module
549 -- ^ The module was found
550 | NoPackage PackageId
551 -- ^ The requested package was not found
552 | FoundMultiple [PackageId]
553 -- ^ _Error_: both in multiple packages
555 | NotFound -- Not found
556 { fr_paths :: [FilePath] -- Places where I looked
558 , fr_pkg :: Maybe PackageId -- Just p => module is in this package's
559 -- manifest, but couldn't find
562 , fr_mods_hidden :: [PackageId] -- Module is in these packages,
563 -- but the *module* is hidden
565 , fr_pkgs_hidden :: [PackageId] -- Module is in these packages,
566 -- but the *package* is hidden
568 , fr_suggestions :: [Module] -- Possible mis-spelled modules
571 -- | Cache that remembers where we found a particular module. Contains both
572 -- home modules and package modules. On @:load@, only home modules are
573 -- purged from this cache.
574 type ModLocationCache = ModuleEnv ModLocation
577 %************************************************************************
579 \subsection{Symbol tables and Module details}
581 %************************************************************************
584 -- | A 'ModIface' plus a 'ModDetails' summarises everything we know
585 -- about a compiled module. The 'ModIface' is the stuff *before* linking,
586 -- and can be written out to an interface file. The 'ModDetails is after
587 -- linking and can be completely recovered from just the 'ModIface'.
589 -- When we read an interface file, we also construct a 'ModIface' from it,
590 -- except that we explicitly make the 'mi_decls' and a few other fields empty;
591 -- as when reading we consolidate the declarations etc. into a number of indexed
592 -- maps and environments in the 'ExternalPackageState'.
595 mi_module :: !Module, -- ^ Name of the module we are for
596 mi_iface_hash :: !Fingerprint, -- ^ Hash of the whole interface
597 mi_mod_hash :: !Fingerprint, -- ^ Hash of the ABI only
599 mi_orphan :: !WhetherHasOrphans, -- ^ Whether this module has orphans
600 mi_finsts :: !WhetherHasFamInst, -- ^ Whether this module has family instances
601 mi_boot :: !IsBootInterface, -- ^ Read from an hi-boot file?
603 mi_deps :: Dependencies,
604 -- ^ The dependencies of the module. This is
605 -- consulted for directly-imported modules, but not
606 -- for anything else (hence lazy)
608 mi_usages :: [Usage],
609 -- ^ Usages; kept sorted so that it's easy to decide
610 -- whether to write a new iface file (changing usages
611 -- doesn't affect the hash of this module)
613 -- NOT STRICT! we read this field lazily from the interface file
614 -- It is *only* consulted by the recompilation checker
617 -- Kept sorted by (mod,occ), to make version comparisons easier
618 mi_exports :: ![IfaceExport],
619 -- ^ Records the modules that are the declaration points for things
620 -- exported by this module, and the 'OccName's of those things
622 mi_exp_hash :: !Fingerprint, -- ^ Hash of export list
624 mi_fixities :: [(OccName,Fixity)],
627 -- NOT STRICT! we read this field lazily from the interface file
629 mi_warns :: Warnings,
632 -- NOT STRICT! we read this field lazily from the interface file
634 mi_anns :: [IfaceAnnotation],
637 -- NOT STRICT! we read this field lazily from the interface file
639 -- Type, class and variable declarations
640 -- The hash of an Id changes if its fixity or deprecations change
641 -- (as well as its type of course)
642 -- Ditto data constructors, class operations, except that
643 -- the hash of the parent class/tycon changes
644 mi_decls :: [(Fingerprint,IfaceDecl)], -- ^ Sorted type, variable, class etc. declarations
646 mi_globals :: !(Maybe GlobalRdrEnv),
647 -- ^ Binds all the things defined at the top level in
648 -- the /original source/ code for this module. which
649 -- is NOT the same as mi_exports, nor mi_decls (which
650 -- may contains declarations for things not actually
651 -- defined by the user). Used for GHCi and for inspecting
652 -- the contents of modules via the GHC API only.
654 -- (We need the source file to figure out the
655 -- top-level environment, if we didn't compile this module
656 -- from source then this field contains @Nothing@).
658 -- Strictly speaking this field should live in the
659 -- 'HomeModInfo', but that leads to more plumbing.
661 -- Instance declarations and rules
662 mi_insts :: [IfaceInst], -- ^ Sorted class instance
663 mi_fam_insts :: [IfaceFamInst], -- ^ Sorted family instances
664 mi_rules :: [IfaceRule], -- ^ Sorted rules
665 mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules and
666 -- class and family instances
669 mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
671 -- Cached environments for easy lookup
672 -- These are computed (lazily) from other fields
673 -- and are not put into the interface file
674 mi_warn_fn :: Name -> Maybe WarningTxt, -- ^ Cached lookup for 'mi_warns'
675 mi_fix_fn :: OccName -> Fixity, -- ^ Cached lookup for 'mi_fixities'
676 mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
677 -- ^ Cached lookup for 'mi_decls'.
678 -- The @Nothing@ in 'mi_hash_fn' means that the thing
679 -- isn't in decls. It's useful to know that when
680 -- seeing if we are up to date wrt. the old interface.
681 -- The 'OccName' is the parent of the name, if it has one.
682 mi_hpc :: !AnyHpcUsage
683 -- ^ True if this program uses Hpc at any point in the program.
686 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
687 -- for home modules only. Information relating to packages will be loaded into
688 -- global environments in 'ExternalPackageState'.
691 -- The next two fields are created by the typechecker
692 md_exports :: [AvailInfo],
693 md_types :: !TypeEnv, -- ^ Local type environment for this particular module
694 md_insts :: ![Instance], -- ^ 'DFunId's for the instances in this module
695 md_fam_insts :: ![FamInst],
696 md_rules :: ![CoreRule], -- ^ Domain may include 'Id's from other modules
697 md_anns :: ![Annotation], -- ^ Annotations present in this module: currently
698 -- they only annotate things also declared in this module
699 md_vect_info :: !VectInfo -- ^ Module vectorisation information
702 emptyModDetails :: ModDetails
703 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
709 md_vect_info = noVectInfo
712 -- | Records the modules directly imported by a module for extracting e.g. usage information
713 type ImportedMods = ModuleEnv [(ModuleName, Bool, SrcSpan)]
714 -- TODO: we are not actually using the codomain of this type at all, so it can be
715 -- replaced with ModuleEnv ()
717 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
718 -- There is only one ModGuts at any time, the one for the module
719 -- being compiled right now. Once it is compiled, a 'ModIface' and
720 -- 'ModDetails' are extracted and the ModGuts is discarded.
723 mg_module :: !Module, -- ^ Module being compiled
724 mg_boot :: IsBootInterface, -- ^ Whether it's an hs-boot module
725 mg_exports :: ![AvailInfo], -- ^ What it exports
726 mg_deps :: !Dependencies, -- ^ What it depends on, directly or
728 mg_dir_imps :: !ImportedMods, -- ^ Directly-imported modules; used to
729 -- generate initialisation code
730 mg_used_names:: !NameSet, -- ^ What the module needed (used in 'MkIface.mkIface')
732 mg_rdr_env :: !GlobalRdrEnv, -- ^ Top-level lexical environment
734 -- These fields all describe the things **declared in this module**
735 mg_fix_env :: !FixityEnv, -- ^ Fixities declared in this module
736 -- TODO: I'm unconvinced this is actually used anywhere
737 mg_types :: !TypeEnv, -- ^ Types declared in this module
738 mg_insts :: ![Instance], -- ^ Class instances declared in this module
739 mg_fam_insts :: ![FamInst], -- ^ Family instances declared in this module
740 mg_rules :: ![CoreRule], -- ^ Before the core pipeline starts, contains
741 -- See Note [Overall plumbing for rules] in Rules.lhs
742 mg_binds :: ![CoreBind], -- ^ Bindings for this module
743 mg_foreign :: !ForeignStubs, -- ^ Foreign exports declared in this module
744 mg_warns :: !Warnings, -- ^ Warnings declared in the module
745 mg_anns :: [Annotation], -- ^ Annotations declared in this module
746 mg_hpc_info :: !HpcInfo, -- ^ Coverage tick boxes in the module
747 mg_modBreaks :: !ModBreaks, -- ^ Breakpoints for the module
748 mg_vect_decls:: ![CoreVect], -- ^ Vectorisation declarations in this module
749 -- (produced by desugarer & consumed by vectoriser)
750 mg_vect_info :: !VectInfo, -- ^ Pool of vectorised declarations in the module
752 -- The next two fields are unusual, because they give instance
753 -- environments for *all* modules in the home package, including
754 -- this module, rather than for *just* this module.
755 -- Reason: when looking up an instance we don't want to have to
756 -- look at each module in the home package in turn
757 mg_inst_env :: InstEnv,
758 -- ^ Class instance environment from /home-package/ modules (including
759 -- this one); c.f. 'tcg_inst_env'
760 mg_fam_inst_env :: FamInstEnv
761 -- ^ Type-family instance enviroment for /home-package/ modules
762 -- (including this one); c.f. 'tcg_fam_inst_env'
765 -- The ModGuts takes on several slightly different forms:
767 -- After simplification, the following fields change slightly:
768 -- mg_rules Orphan rules only (local ones now attached to binds)
769 -- mg_binds With rules attached
771 -- The ModGuts takes on several slightly different forms:
773 -- After simplification, the following fields change slightly:
774 -- mg_rules Orphan rules only (local ones now attached to binds)
775 -- mg_binds With rules attached
778 ---------------------------------------------------------
779 -- The Tidy pass forks the information about this module:
780 -- * one lot goes to interface file generation (ModIface)
781 -- and later compilations (ModDetails)
782 -- * the other lot goes to code generation (CgGuts)
784 -- | A restricted form of 'ModGuts' for code generation purposes
787 cg_module :: !Module, -- ^ Module being compiled
789 cg_tycons :: [TyCon],
790 -- ^ Algebraic data types (including ones that started
791 -- life as classes); generate constructors and info
792 -- tables. Includes newtypes, just for the benefit of
795 cg_binds :: [CoreBind],
796 -- ^ The tidied main bindings, including
797 -- previously-implicit bindings for record and class
798 -- selectors, and data construtor wrappers. But *not*
799 -- data constructor workers; reason: we we regard them
800 -- as part of the code-gen of tycons
802 cg_foreign :: !ForeignStubs, -- ^ Foreign export stubs
803 cg_dep_pkgs :: ![PackageId], -- ^ Dependent packages, used to
804 -- generate #includes for C code gen
805 cg_hpc_info :: !HpcInfo, -- ^ Program coverage tick box information
806 cg_modBreaks :: !ModBreaks -- ^ Module breakpoints
809 -----------------------------------
810 -- | Foreign export stubs
811 data ForeignStubs = NoStubs -- ^ We don't have any stubs
815 -- ^ There are some stubs. Parameters:
817 -- 1) Header file prototypes for
818 -- "foreign exported" functions
820 -- 2) C stubs to use when calling
821 -- "foreign exported" functions
823 appendStubC :: ForeignStubs -> SDoc -> ForeignStubs
824 appendStubC NoStubs c_code = ForeignStubs empty c_code
825 appendStubC (ForeignStubs h c) c_code = ForeignStubs h (c $$ c_code)
829 emptyModIface :: Module -> ModIface
831 = ModIface { mi_module = mod,
832 mi_iface_hash = fingerprint0,
833 mi_mod_hash = fingerprint0,
837 mi_deps = noDependencies,
840 mi_exp_hash = fingerprint0,
842 mi_warns = NoWarnings,
848 mi_globals = Nothing,
849 mi_orphan_hash = fingerprint0,
850 mi_vect_info = noIfaceVectInfo,
851 mi_warn_fn = emptyIfaceWarnCache,
852 mi_fix_fn = emptyIfaceFixCache,
853 mi_hash_fn = emptyIfaceHashCache,
859 %************************************************************************
861 \subsection{The interactive context}
863 %************************************************************************
866 -- | Interactive context, recording information relevant to GHCi
867 data InteractiveContext
868 = InteractiveContext {
869 ic_toplev_scope :: [Module] -- ^ The context includes the "top-level" scope of
872 , ic_exports :: [(Module, Maybe (ImportDecl RdrName))] -- ^ The context includes just the exported parts of these
875 , ic_rn_gbl_env :: GlobalRdrEnv -- ^ The contexts' cached 'GlobalRdrEnv', built from
876 -- 'ic_toplev_scope' and 'ic_exports'
878 , ic_tmp_ids :: [Id] -- ^ Names bound during interaction with the user.
879 -- Later Ids shadow earlier ones with the same OccName
880 -- Expressions are typed with these Ids in the envt
881 -- For runtime-debugging, these Ids may have free
882 -- TcTyVars of RuntimUnkSkol flavour, but no free TyVars
883 -- (because the typechecker doesn't expect that)
886 , ic_resume :: [Resume] -- ^ The stack of breakpoint contexts
889 , ic_cwd :: Maybe FilePath -- virtual CWD of the program
893 emptyInteractiveContext :: InteractiveContext
894 emptyInteractiveContext
895 = InteractiveContext { ic_toplev_scope = [],
897 ic_rn_gbl_env = emptyGlobalRdrEnv,
905 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
906 icPrintUnqual dflags ictxt = mkPrintUnqualified dflags (ic_rn_gbl_env ictxt)
909 extendInteractiveContext
910 :: InteractiveContext
912 -> InteractiveContext
913 extendInteractiveContext ictxt ids
914 = ictxt { ic_tmp_ids = snub ((ic_tmp_ids ictxt \\ ids) ++ ids)
915 -- NB. must be this way around, because we want
916 -- new ids to shadow existing bindings.
918 where snub = map head . group . sort
920 substInteractiveContext :: InteractiveContext -> TvSubst -> InteractiveContext
921 substInteractiveContext ictxt subst | isEmptyTvSubst subst = ictxt
922 substInteractiveContext ictxt@InteractiveContext{ic_tmp_ids=ids} subst
923 = ictxt { ic_tmp_ids = map subst_ty ids }
925 subst_ty id = id `setIdType` substTy subst (idType id)
928 %************************************************************************
930 Building a PrintUnqualified
932 %************************************************************************
934 Note [Printing original names]
935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
936 Deciding how to print names is pretty tricky. We are given a name
937 P:M.T, where P is the package name, M is the defining module, and T is
938 the occurrence name, and we have to decide in which form to display
939 the name given a GlobalRdrEnv describing the current scope.
941 Ideally we want to display the name in the form in which it is in
942 scope. However, the name might not be in scope at all, and that's
943 where it gets tricky. Here are the cases:
945 1. T uniquely maps to P:M.T ---> "T" NameUnqual
946 2. There is an X for which X.T
947 uniquely maps to P:M.T ---> "X.T" NameQual X
948 3. There is no binding for "M.T" ---> "M.T" NameNotInScope1
949 4. Otherwise ---> "P:M.T" NameNotInScope2
951 (3) and (4) apply when the entity P:M.T is not in the GlobalRdrEnv at
952 all. In these cases we still want to refer to the name as "M.T", *but*
953 "M.T" might mean something else in the current scope (e.g. if there's
954 an "import X as M"), so to avoid confusion we avoid using "M.T" if
955 there's already a binding for it. Instead we write P:M.T.
957 There's one further subtlety: in case (3), what if there are two
958 things around, P1:M.T and P2:M.T? Then we don't want to print both of
959 them as M.T! However only one of the modules P1:M and P2:M can be
960 exposed (say P2), so we use M.T for that, and P1:M.T for the other one.
961 This is handled by the qual_mod component of PrintUnqualified, inside
962 the (ppr mod) of case (3), in Name.pprModulePrefix
965 -- | Creates some functions that work out the best ways to format
966 -- names for the user according to a set of heuristics
967 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
968 mkPrintUnqualified dflags env = (qual_name, qual_mod)
970 qual_name mod occ -- The (mod,occ) pair is the original name of the thing
971 | [gre] <- unqual_gres, right_name gre = NameUnqual
972 -- If there's a unique entity that's in scope unqualified with 'occ'
973 -- AND that entity is the right one, then we can use the unqualified name
975 | [gre] <- qual_gres = NameQual (get_qual_mod (gre_prov gre))
978 if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
982 | otherwise = panic "mkPrintUnqualified"
984 right_name gre = nameModule_maybe (gre_name gre) == Just mod
986 unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
987 qual_gres = filter right_name (lookupGlobalRdrEnv env occ)
989 get_qual_mod LocalDef = moduleName mod
990 get_qual_mod (Imported is) = ASSERT( not (null is) ) is_as (is_decl (head is))
992 -- we can mention a module P:M without the P: qualifier iff
993 -- "import M" would resolve unambiguously to P:M. (if P is the
994 -- current package we can just assume it is unqualified).
997 | modulePackageId mod == thisPackage dflags = False
999 | [pkgconfig] <- [pkg | (pkg,exposed_module) <- lookup,
1000 exposed pkg && exposed_module],
1001 packageConfigId pkgconfig == modulePackageId mod
1002 -- this says: we are given a module P:M, is there just one exposed package
1003 -- that exposes a module M, and is it package P?
1007 where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1011 %************************************************************************
1015 %************************************************************************
1018 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1019 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1020 -- as they just bring themselves into scope, but classes bring their
1021 -- dictionary datatype, type constructor and some selector functions into
1022 -- scope, just for a start!
1024 -- N.B. the set of TyThings returned here *must* match the set of
1025 -- names returned by LoadIface.ifaceDeclSubBndrs, in the sense that
1026 -- TyThing.getOccName should define a bijection between the two lists.
1027 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1028 -- The order of the list does not matter.
1029 implicitTyThings :: TyThing -> [TyThing]
1031 -- For data and newtype declarations:
1032 implicitTyThings (ATyCon tc)
1033 = -- fields (names of selectors)
1034 -- (possibly) implicit coercion and family coercion
1035 -- depending on whether it's a newtype or a family instance or both
1036 implicitCoTyCon tc ++
1037 -- for each data constructor in order,
1038 -- the contructor, worker, and (possibly) wrapper
1039 concatMap (extras_plus . ADataCon) (tyConDataCons tc)
1041 implicitTyThings (AClass cl)
1042 = -- dictionary datatype:
1045 -- [recursive call:]
1046 -- (possibly) newtype coercion; definitely no family coercion here
1049 -- (no wrapper by invariant)
1050 extras_plus (ATyCon (classTyCon cl)) ++
1052 -- No extras_plus (recursive call) for the classATs, because they
1053 -- are only the family decls; they have no implicit things
1054 map ATyCon (classATs cl) ++
1055 -- superclass and operation selectors
1056 map AnId (classAllSelIds cl)
1058 implicitTyThings (ADataCon dc) =
1059 -- For data cons add the worker and (possibly) wrapper
1060 map AnId (dataConImplicitIds dc)
1062 implicitTyThings (AnId _) = []
1064 -- add a thing and recursive call
1065 extras_plus :: TyThing -> [TyThing]
1066 extras_plus thing = thing : implicitTyThings thing
1068 -- For newtypes and indexed data types (and both),
1069 -- add the implicit coercion tycon
1070 implicitCoTyCon :: TyCon -> [TyThing]
1072 = map ATyCon . catMaybes $ [-- Just if newtype, Nothing if not
1073 newTyConCo_maybe tc,
1074 -- Just if family instance, Nothing if not
1075 tyConFamilyCoercion_maybe tc]
1077 -- sortByOcc = sortBy (\ x -> \ y -> getOccName x < getOccName y)
1080 -- | Returns @True@ if there should be no interface-file declaration
1081 -- for this thing on its own: either it is built-in, or it is part
1082 -- of some other declaration, or it is generated implicitly by some
1083 -- other declaration.
1084 isImplicitTyThing :: TyThing -> Bool
1085 isImplicitTyThing (ADataCon _) = True
1086 isImplicitTyThing (AnId id) = isImplicitId id
1087 isImplicitTyThing (AClass _) = False
1088 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
1090 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
1091 extendTypeEnvWithIds env ids
1092 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
1095 %************************************************************************
1099 %************************************************************************
1102 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1103 -- local declarations or interface files
1104 type TypeEnv = NameEnv TyThing
1106 emptyTypeEnv :: TypeEnv
1107 typeEnvElts :: TypeEnv -> [TyThing]
1108 typeEnvClasses :: TypeEnv -> [Class]
1109 typeEnvTyCons :: TypeEnv -> [TyCon]
1110 typeEnvIds :: TypeEnv -> [Id]
1111 typeEnvDataCons :: TypeEnv -> [DataCon]
1112 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
1114 emptyTypeEnv = emptyNameEnv
1115 typeEnvElts env = nameEnvElts env
1116 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
1117 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
1118 typeEnvIds env = [id | AnId id <- typeEnvElts env]
1119 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
1121 mkTypeEnv :: [TyThing] -> TypeEnv
1122 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1124 lookupTypeEnv = lookupNameEnv
1126 -- Extend the type environment
1127 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
1128 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
1130 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
1131 extendTypeEnvList env things = foldl extendTypeEnv env things
1135 -- | Find the 'TyThing' for the given 'Name' by using all the resources
1136 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
1137 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
1138 -- that this does NOT look up the 'TyThing' in the module being compiled: you
1139 -- have to do that yourself, if desired
1140 lookupType :: DynFlags
1146 lookupType dflags hpt pte name
1147 -- in one-shot, we don't use the HPT
1148 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
1149 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
1150 lookupNameEnv (md_types (hm_details hm)) name
1152 = lookupNameEnv pte name
1153 where mod = ASSERT( isExternalName name ) nameModule name
1154 this_pkg = thisPackage dflags
1156 -- | As 'lookupType', but with a marginally easier-to-use interface
1157 -- if you have a 'HscEnv'
1158 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
1159 lookupTypeHscEnv hsc_env name = do
1160 eps <- readIORef (hsc_EPS hsc_env)
1161 return $! lookupType dflags hpt (eps_PTE eps) name
1163 dflags = hsc_dflags hsc_env
1164 hpt = hsc_HPT hsc_env
1168 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
1169 tyThingTyCon :: TyThing -> TyCon
1170 tyThingTyCon (ATyCon tc) = tc
1171 tyThingTyCon other = pprPanic "tyThingTyCon" (pprTyThing other)
1173 -- | Get the 'Class' from a 'TyThing' if it is a class thing. Panics otherwise
1174 tyThingClass :: TyThing -> Class
1175 tyThingClass (AClass cls) = cls
1176 tyThingClass other = pprPanic "tyThingClass" (pprTyThing other)
1178 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
1179 tyThingDataCon :: TyThing -> DataCon
1180 tyThingDataCon (ADataCon dc) = dc
1181 tyThingDataCon other = pprPanic "tyThingDataCon" (pprTyThing other)
1183 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
1184 tyThingId :: TyThing -> Id
1185 tyThingId (AnId id) = id
1186 tyThingId (ADataCon dc) = dataConWrapId dc
1187 tyThingId other = pprPanic "tyThingId" (pprTyThing other)
1190 %************************************************************************
1192 \subsection{MonadThings and friends}
1194 %************************************************************************
1197 -- | Class that abstracts out the common ability of the monads in GHC
1198 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
1199 -- a number of related convenience functions for accessing particular
1200 -- kinds of 'TyThing'
1201 class Monad m => MonadThings m where
1202 lookupThing :: Name -> m TyThing
1204 lookupId :: Name -> m Id
1205 lookupId = liftM tyThingId . lookupThing
1207 lookupDataCon :: Name -> m DataCon
1208 lookupDataCon = liftM tyThingDataCon . lookupThing
1210 lookupTyCon :: Name -> m TyCon
1211 lookupTyCon = liftM tyThingTyCon . lookupThing
1213 lookupClass :: Name -> m Class
1214 lookupClass = liftM tyThingClass . lookupThing
1218 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1219 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1220 -> (OccName -> Maybe (OccName, Fingerprint))
1221 mkIfaceHashCache pairs
1222 = \occ -> lookupOccEnv env occ
1224 env = foldr add_decl emptyOccEnv pairs
1225 add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
1227 decl_name = ifName d
1228 env1 = extendOccEnv env0 decl_name (decl_name, v)
1229 add_imp bndr env = extendOccEnv env bndr (decl_name, v)
1231 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1232 emptyIfaceHashCache _occ = Nothing
1235 %************************************************************************
1237 \subsection{Auxiliary types}
1239 %************************************************************************
1241 These types are defined here because they are mentioned in ModDetails,
1242 but they are mostly elaborated elsewhere
1245 ------------------ Warnings -------------------------
1246 -- | Warning information for a module
1248 = NoWarnings -- ^ Nothing deprecated
1249 | WarnAll WarningTxt -- ^ Whole module deprecated
1250 | WarnSome [(OccName,WarningTxt)] -- ^ Some specific things deprecated
1252 -- Only an OccName is needed because
1253 -- (1) a deprecation always applies to a binding
1254 -- defined in the module in which the deprecation appears.
1255 -- (2) deprecations are only reported outside the defining module.
1256 -- this is important because, otherwise, if we saw something like
1258 -- {-# DEPRECATED f "" #-}
1261 -- g = let f = undefined in f
1263 -- we'd need more information than an OccName to know to say something
1264 -- about the use of f in h but not the use of the locally bound f in g
1266 -- however, because we only report about deprecations from the outside,
1267 -- and a module can only export one value called f,
1268 -- an OccName suffices.
1270 -- this is in contrast with fixity declarations, where we need to map
1271 -- a Name to its fixity declaration.
1274 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
1275 mkIfaceWarnCache :: Warnings -> Name -> Maybe WarningTxt
1276 mkIfaceWarnCache NoWarnings = \_ -> Nothing
1277 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
1278 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
1280 emptyIfaceWarnCache :: Name -> Maybe WarningTxt
1281 emptyIfaceWarnCache _ = Nothing
1283 plusWarns :: Warnings -> Warnings -> Warnings
1284 plusWarns d NoWarnings = d
1285 plusWarns NoWarnings d = d
1286 plusWarns _ (WarnAll t) = WarnAll t
1287 plusWarns (WarnAll t) _ = WarnAll t
1288 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
1291 -- | A collection of 'AvailInfo' - several things that are \"available\"
1292 type Avails = [AvailInfo]
1293 -- | 'Name'd things that are available
1294 type AvailInfo = GenAvailInfo Name
1295 -- | 'RdrName'd things that are available
1296 type RdrAvailInfo = GenAvailInfo OccName
1298 -- | Records what things are "available", i.e. in scope
1299 data GenAvailInfo name = Avail name -- ^ An ordinary identifier in scope
1301 [name] -- ^ A type or class in scope. Parameters:
1303 -- 1) The name of the type or class
1305 -- 2) The available pieces of type or class.
1306 -- NB: If the type or class is itself
1307 -- to be in scope, it must be in this list.
1308 -- Thus, typically: @AvailTC Eq [Eq, ==, \/=]@
1310 -- Equality used when deciding if the interface has changed
1312 -- | The original names declared of a certain module that are exported
1313 type IfaceExport = (Module, [GenAvailInfo OccName])
1315 availsToNameSet :: [AvailInfo] -> NameSet
1316 availsToNameSet avails = foldr add emptyNameSet avails
1317 where add avail set = addListToNameSet set (availNames avail)
1319 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
1320 availsToNameEnv avails = foldr add emptyNameEnv avails
1321 where add avail env = extendNameEnvList env
1322 (zip (availNames avail) (repeat avail))
1324 -- | Just the main name made available, i.e. not the available pieces
1325 -- of type or class brought into scope by the 'GenAvailInfo'
1326 availName :: GenAvailInfo name -> name
1327 availName (Avail n) = n
1328 availName (AvailTC n _) = n
1330 -- | All names made available by the availability information
1331 availNames :: GenAvailInfo name -> [name]
1332 availNames (Avail n) = [n]
1333 availNames (AvailTC _ ns) = ns
1335 instance Outputable n => Outputable (GenAvailInfo n) where
1338 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
1339 pprAvail (Avail n) = ppr n
1340 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
1344 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
1345 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
1346 mkIfaceFixCache pairs
1347 = \n -> lookupOccEnv env n `orElse` defaultFixity
1349 env = mkOccEnv pairs
1351 emptyIfaceFixCache :: OccName -> Fixity
1352 emptyIfaceFixCache _ = defaultFixity
1354 -- | Fixity environment mapping names to their fixities
1355 type FixityEnv = NameEnv FixItem
1357 -- | Fixity information for an 'Name'. We keep the OccName in the range
1358 -- so that we can generate an interface from it
1359 data FixItem = FixItem OccName Fixity
1361 instance Outputable FixItem where
1362 ppr (FixItem occ fix) = ppr fix <+> ppr occ
1364 emptyFixityEnv :: FixityEnv
1365 emptyFixityEnv = emptyNameEnv
1367 lookupFixity :: FixityEnv -> Name -> Fixity
1368 lookupFixity env n = case lookupNameEnv env n of
1369 Just (FixItem _ fix) -> fix
1370 Nothing -> defaultFixity
1374 %************************************************************************
1376 \subsection{WhatsImported}
1378 %************************************************************************
1381 -- | Records whether a module has orphans. An \"orphan\" is one of:
1383 -- * An instance declaration in a module other than the definition
1384 -- module for one of the type constructors or classes in the instance head
1386 -- * A transformation rule in a module other than the one defining
1387 -- the function in the head of the rule
1388 type WhetherHasOrphans = Bool
1390 -- | Does this module define family instances?
1391 type WhetherHasFamInst = Bool
1393 -- | Did this module originate from a *-boot file?
1394 type IsBootInterface = Bool
1396 -- | Dependency information about modules and packages below this one
1397 -- in the import hierarchy.
1399 -- Invariant: the dependencies of a module @M@ never includes @M@.
1401 -- Invariant: none of the lists contain duplicates.
1403 = Deps { dep_mods :: [(ModuleName, IsBootInterface)]
1404 -- ^ Home-package module dependencies
1405 , dep_pkgs :: [PackageId]
1406 -- ^ External package dependencies
1407 , dep_orphs :: [Module]
1408 -- ^ Orphan modules (whether home or external pkg),
1409 -- *not* including family instance orphans as they
1410 -- are anyway included in 'dep_finsts'
1411 , dep_finsts :: [Module]
1412 -- ^ Modules that contain family instances (whether the
1413 -- instances are from the home or an external package)
1416 -- Equality used only for old/new comparison in MkIface.addVersionInfo
1418 -- See 'TcRnTypes.ImportAvails' for details on dependencies.
1420 noDependencies :: Dependencies
1421 noDependencies = Deps [] [] [] []
1423 -- | Records modules that we depend on by making a direct import from
1425 = UsagePackageModule {
1427 -- ^ External package module depended on
1428 usg_mod_hash :: Fingerprint
1429 } -- ^ Module from another package
1431 usg_mod_name :: ModuleName,
1432 -- ^ Name of the module
1433 usg_mod_hash :: Fingerprint,
1434 -- ^ Cached module fingerprint
1435 usg_entities :: [(OccName,Fingerprint)],
1436 -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
1437 -- NB: usages are for parent names only, e.g. type constructors
1438 -- but not the associated data constructors.
1439 usg_exports :: Maybe Fingerprint
1440 -- ^ Fingerprint for the export list we used to depend on this module,
1441 -- if we depend on the export list
1442 } -- ^ Module from the current package
1444 -- The export list field is (Just v) if we depend on the export list:
1445 -- i.e. we imported the module directly, whether or not we
1446 -- enumerated the things we imported, or just imported
1448 -- We need to recompile if M's exports change, because
1449 -- if the import was import M, we might now have a name clash
1450 -- in the importing module.
1451 -- if the import was import M(x) M might no longer export x
1452 -- The only way we don't depend on the export list is if we have
1454 -- And of course, for modules that aren't imported directly we don't
1455 -- depend on their export lists
1459 %************************************************************************
1461 The External Package State
1463 %************************************************************************
1466 type PackageTypeEnv = TypeEnv
1467 type PackageRuleBase = RuleBase
1468 type PackageInstEnv = InstEnv
1469 type PackageFamInstEnv = FamInstEnv
1470 type PackageVectInfo = VectInfo
1471 type PackageAnnEnv = AnnEnv
1473 -- | Information about other packages that we have slurped in by reading
1474 -- their interface files
1475 data ExternalPackageState
1477 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1478 -- ^ In OneShot mode (only), home-package modules
1479 -- accumulate in the external package state, and are
1480 -- sucked in lazily. For these home-pkg modules
1481 -- (only) we need to record which are boot modules.
1482 -- We set this field after loading all the
1483 -- explicitly-imported interfaces, but before doing
1486 -- The 'ModuleName' part is not necessary, but it's useful for
1487 -- debug prints, and it's convenient because this field comes
1488 -- direct from 'TcRnTypes.imp_dep_mods'
1490 eps_PIT :: !PackageIfaceTable,
1491 -- ^ The 'ModIface's for modules in external packages
1492 -- whose interfaces we have opened.
1493 -- The declarations in these interface files are held in the
1494 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
1495 -- fields of this record, not in the 'mi_decls' fields of the
1496 -- interface we have sucked in.
1498 -- What /is/ in the PIT is:
1502 -- * Fingerprint info
1508 -- * Deprecations and warnings
1510 eps_PTE :: !PackageTypeEnv,
1511 -- ^ Result of typechecking all the external package
1512 -- interface files we have sucked in. The domain of
1513 -- the mapping is external-package modules
1515 eps_inst_env :: !PackageInstEnv, -- ^ The total 'InstEnv' accumulated
1516 -- from all the external-package modules
1517 eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
1518 -- from all the external-package modules
1519 eps_rule_base :: !PackageRuleBase, -- ^ The total 'RuleEnv' accumulated
1520 -- from all the external-package modules
1521 eps_vect_info :: !PackageVectInfo, -- ^ The total 'VectInfo' accumulated
1522 -- from all the external-package modules
1523 eps_ann_env :: !PackageAnnEnv, -- ^ The total 'AnnEnv' accumulated
1524 -- from all the external-package modules
1526 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
1527 -- packages, keyed off the module that declared them
1529 eps_stats :: !EpsStats -- ^ Stastics about what was loaded from external packages
1532 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
1533 -- \"In\" means stuff that is just /read/ from interface files,
1534 -- \"Out\" means actually sucked in and type-checked
1535 data EpsStats = EpsStats { n_ifaces_in
1536 , n_decls_in, n_decls_out
1537 , n_rules_in, n_rules_out
1538 , n_insts_in, n_insts_out :: !Int }
1540 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1541 -- ^ Add stats for one newly-read interface
1542 addEpsInStats stats n_decls n_insts n_rules
1543 = stats { n_ifaces_in = n_ifaces_in stats + 1
1544 , n_decls_in = n_decls_in stats + n_decls
1545 , n_insts_in = n_insts_in stats + n_insts
1546 , n_rules_in = n_rules_in stats + n_rules }
1549 Names in a NameCache are always stored as a Global, and have the SrcLoc
1550 of their binding locations.
1552 Actually that's not quite right. When we first encounter the original
1553 name, we might not be at its binding site (e.g. we are reading an
1554 interface file); so we give it 'noSrcLoc' then. Later, when we find
1555 its binding site, we fix it up.
1558 -- | The NameCache makes sure that there is just one Unique assigned for
1559 -- each original name; i.e. (module-name, occ-name) pair and provides
1560 -- something of a lookup mechanism for those names.
1562 = NameCache { nsUniqs :: UniqSupply,
1563 -- ^ Supply of uniques
1564 nsNames :: OrigNameCache,
1565 -- ^ Ensures that one original name gets one unique
1566 nsIPs :: OrigIParamCache
1567 -- ^ Ensures that one implicit parameter name gets one unique
1570 -- | Per-module cache of original 'OccName's given 'Name's
1571 type OrigNameCache = ModuleEnv (OccEnv Name)
1573 -- | Module-local cache of implicit parameter 'OccName's given 'Name's
1574 type OrigIParamCache = Map (IPName OccName) (IPName Name)
1579 %************************************************************************
1581 The module graph and ModSummary type
1582 A ModSummary is a node in the compilation manager's
1583 dependency graph, and it's also passed to hscMain
1585 %************************************************************************
1588 -- | A ModuleGraph contains all the nodes from the home package (only).
1589 -- There will be a node for each source module, plus a node for each hi-boot
1592 -- The graph is not necessarily stored in topologically-sorted order. Use
1593 -- 'GHC.topSortModuleGraph' and 'Digraph.flattenSCC' to achieve this.
1594 type ModuleGraph = [ModSummary]
1596 emptyMG :: ModuleGraph
1599 -- | A single node in a 'ModuleGraph. The nodes of the module graph are one of:
1601 -- * A regular Haskell source module
1603 -- * A hi-boot source module
1605 -- * An external-core source module
1608 ms_mod :: Module, -- ^ Identity of the module
1609 ms_hsc_src :: HscSource, -- ^ The module source either plain Haskell, hs-boot or external core
1610 ms_location :: ModLocation, -- ^ Location of the various files belonging to the module
1611 ms_hs_date :: ClockTime, -- ^ Timestamp of source file
1612 ms_obj_date :: Maybe ClockTime, -- ^ Timestamp of object, if we have one
1613 ms_srcimps :: [Located (ImportDecl RdrName)], -- ^ Source imports of the module
1614 ms_imps :: [Located (ImportDecl RdrName)], -- ^ Non-source imports of the module
1615 ms_hspp_file :: FilePath, -- ^ Filename of preprocessed source file
1616 ms_hspp_opts :: DynFlags, -- ^ Cached flags from @OPTIONS@, @INCLUDE@
1617 -- and @LANGUAGE@ pragmas in the modules source code
1618 ms_hspp_buf :: Maybe StringBuffer -- ^ The actual preprocessed source, if we have it
1621 ms_mod_name :: ModSummary -> ModuleName
1622 ms_mod_name = moduleName . ms_mod
1624 -- The ModLocation contains both the original source filename and the
1625 -- filename of the cleaned-up source file after all preprocessing has been
1626 -- done. The point is that the summariser will have to cpp/unlit/whatever
1627 -- all files anyway, and there's no point in doing this twice -- just
1628 -- park the result in a temp file, put the name of it in the location,
1629 -- and let @compile@ read from that file on the way back up.
1631 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1632 -- the ms_hs_date and imports can, of course, change
1634 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1635 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1636 msHiFilePath ms = ml_hi_file (ms_location ms)
1637 msObjFilePath ms = ml_obj_file (ms_location ms)
1639 -- | Did this 'ModSummary' originate from a hs-boot file?
1640 isBootSummary :: ModSummary -> Bool
1641 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1643 instance Outputable ModSummary where
1645 = sep [text "ModSummary {",
1646 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1647 text "ms_mod =" <+> ppr (ms_mod ms)
1648 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1649 text "ms_imps =" <+> ppr (ms_imps ms),
1650 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1654 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1655 showModMsg target recomp mod_summary
1657 hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1658 char '(', text (normalise $ msHsFilePath mod_summary) <> comma,
1660 HscInterpreted | recomp
1661 -> text "interpreted"
1662 HscNothing -> text "nothing"
1663 _ -> text (normalise $ msObjFilePath mod_summary),
1666 mod = moduleName (ms_mod mod_summary)
1667 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1671 %************************************************************************
1673 \subsection{Hpc Support}
1675 %************************************************************************
1678 -- | Information about a modules use of Haskell Program Coverage
1681 { hpcInfoTickCount :: Int
1682 , hpcInfoHash :: Int
1685 { hpcUsed :: AnyHpcUsage -- ^ Is hpc used anywhere on the module \*tree\*?
1688 -- | This is used to signal if one of my imports used HPC instrumentation
1689 -- even if there is no module-local HPC usage
1690 type AnyHpcUsage = Bool
1692 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
1693 emptyHpcInfo = NoHpcInfo
1695 -- | Find out if HPC is used by this module or any of the modules
1697 isHpcUsed :: HpcInfo -> AnyHpcUsage
1698 isHpcUsed (HpcInfo {}) = True
1699 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
1702 %************************************************************************
1704 \subsection{Vectorisation Support}
1706 %************************************************************************
1708 The following information is generated and consumed by the vectorisation
1709 subsystem. It communicates the vectorisation status of declarations from one
1712 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
1713 below? We need to know `f' when converting to IfaceVectInfo. However, during
1714 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
1715 on just the OccName easily in a Core pass.
1718 -- | Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'.
1721 vectInfoVar :: VarEnv (Var , Var ), -- ^ @(f, f_v)@ keyed on @f@
1722 vectInfoTyCon :: NameEnv (TyCon , TyCon), -- ^ @(T, T_v)@ keyed on @T@
1723 vectInfoDataCon :: NameEnv (DataCon, DataCon), -- ^ @(C, C_v)@ keyed on @C@
1724 vectInfoPADFun :: NameEnv (TyCon , Var), -- ^ @(T_v, paT)@ keyed on @T_v@
1725 vectInfoIso :: NameEnv (TyCon , Var) -- ^ @(T, isoT)@ keyed on @T@
1728 -- | Vectorisation information for 'ModIface': a slightly less low-level view
1731 ifaceVectInfoVar :: [Name],
1732 -- ^ All variables in here have a vectorised variant
1733 ifaceVectInfoTyCon :: [Name],
1734 -- ^ All 'TyCon's in here have a vectorised variant;
1735 -- the name of the vectorised variant and those of its
1736 -- data constructors are determined by 'OccName.mkVectTyConOcc'
1737 -- and 'OccName.mkVectDataConOcc'; the names of
1738 -- the isomorphisms are determined by 'OccName.mkVectIsoOcc'
1739 ifaceVectInfoTyConReuse :: [Name]
1740 -- ^ The vectorised form of all the 'TyCon's in here coincides with
1741 -- the unconverted form; the name of the isomorphisms is determined
1742 -- by 'OccName.mkVectIsoOcc'
1745 noVectInfo :: VectInfo
1746 noVectInfo = VectInfo emptyVarEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyNameEnv
1748 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
1749 plusVectInfo vi1 vi2 =
1750 VectInfo (vectInfoVar vi1 `plusVarEnv` vectInfoVar vi2)
1751 (vectInfoTyCon vi1 `plusNameEnv` vectInfoTyCon vi2)
1752 (vectInfoDataCon vi1 `plusNameEnv` vectInfoDataCon vi2)
1753 (vectInfoPADFun vi1 `plusNameEnv` vectInfoPADFun vi2)
1754 (vectInfoIso vi1 `plusNameEnv` vectInfoIso vi2)
1756 concatVectInfo :: [VectInfo] -> VectInfo
1757 concatVectInfo = foldr plusVectInfo noVectInfo
1759 noIfaceVectInfo :: IfaceVectInfo
1760 noIfaceVectInfo = IfaceVectInfo [] [] []
1763 %************************************************************************
1765 \subsection{Linkable stuff}
1767 %************************************************************************
1769 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
1770 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
1773 -- | Information we can use to dynamically link modules into the compiler
1774 data Linkable = LM {
1775 linkableTime :: ClockTime, -- ^ Time at which this linkable was built
1776 -- (i.e. when the bytecodes were produced,
1777 -- or the mod date on the files)
1778 linkableModule :: Module, -- ^ The linkable module itself
1779 linkableUnlinked :: [Unlinked]
1780 -- ^ Those files and chunks of code we have yet to link.
1782 -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
1783 -- If this list is empty, the Linkable represents a fake linkable, which
1784 -- is generated in HscNothing mode to avoid recompiling modules.
1786 -- XXX: Do items get removed from this list when they get linked?
1789 isObjectLinkable :: Linkable -> Bool
1790 isObjectLinkable l = not (null unlinked) && all isObject unlinked
1791 where unlinked = linkableUnlinked l
1792 -- A linkable with no Unlinked's is treated as a BCO. We can
1793 -- generate a linkable with no Unlinked's as a result of
1794 -- compiling a module in HscNothing mode, and this choice
1795 -- happens to work well with checkStability in module GHC.
1797 linkableObjs :: Linkable -> [FilePath]
1798 linkableObjs l = [ f | DotO f <- linkableUnlinked l ]
1800 instance Outputable Linkable where
1801 ppr (LM when_made mod unlinkeds)
1802 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
1803 $$ nest 3 (ppr unlinkeds)
1805 -------------------------------------------
1807 -- | Objects which have yet to be linked by the compiler
1809 = DotO FilePath -- ^ An object file (.o)
1810 | DotA FilePath -- ^ Static archive file (.a)
1811 | DotDLL FilePath -- ^ Dynamically linked library file (.so, .dll, .dylib)
1812 | BCOs CompiledByteCode ModBreaks -- ^ A byte-code object, lives only in memory
1815 data CompiledByteCode = CompiledByteCodeUndefined
1816 _unused :: CompiledByteCode
1817 _unused = CompiledByteCodeUndefined
1820 instance Outputable Unlinked where
1821 ppr (DotO path) = text "DotO" <+> text path
1822 ppr (DotA path) = text "DotA" <+> text path
1823 ppr (DotDLL path) = text "DotDLL" <+> text path
1825 ppr (BCOs bcos _) = text "BCOs" <+> ppr bcos
1827 ppr (BCOs _ _) = text "No byte code"
1830 -- | Is this an actual file on disk we can link in somehow?
1831 isObject :: Unlinked -> Bool
1832 isObject (DotO _) = True
1833 isObject (DotA _) = True
1834 isObject (DotDLL _) = True
1837 -- | Is this a bytecode linkable with no file on disk?
1838 isInterpretable :: Unlinked -> Bool
1839 isInterpretable = not . isObject
1841 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
1842 nameOfObject :: Unlinked -> FilePath
1843 nameOfObject (DotO fn) = fn
1844 nameOfObject (DotA fn) = fn
1845 nameOfObject (DotDLL fn) = fn
1846 nameOfObject other = pprPanic "nameOfObject" (ppr other)
1848 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
1849 byteCodeOfObject :: Unlinked -> CompiledByteCode
1850 byteCodeOfObject (BCOs bc _) = bc
1851 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)
1854 %************************************************************************
1856 \subsection{Breakpoint Support}
1858 %************************************************************************
1861 -- | Breakpoint index
1862 type BreakIndex = Int
1864 -- | All the information about the breakpoints for a given module
1867 { modBreaks_flags :: BreakArray
1868 -- ^ The array of flags, one per breakpoint,
1869 -- indicating which breakpoints are enabled.
1870 , modBreaks_locs :: !(Array BreakIndex SrcSpan)
1871 -- ^ An array giving the source span of each breakpoint.
1872 , modBreaks_vars :: !(Array BreakIndex [OccName])
1873 -- ^ An array giving the names of the free variables at each breakpoint.
1874 , modBreaks_decls :: !(Array BreakIndex [String])
1875 -- ^ An array giving the names of the declarations enclosing each breakpoint.
1878 emptyModBreaks :: ModBreaks
1879 emptyModBreaks = ModBreaks
1880 { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
1881 -- Todo: can we avoid this?
1882 , modBreaks_locs = array (0,-1) []
1883 , modBreaks_vars = array (0,-1) []
1884 , modBreaks_decls = array (0,-1) []