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 )
119 import OccName ( OccName, OccEnv, lookupOccEnv, mkOccEnv, emptyOccEnv,
122 import InstEnv ( InstEnv, Instance )
123 import FamInstEnv ( FamInstEnv, FamInst )
124 import Rules ( RuleBase )
125 import CoreSyn ( CoreBind )
133 import Class ( Class, classSelIds, classATs, classTyCon )
135 import DataCon ( DataCon, dataConImplicitIds, dataConWrapId )
136 import PrelNames ( gHC_PRIM )
137 import Packages hiding ( Version(..) )
138 import DynFlags ( DynFlags(..), isOneShot, HscTarget (..), dopt,
140 import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, Phase )
141 import BasicTypes ( IPName, Fixity, defaultFixity, WarningTxt(..) )
142 import OptimizationFuel ( OptFuelState )
144 import FiniteMap ( FiniteMap )
145 import CoreSyn ( CoreRule )
146 import Maybes ( orElse, expectJust, catMaybes )
149 import SrcLoc ( SrcSpan, Located(..) )
150 import LazyUniqFM ( lookupUFM, eltsUFM, emptyUFM )
151 import UniqSupply ( UniqSupply )
153 import StringBuffer ( StringBuffer )
156 import Data.Dynamic ( Typeable )
157 import qualified Data.Dynamic as Dyn
161 import System.FilePath
162 import System.Time ( ClockTime )
164 import Data.Array ( Array, array )
166 import Control.Monad ( mplus, guard, liftM, when )
171 %************************************************************************
173 \subsection{Compilation environment}
175 %************************************************************************
179 -- | The Session is a handle to the complete state of a compilation
180 -- session. A compilation session consists of a set of modules
181 -- constituting the current program or library, the context for
182 -- interactive evaluation, and various caches.
183 data Session = Session !(IORef HscEnv) !(IORef WarningMessages)
185 mkSrcErr :: ErrorMessages -> SourceError
186 srcErrorMessages :: SourceError -> ErrorMessages
187 mkApiErr :: SDoc -> GhcApiError
189 throwOneError :: MonadIO m => ErrMsg -> m ab
190 throwOneError err = liftIO $ throwIO $ mkSrcErr $ unitBag err
192 -- | A source error is an error that is caused by one or more errors in the
193 -- source code. A 'SourceError' is thrown by many functions in the
194 -- compilation pipeline. Inside GHC these errors are merely printed via
195 -- 'log_action', but API clients may treat them differently, for example,
196 -- insert them into a list box. If you want the default behaviour, use the
199 -- > handleSourceError printExceptionAndWarnings $ do
200 -- > ... api calls that may fail ...
202 -- The 'SourceError's error messages can be accessed via 'srcErrorMessages'.
203 -- This list may be empty if the compiler failed due to @-Werror@
204 -- ('Opt_WarnIsError').
206 -- See 'printExceptionAndWarnings' for more information on what to take care
207 -- of when writing a custom error handler.
208 data SourceError = SourceError ErrorMessages
210 instance Show SourceError where
211 show (SourceError msgs) = unlines . map show . bagToList $ msgs
212 -- ToDo: is there some nicer way to print this?
214 sourceErrorTc :: Dyn.TyCon
215 sourceErrorTc = Dyn.mkTyCon "SourceError"
216 {-# NOINLINE sourceErrorTc #-}
217 instance Typeable SourceError where
218 typeOf _ = Dyn.mkTyConApp sourceErrorTc []
220 instance Exception SourceError
222 mkSrcErr = SourceError
224 -- | Perform the given action and call the exception handler if the action
225 -- throws a 'SourceError'. See 'SourceError' for more information.
226 handleSourceError :: (ExceptionMonad m) =>
227 (SourceError -> m a) -- ^ exception handler
228 -> m a -- ^ action to perform
230 handleSourceError handler act =
231 gcatch act (\(e :: SourceError) -> handler e)
233 srcErrorMessages (SourceError msgs) = msgs
235 -- | XXX: what exactly is an API error?
236 data GhcApiError = GhcApiError SDoc
238 instance Show GhcApiError where
239 show (GhcApiError msg) = showSDoc msg
241 ghcApiErrorTc :: Dyn.TyCon
242 ghcApiErrorTc = Dyn.mkTyCon "GhcApiError"
243 {-# NOINLINE ghcApiErrorTc #-}
244 instance Typeable GhcApiError where
245 typeOf _ = Dyn.mkTyConApp ghcApiErrorTc []
247 instance Exception GhcApiError
249 mkApiErr = GhcApiError
251 -- | A monad that allows logging of warnings.
252 class Monad m => WarnLogMonad m where
253 setWarnings :: WarningMessages -> m ()
254 getWarnings :: m WarningMessages
256 logWarnings :: WarnLogMonad m => WarningMessages -> m ()
257 logWarnings warns = do
258 warns0 <- getWarnings
259 setWarnings (unionBags warns warns0)
261 -- | Clear the log of 'Warnings'.
262 clearWarnings :: WarnLogMonad m => m ()
263 clearWarnings = setWarnings emptyBag
265 -- | Returns true if there were any warnings.
266 hasWarnings :: WarnLogMonad m => m Bool
267 hasWarnings = getWarnings >>= return . not . isEmptyBag
269 -- | A monad that has all the features needed by GHC API calls.
271 -- In short, a GHC monad
273 -- - allows embedding of IO actions,
275 -- - can log warnings,
277 -- - allows handling of (extensible) exceptions, and
279 -- - maintains a current session.
281 -- If you do not use 'Ghc' or 'GhcT', make sure to call 'GHC.initGhcMonad'
282 -- before any call to the GHC API functions can occur.
284 class (Functor m, MonadIO m, WarnLogMonad m, ExceptionMonad m)
286 getSession :: m HscEnv
287 setSession :: HscEnv -> m ()
289 -- | Call the argument with the current session.
290 withSession :: GhcMonad m => (HscEnv -> m a) -> m a
291 withSession f = getSession >>= f
293 -- | Set the current session to the result of applying the current session to
295 modifySession :: GhcMonad m => (HscEnv -> HscEnv) -> m ()
296 modifySession f = do h <- getSession
299 withSavedSession :: GhcMonad m => m a -> m a
300 withSavedSession m = do
301 saved_session <- getSession
302 m `gfinally` setSession saved_session
304 -- | Call an action with a temporarily modified Session.
305 withTempSession :: GhcMonad m => (HscEnv -> HscEnv) -> m a -> m a
306 withTempSession f m =
307 withSavedSession $ modifySession f >> m
309 -- | A minimal implementation of a 'GhcMonad'. If you need a custom monad,
310 -- e.g., to maintain additional state consider wrapping this monad or using
312 newtype Ghc a = Ghc { unGhc :: Session -> IO a }
314 instance Functor Ghc where
315 fmap f m = Ghc $ \s -> f `fmap` unGhc m s
317 instance Monad Ghc where
318 return a = Ghc $ \_ -> return a
319 m >>= g = Ghc $ \s -> do a <- unGhc m s; unGhc (g a) s
321 instance MonadIO Ghc where
322 liftIO ioA = Ghc $ \_ -> ioA
324 instance ExceptionMonad Ghc where
326 Ghc $ \s -> unGhc act s `gcatch` \e -> unGhc (handle e) s
327 gblock (Ghc m) = Ghc $ \s -> gblock (m s)
328 gunblock (Ghc m) = Ghc $ \s -> gunblock (m s)
330 instance WarnLogMonad Ghc where
331 setWarnings warns = Ghc $ \(Session _ wref) -> writeIORef wref warns
332 -- | Return 'Warnings' accumulated so far.
333 getWarnings = Ghc $ \(Session _ wref) -> readIORef wref
335 instance GhcMonad Ghc where
336 getSession = Ghc $ \(Session r _) -> readIORef r
337 setSession s' = Ghc $ \(Session r _) -> writeIORef r s'
339 -- | A monad transformer to add GHC specific features to another monad.
341 -- Note that the wrapped monad must support IO and handling of exceptions.
342 newtype GhcT m a = GhcT { unGhcT :: Session -> m a }
343 liftGhcT :: Monad m => m a -> GhcT m a
344 liftGhcT m = GhcT $ \_ -> m
346 instance Functor m => Functor (GhcT m) where
347 fmap f m = GhcT $ \s -> f `fmap` unGhcT m s
349 instance Monad m => Monad (GhcT m) where
350 return x = GhcT $ \_ -> return x
351 m >>= k = GhcT $ \s -> do a <- unGhcT m s; unGhcT (k a) s
353 instance MonadIO m => MonadIO (GhcT m) where
354 liftIO ioA = GhcT $ \_ -> liftIO ioA
356 instance ExceptionMonad m => ExceptionMonad (GhcT m) where
358 GhcT $ \s -> unGhcT act s `gcatch` \e -> unGhcT (handle e) s
359 gblock (GhcT m) = GhcT $ \s -> gblock (m s)
360 gunblock (GhcT m) = GhcT $ \s -> gunblock (m s)
362 instance MonadIO m => WarnLogMonad (GhcT m) where
363 setWarnings warns = GhcT $ \(Session _ wref) -> liftIO $ writeIORef wref warns
364 -- | Return 'Warnings' accumulated so far.
365 getWarnings = GhcT $ \(Session _ wref) -> liftIO $ readIORef wref
367 instance (Functor m, ExceptionMonad m, MonadIO m) => GhcMonad (GhcT m) where
368 getSession = GhcT $ \(Session r _) -> liftIO $ readIORef r
369 setSession s' = GhcT $ \(Session r _) -> liftIO $ writeIORef r s'
371 -- | Lift an IO action returning errors messages into a 'GhcMonad'.
373 -- In order to reduce dependencies to other parts of the compiler, functions
374 -- outside the "main" parts of GHC return warnings and errors as a parameter
375 -- and signal success via by wrapping the result in a 'Maybe' type. This
376 -- function logs the returned warnings and propagates errors as exceptions
377 -- (of type 'SourceError').
379 -- This function assumes the following invariants:
381 -- 1. If the second result indicates success (is of the form 'Just x'),
382 -- there must be no error messages in the first result.
384 -- 2. If there are no error messages, but the second result indicates failure
385 -- there should be warnings in the first result. That is, if the action
386 -- failed, it must have been due to the warnings (i.e., @-Werror@).
387 ioMsgMaybe :: GhcMonad m =>
388 IO (Messages, Maybe a) -> m a
390 ((warns,errs), mb_r) <- liftIO ioA
393 Nothing -> liftIO $ throwIO (mkSrcErr errs)
394 Just r -> ASSERT( isEmptyBag errs ) return r
396 -- | Lift a non-failing IO action into a 'GhcMonad'.
398 -- Like 'ioMsgMaybe', but assumes that the action will never return any error
400 ioMsg :: GhcMonad m => IO (Messages, a) -> m a
402 ((warns,errs), r) <- liftIO ioA
404 ASSERT( isEmptyBag errs ) return r
406 -- | Reflect a computation in the 'Ghc' monad into the 'IO' monad.
408 -- You can use this to call functions returning an action in the 'Ghc' monad
409 -- inside an 'IO' action. This is needed for some (too restrictive) callback
410 -- arguments of some library functions:
412 -- > libFunc :: String -> (Int -> IO a) -> IO a
413 -- > ghcFunc :: Int -> Ghc a
415 -- > ghcFuncUsingLibFunc :: String -> Ghc a -> Ghc a
416 -- > ghcFuncUsingLibFunc str =
417 -- > reifyGhc $ \s ->
418 -- > libFunc $ \i -> do
419 -- > reflectGhc (ghcFunc i) s
421 reflectGhc :: Ghc a -> Session -> IO a
422 reflectGhc m = unGhc m
424 -- > Dual to 'reflectGhc'. See its documentation.
425 reifyGhc :: (Session -> IO a) -> Ghc a
426 reifyGhc act = Ghc $ act
428 handleFlagWarnings :: GhcMonad m => DynFlags -> [Located String] -> m ()
429 handleFlagWarnings dflags warns
430 = when (dopt Opt_WarnDeprecatedFlags dflags)
431 (handleFlagWarnings' dflags warns)
433 handleFlagWarnings' :: GhcMonad m => DynFlags -> [Located String] -> m ()
434 handleFlagWarnings' _ [] = return ()
435 handleFlagWarnings' dflags warns
436 = do -- It would be nicer if warns :: [Located Message], but that has circular
438 logWarnings $ listToBag (map mkFlagWarning warns)
439 when (dopt Opt_WarnIsError dflags) $
440 liftIO $ throwIO $ mkSrcErr emptyBag
442 mkFlagWarning :: Located String -> WarnMsg
443 mkFlagWarning (L loc warn)
444 = mkPlainWarnMsg loc (text warn)
448 -- | These functions are called in various places of the GHC API.
450 -- API clients can override any of these callbacks to change GHC's default
455 -- | Called by 'load' after the compilating of each module.
457 -- The default implementation simply prints all warnings and errors to
458 -- @stderr@. Don't forget to call 'clearWarnings' when implementing your
461 -- The first argument is the module that was compiled.
463 -- The second argument is @Nothing@ if no errors occured, but there may
464 -- have been warnings. If it is @Just err@ at least one error has
465 -- occured. If 'srcErrorMessages' is empty, compilation failed due to
467 reportModuleCompilationResult :: GhcMonad m =>
468 ModSummary -> Maybe SourceError
472 -- | Temporarily modify the callbacks. After the action is executed all
473 -- callbacks are reset (not, however, any other modifications to the session
475 withLocalCallbacks :: GhcMonad m =>
476 (GhcApiCallbacks -> GhcApiCallbacks)
478 withLocalCallbacks f m = do
479 hsc_env <- getSession
480 let cb0 = hsc_callbacks hsc_env
482 setSession (hsc_env { hsc_callbacks = cb' `seq` cb' })
484 hsc_env' <- getSession
485 setSession (hsc_env' { hsc_callbacks = cb0 })
491 -- | Hscenv is like 'Session', except that some of the fields are immutable.
492 -- An HscEnv is used to compile a single module from plain Haskell source
493 -- code (after preprocessing) to either C, assembly or C--. Things like
494 -- the module graph don't change during a single compilation.
496 -- Historical note: \"hsc\" used to be the name of the compiler binary,
497 -- when there was a separate driver and compiler. To compile a single
498 -- module, the driver would invoke hsc on the source code... so nowadays
499 -- we think of hsc as the layer of the compiler that deals with compiling
503 hsc_dflags :: DynFlags,
504 -- ^ The dynamic flag settings
506 hsc_callbacks :: GhcApiCallbacks,
507 -- ^ Callbacks for the GHC API.
509 hsc_targets :: [Target],
510 -- ^ The targets (or roots) of the current session
512 hsc_mod_graph :: ModuleGraph,
513 -- ^ The module graph of the current session
515 hsc_IC :: InteractiveContext,
516 -- ^ The context for evaluating interactive statements
518 hsc_HPT :: HomePackageTable,
519 -- ^ The home package table describes already-compiled
520 -- home-package modules, /excluding/ the module we
521 -- are compiling right now.
522 -- (In one-shot mode the current module is the only
523 -- home-package module, so hsc_HPT is empty. All other
524 -- modules count as \"external-package\" modules.
525 -- However, even in GHCi mode, hi-boot interfaces are
526 -- demand-loaded into the external-package table.)
528 -- 'hsc_HPT' is not mutable because we only demand-load
529 -- external packages; the home package is eagerly
530 -- loaded, module by module, by the compilation manager.
532 -- The HPT may contain modules compiled earlier by @--make@
533 -- but not actually below the current module in the dependency
536 -- (This changes a previous invariant: changed Jan 05.)
538 hsc_EPS :: {-# UNPACK #-} !(IORef ExternalPackageState),
539 -- ^ Information about the currently loaded external packages.
540 -- This is mutable because packages will be demand-loaded during
541 -- a compilation run as required.
543 hsc_NC :: {-# UNPACK #-} !(IORef NameCache),
544 -- ^ As with 'hsc_EPS', this is side-effected by compiling to
545 -- reflect sucking in interface files. They cache the state of
546 -- external interface files, in effect.
548 hsc_FC :: {-# UNPACK #-} !(IORef FinderCache),
549 -- ^ The cached result of performing finding in the file system
550 hsc_MLC :: {-# UNPACK #-} !(IORef ModLocationCache),
551 -- ^ This caches the location of modules, so we don't have to
552 -- search the filesystem multiple times. See also 'hsc_FC'.
554 hsc_OptFuel :: OptFuelState,
555 -- ^ Settings to control the use of \"optimization fuel\":
556 -- by limiting the number of transformations,
557 -- we can use binary search to help find compiler bugs.
559 hsc_type_env_var :: Maybe (Module, IORef TypeEnv),
560 -- ^ Used for one-shot compilation only, to initialise
561 -- the 'IfGblEnv'. See 'TcRnTypes.tcg_type_env_var' for
562 -- 'TcRunTypes.TcGblEnv'
564 hsc_global_rdr_env :: GlobalRdrEnv,
565 -- ^ A mapping from 'RdrName's that are in global scope during
566 -- the compilation of the current file to more detailed
567 -- information about those names. Not necessarily just the
568 -- names directly imported by the module being compiled!
570 hsc_global_type_env :: TypeEnv
571 -- ^ Typing information about all those things in global scope.
572 -- Not necessarily just the things directly imported by the module
576 hscEPS :: HscEnv -> IO ExternalPackageState
577 hscEPS hsc_env = readIORef (hsc_EPS hsc_env)
579 -- | A compilation target.
581 -- A target may be supplied with the actual text of the
582 -- module. If so, use this instead of the file contents (this
583 -- is for use in an IDE where the file hasn't been saved by
586 { targetId :: TargetId -- ^ module or filename
587 , targetAllowObjCode :: Bool -- ^ object code allowed?
588 , targetContents :: Maybe (StringBuffer,ClockTime)
589 -- ^ in-memory text buffer?
593 = TargetModule ModuleName
594 -- ^ A module name: search for the file
595 | TargetFile FilePath (Maybe Phase)
596 -- ^ A filename: preprocess & parse it to find the module name.
597 -- If specified, the Phase indicates how to compile this file
598 -- (which phase to start from). Nothing indicates the starting phase
599 -- should be determined from the suffix of the filename.
602 pprTarget :: Target -> SDoc
603 pprTarget (Target id obj _) =
604 (if obj then char '*' else empty) <> pprTargetId id
606 instance Outputable Target where
609 pprTargetId :: TargetId -> SDoc
610 pprTargetId (TargetModule m) = ppr m
611 pprTargetId (TargetFile f _) = text f
613 instance Outputable TargetId where
616 -- | Helps us find information about modules in the home package
617 type HomePackageTable = ModuleNameEnv HomeModInfo
618 -- Domain = modules in the home package that have been fully compiled
619 -- "home" package name cached here for convenience
621 -- | Helps us find information about modules in the imported packages
622 type PackageIfaceTable = ModuleEnv ModIface
623 -- Domain = modules in the imported packages
625 emptyHomePackageTable :: HomePackageTable
626 emptyHomePackageTable = emptyUFM
628 emptyPackageIfaceTable :: PackageIfaceTable
629 emptyPackageIfaceTable = emptyModuleEnv
631 -- | Information about modules in the package being compiled
634 hm_iface :: !ModIface,
635 -- ^ The basic loaded interface file: every loaded module has one of
636 -- these, even if it is imported from another package
637 hm_details :: !ModDetails,
638 -- ^ Extra information that has been created from the 'ModIface' for
639 -- the module, typically during typechecking
640 hm_linkable :: !(Maybe Linkable)
641 -- ^ The actual artifact we would like to link to access things in
644 -- 'hm_linkable' might be Nothing:
646 -- 1. If this is an .hs-boot module
648 -- 2. Temporarily during compilation if we pruned away
649 -- the old linkable because it was out of date.
651 -- After a complete compilation ('GHC.load'), all 'hm_linkable' fields
652 -- in the 'HomePackageTable' will be @Just@.
654 -- When re-linking a module ('HscMain.HscNoRecomp'), we construct the
655 -- 'HomeModInfo' by building a new 'ModDetails' from the old
656 -- 'ModIface' (only).
659 -- | Find the 'ModIface' for a 'Module', searching in both the loaded home
660 -- and external package module information
667 lookupIfaceByModule dflags hpt pit mod
668 | modulePackageId mod == thisPackage dflags
669 = -- The module comes from the home package, so look first
670 -- in the HPT. If it's not from the home package it's wrong to look
671 -- in the HPT, because the HPT is indexed by *ModuleName* not Module
672 fmap hm_iface (lookupUFM hpt (moduleName mod))
673 `mplus` lookupModuleEnv pit mod
675 | otherwise = lookupModuleEnv pit mod -- Look in PIT only
677 -- If the module does come from the home package, why do we look in the PIT as well?
678 -- (a) In OneShot mode, even home-package modules accumulate in the PIT
679 -- (b) Even in Batch (--make) mode, there is *one* case where a home-package
680 -- module is in the PIT, namely GHC.Prim when compiling the base package.
681 -- We could eliminate (b) if we wanted, by making GHC.Prim belong to a package
682 -- of its own, but it doesn't seem worth the bother.
687 hptInstances :: HscEnv -> (ModuleName -> Bool) -> ([Instance], [FamInst])
688 -- ^ Find all the instance declarations (of classes and families) that are in
689 -- modules imported by this one, directly or indirectly, and are in the Home
690 -- Package Table. This ensures that we don't see instances from modules @--make@
691 -- compiled before this one, but which are not below this one.
692 hptInstances hsc_env want_this_module
693 = let (insts, famInsts) = unzip $ flip hptAllThings hsc_env $ \mod_info -> do
694 guard (want_this_module (moduleName (mi_module (hm_iface mod_info))))
695 let details = hm_details mod_info
696 return (md_insts details, md_fam_insts details)
697 in (concat insts, concat famInsts)
699 hptVectInfo :: HscEnv -> VectInfo
700 -- ^ Get the combined VectInfo of all modules in the home package table. In
701 -- contrast to instances and rules, we don't care whether the modules are
702 -- \"below\" us in the dependency sense. The VectInfo of those modules not \"below\"
703 -- us does not affect the compilation of the current module.
704 hptVectInfo = concatVectInfo . hptAllThings ((: []) . md_vect_info . hm_details)
706 hptRules :: HscEnv -> [(ModuleName, IsBootInterface)] -> [CoreRule]
707 -- ^ Get rules from modules \"below\" this one (in the dependency sense)
708 hptRules = hptSomeThingsBelowUs (md_rules . hm_details) False
711 hptAnns :: HscEnv -> Maybe [(ModuleName, IsBootInterface)] -> [Annotation]
712 -- ^ Get annotations from modules \"below\" this one (in the dependency sense)
713 hptAnns hsc_env (Just deps) = hptSomeThingsBelowUs (md_anns . hm_details) False hsc_env deps
714 hptAnns hsc_env Nothing = hptAllThings (md_anns . hm_details) hsc_env
716 hptAllThings :: (HomeModInfo -> [a]) -> HscEnv -> [a]
717 hptAllThings extract hsc_env = concatMap extract (eltsUFM (hsc_HPT hsc_env))
719 hptSomeThingsBelowUs :: (HomeModInfo -> [a]) -> Bool -> HscEnv -> [(ModuleName, IsBootInterface)] -> [a]
720 -- Get things from modules \"below\" this one (in the dependency sense)
721 -- C.f Inst.hptInstances
722 hptSomeThingsBelowUs extract include_hi_boot hsc_env deps
723 | isOneShot (ghcMode (hsc_dflags hsc_env)) = []
726 hpt = hsc_HPT hsc_env
729 | -- Find each non-hi-boot module below me
730 (mod, is_boot_mod) <- deps
731 , include_hi_boot || not is_boot_mod
733 -- unsavoury: when compiling the base package with --make, we
734 -- sometimes try to look up RULES etc for GHC.Prim. GHC.Prim won't
735 -- be in the HPT, because we never compile it; it's in the EPT
736 -- instead. ToDo: clean up, and remove this slightly bogus
738 , mod /= moduleName gHC_PRIM
740 -- Look it up in the HPT
741 , let things = case lookupUFM hpt mod of
742 Just info -> extract info
743 Nothing -> pprTrace "WARNING in hptSomeThingsBelowUs" msg []
744 msg = vcat [ptext (sLit "missing module") <+> ppr mod,
745 ptext (sLit "Probable cause: out-of-date interface files")]
746 -- This really shouldn't happen, but see Trac #962
752 %************************************************************************
754 \subsection{Dealing with Annotations}
756 %************************************************************************
759 prepareAnnotations :: HscEnv -> Maybe ModGuts -> IO AnnEnv
760 -- ^ Deal with gathering annotations in from all possible places
761 -- and combining them into a single 'AnnEnv'
762 prepareAnnotations hsc_env mb_guts
763 = do { eps <- hscEPS hsc_env
764 ; let -- Extract annotations from the module being compiled if supplied one
765 mb_this_module_anns = fmap (mkAnnEnv . mg_anns) mb_guts
766 -- Extract dependencies of the module if we are supplied one,
767 -- otherwise load annotations from all home package table
768 -- entries regardless of dependency ordering.
769 home_pkg_anns = (mkAnnEnv . hptAnns hsc_env) $ fmap (dep_mods . mg_deps) mb_guts
770 other_pkg_anns = eps_ann_env eps
771 ann_env = foldl1' plusAnnEnv $ catMaybes [mb_this_module_anns,
778 %************************************************************************
780 \subsection{The Finder cache}
782 %************************************************************************
785 -- | The 'FinderCache' maps home module names to the result of
786 -- searching for that module. It records the results of searching for
787 -- modules along the search path. On @:load@, we flush the entire
788 -- contents of this cache.
790 -- Although the @FinderCache@ range is 'FindResult' for convenience ,
791 -- in fact it will only ever contain 'Found' or 'NotFound' entries.
793 type FinderCache = ModuleNameEnv FindResult
795 -- | The result of searching for an imported module.
797 = Found ModLocation Module
798 -- ^ The module was found
799 | NoPackage PackageId
800 -- ^ The requested package was not found
801 | FoundMultiple [PackageId]
802 -- ^ _Error_: both in multiple packages
803 | NotFound [FilePath] (Maybe PackageId) [PackageId] [PackageId]
804 -- ^ The module was not found, including either
805 -- * the specified places were searched
806 -- * the package that this module should have been in
807 -- * list of packages in which the module was hidden,
808 -- * list of hidden packages containing this module
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. This is
846 -- consulted for directly-imported modules, but not
847 -- for anything else (hence lazy)
849 mi_usages :: [Usage],
850 -- ^ Usages; kept sorted so that it's easy to decide
851 -- whether to write a new iface file (changing usages
852 -- doesn't affect the hash of this module)
854 -- NOT STRICT! we read this field lazily from the interface file
855 -- It is *only* consulted by the recompilation checker
858 -- Kept sorted by (mod,occ), to make version comparisons easier
859 mi_exports :: ![IfaceExport],
860 -- ^ Records the modules that are the declaration points for things
861 -- exported by this module, and the 'OccName's of those things
863 mi_exp_hash :: !Fingerprint, -- ^ Hash of export list
865 mi_fixities :: [(OccName,Fixity)],
868 -- NOT STRICT! we read this field lazily from the interface file
870 mi_warns :: Warnings,
873 -- NOT STRICT! we read this field lazily from the interface file
875 mi_anns :: [IfaceAnnotation],
878 -- NOT STRICT! we read this field lazily from the interface file
880 -- Type, class and variable declarations
881 -- The hash of an Id changes if its fixity or deprecations change
882 -- (as well as its type of course)
883 -- Ditto data constructors, class operations, except that
884 -- the hash of the parent class/tycon changes
885 mi_decls :: [(Fingerprint,IfaceDecl)], -- ^ Sorted type, variable, class etc. declarations
887 mi_globals :: !(Maybe GlobalRdrEnv),
888 -- ^ Binds all the things defined at the top level in
889 -- the /original source/ code for this module. which
890 -- is NOT the same as mi_exports, nor mi_decls (which
891 -- may contains declarations for things not actually
892 -- defined by the user). Used for GHCi and for inspecting
893 -- the contents of modules via the GHC API only.
895 -- (We need the source file to figure out the
896 -- top-level environment, if we didn't compile this module
897 -- from source then this field contains @Nothing@).
899 -- Strictly speaking this field should live in the
900 -- 'HomeModInfo', but that leads to more plumbing.
902 -- Instance declarations and rules
903 mi_insts :: [IfaceInst], -- ^ Sorted class instance
904 mi_fam_insts :: [IfaceFamInst], -- ^ Sorted family instances
905 mi_rules :: [IfaceRule], -- ^ Sorted rules
906 mi_orphan_hash :: !Fingerprint, -- ^ Hash for orphan rules and
907 -- class and family instances
910 mi_vect_info :: !IfaceVectInfo, -- ^ Vectorisation information
912 -- Cached environments for easy lookup
913 -- These are computed (lazily) from other fields
914 -- and are not put into the interface file
915 mi_warn_fn :: Name -> Maybe WarningTxt, -- ^ Cached lookup for 'mi_warns'
916 mi_fix_fn :: OccName -> Fixity, -- ^ Cached lookup for 'mi_fixities'
917 mi_hash_fn :: OccName -> Maybe (OccName, Fingerprint),
918 -- ^ Cached lookup for 'mi_decls'.
919 -- The @Nothing@ in 'mi_hash_fn' means that the thing
920 -- isn't in decls. It's useful to know that when
921 -- seeing if we are up to date wrt. the old interface.
922 -- The 'OccName' is the parent of the name, if it has one.
923 mi_hpc :: !AnyHpcUsage
924 -- ^ True if this program uses Hpc at any point in the program.
927 -- | The 'ModDetails' is essentially a cache for information in the 'ModIface'
928 -- for home modules only. Information relating to packages will be loaded into
929 -- global environments in 'ExternalPackageState'.
932 -- The next two fields are created by the typechecker
933 md_exports :: [AvailInfo],
934 md_types :: !TypeEnv, -- ^ Local type environment for this particular module
935 md_insts :: ![Instance], -- ^ 'DFunId's for the instances in this module
936 md_fam_insts :: ![FamInst],
937 md_rules :: ![CoreRule], -- ^ Domain may include 'Id's from other modules
938 md_anns :: ![Annotation], -- ^ Annotations present in this module: currently
939 -- they only annotate things also declared in this module
940 md_vect_info :: !VectInfo -- ^ Module vectorisation information
943 emptyModDetails :: ModDetails
944 emptyModDetails = ModDetails { md_types = emptyTypeEnv,
950 md_vect_info = noVectInfo
953 -- | Records the modules directly imported by a module for extracting e.g. usage information
954 type ImportedMods = ModuleEnv [(ModuleName, Bool, SrcSpan)]
955 -- TODO: we are not actually using the codomain of this type at all, so it can be
956 -- replaced with ModuleEnv ()
958 -- | A ModGuts is carried through the compiler, accumulating stuff as it goes
959 -- There is only one ModGuts at any time, the one for the module
960 -- being compiled right now. Once it is compiled, a 'ModIface' and
961 -- 'ModDetails' are extracted and the ModGuts is dicarded.
964 mg_module :: !Module, -- ^ Module being compiled
965 mg_boot :: IsBootInterface, -- ^ Whether it's an hs-boot module
966 mg_exports :: ![AvailInfo], -- ^ What it exports
967 mg_deps :: !Dependencies, -- ^ What it depends on, directly or
969 mg_dir_imps :: !ImportedMods, -- ^ Directly-imported modules; used to
970 -- generate initialisation code
971 mg_used_names:: !NameSet, -- ^ What the module needed (used in 'MkIface.mkIface')
973 mg_rdr_env :: !GlobalRdrEnv, -- ^ Top-level lexical environment
975 -- These fields all describe the things **declared in this module**
976 mg_fix_env :: !FixityEnv, -- ^ Fixities declared in this module
977 -- TODO: I'm unconvinced this is actually used anywhere
978 mg_types :: !TypeEnv, -- ^ Types declared in this module
979 mg_insts :: ![Instance], -- ^ Class instances declared in this module
980 mg_fam_insts :: ![FamInst], -- ^ Family instances declared in this module
981 mg_rules :: ![CoreRule], -- ^ Before the core pipeline starts, contains
982 -- rules declared in this module. After the core
983 -- pipeline starts, it is changed to contain all
984 -- known rules for those things imported
985 mg_binds :: ![CoreBind], -- ^ Bindings for this module
986 mg_foreign :: !ForeignStubs, -- ^ Foreign exports declared in this module
987 mg_warns :: !Warnings, -- ^ Warnings declared in the module
988 mg_anns :: [Annotation], -- ^ Annotations declared in this module
989 mg_hpc_info :: !HpcInfo, -- ^ Coverage tick boxes in the module
990 mg_modBreaks :: !ModBreaks, -- ^ Breakpoints for the module
991 mg_vect_info :: !VectInfo, -- ^ Pool of vectorised declarations in the module
993 -- The next two fields are unusual, because they give instance
994 -- environments for *all* modules in the home package, including
995 -- this module, rather than for *just* this module.
996 -- Reason: when looking up an instance we don't want to have to
997 -- look at each module in the home package in turn
998 mg_inst_env :: InstEnv,
999 -- ^ Class instance environment from /home-package/ modules (including
1000 -- this one); c.f. 'tcg_inst_env'
1001 mg_fam_inst_env :: FamInstEnv
1002 -- ^ Type-family instance enviroment for /home-package/ modules
1003 -- (including this one); c.f. 'tcg_fam_inst_env'
1006 -- The ModGuts takes on several slightly different forms:
1008 -- After simplification, the following fields change slightly:
1009 -- mg_rules Orphan rules only (local ones now attached to binds)
1010 -- mg_binds With rules attached
1012 -- | A CoreModule consists of just the fields of a 'ModGuts' that are needed for
1013 -- the 'GHC.compileToCoreModule' interface.
1017 cm_module :: !Module,
1018 -- | Type environment for types declared in this module
1019 cm_types :: !TypeEnv,
1021 cm_binds :: [CoreBind],
1023 cm_imports :: ![Module]
1026 instance Outputable CoreModule where
1027 ppr (CoreModule {cm_module = mn, cm_types = te, cm_binds = cb}) =
1028 text "%module" <+> ppr mn <+> ppr te $$ vcat (map ppr cb)
1030 -- The ModGuts takes on several slightly different forms:
1032 -- After simplification, the following fields change slightly:
1033 -- mg_rules Orphan rules only (local ones now attached to binds)
1034 -- mg_binds With rules attached
1037 ---------------------------------------------------------
1038 -- The Tidy pass forks the information about this module:
1039 -- * one lot goes to interface file generation (ModIface)
1040 -- and later compilations (ModDetails)
1041 -- * the other lot goes to code generation (CgGuts)
1043 -- | A restricted form of 'ModGuts' for code generation purposes
1046 cg_module :: !Module, -- ^ Module being compiled
1048 cg_tycons :: [TyCon],
1049 -- ^ Algebraic data types (including ones that started
1050 -- life as classes); generate constructors and info
1051 -- tables. Includes newtypes, just for the benefit of
1054 cg_binds :: [CoreBind],
1055 -- ^ The tidied main bindings, including
1056 -- previously-implicit bindings for record and class
1057 -- selectors, and data construtor wrappers. But *not*
1058 -- data constructor workers; reason: we we regard them
1059 -- as part of the code-gen of tycons
1061 cg_dir_imps :: ![Module],
1062 -- ^ Directly-imported modules; used to generate
1063 -- initialisation code
1065 cg_foreign :: !ForeignStubs, -- ^ Foreign export stubs
1066 cg_dep_pkgs :: ![PackageId], -- ^ Dependent packages, used to
1067 -- generate #includes for C code gen
1068 cg_hpc_info :: !HpcInfo, -- ^ Program coverage tick box information
1069 cg_modBreaks :: !ModBreaks -- ^ Module breakpoints
1072 -----------------------------------
1073 -- | Foreign export stubs
1074 data ForeignStubs = NoStubs -- ^ We don't have any stubs
1078 -- ^ There are some stubs. Parameters:
1080 -- 1) Header file prototypes for
1081 -- "foreign exported" functions
1083 -- 2) C stubs to use when calling
1084 -- "foreign exported" functions
1088 emptyModIface :: Module -> ModIface
1090 = ModIface { mi_module = mod,
1091 mi_iface_hash = fingerprint0,
1092 mi_mod_hash = fingerprint0,
1096 mi_deps = noDependencies,
1099 mi_exp_hash = fingerprint0,
1101 mi_warns = NoWarnings,
1107 mi_globals = Nothing,
1108 mi_orphan_hash = fingerprint0,
1109 mi_vect_info = noIfaceVectInfo,
1110 mi_warn_fn = emptyIfaceWarnCache,
1111 mi_fix_fn = emptyIfaceFixCache,
1112 mi_hash_fn = emptyIfaceHashCache,
1118 %************************************************************************
1120 \subsection{The interactive context}
1122 %************************************************************************
1125 -- | Interactive context, recording information relevant to GHCi
1126 data InteractiveContext
1127 = InteractiveContext {
1128 ic_toplev_scope :: [Module], -- ^ The context includes the "top-level" scope of
1131 ic_exports :: [Module], -- ^ The context includes just the exports of these
1134 ic_rn_gbl_env :: GlobalRdrEnv, -- ^ The contexts' cached 'GlobalRdrEnv', built from
1135 -- 'ic_toplev_scope' and 'ic_exports'
1137 ic_tmp_ids :: [Id], -- ^ Names bound during interaction with the user.
1138 -- Later Ids shadow earlier ones with the same OccName.
1140 ic_tyvars :: TyVarSet -- ^ Skolem type variables free in
1141 -- 'ic_tmp_ids'. These arise at
1142 -- breakpoints in a polymorphic
1143 -- context, where we have only partial
1144 -- type information.
1147 , ic_resume :: [Resume] -- ^ The stack of breakpoint contexts
1150 , ic_cwd :: Maybe FilePath -- virtual CWD of the program
1154 emptyInteractiveContext :: InteractiveContext
1155 emptyInteractiveContext
1156 = InteractiveContext { ic_toplev_scope = [],
1158 ic_rn_gbl_env = emptyGlobalRdrEnv,
1160 ic_tyvars = emptyVarSet
1167 icPrintUnqual :: DynFlags -> InteractiveContext -> PrintUnqualified
1168 icPrintUnqual dflags ictxt = mkPrintUnqualified dflags (ic_rn_gbl_env ictxt)
1171 extendInteractiveContext
1172 :: InteractiveContext
1175 -> InteractiveContext
1176 extendInteractiveContext ictxt ids tyvars
1177 = ictxt { ic_tmp_ids = snub((ic_tmp_ids ictxt \\ ids) ++ ids),
1178 -- NB. must be this way around, because we want
1179 -- new ids to shadow existing bindings.
1180 ic_tyvars = ic_tyvars ictxt `unionVarSet` tyvars }
1181 where snub = map head . group . sort
1183 substInteractiveContext :: InteractiveContext -> TvSubst -> InteractiveContext
1184 substInteractiveContext ictxt subst | isEmptyTvSubst subst = ictxt
1185 substInteractiveContext ictxt@InteractiveContext{ic_tmp_ids=ids} subst =
1186 let ids' = map (\id -> id `setIdType` substTy subst (idType id)) ids
1187 subst_dom= varEnvKeys$ getTvSubstEnv subst
1188 subst_ran= varEnvElts$ getTvSubstEnv subst
1189 new_tvs = [ tv | Just tv <- map getTyVar_maybe subst_ran]
1190 ic_tyvars'= (`delVarSetListByKey` subst_dom)
1191 . (`extendVarSetList` new_tvs)
1193 in ictxt { ic_tmp_ids = ids'
1194 , ic_tyvars = ic_tyvars' }
1196 where delVarSetListByKey = foldl' delVarSetByKey
1199 %************************************************************************
1201 Building a PrintUnqualified
1203 %************************************************************************
1205 Deciding how to print names is pretty tricky. We are given a name
1206 P:M.T, where P is the package name, M is the defining module, and T is
1207 the occurrence name, and we have to decide in which form to display
1208 the name given a GlobalRdrEnv describing the current scope.
1210 Ideally we want to display the name in the form in which it is in
1211 scope. However, the name might not be in scope at all, and that's
1212 where it gets tricky. Here are the cases:
1214 1. T uniquely maps to P:M.T ---> "T"
1215 2. there is an X for which X.T uniquely maps to P:M.T ---> "X.T"
1216 3. there is no binding for "M.T" ---> "M.T"
1217 4. otherwise ---> "P:M.T"
1219 3 and 4 apply when P:M.T is not in scope. In these cases we want to
1220 refer to the name as "M.T", but "M.T" might mean something else in the
1221 current scope (e.g. if there's an "import X as M"), so to avoid
1222 confusion we avoid using "M.T" if there's already a binding for it.
1224 There's one further subtlety: if the module M cannot be imported
1225 because it is not exposed by any package, then we must refer to it as
1226 "P:M". This is handled by the qual_mod component of PrintUnqualified.
1229 -- | Creates some functions that work out the best ways to format
1230 -- names for the user according to a set of heuristics
1231 mkPrintUnqualified :: DynFlags -> GlobalRdrEnv -> PrintUnqualified
1232 mkPrintUnqualified dflags env = (qual_name, qual_mod)
1234 qual_name mod occ -- The (mod,occ) pair is the original name of the thing
1235 | [gre] <- unqual_gres, right_name gre = NameUnqual
1236 -- If there's a unique entity that's in scope unqualified with 'occ'
1237 -- AND that entity is the right one, then we can use the unqualified name
1239 | [gre] <- qual_gres = NameQual (get_qual_mod (gre_prov gre))
1242 if null (lookupGRE_RdrName (mkRdrQual (moduleName mod) occ) env)
1243 then NameNotInScope1
1244 else NameNotInScope2
1246 | otherwise = panic "mkPrintUnqualified"
1248 right_name gre = nameModule_maybe (gre_name gre) == Just mod
1250 unqual_gres = lookupGRE_RdrName (mkRdrUnqual occ) env
1251 qual_gres = filter right_name (lookupGlobalRdrEnv env occ)
1253 get_qual_mod LocalDef = moduleName mod
1254 get_qual_mod (Imported is) = ASSERT( not (null is) ) is_as (is_decl (head is))
1256 -- we can mention a module P:M without the P: qualifier iff
1257 -- "import M" would resolve unambiguously to P:M. (if P is the
1258 -- current package we can just assume it is unqualified).
1261 | modulePackageId mod == thisPackage dflags = False
1263 | [pkgconfig] <- [pkg | (pkg,exposed_module) <- lookup,
1264 exposed pkg && exposed_module],
1265 packageConfigId pkgconfig == modulePackageId mod
1266 -- this says: we are given a module P:M, is there just one exposed package
1267 -- that exposes a module M, and is it package P?
1271 where lookup = lookupModuleInAllPackages dflags (moduleName mod)
1275 %************************************************************************
1279 %************************************************************************
1282 -- | Determine the 'TyThing's brought into scope by another 'TyThing'
1283 -- /other/ than itself. For example, Id's don't have any implicit TyThings
1284 -- as they just bring themselves into scope, but classes bring their
1285 -- dictionary datatype, type constructor and some selector functions into
1286 -- scope, just for a start!
1288 -- N.B. the set of TyThings returned here *must* match the set of
1289 -- names returned by LoadIface.ifaceDeclSubBndrs, in the sense that
1290 -- TyThing.getOccName should define a bijection between the two lists.
1291 -- This invariant is used in LoadIface.loadDecl (see note [Tricky iface loop])
1292 -- The order of the list does not matter.
1293 implicitTyThings :: TyThing -> [TyThing]
1295 -- For data and newtype declarations:
1296 implicitTyThings (ATyCon tc)
1297 = -- fields (names of selectors)
1298 -- (possibly) implicit coercion and family coercion
1299 -- depending on whether it's a newtype or a family instance or both
1300 implicitCoTyCon tc ++
1301 -- for each data constructor in order,
1302 -- the contructor, worker, and (possibly) wrapper
1303 concatMap (extras_plus . ADataCon) (tyConDataCons tc)
1305 implicitTyThings (AClass cl)
1306 = -- dictionary datatype:
1309 -- [recursive call:]
1310 -- (possibly) newtype coercion; definitely no family coercion here
1313 -- (no wrapper by invariant)
1314 extras_plus (ATyCon (classTyCon cl)) ++
1316 -- No extras_plus (recursive call) for the classATs, because they
1317 -- are only the family decls; they have no implicit things
1318 map ATyCon (classATs cl) ++
1319 -- superclass and operation selectors
1320 map AnId (classSelIds cl)
1322 implicitTyThings (ADataCon dc) =
1323 -- For data cons add the worker and (possibly) wrapper
1324 map AnId (dataConImplicitIds dc)
1326 implicitTyThings (AnId _) = []
1328 -- add a thing and recursive call
1329 extras_plus :: TyThing -> [TyThing]
1330 extras_plus thing = thing : implicitTyThings thing
1332 -- For newtypes and indexed data types (and both),
1333 -- add the implicit coercion tycon
1334 implicitCoTyCon :: TyCon -> [TyThing]
1336 = map ATyCon . catMaybes $ [-- Just if newtype, Nothing if not
1337 newTyConCo_maybe tc,
1338 -- Just if family instance, Nothing if not
1339 tyConFamilyCoercion_maybe tc]
1341 -- sortByOcc = sortBy (\ x -> \ y -> getOccName x < getOccName y)
1344 -- | Returns @True@ if there should be no interface-file declaration
1345 -- for this thing on its own: either it is built-in, or it is part
1346 -- of some other declaration, or it is generated implicitly by some
1347 -- other declaration.
1348 isImplicitTyThing :: TyThing -> Bool
1349 isImplicitTyThing (ADataCon _) = True
1350 isImplicitTyThing (AnId id) = isImplicitId id
1351 isImplicitTyThing (AClass _) = False
1352 isImplicitTyThing (ATyCon tc) = isImplicitTyCon tc
1354 extendTypeEnvWithIds :: TypeEnv -> [Id] -> TypeEnv
1355 extendTypeEnvWithIds env ids
1356 = extendNameEnvList env [(getName id, AnId id) | id <- ids]
1359 %************************************************************************
1363 %************************************************************************
1366 -- | A map from 'Name's to 'TyThing's, constructed by typechecking
1367 -- local declarations or interface files
1368 type TypeEnv = NameEnv TyThing
1370 emptyTypeEnv :: TypeEnv
1371 typeEnvElts :: TypeEnv -> [TyThing]
1372 typeEnvClasses :: TypeEnv -> [Class]
1373 typeEnvTyCons :: TypeEnv -> [TyCon]
1374 typeEnvIds :: TypeEnv -> [Id]
1375 typeEnvDataCons :: TypeEnv -> [DataCon]
1376 lookupTypeEnv :: TypeEnv -> Name -> Maybe TyThing
1378 emptyTypeEnv = emptyNameEnv
1379 typeEnvElts env = nameEnvElts env
1380 typeEnvClasses env = [cl | AClass cl <- typeEnvElts env]
1381 typeEnvTyCons env = [tc | ATyCon tc <- typeEnvElts env]
1382 typeEnvIds env = [id | AnId id <- typeEnvElts env]
1383 typeEnvDataCons env = [dc | ADataCon dc <- typeEnvElts env]
1385 mkTypeEnv :: [TyThing] -> TypeEnv
1386 mkTypeEnv things = extendTypeEnvList emptyTypeEnv things
1388 lookupTypeEnv = lookupNameEnv
1390 -- Extend the type environment
1391 extendTypeEnv :: TypeEnv -> TyThing -> TypeEnv
1392 extendTypeEnv env thing = extendNameEnv env (getName thing) thing
1394 extendTypeEnvList :: TypeEnv -> [TyThing] -> TypeEnv
1395 extendTypeEnvList env things = foldl extendTypeEnv env things
1399 -- | Find the 'TyThing' for the given 'Name' by using all the resources
1400 -- at our disposal: the compiled modules in the 'HomePackageTable' and the
1401 -- compiled modules in other packages that live in 'PackageTypeEnv'. Note
1402 -- that this does NOT look up the 'TyThing' in the module being compiled: you
1403 -- have to do that yourself, if desired
1404 lookupType :: DynFlags
1410 lookupType dflags hpt pte name
1411 -- in one-shot, we don't use the HPT
1412 | not (isOneShot (ghcMode dflags)) && modulePackageId mod == this_pkg
1413 = do hm <- lookupUFM hpt (moduleName mod) -- Maybe monad
1414 lookupNameEnv (md_types (hm_details hm)) name
1416 = lookupNameEnv pte name
1417 where mod = ASSERT( isExternalName name ) nameModule name
1418 this_pkg = thisPackage dflags
1420 -- | As 'lookupType', but with a marginally easier-to-use interface
1421 -- if you have a 'HscEnv'
1422 lookupTypeHscEnv :: HscEnv -> Name -> IO (Maybe TyThing)
1423 lookupTypeHscEnv hsc_env name = do
1424 eps <- readIORef (hsc_EPS hsc_env)
1425 return $! lookupType dflags hpt (eps_PTE eps) name
1427 dflags = hsc_dflags hsc_env
1428 hpt = hsc_HPT hsc_env
1432 -- | Get the 'TyCon' from a 'TyThing' if it is a type constructor thing. Panics otherwise
1433 tyThingTyCon :: TyThing -> TyCon
1434 tyThingTyCon (ATyCon tc) = tc
1435 tyThingTyCon other = pprPanic "tyThingTyCon" (pprTyThing other)
1437 -- | Get the 'Class' from a 'TyThing' if it is a class thing. Panics otherwise
1438 tyThingClass :: TyThing -> Class
1439 tyThingClass (AClass cls) = cls
1440 tyThingClass other = pprPanic "tyThingClass" (pprTyThing other)
1442 -- | Get the 'DataCon' from a 'TyThing' if it is a data constructor thing. Panics otherwise
1443 tyThingDataCon :: TyThing -> DataCon
1444 tyThingDataCon (ADataCon dc) = dc
1445 tyThingDataCon other = pprPanic "tyThingDataCon" (pprTyThing other)
1447 -- | Get the 'Id' from a 'TyThing' if it is a id *or* data constructor thing. Panics otherwise
1448 tyThingId :: TyThing -> Id
1449 tyThingId (AnId id) = id
1450 tyThingId (ADataCon dc) = dataConWrapId dc
1451 tyThingId other = pprPanic "tyThingId" (pprTyThing other)
1454 %************************************************************************
1456 \subsection{MonadThings and friends}
1458 %************************************************************************
1461 -- | Class that abstracts out the common ability of the monads in GHC
1462 -- to lookup a 'TyThing' in the monadic environment by 'Name'. Provides
1463 -- a number of related convenience functions for accessing particular
1464 -- kinds of 'TyThing'
1465 class Monad m => MonadThings m where
1466 lookupThing :: Name -> m TyThing
1468 lookupId :: Name -> m Id
1469 lookupId = liftM tyThingId . lookupThing
1471 lookupDataCon :: Name -> m DataCon
1472 lookupDataCon = liftM tyThingDataCon . lookupThing
1474 lookupTyCon :: Name -> m TyCon
1475 lookupTyCon = liftM tyThingTyCon . lookupThing
1477 lookupClass :: Name -> m Class
1478 lookupClass = liftM tyThingClass . lookupThing
1482 -- | Constructs cache for the 'mi_hash_fn' field of a 'ModIface'
1483 mkIfaceHashCache :: [(Fingerprint,IfaceDecl)]
1484 -> (OccName -> Maybe (OccName, Fingerprint))
1485 mkIfaceHashCache pairs
1486 = \occ -> lookupOccEnv env occ
1488 env = foldr add_decl emptyOccEnv pairs
1489 add_decl (v,d) env0 = foldr add_imp env1 (ifaceDeclSubBndrs d)
1491 decl_name = ifName d
1492 env1 = extendOccEnv env0 decl_name (decl_name, v)
1493 add_imp bndr env = extendOccEnv env bndr (decl_name, v)
1495 emptyIfaceHashCache :: OccName -> Maybe (OccName, Fingerprint)
1496 emptyIfaceHashCache _occ = Nothing
1499 %************************************************************************
1501 \subsection{Auxiliary types}
1503 %************************************************************************
1505 These types are defined here because they are mentioned in ModDetails,
1506 but they are mostly elaborated elsewhere
1509 ------------------ Warnings -------------------------
1510 -- | Warning information for a module
1512 = NoWarnings -- ^ Nothing deprecated
1513 | WarnAll WarningTxt -- ^ Whole module deprecated
1514 | WarnSome [(OccName,WarningTxt)] -- ^ Some specific things deprecated
1516 -- Only an OccName is needed because
1517 -- (1) a deprecation always applies to a binding
1518 -- defined in the module in which the deprecation appears.
1519 -- (2) deprecations are only reported outside the defining module.
1520 -- this is important because, otherwise, if we saw something like
1522 -- {-# DEPRECATED f "" #-}
1525 -- g = let f = undefined in f
1527 -- we'd need more information than an OccName to know to say something
1528 -- about the use of f in h but not the use of the locally bound f in g
1530 -- however, because we only report about deprecations from the outside,
1531 -- and a module can only export one value called f,
1532 -- an OccName suffices.
1534 -- this is in contrast with fixity declarations, where we need to map
1535 -- a Name to its fixity declaration.
1538 -- | Constructs the cache for the 'mi_warn_fn' field of a 'ModIface'
1539 mkIfaceWarnCache :: Warnings -> Name -> Maybe WarningTxt
1540 mkIfaceWarnCache NoWarnings = \_ -> Nothing
1541 mkIfaceWarnCache (WarnAll t) = \_ -> Just t
1542 mkIfaceWarnCache (WarnSome pairs) = lookupOccEnv (mkOccEnv pairs) . nameOccName
1544 emptyIfaceWarnCache :: Name -> Maybe WarningTxt
1545 emptyIfaceWarnCache _ = Nothing
1547 plusWarns :: Warnings -> Warnings -> Warnings
1548 plusWarns d NoWarnings = d
1549 plusWarns NoWarnings d = d
1550 plusWarns _ (WarnAll t) = WarnAll t
1551 plusWarns (WarnAll t) _ = WarnAll t
1552 plusWarns (WarnSome v1) (WarnSome v2) = WarnSome (v1 ++ v2)
1555 -- | A collection of 'AvailInfo' - several things that are \"available\"
1556 type Avails = [AvailInfo]
1557 -- | 'Name'd things that are available
1558 type AvailInfo = GenAvailInfo Name
1559 -- | 'RdrName'd things that are available
1560 type RdrAvailInfo = GenAvailInfo OccName
1562 -- | Records what things are "available", i.e. in scope
1563 data GenAvailInfo name = Avail name -- ^ An ordinary identifier in scope
1565 [name] -- ^ A type or class in scope. Parameters:
1567 -- 1) The name of the type or class
1569 -- 2) The available pieces of type or class.
1570 -- NB: If the type or class is itself
1571 -- to be in scope, it must be in this list.
1572 -- Thus, typically: @AvailTC Eq [Eq, ==, \/=]@
1574 -- Equality used when deciding if the interface has changed
1576 -- | The original names declared of a certain module that are exported
1577 type IfaceExport = (Module, [GenAvailInfo OccName])
1579 availsToNameSet :: [AvailInfo] -> NameSet
1580 availsToNameSet avails = foldr add emptyNameSet avails
1581 where add avail set = addListToNameSet set (availNames avail)
1583 availsToNameEnv :: [AvailInfo] -> NameEnv AvailInfo
1584 availsToNameEnv avails = foldr add emptyNameEnv avails
1585 where add avail env = extendNameEnvList env
1586 (zip (availNames avail) (repeat avail))
1588 -- | Just the main name made available, i.e. not the available pieces
1589 -- of type or class brought into scope by the 'GenAvailInfo'
1590 availName :: GenAvailInfo name -> name
1591 availName (Avail n) = n
1592 availName (AvailTC n _) = n
1594 -- | All names made available by the availability information
1595 availNames :: GenAvailInfo name -> [name]
1596 availNames (Avail n) = [n]
1597 availNames (AvailTC _ ns) = ns
1599 instance Outputable n => Outputable (GenAvailInfo n) where
1602 pprAvail :: Outputable n => GenAvailInfo n -> SDoc
1603 pprAvail (Avail n) = ppr n
1604 pprAvail (AvailTC n ns) = ppr n <> braces (hsep (punctuate comma (map ppr ns)))
1608 -- | Creates cached lookup for the 'mi_fix_fn' field of 'ModIface'
1609 mkIfaceFixCache :: [(OccName, Fixity)] -> OccName -> Fixity
1610 mkIfaceFixCache pairs
1611 = \n -> lookupOccEnv env n `orElse` defaultFixity
1613 env = mkOccEnv pairs
1615 emptyIfaceFixCache :: OccName -> Fixity
1616 emptyIfaceFixCache _ = defaultFixity
1618 -- | Fixity environment mapping names to their fixities
1619 type FixityEnv = NameEnv FixItem
1621 -- | Fixity information for an 'Name'. We keep the OccName in the range
1622 -- so that we can generate an interface from it
1623 data FixItem = FixItem OccName Fixity
1625 instance Outputable FixItem where
1626 ppr (FixItem occ fix) = ppr fix <+> ppr occ
1628 emptyFixityEnv :: FixityEnv
1629 emptyFixityEnv = emptyNameEnv
1631 lookupFixity :: FixityEnv -> Name -> Fixity
1632 lookupFixity env n = case lookupNameEnv env n of
1633 Just (FixItem _ fix) -> fix
1634 Nothing -> defaultFixity
1638 %************************************************************************
1640 \subsection{WhatsImported}
1642 %************************************************************************
1645 -- | Records whether a module has orphans. An \"orphan\" is one of:
1647 -- * An instance declaration in a module other than the definition
1648 -- module for one of the type constructors or classes in the instance head
1650 -- * A transformation rule in a module other than the one defining
1651 -- the function in the head of the rule
1652 type WhetherHasOrphans = Bool
1654 -- | Does this module define family instances?
1655 type WhetherHasFamInst = Bool
1657 -- | Did this module originate from a *-boot file?
1658 type IsBootInterface = Bool
1660 -- | Dependency information about modules and packages below this one
1661 -- in the import hierarchy.
1663 -- Invariant: the dependencies of a module @M@ never includes @M@.
1665 -- Invariant: none of the lists contain duplicates.
1667 = Deps { dep_mods :: [(ModuleName, IsBootInterface)]
1668 -- ^ Home-package module dependencies
1669 , dep_pkgs :: [PackageId]
1670 -- ^ External package dependencies
1671 , dep_orphs :: [Module]
1672 -- ^ Orphan modules (whether home or external pkg),
1673 -- *not* including family instance orphans as they
1674 -- are anyway included in 'dep_finsts'
1675 , dep_finsts :: [Module]
1676 -- ^ Modules that contain family instances (whether the
1677 -- instances are from the home or an external package)
1680 -- Equality used only for old/new comparison in MkIface.addVersionInfo
1682 -- See 'TcRnTypes.ImportAvails' for details on dependencies.
1684 noDependencies :: Dependencies
1685 noDependencies = Deps [] [] [] []
1687 -- | Records modules that we depend on by making a direct import from
1689 = UsagePackageModule {
1691 -- ^ External package module depended on
1692 usg_mod_hash :: Fingerprint
1693 } -- ^ Module from another package
1695 usg_mod_name :: ModuleName,
1696 -- ^ Name of the module
1697 usg_mod_hash :: Fingerprint,
1698 -- ^ Cached module fingerprint
1699 usg_entities :: [(OccName,Fingerprint)],
1700 -- ^ Entities we depend on, sorted by occurrence name and fingerprinted.
1701 -- NB: usages are for parent names only, e.g. type constructors
1702 -- but not the associated data constructors.
1703 usg_exports :: Maybe Fingerprint
1704 -- ^ Fingerprint for the export list we used to depend on this module,
1705 -- if we depend on the export list
1706 } -- ^ Module from the current package
1708 -- The export list field is (Just v) if we depend on the export list:
1709 -- i.e. we imported the module directly, whether or not we
1710 -- enumerated the things we imported, or just imported
1712 -- We need to recompile if M's exports change, because
1713 -- if the import was import M, we might now have a name clash
1714 -- in the importing module.
1715 -- if the import was import M(x) M might no longer export x
1716 -- The only way we don't depend on the export list is if we have
1718 -- And of course, for modules that aren't imported directly we don't
1719 -- depend on their export lists
1723 %************************************************************************
1725 The External Package State
1727 %************************************************************************
1730 type PackageTypeEnv = TypeEnv
1731 type PackageRuleBase = RuleBase
1732 type PackageInstEnv = InstEnv
1733 type PackageFamInstEnv = FamInstEnv
1734 type PackageVectInfo = VectInfo
1735 type PackageAnnEnv = AnnEnv
1737 -- | Information about other packages that we have slurped in by reading
1738 -- their interface files
1739 data ExternalPackageState
1741 eps_is_boot :: !(ModuleNameEnv (ModuleName, IsBootInterface)),
1742 -- ^ In OneShot mode (only), home-package modules
1743 -- accumulate in the external package state, and are
1744 -- sucked in lazily. For these home-pkg modules
1745 -- (only) we need to record which are boot modules.
1746 -- We set this field after loading all the
1747 -- explicitly-imported interfaces, but before doing
1750 -- The 'ModuleName' part is not necessary, but it's useful for
1751 -- debug prints, and it's convenient because this field comes
1752 -- direct from 'TcRnTypes.imp_dep_mods'
1754 eps_PIT :: !PackageIfaceTable,
1755 -- ^ The 'ModIface's for modules in external packages
1756 -- whose interfaces we have opened.
1757 -- The declarations in these interface files are held in the
1758 -- 'eps_decls', 'eps_inst_env', 'eps_fam_inst_env' and 'eps_rules'
1759 -- fields of this record, not in the 'mi_decls' fields of the
1760 -- interface we have sucked in.
1762 -- What /is/ in the PIT is:
1766 -- * Fingerprint info
1772 -- * Deprecations and warnings
1774 eps_PTE :: !PackageTypeEnv,
1775 -- ^ Result of typechecking all the external package
1776 -- interface files we have sucked in. The domain of
1777 -- the mapping is external-package modules
1779 eps_inst_env :: !PackageInstEnv, -- ^ The total 'InstEnv' accumulated
1780 -- from all the external-package modules
1781 eps_fam_inst_env :: !PackageFamInstEnv,-- ^ The total 'FamInstEnv' accumulated
1782 -- from all the external-package modules
1783 eps_rule_base :: !PackageRuleBase, -- ^ The total 'RuleEnv' accumulated
1784 -- from all the external-package modules
1785 eps_vect_info :: !PackageVectInfo, -- ^ The total 'VectInfo' accumulated
1786 -- from all the external-package modules
1787 eps_ann_env :: !PackageAnnEnv, -- ^ The total 'AnnEnv' accumulated
1788 -- from all the external-package modules
1790 eps_mod_fam_inst_env :: !(ModuleEnv FamInstEnv), -- ^ The family instances accumulated from external
1791 -- packages, keyed off the module that declared them
1793 eps_stats :: !EpsStats -- ^ Stastics about what was loaded from external packages
1796 -- | Accumulated statistics about what we are putting into the 'ExternalPackageState'.
1797 -- \"In\" means stuff that is just /read/ from interface files,
1798 -- \"Out\" means actually sucked in and type-checked
1799 data EpsStats = EpsStats { n_ifaces_in
1800 , n_decls_in, n_decls_out
1801 , n_rules_in, n_rules_out
1802 , n_insts_in, n_insts_out :: !Int }
1804 addEpsInStats :: EpsStats -> Int -> Int -> Int -> EpsStats
1805 -- ^ Add stats for one newly-read interface
1806 addEpsInStats stats n_decls n_insts n_rules
1807 = stats { n_ifaces_in = n_ifaces_in stats + 1
1808 , n_decls_in = n_decls_in stats + n_decls
1809 , n_insts_in = n_insts_in stats + n_insts
1810 , n_rules_in = n_rules_in stats + n_rules }
1813 Names in a NameCache are always stored as a Global, and have the SrcLoc
1814 of their binding locations.
1816 Actually that's not quite right. When we first encounter the original
1817 name, we might not be at its binding site (e.g. we are reading an
1818 interface file); so we give it 'noSrcLoc' then. Later, when we find
1819 its binding site, we fix it up.
1822 -- | The NameCache makes sure that there is just one Unique assigned for
1823 -- each original name; i.e. (module-name, occ-name) pair and provides
1824 -- something of a lookup mechanism for those names.
1826 = NameCache { nsUniqs :: UniqSupply,
1827 -- ^ Supply of uniques
1828 nsNames :: OrigNameCache,
1829 -- ^ Ensures that one original name gets one unique
1830 nsIPs :: OrigIParamCache
1831 -- ^ Ensures that one implicit parameter name gets one unique
1834 -- | Per-module cache of original 'OccName's given 'Name's
1835 type OrigNameCache = ModuleEnv (OccEnv Name)
1837 -- | Module-local cache of implicit parameter 'OccName's given 'Name's
1838 type OrigIParamCache = FiniteMap (IPName OccName) (IPName Name)
1843 %************************************************************************
1845 The module graph and ModSummary type
1846 A ModSummary is a node in the compilation manager's
1847 dependency graph, and it's also passed to hscMain
1849 %************************************************************************
1852 -- | A ModuleGraph contains all the nodes from the home package (only).
1853 -- There will be a node for each source module, plus a node for each hi-boot
1856 -- The graph is not necessarily stored in topologically-sorted order. Use
1857 -- 'GHC.topSortModuleGraph' and 'Digraph.flattenSCC' to achieve this.
1858 type ModuleGraph = [ModSummary]
1860 emptyMG :: ModuleGraph
1863 -- | A single node in a 'ModuleGraph. The nodes of the module graph are one of:
1865 -- * A regular Haskell source module
1867 -- * A hi-boot source module
1869 -- * An external-core source module
1872 ms_mod :: Module, -- ^ Identity of the module
1873 ms_hsc_src :: HscSource, -- ^ The module source either plain Haskell, hs-boot or external core
1874 ms_location :: ModLocation, -- ^ Location of the various files belonging to the module
1875 ms_hs_date :: ClockTime, -- ^ Timestamp of source file
1876 ms_obj_date :: Maybe ClockTime, -- ^ Timestamp of object, if we have one
1877 ms_srcimps :: [Located (ImportDecl RdrName)], -- ^ Source imports of the module
1878 ms_imps :: [Located (ImportDecl RdrName)], -- ^ Non-source imports of the module
1879 ms_hspp_file :: FilePath, -- ^ Filename of preprocessed source file
1880 ms_hspp_opts :: DynFlags, -- ^ Cached flags from @OPTIONS@, @INCLUDE@
1881 -- and @LANGUAGE@ pragmas in the modules source code
1882 ms_hspp_buf :: Maybe StringBuffer -- ^ The actual preprocessed source, if we have it
1885 ms_mod_name :: ModSummary -> ModuleName
1886 ms_mod_name = moduleName . ms_mod
1888 -- The ModLocation contains both the original source filename and the
1889 -- filename of the cleaned-up source file after all preprocessing has been
1890 -- done. The point is that the summariser will have to cpp/unlit/whatever
1891 -- all files anyway, and there's no point in doing this twice -- just
1892 -- park the result in a temp file, put the name of it in the location,
1893 -- and let @compile@ read from that file on the way back up.
1895 -- The ModLocation is stable over successive up-sweeps in GHCi, wheres
1896 -- the ms_hs_date and imports can, of course, change
1898 msHsFilePath, msHiFilePath, msObjFilePath :: ModSummary -> FilePath
1899 msHsFilePath ms = expectJust "msHsFilePath" (ml_hs_file (ms_location ms))
1900 msHiFilePath ms = ml_hi_file (ms_location ms)
1901 msObjFilePath ms = ml_obj_file (ms_location ms)
1903 -- | Did this 'ModSummary' originate from a hs-boot file?
1904 isBootSummary :: ModSummary -> Bool
1905 isBootSummary ms = isHsBoot (ms_hsc_src ms)
1907 instance Outputable ModSummary where
1909 = sep [text "ModSummary {",
1910 nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)),
1911 text "ms_mod =" <+> ppr (ms_mod ms)
1912 <> text (hscSourceString (ms_hsc_src ms)) <> comma,
1913 text "ms_imps =" <+> ppr (ms_imps ms),
1914 text "ms_srcimps =" <+> ppr (ms_srcimps ms)]),
1918 showModMsg :: HscTarget -> Bool -> ModSummary -> String
1919 showModMsg target recomp mod_summary
1921 hsep [text (mod_str ++ replicate (max 0 (16 - length mod_str)) ' '),
1922 char '(', text (normalise $ msHsFilePath mod_summary) <> comma,
1924 HscInterpreted | recomp
1925 -> text "interpreted"
1926 HscNothing -> text "nothing"
1927 _ -> text (normalise $ msObjFilePath mod_summary),
1930 mod = moduleName (ms_mod mod_summary)
1931 mod_str = showSDoc (ppr mod) ++ hscSourceString (ms_hsc_src mod_summary)
1935 %************************************************************************
1937 \subsection{Hpc Support}
1939 %************************************************************************
1942 -- | Information about a modules use of Haskell Program Coverage
1945 { hpcInfoTickCount :: Int
1946 , hpcInfoHash :: Int
1949 { hpcUsed :: AnyHpcUsage -- ^ Is hpc used anywhere on the module \*tree\*?
1952 -- | This is used to signal if one of my imports used HPC instrumentation
1953 -- even if there is no module-local HPC usage
1954 type AnyHpcUsage = Bool
1956 emptyHpcInfo :: AnyHpcUsage -> HpcInfo
1957 emptyHpcInfo = NoHpcInfo
1959 -- | Find out if HPC is used by this module or any of the modules
1961 isHpcUsed :: HpcInfo -> AnyHpcUsage
1962 isHpcUsed (HpcInfo {}) = True
1963 isHpcUsed (NoHpcInfo { hpcUsed = used }) = used
1966 %************************************************************************
1968 \subsection{Vectorisation Support}
1970 %************************************************************************
1972 The following information is generated and consumed by the vectorisation
1973 subsystem. It communicates the vectorisation status of declarations from one
1976 Why do we need both f and f_v in the ModGuts/ModDetails/EPS version VectInfo
1977 below? We need to know `f' when converting to IfaceVectInfo. However, during
1978 vectorisation, we need to know `f_v', whose `Var' we cannot lookup based
1979 on just the OccName easily in a Core pass.
1982 -- | Vectorisation information for 'ModGuts', 'ModDetails' and 'ExternalPackageState'.
1983 -- All of this information is always tidy, even in ModGuts.
1986 vectInfoVar :: VarEnv (Var , Var ), -- ^ @(f, f_v)@ keyed on @f@
1987 vectInfoTyCon :: NameEnv (TyCon , TyCon), -- ^ @(T, T_v)@ keyed on @T@
1988 vectInfoDataCon :: NameEnv (DataCon, DataCon), -- ^ @(C, C_v)@ keyed on @C@
1989 vectInfoPADFun :: NameEnv (TyCon , Var), -- ^ @(T_v, paT)@ keyed on @T_v@
1990 vectInfoIso :: NameEnv (TyCon , Var) -- ^ @(T, isoT)@ keyed on @T@
1993 -- | Vectorisation information for 'ModIface': a slightly less low-level view
1996 ifaceVectInfoVar :: [Name],
1997 -- ^ All variables in here have a vectorised variant
1998 ifaceVectInfoTyCon :: [Name],
1999 -- ^ All 'TyCon's in here have a vectorised variant;
2000 -- the name of the vectorised variant and those of its
2001 -- data constructors are determined by 'OccName.mkVectTyConOcc'
2002 -- and 'OccName.mkVectDataConOcc'; the names of
2003 -- the isomorphisms are determined by 'OccName.mkVectIsoOcc'
2004 ifaceVectInfoTyConReuse :: [Name]
2005 -- ^ The vectorised form of all the 'TyCon's in here coincides with
2006 -- the unconverted form; the name of the isomorphisms is determined
2007 -- by 'OccName.mkVectIsoOcc'
2010 noVectInfo :: VectInfo
2011 noVectInfo = VectInfo emptyVarEnv emptyNameEnv emptyNameEnv emptyNameEnv emptyNameEnv
2013 plusVectInfo :: VectInfo -> VectInfo -> VectInfo
2014 plusVectInfo vi1 vi2 =
2015 VectInfo (vectInfoVar vi1 `plusVarEnv` vectInfoVar vi2)
2016 (vectInfoTyCon vi1 `plusNameEnv` vectInfoTyCon vi2)
2017 (vectInfoDataCon vi1 `plusNameEnv` vectInfoDataCon vi2)
2018 (vectInfoPADFun vi1 `plusNameEnv` vectInfoPADFun vi2)
2019 (vectInfoIso vi1 `plusNameEnv` vectInfoIso vi2)
2021 concatVectInfo :: [VectInfo] -> VectInfo
2022 concatVectInfo = foldr plusVectInfo noVectInfo
2024 noIfaceVectInfo :: IfaceVectInfo
2025 noIfaceVectInfo = IfaceVectInfo [] [] []
2028 %************************************************************************
2030 \subsection{Linkable stuff}
2032 %************************************************************************
2034 This stuff is in here, rather than (say) in Linker.lhs, because the Linker.lhs
2035 stuff is the *dynamic* linker, and isn't present in a stage-1 compiler
2038 -- | Information we can use to dynamically link modules into the compiler
2039 data Linkable = LM {
2040 linkableTime :: ClockTime, -- ^ Time at which this linkable was built
2041 -- (i.e. when the bytecodes were produced,
2042 -- or the mod date on the files)
2043 linkableModule :: Module, -- ^ The linkable module itself
2044 linkableUnlinked :: [Unlinked]
2045 -- ^ Those files and chunks of code we have yet to link.
2047 -- INVARIANT: A valid linkable always has at least one 'Unlinked' item.
2048 -- If this list is empty, the Linkable represents a fake linkable, which
2049 -- is generated in HscNothing mode to avoid recompiling modules.
2051 -- XXX: Do items get removed from this list when they get linked?
2054 isObjectLinkable :: Linkable -> Bool
2055 isObjectLinkable l = not (null unlinked) && all isObject unlinked
2056 where unlinked = linkableUnlinked l
2057 -- A linkable with no Unlinked's is treated as a BCO. We can
2058 -- generate a linkable with no Unlinked's as a result of
2059 -- compiling a module in HscNothing mode, and this choice
2060 -- happens to work well with checkStability in module GHC.
2062 instance Outputable Linkable where
2063 ppr (LM when_made mod unlinkeds)
2064 = (text "LinkableM" <+> parens (text (show when_made)) <+> ppr mod)
2065 $$ nest 3 (ppr unlinkeds)
2067 -------------------------------------------
2069 -- | Objects which have yet to be linked by the compiler
2071 = DotO FilePath -- ^ An object file (.o)
2072 | DotA FilePath -- ^ Static archive file (.a)
2073 | DotDLL FilePath -- ^ Dynamically linked library file (.so, .dll, .dylib)
2074 | BCOs CompiledByteCode ModBreaks -- ^ A byte-code object, lives only in memory
2077 data CompiledByteCode = CompiledByteCodeUndefined
2078 _unused :: CompiledByteCode
2079 _unused = CompiledByteCodeUndefined
2082 instance Outputable Unlinked where
2083 ppr (DotO path) = text "DotO" <+> text path
2084 ppr (DotA path) = text "DotA" <+> text path
2085 ppr (DotDLL path) = text "DotDLL" <+> text path
2087 ppr (BCOs bcos _) = text "BCOs" <+> ppr bcos
2089 ppr (BCOs _ _) = text "No byte code"
2092 -- | Is this an actual file on disk we can link in somehow?
2093 isObject :: Unlinked -> Bool
2094 isObject (DotO _) = True
2095 isObject (DotA _) = True
2096 isObject (DotDLL _) = True
2099 -- | Is this a bytecode linkable with no file on disk?
2100 isInterpretable :: Unlinked -> Bool
2101 isInterpretable = not . isObject
2103 -- | Retrieve the filename of the linkable if possible. Panic if it is a byte-code object
2104 nameOfObject :: Unlinked -> FilePath
2105 nameOfObject (DotO fn) = fn
2106 nameOfObject (DotA fn) = fn
2107 nameOfObject (DotDLL fn) = fn
2108 nameOfObject other = pprPanic "nameOfObject" (ppr other)
2110 -- | Retrieve the compiled byte-code if possible. Panic if it is a file-based linkable
2111 byteCodeOfObject :: Unlinked -> CompiledByteCode
2112 byteCodeOfObject (BCOs bc _) = bc
2113 byteCodeOfObject other = pprPanic "byteCodeOfObject" (ppr other)
2116 %************************************************************************
2118 \subsection{Breakpoint Support}
2120 %************************************************************************
2123 -- | Breakpoint index
2124 type BreakIndex = Int
2126 -- | All the information about the breakpoints for a given module
2129 { modBreaks_flags :: BreakArray
2130 -- ^ The array of flags, one per breakpoint,
2131 -- indicating which breakpoints are enabled.
2132 , modBreaks_locs :: !(Array BreakIndex SrcSpan)
2133 -- ^ An array giving the source span of each breakpoint.
2134 , modBreaks_vars :: !(Array BreakIndex [OccName])
2135 -- ^ An array giving the names of the free variables at each breakpoint.
2138 emptyModBreaks :: ModBreaks
2139 emptyModBreaks = ModBreaks
2140 { modBreaks_flags = error "ModBreaks.modBreaks_array not initialised"
2141 -- Todo: can we avoid this?
2142 , modBreaks_locs = array (0,-1) []
2143 , modBreaks_vars = array (0,-1) []