2 % (c) The University of Glasgow, 2006
4 \section[HscTypes]{Types for the per-module compiler}
7 -- | Types for the per-module compiler
10 Ghc(..), GhcT(..), liftGhcT,
11 GhcMonad(..), WarnLogMonad(..),
14 logWarnings, clearWarnings, hasWarnings,
15 SourceError, GhcApiError, mkSrcErr, srcErrorMessages, mkApiErr,
16 throwOneError, handleSourceError,
20 -- * Sessions and compilation state
21 Session(..), withSession, modifySession, withTempSession,
23 FinderCache, FindResult(..), ModLocationCache,
24 Target(..), TargetId(..), pprTarget, pprTargetId,
27 GhcApiCallbacks(..), withLocalCallbacks,
29 -- * Information about modules
30 ModDetails(..), emptyModDetails,
31 ModGuts(..), CoreModule(..), CgGuts(..), ForeignStubs(..),
34 ModSummary(..), ms_mod_name, showModMsg, isBootSummary,
35 msHsFilePath, msHiFilePath, msObjFilePath,
37 -- * Information about the module being compiled
38 HscSource(..), isHsBoot, hscSourceString, -- Re-exported from DriverPhases
40 -- * State relating to modules in this package
41 HomePackageTable, HomeModInfo(..), emptyHomePackageTable,
42 hptInstances, hptRules, hptVectInfo,
44 -- * State relating to known packages
45 ExternalPackageState(..), EpsStats(..), addEpsInStats,
46 PackageTypeEnv, PackageIfaceTable, emptyPackageIfaceTable,
47 lookupIfaceByModule, emptyModIface,
49 PackageInstEnv, PackageRuleBase,
55 -- * Interactive context
56 InteractiveContext(..), emptyInteractiveContext,
57 icPrintUnqual, mkPrintUnqualified, extendInteractiveContext,
58 substInteractiveContext,
61 ModIface(..), mkIfaceWarnCache, mkIfaceHashCache, mkIfaceFixCache,
65 FixityEnv, FixItem(..), lookupFixity, emptyFixityEnv,
67 -- * TyThings and type environments
69 tyThingClass, tyThingTyCon, tyThingDataCon, tyThingId,
70 implicitTyThings, isImplicitTyThing,
72 TypeEnv, lookupType, lookupTypeHscEnv, mkTypeEnv, emptyTypeEnv,
73 extendTypeEnv, extendTypeEnvList, extendTypeEnvWithIds, lookupTypeEnv,
74 typeEnvElts, typeEnvClasses, typeEnvTyCons, typeEnvIds,
80 -- * Information on imports and exports
81 WhetherHasOrphans, IsBootInterface, Usage(..),
82 Dependencies(..), noDependencies,
83 NameCache(..), OrigNameCache, OrigIParamCache,
84 Avails, availsToNameSet, availsToNameEnv, availName, availNames,
85 GenAvailInfo(..), AvailInfo, RdrAvailInfo,
89 Warnings(..), WarningTxt(..), plusWarns,
92 Linkable(..), isObjectLinkable,
93 Unlinked(..), CompiledByteCode,
94 isObject, nameOfObject, isInterpretable, byteCodeOfObject,
97 HpcInfo(..), emptyHpcInfo, isHpcUsed, AnyHpcUsage,
100 ModBreaks (..), BreakIndex, emptyModBreaks,
102 -- * Vectorisation information
103 VectInfo(..), IfaceVectInfo(..), noVectInfo, plusVectInfo,
107 #include "HsVersions.h"
110 import ByteCodeAsm ( CompiledByteCode )
111 import {-# SOURCE #-} InteractiveEval ( Resume )
118 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
121 import InstEnv ( InstEnv, Instance )
122 import FamInstEnv ( FamInstEnv, FamInst )
123 import Rules ( RuleBase )
124 import CoreSyn ( CoreBind )
132 import Class ( Class, classSelIds, classATs, classTyCon )
134 import DataCon ( DataCon, dataConImplicitIds, dataConWrapId )
135 import PrelNames ( gHC_PRIM )
136 import Packages hiding ( Version(..) )
137 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..), dopt,
139 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
140 import BasicTypes ( IPName, Fixity, defaultFixity, WarningTxt(..) )
141 import OptimizationFuel ( OptFuelState )
143 import FiniteMap ( FiniteMap )
144 import CoreSyn ( CoreRule )
145 import Maybes ( orElse, expectJust, catMaybes )
148 import SrcLoc ( SrcSpan, Located(..) )
149 import LazyUniqFM ( lookupUFM, eltsUFM, emptyUFM )
150 import UniqSupply ( UniqSupply )
152 import StringBuffer ( StringBuffer )
155 import Data.Dynamic ( Typeable )
156 import qualified Data.Dynamic as Dyn
160 import System.FilePath
161 import System.Time ( ClockTime )
163 import Data.Array ( Array, array )
165 import Control.Monad ( mplus, guard, liftM, when )
170 %************************************************************************
172 \subsection{Compilation environment}
174 %************************************************************************
178 -- | The Session is a handle to the complete state of a compilation
179 -- session. A compilation session consists of a set of modules
180 -- constituting the current program or library, the context for
181 -- interactive evaluation, and various caches.
182 data Session = Session !(IORef HscEnv) !(IORef WarningMessages)
184 mkSrcErr :: ErrorMessages -> SourceError
185 srcErrorMessages :: SourceError -> ErrorMessages
186 mkApiErr :: SDoc -> GhcApiError
188 throwOneError :: MonadIO m => ErrMsg -> m ab
189 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
191 -- | A source error is an error that is caused by one or more errors in the
192 -- source code. A 'SourceError' is thrown by many functions in the
193 -- compilation pipeline. Inside GHC these errors are merely printed via
194 -- 'log_action', but API clients may treat them differently, for example,
195 -- insert them into a list box. If you want the default behaviour, use the
198 -- > handleSourceError printExceptionAndWarnings $ do
199 -- > ... api calls that may fail ...
201 -- The 'SourceError's error messages can be accessed via 'srcErrorMessages'.
202 -- This list may be empty if the compiler failed due to @-Werror@
203 -- ('Opt_WarnIsError').
205 -- See 'printExceptionAndWarnings' for more information on what to take care
206 -- of when writing a custom error handler.
207 data SourceError = SourceError ErrorMessages
209 instance Show SourceError where
210 show (SourceError msgs) = unlines . map show . bagToList $ msgs
211 -- ToDo: is there some nicer way to print this?
213 sourceErrorTc :: Dyn.TyCon
214 sourceErrorTc = Dyn.mkTyCon "SourceError"
215 {-# NOINLINE sourceErrorTc #-}
216 instance Typeable SourceError where
217 typeOf _ = Dyn.mkTyConApp sourceErrorTc []
219 instance Exception SourceError
221 mkSrcErr = SourceError
223 -- | Perform the given action and call the exception handler if the action
224 -- throws a 'SourceError'. See 'SourceError' for more information.
225 handleSourceError :: (ExceptionMonad m) =>
226 (SourceError -> m a) -- ^ exception handler
227 -> m a -- ^ action to perform
229 handleSourceError handler act =
230 gcatch act (\(e :: SourceError) -> handler e)
232 srcErrorMessages (SourceError msgs) = msgs
234 -- | XXX: what exactly is an API error?
235 data GhcApiError = GhcApiError SDoc
237 instance Show GhcApiError where
238 show (GhcApiError msg) = showSDoc msg
240 ghcApiErrorTc :: Dyn.TyCon
241 ghcApiErrorTc = Dyn.mkTyCon "GhcApiError"
242 {-# NOINLINE ghcApiErrorTc #-}
243 instance Typeable GhcApiError where
244 typeOf _ = Dyn.mkTyConApp ghcApiErrorTc []
246 instance Exception GhcApiError
248 mkApiErr = GhcApiError
250 -- | A monad that allows logging of warnings.
251 class Monad m => WarnLogMonad m where
252 setWarnings :: WarningMessages -> m ()
253 getWarnings :: m WarningMessages
255 logWarnings :: WarnLogMonad m => WarningMessages -> m ()
256 logWarnings warns = do
257 warns0 <- getWarnings
258 setWarnings (unionBags warns warns0)
260 -- | Clear the log of 'Warnings'.
261 clearWarnings :: WarnLogMonad m => m ()
262 clearWarnings = setWarnings emptyBag
264 -- | Returns true if there were any warnings.
265 hasWarnings :: WarnLogMonad m => m Bool
266 hasWarnings = getWarnings >>= return . not . isEmptyBag
268 -- | A monad that has all the features needed by GHC API calls.
270 -- In short, a GHC monad
272 -- - allows embedding of IO actions,
274 -- - can log warnings,
276 -- - allows handling of (extensible) exceptions, and
278 -- - maintains a current session.
280 -- If you do not use 'Ghc' or 'GhcT', make sure to call 'GHC.initGhcMonad'
281 -- before any call to the GHC API functions can occur.
283 class (Functor m, MonadIO m, WarnLogMonad m, ExceptionMonad m)
285 getSession :: m HscEnv
286 setSession :: HscEnv -> m ()
288 -- | Call the argument with the current session.
289 withSession :: GhcMonad m => (HscEnv -> m a) -> m a
290 withSession f = getSession >>= f
292 -- | Set the current session to the result of applying the current session to
294 modifySession :: GhcMonad m => (HscEnv -> HscEnv) -> m ()
295 modifySession f = do h <- getSession
298 withSavedSession :: GhcMonad m => m a -> m a
299 withSavedSession m = do
300 saved_session <- getSession
301 m `gfinally` setSession saved_session
303 -- | Call an action with a temporarily modified Session.
304 withTempSession :: GhcMonad m => (HscEnv -> HscEnv) -> m a -> m a
305 withTempSession f m =
306 withSavedSession $ modifySession f >> m
308 -- | A minimal implementation of a 'GhcMonad'. If you need a custom monad,
309 -- e.g., to maintain additional state consider wrapping this monad or using
311 newtype Ghc a = Ghc { unGhc :: Session -> IO a }
313 instance Functor Ghc where
314 fmap f m = Ghc $ \s -> f `fmap` unGhc m s
316 instance Monad Ghc where
317 return a = Ghc $ \_ -> return a
318 m >>= g = Ghc $ \s -> do a <- unGhc m s; unGhc (g a) s
320 instance MonadIO Ghc where
321 liftIO ioA = Ghc $ \_ -> ioA
323 instance ExceptionMonad Ghc where
325 Ghc $ \s -> unGhc act s `gcatch` \e -> unGhc (handle e) s
326 gblock (Ghc m) = Ghc $ \s -> gblock (m s)
327 gunblock (Ghc m) = Ghc $ \s -> gunblock (m s)
329 instance WarnLogMonad Ghc where
330 setWarnings warns = Ghc $ \(Session _ wref) -> writeIORef wref warns
331 -- | Return 'Warnings' accumulated so far.
332 getWarnings = Ghc $ \(Session _ wref) -> readIORef wref
334 instance GhcMonad Ghc where
335 getSession = Ghc $ \(Session r _) -> readIORef r
336 setSession s' = Ghc $ \(Session r _) -> writeIORef r s'
338 -- | A monad transformer to add GHC specific features to another monad.
340 -- Note that the wrapped monad must support IO and handling of exceptions.
341 newtype GhcT m a = GhcT { unGhcT :: Session -> m a }
342 liftGhcT :: Monad m => m a -> GhcT m a
343 liftGhcT m = GhcT $ \_ -> m
345 instance Functor m => Functor (GhcT m) where
346 fmap f m = GhcT $ \s -> f `fmap` unGhcT m s
348 instance Monad m => Monad (GhcT m) where
349 return x = GhcT $ \_ -> return x
350 m >>= k = GhcT $ \s -> do a <- unGhcT m s; unGhcT (k a) s
352 instance MonadIO m => MonadIO (GhcT m) where
353 liftIO ioA = GhcT $ \_ -> liftIO ioA
355 instance ExceptionMonad m => ExceptionMonad (GhcT m) where
357 GhcT $ \s -> unGhcT act s `gcatch` \e -> unGhcT (handle e) s
358 gblock (GhcT m) = GhcT $ \s -> gblock (m s)
359 gunblock (GhcT m) = GhcT $ \s -> gunblock (m s)
361 instance MonadIO m => WarnLogMonad (GhcT m) where
362 setWarnings warns = GhcT $ \(Session _ wref) -> liftIO $ writeIORef wref warns
363 -- | Return 'Warnings' accumulated so far.
364 getWarnings = GhcT $ \(Session _ wref) -> liftIO $ readIORef wref
366 instance (Functor m, ExceptionMonad m, MonadIO m) => GhcMonad (GhcT m) where
367 getSession = GhcT $ \(Session r _) -> liftIO $ readIORef r
368 setSession s' = GhcT $ \(Session r _) -> liftIO $ writeIORef r s'
370 -- | Lift an IO action returning errors messages into a 'GhcMonad'.
372 -- In order to reduce dependencies to other parts of the compiler, functions
373 -- outside the "main" parts of GHC return warnings and errors as a parameter
374 -- and signal success via by wrapping the result in a 'Maybe' type. This
375 -- function logs the returned warnings and propagates errors as exceptions
376 -- (of type 'SourceError').
378 -- This function assumes the following invariants:
380 -- 1. If the second result indicates success (is of the form 'Just x'),
381 -- there must be no error messages in the first result.
383 -- 2. If there are no error messages, but the second result indicates failure
384 -- there should be warnings in the first result. That is, if the action
385 -- failed, it must have been due to the warnings (i.e., @-Werror@).
386 ioMsgMaybe :: GhcMonad m =>
387 IO (Messages, Maybe a) -> m a
389 ((warns,errs), mb_r) <- liftIO ioA
392 Nothing -> liftIO $ throwIO (mkSrcErr errs)
393 Just r -> ASSERT( isEmptyBag errs ) return r
395 -- | Lift a non-failing IO action into a 'GhcMonad'.
397 -- Like 'ioMsgMaybe', but assumes that the action will never return any error
399 ioMsg :: GhcMonad m => IO (Messages, a) -> m a
401 ((warns,errs), r) <- liftIO ioA
403 ASSERT( isEmptyBag errs ) return r
405 -- | Reflect a computation in the 'Ghc' monad into the 'IO' monad.
407 -- You can use this to call functions returning an action in the 'Ghc' monad
408 -- inside an 'IO' action. This is needed for some (too restrictive) callback
409 -- arguments of some library functions:
411 -- > libFunc :: String -> (Int -> IO a) -> IO a
412 -- > ghcFunc :: Int -> Ghc a
414 -- > ghcFuncUsingLibFunc :: String -> Ghc a -> Ghc a
415 -- > ghcFuncUsingLibFunc str =
416 -- > reifyGhc $ \s ->
417 -- > libFunc $ \i -> do
418 -- > reflectGhc (ghcFunc i) s
420 reflectGhc :: Ghc a -> Session -> IO a
421 reflectGhc m = unGhc m
423 -- > Dual to 'reflectGhc'. See its documentation.
424 reifyGhc :: (Session -> IO a) -> Ghc a
425 reifyGhc act = Ghc $ act
427 handleFlagWarnings :: GhcMonad m => DynFlags -> [Located String] -> m ()
428 handleFlagWarnings dflags warns
429 = when (dopt Opt_WarnDeprecatedFlags dflags)
430 (handleFlagWarnings' dflags warns)
432 handleFlagWarnings' :: GhcMonad m => DynFlags -> [Located String] -> m ()
433 handleFlagWarnings' _ [] = return ()
434 handleFlagWarnings' dflags warns
435 = do -- It would be nicer if warns :: [Located Message], but that has circular
437 logWarnings $ listToBag (map mkFlagWarning warns)
438 when (dopt Opt_WarnIsError dflags) $
439 liftIO $ throwIO $ mkSrcErr emptyBag
441 mkFlagWarning :: Located String -> WarnMsg
442 mkFlagWarning (L loc warn)
443 = mkPlainWarnMsg loc (text warn)
447 -- | These functions are called in various places of the GHC API.
449 -- API clients can override any of these callbacks to change GHC's default
454 -- | Called by 'load' after the compilating of each module.
456 -- The default implementation simply prints all warnings and errors to
457 -- @stderr@. Don't forget to call 'clearWarnings' when implementing your
460 -- The first argument is the module that was compiled.
462 -- The second argument is @Nothing@ if no errors occured, but there may
463 -- have been warnings. If it is @Just err@ at least one error has
464 -- occured. If 'srcErrorMessages' is empty, compilation failed due to
466 reportModuleCompilationResult :: GhcMonad m =>
467 ModSummary -> Maybe SourceError
471 -- | Temporarily modify the callbacks. After the action is executed all
472 -- callbacks are reset (not, however, any other modifications to the session
474 withLocalCallbacks :: GhcMonad m =>
475 (GhcApiCallbacks -> GhcApiCallbacks)
477 withLocalCallbacks f m = do
478 hsc_env <- getSession
479 let cb0 = hsc_callbacks hsc_env
481 setSession (hsc_env { hsc_callbacks = cb' `seq` cb' })
483 setSession (hsc_env { hsc_callbacks = cb0 })
489 -- | Hscenv is like 'Session', except that some of the fields are immutable.
490 -- An HscEnv is used to compile a single module from plain Haskell source
491 -- code (after preprocessing) to either C, assembly or C--. Things like
492 -- the module graph don't change during a single compilation.
494 -- Historical note: \"hsc\" used to be the name of the compiler binary,
495 -- when there was a separate driver and compiler. To compile a single
496 -- module, the driver would invoke hsc on the source code... so nowadays
497 -- we think of hsc as the layer of the compiler that deals with compiling
501 hsc_dflags :: DynFlags,
502 -- ^ The dynamic flag settings
504 hsc_callbacks :: GhcApiCallbacks,
505 -- ^ Callbacks for the GHC API.
507 hsc_targets :: [Target],
508 -- ^ The targets (or roots) of the current session
510 hsc_mod_graph :: ModuleGraph,
511 -- ^ The module graph of the current session
513 hsc_IC :: InteractiveContext,
514 -- ^ The context for evaluating interactive statements
516 hsc_HPT :: HomePackageTable,
517 -- ^ The home package table describes already-compiled
518 -- home-package modules, /excluding/ the module we
519 -- are compiling right now.
520 -- (In one-shot mode the current module is the only
521 -- home-package module, so hsc_HPT is empty. All other
522 -- modules count as \"external-package\" modules.
523 -- However, even in GHCi mode, hi-boot interfaces are
524 -- demand-loaded into the external-package table.)
526 -- 'hsc_HPT' is not mutable because we only demand-load
527 -- external packages; the home package is eagerly
528 -- loaded, module by module, by the compilation manager.
530 -- The HPT may contain modules compiled earlier by @--make@
531 -- but not actually below the current module in the dependency
534 -- (This changes a previous invariant: changed Jan 05.)
536 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
537 -- ^ Information about the currently loaded external packages.
538 -- This is mutable because packages will be demand-loaded during
539 -- a compilation run as required.
541 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
542 -- ^ As with 'hsc_EPS', this is side-effected by compiling to
543 -- reflect sucking in interface files. They cache the state of
544 -- external interface files, in effect.
546 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
547 -- ^ The cached result of performing finding in the file system
548 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
549 -- ^ This caches the location of modules, so we don't have to
550 -- search the filesystem multiple times. See also 'hsc_FC'.
552 hsc_OptFuel :: OptFuelState,
553 -- ^ Settings to control the use of \"optimization fuel\":
554 -- by limiting the number of transformations,
555 -- we can use binary search to help find compiler bugs.
557 hsc_type_env_var :: Maybe (Module, IORef TypeEnv),
558 -- ^ Used for one-shot compilation only, to initialise
559 -- the 'IfGblEnv'. See 'TcRnTypes.tcg_type_env_var' for
560 -- 'TcRunTypes.TcGblEnv'
562 hsc_global_rdr_env :: GlobalRdrEnv,
563 -- ^ A mapping from 'RdrName's that are in global scope during
564 -- the compilation of the current file to more detailed
565 -- information about those names. Not necessarily just the
566 -- names directly imported by the module being compiled!
568 hsc_global_type_env :: TypeEnv
569 -- ^ Typing information about all those things in global scope.
570 -- Not necessarily just the things directly imported by the module
574 hscEPS :: HscEnv -> IO ExternalPackageState
575 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
577 -- | A compilation target.
579 -- A target may be supplied with the actual text of the
580 -- module. If so, use this instead of the file contents (this
581 -- is for use in an IDE where the file hasn't been saved by
584 { targetId :: TargetId -- ^ module or filename
585 , targetAllowObjCode :: Bool -- ^ object code allowed?
586 , targetContents :: Maybe (StringBuffer,ClockTime)
587 -- ^ in-memory text buffer?
591 = TargetModule ModuleName
592 -- ^ A module name: search for the file
593 | TargetFile FilePath (Maybe Phase)
594 -- ^ A filename: preprocess & parse it to find the module name.
595 -- If specified, the Phase indicates how to compile this file
596 -- (which phase to start from). Nothing indicates the starting phase
597 -- should be determined from the suffix of the filename.
600 pprTarget :: Target -> SDoc
601 pprTarget (Target id obj _) =
602 (if obj then char '*' else empty) <> pprTargetId id
604 instance Outputable Target where
607 pprTargetId :: TargetId -> SDoc
608 pprTargetId (TargetModule m) = ppr m
609 pprTargetId (TargetFile f _) = text f
611 instance Outputable TargetId where
614 -- | Helps us find information about modules in the home package
615 type HomePackageTable = ModuleNameEnv HomeModInfo
616 -- Domain = modules in the home package that have been fully compiled
617 -- "home" package name cached here for convenience
619 -- | Helps us find information about modules in the imported packages
620 type PackageIfaceTable = ModuleEnv ModIface
621 -- Domain = modules in the imported packages
623 emptyHomePackageTable :: HomePackageTable
624 emptyHomePackageTable = emptyUFM
626 emptyPackageIfaceTable :: PackageIfaceTable
627 emptyPackageIfaceTable = emptyModuleEnv
629 -- | Information about modules in the package being compiled
632 hm_iface :: !ModIface,
633 -- ^ The basic loaded interface file: every loaded module has one of
634 -- these, even if it is imported from another package
635 hm_details :: !ModDetails,
636 -- ^ Extra information that has been created from the 'ModIface' for
637 -- the module, typically during typechecking
638 hm_linkable :: !(Maybe Linkable)
639 -- ^ The actual artifact we would like to link to access things in
642 -- 'hm_linkable' might be Nothing:
644 -- 1. If this is an .hs-boot module
646 -- 2. Temporarily during compilation if we pruned away
647 -- the old linkable because it was out of date.
649 -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
650 -- in the 'HomePackageTable' will be @Just@.
652 -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
653 -- 'HomeModInfo' by building a new 'ModDetails' from the old
654 -- 'ModIface' (only).
657 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
658 -- and external package module information
665 lookupIfaceByModule dflags hpt pit mod
666 | modulePackageId mod == thisPackage dflags
667 = -- The module comes from the home package, so look first
668 -- in the HPT. If it's not from the home package it's wrong to look
669 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
670 fmap hm_iface (lookupUFM hpt (moduleName mod))
671 `mplus` lookupModuleEnv pit mod
673 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
675 -- If the module does come from the home package, why do we look in the PIT as well?
676 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
677 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
678 -- module is in the PIT, namely GHC.Prim when compiling the base package.
679 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a package
680 -- of its own, but it doesn't seem worth the bother.
685 hptInstances :: HscEnv -> (ModuleName -> Bool) -> ([Instance], [FamInst])
686 -- ^ Find all the instance declarations (of classes and families) that are in
687 -- modules imported by this one, directly or indirectly, and are in the Home
688 -- Package Table. This ensures that we don't see instances from modules @--make@
689 -- compiled before this one, but which are not below this one.
690 hptInstances hsc_env want_this_module
691 = let (insts, famInsts) = unzip $ flip hptAllThings hsc_env $ \mod_info -> do
692 guard (want_this_module (moduleName (mi_module (hm_iface mod_info))))
693 let details = hm_details mod_info
694 return (md_insts details, md_fam_insts details)
695 in (concat insts, concat famInsts)
697 hptVectInfo :: HscEnv -> VectInfo
698 -- ^ Get the combined VectInfo of all modules in the home package table. In
699 -- contrast to instances and rules, we don't care whether the modules are
700 -- \"below\" us in the dependency sense. The VectInfo of those modules not \"below\"
701 -- us does not affect the compilation of the current module.
702 hptVectInfo = concatVectInfo . hptAllThings ((: []) . md_vect_info . hm_details)
704 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
705 -- ^ Get rules from modules \"below\" this one (in the dependency sense)
706 hptRules = hptSomeThingsBelowUs (md_rules . hm_details) False
709 hptAnns :: HscEnv -> Maybe [(ModuleName, IsBootInterface)] -> [Annotation]
710 -- ^ Get annotations from modules \"below\" this one (in the dependency sense)
711 hptAnns hsc_env (Just deps) = hptSomeThingsBelowUs (md_anns . hm_details) False hsc_env deps
712 hptAnns hsc_env Nothing = hptAllThings (md_anns . hm_details) hsc_env
714 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
715 hptAllThings extract hsc_env = concatMap extract (eltsUFM (hsc_HPT hsc_env))
717 hptSomeThingsBelowUs :: (HomeModInfo -> [a]) -> Bool -> HscEnv -> [(ModuleName, IsBootInterface)] -> [a]
718 -- Get things from modules \"below\" this one (in the dependency sense)
719 -- C.f Inst.hptInstances
720 hptSomeThingsBelowUs extract include_hi_boot hsc_env deps
721 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
724 hpt = hsc_HPT hsc_env
727 | -- Find each non-hi-boot module below me
728 (mod, is_boot_mod) <- deps
729 , include_hi_boot || not is_boot_mod
731 -- unsavoury: when compiling the base package with --make, we
732 -- sometimes try to look up RULES etc for GHC.Prim. GHC.Prim won't
733 -- be in the HPT, because we never compile it; it's in the EPT
734 -- instead. ToDo: clean up, and remove this slightly bogus
736 , mod /= moduleName gHC_PRIM
738 -- Look it up in the HPT
739 , let things = case lookupUFM hpt mod of
740 Just info -> extract info
741 Nothing -> pprTrace "WARNING in hptSomeThingsBelowUs" msg []
742 msg = vcat [ptext (sLit "missing module") <+> ppr mod,
743 ptext (sLit "Probable cause: out-of-date interface files")]
744 -- This really shouldn't happen, but see Trac #962
750 %************************************************************************
752 \subsection{Dealing with Annotations}
754 %************************************************************************
757 prepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv
758 -- ^ Deal with gathering annotations in from all possible places
759 -- and combining them into a single 'AnnEnv'
760 prepareAnnotations hsc_env mb_guts
761 = do { eps <- hscEPS hsc_env
762 ; let -- Extract annotations from the module being compiled if supplied one
763 mb_this_module_anns = fmap (mkAnnEnv . mg_anns) mb_guts
764 -- Extract dependencies of the module if we are supplied one,
765 -- otherwise load annotations from all home package table
766 -- entries regardless of dependency ordering.
767 home_pkg_anns = (mkAnnEnv . hptAnns hsc_env) $ fmap (dep_mods . mg_deps) mb_guts
768 other_pkg_anns = eps_ann_env eps
769 ann_env = foldl1' plusAnnEnv $ catMaybes [mb_this_module_anns,
776 %************************************************************************
778 \subsection{The Finder cache}
780 %************************************************************************
783 -- | The 'FinderCache' maps home module names to the result of
784 -- searching for that module. It records the results of searching for
785 -- modules along the search path. On @:load@, we flush the entire
786 -- contents of this cache.
788 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
789 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
791 type FinderCache = ModuleNameEnv FindResult
793 -- | The result of searching for an imported module.
795 = Found ModLocation Module
796 -- ^ The module was found
797 | NoPackage PackageId
798 -- ^ The requested package was not found
799 | FoundMultiple [PackageId]
800 -- ^ _Error_: both in multiple packages
801 | PackageHidden PackageId
802 -- ^ For an explicit source import, the package containing the module is
804 | ModuleHidden PackageId
805 -- ^ For an explicit source import, the package containing the module is
806 -- exposed, but the module itself is hidden.
807 | NotFound [FilePath] (Maybe PackageId)
808 -- ^ The module was not found, the specified places were searched
809 | NotFoundInPackage PackageId
810 -- ^ The module was not found in this package
812 -- | Cache that remembers where we found a particular module. Contains both
813 -- home modules and package modules. On @:load@, only home modules are
814 -- purged from this cache.
815 type ModLocationCache = ModuleEnv ModLocation
818 %************************************************************************
820 \subsection{Symbol tables and Module details}
822 %************************************************************************
825 -- | A 'ModIface' plus a 'ModDetails' summarises everything we know
826 -- about a compiled module. The 'ModIface' is the stuff *before* linking,
827 -- and can be written out to an interface file. The 'ModDetails is after
828 -- linking and can be completely recovered from just the 'ModIface'.
830 -- When we read an interface file, we also construct a 'ModIface' from it,
831 -- except that we explicitly make the 'mi_decls' and a few other fields empty;
832 -- as when reading we consolidate the declarations etc. into a number of indexed
833 -- maps and environments in the 'ExternalPackageState'.
836 mi_module :: !Module, -- ^ Name of the module we are for
837 mi_iface_hash :: !Fingerprint, -- ^ Hash of the whole interface
838 mi_mod_hash :: !Fingerprint, -- ^ Hash of the ABI only
840 mi_orphan :: !WhetherHasOrphans, -- ^ Whether this module has orphans
841 mi_finsts :: !WhetherHasFamInst, -- ^ Whether this module has family instances
842 mi_boot :: !IsBootInterface, -- ^ Read from an hi-boot file?
844 mi_deps :: Dependencies,
845 -- ^ The dependencies of the module, consulted for directly
846 -- imported modules only
848 -- This is consulted for directly-imported modules,
849 -- but not for anything else (hence lazy)
850 mi_usages :: [Usage],
851 -- ^ Usages; kept sorted so that it's easy to decide
852 -- whether to write a new iface file (changing usages
853 -- doesn't affect the hash of this module)
855 -- NOT STRICT! we read this field lazily from the interface file
856 -- It is *only* consulted by the recompilation checker
859 -- Kept sorted by (mod,occ), to make version comparisons easier
860 mi_exports :: ![IfaceExport],
861 -- ^ Records the modules that are the declaration points for things
862 -- exported by this module, and the 'OccName's of those things
864 mi_exp_hash :: !Fingerprint, -- ^ Hash of export list
866 mi_fixities :: [(OccName,Fixity)],
869 -- NOT STRICT! we read this field lazily from the interface file
871 mi_warns :: Warnings,
874 -- NOT STRICT! we read this field lazily from the interface file
876 mi_anns :: [IfaceAnnotation],
879 -- NOT STRICT! we read this field lazily from the interface file
881 -- Type, class and variable declarations
882 -- The hash of an Id changes if its fixity or deprecations change
883 -- (as well as its type of course)
884 -- Ditto data constructors, class operations, except that
885 -- the hash of the parent class/tycon changes
886 mi_decls :: [(Fingerprint,IfaceDecl)], -- ^ Sorted type, variable, class etc. declarations
888 mi_globals :: !(Maybe GlobalRdrEnv),
889 -- ^ Binds all the things defined at the top level in
890 -- the /original source/ code for this module. which
891 -- is NOT the same as mi_exports, nor mi_decls (which
892 -- may contains declarations for things not actually
893 -- defined by the user). Used for GHCi and for inspecting
894 -- the contents of modules via the GHC API only.
896 -- (We need the source file to figure out the
897 -- top-level environment, if we didn't compile this module
898 -- from source then this field contains @Nothing@).
900 -- Strictly speaking this field should live in the
901 -- 'HomeModInfo', but that leads to more plumbing.
903 -- Instance declarations and rules
904 mi_insts :: [IfaceInst], -- ^ Sorted class instance
905 mi_fam_insts :: [IfaceFamInst], -- ^ Sorted family instances
906 mi_rules :: [IfaceRule], -- ^ Sorted rules
907 mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules and
908 -- class and family instances
911 mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
913 -- Cached environments for easy lookup
914 -- These are computed (lazily) from other fields
915 -- and are not put into the interface file
916 mi_warn_fn :: Name -> Maybe WarningTxt, -- ^ Cached lookup for 'mi_warns'
917 mi_fix_fn :: OccName -> Fixity, -- ^ Cached lookup for 'mi_fixities'
918 mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
919 -- ^ Cached lookup for 'mi_decls'.
920 -- The @Nothing@ in 'mi_hash_fn' means that the thing
921 -- isn't in decls. It's useful to know that when
922 -- seeing if we are up to date wrt. the old interface.
923 -- The 'OccName' is the parent of the name, if it has one.
924 mi_hpc :: !AnyHpcUsage
925 -- ^ True if this program uses Hpc at any point in the program.
928 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
929 -- for home modules only. Information relating to packages will be loaded into
930 -- global environments in 'ExternalPackageState'.
933 -- The next two fields are created by the typechecker
934 md_exports :: [AvailInfo],
935 md_types :: !TypeEnv, -- ^ Local type environment for this particular module
936 md_insts :: ![Instance], -- ^ 'DFunId's for the instances in this module
937 md_fam_insts :: ![FamInst],
938 md_rules :: ![CoreRule], -- ^ Domain may include 'Id's from other modules
939 md_anns :: ![Annotation], -- ^ Annotations present in this module: currently
940 -- they only annotate things also declared in this module
941 md_vect_info :: !VectInfo -- ^ Module vectorisation information
944 emptyModDetails :: ModDetails
945 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
951 md_vect_info = noVectInfo
954 -- | Records the modules directly imported by a module for extracting e.g. usage information
955 type ImportedMods = ModuleEnv [(ModuleName, Bool, SrcSpan)]
956 -- TODO: we are not actually using the codomain of this type at all, so it can be
957 -- replaced with ModuleEnv ()
959 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
960 -- There is only one ModGuts at any time, the one for the module
961 -- being compiled right now. Once it is compiled, a 'ModIface' and
962 -- 'ModDetails' are extracted and the ModGuts is dicarded.
965 mg_module :: !Module, -- ^ Module being compiled
966 mg_boot :: IsBootInterface, -- ^ Whether it's an hs-boot module
967 mg_exports :: ![AvailInfo], -- ^ What it exports
968 mg_deps :: !Dependencies, -- ^ What it depends on, directly or
970 mg_dir_imps :: !ImportedMods, -- ^ Directly-imported modules; used to
971 -- generate initialisation code
972 mg_used_names:: !NameSet, -- ^ What the module needed (used in 'MkIface.mkIface')
974 mg_rdr_env :: !GlobalRdrEnv, -- ^ Top-level lexical environment
976 -- These fields all describe the things **declared in this module**
977 mg_fix_env :: !FixityEnv, -- ^ Fixities declared in this module
978 -- TODO: I'm unconvinced this is actually used anywhere
979 mg_types :: !TypeEnv, -- ^ Types declared in this module
980 mg_insts :: ![Instance], -- ^ Class instances declared in this module
981 mg_fam_insts :: ![FamInst], -- ^ Family instances declared in this module
982 mg_rules :: ![CoreRule], -- ^ Before the core pipeline starts, contains
983 -- rules declared in this module. After the core
984 -- pipeline starts, it is changed to contain all
985 -- known rules for those things imported
986 mg_binds :: ![CoreBind], -- ^ Bindings for this module
987 mg_foreign :: !ForeignStubs, -- ^ Foreign exports declared in this module
988 mg_warns :: !Warnings, -- ^ Warnings declared in the module
989 mg_anns :: [Annotation], -- ^ Annotations declared in this module
990 mg_hpc_info :: !HpcInfo, -- ^ Coverage tick boxes in the module
991 mg_modBreaks :: !ModBreaks, -- ^ Breakpoints for the module
992 mg_vect_info :: !VectInfo, -- ^ Pool of vectorised declarations in the module
994 -- The next two fields are unusual, because they give instance
995 -- environments for *all* modules in the home package, including
996 -- this module, rather than for *just* this module.
997 -- Reason: when looking up an instance we don't want to have to
998 -- look at each module in the home package in turn
999 mg_inst_env :: InstEnv,
1000 -- ^ Class instance environment from /home-package/ modules (including
1001 -- this one); c.f. 'tcg_inst_env'
1002 mg_fam_inst_env :: FamInstEnv
1003 -- ^ Type-family instance enviroment for /home-package/ modules
1004 -- (including this one); c.f. 'tcg_fam_inst_env'
1007 -- The ModGuts takes on several slightly different forms:
1009 -- After simplification, the following fields change slightly:
1010 -- mg_rules Orphan rules only (local ones now attached to binds)
1011 -- mg_binds With rules attached
1013 -- | A CoreModule consists of just the fields of a 'ModGuts' that are needed for
1014 -- the 'GHC.compileToCoreModule' interface.
1018 cm_module :: !Module,
1019 -- | Type environment for types declared in this module
1020 cm_types :: !TypeEnv,
1022 cm_binds :: [CoreBind],
1024 cm_imports :: ![Module]
1027 instance Outputable CoreModule where
1028 ppr (CoreModule {cm_module = mn, cm_types = te, cm_binds = cb}) =
1029 text "%module" <+> ppr mn <+> ppr te $$ vcat (map ppr cb)
1031 -- The ModGuts takes on several slightly different forms:
1033 -- After simplification, the following fields change slightly:
1034 -- mg_rules Orphan rules only (local ones now attached to binds)
1035 -- mg_binds With rules attached
1038 ---------------------------------------------------------
1039 -- The Tidy pass forks the information about this module:
1040 -- * one lot goes to interface file generation (ModIface)
1041 -- and later compilations (ModDetails)
1042 -- * the other lot goes to code generation (CgGuts)
1044 -- | A restricted form of 'ModGuts' for code generation purposes
1047 cg_module :: !Module, -- ^ Module being compiled
1049 cg_tycons :: [TyCon],
1050 -- ^ Algebraic data types (including ones that started
1051 -- life as classes); generate constructors and info
1052 -- tables. Includes newtypes, just for the benefit of
1055 cg_binds :: [CoreBind],
1056 -- ^ The tidied main bindings, including
1057 -- previously-implicit bindings for record and class
1058 -- selectors, and data construtor wrappers. But *not*
1059 -- data constructor workers; reason: we we regard them
1060 -- as part of the code-gen of tycons
1062 cg_dir_imps :: ![Module],
1063 -- ^ Directly-imported modules; used to generate
1064 -- initialisation code
1066 cg_foreign :: !ForeignStubs, -- ^ Foreign export stubs
1067 cg_dep_pkgs :: ![PackageId], -- ^ Dependent packages, used to
1068 -- generate #includes for C code gen
1069 cg_hpc_info :: !HpcInfo, -- ^ Program coverage tick box information
1070 cg_modBreaks :: !ModBreaks -- ^ Module breakpoints
1073 -----------------------------------
1074 -- | Foreign export stubs
1075 data ForeignStubs = NoStubs -- ^ We don't have any stubs
1079 -- ^ There are some stubs. Parameters:
1081 -- 1) Header file prototypes for
1082 -- "foreign exported" functions
1084 -- 2) C stubs to use when calling
1085 -- "foreign exported" functions
1089 emptyModIface :: Module -> ModIface
1091 = ModIface { mi_module = mod,
1092 mi_iface_hash = fingerprint0,
1093 mi_mod_hash = fingerprint0,
1097 mi_deps = noDependencies,
1100 mi_exp_hash = fingerprint0,
1102 mi_warns = NoWarnings,
1108 mi_globals = Nothing,
1109 mi_orphan_hash = fingerprint0,
1110 mi_vect_info = noIfaceVectInfo,
1111 mi_warn_fn = emptyIfaceWarnCache,
1112 mi_fix_fn = emptyIfaceFixCache,
1113 mi_hash_fn = emptyIfaceHashCache,
1119 %************************************************************************
1121 \subsection{The interactive context}
1123 %************************************************************************
1126 -- | Interactive context, recording information relevant to GHCi
1127 data InteractiveContext
1128 = InteractiveContext {
1129 ic_toplev_scope :: [Module], -- ^ The context includes the "top-level" scope of
1132 ic_exports :: [Module], -- ^ The context includes just the exports of these
1135 ic_rn_gbl_env :: GlobalRdrEnv, -- ^ The contexts' cached 'GlobalRdrEnv', built from
1136 -- 'ic_toplev_scope' and 'ic_exports'
1138 ic_tmp_ids :: [Id], -- ^ Names bound during interaction with the user.
1139 -- Later Ids shadow earlier ones with the same OccName.
1141 ic_tyvars :: TyVarSet -- ^ Skolem type variables free in
1142 -- 'ic_tmp_ids'. These arise at
1143 -- breakpoints in a polymorphic
1144 -- context, where we have only partial
1145 -- type information.
1148 , ic_resume :: [Resume] -- ^ The stack of breakpoint contexts
1153 emptyInteractiveContext :: InteractiveContext
1154 emptyInteractiveContext
1155 = InteractiveContext { ic_toplev_scope = [],
1157 ic_rn_gbl_env = emptyGlobalRdrEnv,
1159 ic_tyvars = emptyVarSet
1165 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
1166 icPrintUnqual dflags ictxt = mkPrintUnqualified dflags (ic_rn_gbl_env ictxt)
1169 extendInteractiveContext
1170 :: InteractiveContext
1173 -> InteractiveContext
1174 extendInteractiveContext ictxt ids tyvars
1175 = ictxt { ic_tmp_ids = snub((ic_tmp_ids ictxt \\ ids) ++ ids),
1176 -- NB. must be this way around, because we want
1177 -- new ids to shadow existing bindings.
1178 ic_tyvars = ic_tyvars ictxt `unionVarSet` tyvars }
1179 where snub = map head . group . sort
1181 substInteractiveContext :: InteractiveContext -> TvSubst -> InteractiveContext
1182 substInteractiveContext ictxt subst | isEmptyTvSubst subst = ictxt
1183 substInteractiveContext ictxt@InteractiveContext{ic_tmp_ids=ids} subst =
1184 let ids' = map (\id -> id `setIdType` substTy subst (idType id)) ids
1185 subst_dom= varEnvKeys$ getTvSubstEnv subst
1186 subst_ran= varEnvElts$ getTvSubstEnv subst
1187 new_tvs = [ tv | Just tv <- map getTyVar_maybe subst_ran]
1188 ic_tyvars'= (`delVarSetListByKey` subst_dom)
1189 . (`extendVarSetList` new_tvs)
1191 in ictxt { ic_tmp_ids = ids'
1192 , ic_tyvars = ic_tyvars' }
1194 where delVarSetListByKey = foldl' delVarSetByKey
1197 %************************************************************************
1199 Building a PrintUnqualified
1201 %************************************************************************
1203 Deciding how to print names is pretty tricky. We are given a name
1204 P:M.T, where P is the package name, M is the defining module, and T is
1205 the occurrence name, and we have to decide in which form to display
1206 the name given a GlobalRdrEnv describing the current scope.
1208 Ideally we want to display the name in the form in which it is in
1209 scope. However, the name might not be in scope at all, and that's
1210 where it gets tricky. Here are the cases:
1212 1. T uniquely maps to P:M.T ---> "T"
1213 2. there is an X for which X.T uniquely maps to P:M.T ---> "X.T"
1214 3. there is no binding for "M.T" ---> "M.T"
1215 4. otherwise ---> "P:M.T"
1217 3 and 4 apply when P:M.T is not in scope. In these cases we want to
1218 refer to the name as "M.T", but "M.T" might mean something else in the
1219 current scope (e.g. if there's an "import X as M"), so to avoid
1220 confusion we avoid using "M.T" if there's already a binding for it.
1222 There's one further subtlety: if the module M cannot be imported
1223 because it is not exposed by any package, then we must refer to it as
1224 "P:M". This is handled by the qual_mod component of PrintUnqualified.
1227 -- | Creates some functions that work out the best ways to format
1228 -- names for the user according to a set of heuristics
1229 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
1230 mkPrintUnqualified dflags env = (qual_name, qual_mod)
1232 qual_name mod occ -- The (mod,occ) pair is the original name of the thing
1233 | [gre] <- unqual_gres, right_name gre = NameUnqual
1234 -- If there's a unique entity that's in scope unqualified with 'occ'
1235 -- AND that entity is the right one, then we can use the unqualified name
1237 | [gre] <- qual_gres = NameQual (get_qual_mod (gre_prov gre))
1240 if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
1241 then NameNotInScope1
1242 else NameNotInScope2
1244 | otherwise = panic "mkPrintUnqualified"
1246 right_name gre = nameModule_maybe (gre_name gre) == Just mod
1248 unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
1249 qual_gres = filter right_name (lookupGlobalRdrEnv env occ)
1251 get_qual_mod LocalDef = moduleName mod
1252 get_qual_mod (Imported is) = ASSERT( not (null is) ) is_as (is_decl (head is))
1254 -- we can mention a module P:M without the P: qualifier iff
1255 -- "import M" would resolve unambiguously to P:M. (if P is the
1256 -- current package we can just assume it is unqualified).
1259 | modulePackageId mod == thisPackage dflags = False
1261 | [pkgconfig] <- [pkg | (pkg,exposed_module) <- lookup,
1262 exposed pkg && exposed_module],
1263 packageConfigId pkgconfig == modulePackageId mod
1264 -- this says: we are given a module P:M, is there just one exposed package
1265 -- that exposes a module M, and is it package P?
1269 where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1273 %************************************************************************
1277 %************************************************************************
1280 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1281 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1282 -- as they just bring themselves into scope, but classes bring their
1283 -- dictionary datatype, type constructor and some selector functions into
1284 -- scope, just for a start!
1286 -- N.B. the set of TyThings returned here *must* match the set of
1287 -- names returned by LoadIface.ifaceDeclSubBndrs, in the sense that
1288 -- TyThing.getOccName should define a bijection between the two lists.
1289 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1290 -- The order of the list does not matter.
1291 implicitTyThings :: TyThing -> [TyThing]
1293 -- For data and newtype declarations:
1294 implicitTyThings (ATyCon tc) =
1295 -- fields (names of selectors)
1296 map AnId (tyConSelIds tc) ++
1297 -- (possibly) implicit coercion and family coercion
1298 -- depending on whether it's a newtype or a family instance or both
1299 implicitCoTyCon tc ++
1300 -- for each data constructor in order,
1301 -- the contructor, worker, and (possibly) wrapper
1302 concatMap (extras_plus . ADataCon) (tyConDataCons tc)
1304 implicitTyThings (AClass cl)
1305 = -- dictionary datatype:
1308 -- [recursive call:]
1309 -- (possibly) newtype coercion; definitely no family coercion here
1312 -- (no wrapper by invariant)
1313 extras_plus (ATyCon (classTyCon cl)) ++
1315 -- No extras_plus (recursive call) for the classATs, because they
1316 -- are only the family decls; they have no implicit things
1317 map ATyCon (classATs cl) ++
1318 -- superclass and operation selectors
1319 map AnId (classSelIds cl)
1321 implicitTyThings (ADataCon dc) =
1322 -- For data cons add the worker and (possibly) wrapper
1323 map AnId (dataConImplicitIds dc)
1325 implicitTyThings (AnId _) = []
1327 -- add a thing and recursive call
1328 extras_plus :: TyThing -> [TyThing]
1329 extras_plus thing = thing : implicitTyThings thing
1331 -- For newtypes and indexed data types (and both),
1332 -- add the implicit coercion tycon
1333 implicitCoTyCon :: TyCon -> [TyThing]
1335 = map ATyCon . catMaybes $ [-- Just if newtype, Nothing if not
1336 newTyConCo_maybe tc,
1337 -- Just if family instance, Nothing if not
1338 tyConFamilyCoercion_maybe tc]
1340 -- sortByOcc = sortBy (\ x -> \ y -> getOccName x < getOccName y)
1343 -- | Returns @True@ if there should be no interface-file declaration
1344 -- for this thing on its own: either it is built-in, or it is part
1345 -- of some other declaration, or it is generated implicitly by some
1346 -- other declaration.
1347 isImplicitTyThing :: TyThing -> Bool
1348 isImplicitTyThing (ADataCon _) = True
1349 isImplicitTyThing (AnId id) = isImplicitId id
1350 isImplicitTyThing (AClass _) = False
1351 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
1353 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
1354 extendTypeEnvWithIds env ids
1355 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
1358 %************************************************************************
1362 %************************************************************************
1365 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1366 -- local declarations or interface files
1367 type TypeEnv = NameEnv TyThing
1369 emptyTypeEnv :: TypeEnv
1370 typeEnvElts :: TypeEnv -> [TyThing]
1371 typeEnvClasses :: TypeEnv -> [Class]
1372 typeEnvTyCons :: TypeEnv -> [TyCon]
1373 typeEnvIds :: TypeEnv -> [Id]
1374 typeEnvDataCons :: TypeEnv -> [DataCon]
1375 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
1377 emptyTypeEnv = emptyNameEnv
1378 typeEnvElts env = nameEnvElts env
1379 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
1380 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
1381 typeEnvIds env = [id | AnId id <- typeEnvElts env]
1382 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
1384 mkTypeEnv :: [TyThing] -> TypeEnv
1385 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1387 lookupTypeEnv = lookupNameEnv
1389 -- Extend the type environment
1390 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
1391 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
1393 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
1394 extendTypeEnvList env things = foldl extendTypeEnv env things
1398 -- | Find the 'TyThing' for the given 'Name' by using all the resources
1399 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
1400 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
1401 -- that this does NOT look up the 'TyThing' in the module being compiled: you
1402 -- have to do that yourself, if desired
1403 lookupType :: DynFlags
1409 lookupType dflags hpt pte name
1410 -- in one-shot, we don't use the HPT
1411 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
1412 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
1413 lookupNameEnv (md_types (hm_details hm)) name
1415 = lookupNameEnv pte name
1416 where mod = ASSERT( isExternalName name ) nameModule name
1417 this_pkg = thisPackage dflags
1419 -- | As 'lookupType', but with a marginally easier-to-use interface
1420 -- if you have a 'HscEnv'
1421 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
1422 lookupTypeHscEnv hsc_env name = do
1423 eps <- readIORef (hsc_EPS hsc_env)
1424 return $! lookupType dflags hpt (eps_PTE eps) name
1426 dflags = hsc_dflags hsc_env
1427 hpt = hsc_HPT hsc_env
1431 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
1432 tyThingTyCon :: TyThing -> TyCon
1433 tyThingTyCon (ATyCon tc) = tc
1434 tyThingTyCon other = pprPanic "tyThingTyCon" (pprTyThing other)
1436 -- | Get the 'Class' from a 'TyThing' if it is a class thing. Panics otherwise
1437 tyThingClass :: TyThing -> Class
1438 tyThingClass (AClass cls) = cls
1439 tyThingClass other = pprPanic "tyThingClass" (pprTyThing other)
1441 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
1442 tyThingDataCon :: TyThing -> DataCon
1443 tyThingDataCon (ADataCon dc) = dc
1444 tyThingDataCon other = pprPanic "tyThingDataCon" (pprTyThing other)
1446 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
1447 tyThingId :: TyThing -> Id
1448 tyThingId (AnId id) = id
1449 tyThingId (ADataCon dc) = dataConWrapId dc
1450 tyThingId other = pprPanic "tyThingId" (pprTyThing other)
1453 %************************************************************************
1455 \subsection{MonadThings and friends}
1457 %************************************************************************
1460 -- | Class that abstracts out the common ability of the monads in GHC
1461 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
1462 -- a number of related convenience functions for accessing particular
1463 -- kinds of 'TyThing'
1464 class Monad m => MonadThings m where
1465 lookupThing :: Name -> m TyThing
1467 lookupId :: Name -> m Id
1468 lookupId = liftM tyThingId . lookupThing
1470 lookupDataCon :: Name -> m DataCon
1471 lookupDataCon = liftM tyThingDataCon . lookupThing
1473 lookupTyCon :: Name -> m TyCon
1474 lookupTyCon = liftM tyThingTyCon . lookupThing
1476 lookupClass :: Name -> m Class
1477 lookupClass = liftM tyThingClass . lookupThing
1481 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1482 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1483 -> (OccName -> Maybe (OccName, Fingerprint))
1484 mkIfaceHashCache pairs
1485 = \occ -> lookupOccEnv env occ
1487 env = foldr add_decl emptyOccEnv pairs
1488 add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
1490 decl_name = ifName d
1491 env1 = extendOccEnv env0 decl_name (decl_name, v)
1492 add_imp bndr env = extendOccEnv env bndr (decl_name, v)
1494 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1495 emptyIfaceHashCache _occ = Nothing
1498 %************************************************************************
1500 \subsection{Auxiliary types}
1502 %************************************************************************
1504 These types are defined here because they are mentioned in ModDetails,
1505 but they are mostly elaborated elsewhere
1508 ------------------ Warnings -------------------------
1509 -- | Warning information for a module
1511 = NoWarnings -- ^ Nothing deprecated
1512 | WarnAll WarningTxt -- ^ Whole module deprecated
1513 | WarnSome [(OccName,WarningTxt)] -- ^ Some specific things deprecated
1515 -- Only an OccName is needed because
1516 -- (1) a deprecation always applies to a binding
1517 -- defined in the module in which the deprecation appears.
1518 -- (2) deprecations are only reported outside the defining module.
1519 -- this is important because, otherwise, if we saw something like
1521 -- {-# DEPRECATED f "" #-}
1524 -- g = let f = undefined in f
1526 -- we'd need more information than an OccName to know to say something
1527 -- about the use of f in h but not the use of the locally bound f in g
1529 -- however, because we only report about deprecations from the outside,
1530 -- and a module can only export one value called f,
1531 -- an OccName suffices.
1533 -- this is in contrast with fixity declarations, where we need to map
1534 -- a Name to its fixity declaration.
1537 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
1538 mkIfaceWarnCache :: Warnings -> Name -> Maybe WarningTxt
1539 mkIfaceWarnCache NoWarnings = \_ -> Nothing
1540 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
1541 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
1543 emptyIfaceWarnCache :: Name -> Maybe WarningTxt
1544 emptyIfaceWarnCache _ = Nothing
1546 plusWarns :: Warnings -> Warnings -> Warnings
1547 plusWarns d NoWarnings = d
1548 plusWarns NoWarnings d = d
1549 plusWarns _ (WarnAll t) = WarnAll t
1550 plusWarns (WarnAll t) _ = WarnAll t
1551 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
1554 -- | A collection of 'AvailInfo' - several things that are \"available\"
1555 type Avails = [AvailInfo]
1556 -- | 'Name'd things that are available
1557 type AvailInfo = GenAvailInfo Name
1558 -- | 'RdrName'd things that are available
1559 type RdrAvailInfo = GenAvailInfo OccName
1561 -- | Records what things are "available", i.e. in scope
1562 data GenAvailInfo name = Avail name -- ^ An ordinary identifier in scope
1564 [name] -- ^ A type or class in scope. Parameters:
1566 -- 1) The name of the type or class
1568 -- 2) The available pieces of type or class.
1569 -- NB: If the type or class is itself
1570 -- to be in scope, it must be in this list.
1571 -- Thus, typically: @AvailTC Eq [Eq, ==, \/=]@
1573 -- Equality used when deciding if the interface has changed
1575 -- | The original names declared of a certain module that are exported
1576 type IfaceExport = (Module, [GenAvailInfo OccName])
1578 availsToNameSet :: [AvailInfo] -> NameSet
1579 availsToNameSet avails = foldr add emptyNameSet avails
1580 where add avail set = addListToNameSet set (availNames avail)
1582 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
1583 availsToNameEnv avails = foldr add emptyNameEnv avails
1584 where add avail env = extendNameEnvList env
1585 (zip (availNames avail) (repeat avail))
1587 -- | Just the main name made available, i.e. not the available pieces
1588 -- of type or class brought into scope by the 'GenAvailInfo'
1589 availName :: GenAvailInfo name -> name
1590 availName (Avail n) = n
1591 availName (AvailTC n _) = n
1593 -- | All names made available by the availability information
1594 availNames :: GenAvailInfo name -> [name]
1595 availNames (Avail n) = [n]
1596 availNames (AvailTC _ ns) = ns
1598 instance Outputable n => Outputable (GenAvailInfo n) where
1601 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
1602 pprAvail (Avail n) = ppr n
1603 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
1607 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
1608 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
1609 mkIfaceFixCache pairs
1610 = \n -> lookupOccEnv env n `orElse` defaultFixity
1612 env = mkOccEnv pairs
1614 emptyIfaceFixCache :: OccName -> Fixity
1615 emptyIfaceFixCache _ = defaultFixity
1617 -- | Fixity environment mapping names to their fixities
1618 type FixityEnv = NameEnv FixItem
1620 -- | Fixity information for an 'Name'. We keep the OccName in the range
1621 -- so that we can generate an interface from it
1622 data FixItem = FixItem OccName Fixity
1624 instance Outputable FixItem where
1625 ppr (FixItem occ fix) = ppr fix <+> ppr occ
1627 emptyFixityEnv :: FixityEnv
1628 emptyFixityEnv = emptyNameEnv
1630 lookupFixity :: FixityEnv -> Name -> Fixity
1631 lookupFixity env n = case lookupNameEnv env n of
1632 Just (FixItem _ fix) -> fix
1633 Nothing -> defaultFixity
1637 %************************************************************************
1639 \subsection{WhatsImported}
1641 %************************************************************************
1644 -- | Records whether a module has orphans. An \"orphan\" is one of:
1646 -- * An instance declaration in a module other than the definition
1647 -- module for one of the type constructors or classes in the instance head
1649 -- * A transformation rule in a module other than the one defining
1650 -- the function in the head of the rule
1651 type WhetherHasOrphans = Bool
1653 -- | Does this module define family instances?
1654 type WhetherHasFamInst = Bool
1656 -- | Did this module originate from a *-boot file?
1657 type IsBootInterface = Bool
1659 -- | Dependency information about modules and packages below this one
1660 -- in the import hierarchy.
1662 -- Invariant: the dependencies of a module @M@ never includes @M@.
1664 -- Invariant: none of the lists contain duplicates.
1666 = Deps { dep_mods :: [(ModuleName, IsBootInterface)]
1667 -- ^ Home-package module dependencies
1668 , dep_pkgs :: [PackageId]
1669 -- ^ External package dependencies
1670 , dep_orphs :: [Module]
1671 -- ^ Orphan modules (whether home or external pkg),
1672 -- *not* including family instance orphans as they
1673 -- are anyway included in 'dep_finsts'
1674 , dep_finsts :: [Module]
1675 -- ^ Modules that contain family instances (whether the
1676 -- instances are from the home or an external package)
1679 -- Equality used only for old/new comparison in MkIface.addVersionInfo
1681 -- See 'TcRnTypes.ImportAvails' for details on dependencies.
1683 noDependencies :: Dependencies
1684 noDependencies = Deps [] [] [] []
1686 -- | Records modules that we depend on by making a direct import from
1688 = UsagePackageModule {
1690 -- ^ External package module depended on
1691 usg_mod_hash :: Fingerprint
1692 } -- ^ Module from another package
1694 usg_mod_name :: ModuleName,
1695 -- ^ Name of the module
1696 usg_mod_hash :: Fingerprint,
1697 -- ^ Cached module fingerprint
1698 usg_entities :: [(OccName,Fingerprint)],
1699 -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
1700 -- NB: usages are for parent names only, e.g. type constructors
1701 -- but not the associated data constructors.
1702 usg_exports :: Maybe Fingerprint
1703 -- ^ Fingerprint for the export list we used to depend on this module,
1704 -- if we depend on the export list
1705 } -- ^ Module from the current package
1707 -- The export list field is (Just v) if we depend on the export list:
1708 -- i.e. we imported the module directly, whether or not we
1709 -- enumerated the things we imported, or just imported
1711 -- We need to recompile if M's exports change, because
1712 -- if the import was import M, we might now have a name clash
1713 -- in the importing module.
1714 -- if the import was import M(x) M might no longer export x
1715 -- The only way we don't depend on the export list is if we have
1717 -- And of course, for modules that aren't imported directly we don't
1718 -- depend on their export lists
1722 %************************************************************************
1724 The External Package State
1726 %************************************************************************
1729 type PackageTypeEnv = TypeEnv
1730 type PackageRuleBase = RuleBase
1731 type PackageInstEnv = InstEnv
1732 type PackageFamInstEnv = FamInstEnv
1733 type PackageVectInfo = VectInfo
1734 type PackageAnnEnv = AnnEnv
1736 -- | Information about other packages that we have slurped in by reading
1737 -- their interface files
1738 data ExternalPackageState
1740 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1741 -- ^ In OneShot mode (only), home-package modules
1742 -- accumulate in the external package state, and are
1743 -- sucked in lazily. For these home-pkg modules
1744 -- (only) we need to record which are boot modules.
1745 -- We set this field after loading all the
1746 -- explicitly-imported interfaces, but before doing
1749 -- The 'ModuleName' part is not necessary, but it's useful for
1750 -- debug prints, and it's convenient because this field comes
1751 -- direct from 'TcRnTypes.imp_dep_mods'
1753 eps_PIT :: !PackageIfaceTable,
1754 -- ^ The 'ModIface's for modules in external packages
1755 -- whose interfaces we have opened.
1756 -- The declarations in these interface files are held in the
1757 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
1758 -- fields of this record, not in the 'mi_decls' fields of the
1759 -- interface we have sucked in.
1761 -- What /is/ in the PIT is:
1765 -- * Fingerprint info
1771 -- * Deprecations and warnings
1773 eps_PTE :: !PackageTypeEnv,
1774 -- ^ Result of typechecking all the external package
1775 -- interface files we have sucked in. The domain of
1776 -- the mapping is external-package modules
1778 eps_inst_env :: !PackageInstEnv, -- ^ The total 'InstEnv' accumulated
1779 -- from all the external-package modules
1780 eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
1781 -- from all the external-package modules
1782 eps_rule_base :: !PackageRuleBase, -- ^ The total 'RuleEnv' accumulated
1783 -- from all the external-package modules
1784 eps_vect_info :: !PackageVectInfo, -- ^ The total 'VectInfo' accumulated
1785 -- from all the external-package modules
1786 eps_ann_env :: !PackageAnnEnv, -- ^ The total 'AnnEnv' accumulated
1787 -- from all the external-package modules
1789 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
1790 -- packages, keyed off the module that declared them
1792 eps_stats :: !EpsStats -- ^ Stastics about what was loaded from external packages
1795 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
1796 -- \"In\" means stuff that is just /read/ from interface files,
1797 -- \"Out\" means actually sucked in and type-checked
1798 data EpsStats = EpsStats { n_ifaces_in
1799 , n_decls_in, n_decls_out
1800 , n_rules_in, n_rules_out
1801 , n_insts_in, n_insts_out :: !Int }
1803 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1804 -- ^ Add stats for one newly-read interface
1805 addEpsInStats stats n_decls n_insts n_rules
1806 = stats { n_ifaces_in = n_ifaces_in stats + 1
1807 , n_decls_in = n_decls_in stats + n_decls
1808 , n_insts_in = n_insts_in stats + n_insts
1809 , n_rules_in = n_rules_in stats + n_rules }
1812 Names in a NameCache are always stored as a Global, and have the SrcLoc
1813 of their binding locations.
1815 Actually that's not quite right. When we first encounter the original
1816 name, we might not be at its binding site (e.g. we are reading an
1817 interface file); so we give it 'noSrcLoc' then. Later, when we find
1818 its binding site, we fix it up.
1821 -- | The NameCache makes sure that there is just one Unique assigned for
1822 -- each original name; i.e. (module-name, occ-name) pair and provides
1823 -- something of a lookup mechanism for those names.
1825 = NameCache { nsUniqs :: UniqSupply,
1826 -- ^ Supply of uniques
1827 nsNames :: OrigNameCache,
1828 -- ^ Ensures that one original name gets one unique
1829 nsIPs :: OrigIParamCache
1830 -- ^ Ensures that one implicit parameter name gets one unique
1833 -- | Per-module cache of original 'OccName's given 'Name's
1834 type OrigNameCache = ModuleEnv (OccEnv Name)
1836 -- | Module-local cache of implicit parameter 'OccName's given 'Name's
1837 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1842 %************************************************************************
1844 The module graph and ModSummary type
1845 A ModSummary is a node in the compilation manager's
1846 dependency graph, and it's also passed to hscMain
1848 %************************************************************************
1851 -- | A ModuleGraph contains all the nodes from the home package (only).
1852 -- There will be a node for each source module, plus a node for each hi-boot
1855 -- The graph is not necessarily stored in topologically-sorted order.
1856 type ModuleGraph = [ModSummary]
1858 emptyMG :: ModuleGraph
1861 -- | A single node in a 'ModuleGraph. The nodes of the module graph are one of:
1863 -- * A regular Haskell source module
1865 -- * A hi-boot source module
1867 -- * An external-core source module
1870 ms_mod :: Module, -- ^ Identity of the module
1871 ms_hsc_src :: HscSource, -- ^ The module source either plain Haskell, hs-boot or external core
1872 ms_location :: ModLocation, -- ^ Location of the various files belonging to the module
1873 ms_hs_date :: ClockTime, -- ^ Timestamp of source file
1874 ms_obj_date :: Maybe ClockTime, -- ^ Timestamp of object, if we have one
1875 ms_srcimps :: [Located ModuleName], -- ^ Source imports of the module
1876 ms_imps :: [Located ModuleName], -- ^ Non-source imports of the module
1877 ms_hspp_file :: FilePath, -- ^ Filename of preprocessed source file
1878 ms_hspp_opts :: DynFlags, -- ^ Cached flags from @OPTIONS@, @INCLUDE@
1879 -- and @LANGUAGE@ pragmas in the modules source code
1880 ms_hspp_buf :: Maybe StringBuffer -- ^ The actual preprocessed source, if we have it
1883 ms_mod_name :: ModSummary -> ModuleName
1884 ms_mod_name = moduleName . ms_mod
1886 -- The ModLocation contains both the original source filename and the
1887 -- filename of the cleaned-up source file after all preprocessing has been
1888 -- done. The point is that the summariser will have to cpp/unlit/whatever
1889 -- all files anyway, and there's no point in doing this twice -- just
1890 -- park the result in a temp file, put the name of it in the location,
1891 -- and let @compile@ read from that file on the way back up.
1893 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1894 -- the ms_hs_date and imports can, of course, change
1896 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1897 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1898 msHiFilePath ms = ml_hi_file (ms_location ms)
1899 msObjFilePath ms = ml_obj_file (ms_location ms)
1901 -- | Did this 'ModSummary' originate from a hs-boot file?
1902 isBootSummary :: ModSummary -> Bool
1903 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1905 instance Outputable ModSummary where
1907 = sep [text "ModSummary {",
1908 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1909 text "ms_mod =" <+> ppr (ms_mod ms)
1910 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1911 text "ms_imps =" <+> ppr (ms_imps ms),
1912 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1916 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1917 showModMsg target recomp mod_summary
1919 hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1920 char '(', text (normalise $ msHsFilePath mod_summary) <> comma,
1922 HscInterpreted | recomp
1923 -> text "interpreted"
1924 HscNothing -> text "nothing"
1925 _ -> text (normalise $ msObjFilePath mod_summary),
1928 mod = moduleName (ms_mod mod_summary)
1929 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1933 %************************************************************************
1935 \subsection{Hpc Support}
1937 %************************************************************************
1940 -- | Information about a modules use of Haskell Program Coverage
1943 { hpcInfoTickCount :: Int
1944 , hpcInfoHash :: Int
1947 { hpcUsed :: AnyHpcUsage -- ^ Is hpc used anywhere on the module \*tree\*?
1950 -- | This is used to signal if one of my imports used HPC instrumentation
1951 -- even if there is no module-local HPC usage
1952 type AnyHpcUsage = Bool
1954 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
1955 emptyHpcInfo = NoHpcInfo
1957 -- | Find out if HPC is used by this module or any of the modules
1959 isHpcUsed :: HpcInfo -> AnyHpcUsage
1960 isHpcUsed (HpcInfo {}) = True
1961 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
1964 %************************************************************************
1966 \subsection{Vectorisation Support}
1968 %************************************************************************
1970 The following information is generated and consumed by the vectorisation
1971 subsystem. It communicates the vectorisation status of declarations from one
1974 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
1975 below? We need to know `f' when converting to IfaceVectInfo. However, during
1976 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
1977 on just the OccName easily in a Core pass.
1980 -- | Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'.
1981 -- All of this information is always tidy, even in ModGuts.
1984 vectInfoVar :: VarEnv (Var , Var ), -- ^ @(f, f_v)@ keyed on @f@
1985 vectInfoTyCon :: NameEnv (TyCon , TyCon), -- ^ @(T, T_v)@ keyed on @T@
1986 vectInfoDataCon :: NameEnv (DataCon, DataCon), -- ^ @(C, C_v)@ keyed on @C@
1987 vectInfoPADFun :: NameEnv (TyCon , Var), -- ^ @(T_v, paT)@ keyed on @T_v@
1988 vectInfoIso :: NameEnv (TyCon , Var) -- ^ @(T, isoT)@ keyed on @T@
1991 -- | Vectorisation information for 'ModIface': a slightly less low-level view
1994 ifaceVectInfoVar :: [Name],
1995 -- ^ All variables in here have a vectorised variant
1996 ifaceVectInfoTyCon :: [Name],
1997 -- ^ All 'TyCon's in here have a vectorised variant;
1998 -- the name of the vectorised variant and those of its
1999 -- data constructors are determined by 'OccName.mkVectTyConOcc'
2000 -- and 'OccName.mkVectDataConOcc'; the names of
2001 -- the isomorphisms are determined by 'OccName.mkVectIsoOcc'
2002 ifaceVectInfoTyConReuse :: [Name]
2003 -- ^ The vectorised form of all the 'TyCon's in here coincides with
2004 -- the unconverted form; the name of the isomorphisms is determined
2005 -- by 'OccName.mkVectIsoOcc'
2008 noVectInfo :: VectInfo
2009 noVectInfo = VectInfo emptyVarEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyNameEnv
2011 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
2012 plusVectInfo vi1 vi2 =
2013 VectInfo (vectInfoVar vi1 `plusVarEnv` vectInfoVar vi2)
2014 (vectInfoTyCon vi1 `plusNameEnv` vectInfoTyCon vi2)
2015 (vectInfoDataCon vi1 `plusNameEnv` vectInfoDataCon vi2)
2016 (vectInfoPADFun vi1 `plusNameEnv` vectInfoPADFun vi2)
2017 (vectInfoIso vi1 `plusNameEnv` vectInfoIso vi2)
2019 concatVectInfo :: [VectInfo] -> VectInfo
2020 concatVectInfo = foldr plusVectInfo noVectInfo
2022 noIfaceVectInfo :: IfaceVectInfo
2023 noIfaceVectInfo = IfaceVectInfo [] [] []
2026 %************************************************************************
2028 \subsection{Linkable stuff}
2030 %************************************************************************
2032 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
2033 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
2036 -- | Information we can use to dynamically link modules into the compiler
2037 data Linkable = LM {
2038 linkableTime :: ClockTime, -- ^ Time at which this linkable was built
2039 -- (i.e. when the bytecodes were produced,
2040 -- or the mod date on the files)
2041 linkableModule :: Module, -- ^ The linkable module itself
2042 linkableUnlinked :: [Unlinked]
2043 -- ^ Those files and chunks of code we have yet to link.
2045 -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
2046 -- If this list is empty, the Linkable represents a fake linkable, which
2047 -- is generated in HscNothing mode to avoid recompiling modules.
2049 -- XXX: Do items get removed from this list when they get linked?
2052 isObjectLinkable :: Linkable -> Bool
2053 isObjectLinkable l = not (null unlinked) && all isObject unlinked
2054 where unlinked = linkableUnlinked l
2055 -- A linkable with no Unlinked's is treated as a BCO. We can
2056 -- generate a linkable with no Unlinked's as a result of
2057 -- compiling a module in HscNothing mode, and this choice
2058 -- happens to work well with checkStability in module GHC.
2060 instance Outputable Linkable where
2061 ppr (LM when_made mod unlinkeds)
2062 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
2063 $$ nest 3 (ppr unlinkeds)
2065 -------------------------------------------
2067 -- | Objects which have yet to be linked by the compiler
2069 = DotO FilePath -- ^ An object file (.o)
2070 | DotA FilePath -- ^ Static archive file (.a)
2071 | DotDLL FilePath -- ^ Dynamically linked library file (.so, .dll, .dylib)
2072 | BCOs CompiledByteCode ModBreaks -- ^ A byte-code object, lives only in memory
2075 data CompiledByteCode = CompiledByteCodeUndefined
2076 _unused :: CompiledByteCode
2077 _unused = CompiledByteCodeUndefined
2080 instance Outputable Unlinked where
2081 ppr (DotO path) = text "DotO" <+> text path
2082 ppr (DotA path) = text "DotA" <+> text path
2083 ppr (DotDLL path) = text "DotDLL" <+> text path
2085 ppr (BCOs bcos _) = text "BCOs" <+> ppr bcos
2087 ppr (BCOs _ _) = text "No byte code"
2090 -- | Is this an actual file on disk we can link in somehow?
2091 isObject :: Unlinked -> Bool
2092 isObject (DotO _) = True
2093 isObject (DotA _) = True
2094 isObject (DotDLL _) = True
2097 -- | Is this a bytecode linkable with no file on disk?
2098 isInterpretable :: Unlinked -> Bool
2099 isInterpretable = not . isObject
2101 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
2102 nameOfObject :: Unlinked -> FilePath
2103 nameOfObject (DotO fn) = fn
2104 nameOfObject (DotA fn) = fn
2105 nameOfObject (DotDLL fn) = fn
2106 nameOfObject other = pprPanic "nameOfObject" (ppr other)
2108 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
2109 byteCodeOfObject :: Unlinked -> CompiledByteCode
2110 byteCodeOfObject (BCOs bc _) = bc
2111 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)
2114 %************************************************************************
2116 \subsection{Breakpoint Support}
2118 %************************************************************************
2121 -- | Breakpoint index
2122 type BreakIndex = Int
2124 -- | All the information about the breakpoints for a given module
2127 { modBreaks_flags :: BreakArray
2128 -- ^ The array of flags, one per breakpoint,
2129 -- indicating which breakpoints are enabled.
2130 , modBreaks_locs :: !(Array BreakIndex SrcSpan)
2131 -- ^ An array giving the source span of each breakpoint.
2132 , modBreaks_vars :: !(Array BreakIndex [OccName])
2133 -- ^ An array giving the names of the free variables at each breakpoint.
2136 emptyModBreaks :: ModBreaks
2137 emptyModBreaks = ModBreaks
2138 { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
2139 -- Todo: can we avoid this?
2140 , modBreaks_locs = array (0,-1) []
2141 , modBreaks_vars = array (0,-1) []