1 -- -----------------------------------------------------------------------------
3 -- (c) The University of Glasgow, 2005
7 -- -----------------------------------------------------------------------------
12 defaultCleanupHandler,
15 Ghc, GhcT, GhcMonad(..),
16 runGhc, runGhcT, initGhcMonad,
17 gcatch, gbracket, gfinally,
18 clearWarnings, getWarnings, hasWarnings,
19 printExceptionAndWarnings, printWarnings,
20 handleSourceError, defaultCallbacks, GhcApiCallbacks(..),
22 -- * Flags and settings
23 DynFlags(..), DynFlag(..), Severity(..), HscTarget(..), dopt,
24 GhcMode(..), GhcLink(..), defaultObjectTarget,
31 Target(..), TargetId(..), Phase,
38 -- * Extending the program scope
41 extendGlobalTypeScope,
44 -- * Loading\/compiling the program
46 load, loadWithLogger, LoadHowMuch(..), SuccessFlag(..), -- also does depanal
47 defaultWarnErrLogger, WarnErrLogger,
48 workingDirectoryChanged,
49 parseModule, typecheckModule, desugarModule, loadModule,
50 ParsedModule, TypecheckedModule, DesugaredModule, -- all abstract
51 TypecheckedSource, ParsedSource, RenamedSource, -- ditto
52 TypecheckedMod, ParsedMod,
53 moduleInfo, renamedSource, typecheckedSource,
54 parsedSource, coreModule,
55 compileToCoreModule, compileToCoreSimplified,
59 -- * Parsing Haddock comments
62 -- * Inspecting the module structure of the program
63 ModuleGraph, ModSummary(..), ms_mod_name, ModLocation(..),
68 -- * Inspecting modules
75 modInfoIsExportedName,
79 mkPrintUnqualifiedForModule,
81 -- * Querying the environment
85 PrintUnqualified, alwaysQualify,
87 -- * Interactive evaluation
88 getBindings, getPrintUnqual,
91 setContext, getContext,
101 runStmt, SingleStep(..),
103 Resume(resumeStmt, resumeThreadId, resumeBreakInfo, resumeSpan,
104 resumeHistory, resumeHistoryIx),
105 History(historyBreakInfo, historyEnclosingDecl),
106 GHC.getHistorySpan, getHistoryModule,
109 InteractiveEval.back,
110 InteractiveEval.forward,
113 InteractiveEval.compileExpr, HValue, dynCompileExpr,
115 GHC.obtainTermFromId, GHC.obtainTermFromVal, reconstructType,
117 ModBreaks(..), BreakIndex,
118 BreakInfo(breakInfo_number, breakInfo_module),
119 BreakArray, setBreakOn, setBreakOff, getBreak,
122 -- * Abstract syntax elements
128 Module, mkModule, pprModule, moduleName, modulePackageId,
129 ModuleName, mkModuleName, moduleNameString,
133 isExternalName, nameModule, pprParenSymName, nameSrcSpan,
135 RdrName(Qual,Unqual),
139 isImplicitId, isDeadBinder,
140 isExportedId, isLocalId, isGlobalId,
142 isPrimOpId, isFCallId, isClassOpId_maybe,
143 isDataConWorkId, idDataCon,
144 isBottomingId, isDictonaryId,
145 recordSelectorFieldLabel,
147 -- ** Type constructors
149 tyConTyVars, tyConDataCons, tyConArity,
150 isClassTyCon, isSynTyCon, isNewTyCon, isPrimTyCon, isFunTyCon,
152 synTyConDefn, synTyConType, synTyConResKind,
158 -- ** Data constructors
160 dataConSig, dataConType, dataConTyCon, dataConFieldLabels,
161 dataConIsInfix, isVanillaDataCon,
163 StrictnessMark(..), isMarkedStrict,
167 classMethods, classSCTheta, classTvsFds,
172 instanceDFunId, pprInstance, pprInstanceHdr,
174 -- ** Types and Kinds
175 Type, splitForAllTys, funResultTy,
176 pprParendType, pprTypeApp,
179 ThetaType, pprThetaArrow,
185 module HsSyn, -- ToDo: remove extraneous bits
189 defaultFixity, maxPrecedence,
193 -- ** Source locations
195 mkSrcLoc, isGoodSrcLoc, noSrcLoc,
196 srcLocFile, srcLocLine, srcLocCol,
198 mkSrcSpan, srcLocSpan, isGoodSrcSpan, noSrcSpan,
199 srcSpanStart, srcSpanEnd,
201 srcSpanStartLine, srcSpanEndLine,
202 srcSpanStartCol, srcSpanEndCol,
207 -- *** Constructing Located
208 noLoc, mkGeneralLocated,
210 -- *** Deconstructing Located
213 -- *** Combining and comparing Located values
214 eqLocated, cmpLocated, combineLocs, addCLoc,
215 leftmost_smallest, leftmost_largest, rightmost,
219 GhcException(..), showGhcException,
221 -- * Token stream manipulations
223 getTokenStream, getRichTokenStream,
224 showRichTokenStream, addSourceToTokens,
234 * inline bits of HscMain here to simplify layering: hscTcExpr, hscStmt.
235 * what StaticFlags should we expose, if any?
238 #include "HsVersions.h"
241 import qualified Linker
242 import Linker ( HValue )
246 import InteractiveEval
251 import TcRnTypes hiding (LIE)
252 import TcRnMonad ( initIfaceCheck )
256 import qualified HsSyn -- hack as we want to reexport the whole module
257 import HsSyn hiding ((<.>))
258 import Type hiding (typeKind)
259 import TcType hiding (typeKind)
262 import TysPrim ( alphaTyVars )
267 import Name hiding ( varName )
268 import OccName ( parenSymOcc )
269 import InstEnv ( Instance, instanceDFunId, pprInstance, pprInstanceHdr,
271 import FamInstEnv ( emptyFamInstEnv )
275 import DriverPipeline
276 import DriverPhases ( HscSource(..), Phase(..), isHaskellSrcFilename, startPhase )
282 import StaticFlagParser
283 import qualified StaticFlags
284 import SysTools ( initSysTools, cleanTempFiles, cleanTempFilesExcept,
289 import qualified UniqFM as UFM
295 import Bag ( unitBag, listToBag, emptyBag, isEmptyBag )
299 import StringBuffer ( StringBuffer, hGetStringBuffer, nextChar )
302 import Maybes ( expectJust, mapCatMaybes )
304 import HaddockLex ( tokenise )
308 import Control.Concurrent
309 import System.Directory ( getModificationTime, doesFileExist,
310 getCurrentDirectory )
313 import qualified Data.List as List
314 import Data.Typeable ( Typeable )
315 import Data.Word ( Word8 )
317 import System.Exit ( exitWith, ExitCode(..) )
318 import System.Time ( ClockTime, getClockTime )
321 import System.FilePath
323 import System.IO.Error ( try, isDoesNotExistError )
324 import Prelude hiding (init)
327 -- -----------------------------------------------------------------------------
328 -- Exception handlers
330 -- | Install some default exception handlers and run the inner computation.
331 -- Unless you want to handle exceptions yourself, you should wrap this around
332 -- the top level of your program. The default handlers output the error
333 -- message(s) to stderr and exit cleanly.
334 defaultErrorHandler :: (ExceptionMonad m, MonadIO m) => DynFlags -> m a -> m a
335 defaultErrorHandler dflags inner =
336 -- top-level exception handler: any unrecognised exception is a compiler bug.
337 ghandle (\exception -> liftIO $ do
339 case fromException exception of
340 -- an IO exception probably isn't our fault, so don't panic
341 Just (ioe :: IOException) ->
342 fatalErrorMsg dflags (text (show ioe))
343 _ -> case fromException exception of
344 Just StackOverflow ->
345 fatalErrorMsg dflags (text "stack overflow: use +RTS -K<size> to increase it")
346 _ -> case fromException exception of
347 Just (ex :: ExitCode) -> throw ex
350 (text (show (Panic (show exception))))
351 exitWith (ExitFailure 1)
354 -- error messages propagated as exceptions
359 PhaseFailed _ code -> exitWith code
360 Interrupted -> exitWith (ExitFailure 1)
361 _ -> do fatalErrorMsg dflags (text (show ge))
362 exitWith (ExitFailure 1)
366 -- | Install a default cleanup handler to remove temporary files deposited by
367 -- a GHC run. This is seperate from 'defaultErrorHandler', because you might
368 -- want to override the error handling, but still get the ordinary cleanup
370 defaultCleanupHandler :: (ExceptionMonad m, MonadIO m) =>
371 DynFlags -> m a -> m a
372 defaultCleanupHandler dflags inner =
373 -- make sure we clean up after ourselves
376 cleanTempFiles dflags
379 -- exceptions will be blocked while we clean the temporary files,
380 -- so there shouldn't be any difficulty if we receive further
383 -- | Print the error message and all warnings. Useful inside exception
384 -- handlers. Clears warnings after printing.
385 printExceptionAndWarnings :: GhcMonad m => SourceError -> m ()
386 printExceptionAndWarnings err = do
387 let errs = srcErrorMessages err
389 dflags <- getSessionDynFlags
391 -- Empty errors means we failed due to -Werror. (Since this function
392 -- takes a source error as argument, we know for sure _some_ error
393 -- did indeed happen.)
395 printBagOfWarnings dflags warns
396 printBagOfErrors dflags (unitBag warnIsErrorMsg)
397 else liftIO $ printBagOfErrors dflags errs
400 -- | Print all accumulated warnings using 'log_action'.
401 printWarnings :: GhcMonad m => m ()
403 dflags <- getSessionDynFlags
405 liftIO $ printBagOfWarnings dflags warns
408 -- | Run function for the 'Ghc' monad.
410 -- It initialises the GHC session and warnings via 'initGhcMonad'. Each call
411 -- to this function will create a new session which should not be shared among
414 -- Any errors not handled inside the 'Ghc' action are propagated as IO
417 runGhc :: Maybe FilePath -- ^ See argument to 'initGhcMonad'.
418 -> Ghc a -- ^ The action to perform.
420 runGhc mb_top_dir ghc = do
421 wref <- newIORef emptyBag
422 ref <- newIORef undefined
423 let session = Session ref wref
424 flip unGhc session $ do
425 initGhcMonad mb_top_dir
427 -- XXX: unregister interrupt handlers here?
429 -- | Run function for 'GhcT' monad transformer.
431 -- It initialises the GHC session and warnings via 'initGhcMonad'. Each call
432 -- to this function will create a new session which should not be shared among
435 runGhcT :: (ExceptionMonad m, Functor m, MonadIO m) =>
436 Maybe FilePath -- ^ See argument to 'initGhcMonad'.
437 -> GhcT m a -- ^ The action to perform.
439 runGhcT mb_top_dir ghct = do
440 wref <- liftIO $ newIORef emptyBag
441 ref <- liftIO $ newIORef undefined
442 let session = Session ref wref
443 flip unGhcT session $ do
444 initGhcMonad mb_top_dir
447 -- | Initialise a GHC session.
449 -- If you implement a custom 'GhcMonad' you must call this function in the
450 -- monad run function. It will initialise the session variable and clear all
453 -- The first argument should point to the directory where GHC's library files
454 -- reside. More precisely, this should be the output of @ghc --print-libdir@
455 -- of the version of GHC the module using this API is compiled with. For
456 -- portability, you should use the @ghc-paths@ package, available at
457 -- <http://hackage.haskell.org/cgi-bin/hackage-scripts/package/ghc-paths>.
459 initGhcMonad :: GhcMonad m => Maybe FilePath -> m ()
460 initGhcMonad mb_top_dir = do
462 main_thread <- liftIO $ myThreadId
463 liftIO $ modifyMVar_ interruptTargetThread (return . (main_thread :))
464 liftIO $ installSignalHandlers
466 liftIO $ StaticFlags.initStaticOpts
468 dflags0 <- liftIO $ initDynFlags defaultDynFlags
469 dflags <- liftIO $ initSysTools mb_top_dir dflags0
470 env <- liftIO $ newHscEnv defaultCallbacks dflags
474 defaultCallbacks :: GhcApiCallbacks
477 reportModuleCompilationResult =
478 \_ mb_err -> defaultWarnErrLogger mb_err
481 -- -----------------------------------------------------------------------------
484 -- | Grabs the DynFlags from the Session
485 getSessionDynFlags :: GhcMonad m => m DynFlags
486 getSessionDynFlags = withSession (return . hsc_dflags)
488 -- | Updates the DynFlags in a Session. This also reads
489 -- the package database (unless it has already been read),
490 -- and prepares the compilers knowledge about packages. It
491 -- can be called again to load new packages: just add new
492 -- package flags to (packageFlags dflags).
494 -- Returns a list of new packages that may need to be linked in using
495 -- the dynamic linker (see 'linkPackages') as a result of new package
496 -- flags. If you are not doing linking or doing static linking, you
497 -- can ignore the list of packages returned.
499 setSessionDynFlags :: GhcMonad m => DynFlags -> m [PackageId]
500 setSessionDynFlags dflags = do
501 (dflags', preload) <- liftIO $ initPackages dflags
502 modifySession (\h -> h{ hsc_dflags = dflags' })
505 -- | If there is no -o option, guess the name of target executable
506 -- by using top-level source file name as a base.
507 guessOutputFile :: GhcMonad m => m ()
508 guessOutputFile = modifySession $ \env ->
509 let dflags = hsc_dflags env
510 mod_graph = hsc_mod_graph env
511 mainModuleSrcPath :: Maybe String
512 mainModuleSrcPath = do
513 let isMain = (== mainModIs dflags) . ms_mod
514 [ms] <- return (filter isMain mod_graph)
515 ml_hs_file (ms_location ms)
516 name = fmap dropExtension mainModuleSrcPath
518 #if defined(mingw32_HOST_OS)
519 -- we must add the .exe extention unconditionally here, otherwise
520 -- when name has an extension of its own, the .exe extension will
521 -- not be added by DriverPipeline.exeFileName. See #2248
522 name_exe = fmap (<.> "exe") name
527 case outputFile dflags of
529 Nothing -> env { hsc_dflags = dflags { outputFile = name_exe } }
531 -- -----------------------------------------------------------------------------
534 -- ToDo: think about relative vs. absolute file paths. And what
535 -- happens when the current directory changes.
537 -- | Sets the targets for this session. Each target may be a module name
538 -- or a filename. The targets correspond to the set of root modules for
539 -- the program\/library. Unloading the current program is achieved by
540 -- setting the current set of targets to be empty, followed by 'load'.
541 setTargets :: GhcMonad m => [Target] -> m ()
542 setTargets targets = modifySession (\h -> h{ hsc_targets = targets })
544 -- | Returns the current set of targets
545 getTargets :: GhcMonad m => m [Target]
546 getTargets = withSession (return . hsc_targets)
548 -- | Add another target.
549 addTarget :: GhcMonad m => Target -> m ()
551 = modifySession (\h -> h{ hsc_targets = target : hsc_targets h })
554 removeTarget :: GhcMonad m => TargetId -> m ()
555 removeTarget target_id
556 = modifySession (\h -> h{ hsc_targets = filter (hsc_targets h) })
558 filter targets = [ t | t@(Target id _ _) <- targets, id /= target_id ]
560 -- | Attempts to guess what Target a string refers to. This function
561 -- implements the @--make@/GHCi command-line syntax for filenames:
563 -- - if the string looks like a Haskell source filename, then interpret it
566 -- - if adding a .hs or .lhs suffix yields the name of an existing file,
569 -- - otherwise interpret the string as a module name
571 guessTarget :: GhcMonad m => String -> Maybe Phase -> m Target
572 guessTarget str (Just phase)
573 = return (Target (TargetFile str (Just phase)) True Nothing)
574 guessTarget str Nothing
575 | isHaskellSrcFilename file
576 = return (target (TargetFile file Nothing))
578 = do exists <- liftIO $ doesFileExist hs_file
580 then return (target (TargetFile hs_file Nothing))
582 exists <- liftIO $ doesFileExist lhs_file
584 then return (target (TargetFile lhs_file Nothing))
586 if looksLikeModuleName file
587 then return (target (TargetModule (mkModuleName file)))
590 (ProgramError (showSDoc $
591 text "target" <+> quotes (text file) <+>
592 text "is not a module name or a source file"))
595 | '*':rest <- str = (rest, False)
596 | otherwise = (str, True)
598 hs_file = file <.> "hs"
599 lhs_file = file <.> "lhs"
601 target tid = Target tid obj_allowed Nothing
603 -- -----------------------------------------------------------------------------
604 -- Extending the program scope
606 extendGlobalRdrScope :: GhcMonad m => [GlobalRdrElt] -> m ()
607 extendGlobalRdrScope rdrElts
608 = modifySession $ \hscEnv ->
609 let global_rdr = hsc_global_rdr_env hscEnv
610 in hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv global_rdr rdrElts }
612 setGlobalRdrScope :: GhcMonad m => [GlobalRdrElt] -> m ()
613 setGlobalRdrScope rdrElts
614 = modifySession $ \hscEnv ->
615 hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv emptyGlobalRdrEnv rdrElts }
617 extendGlobalTypeScope :: GhcMonad m => [Id] -> m ()
618 extendGlobalTypeScope ids
619 = modifySession $ \hscEnv ->
620 let global_type = hsc_global_type_env hscEnv
621 in hscEnv{ hsc_global_type_env = extendTypeEnvWithIds global_type ids }
623 setGlobalTypeScope :: GhcMonad m => [Id] -> m ()
624 setGlobalTypeScope ids
625 = modifySession $ \hscEnv ->
626 hscEnv{ hsc_global_type_env = extendTypeEnvWithIds emptyTypeEnv ids }
628 -- -----------------------------------------------------------------------------
629 -- Parsing Haddock comments
631 parseHaddockComment :: String -> Either String (HsDoc RdrName)
632 parseHaddockComment string =
633 case parseHaddockParagraphs (tokenise string) of
637 -- -----------------------------------------------------------------------------
638 -- Loading the program
640 -- | Perform a dependency analysis starting from the current targets
641 -- and update the session with the new module graph.
642 depanal :: GhcMonad m =>
643 [ModuleName] -- ^ excluded modules
644 -> Bool -- ^ allow duplicate roots
646 depanal excluded_mods allow_dup_roots = do
647 hsc_env <- getSession
649 dflags = hsc_dflags hsc_env
650 targets = hsc_targets hsc_env
651 old_graph = hsc_mod_graph hsc_env
653 liftIO $ showPass dflags "Chasing dependencies"
654 liftIO $ debugTraceMsg dflags 2 (hcat [
655 text "Chasing modules from: ",
656 hcat (punctuate comma (map pprTarget targets))])
658 mod_graph <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
659 modifySession $ \_ -> hsc_env { hsc_mod_graph = mod_graph }
664 | LoadUpTo ModuleName
665 | LoadDependenciesOf ModuleName
667 -- | Try to load the program. Calls 'loadWithLogger' with the default
668 -- compiler that just immediately logs all warnings and errors.
670 -- This function may throw a 'SourceError' if errors are encountered before
671 -- the actual compilation starts (e.g., during dependency analysis).
673 load :: GhcMonad m => LoadHowMuch -> m SuccessFlag
675 mod_graph <- depanal [] False
676 load2 how_much mod_graph
678 -- | A function called to log warnings and errors.
679 type WarnErrLogger = GhcMonad m => Maybe SourceError -> m ()
681 defaultWarnErrLogger :: WarnErrLogger
682 defaultWarnErrLogger Nothing = printWarnings
683 defaultWarnErrLogger (Just e) = printExceptionAndWarnings e
685 -- | Try to load the program. If a Module is supplied, then just
686 -- attempt to load up to this target. If no Module is supplied,
687 -- then try to load all targets.
689 -- The first argument is a function that is called after compiling each
690 -- module to print wanrings and errors.
692 -- While compiling a module, all 'SourceError's are caught and passed to the
693 -- logger, however, this function may still throw a 'SourceError' if
694 -- dependency analysis failed (e.g., due to a parse error).
696 loadWithLogger :: GhcMonad m => WarnErrLogger -> LoadHowMuch -> m SuccessFlag
697 loadWithLogger logger how_much = do
698 -- Dependency analysis first. Note that this fixes the module graph:
699 -- even if we don't get a fully successful upsweep, the full module
700 -- graph is still retained in the Session. We can tell which modules
701 -- were successfully loaded by inspecting the Session's HPT.
702 withLocalCallbacks (\cbs -> cbs { reportModuleCompilationResult =
706 load2 :: GhcMonad m => LoadHowMuch -> [ModSummary]
708 load2 how_much mod_graph = do
710 hsc_env <- getSession
712 let hpt1 = hsc_HPT hsc_env
713 let dflags = hsc_dflags hsc_env
715 -- The "bad" boot modules are the ones for which we have
716 -- B.hs-boot in the module graph, but no B.hs
717 -- The downsweep should have ensured this does not happen
719 let all_home_mods = [ms_mod_name s
720 | s <- mod_graph, not (isBootSummary s)]
721 bad_boot_mods = [s | s <- mod_graph, isBootSummary s,
722 not (ms_mod_name s `elem` all_home_mods)]
723 ASSERT( null bad_boot_mods ) return ()
725 -- check that the module given in HowMuch actually exists, otherwise
726 -- topSortModuleGraph will bomb later.
727 let checkHowMuch (LoadUpTo m) = checkMod m
728 checkHowMuch (LoadDependenciesOf m) = checkMod m
732 | m `elem` all_home_mods = and_then
734 liftIO $ errorMsg dflags (text "no such module:" <+>
738 checkHowMuch how_much $ do
740 -- mg2_with_srcimps drops the hi-boot nodes, returning a
741 -- graph with cycles. Among other things, it is used for
742 -- backing out partially complete cycles following a failed
743 -- upsweep, and for removing from hpt all the modules
744 -- not in strict downwards closure, during calls to compile.
745 let mg2_with_srcimps :: [SCC ModSummary]
746 mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
748 -- If we can determine that any of the {-# SOURCE #-} imports
749 -- are definitely unnecessary, then emit a warning.
750 warnUnnecessarySourceImports mg2_with_srcimps
753 -- check the stability property for each module.
754 stable_mods@(stable_obj,stable_bco)
755 = checkStability hpt1 mg2_with_srcimps all_home_mods
757 -- prune bits of the HPT which are definitely redundant now,
759 pruned_hpt = pruneHomePackageTable hpt1
760 (flattenSCCs mg2_with_srcimps)
763 liftIO $ evaluate pruned_hpt
765 -- before we unload anything, make sure we don't leave an old
766 -- interactive context around pointing to dead bindings. Also,
767 -- write the pruned HPT to allow the old HPT to be GC'd.
768 modifySession $ \_ -> hsc_env{ hsc_IC = emptyInteractiveContext,
769 hsc_HPT = pruned_hpt }
771 liftIO $ debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
772 text "Stable BCO:" <+> ppr stable_bco)
774 -- Unload any modules which are going to be re-linked this time around.
775 let stable_linkables = [ linkable
776 | m <- stable_obj++stable_bco,
777 Just hmi <- [lookupUFM pruned_hpt m],
778 Just linkable <- [hm_linkable hmi] ]
779 liftIO $ unload hsc_env stable_linkables
781 -- We could at this point detect cycles which aren't broken by
782 -- a source-import, and complain immediately, but it seems better
783 -- to let upsweep_mods do this, so at least some useful work gets
784 -- done before the upsweep is abandoned.
785 --hPutStrLn stderr "after tsort:\n"
786 --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
788 -- Now do the upsweep, calling compile for each module in
789 -- turn. Final result is version 3 of everything.
791 -- Topologically sort the module graph, this time including hi-boot
792 -- nodes, and possibly just including the portion of the graph
793 -- reachable from the module specified in the 2nd argument to load.
794 -- This graph should be cycle-free.
795 -- If we're restricting the upsweep to a portion of the graph, we
796 -- also want to retain everything that is still stable.
797 let full_mg :: [SCC ModSummary]
798 full_mg = topSortModuleGraph False mod_graph Nothing
800 maybe_top_mod = case how_much of
802 LoadDependenciesOf m -> Just m
805 partial_mg0 :: [SCC ModSummary]
806 partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod
808 -- LoadDependenciesOf m: we want the upsweep to stop just
809 -- short of the specified module (unless the specified module
812 | LoadDependenciesOf _mod <- how_much
813 = ASSERT( case last partial_mg0 of
814 AcyclicSCC ms -> ms_mod_name ms == _mod; _ -> False )
815 List.init partial_mg0
821 | AcyclicSCC ms <- full_mg,
822 ms_mod_name ms `elem` stable_obj++stable_bco,
823 ms_mod_name ms `notElem` [ ms_mod_name ms' |
824 AcyclicSCC ms' <- partial_mg ] ]
826 mg = stable_mg ++ partial_mg
828 -- clean up between compilations
829 let cleanup = cleanTempFilesExcept dflags
830 (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
832 liftIO $ debugTraceMsg dflags 2 (hang (text "Ready for upsweep")
834 (upsweep_ok, hsc_env1, modsUpswept)
835 <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
836 pruned_hpt stable_mods cleanup mg
838 -- Make modsDone be the summaries for each home module now
839 -- available; this should equal the domain of hpt3.
840 -- Get in in a roughly top .. bottom order (hence reverse).
842 let modsDone = reverse modsUpswept
844 -- Try and do linking in some form, depending on whether the
845 -- upsweep was completely or only partially successful.
847 if succeeded upsweep_ok
850 -- Easy; just relink it all.
851 do liftIO $ debugTraceMsg dflags 2 (text "Upsweep completely successful.")
853 -- Clean up after ourselves
854 liftIO $ cleanTempFilesExcept dflags (ppFilesFromSummaries modsDone)
856 -- Issue a warning for the confusing case where the user
857 -- said '-o foo' but we're not going to do any linking.
858 -- We attempt linking if either (a) one of the modules is
859 -- called Main, or (b) the user said -no-hs-main, indicating
860 -- that main() is going to come from somewhere else.
862 let ofile = outputFile dflags
863 let no_hs_main = dopt Opt_NoHsMain dflags
865 main_mod = mainModIs dflags
866 a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
867 do_linking = a_root_is_Main || no_hs_main
869 when (ghcLink dflags == LinkBinary
870 && isJust ofile && not do_linking) $
871 liftIO $ debugTraceMsg dflags 1 $
872 text ("Warning: output was redirected with -o, " ++
873 "but no output will be generated\n" ++
874 "because there is no " ++
875 moduleNameString (moduleName main_mod) ++ " module.")
877 -- link everything together
878 linkresult <- liftIO $ link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)
880 loadFinish Succeeded linkresult hsc_env1
883 -- Tricky. We need to back out the effects of compiling any
884 -- half-done cycles, both so as to clean up the top level envs
885 -- and to avoid telling the interactive linker to link them.
886 do liftIO $ debugTraceMsg dflags 2 (text "Upsweep partially successful.")
889 = map ms_mod modsDone
890 let mods_to_zap_names
891 = findPartiallyCompletedCycles modsDone_names
894 = filter ((`notElem` mods_to_zap_names).ms_mod)
897 let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep)
900 -- Clean up after ourselves
901 liftIO $ cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep)
903 -- there should be no Nothings where linkables should be, now
904 ASSERT(all (isJust.hm_linkable)
905 (eltsUFM (hsc_HPT hsc_env))) do
907 -- Link everything together
908 linkresult <- liftIO $ link (ghcLink dflags) dflags False hpt4
910 let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
911 loadFinish Failed linkresult hsc_env4
913 -- Finish up after a load.
915 -- If the link failed, unload everything and return.
916 loadFinish :: GhcMonad m =>
917 SuccessFlag -> SuccessFlag -> HscEnv
919 loadFinish _all_ok Failed hsc_env
920 = do liftIO $ unload hsc_env []
921 modifySession $ \_ -> discardProg hsc_env
924 -- Empty the interactive context and set the module context to the topmost
925 -- newly loaded module, or the Prelude if none were loaded.
926 loadFinish all_ok Succeeded hsc_env
927 = do modifySession $ \_ -> hsc_env{ hsc_IC = emptyInteractiveContext }
931 -- Forget the current program, but retain the persistent info in HscEnv
932 discardProg :: HscEnv -> HscEnv
934 = hsc_env { hsc_mod_graph = emptyMG,
935 hsc_IC = emptyInteractiveContext,
936 hsc_HPT = emptyHomePackageTable }
938 -- used to fish out the preprocess output files for the purposes of
939 -- cleaning up. The preprocessed file *might* be the same as the
940 -- source file, but that doesn't do any harm.
941 ppFilesFromSummaries :: [ModSummary] -> [FilePath]
942 ppFilesFromSummaries summaries = map ms_hspp_file summaries
944 -- -----------------------------------------------------------------------------
946 class ParsedMod m where
947 modSummary :: m -> ModSummary
948 parsedSource :: m -> ParsedSource
950 class ParsedMod m => TypecheckedMod m where
951 renamedSource :: m -> Maybe RenamedSource
952 typecheckedSource :: m -> TypecheckedSource
953 moduleInfo :: m -> ModuleInfo
954 tm_internals :: m -> (TcGblEnv, ModDetails)
955 -- ToDo: improvements that could be made here:
956 -- if the module succeeded renaming but not typechecking,
957 -- we can still get back the GlobalRdrEnv and exports, so
958 -- perhaps the ModuleInfo should be split up into separate
961 class TypecheckedMod m => DesugaredMod m where
962 coreModule :: m -> ModGuts
964 -- | The result of successful parsing.
966 ParsedModule { pm_mod_summary :: ModSummary
967 , pm_parsed_source :: ParsedSource }
969 instance ParsedMod ParsedModule where
970 modSummary m = pm_mod_summary m
971 parsedSource m = pm_parsed_source m
973 -- | The result of successful typechecking. It also contains the parser
975 data TypecheckedModule =
976 TypecheckedModule { tm_parsed_module :: ParsedModule
977 , tm_renamed_source :: Maybe RenamedSource
978 , tm_typechecked_source :: TypecheckedSource
979 , tm_checked_module_info :: ModuleInfo
980 , tm_internals_ :: (TcGblEnv, ModDetails)
983 instance ParsedMod TypecheckedModule where
984 modSummary m = modSummary (tm_parsed_module m)
985 parsedSource m = parsedSource (tm_parsed_module m)
987 instance TypecheckedMod TypecheckedModule where
988 renamedSource m = tm_renamed_source m
989 typecheckedSource m = tm_typechecked_source m
990 moduleInfo m = tm_checked_module_info m
991 tm_internals m = tm_internals_ m
993 -- | The result of successful desugaring (i.e., translation to core). Also
994 -- contains all the information of a typechecked module.
995 data DesugaredModule =
996 DesugaredModule { dm_typechecked_module :: TypecheckedModule
997 , dm_core_module :: ModGuts
1000 instance ParsedMod DesugaredModule where
1001 modSummary m = modSummary (dm_typechecked_module m)
1002 parsedSource m = parsedSource (dm_typechecked_module m)
1004 instance TypecheckedMod DesugaredModule where
1005 renamedSource m = renamedSource (dm_typechecked_module m)
1006 typecheckedSource m = typecheckedSource (dm_typechecked_module m)
1007 moduleInfo m = moduleInfo (dm_typechecked_module m)
1008 tm_internals m = tm_internals_ (dm_typechecked_module m)
1010 instance DesugaredMod DesugaredModule where
1011 coreModule m = dm_core_module m
1013 type ParsedSource = Located (HsModule RdrName)
1014 type RenamedSource = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
1015 Maybe (HsDoc Name), HaddockModInfo Name)
1016 type TypecheckedSource = LHsBinds Id
1019 -- - things that aren't in the output of the typechecker right now:
1020 -- - the export list
1022 -- - type signatures
1023 -- - type/data/newtype declarations
1024 -- - class declarations
1026 -- - extra things in the typechecker's output:
1027 -- - default methods are turned into top-level decls.
1028 -- - dictionary bindings
1030 -- | Return the 'ModSummary' of a module with the given name.
1032 -- The module must be part of the module graph (see 'hsc_mod_graph' and
1033 -- 'ModuleGraph'). If this is not the case, this function will throw a
1036 -- This function ignores boot modules and requires that there is only one
1037 -- non-boot module with the given name.
1038 getModSummary :: GhcMonad m => ModuleName -> m ModSummary
1039 getModSummary mod = do
1040 mg <- liftM hsc_mod_graph getSession
1041 case [ ms | ms <- mg, ms_mod_name ms == mod, not (isBootSummary ms) ] of
1042 [] -> throw $ mkApiErr (text "Module not part of module graph")
1044 multiple -> throw $ mkApiErr (text "getModSummary is ambiguous: " <+> ppr multiple)
1046 -- | Parse a module.
1048 -- Throws a 'SourceError' on parse error.
1049 parseModule :: GhcMonad m => ModSummary -> m ParsedModule
1051 rdr_module <- withTempSession
1052 (\e -> e { hsc_dflags = ms_hspp_opts ms }) $
1054 return (ParsedModule ms rdr_module)
1056 -- | Typecheck and rename a parsed module.
1058 -- Throws a 'SourceError' if either fails.
1059 typecheckModule :: GhcMonad m => ParsedModule -> m TypecheckedModule
1060 typecheckModule pmod = do
1061 let ms = modSummary pmod
1062 withTempSession (\e -> e { hsc_dflags = ms_hspp_opts ms }) $ do
1063 (tc_gbl_env, rn_info)
1064 <- hscTypecheckRename ms (parsedSource pmod)
1065 details <- makeSimpleDetails tc_gbl_env
1068 tm_internals_ = (tc_gbl_env, details),
1069 tm_parsed_module = pmod,
1070 tm_renamed_source = rn_info,
1071 tm_typechecked_source = tcg_binds tc_gbl_env,
1072 tm_checked_module_info =
1074 minf_type_env = md_types details,
1075 minf_exports = availsToNameSet $ md_exports details,
1076 minf_rdr_env = Just (tcg_rdr_env tc_gbl_env),
1077 minf_instances = md_insts details
1079 ,minf_modBreaks = emptyModBreaks
1083 -- | Desugar a typechecked module.
1084 desugarModule :: GhcMonad m => TypecheckedModule -> m DesugaredModule
1085 desugarModule tcm = do
1086 let ms = modSummary tcm
1087 withTempSession (\e -> e { hsc_dflags = ms_hspp_opts ms }) $ do
1088 let (tcg, _) = tm_internals tcm
1089 guts <- hscDesugar ms tcg
1092 dm_typechecked_module = tcm,
1093 dm_core_module = guts
1096 -- | Load a module. Input doesn't need to be desugared.
1098 -- XXX: Describe usage.
1099 loadModule :: (TypecheckedMod mod, GhcMonad m) => mod -> m mod
1101 let ms = modSummary tcm
1102 let mod = ms_mod_name ms
1103 let (tcg, _details) = tm_internals tcm
1105 withTempSession (\e -> e { hsc_dflags = ms_hspp_opts ms }) $ do
1107 let compilerBackend comp env ms' _ _mb_old_iface _ =
1108 withTempSession (\_ -> env) $
1109 hscBackend comp tcg ms'
1111 hsc_env <- getSession
1113 <- compile' (compilerBackend hscNothingCompiler
1114 ,compilerBackend hscInteractiveCompiler
1115 ,compilerBackend hscBatchCompiler)
1116 hsc_env ms 1 1 Nothing Nothing
1117 -- compile' shouldn't change the environment
1118 return $ addToUFM (hsc_HPT hsc_env) mod mod_info
1119 modifySession $ \e -> e{ hsc_HPT = hpt_new }
1122 -- | This is the way to get access to the Core bindings corresponding
1123 -- to a module. 'compileToCore' parses, typechecks, and
1124 -- desugars the module, then returns the resulting Core module (consisting of
1125 -- the module name, type declarations, and function declarations) if
1127 compileToCoreModule :: GhcMonad m => FilePath -> m CoreModule
1128 compileToCoreModule = compileCore False
1130 -- | Like compileToCoreModule, but invokes the simplifier, so
1131 -- as to return simplified and tidied Core.
1132 compileToCoreSimplified :: GhcMonad m => FilePath -> m CoreModule
1133 compileToCoreSimplified = compileCore True
1135 -- | Provided for backwards-compatibility: compileToCore returns just the Core
1136 -- bindings, but for most purposes, you probably want to call
1137 -- compileToCoreModule.
1138 compileToCore :: GhcMonad m => FilePath -> m [CoreBind]
1139 compileToCore fn = do
1140 mod <- compileToCoreModule session fn
1141 return $ cm_binds mod
1143 -- | Takes a CoreModule and compiles the bindings therein
1144 -- to object code. The first argument is a bool flag indicating
1145 -- whether to run the simplifier.
1146 -- The resulting .o, .hi, and executable files, if any, are stored in the
1147 -- current directory, and named according to the module name.
1148 -- This has only so far been tested with a single self-contained module.
1149 compileCoreToObj :: GhcMonad m => Bool -> CoreModule -> m ()
1150 compileCoreToObj simplify cm@(CoreModule{ cm_module = mName }) = do
1151 dflags <- getSessionDynFlags
1152 currentTime <- liftIO $ getClockTime
1153 cwd <- liftIO $ getCurrentDirectory
1154 modLocation <- liftIO $ mkHiOnlyModLocation dflags (hiSuf dflags) cwd
1155 ((moduleNameSlashes . moduleName) mName)
1157 let modSummary = ModSummary { ms_mod = mName,
1158 ms_hsc_src = ExtCoreFile,
1159 ms_location = modLocation,
1160 -- By setting the object file timestamp to Nothing,
1161 -- we always force recompilation, which is what we
1162 -- want. (Thus it doesn't matter what the timestamp
1163 -- for the (nonexistent) source file is.)
1164 ms_hs_date = currentTime,
1165 ms_obj_date = Nothing,
1166 -- Only handling the single-module case for now, so no imports.
1171 ms_hspp_opts = dflags,
1172 ms_hspp_buf = Nothing
1175 let maybe_simplify mod_guts | simplify = hscSimplify mod_guts
1176 | otherwise = return mod_guts
1177 guts <- maybe_simplify (mkModGuts cm)
1178 (iface, changed, _details, cgguts)
1179 <- hscNormalIface guts Nothing
1180 hscWriteIface iface changed modSummary
1181 hscGenHardCode cgguts modSummary
1184 -- Makes a "vanilla" ModGuts.
1185 mkModGuts :: CoreModule -> ModGuts
1186 mkModGuts coreModule = ModGuts {
1187 mg_module = cm_module coreModule,
1190 mg_deps = noDependencies,
1191 mg_dir_imps = emptyModuleEnv,
1192 mg_used_names = emptyNameSet,
1193 mg_rdr_env = emptyGlobalRdrEnv,
1194 mg_fix_env = emptyFixityEnv,
1195 mg_types = emptyTypeEnv,
1199 mg_binds = cm_binds coreModule,
1200 mg_foreign = NoStubs,
1201 mg_warns = NoWarnings,
1203 mg_hpc_info = emptyHpcInfo False,
1204 mg_modBreaks = emptyModBreaks,
1205 mg_vect_info = noVectInfo,
1206 mg_inst_env = emptyInstEnv,
1207 mg_fam_inst_env = emptyFamInstEnv
1210 compileCore :: GhcMonad m => Bool -> FilePath -> m CoreModule
1211 compileCore simplify fn = do
1212 -- First, set the target to the desired filename
1213 target <- guessTarget fn Nothing
1216 -- Then find dependencies
1217 modGraph <- depanal [] True
1218 case find ((== fn) . msHsFilePath) modGraph of
1219 Just modSummary -> do
1220 -- Now we have the module name;
1221 -- parse, typecheck and desugar the module
1222 mod_guts <- coreModule `fmap`
1223 -- TODO: space leaky: call hsc* directly?
1224 (desugarModule =<< typecheckModule =<< parseModule modSummary)
1225 liftM gutsToCoreModule $
1228 -- If simplify is true: simplify (hscSimplify), then tidy
1230 hsc_env <- getSession
1231 simpl_guts <- hscSimplify mod_guts
1232 tidy_guts <- liftIO $ tidyProgram hsc_env simpl_guts
1233 return $ Left tidy_guts
1235 return $ Right mod_guts
1237 Nothing -> panic "compileToCoreModule: target FilePath not found in\
1238 module dependency graph"
1239 where -- two versions, based on whether we simplify (thus run tidyProgram,
1240 -- which returns a (CgGuts, ModDetails) pair, or not (in which case
1241 -- we just have a ModGuts.
1242 gutsToCoreModule :: Either (CgGuts, ModDetails) ModGuts -> CoreModule
1243 gutsToCoreModule (Left (cg, md)) = CoreModule {
1244 cm_module = cg_module cg, cm_types = md_types md,
1245 cm_imports = cg_dir_imps cg, cm_binds = cg_binds cg
1247 gutsToCoreModule (Right mg) = CoreModule {
1248 cm_module = mg_module mg, cm_types = mg_types mg,
1249 cm_imports = moduleEnvKeys (mg_dir_imps mg), cm_binds = mg_binds mg
1252 -- ---------------------------------------------------------------------------
1255 unload :: HscEnv -> [Linkable] -> IO ()
1256 unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
1257 = case ghcLink (hsc_dflags hsc_env) of
1259 LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
1261 LinkInMemory -> panic "unload: no interpreter"
1262 -- urgh. avoid warnings:
1263 hsc_env stable_linkables
1267 -- -----------------------------------------------------------------------------
1271 Stability tells us which modules definitely do not need to be recompiled.
1272 There are two main reasons for having stability:
1274 - avoid doing a complete upsweep of the module graph in GHCi when
1275 modules near the bottom of the tree have not changed.
1277 - to tell GHCi when it can load object code: we can only load object code
1278 for a module when we also load object code fo all of the imports of the
1279 module. So we need to know that we will definitely not be recompiling
1280 any of these modules, and we can use the object code.
1282 The stability check is as follows. Both stableObject and
1283 stableBCO are used during the upsweep phase later.
1286 stable m = stableObject m || stableBCO m
1289 all stableObject (imports m)
1290 && old linkable does not exist, or is == on-disk .o
1291 && date(on-disk .o) > date(.hs)
1294 all stable (imports m)
1295 && date(BCO) > date(.hs)
1298 These properties embody the following ideas:
1300 - if a module is stable, then:
1302 - if it has been compiled in a previous pass (present in HPT)
1303 then it does not need to be compiled or re-linked.
1305 - if it has not been compiled in a previous pass,
1306 then we only need to read its .hi file from disk and
1307 link it to produce a 'ModDetails'.
1309 - if a modules is not stable, we will definitely be at least
1310 re-linking, and possibly re-compiling it during the 'upsweep'.
1311 All non-stable modules can (and should) therefore be unlinked
1312 before the 'upsweep'.
1314 - Note that objects are only considered stable if they only depend
1315 on other objects. We can't link object code against byte code.
1319 :: HomePackageTable -- HPT from last compilation
1320 -> [SCC ModSummary] -- current module graph (cyclic)
1321 -> [ModuleName] -- all home modules
1322 -> ([ModuleName], -- stableObject
1323 [ModuleName]) -- stableBCO
1325 checkStability hpt sccs all_home_mods = foldl checkSCC ([],[]) sccs
1327 checkSCC (stable_obj, stable_bco) scc0
1328 | stableObjects = (scc_mods ++ stable_obj, stable_bco)
1329 | stableBCOs = (stable_obj, scc_mods ++ stable_bco)
1330 | otherwise = (stable_obj, stable_bco)
1332 scc = flattenSCC scc0
1333 scc_mods = map ms_mod_name scc
1334 home_module m = m `elem` all_home_mods && m `notElem` scc_mods
1336 scc_allimps = nub (filter home_module (concatMap ms_allimps scc))
1337 -- all imports outside the current SCC, but in the home pkg
1339 stable_obj_imps = map (`elem` stable_obj) scc_allimps
1340 stable_bco_imps = map (`elem` stable_bco) scc_allimps
1344 && all object_ok scc
1347 and (zipWith (||) stable_obj_imps stable_bco_imps)
1351 | Just t <- ms_obj_date ms = t >= ms_hs_date ms
1355 same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
1356 Just hmi | Just l <- hm_linkable hmi
1357 -> isObjectLinkable l && t == linkableTime l
1359 -- why '>=' rather than '>' above? If the filesystem stores
1360 -- times to the nearset second, we may occasionally find that
1361 -- the object & source have the same modification time,
1362 -- especially if the source was automatically generated
1363 -- and compiled. Using >= is slightly unsafe, but it matches
1364 -- make's behaviour.
1367 = case lookupUFM hpt (ms_mod_name ms) of
1368 Just hmi | Just l <- hm_linkable hmi ->
1369 not (isObjectLinkable l) &&
1370 linkableTime l >= ms_hs_date ms
1373 ms_allimps :: ModSummary -> [ModuleName]
1374 ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
1376 -- -----------------------------------------------------------------------------
1378 -- | Prune the HomePackageTable
1380 -- Before doing an upsweep, we can throw away:
1382 -- - For non-stable modules:
1383 -- - all ModDetails, all linked code
1384 -- - all unlinked code that is out of date with respect to
1387 -- This is VERY IMPORTANT otherwise we'll end up requiring 2x the
1388 -- space at the end of the upsweep, because the topmost ModDetails of the
1389 -- old HPT holds on to the entire type environment from the previous
1392 pruneHomePackageTable
1395 -> ([ModuleName],[ModuleName])
1398 pruneHomePackageTable hpt summ (stable_obj, stable_bco)
1401 | is_stable modl = hmi'
1402 | otherwise = hmi'{ hm_details = emptyModDetails }
1404 modl = moduleName (mi_module (hm_iface hmi))
1405 hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
1406 = hmi{ hm_linkable = Nothing }
1409 where ms = expectJust "prune" (lookupUFM ms_map modl)
1411 ms_map = listToUFM [(ms_mod_name ms, ms) | ms <- summ]
1413 is_stable m = m `elem` stable_obj || m `elem` stable_bco
1415 -- -----------------------------------------------------------------------------
1417 -- Return (names of) all those in modsDone who are part of a cycle
1418 -- as defined by theGraph.
1419 findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
1420 findPartiallyCompletedCycles modsDone theGraph
1424 chew ((AcyclicSCC _):rest) = chew rest -- acyclic? not interesting.
1425 chew ((CyclicSCC vs):rest)
1426 = let names_in_this_cycle = nub (map ms_mod vs)
1428 = nub ([done | done <- modsDone,
1429 done `elem` names_in_this_cycle])
1430 chewed_rest = chew rest
1432 if notNull mods_in_this_cycle
1433 && length mods_in_this_cycle < length names_in_this_cycle
1434 then mods_in_this_cycle ++ chewed_rest
1437 -- -----------------------------------------------------------------------------
1441 -- This is where we compile each module in the module graph, in a pass
1442 -- from the bottom to the top of the graph.
1444 -- There better had not be any cyclic groups here -- we check for them.
1448 HscEnv -- ^ Includes initially-empty HPT
1449 -> HomePackageTable -- ^ HPT from last time round (pruned)
1450 -> ([ModuleName],[ModuleName]) -- ^ stable modules (see checkStability)
1451 -> IO () -- ^ How to clean up unwanted tmp files
1452 -> [SCC ModSummary] -- ^ Mods to do (the worklist)
1454 HscEnv, -- With an updated HPT
1455 [ModSummary]) -- Mods which succeeded
1457 upsweep hsc_env old_hpt stable_mods cleanup sccs = do
1458 (res, hsc_env, done) <- upsweep' hsc_env old_hpt [] sccs 1 (length sccs)
1459 return (res, hsc_env, reverse done)
1462 upsweep' hsc_env _old_hpt done
1464 = return (Succeeded, hsc_env, done)
1466 upsweep' hsc_env _old_hpt done
1467 (CyclicSCC ms:_) _ _
1468 = do liftIO $ fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1469 return (Failed, hsc_env, done)
1471 upsweep' hsc_env old_hpt done
1472 (AcyclicSCC mod:mods) mod_index nmods
1473 = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++
1474 -- show (map (moduleUserString.moduleName.mi_module.hm_iface)
1475 -- (moduleEnvElts (hsc_HPT hsc_env)))
1476 let logger = reportModuleCompilationResult (hsc_callbacks hsc_env)
1479 <- handleSourceError
1480 (\err -> do logger mod (Just err); return Nothing) $ do
1481 mod_info <- upsweep_mod hsc_env old_hpt stable_mods
1483 logger mod Nothing -- log warnings
1484 return (Just mod_info)
1486 liftIO cleanup -- Remove unwanted tmp files between compilations
1489 Nothing -> return (Failed, hsc_env, done)
1491 let this_mod = ms_mod_name mod
1493 -- Add new info to hsc_env
1494 hpt1 = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1495 hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1497 -- Space-saving: delete the old HPT entry
1498 -- for mod BUT if mod is a hs-boot
1499 -- node, don't delete it. For the
1500 -- interface, the HPT entry is probaby for the
1501 -- main Haskell source file. Deleting it
1502 -- would force the real module to be recompiled
1504 old_hpt1 | isBootSummary mod = old_hpt
1505 | otherwise = delFromUFM old_hpt this_mod
1509 -- fixup our HomePackageTable after we've finished compiling
1510 -- a mutually-recursive loop. See reTypecheckLoop, below.
1511 hsc_env2 <- liftIO $ reTypecheckLoop hsc_env1 mod done'
1513 upsweep' hsc_env2 old_hpt1 done' mods (mod_index+1) nmods
1515 -- | Compile a single module. Always produce a Linkable for it if
1516 -- successful. If no compilation happened, return the old Linkable.
1517 upsweep_mod :: GhcMonad m =>
1520 -> ([ModuleName],[ModuleName])
1522 -> Int -- index of module
1523 -> Int -- total number of modules
1526 upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1528 this_mod_name = ms_mod_name summary
1529 this_mod = ms_mod summary
1530 mb_obj_date = ms_obj_date summary
1531 obj_fn = ml_obj_file (ms_location summary)
1532 hs_date = ms_hs_date summary
1534 is_stable_obj = this_mod_name `elem` stable_obj
1535 is_stable_bco = this_mod_name `elem` stable_bco
1537 old_hmi = lookupUFM old_hpt this_mod_name
1539 -- We're using the dflags for this module now, obtained by
1540 -- applying any options in its LANGUAGE & OPTIONS_GHC pragmas.
1541 dflags = ms_hspp_opts summary
1542 prevailing_target = hscTarget (hsc_dflags hsc_env)
1543 local_target = hscTarget dflags
1545 -- If OPTIONS_GHC contains -fasm or -fvia-C, be careful that
1546 -- we don't do anything dodgy: these should only work to change
1547 -- from -fvia-C to -fasm and vice-versa, otherwise we could
1548 -- end up trying to link object code to byte code.
1549 target = if prevailing_target /= local_target
1550 && (not (isObjectTarget prevailing_target)
1551 || not (isObjectTarget local_target))
1552 then prevailing_target
1555 -- store the corrected hscTarget into the summary
1556 summary' = summary{ ms_hspp_opts = dflags { hscTarget = target } }
1558 -- The old interface is ok if
1559 -- a) we're compiling a source file, and the old HPT
1560 -- entry is for a source file
1561 -- b) we're compiling a hs-boot file
1562 -- Case (b) allows an hs-boot file to get the interface of its
1563 -- real source file on the second iteration of the compilation
1564 -- manager, but that does no harm. Otherwise the hs-boot file
1565 -- will always be recompiled
1570 Just hm_info | isBootSummary summary -> Just iface
1571 | not (mi_boot iface) -> Just iface
1572 | otherwise -> Nothing
1574 iface = hm_iface hm_info
1576 compile_it :: GhcMonad m => Maybe Linkable -> m HomeModInfo
1577 compile_it = compile hsc_env summary' mod_index nmods mb_old_iface
1579 compile_it_discard_iface :: GhcMonad m =>
1580 Maybe Linkable -> m HomeModInfo
1581 compile_it_discard_iface
1582 = compile hsc_env summary' mod_index nmods Nothing
1584 -- With the HscNothing target we create empty linkables to avoid
1585 -- recompilation. We have to detect these to recompile anyway if
1586 -- the target changed since the last compile.
1588 | Just hmi <- old_hmi, Just l <- hm_linkable hmi =
1589 null (linkableUnlinked l)
1591 -- we have no linkable, so it cannot be fake
1594 implies False _ = True
1600 -- Regardless of whether we're generating object code or
1601 -- byte code, we can always use an existing object file
1602 -- if it is *stable* (see checkStability).
1603 | is_stable_obj, Just hmi <- old_hmi -> do
1604 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1605 (text "skipping stable obj mod:" <+> ppr this_mod_name)
1607 -- object is stable, and we have an entry in the
1608 -- old HPT: nothing to do
1610 | is_stable_obj, isNothing old_hmi -> do
1611 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1612 (text "compiling stable on-disk mod:" <+> ppr this_mod_name)
1613 linkable <- liftIO $ findObjectLinkable this_mod obj_fn
1614 (expectJust "upsweep1" mb_obj_date)
1615 compile_it (Just linkable)
1616 -- object is stable, but we need to load the interface
1617 -- off disk to make a HMI.
1619 | not (isObjectTarget target), is_stable_bco,
1620 (target /= HscNothing) `implies` not is_fake_linkable ->
1621 ASSERT(isJust old_hmi) -- must be in the old_hpt
1622 let Just hmi = old_hmi in do
1623 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1624 (text "skipping stable BCO mod:" <+> ppr this_mod_name)
1626 -- BCO is stable: nothing to do
1628 | not (isObjectTarget target),
1629 Just hmi <- old_hmi,
1630 Just l <- hm_linkable hmi,
1631 not (isObjectLinkable l),
1632 (target /= HscNothing) `implies` not is_fake_linkable,
1633 linkableTime l >= ms_hs_date summary -> do
1634 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1635 (text "compiling non-stable BCO mod:" <+> ppr this_mod_name)
1637 -- we have an old BCO that is up to date with respect
1638 -- to the source: do a recompilation check as normal.
1640 -- When generating object code, if there's an up-to-date
1641 -- object file on the disk, then we can use it.
1642 -- However, if the object file is new (compared to any
1643 -- linkable we had from a previous compilation), then we
1644 -- must discard any in-memory interface, because this
1645 -- means the user has compiled the source file
1646 -- separately and generated a new interface, that we must
1647 -- read from the disk.
1649 | isObjectTarget target,
1650 Just obj_date <- mb_obj_date,
1651 obj_date >= hs_date -> do
1654 | Just l <- hm_linkable hmi,
1655 isObjectLinkable l && linkableTime l == obj_date -> do
1656 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1657 (text "compiling mod with new on-disk obj:" <+> ppr this_mod_name)
1660 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1661 (text "compiling mod with new on-disk obj2:" <+> ppr this_mod_name)
1662 linkable <- liftIO $ findObjectLinkable this_mod obj_fn obj_date
1663 compile_it_discard_iface (Just linkable)
1666 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1667 (text "compiling mod:" <+> ppr this_mod_name)
1672 -- Filter modules in the HPT
1673 retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable
1674 retainInTopLevelEnvs keep_these hpt
1675 = listToUFM [ (mod, expectJust "retain" mb_mod_info)
1677 , let mb_mod_info = lookupUFM hpt mod
1678 , isJust mb_mod_info ]
1680 -- ---------------------------------------------------------------------------
1681 -- Typecheck module loops
1684 See bug #930. This code fixes a long-standing bug in --make. The
1685 problem is that when compiling the modules *inside* a loop, a data
1686 type that is only defined at the top of the loop looks opaque; but
1687 after the loop is done, the structure of the data type becomes
1690 The difficulty is then that two different bits of code have
1691 different notions of what the data type looks like.
1693 The idea is that after we compile a module which also has an .hs-boot
1694 file, we re-generate the ModDetails for each of the modules that
1695 depends on the .hs-boot file, so that everyone points to the proper
1696 TyCons, Ids etc. defined by the real module, not the boot module.
1697 Fortunately re-generating a ModDetails from a ModIface is easy: the
1698 function TcIface.typecheckIface does exactly that.
1700 Picking the modules to re-typecheck is slightly tricky. Starting from
1701 the module graph consisting of the modules that have already been
1702 compiled, we reverse the edges (so they point from the imported module
1703 to the importing module), and depth-first-search from the .hs-boot
1704 node. This gives us all the modules that depend transitively on the
1705 .hs-boot module, and those are exactly the modules that we need to
1708 Following this fix, GHC can compile itself with --make -O2.
1711 reTypecheckLoop :: HscEnv -> ModSummary -> ModuleGraph -> IO HscEnv
1712 reTypecheckLoop hsc_env ms graph
1713 | not (isBootSummary ms) &&
1714 any (\m -> ms_mod m == this_mod && isBootSummary m) graph
1716 let mss = reachableBackwards (ms_mod_name ms) graph
1717 non_boot = filter (not.isBootSummary) mss
1718 debugTraceMsg (hsc_dflags hsc_env) 2 $
1719 text "Re-typechecking loop: " <> ppr (map ms_mod_name non_boot)
1720 typecheckLoop hsc_env (map ms_mod_name non_boot)
1724 this_mod = ms_mod ms
1726 typecheckLoop :: HscEnv -> [ModuleName] -> IO HscEnv
1727 typecheckLoop hsc_env mods = do
1729 fixIO $ \new_hpt -> do
1730 let new_hsc_env = hsc_env{ hsc_HPT = new_hpt }
1731 mds <- initIfaceCheck new_hsc_env $
1732 mapM (typecheckIface . hm_iface) hmis
1733 let new_hpt = addListToUFM old_hpt
1734 (zip mods [ hmi{ hm_details = details }
1735 | (hmi,details) <- zip hmis mds ])
1737 return hsc_env{ hsc_HPT = new_hpt }
1739 old_hpt = hsc_HPT hsc_env
1740 hmis = map (expectJust "typecheckLoop" . lookupUFM old_hpt) mods
1742 reachableBackwards :: ModuleName -> [ModSummary] -> [ModSummary]
1743 reachableBackwards mod summaries
1744 = [ ms | (ms,_,_) <- reachableG (transposeG graph) root ]
1745 where -- the rest just sets up the graph:
1746 (graph, lookup_node) = moduleGraphNodes False summaries
1747 root = expectJust "reachableBackwards" (lookup_node HsBootFile mod)
1749 -- ---------------------------------------------------------------------------
1750 -- Topological sort of the module graph
1752 type SummaryNode = (ModSummary, Int, [Int])
1756 -- ^ Drop hi-boot nodes? (see below)
1760 -- ^ Calculate SCCs of the module graph, possibly dropping the hi-boot nodes
1761 -- The resulting list of strongly-connected-components is in topologically
1762 -- sorted order, starting with the module(s) at the bottom of the
1763 -- dependency graph (ie compile them first) and ending with the ones at
1766 -- Drop hi-boot nodes (first boolean arg)?
1768 -- - @False@: treat the hi-boot summaries as nodes of the graph,
1769 -- so the graph must be acyclic
1771 -- - @True@: eliminate the hi-boot nodes, and instead pretend
1772 -- the a source-import of Foo is an import of Foo
1773 -- The resulting graph has no hi-boot nodes, but can be cyclic
1775 topSortModuleGraph drop_hs_boot_nodes summaries mb_root_mod
1776 = map (fmap summaryNodeSummary) $ stronglyConnCompG initial_graph
1778 (graph, lookup_node) = moduleGraphNodes drop_hs_boot_nodes summaries
1780 initial_graph = case mb_root_mod of
1783 -- restrict the graph to just those modules reachable from
1784 -- the specified module. We do this by building a graph with
1785 -- the full set of nodes, and determining the reachable set from
1786 -- the specified node.
1787 let root | Just node <- lookup_node HsSrcFile root_mod, graph `hasVertexG` node = node
1788 | otherwise = ghcError (ProgramError "module does not exist")
1789 in graphFromEdgedVertices (seq root (reachableG graph root))
1791 summaryNodeKey :: SummaryNode -> Int
1792 summaryNodeKey (_, k, _) = k
1794 summaryNodeSummary :: SummaryNode -> ModSummary
1795 summaryNodeSummary (s, _, _) = s
1797 moduleGraphNodes :: Bool -> [ModSummary]
1798 -> (Graph SummaryNode, HscSource -> ModuleName -> Maybe SummaryNode)
1799 moduleGraphNodes drop_hs_boot_nodes summaries = (graphFromEdgedVertices nodes, lookup_node)
1801 numbered_summaries = zip summaries [1..]
1803 lookup_node :: HscSource -> ModuleName -> Maybe SummaryNode
1804 lookup_node hs_src mod = lookupFM node_map (mod, hs_src)
1806 lookup_key :: HscSource -> ModuleName -> Maybe Int
1807 lookup_key hs_src mod = fmap summaryNodeKey (lookup_node hs_src mod)
1809 node_map :: NodeMap SummaryNode
1810 node_map = listToFM [ ((moduleName (ms_mod s), ms_hsc_src s), node)
1811 | node@(s, _, _) <- nodes ]
1813 -- We use integers as the keys for the SCC algorithm
1814 nodes :: [SummaryNode]
1815 nodes = [ (s, key, out_keys)
1816 | (s, key) <- numbered_summaries
1817 -- Drop the hi-boot ones if told to do so
1818 , not (isBootSummary s && drop_hs_boot_nodes)
1819 , let out_keys = out_edge_keys hs_boot_key (map unLoc (ms_srcimps s)) ++
1820 out_edge_keys HsSrcFile (map unLoc (ms_imps s)) ++
1821 (-- see [boot-edges] below
1822 if drop_hs_boot_nodes || ms_hsc_src s == HsBootFile
1824 else case lookup_key HsBootFile (ms_mod_name s) of
1828 -- [boot-edges] if this is a .hs and there is an equivalent
1829 -- .hs-boot, add a link from the former to the latter. This
1830 -- has the effect of detecting bogus cases where the .hs-boot
1831 -- depends on the .hs, by introducing a cycle. Additionally,
1832 -- it ensures that we will always process the .hs-boot before
1833 -- the .hs, and so the HomePackageTable will always have the
1834 -- most up to date information.
1836 -- Drop hs-boot nodes by using HsSrcFile as the key
1837 hs_boot_key | drop_hs_boot_nodes = HsSrcFile
1838 | otherwise = HsBootFile
1840 out_edge_keys :: HscSource -> [ModuleName] -> [Int]
1841 out_edge_keys hi_boot ms = mapCatMaybes (lookup_key hi_boot) ms
1842 -- If we want keep_hi_boot_nodes, then we do lookup_key with
1843 -- the IsBootInterface parameter True; else False
1846 type NodeKey = (ModuleName, HscSource) -- The nodes of the graph are
1847 type NodeMap a = FiniteMap NodeKey a -- keyed by (mod, src_file_type) pairs
1849 msKey :: ModSummary -> NodeKey
1850 msKey (ModSummary { ms_mod = mod, ms_hsc_src = boot }) = (moduleName mod,boot)
1852 mkNodeMap :: [ModSummary] -> NodeMap ModSummary
1853 mkNodeMap summaries = listToFM [ (msKey s, s) | s <- summaries]
1855 nodeMapElts :: NodeMap a -> [a]
1856 nodeMapElts = eltsFM
1858 -- | If there are {-# SOURCE #-} imports between strongly connected
1859 -- components in the topological sort, then those imports can
1860 -- definitely be replaced by ordinary non-SOURCE imports: if SOURCE
1861 -- were necessary, then the edge would be part of a cycle.
1862 warnUnnecessarySourceImports :: GhcMonad m => [SCC ModSummary] -> m ()
1863 warnUnnecessarySourceImports sccs =
1864 logWarnings (listToBag (concatMap (check.flattenSCC) sccs))
1866 let mods_in_this_cycle = map ms_mod_name ms in
1867 [ warn i | m <- ms, i <- ms_srcimps m,
1868 unLoc i `notElem` mods_in_this_cycle ]
1870 warn :: Located ModuleName -> WarnMsg
1873 (ptext (sLit "Warning: {-# SOURCE #-} unnecessary in import of ")
1874 <+> quotes (ppr mod))
1876 -----------------------------------------------------------------------------
1877 -- Downsweep (dependency analysis)
1879 -- Chase downwards from the specified root set, returning summaries
1880 -- for all home modules encountered. Only follow source-import
1883 -- We pass in the previous collection of summaries, which is used as a
1884 -- cache to avoid recalculating a module summary if the source is
1887 -- The returned list of [ModSummary] nodes has one node for each home-package
1888 -- module, plus one for any hs-boot files. The imports of these nodes
1889 -- are all there, including the imports of non-home-package modules.
1891 downsweep :: GhcMonad m =>
1893 -> [ModSummary] -- Old summaries
1894 -> [ModuleName] -- Ignore dependencies on these; treat
1895 -- them as if they were package modules
1896 -> Bool -- True <=> allow multiple targets to have
1897 -- the same module name; this is
1898 -- very useful for ghc -M
1900 -- The elts of [ModSummary] all have distinct
1901 -- (Modules, IsBoot) identifiers, unless the Bool is true
1902 -- in which case there can be repeats
1903 downsweep hsc_env old_summaries excl_mods allow_dup_roots
1904 = do -- catch error messages and return them
1905 --handleErrMsg -- should be covered by GhcMonad now
1906 -- (\err_msg -> printBagOfErrors (hsc_dflags hsc_env) (unitBag err_msg) >> return Nothing) $ do
1907 rootSummaries <- mapM getRootSummary roots
1908 let root_map = mkRootMap rootSummaries
1909 checkDuplicates root_map
1910 summs <- loop (concatMap msDeps rootSummaries) root_map
1913 roots = hsc_targets hsc_env
1915 old_summary_map :: NodeMap ModSummary
1916 old_summary_map = mkNodeMap old_summaries
1918 getRootSummary :: GhcMonad m => Target -> m ModSummary
1919 getRootSummary (Target (TargetFile file mb_phase) obj_allowed maybe_buf)
1920 = do exists <- liftIO $ doesFileExist file
1922 then summariseFile hsc_env old_summaries file mb_phase
1923 obj_allowed maybe_buf
1924 else throwOneError $ mkPlainErrMsg noSrcSpan $
1925 text "can't find file:" <+> text file
1926 getRootSummary (Target (TargetModule modl) obj_allowed maybe_buf)
1927 = do maybe_summary <- summariseModule hsc_env old_summary_map False
1928 (L rootLoc modl) obj_allowed
1930 case maybe_summary of
1931 Nothing -> packageModErr modl
1934 rootLoc = mkGeneralSrcSpan (fsLit "<command line>")
1936 -- In a root module, the filename is allowed to diverge from the module
1937 -- name, so we have to check that there aren't multiple root files
1938 -- defining the same module (otherwise the duplicates will be silently
1939 -- ignored, leading to confusing behaviour).
1940 checkDuplicates :: GhcMonad m => NodeMap [ModSummary] -> m ()
1941 checkDuplicates root_map
1942 | allow_dup_roots = return ()
1943 | null dup_roots = return ()
1944 | otherwise = liftIO $ multiRootsErr (head dup_roots)
1946 dup_roots :: [[ModSummary]] -- Each at least of length 2
1947 dup_roots = filterOut isSingleton (nodeMapElts root_map)
1949 loop :: GhcMonad m =>
1950 [(Located ModuleName,IsBootInterface)]
1951 -- Work list: process these modules
1952 -> NodeMap [ModSummary]
1953 -- Visited set; the range is a list because
1954 -- the roots can have the same module names
1955 -- if allow_dup_roots is True
1957 -- The result includes the worklist, except
1958 -- for those mentioned in the visited set
1959 loop [] done = return (concat (nodeMapElts done))
1960 loop ((wanted_mod, is_boot) : ss) done
1961 | Just summs <- lookupFM done key
1962 = if isSingleton summs then
1965 do { liftIO $ multiRootsErr summs; return [] }
1967 = do mb_s <- summariseModule hsc_env old_summary_map
1968 is_boot wanted_mod True
1971 Nothing -> loop ss done
1972 Just s -> loop (msDeps s ++ ss) (addToFM done key [s])
1974 key = (unLoc wanted_mod, if is_boot then HsBootFile else HsSrcFile)
1976 mkRootMap :: [ModSummary] -> NodeMap [ModSummary]
1977 mkRootMap summaries = addListToFM_C (++) emptyFM
1978 [ (msKey s, [s]) | s <- summaries ]
1980 msDeps :: ModSummary -> [(Located ModuleName, IsBootInterface)]
1981 -- (msDeps s) returns the dependencies of the ModSummary s.
1982 -- A wrinkle is that for a {-# SOURCE #-} import we return
1983 -- *both* the hs-boot file
1984 -- *and* the source file
1985 -- as "dependencies". That ensures that the list of all relevant
1986 -- modules always contains B.hs if it contains B.hs-boot.
1987 -- Remember, this pass isn't doing the topological sort. It's
1988 -- just gathering the list of all relevant ModSummaries
1990 concat [ [(m,True), (m,False)] | m <- ms_srcimps s ]
1991 ++ [ (m,False) | m <- ms_imps s ]
1993 -----------------------------------------------------------------------------
1994 -- Summarising modules
1996 -- We have two types of summarisation:
1998 -- * Summarise a file. This is used for the root module(s) passed to
1999 -- cmLoadModules. The file is read, and used to determine the root
2000 -- module name. The module name may differ from the filename.
2002 -- * Summarise a module. We are given a module name, and must provide
2003 -- a summary. The finder is used to locate the file in which the module
2009 -> [ModSummary] -- old summaries
2010 -> FilePath -- source file name
2011 -> Maybe Phase -- start phase
2012 -> Bool -- object code allowed?
2013 -> Maybe (StringBuffer,ClockTime)
2016 summariseFile hsc_env old_summaries file mb_phase obj_allowed maybe_buf
2017 -- we can use a cached summary if one is available and the
2018 -- source file hasn't changed, But we have to look up the summary
2019 -- by source file, rather than module name as we do in summarise.
2020 | Just old_summary <- findSummaryBySourceFile old_summaries file
2022 let location = ms_location old_summary
2024 -- return the cached summary if the source didn't change
2025 src_timestamp <- case maybe_buf of
2026 Just (_,t) -> return t
2027 Nothing -> liftIO $ getModificationTime file
2028 -- The file exists; we checked in getRootSummary above.
2029 -- If it gets removed subsequently, then this
2030 -- getModificationTime may fail, but that's the right
2033 if ms_hs_date old_summary == src_timestamp
2034 then do -- update the object-file timestamp
2036 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2037 || obj_allowed -- bug #1205
2038 then liftIO $ getObjTimestamp location False
2040 return old_summary{ ms_obj_date = obj_timestamp }
2048 let dflags = hsc_dflags hsc_env
2050 (dflags', hspp_fn, buf)
2051 <- preprocessFile hsc_env file mb_phase maybe_buf
2053 (srcimps,the_imps, L _ mod_name) <- getImports dflags' buf hspp_fn file
2055 -- Make a ModLocation for this file
2056 location <- liftIO $ mkHomeModLocation dflags mod_name file
2058 -- Tell the Finder cache where it is, so that subsequent calls
2059 -- to findModule will find it, even if it's not on any search path
2060 mod <- liftIO $ addHomeModuleToFinder hsc_env mod_name location
2062 src_timestamp <- case maybe_buf of
2063 Just (_,t) -> return t
2064 Nothing -> liftIO $ getModificationTime file
2065 -- getMofificationTime may fail
2067 -- when the user asks to load a source file by name, we only
2068 -- use an object file if -fobject-code is on. See #1205.
2070 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2071 || obj_allowed -- bug #1205
2072 then liftIO $ modificationTimeIfExists (ml_obj_file location)
2075 return (ModSummary { ms_mod = mod, ms_hsc_src = HsSrcFile,
2076 ms_location = location,
2077 ms_hspp_file = hspp_fn,
2078 ms_hspp_opts = dflags',
2079 ms_hspp_buf = Just buf,
2080 ms_srcimps = srcimps, ms_imps = the_imps,
2081 ms_hs_date = src_timestamp,
2082 ms_obj_date = obj_timestamp })
2084 findSummaryBySourceFile :: [ModSummary] -> FilePath -> Maybe ModSummary
2085 findSummaryBySourceFile summaries file
2086 = case [ ms | ms <- summaries, HsSrcFile <- [ms_hsc_src ms],
2087 expectJust "findSummaryBySourceFile" (ml_hs_file (ms_location ms)) == file ] of
2091 -- Summarise a module, and pick up source and timestamp.
2095 -> NodeMap ModSummary -- Map of old summaries
2096 -> IsBootInterface -- True <=> a {-# SOURCE #-} import
2097 -> Located ModuleName -- Imported module to be summarised
2098 -> Bool -- object code allowed?
2099 -> Maybe (StringBuffer, ClockTime)
2100 -> [ModuleName] -- Modules to exclude
2101 -> m (Maybe ModSummary) -- Its new summary
2103 summariseModule hsc_env old_summary_map is_boot (L loc wanted_mod)
2104 obj_allowed maybe_buf excl_mods
2105 | wanted_mod `elem` excl_mods
2108 | Just old_summary <- lookupFM old_summary_map (wanted_mod, hsc_src)
2109 = do -- Find its new timestamp; all the
2110 -- ModSummaries in the old map have valid ml_hs_files
2111 let location = ms_location old_summary
2112 src_fn = expectJust "summariseModule" (ml_hs_file location)
2114 -- check the modification time on the source file, and
2115 -- return the cached summary if it hasn't changed. If the
2116 -- file has disappeared, we need to call the Finder again.
2118 Just (_,t) -> check_timestamp old_summary location src_fn t
2120 m <- liftIO $ System.IO.Error.try (getModificationTime src_fn)
2122 Right t -> check_timestamp old_summary location src_fn t
2123 Left e | isDoesNotExistError e -> find_it
2124 | otherwise -> liftIO $ ioError e
2126 | otherwise = find_it
2128 dflags = hsc_dflags hsc_env
2130 hsc_src = if is_boot then HsBootFile else HsSrcFile
2132 check_timestamp old_summary location src_fn src_timestamp
2133 | ms_hs_date old_summary == src_timestamp = do
2134 -- update the object-file timestamp
2135 obj_timestamp <- liftIO $
2136 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2137 || obj_allowed -- bug #1205
2138 then getObjTimestamp location is_boot
2140 return (Just old_summary{ ms_obj_date = obj_timestamp })
2142 -- source changed: re-summarise.
2143 new_summary location (ms_mod old_summary) src_fn src_timestamp
2146 -- Don't use the Finder's cache this time. If the module was
2147 -- previously a package module, it may have now appeared on the
2148 -- search path, so we want to consider it to be a home module. If
2149 -- the module was previously a home module, it may have moved.
2150 liftIO $ uncacheModule hsc_env wanted_mod
2151 found <- liftIO $ findImportedModule hsc_env wanted_mod Nothing
2154 | isJust (ml_hs_file location) ->
2156 just_found location mod
2158 -- Drop external-pkg
2159 ASSERT(modulePackageId mod /= thisPackage dflags)
2162 err -> liftIO $ noModError dflags loc wanted_mod err
2165 just_found location mod = do
2166 -- Adjust location to point to the hs-boot source file,
2167 -- hi file, object file, when is_boot says so
2168 let location' | is_boot = addBootSuffixLocn location
2169 | otherwise = location
2170 src_fn = expectJust "summarise2" (ml_hs_file location')
2172 -- Check that it exists
2173 -- It might have been deleted since the Finder last found it
2174 maybe_t <- liftIO $ modificationTimeIfExists src_fn
2176 Nothing -> noHsFileErr loc src_fn
2177 Just t -> new_summary location' mod src_fn t
2180 new_summary location mod src_fn src_timestamp
2182 -- Preprocess the source file and get its imports
2183 -- The dflags' contains the OPTIONS pragmas
2184 (dflags', hspp_fn, buf) <- preprocessFile hsc_env src_fn Nothing maybe_buf
2185 (srcimps, the_imps, L mod_loc mod_name) <- getImports dflags' buf hspp_fn src_fn
2187 when (mod_name /= wanted_mod) $
2188 throwOneError $ mkPlainErrMsg mod_loc $
2189 text "File name does not match module name:"
2190 $$ text "Saw:" <+> quotes (ppr mod_name)
2191 $$ text "Expected:" <+> quotes (ppr wanted_mod)
2193 -- Find the object timestamp, and return the summary
2194 obj_timestamp <- liftIO $
2195 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2196 || obj_allowed -- bug #1205
2197 then getObjTimestamp location is_boot
2200 return (Just (ModSummary { ms_mod = mod,
2201 ms_hsc_src = hsc_src,
2202 ms_location = location,
2203 ms_hspp_file = hspp_fn,
2204 ms_hspp_opts = dflags',
2205 ms_hspp_buf = Just buf,
2206 ms_srcimps = srcimps,
2208 ms_hs_date = src_timestamp,
2209 ms_obj_date = obj_timestamp }))
2212 getObjTimestamp :: ModLocation -> Bool -> IO (Maybe ClockTime)
2213 getObjTimestamp location is_boot
2214 = if is_boot then return Nothing
2215 else modificationTimeIfExists (ml_obj_file location)
2218 preprocessFile :: GhcMonad m =>
2221 -> Maybe Phase -- ^ Starting phase
2222 -> Maybe (StringBuffer,ClockTime)
2223 -> m (DynFlags, FilePath, StringBuffer)
2224 preprocessFile hsc_env src_fn mb_phase Nothing
2226 (dflags', hspp_fn) <- preprocess hsc_env (src_fn, mb_phase)
2227 buf <- liftIO $ hGetStringBuffer hspp_fn
2228 return (dflags', hspp_fn, buf)
2230 preprocessFile hsc_env src_fn mb_phase (Just (buf, _time))
2232 let dflags = hsc_dflags hsc_env
2233 -- case we bypass the preprocessing stage?
2235 local_opts = getOptions dflags buf src_fn
2237 (dflags', leftovers, warns)
2238 <- parseDynamicNoPackageFlags dflags local_opts
2239 checkProcessArgsResult leftovers
2240 handleFlagWarnings dflags' warns
2244 | Just (Unlit _) <- mb_phase = True
2245 | Nothing <- mb_phase, Unlit _ <- startPhase src_fn = True
2246 -- note: local_opts is only required if there's no Unlit phase
2247 | dopt Opt_Cpp dflags' = True
2248 | dopt Opt_Pp dflags' = True
2251 when needs_preprocessing $
2252 ghcError (ProgramError "buffer needs preprocesing; interactive check disabled")
2254 return (dflags', src_fn, buf)
2257 -----------------------------------------------------------------------------
2259 -----------------------------------------------------------------------------
2261 noModError :: DynFlags -> SrcSpan -> ModuleName -> FindResult -> IO ab
2262 -- ToDo: we don't have a proper line number for this error
2263 noModError dflags loc wanted_mod err
2264 = throwOneError $ mkPlainErrMsg loc $ cannotFindModule dflags wanted_mod err
2266 noHsFileErr :: GhcMonad m => SrcSpan -> String -> m a
2267 noHsFileErr loc path
2268 = throwOneError $ mkPlainErrMsg loc $ text "Can't find" <+> text path
2270 packageModErr :: GhcMonad m => ModuleName -> m a
2272 = throwOneError $ mkPlainErrMsg noSrcSpan $
2273 text "module" <+> quotes (ppr mod) <+> text "is a package module"
2275 multiRootsErr :: [ModSummary] -> IO ()
2276 multiRootsErr [] = panic "multiRootsErr"
2277 multiRootsErr summs@(summ1:_)
2278 = throwOneError $ mkPlainErrMsg noSrcSpan $
2279 text "module" <+> quotes (ppr mod) <+>
2280 text "is defined in multiple files:" <+>
2281 sep (map text files)
2284 files = map (expectJust "checkDup" . ml_hs_file . ms_location) summs
2286 cyclicModuleErr :: [ModSummary] -> SDoc
2288 = hang (ptext (sLit "Module imports form a cycle for modules:"))
2289 2 (vcat (map show_one ms))
2291 show_one ms = sep [ show_mod (ms_hsc_src ms) (ms_mod ms),
2292 nest 2 $ ptext (sLit "imports:") <+>
2293 (pp_imps HsBootFile (ms_srcimps ms)
2294 $$ pp_imps HsSrcFile (ms_imps ms))]
2295 show_mod hsc_src mod = ppr mod <> text (hscSourceString hsc_src)
2296 pp_imps src mods = fsep (map (show_mod src) mods)
2299 -- | Inform GHC that the working directory has changed. GHC will flush
2300 -- its cache of module locations, since it may no longer be valid.
2301 -- Note: if you change the working directory, you should also unload
2302 -- the current program (set targets to empty, followed by load).
2303 workingDirectoryChanged :: GhcMonad m => m ()
2304 workingDirectoryChanged = withSession $ (liftIO . flushFinderCaches)
2306 -- -----------------------------------------------------------------------------
2307 -- inspecting the session
2309 -- | Get the module dependency graph.
2310 getModuleGraph :: GhcMonad m => m ModuleGraph -- ToDo: DiGraph ModSummary
2311 getModuleGraph = liftM hsc_mod_graph getSession
2313 -- | Return @True@ <==> module is loaded.
2314 isLoaded :: GhcMonad m => ModuleName -> m Bool
2315 isLoaded m = withSession $ \hsc_env ->
2316 return $! isJust (lookupUFM (hsc_HPT hsc_env) m)
2318 -- | Return the bindings for the current interactive session.
2319 getBindings :: GhcMonad m => m [TyThing]
2320 getBindings = withSession $ \hsc_env ->
2321 -- we have to implement the shadowing behaviour of ic_tmp_ids here
2322 -- (see InteractiveContext) and the quickest way is to use an OccEnv.
2324 tmp_ids = ic_tmp_ids (hsc_IC hsc_env)
2325 filtered = foldr f (const []) tmp_ids emptyUniqSet
2327 | uniq `elementOfUniqSet` set = rest set
2328 | otherwise = AnId id : rest (addOneToUniqSet set uniq)
2329 where uniq = getUnique (nameOccName (idName id))
2333 getPrintUnqual :: GhcMonad m => m PrintUnqualified
2334 getPrintUnqual = withSession $ \hsc_env ->
2335 return (icPrintUnqual (hsc_dflags hsc_env) (hsc_IC hsc_env))
2337 -- | Container for information about a 'Module'.
2338 data ModuleInfo = ModuleInfo {
2339 minf_type_env :: TypeEnv,
2340 minf_exports :: NameSet, -- ToDo, [AvailInfo] like ModDetails?
2341 minf_rdr_env :: Maybe GlobalRdrEnv, -- Nothing for a compiled/package mod
2342 minf_instances :: [Instance]
2344 ,minf_modBreaks :: ModBreaks
2346 -- ToDo: this should really contain the ModIface too
2348 -- We don't want HomeModInfo here, because a ModuleInfo applies
2349 -- to package modules too.
2351 -- | Request information about a loaded 'Module'
2352 getModuleInfo :: GhcMonad m => Module -> m (Maybe ModuleInfo) -- XXX: Maybe X
2353 getModuleInfo mdl = withSession $ \hsc_env -> do
2354 let mg = hsc_mod_graph hsc_env
2355 if mdl `elem` map ms_mod mg
2356 then liftIO $ getHomeModuleInfo hsc_env (moduleName mdl)
2358 {- if isHomeModule (hsc_dflags hsc_env) mdl
2360 else -} liftIO $ getPackageModuleInfo hsc_env mdl
2361 -- getPackageModuleInfo will attempt to find the interface, so
2362 -- we don't want to call it for a home module, just in case there
2363 -- was a problem loading the module and the interface doesn't
2364 -- exist... hence the isHomeModule test here. (ToDo: reinstate)
2366 getPackageModuleInfo :: HscEnv -> Module -> IO (Maybe ModuleInfo)
2368 getPackageModuleInfo hsc_env mdl = do
2369 (_msgs, mb_avails) <- getModuleExports hsc_env mdl
2371 Nothing -> return Nothing
2373 eps <- readIORef (hsc_EPS hsc_env)
2375 names = availsToNameSet avails
2377 tys = [ ty | name <- concatMap availNames avails,
2378 Just ty <- [lookupTypeEnv pte name] ]
2380 return (Just (ModuleInfo {
2381 minf_type_env = mkTypeEnv tys,
2382 minf_exports = names,
2383 minf_rdr_env = Just $! nameSetToGlobalRdrEnv names (moduleName mdl),
2384 minf_instances = error "getModuleInfo: instances for package module unimplemented",
2385 minf_modBreaks = emptyModBreaks
2388 getPackageModuleInfo _hsc_env _mdl = do
2389 -- bogusly different for non-GHCI (ToDo)
2393 getHomeModuleInfo :: HscEnv -> ModuleName -> IO (Maybe ModuleInfo)
2394 getHomeModuleInfo hsc_env mdl =
2395 case lookupUFM (hsc_HPT hsc_env) mdl of
2396 Nothing -> return Nothing
2398 let details = hm_details hmi
2399 return (Just (ModuleInfo {
2400 minf_type_env = md_types details,
2401 minf_exports = availsToNameSet (md_exports details),
2402 minf_rdr_env = mi_globals $! hm_iface hmi,
2403 minf_instances = md_insts details
2405 ,minf_modBreaks = getModBreaks hmi
2409 -- | The list of top-level entities defined in a module
2410 modInfoTyThings :: ModuleInfo -> [TyThing]
2411 modInfoTyThings minf = typeEnvElts (minf_type_env minf)
2413 modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]
2414 modInfoTopLevelScope minf
2415 = fmap (map gre_name . globalRdrEnvElts) (minf_rdr_env minf)
2417 modInfoExports :: ModuleInfo -> [Name]
2418 modInfoExports minf = nameSetToList $! minf_exports minf
2420 -- | Returns the instances defined by the specified module.
2421 -- Warning: currently unimplemented for package modules.
2422 modInfoInstances :: ModuleInfo -> [Instance]
2423 modInfoInstances = minf_instances
2425 modInfoIsExportedName :: ModuleInfo -> Name -> Bool
2426 modInfoIsExportedName minf name = elemNameSet name (minf_exports minf)
2428 mkPrintUnqualifiedForModule :: GhcMonad m =>
2430 -> m (Maybe PrintUnqualified) -- XXX: returns a Maybe X
2431 mkPrintUnqualifiedForModule minf = withSession $ \hsc_env -> do
2432 return (fmap (mkPrintUnqualified (hsc_dflags hsc_env)) (minf_rdr_env minf))
2434 modInfoLookupName :: GhcMonad m =>
2436 -> m (Maybe TyThing) -- XXX: returns a Maybe X
2437 modInfoLookupName minf name = withSession $ \hsc_env -> do
2438 case lookupTypeEnv (minf_type_env minf) name of
2439 Just tyThing -> return (Just tyThing)
2441 eps <- liftIO $ readIORef (hsc_EPS hsc_env)
2442 return $! lookupType (hsc_dflags hsc_env)
2443 (hsc_HPT hsc_env) (eps_PTE eps) name
2446 modInfoModBreaks :: ModuleInfo -> ModBreaks
2447 modInfoModBreaks = minf_modBreaks
2450 isDictonaryId :: Id -> Bool
2452 = case tcSplitSigmaTy (idType id) of { (_tvs, _theta, tau) -> isDictTy tau }
2454 -- | Looks up a global name: that is, any top-level name in any
2455 -- visible module. Unlike 'lookupName', lookupGlobalName does not use
2456 -- the interactive context, and therefore does not require a preceding
2458 lookupGlobalName :: GhcMonad m => Name -> m (Maybe TyThing)
2459 lookupGlobalName name = withSession $ \hsc_env -> do
2460 liftIO $ lookupTypeHscEnv hsc_env name
2462 findGlobalAnns :: (GhcMonad m, Typeable a) => ([Word8] -> a) -> AnnTarget Name -> m [a]
2463 findGlobalAnns deserialize target = withSession $ \hsc_env -> do
2464 ann_env <- liftIO $ prepareAnnotations hsc_env Nothing
2465 return (findAnns deserialize ann_env target)
2468 -- | get the GlobalRdrEnv for a session
2469 getGRE :: GhcMonad m => m GlobalRdrEnv
2470 getGRE = withSession $ \hsc_env-> return $ ic_rn_gbl_env (hsc_IC hsc_env)
2473 -- -----------------------------------------------------------------------------
2475 -- | Return all /external/ modules available in the package database.
2476 -- Modules from the current session (i.e., from the 'HomePackageTable') are
2478 packageDbModules :: GhcMonad m =>
2479 Bool -- ^ Only consider exposed packages.
2481 packageDbModules only_exposed = do
2482 dflags <- getSessionDynFlags
2483 let pkgs = UFM.eltsUFM (pkgIdMap (pkgState dflags))
2485 [ mkModule pid modname | p <- pkgs
2486 , not only_exposed || exposed p
2487 , pid <- [mkPackageId (package p)]
2488 , modname <- exposedModules p ]
2490 -- -----------------------------------------------------------------------------
2491 -- Misc exported utils
2493 dataConType :: DataCon -> Type
2494 dataConType dc = idType (dataConWrapId dc)
2496 -- | print a 'NamedThing', adding parentheses if the name is an operator.
2497 pprParenSymName :: NamedThing a => a -> SDoc
2498 pprParenSymName a = parenSymOcc (getOccName a) (ppr (getName a))
2500 -- ----------------------------------------------------------------------------
2505 -- - Data and Typeable instances for HsSyn.
2507 -- ToDo: check for small transformations that happen to the syntax in
2508 -- the typechecker (eg. -e ==> negate e, perhaps for fromIntegral)
2510 -- ToDo: maybe use TH syntax instead of IfaceSyn? There's already a way
2511 -- to get from TyCons, Ids etc. to TH syntax (reify).
2513 -- :browse will use either lm_toplev or inspect lm_interface, depending
2514 -- on whether the module is interpreted or not.
2518 -- Extract the filename, stringbuffer content and dynflags associed to a module
2520 -- XXX: Explain pre-conditions
2521 getModuleSourceAndFlags :: GhcMonad m => Module -> m (String, StringBuffer, DynFlags)
2522 getModuleSourceAndFlags mod = do
2523 m <- getModSummary (moduleName mod)
2524 case ml_hs_file $ ms_location m of
2525 Nothing -> throw $ mkApiErr (text "No source available for module " <+> ppr mod)
2526 Just sourceFile -> do
2527 source <- liftIO $ hGetStringBuffer sourceFile
2528 return (sourceFile, source, ms_hspp_opts m)
2531 -- | Return module source as token stream, including comments.
2533 -- The module must be in the module graph and its source must be available.
2534 -- Throws a 'HscTypes.SourceError' on parse error.
2535 getTokenStream :: GhcMonad m => Module -> m [Located Token]
2536 getTokenStream mod = do
2537 (sourceFile, source, flags) <- getModuleSourceAndFlags mod
2538 let startLoc = mkSrcLoc (mkFastString sourceFile) 0 0
2539 case lexTokenStream source startLoc flags of
2540 POk _ ts -> return ts
2541 PFailed span err -> throw $ mkSrcErr (unitBag $ mkPlainErrMsg span err)
2543 -- | Give even more information on the source than 'getTokenStream'
2544 -- This function allows reconstructing the source completely with
2545 -- 'showRichTokenStream'.
2546 getRichTokenStream :: GhcMonad m => Module -> m [(Located Token, String)]
2547 getRichTokenStream mod = do
2548 (sourceFile, source, flags) <- getModuleSourceAndFlags mod
2549 let startLoc = mkSrcLoc (mkFastString sourceFile) 0 0
2550 case lexTokenStream source startLoc flags of
2551 POk _ ts -> return $ addSourceToTokens startLoc source ts
2552 PFailed span err -> throw $ mkSrcErr (unitBag $ mkPlainErrMsg span err)
2554 -- | Given a source location and a StringBuffer corresponding to this
2555 -- location, return a rich token stream with the source associated to the
2557 addSourceToTokens :: SrcLoc -> StringBuffer -> [Located Token]
2558 -> [(Located Token, String)]
2559 addSourceToTokens _ _ [] = []
2560 addSourceToTokens loc buf (t@(L span _) : ts)
2561 | not (isGoodSrcSpan span) = (t,"") : addSourceToTokens loc buf ts
2562 | otherwise = (t,str) : addSourceToTokens newLoc newBuf ts
2564 (newLoc, newBuf, str) = go "" loc buf
2565 start = srcSpanStart span
2566 end = srcSpanEnd span
2567 go acc loc buf | loc < start = go acc nLoc nBuf
2568 | start <= loc && loc < end = go (ch:acc) nLoc nBuf
2569 | otherwise = (loc, buf, reverse acc)
2570 where (ch, nBuf) = nextChar buf
2571 nLoc = advanceSrcLoc loc ch
2574 -- | Take a rich token stream such as produced from 'getRichTokenStream' and
2575 -- return source code almost identical to the original code (except for
2576 -- insignificant whitespace.)
2577 showRichTokenStream :: [(Located Token, String)] -> String
2578 showRichTokenStream ts = go startLoc ts ""
2579 where sourceFile = srcSpanFile (getLoc . fst . head $ ts)
2580 startLoc = mkSrcLoc sourceFile 0 0
2582 go loc ((L span _, str):ts)
2583 | not (isGoodSrcSpan span) = go loc ts
2584 | locLine == tokLine = ((replicate (tokCol - locCol) ' ') ++)
2587 | otherwise = ((replicate (tokLine - locLine) '\n') ++)
2588 . ((replicate tokCol ' ') ++)
2591 where (locLine, locCol) = (srcLocLine loc, srcLocCol loc)
2592 (tokLine, tokCol) = (srcSpanStartLine span, srcSpanStartCol span)
2593 tokEnd = srcSpanEnd span
2595 -- -----------------------------------------------------------------------------
2596 -- Interactive evaluation
2598 -- | Takes a 'ModuleName' and possibly a 'PackageId', and consults the
2599 -- filesystem and package database to find the corresponding 'Module',
2600 -- using the algorithm that is used for an @import@ declaration.
2601 findModule :: GhcMonad m => ModuleName -> Maybe FastString -> m Module
2602 findModule mod_name maybe_pkg = withSession $ \hsc_env -> liftIO $ -- XXX
2604 dflags = hsc_dflags hsc_env
2605 hpt = hsc_HPT hsc_env
2606 this_pkg = thisPackage dflags
2608 case lookupUFM hpt mod_name of
2609 Just mod_info -> return (mi_module (hm_iface mod_info))
2610 _not_a_home_module -> do
2611 res <- findImportedModule hsc_env mod_name maybe_pkg
2613 Found _ m | modulePackageId m /= this_pkg -> return m
2614 | otherwise -> ghcError (CmdLineError (showSDoc $
2615 text "module" <+> quotes (ppr (moduleName m)) <+>
2616 text "is not loaded"))
2617 err -> let msg = cannotFindModule dflags mod_name err in
2618 ghcError (CmdLineError (showSDoc msg))
2621 getHistorySpan :: GhcMonad m => History -> m SrcSpan
2622 getHistorySpan h = withSession $ \hsc_env ->
2623 return$ InteractiveEval.getHistorySpan hsc_env h
2625 obtainTermFromVal :: GhcMonad m => Int -> Bool -> Type -> a -> m Term
2626 obtainTermFromVal bound force ty a =
2627 withSession $ \hsc_env ->
2628 liftIO $ InteractiveEval.obtainTermFromVal hsc_env bound force ty a
2630 obtainTermFromId :: GhcMonad m => Int -> Bool -> Id -> m Term
2631 obtainTermFromId bound force id =
2632 withSession $ \hsc_env ->
2633 liftIO $ InteractiveEval.obtainTermFromId hsc_env bound force id
projects / ghc-hetmet.git / blob