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,
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 dflags
474 -- -----------------------------------------------------------------------------
477 -- | Grabs the DynFlags from the Session
478 getSessionDynFlags :: GhcMonad m => m DynFlags
479 getSessionDynFlags = withSession (return . hsc_dflags)
481 -- | Updates the DynFlags in a Session. This also reads
482 -- the package database (unless it has already been read),
483 -- and prepares the compilers knowledge about packages. It
484 -- can be called again to load new packages: just add new
485 -- package flags to (packageFlags dflags).
487 -- Returns a list of new packages that may need to be linked in using
488 -- the dynamic linker (see 'linkPackages') as a result of new package
489 -- flags. If you are not doing linking or doing static linking, you
490 -- can ignore the list of packages returned.
492 setSessionDynFlags :: GhcMonad m => DynFlags -> m [PackageId]
493 setSessionDynFlags dflags = do
494 (dflags', preload) <- liftIO $ initPackages dflags
495 modifySession (\h -> h{ hsc_dflags = dflags' })
498 -- | If there is no -o option, guess the name of target executable
499 -- by using top-level source file name as a base.
500 guessOutputFile :: GhcMonad m => m ()
501 guessOutputFile = modifySession $ \env ->
502 let dflags = hsc_dflags env
503 mod_graph = hsc_mod_graph env
504 mainModuleSrcPath :: Maybe String
505 mainModuleSrcPath = do
506 let isMain = (== mainModIs dflags) . ms_mod
507 [ms] <- return (filter isMain mod_graph)
508 ml_hs_file (ms_location ms)
509 name = fmap dropExtension mainModuleSrcPath
511 #if defined(mingw32_HOST_OS)
512 -- we must add the .exe extention unconditionally here, otherwise
513 -- when name has an extension of its own, the .exe extension will
514 -- not be added by DriverPipeline.exeFileName. See #2248
515 name_exe = fmap (<.> "exe") name
520 case outputFile dflags of
522 Nothing -> env { hsc_dflags = dflags { outputFile = name_exe } }
524 -- -----------------------------------------------------------------------------
527 -- ToDo: think about relative vs. absolute file paths. And what
528 -- happens when the current directory changes.
530 -- | Sets the targets for this session. Each target may be a module name
531 -- or a filename. The targets correspond to the set of root modules for
532 -- the program\/library. Unloading the current program is achieved by
533 -- setting the current set of targets to be empty, followed by 'load'.
534 setTargets :: GhcMonad m => [Target] -> m ()
535 setTargets targets = modifySession (\h -> h{ hsc_targets = targets })
537 -- | Returns the current set of targets
538 getTargets :: GhcMonad m => m [Target]
539 getTargets = withSession (return . hsc_targets)
541 -- | Add another target.
542 addTarget :: GhcMonad m => Target -> m ()
544 = modifySession (\h -> h{ hsc_targets = target : hsc_targets h })
547 removeTarget :: GhcMonad m => TargetId -> m ()
548 removeTarget target_id
549 = modifySession (\h -> h{ hsc_targets = filter (hsc_targets h) })
551 filter targets = [ t | t@(Target id _ _) <- targets, id /= target_id ]
553 -- | Attempts to guess what Target a string refers to. This function
554 -- implements the @--make@/GHCi command-line syntax for filenames:
556 -- - if the string looks like a Haskell source filename, then interpret it
559 -- - if adding a .hs or .lhs suffix yields the name of an existing file,
562 -- - otherwise interpret the string as a module name
564 guessTarget :: GhcMonad m => String -> Maybe Phase -> m Target
565 guessTarget str (Just phase)
566 = return (Target (TargetFile str (Just phase)) True Nothing)
567 guessTarget str Nothing
568 | isHaskellSrcFilename file
569 = return (target (TargetFile file Nothing))
571 = do exists <- liftIO $ doesFileExist hs_file
573 then return (target (TargetFile hs_file Nothing))
575 exists <- liftIO $ doesFileExist lhs_file
577 then return (target (TargetFile lhs_file Nothing))
579 if looksLikeModuleName file
580 then return (target (TargetModule (mkModuleName file)))
583 (ProgramError (showSDoc $
584 text "target" <+> quotes (text file) <+>
585 text "is not a module name or a source file"))
588 | '*':rest <- str = (rest, False)
589 | otherwise = (str, True)
591 hs_file = file <.> "hs"
592 lhs_file = file <.> "lhs"
594 target tid = Target tid obj_allowed Nothing
596 -- -----------------------------------------------------------------------------
597 -- Extending the program scope
599 extendGlobalRdrScope :: GhcMonad m => [GlobalRdrElt] -> m ()
600 extendGlobalRdrScope rdrElts
601 = modifySession $ \hscEnv ->
602 let global_rdr = hsc_global_rdr_env hscEnv
603 in hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv global_rdr rdrElts }
605 setGlobalRdrScope :: GhcMonad m => [GlobalRdrElt] -> m ()
606 setGlobalRdrScope rdrElts
607 = modifySession $ \hscEnv ->
608 hscEnv{ hsc_global_rdr_env = foldl extendGlobalRdrEnv emptyGlobalRdrEnv rdrElts }
610 extendGlobalTypeScope :: GhcMonad m => [Id] -> m ()
611 extendGlobalTypeScope ids
612 = modifySession $ \hscEnv ->
613 let global_type = hsc_global_type_env hscEnv
614 in hscEnv{ hsc_global_type_env = extendTypeEnvWithIds global_type ids }
616 setGlobalTypeScope :: GhcMonad m => [Id] -> m ()
617 setGlobalTypeScope ids
618 = modifySession $ \hscEnv ->
619 hscEnv{ hsc_global_type_env = extendTypeEnvWithIds emptyTypeEnv ids }
621 -- -----------------------------------------------------------------------------
622 -- Parsing Haddock comments
624 parseHaddockComment :: String -> Either String (HsDoc RdrName)
625 parseHaddockComment string =
626 case parseHaddockParagraphs (tokenise string) of
630 -- -----------------------------------------------------------------------------
631 -- Loading the program
633 -- | Perform a dependency analysis starting from the current targets
634 -- and update the session with the new module graph.
635 depanal :: GhcMonad m =>
636 [ModuleName] -- ^ excluded modules
637 -> Bool -- ^ allow duplicate roots
639 depanal excluded_mods allow_dup_roots = do
640 hsc_env <- getSession
642 dflags = hsc_dflags hsc_env
643 targets = hsc_targets hsc_env
644 old_graph = hsc_mod_graph hsc_env
646 liftIO $ showPass dflags "Chasing dependencies"
647 liftIO $ debugTraceMsg dflags 2 (hcat [
648 text "Chasing modules from: ",
649 hcat (punctuate comma (map pprTarget targets))])
651 mod_graph <- downsweep hsc_env old_graph excluded_mods allow_dup_roots
652 modifySession $ \_ -> hsc_env { hsc_mod_graph = mod_graph }
657 | LoadUpTo ModuleName
658 | LoadDependenciesOf ModuleName
660 -- | Try to load the program. Calls 'loadWithLogger' with the default
661 -- compiler that just immediately logs all warnings and errors.
663 -- This function may throw a 'SourceError' if errors are encountered before
664 -- the actual compilation starts (e.g., during dependency analysis).
666 load :: GhcMonad m => LoadHowMuch -> m SuccessFlag
668 loadWithLogger defaultWarnErrLogger how_much
670 -- | A function called to log warnings and errors.
671 type WarnErrLogger = GhcMonad m => Maybe SourceError -> m ()
673 defaultWarnErrLogger :: WarnErrLogger
674 defaultWarnErrLogger Nothing = printWarnings
675 defaultWarnErrLogger (Just e) = printExceptionAndWarnings e
677 -- | Try to load the program. If a Module is supplied, then just
678 -- attempt to load up to this target. If no Module is supplied,
679 -- then try to load all targets.
681 -- The first argument is a function that is called after compiling each
682 -- module to print wanrings and errors.
684 -- While compiling a module, all 'SourceError's are caught and passed to the
685 -- logger, however, this function may still throw a 'SourceError' if
686 -- dependency analysis failed (e.g., due to a parse error).
688 loadWithLogger :: GhcMonad m => WarnErrLogger -> LoadHowMuch -> m SuccessFlag
689 loadWithLogger logger how_much = do
690 -- Dependency analysis first. Note that this fixes the module graph:
691 -- even if we don't get a fully successful upsweep, the full module
692 -- graph is still retained in the Session. We can tell which modules
693 -- were successfully loaded by inspecting the Session's HPT.
694 mod_graph <- depanal [] False
695 load2 how_much mod_graph logger
697 load2 :: GhcMonad m => LoadHowMuch -> [ModSummary] -> WarnErrLogger
699 load2 how_much mod_graph logger = do
701 hsc_env <- getSession
703 let hpt1 = hsc_HPT hsc_env
704 let dflags = hsc_dflags hsc_env
706 -- The "bad" boot modules are the ones for which we have
707 -- B.hs-boot in the module graph, but no B.hs
708 -- The downsweep should have ensured this does not happen
710 let all_home_mods = [ms_mod_name s
711 | s <- mod_graph, not (isBootSummary s)]
712 bad_boot_mods = [s | s <- mod_graph, isBootSummary s,
713 not (ms_mod_name s `elem` all_home_mods)]
714 ASSERT( null bad_boot_mods ) return ()
716 -- check that the module given in HowMuch actually exists, otherwise
717 -- topSortModuleGraph will bomb later.
718 let checkHowMuch (LoadUpTo m) = checkMod m
719 checkHowMuch (LoadDependenciesOf m) = checkMod m
723 | m `elem` all_home_mods = and_then
725 liftIO $ errorMsg dflags (text "no such module:" <+>
729 checkHowMuch how_much $ do
731 -- mg2_with_srcimps drops the hi-boot nodes, returning a
732 -- graph with cycles. Among other things, it is used for
733 -- backing out partially complete cycles following a failed
734 -- upsweep, and for removing from hpt all the modules
735 -- not in strict downwards closure, during calls to compile.
736 let mg2_with_srcimps :: [SCC ModSummary]
737 mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
739 -- If we can determine that any of the {-# SOURCE #-} imports
740 -- are definitely unnecessary, then emit a warning.
741 warnUnnecessarySourceImports dflags mg2_with_srcimps
744 -- check the stability property for each module.
745 stable_mods@(stable_obj,stable_bco)
746 = checkStability hpt1 mg2_with_srcimps all_home_mods
748 -- prune bits of the HPT which are definitely redundant now,
750 pruned_hpt = pruneHomePackageTable hpt1
751 (flattenSCCs mg2_with_srcimps)
754 liftIO $ evaluate pruned_hpt
756 -- before we unload anything, make sure we don't leave an old
757 -- interactive context around pointing to dead bindings. Also,
758 -- write the pruned HPT to allow the old HPT to be GC'd.
759 modifySession $ \_ -> hsc_env{ hsc_IC = emptyInteractiveContext,
760 hsc_HPT = pruned_hpt }
762 liftIO $ debugTraceMsg dflags 2 (text "Stable obj:" <+> ppr stable_obj $$
763 text "Stable BCO:" <+> ppr stable_bco)
765 -- Unload any modules which are going to be re-linked this time around.
766 let stable_linkables = [ linkable
767 | m <- stable_obj++stable_bco,
768 Just hmi <- [lookupUFM pruned_hpt m],
769 Just linkable <- [hm_linkable hmi] ]
770 liftIO $ unload hsc_env stable_linkables
772 -- We could at this point detect cycles which aren't broken by
773 -- a source-import, and complain immediately, but it seems better
774 -- to let upsweep_mods do this, so at least some useful work gets
775 -- done before the upsweep is abandoned.
776 --hPutStrLn stderr "after tsort:\n"
777 --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
779 -- Now do the upsweep, calling compile for each module in
780 -- turn. Final result is version 3 of everything.
782 -- Topologically sort the module graph, this time including hi-boot
783 -- nodes, and possibly just including the portion of the graph
784 -- reachable from the module specified in the 2nd argument to load.
785 -- This graph should be cycle-free.
786 -- If we're restricting the upsweep to a portion of the graph, we
787 -- also want to retain everything that is still stable.
788 let full_mg :: [SCC ModSummary]
789 full_mg = topSortModuleGraph False mod_graph Nothing
791 maybe_top_mod = case how_much of
793 LoadDependenciesOf m -> Just m
796 partial_mg0 :: [SCC ModSummary]
797 partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod
799 -- LoadDependenciesOf m: we want the upsweep to stop just
800 -- short of the specified module (unless the specified module
803 | LoadDependenciesOf _mod <- how_much
804 = ASSERT( case last partial_mg0 of
805 AcyclicSCC ms -> ms_mod_name ms == _mod; _ -> False )
806 List.init partial_mg0
812 | AcyclicSCC ms <- full_mg,
813 ms_mod_name ms `elem` stable_obj++stable_bco,
814 ms_mod_name ms `notElem` [ ms_mod_name ms' |
815 AcyclicSCC ms' <- partial_mg ] ]
817 mg = stable_mg ++ partial_mg
819 -- clean up between compilations
820 let cleanup = cleanTempFilesExcept dflags
821 (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
823 liftIO $ debugTraceMsg dflags 2 (hang (text "Ready for upsweep")
825 (upsweep_ok, hsc_env1, modsUpswept)
827 (hsc_env { hsc_HPT = emptyHomePackageTable })
828 pruned_hpt stable_mods cleanup mg
830 -- Make modsDone be the summaries for each home module now
831 -- available; this should equal the domain of hpt3.
832 -- Get in in a roughly top .. bottom order (hence reverse).
834 let modsDone = reverse modsUpswept
836 -- Try and do linking in some form, depending on whether the
837 -- upsweep was completely or only partially successful.
839 if succeeded upsweep_ok
842 -- Easy; just relink it all.
843 do liftIO $ debugTraceMsg dflags 2 (text "Upsweep completely successful.")
845 -- Clean up after ourselves
846 liftIO $ cleanTempFilesExcept dflags (ppFilesFromSummaries modsDone)
848 -- Issue a warning for the confusing case where the user
849 -- said '-o foo' but we're not going to do any linking.
850 -- We attempt linking if either (a) one of the modules is
851 -- called Main, or (b) the user said -no-hs-main, indicating
852 -- that main() is going to come from somewhere else.
854 let ofile = outputFile dflags
855 let no_hs_main = dopt Opt_NoHsMain dflags
857 main_mod = mainModIs dflags
858 a_root_is_Main = any ((==main_mod).ms_mod) mod_graph
859 do_linking = a_root_is_Main || no_hs_main
861 when (ghcLink dflags == LinkBinary
862 && isJust ofile && not do_linking) $
863 liftIO $ debugTraceMsg dflags 1 $
864 text ("Warning: output was redirected with -o, " ++
865 "but no output will be generated\n" ++
866 "because there is no " ++
867 moduleNameString (moduleName main_mod) ++ " module.")
869 -- link everything together
870 linkresult <- liftIO $ link (ghcLink dflags) dflags do_linking (hsc_HPT hsc_env1)
872 loadFinish Succeeded linkresult hsc_env1
875 -- Tricky. We need to back out the effects of compiling any
876 -- half-done cycles, both so as to clean up the top level envs
877 -- and to avoid telling the interactive linker to link them.
878 do liftIO $ debugTraceMsg dflags 2 (text "Upsweep partially successful.")
881 = map ms_mod modsDone
882 let mods_to_zap_names
883 = findPartiallyCompletedCycles modsDone_names
886 = filter ((`notElem` mods_to_zap_names).ms_mod)
889 let hpt4 = retainInTopLevelEnvs (map ms_mod_name mods_to_keep)
892 -- Clean up after ourselves
893 liftIO $ cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep)
895 -- there should be no Nothings where linkables should be, now
896 ASSERT(all (isJust.hm_linkable)
897 (eltsUFM (hsc_HPT hsc_env))) do
899 -- Link everything together
900 linkresult <- liftIO $ link (ghcLink dflags) dflags False hpt4
902 let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
903 loadFinish Failed linkresult hsc_env4
905 -- Finish up after a load.
907 -- If the link failed, unload everything and return.
908 loadFinish :: GhcMonad m =>
909 SuccessFlag -> SuccessFlag -> HscEnv
911 loadFinish _all_ok Failed hsc_env
912 = do liftIO $ unload hsc_env []
913 modifySession $ \_ -> discardProg hsc_env
916 -- Empty the interactive context and set the module context to the topmost
917 -- newly loaded module, or the Prelude if none were loaded.
918 loadFinish all_ok Succeeded hsc_env
919 = do modifySession $ \_ -> hsc_env{ hsc_IC = emptyInteractiveContext }
923 -- Forget the current program, but retain the persistent info in HscEnv
924 discardProg :: HscEnv -> HscEnv
926 = hsc_env { hsc_mod_graph = emptyMG,
927 hsc_IC = emptyInteractiveContext,
928 hsc_HPT = emptyHomePackageTable }
930 -- used to fish out the preprocess output files for the purposes of
931 -- cleaning up. The preprocessed file *might* be the same as the
932 -- source file, but that doesn't do any harm.
933 ppFilesFromSummaries :: [ModSummary] -> [FilePath]
934 ppFilesFromSummaries summaries = map ms_hspp_file summaries
936 -- -----------------------------------------------------------------------------
938 class ParsedMod m where
939 modSummary :: m -> ModSummary
940 parsedSource :: m -> ParsedSource
942 class ParsedMod m => TypecheckedMod m where
943 renamedSource :: m -> Maybe RenamedSource
944 typecheckedSource :: m -> TypecheckedSource
945 moduleInfo :: m -> ModuleInfo
946 tm_internals :: m -> (TcGblEnv, ModDetails)
947 -- ToDo: improvements that could be made here:
948 -- if the module succeeded renaming but not typechecking,
949 -- we can still get back the GlobalRdrEnv and exports, so
950 -- perhaps the ModuleInfo should be split up into separate
953 class TypecheckedMod m => DesugaredMod m where
954 coreModule :: m -> ModGuts
956 -- | The result of successful parsing.
958 ParsedModule { pm_mod_summary :: ModSummary
959 , pm_parsed_source :: ParsedSource }
961 instance ParsedMod ParsedModule where
962 modSummary m = pm_mod_summary m
963 parsedSource m = pm_parsed_source m
965 -- | The result of successful typechecking. It also contains the parser
967 data TypecheckedModule =
968 TypecheckedModule { tm_parsed_module :: ParsedModule
969 , tm_renamed_source :: Maybe RenamedSource
970 , tm_typechecked_source :: TypecheckedSource
971 , tm_checked_module_info :: ModuleInfo
972 , tm_internals_ :: (TcGblEnv, ModDetails)
975 instance ParsedMod TypecheckedModule where
976 modSummary m = modSummary (tm_parsed_module m)
977 parsedSource m = parsedSource (tm_parsed_module m)
979 instance TypecheckedMod TypecheckedModule where
980 renamedSource m = tm_renamed_source m
981 typecheckedSource m = tm_typechecked_source m
982 moduleInfo m = tm_checked_module_info m
983 tm_internals m = tm_internals_ m
985 -- | The result of successful desugaring (i.e., translation to core). Also
986 -- contains all the information of a typechecked module.
987 data DesugaredModule =
988 DesugaredModule { dm_typechecked_module :: TypecheckedModule
989 , dm_core_module :: ModGuts
992 instance ParsedMod DesugaredModule where
993 modSummary m = modSummary (dm_typechecked_module m)
994 parsedSource m = parsedSource (dm_typechecked_module m)
996 instance TypecheckedMod DesugaredModule where
997 renamedSource m = renamedSource (dm_typechecked_module m)
998 typecheckedSource m = typecheckedSource (dm_typechecked_module m)
999 moduleInfo m = moduleInfo (dm_typechecked_module m)
1000 tm_internals m = tm_internals_ (dm_typechecked_module m)
1002 instance DesugaredMod DesugaredModule where
1003 coreModule m = dm_core_module m
1005 type ParsedSource = Located (HsModule RdrName)
1006 type RenamedSource = (HsGroup Name, [LImportDecl Name], Maybe [LIE Name],
1007 Maybe (HsDoc Name), HaddockModInfo Name)
1008 type TypecheckedSource = LHsBinds Id
1011 -- - things that aren't in the output of the typechecker right now:
1012 -- - the export list
1014 -- - type signatures
1015 -- - type/data/newtype declarations
1016 -- - class declarations
1018 -- - extra things in the typechecker's output:
1019 -- - default methods are turned into top-level decls.
1020 -- - dictionary bindings
1022 -- | Return the 'ModSummary' of a module with the given name.
1024 -- The module must be part of the module graph (see 'hsc_mod_graph' and
1025 -- 'ModuleGraph'). If this is not the case, this function will throw a
1028 -- This function ignores boot modules and requires that there is only one
1029 -- non-boot module with the given name.
1030 getModSummary :: GhcMonad m => ModuleName -> m ModSummary
1031 getModSummary mod = do
1032 mg <- liftM hsc_mod_graph getSession
1033 case [ ms | ms <- mg, ms_mod_name ms == mod, not (isBootSummary ms) ] of
1034 [] -> throw $ mkApiErr (text "Module not part of module graph")
1036 multiple -> throw $ mkApiErr (text "getModSummary is ambiguous: " <+> ppr multiple)
1038 -- | Parse a module.
1040 -- Throws a 'SourceError' on parse error.
1041 parseModule :: GhcMonad m => ModSummary -> m ParsedModule
1043 rdr_module <- withTempSession
1044 (\e -> e { hsc_dflags = ms_hspp_opts ms }) $
1046 return (ParsedModule ms rdr_module)
1048 -- | Typecheck and rename a parsed module.
1050 -- Throws a 'SourceError' if either fails.
1051 typecheckModule :: GhcMonad m => ParsedModule -> m TypecheckedModule
1052 typecheckModule pmod = do
1053 let ms = modSummary pmod
1054 withTempSession (\e -> e { hsc_dflags = ms_hspp_opts ms }) $ do
1055 (tc_gbl_env, rn_info)
1056 <- hscTypecheckRename ms (parsedSource pmod)
1057 details <- makeSimpleDetails tc_gbl_env
1060 tm_internals_ = (tc_gbl_env, details),
1061 tm_parsed_module = pmod,
1062 tm_renamed_source = rn_info,
1063 tm_typechecked_source = tcg_binds tc_gbl_env,
1064 tm_checked_module_info =
1066 minf_type_env = md_types details,
1067 minf_exports = availsToNameSet $ md_exports details,
1068 minf_rdr_env = Just (tcg_rdr_env tc_gbl_env),
1069 minf_instances = md_insts details
1071 ,minf_modBreaks = emptyModBreaks
1075 -- | Desugar a typechecked module.
1076 desugarModule :: GhcMonad m => TypecheckedModule -> m DesugaredModule
1077 desugarModule tcm = do
1078 let ms = modSummary tcm
1079 withTempSession (\e -> e { hsc_dflags = ms_hspp_opts ms }) $ do
1080 let (tcg, _) = tm_internals tcm
1081 guts <- hscDesugar ms tcg
1084 dm_typechecked_module = tcm,
1085 dm_core_module = guts
1088 -- | Load a module. Input doesn't need to be desugared.
1090 -- XXX: Describe usage.
1091 loadModule :: (TypecheckedMod mod, GhcMonad m) => mod -> m mod
1093 let ms = modSummary tcm
1094 let mod = ms_mod_name ms
1095 let (tcg, details) = tm_internals tcm
1097 withTempSession (\e -> e { hsc_dflags = ms_hspp_opts ms }) $ do
1098 (iface, _) <- makeSimpleIface Nothing tcg details
1099 let mod_info = HomeModInfo {
1101 hm_details = details,
1102 hm_linkable = Nothing }
1103 hsc_env <- getSession
1104 return $ addToUFM (hsc_HPT hsc_env) mod mod_info
1105 modifySession $ \e -> e{ hsc_HPT = hpt_new }
1108 -- | This is the way to get access to the Core bindings corresponding
1109 -- to a module. 'compileToCore' parses, typechecks, and
1110 -- desugars the module, then returns the resulting Core module (consisting of
1111 -- the module name, type declarations, and function declarations) if
1113 compileToCoreModule :: GhcMonad m => FilePath -> m CoreModule
1114 compileToCoreModule = compileCore False
1116 -- | Like compileToCoreModule, but invokes the simplifier, so
1117 -- as to return simplified and tidied Core.
1118 compileToCoreSimplified :: GhcMonad m => FilePath -> m CoreModule
1119 compileToCoreSimplified = compileCore True
1121 -- | Provided for backwards-compatibility: compileToCore returns just the Core
1122 -- bindings, but for most purposes, you probably want to call
1123 -- compileToCoreModule.
1124 compileToCore :: GhcMonad m => FilePath -> m [CoreBind]
1125 compileToCore fn = do
1126 mod <- compileToCoreModule session fn
1127 return $ cm_binds mod
1129 -- | Takes a CoreModule and compiles the bindings therein
1130 -- to object code. The first argument is a bool flag indicating
1131 -- whether to run the simplifier.
1132 -- The resulting .o, .hi, and executable files, if any, are stored in the
1133 -- current directory, and named according to the module name.
1134 -- This has only so far been tested with a single self-contained module.
1135 compileCoreToObj :: GhcMonad m => Bool -> CoreModule -> m ()
1136 compileCoreToObj simplify cm@(CoreModule{ cm_module = mName }) = do
1137 dflags <- getSessionDynFlags
1138 currentTime <- liftIO $ getClockTime
1139 cwd <- liftIO $ getCurrentDirectory
1140 modLocation <- liftIO $ mkHiOnlyModLocation dflags (hiSuf dflags) cwd
1141 ((moduleNameSlashes . moduleName) mName)
1143 let modSummary = ModSummary { ms_mod = mName,
1144 ms_hsc_src = ExtCoreFile,
1145 ms_location = modLocation,
1146 -- By setting the object file timestamp to Nothing,
1147 -- we always force recompilation, which is what we
1148 -- want. (Thus it doesn't matter what the timestamp
1149 -- for the (nonexistent) source file is.)
1150 ms_hs_date = currentTime,
1151 ms_obj_date = Nothing,
1152 -- Only handling the single-module case for now, so no imports.
1157 ms_hspp_opts = dflags,
1158 ms_hspp_buf = Nothing
1161 let maybe_simplify mod_guts | simplify = hscSimplify mod_guts
1162 | otherwise = return mod_guts
1163 guts <- maybe_simplify (mkModGuts cm)
1164 (iface, changed, _details, cgguts)
1165 <- hscNormalIface guts Nothing
1166 hscWriteIface iface changed modSummary
1167 hscGenHardCode cgguts modSummary
1170 -- Makes a "vanilla" ModGuts.
1171 mkModGuts :: CoreModule -> ModGuts
1172 mkModGuts coreModule = ModGuts {
1173 mg_module = cm_module coreModule,
1176 mg_deps = noDependencies,
1177 mg_dir_imps = emptyModuleEnv,
1178 mg_used_names = emptyNameSet,
1179 mg_rdr_env = emptyGlobalRdrEnv,
1180 mg_fix_env = emptyFixityEnv,
1181 mg_types = emptyTypeEnv,
1185 mg_binds = cm_binds coreModule,
1186 mg_foreign = NoStubs,
1187 mg_warns = NoWarnings,
1189 mg_hpc_info = emptyHpcInfo False,
1190 mg_modBreaks = emptyModBreaks,
1191 mg_vect_info = noVectInfo,
1192 mg_inst_env = emptyInstEnv,
1193 mg_fam_inst_env = emptyFamInstEnv
1196 compileCore :: GhcMonad m => Bool -> FilePath -> m CoreModule
1197 compileCore simplify fn = do
1198 -- First, set the target to the desired filename
1199 target <- guessTarget fn Nothing
1202 -- Then find dependencies
1203 modGraph <- depanal [] True
1204 case find ((== fn) . msHsFilePath) modGraph of
1205 Just modSummary -> do
1206 -- Now we have the module name;
1207 -- parse, typecheck and desugar the module
1208 mod_guts <- coreModule `fmap`
1209 -- TODO: space leaky: call hsc* directly?
1210 (desugarModule =<< typecheckModule =<< parseModule modSummary)
1211 liftM gutsToCoreModule $
1214 -- If simplify is true: simplify (hscSimplify), then tidy
1216 hsc_env <- getSession
1217 simpl_guts <- hscSimplify mod_guts
1218 tidy_guts <- liftIO $ tidyProgram hsc_env simpl_guts
1219 return $ Left tidy_guts
1221 return $ Right mod_guts
1223 Nothing -> panic "compileToCoreModule: target FilePath not found in\
1224 module dependency graph"
1225 where -- two versions, based on whether we simplify (thus run tidyProgram,
1226 -- which returns a (CgGuts, ModDetails) pair, or not (in which case
1227 -- we just have a ModGuts.
1228 gutsToCoreModule :: Either (CgGuts, ModDetails) ModGuts -> CoreModule
1229 gutsToCoreModule (Left (cg, md)) = CoreModule {
1230 cm_module = cg_module cg, cm_types = md_types md,
1231 cm_imports = cg_dir_imps cg, cm_binds = cg_binds cg
1233 gutsToCoreModule (Right mg) = CoreModule {
1234 cm_module = mg_module mg, cm_types = mg_types mg,
1235 cm_imports = moduleEnvKeys (mg_dir_imps mg), cm_binds = mg_binds mg
1238 -- ---------------------------------------------------------------------------
1241 unload :: HscEnv -> [Linkable] -> IO ()
1242 unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
1243 = case ghcLink (hsc_dflags hsc_env) of
1245 LinkInMemory -> Linker.unload (hsc_dflags hsc_env) stable_linkables
1247 LinkInMemory -> panic "unload: no interpreter"
1248 -- urgh. avoid warnings:
1249 hsc_env stable_linkables
1253 -- -----------------------------------------------------------------------------
1257 Stability tells us which modules definitely do not need to be recompiled.
1258 There are two main reasons for having stability:
1260 - avoid doing a complete upsweep of the module graph in GHCi when
1261 modules near the bottom of the tree have not changed.
1263 - to tell GHCi when it can load object code: we can only load object code
1264 for a module when we also load object code fo all of the imports of the
1265 module. So we need to know that we will definitely not be recompiling
1266 any of these modules, and we can use the object code.
1268 The stability check is as follows. Both stableObject and
1269 stableBCO are used during the upsweep phase later.
1272 stable m = stableObject m || stableBCO m
1275 all stableObject (imports m)
1276 && old linkable does not exist, or is == on-disk .o
1277 && date(on-disk .o) > date(.hs)
1280 all stable (imports m)
1281 && date(BCO) > date(.hs)
1284 These properties embody the following ideas:
1286 - if a module is stable, then:
1288 - if it has been compiled in a previous pass (present in HPT)
1289 then it does not need to be compiled or re-linked.
1291 - if it has not been compiled in a previous pass,
1292 then we only need to read its .hi file from disk and
1293 link it to produce a 'ModDetails'.
1295 - if a modules is not stable, we will definitely be at least
1296 re-linking, and possibly re-compiling it during the 'upsweep'.
1297 All non-stable modules can (and should) therefore be unlinked
1298 before the 'upsweep'.
1300 - Note that objects are only considered stable if they only depend
1301 on other objects. We can't link object code against byte code.
1305 :: HomePackageTable -- HPT from last compilation
1306 -> [SCC ModSummary] -- current module graph (cyclic)
1307 -> [ModuleName] -- all home modules
1308 -> ([ModuleName], -- stableObject
1309 [ModuleName]) -- stableBCO
1311 checkStability hpt sccs all_home_mods = foldl checkSCC ([],[]) sccs
1313 checkSCC (stable_obj, stable_bco) scc0
1314 | stableObjects = (scc_mods ++ stable_obj, stable_bco)
1315 | stableBCOs = (stable_obj, scc_mods ++ stable_bco)
1316 | otherwise = (stable_obj, stable_bco)
1318 scc = flattenSCC scc0
1319 scc_mods = map ms_mod_name scc
1320 home_module m = m `elem` all_home_mods && m `notElem` scc_mods
1322 scc_allimps = nub (filter home_module (concatMap ms_allimps scc))
1323 -- all imports outside the current SCC, but in the home pkg
1325 stable_obj_imps = map (`elem` stable_obj) scc_allimps
1326 stable_bco_imps = map (`elem` stable_bco) scc_allimps
1330 && all object_ok scc
1333 and (zipWith (||) stable_obj_imps stable_bco_imps)
1337 | Just t <- ms_obj_date ms = t >= ms_hs_date ms
1341 same_as_prev t = case lookupUFM hpt (ms_mod_name ms) of
1342 Just hmi | Just l <- hm_linkable hmi
1343 -> isObjectLinkable l && t == linkableTime l
1345 -- why '>=' rather than '>' above? If the filesystem stores
1346 -- times to the nearset second, we may occasionally find that
1347 -- the object & source have the same modification time,
1348 -- especially if the source was automatically generated
1349 -- and compiled. Using >= is slightly unsafe, but it matches
1350 -- make's behaviour.
1353 = case lookupUFM hpt (ms_mod_name ms) of
1354 Just hmi | Just l <- hm_linkable hmi ->
1355 not (isObjectLinkable l) &&
1356 linkableTime l >= ms_hs_date ms
1359 ms_allimps :: ModSummary -> [ModuleName]
1360 ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
1362 -- -----------------------------------------------------------------------------
1364 -- | Prune the HomePackageTable
1366 -- Before doing an upsweep, we can throw away:
1368 -- - For non-stable modules:
1369 -- - all ModDetails, all linked code
1370 -- - all unlinked code that is out of date with respect to
1373 -- This is VERY IMPORTANT otherwise we'll end up requiring 2x the
1374 -- space at the end of the upsweep, because the topmost ModDetails of the
1375 -- old HPT holds on to the entire type environment from the previous
1378 pruneHomePackageTable
1381 -> ([ModuleName],[ModuleName])
1384 pruneHomePackageTable hpt summ (stable_obj, stable_bco)
1387 | is_stable modl = hmi'
1388 | otherwise = hmi'{ hm_details = emptyModDetails }
1390 modl = moduleName (mi_module (hm_iface hmi))
1391 hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
1392 = hmi{ hm_linkable = Nothing }
1395 where ms = expectJust "prune" (lookupUFM ms_map modl)
1397 ms_map = listToUFM [(ms_mod_name ms, ms) | ms <- summ]
1399 is_stable m = m `elem` stable_obj || m `elem` stable_bco
1401 -- -----------------------------------------------------------------------------
1403 -- Return (names of) all those in modsDone who are part of a cycle
1404 -- as defined by theGraph.
1405 findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
1406 findPartiallyCompletedCycles modsDone theGraph
1410 chew ((AcyclicSCC _):rest) = chew rest -- acyclic? not interesting.
1411 chew ((CyclicSCC vs):rest)
1412 = let names_in_this_cycle = nub (map ms_mod vs)
1414 = nub ([done | done <- modsDone,
1415 done `elem` names_in_this_cycle])
1416 chewed_rest = chew rest
1418 if notNull mods_in_this_cycle
1419 && length mods_in_this_cycle < length names_in_this_cycle
1420 then mods_in_this_cycle ++ chewed_rest
1423 -- -----------------------------------------------------------------------------
1427 -- This is where we compile each module in the module graph, in a pass
1428 -- from the bottom to the top of the graph.
1430 -- There better had not be any cyclic groups here -- we check for them.
1434 WarnErrLogger -- ^ Called to print warnings and errors.
1435 -> HscEnv -- ^ Includes initially-empty HPT
1436 -> HomePackageTable -- ^ HPT from last time round (pruned)
1437 -> ([ModuleName],[ModuleName]) -- ^ stable modules (see checkStability)
1438 -> IO () -- ^ How to clean up unwanted tmp files
1439 -> [SCC ModSummary] -- ^ Mods to do (the worklist)
1441 HscEnv, -- With an updated HPT
1442 [ModSummary]) -- Mods which succeeded
1444 upsweep logger hsc_env old_hpt stable_mods cleanup sccs = do
1445 (res, hsc_env, done) <- upsweep' hsc_env old_hpt [] sccs 1 (length sccs)
1446 return (res, hsc_env, reverse done)
1449 upsweep' hsc_env _old_hpt done
1451 = return (Succeeded, hsc_env, done)
1453 upsweep' hsc_env _old_hpt done
1454 (CyclicSCC ms:_) _ _
1455 = do liftIO $ fatalErrorMsg (hsc_dflags hsc_env) (cyclicModuleErr ms)
1456 return (Failed, hsc_env, done)
1458 upsweep' hsc_env old_hpt done
1459 (AcyclicSCC mod:mods) mod_index nmods
1460 = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++
1461 -- show (map (moduleUserString.moduleName.mi_module.hm_iface)
1462 -- (moduleEnvElts (hsc_HPT hsc_env)))
1465 <- handleSourceError
1466 (\err -> do logger (Just err); return Nothing) $ do
1467 mod_info <- upsweep_mod hsc_env old_hpt stable_mods
1469 logger Nothing -- log warnings
1470 return (Just mod_info)
1472 liftIO cleanup -- Remove unwanted tmp files between compilations
1475 Nothing -> return (Failed, hsc_env, done)
1477 let this_mod = ms_mod_name mod
1479 -- Add new info to hsc_env
1480 hpt1 = addToUFM (hsc_HPT hsc_env) this_mod mod_info
1481 hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1483 -- Space-saving: delete the old HPT entry
1484 -- for mod BUT if mod is a hs-boot
1485 -- node, don't delete it. For the
1486 -- interface, the HPT entry is probaby for the
1487 -- main Haskell source file. Deleting it
1488 -- would force the real module to be recompiled
1490 old_hpt1 | isBootSummary mod = old_hpt
1491 | otherwise = delFromUFM old_hpt this_mod
1495 -- fixup our HomePackageTable after we've finished compiling
1496 -- a mutually-recursive loop. See reTypecheckLoop, below.
1497 hsc_env2 <- liftIO $ reTypecheckLoop hsc_env1 mod done'
1499 upsweep' hsc_env2 old_hpt1 done' mods (mod_index+1) nmods
1501 -- | Compile a single module. Always produce a Linkable for it if
1502 -- successful. If no compilation happened, return the old Linkable.
1503 upsweep_mod :: GhcMonad m =>
1506 -> ([ModuleName],[ModuleName])
1508 -> Int -- index of module
1509 -> Int -- total number of modules
1512 upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) summary mod_index nmods
1514 this_mod_name = ms_mod_name summary
1515 this_mod = ms_mod summary
1516 mb_obj_date = ms_obj_date summary
1517 obj_fn = ml_obj_file (ms_location summary)
1518 hs_date = ms_hs_date summary
1520 is_stable_obj = this_mod_name `elem` stable_obj
1521 is_stable_bco = this_mod_name `elem` stable_bco
1523 old_hmi = lookupUFM old_hpt this_mod_name
1525 -- We're using the dflags for this module now, obtained by
1526 -- applying any options in its LANGUAGE & OPTIONS_GHC pragmas.
1527 dflags = ms_hspp_opts summary
1528 prevailing_target = hscTarget (hsc_dflags hsc_env)
1529 local_target = hscTarget dflags
1531 -- If OPTIONS_GHC contains -fasm or -fvia-C, be careful that
1532 -- we don't do anything dodgy: these should only work to change
1533 -- from -fvia-C to -fasm and vice-versa, otherwise we could
1534 -- end up trying to link object code to byte code.
1535 target = if prevailing_target /= local_target
1536 && (not (isObjectTarget prevailing_target)
1537 || not (isObjectTarget local_target))
1538 then prevailing_target
1541 -- store the corrected hscTarget into the summary
1542 summary' = summary{ ms_hspp_opts = dflags { hscTarget = target } }
1544 -- The old interface is ok if
1545 -- a) we're compiling a source file, and the old HPT
1546 -- entry is for a source file
1547 -- b) we're compiling a hs-boot file
1548 -- Case (b) allows an hs-boot file to get the interface of its
1549 -- real source file on the second iteration of the compilation
1550 -- manager, but that does no harm. Otherwise the hs-boot file
1551 -- will always be recompiled
1556 Just hm_info | isBootSummary summary -> Just iface
1557 | not (mi_boot iface) -> Just iface
1558 | otherwise -> Nothing
1560 iface = hm_iface hm_info
1562 compile_it :: GhcMonad m => Maybe Linkable -> m HomeModInfo
1563 compile_it = compile hsc_env summary' mod_index nmods mb_old_iface
1565 compile_it_discard_iface :: GhcMonad m =>
1566 Maybe Linkable -> m HomeModInfo
1567 compile_it_discard_iface
1568 = compile hsc_env summary' mod_index nmods Nothing
1573 -- Regardless of whether we're generating object code or
1574 -- byte code, we can always use an existing object file
1575 -- if it is *stable* (see checkStability).
1576 | is_stable_obj, Just hmi <- old_hmi -> do
1577 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1578 (text "skipping stable obj mod:" <+> ppr this_mod_name)
1580 -- object is stable, and we have an entry in the
1581 -- old HPT: nothing to do
1583 | is_stable_obj, isNothing old_hmi -> do
1584 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1585 (text "compiling stable on-disk mod:" <+> ppr this_mod_name)
1586 linkable <- liftIO $ findObjectLinkable this_mod obj_fn
1587 (expectJust "upsweep1" mb_obj_date)
1588 compile_it (Just linkable)
1589 -- object is stable, but we need to load the interface
1590 -- off disk to make a HMI.
1592 | not (isObjectTarget target), is_stable_bco ->
1593 ASSERT(isJust old_hmi) -- must be in the old_hpt
1594 let Just hmi = old_hmi in do
1595 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1596 (text "skipping stable BCO mod:" <+> ppr this_mod_name)
1598 -- BCO is stable: nothing to do
1600 | not (isObjectTarget target),
1601 Just hmi <- old_hmi,
1602 Just l <- hm_linkable hmi,
1603 not (isObjectLinkable l),
1604 linkableTime l >= ms_hs_date summary -> do
1605 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1606 (text "compiling non-stable BCO mod:" <+> ppr this_mod_name)
1608 -- we have an old BCO that is up to date with respect
1609 -- to the source: do a recompilation check as normal.
1611 -- When generating object code, if there's an up-to-date
1612 -- object file on the disk, then we can use it.
1613 -- However, if the object file is new (compared to any
1614 -- linkable we had from a previous compilation), then we
1615 -- must discard any in-memory interface, because this
1616 -- means the user has compiled the source file
1617 -- separately and generated a new interface, that we must
1618 -- read from the disk.
1620 | isObjectTarget target,
1621 Just obj_date <- mb_obj_date,
1622 obj_date >= hs_date -> do
1625 | Just l <- hm_linkable hmi,
1626 isObjectLinkable l && linkableTime l == obj_date -> do
1627 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1628 (text "compiling mod with new on-disk obj:" <+> ppr this_mod_name)
1631 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1632 (text "compiling mod with new on-disk obj2:" <+> ppr this_mod_name)
1633 linkable <- liftIO $ findObjectLinkable this_mod obj_fn obj_date
1634 compile_it_discard_iface (Just linkable)
1637 liftIO $ debugTraceMsg (hsc_dflags hsc_env) 5
1638 (text "compiling mod:" <+> ppr this_mod_name)
1643 -- Filter modules in the HPT
1644 retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable
1645 retainInTopLevelEnvs keep_these hpt
1646 = listToUFM [ (mod, expectJust "retain" mb_mod_info)
1648 , let mb_mod_info = lookupUFM hpt mod
1649 , isJust mb_mod_info ]
1651 -- ---------------------------------------------------------------------------
1652 -- Typecheck module loops
1655 See bug #930. This code fixes a long-standing bug in --make. The
1656 problem is that when compiling the modules *inside* a loop, a data
1657 type that is only defined at the top of the loop looks opaque; but
1658 after the loop is done, the structure of the data type becomes
1661 The difficulty is then that two different bits of code have
1662 different notions of what the data type looks like.
1664 The idea is that after we compile a module which also has an .hs-boot
1665 file, we re-generate the ModDetails for each of the modules that
1666 depends on the .hs-boot file, so that everyone points to the proper
1667 TyCons, Ids etc. defined by the real module, not the boot module.
1668 Fortunately re-generating a ModDetails from a ModIface is easy: the
1669 function TcIface.typecheckIface does exactly that.
1671 Picking the modules to re-typecheck is slightly tricky. Starting from
1672 the module graph consisting of the modules that have already been
1673 compiled, we reverse the edges (so they point from the imported module
1674 to the importing module), and depth-first-search from the .hs-boot
1675 node. This gives us all the modules that depend transitively on the
1676 .hs-boot module, and those are exactly the modules that we need to
1679 Following this fix, GHC can compile itself with --make -O2.
1682 reTypecheckLoop :: HscEnv -> ModSummary -> ModuleGraph -> IO HscEnv
1683 reTypecheckLoop hsc_env ms graph
1684 | not (isBootSummary ms) &&
1685 any (\m -> ms_mod m == this_mod && isBootSummary m) graph
1687 let mss = reachableBackwards (ms_mod_name ms) graph
1688 non_boot = filter (not.isBootSummary) mss
1689 debugTraceMsg (hsc_dflags hsc_env) 2 $
1690 text "Re-typechecking loop: " <> ppr (map ms_mod_name non_boot)
1691 typecheckLoop hsc_env (map ms_mod_name non_boot)
1695 this_mod = ms_mod ms
1697 typecheckLoop :: HscEnv -> [ModuleName] -> IO HscEnv
1698 typecheckLoop hsc_env mods = do
1700 fixIO $ \new_hpt -> do
1701 let new_hsc_env = hsc_env{ hsc_HPT = new_hpt }
1702 mds <- initIfaceCheck new_hsc_env $
1703 mapM (typecheckIface . hm_iface) hmis
1704 let new_hpt = addListToUFM old_hpt
1705 (zip mods [ hmi{ hm_details = details }
1706 | (hmi,details) <- zip hmis mds ])
1708 return hsc_env{ hsc_HPT = new_hpt }
1710 old_hpt = hsc_HPT hsc_env
1711 hmis = map (expectJust "typecheckLoop" . lookupUFM old_hpt) mods
1713 reachableBackwards :: ModuleName -> [ModSummary] -> [ModSummary]
1714 reachableBackwards mod summaries
1715 = [ ms | (ms,_,_) <- reachableG (transposeG graph) root ]
1716 where -- the rest just sets up the graph:
1717 (graph, lookup_node) = moduleGraphNodes False summaries
1718 root = expectJust "reachableBackwards" (lookup_node HsBootFile mod)
1720 -- ---------------------------------------------------------------------------
1721 -- Topological sort of the module graph
1723 type SummaryNode = (ModSummary, Int, [Int])
1727 -- ^ Drop hi-boot nodes? (see below)
1731 -- ^ Calculate SCCs of the module graph, possibly dropping the hi-boot nodes
1732 -- The resulting list of strongly-connected-components is in topologically
1733 -- sorted order, starting with the module(s) at the bottom of the
1734 -- dependency graph (ie compile them first) and ending with the ones at
1737 -- Drop hi-boot nodes (first boolean arg)?
1739 -- - @False@: treat the hi-boot summaries as nodes of the graph,
1740 -- so the graph must be acyclic
1742 -- - @True@: eliminate the hi-boot nodes, and instead pretend
1743 -- the a source-import of Foo is an import of Foo
1744 -- The resulting graph has no hi-boot nodes, but can be cyclic
1746 topSortModuleGraph drop_hs_boot_nodes summaries mb_root_mod
1747 = map (fmap summaryNodeSummary) $ stronglyConnCompG initial_graph
1749 (graph, lookup_node) = moduleGraphNodes drop_hs_boot_nodes summaries
1751 initial_graph = case mb_root_mod of
1754 -- restrict the graph to just those modules reachable from
1755 -- the specified module. We do this by building a graph with
1756 -- the full set of nodes, and determining the reachable set from
1757 -- the specified node.
1758 let root | Just node <- lookup_node HsSrcFile root_mod, graph `hasVertexG` node = node
1759 | otherwise = ghcError (ProgramError "module does not exist")
1760 in graphFromEdgedVertices (seq root (reachableG graph root))
1762 summaryNodeKey :: SummaryNode -> Int
1763 summaryNodeKey (_, k, _) = k
1765 summaryNodeSummary :: SummaryNode -> ModSummary
1766 summaryNodeSummary (s, _, _) = s
1768 moduleGraphNodes :: Bool -> [ModSummary]
1769 -> (Graph SummaryNode, HscSource -> ModuleName -> Maybe SummaryNode)
1770 moduleGraphNodes drop_hs_boot_nodes summaries = (graphFromEdgedVertices nodes, lookup_node)
1772 numbered_summaries = zip summaries [1..]
1774 lookup_node :: HscSource -> ModuleName -> Maybe SummaryNode
1775 lookup_node hs_src mod = lookupFM node_map (mod, hs_src)
1777 lookup_key :: HscSource -> ModuleName -> Maybe Int
1778 lookup_key hs_src mod = fmap summaryNodeKey (lookup_node hs_src mod)
1780 node_map :: NodeMap SummaryNode
1781 node_map = listToFM [ ((moduleName (ms_mod s), ms_hsc_src s), node)
1782 | node@(s, _, _) <- nodes ]
1784 -- We use integers as the keys for the SCC algorithm
1785 nodes :: [SummaryNode]
1786 nodes = [ (s, key, out_keys)
1787 | (s, key) <- numbered_summaries
1788 -- Drop the hi-boot ones if told to do so
1789 , not (isBootSummary s && drop_hs_boot_nodes)
1790 , let out_keys = out_edge_keys hs_boot_key (map unLoc (ms_srcimps s)) ++
1791 out_edge_keys HsSrcFile (map unLoc (ms_imps s)) ++
1792 (-- see [boot-edges] below
1793 if drop_hs_boot_nodes || ms_hsc_src s == HsBootFile
1795 else case lookup_key HsBootFile (ms_mod_name s) of
1799 -- [boot-edges] if this is a .hs and there is an equivalent
1800 -- .hs-boot, add a link from the former to the latter. This
1801 -- has the effect of detecting bogus cases where the .hs-boot
1802 -- depends on the .hs, by introducing a cycle. Additionally,
1803 -- it ensures that we will always process the .hs-boot before
1804 -- the .hs, and so the HomePackageTable will always have the
1805 -- most up to date information.
1807 -- Drop hs-boot nodes by using HsSrcFile as the key
1808 hs_boot_key | drop_hs_boot_nodes = HsSrcFile
1809 | otherwise = HsBootFile
1811 out_edge_keys :: HscSource -> [ModuleName] -> [Int]
1812 out_edge_keys hi_boot ms = mapCatMaybes (lookup_key hi_boot) ms
1813 -- If we want keep_hi_boot_nodes, then we do lookup_key with
1814 -- the IsBootInterface parameter True; else False
1817 type NodeKey = (ModuleName, HscSource) -- The nodes of the graph are
1818 type NodeMap a = FiniteMap NodeKey a -- keyed by (mod, src_file_type) pairs
1820 msKey :: ModSummary -> NodeKey
1821 msKey (ModSummary { ms_mod = mod, ms_hsc_src = boot }) = (moduleName mod,boot)
1823 mkNodeMap :: [ModSummary] -> NodeMap ModSummary
1824 mkNodeMap summaries = listToFM [ (msKey s, s) | s <- summaries]
1826 nodeMapElts :: NodeMap a -> [a]
1827 nodeMapElts = eltsFM
1829 -- | If there are {-# SOURCE #-} imports between strongly connected
1830 -- components in the topological sort, then those imports can
1831 -- definitely be replaced by ordinary non-SOURCE imports: if SOURCE
1832 -- were necessary, then the edge would be part of a cycle.
1833 warnUnnecessarySourceImports :: GhcMonad m => DynFlags -> [SCC ModSummary] -> m ()
1834 warnUnnecessarySourceImports dflags sccs =
1835 liftIO $ printBagOfWarnings dflags (listToBag (concatMap (check.flattenSCC) sccs))
1837 let mods_in_this_cycle = map ms_mod_name ms in
1838 [ warn i | m <- ms, i <- ms_srcimps m,
1839 unLoc i `notElem` mods_in_this_cycle ]
1841 warn :: Located ModuleName -> WarnMsg
1844 (ptext (sLit "Warning: {-# SOURCE #-} unnecessary in import of ")
1845 <+> quotes (ppr mod))
1847 -----------------------------------------------------------------------------
1848 -- Downsweep (dependency analysis)
1850 -- Chase downwards from the specified root set, returning summaries
1851 -- for all home modules encountered. Only follow source-import
1854 -- We pass in the previous collection of summaries, which is used as a
1855 -- cache to avoid recalculating a module summary if the source is
1858 -- The returned list of [ModSummary] nodes has one node for each home-package
1859 -- module, plus one for any hs-boot files. The imports of these nodes
1860 -- are all there, including the imports of non-home-package modules.
1862 downsweep :: GhcMonad m =>
1864 -> [ModSummary] -- Old summaries
1865 -> [ModuleName] -- Ignore dependencies on these; treat
1866 -- them as if they were package modules
1867 -> Bool -- True <=> allow multiple targets to have
1868 -- the same module name; this is
1869 -- very useful for ghc -M
1871 -- The elts of [ModSummary] all have distinct
1872 -- (Modules, IsBoot) identifiers, unless the Bool is true
1873 -- in which case there can be repeats
1874 downsweep hsc_env old_summaries excl_mods allow_dup_roots
1875 = do -- catch error messages and return them
1876 --handleErrMsg -- should be covered by GhcMonad now
1877 -- (\err_msg -> printBagOfErrors (hsc_dflags hsc_env) (unitBag err_msg) >> return Nothing) $ do
1878 rootSummaries <- mapM getRootSummary roots
1879 let root_map = mkRootMap rootSummaries
1880 checkDuplicates root_map
1881 summs <- loop (concatMap msDeps rootSummaries) root_map
1884 roots = hsc_targets hsc_env
1886 old_summary_map :: NodeMap ModSummary
1887 old_summary_map = mkNodeMap old_summaries
1889 getRootSummary :: GhcMonad m => Target -> m ModSummary
1890 getRootSummary (Target (TargetFile file mb_phase) obj_allowed maybe_buf)
1891 = do exists <- liftIO $ doesFileExist file
1893 then summariseFile hsc_env old_summaries file mb_phase
1894 obj_allowed maybe_buf
1895 else throwOneError $ mkPlainErrMsg noSrcSpan $
1896 text "can't find file:" <+> text file
1897 getRootSummary (Target (TargetModule modl) obj_allowed maybe_buf)
1898 = do maybe_summary <- summariseModule hsc_env old_summary_map False
1899 (L rootLoc modl) obj_allowed
1901 case maybe_summary of
1902 Nothing -> packageModErr modl
1905 rootLoc = mkGeneralSrcSpan (fsLit "<command line>")
1907 -- In a root module, the filename is allowed to diverge from the module
1908 -- name, so we have to check that there aren't multiple root files
1909 -- defining the same module (otherwise the duplicates will be silently
1910 -- ignored, leading to confusing behaviour).
1911 checkDuplicates :: GhcMonad m => NodeMap [ModSummary] -> m ()
1912 checkDuplicates root_map
1913 | allow_dup_roots = return ()
1914 | null dup_roots = return ()
1915 | otherwise = liftIO $ multiRootsErr (head dup_roots)
1917 dup_roots :: [[ModSummary]] -- Each at least of length 2
1918 dup_roots = filterOut isSingleton (nodeMapElts root_map)
1920 loop :: GhcMonad m =>
1921 [(Located ModuleName,IsBootInterface)]
1922 -- Work list: process these modules
1923 -> NodeMap [ModSummary]
1924 -- Visited set; the range is a list because
1925 -- the roots can have the same module names
1926 -- if allow_dup_roots is True
1928 -- The result includes the worklist, except
1929 -- for those mentioned in the visited set
1930 loop [] done = return (concat (nodeMapElts done))
1931 loop ((wanted_mod, is_boot) : ss) done
1932 | Just summs <- lookupFM done key
1933 = if isSingleton summs then
1936 do { liftIO $ multiRootsErr summs; return [] }
1938 = do mb_s <- summariseModule hsc_env old_summary_map
1939 is_boot wanted_mod True
1942 Nothing -> loop ss done
1943 Just s -> loop (msDeps s ++ ss) (addToFM done key [s])
1945 key = (unLoc wanted_mod, if is_boot then HsBootFile else HsSrcFile)
1947 mkRootMap :: [ModSummary] -> NodeMap [ModSummary]
1948 mkRootMap summaries = addListToFM_C (++) emptyFM
1949 [ (msKey s, [s]) | s <- summaries ]
1951 msDeps :: ModSummary -> [(Located ModuleName, IsBootInterface)]
1952 -- (msDeps s) returns the dependencies of the ModSummary s.
1953 -- A wrinkle is that for a {-# SOURCE #-} import we return
1954 -- *both* the hs-boot file
1955 -- *and* the source file
1956 -- as "dependencies". That ensures that the list of all relevant
1957 -- modules always contains B.hs if it contains B.hs-boot.
1958 -- Remember, this pass isn't doing the topological sort. It's
1959 -- just gathering the list of all relevant ModSummaries
1961 concat [ [(m,True), (m,False)] | m <- ms_srcimps s ]
1962 ++ [ (m,False) | m <- ms_imps s ]
1964 -----------------------------------------------------------------------------
1965 -- Summarising modules
1967 -- We have two types of summarisation:
1969 -- * Summarise a file. This is used for the root module(s) passed to
1970 -- cmLoadModules. The file is read, and used to determine the root
1971 -- module name. The module name may differ from the filename.
1973 -- * Summarise a module. We are given a module name, and must provide
1974 -- a summary. The finder is used to locate the file in which the module
1980 -> [ModSummary] -- old summaries
1981 -> FilePath -- source file name
1982 -> Maybe Phase -- start phase
1983 -> Bool -- object code allowed?
1984 -> Maybe (StringBuffer,ClockTime)
1987 summariseFile hsc_env old_summaries file mb_phase obj_allowed maybe_buf
1988 -- we can use a cached summary if one is available and the
1989 -- source file hasn't changed, But we have to look up the summary
1990 -- by source file, rather than module name as we do in summarise.
1991 | Just old_summary <- findSummaryBySourceFile old_summaries file
1993 let location = ms_location old_summary
1995 -- return the cached summary if the source didn't change
1996 src_timestamp <- case maybe_buf of
1997 Just (_,t) -> return t
1998 Nothing -> liftIO $ getModificationTime file
1999 -- The file exists; we checked in getRootSummary above.
2000 -- If it gets removed subsequently, then this
2001 -- getModificationTime may fail, but that's the right
2004 if ms_hs_date old_summary == src_timestamp
2005 then do -- update the object-file timestamp
2007 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2008 || obj_allowed -- bug #1205
2009 then liftIO $ getObjTimestamp location False
2011 return old_summary{ ms_obj_date = obj_timestamp }
2019 let dflags = hsc_dflags hsc_env
2021 (dflags', hspp_fn, buf)
2022 <- preprocessFile hsc_env file mb_phase maybe_buf
2024 (srcimps,the_imps, L _ mod_name) <- getImports dflags' buf hspp_fn file
2026 -- Make a ModLocation for this file
2027 location <- liftIO $ mkHomeModLocation dflags mod_name file
2029 -- Tell the Finder cache where it is, so that subsequent calls
2030 -- to findModule will find it, even if it's not on any search path
2031 mod <- liftIO $ addHomeModuleToFinder hsc_env mod_name location
2033 src_timestamp <- case maybe_buf of
2034 Just (_,t) -> return t
2035 Nothing -> liftIO $ getModificationTime file
2036 -- getMofificationTime may fail
2038 -- when the user asks to load a source file by name, we only
2039 -- use an object file if -fobject-code is on. See #1205.
2041 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2042 || obj_allowed -- bug #1205
2043 then liftIO $ modificationTimeIfExists (ml_obj_file location)
2046 return (ModSummary { ms_mod = mod, ms_hsc_src = HsSrcFile,
2047 ms_location = location,
2048 ms_hspp_file = hspp_fn,
2049 ms_hspp_opts = dflags',
2050 ms_hspp_buf = Just buf,
2051 ms_srcimps = srcimps, ms_imps = the_imps,
2052 ms_hs_date = src_timestamp,
2053 ms_obj_date = obj_timestamp })
2055 findSummaryBySourceFile :: [ModSummary] -> FilePath -> Maybe ModSummary
2056 findSummaryBySourceFile summaries file
2057 = case [ ms | ms <- summaries, HsSrcFile <- [ms_hsc_src ms],
2058 expectJust "findSummaryBySourceFile" (ml_hs_file (ms_location ms)) == file ] of
2062 -- Summarise a module, and pick up source and timestamp.
2066 -> NodeMap ModSummary -- Map of old summaries
2067 -> IsBootInterface -- True <=> a {-# SOURCE #-} import
2068 -> Located ModuleName -- Imported module to be summarised
2069 -> Bool -- object code allowed?
2070 -> Maybe (StringBuffer, ClockTime)
2071 -> [ModuleName] -- Modules to exclude
2072 -> m (Maybe ModSummary) -- Its new summary
2074 summariseModule hsc_env old_summary_map is_boot (L loc wanted_mod)
2075 obj_allowed maybe_buf excl_mods
2076 | wanted_mod `elem` excl_mods
2079 | Just old_summary <- lookupFM old_summary_map (wanted_mod, hsc_src)
2080 = do -- Find its new timestamp; all the
2081 -- ModSummaries in the old map have valid ml_hs_files
2082 let location = ms_location old_summary
2083 src_fn = expectJust "summariseModule" (ml_hs_file location)
2085 -- check the modification time on the source file, and
2086 -- return the cached summary if it hasn't changed. If the
2087 -- file has disappeared, we need to call the Finder again.
2089 Just (_,t) -> check_timestamp old_summary location src_fn t
2091 m <- liftIO $ System.IO.Error.try (getModificationTime src_fn)
2093 Right t -> check_timestamp old_summary location src_fn t
2094 Left e | isDoesNotExistError e -> find_it
2095 | otherwise -> liftIO $ ioError e
2097 | otherwise = find_it
2099 dflags = hsc_dflags hsc_env
2101 hsc_src = if is_boot then HsBootFile else HsSrcFile
2103 check_timestamp old_summary location src_fn src_timestamp
2104 | ms_hs_date old_summary == src_timestamp = do
2105 -- update the object-file timestamp
2106 obj_timestamp <- liftIO $
2107 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2108 || obj_allowed -- bug #1205
2109 then getObjTimestamp location is_boot
2111 return (Just old_summary{ ms_obj_date = obj_timestamp })
2113 -- source changed: re-summarise.
2114 new_summary location (ms_mod old_summary) src_fn src_timestamp
2117 -- Don't use the Finder's cache this time. If the module was
2118 -- previously a package module, it may have now appeared on the
2119 -- search path, so we want to consider it to be a home module. If
2120 -- the module was previously a home module, it may have moved.
2121 liftIO $ uncacheModule hsc_env wanted_mod
2122 found <- liftIO $ findImportedModule hsc_env wanted_mod Nothing
2125 | isJust (ml_hs_file location) ->
2127 just_found location mod
2129 -- Drop external-pkg
2130 ASSERT(modulePackageId mod /= thisPackage dflags)
2133 err -> liftIO $ noModError dflags loc wanted_mod err
2136 just_found location mod = do
2137 -- Adjust location to point to the hs-boot source file,
2138 -- hi file, object file, when is_boot says so
2139 let location' | is_boot = addBootSuffixLocn location
2140 | otherwise = location
2141 src_fn = expectJust "summarise2" (ml_hs_file location')
2143 -- Check that it exists
2144 -- It might have been deleted since the Finder last found it
2145 maybe_t <- liftIO $ modificationTimeIfExists src_fn
2147 Nothing -> noHsFileErr loc src_fn
2148 Just t -> new_summary location' mod src_fn t
2151 new_summary location mod src_fn src_timestamp
2153 -- Preprocess the source file and get its imports
2154 -- The dflags' contains the OPTIONS pragmas
2155 (dflags', hspp_fn, buf) <- preprocessFile hsc_env src_fn Nothing maybe_buf
2156 (srcimps, the_imps, L mod_loc mod_name) <- getImports dflags' buf hspp_fn src_fn
2158 when (mod_name /= wanted_mod) $
2159 throwOneError $ mkPlainErrMsg mod_loc $
2160 text "File name does not match module name:"
2161 $$ text "Saw:" <+> quotes (ppr mod_name)
2162 $$ text "Expected:" <+> quotes (ppr wanted_mod)
2164 -- Find the object timestamp, and return the summary
2165 obj_timestamp <- liftIO $
2166 if isObjectTarget (hscTarget (hsc_dflags hsc_env))
2167 || obj_allowed -- bug #1205
2168 then getObjTimestamp location is_boot
2171 return (Just (ModSummary { ms_mod = mod,
2172 ms_hsc_src = hsc_src,
2173 ms_location = location,
2174 ms_hspp_file = hspp_fn,
2175 ms_hspp_opts = dflags',
2176 ms_hspp_buf = Just buf,
2177 ms_srcimps = srcimps,
2179 ms_hs_date = src_timestamp,
2180 ms_obj_date = obj_timestamp }))
2183 getObjTimestamp :: ModLocation -> Bool -> IO (Maybe ClockTime)
2184 getObjTimestamp location is_boot
2185 = if is_boot then return Nothing
2186 else modificationTimeIfExists (ml_obj_file location)
2189 preprocessFile :: GhcMonad m =>
2192 -> Maybe Phase -- ^ Starting phase
2193 -> Maybe (StringBuffer,ClockTime)
2194 -> m (DynFlags, FilePath, StringBuffer)
2195 preprocessFile hsc_env src_fn mb_phase Nothing
2197 (dflags', hspp_fn) <- preprocess hsc_env (src_fn, mb_phase)
2198 buf <- liftIO $ hGetStringBuffer hspp_fn
2199 return (dflags', hspp_fn, buf)
2201 preprocessFile hsc_env src_fn mb_phase (Just (buf, _time))
2203 let dflags = hsc_dflags hsc_env
2204 -- case we bypass the preprocessing stage?
2206 local_opts = getOptions dflags buf src_fn
2208 (dflags', leftovers, warns)
2209 <- parseDynamicNoPackageFlags dflags local_opts
2210 checkProcessArgsResult leftovers
2211 handleFlagWarnings dflags' warns
2215 | Just (Unlit _) <- mb_phase = True
2216 | Nothing <- mb_phase, Unlit _ <- startPhase src_fn = True
2217 -- note: local_opts is only required if there's no Unlit phase
2218 | dopt Opt_Cpp dflags' = True
2219 | dopt Opt_Pp dflags' = True
2222 when needs_preprocessing $
2223 ghcError (ProgramError "buffer needs preprocesing; interactive check disabled")
2225 return (dflags', src_fn, buf)
2228 -----------------------------------------------------------------------------
2230 -----------------------------------------------------------------------------
2232 noModError :: DynFlags -> SrcSpan -> ModuleName -> FindResult -> IO ab
2233 -- ToDo: we don't have a proper line number for this error
2234 noModError dflags loc wanted_mod err
2235 = throwOneError $ mkPlainErrMsg loc $ cannotFindModule dflags wanted_mod err
2237 noHsFileErr :: GhcMonad m => SrcSpan -> String -> m a
2238 noHsFileErr loc path
2239 = throwOneError $ mkPlainErrMsg loc $ text "Can't find" <+> text path
2241 packageModErr :: GhcMonad m => ModuleName -> m a
2243 = throwOneError $ mkPlainErrMsg noSrcSpan $
2244 text "module" <+> quotes (ppr mod) <+> text "is a package module"
2246 multiRootsErr :: [ModSummary] -> IO ()
2247 multiRootsErr [] = panic "multiRootsErr"
2248 multiRootsErr summs@(summ1:_)
2249 = throwOneError $ mkPlainErrMsg noSrcSpan $
2250 text "module" <+> quotes (ppr mod) <+>
2251 text "is defined in multiple files:" <+>
2252 sep (map text files)
2255 files = map (expectJust "checkDup" . ml_hs_file . ms_location) summs
2257 cyclicModuleErr :: [ModSummary] -> SDoc
2259 = hang (ptext (sLit "Module imports form a cycle for modules:"))
2260 2 (vcat (map show_one ms))
2262 show_one ms = sep [ show_mod (ms_hsc_src ms) (ms_mod ms),
2263 nest 2 $ ptext (sLit "imports:") <+>
2264 (pp_imps HsBootFile (ms_srcimps ms)
2265 $$ pp_imps HsSrcFile (ms_imps ms))]
2266 show_mod hsc_src mod = ppr mod <> text (hscSourceString hsc_src)
2267 pp_imps src mods = fsep (map (show_mod src) mods)
2270 -- | Inform GHC that the working directory has changed. GHC will flush
2271 -- its cache of module locations, since it may no longer be valid.
2272 -- Note: if you change the working directory, you should also unload
2273 -- the current program (set targets to empty, followed by load).
2274 workingDirectoryChanged :: GhcMonad m => m ()
2275 workingDirectoryChanged = withSession $ (liftIO . flushFinderCaches)
2277 -- -----------------------------------------------------------------------------
2278 -- inspecting the session
2280 -- | Get the module dependency graph.
2281 getModuleGraph :: GhcMonad m => m ModuleGraph -- ToDo: DiGraph ModSummary
2282 getModuleGraph = liftM hsc_mod_graph getSession
2284 -- | Return @True@ <==> module is loaded.
2285 isLoaded :: GhcMonad m => ModuleName -> m Bool
2286 isLoaded m = withSession $ \hsc_env ->
2287 return $! isJust (lookupUFM (hsc_HPT hsc_env) m)
2289 -- | Return the bindings for the current interactive session.
2290 getBindings :: GhcMonad m => m [TyThing]
2291 getBindings = withSession $ \hsc_env ->
2292 -- we have to implement the shadowing behaviour of ic_tmp_ids here
2293 -- (see InteractiveContext) and the quickest way is to use an OccEnv.
2295 tmp_ids = ic_tmp_ids (hsc_IC hsc_env)
2296 filtered = foldr f (const []) tmp_ids emptyUniqSet
2298 | uniq `elementOfUniqSet` set = rest set
2299 | otherwise = AnId id : rest (addOneToUniqSet set uniq)
2300 where uniq = getUnique (nameOccName (idName id))
2304 getPrintUnqual :: GhcMonad m => m PrintUnqualified
2305 getPrintUnqual = withSession $ \hsc_env ->
2306 return (icPrintUnqual (hsc_dflags hsc_env) (hsc_IC hsc_env))
2308 -- | Container for information about a 'Module'.
2309 data ModuleInfo = ModuleInfo {
2310 minf_type_env :: TypeEnv,
2311 minf_exports :: NameSet, -- ToDo, [AvailInfo] like ModDetails?
2312 minf_rdr_env :: Maybe GlobalRdrEnv, -- Nothing for a compiled/package mod
2313 minf_instances :: [Instance]
2315 ,minf_modBreaks :: ModBreaks
2317 -- ToDo: this should really contain the ModIface too
2319 -- We don't want HomeModInfo here, because a ModuleInfo applies
2320 -- to package modules too.
2322 -- | Request information about a loaded 'Module'
2323 getModuleInfo :: GhcMonad m => Module -> m (Maybe ModuleInfo) -- XXX: Maybe X
2324 getModuleInfo mdl = withSession $ \hsc_env -> do
2325 let mg = hsc_mod_graph hsc_env
2326 if mdl `elem` map ms_mod mg
2327 then liftIO $ getHomeModuleInfo hsc_env (moduleName mdl)
2329 {- if isHomeModule (hsc_dflags hsc_env) mdl
2331 else -} liftIO $ getPackageModuleInfo hsc_env mdl
2332 -- getPackageModuleInfo will attempt to find the interface, so
2333 -- we don't want to call it for a home module, just in case there
2334 -- was a problem loading the module and the interface doesn't
2335 -- exist... hence the isHomeModule test here. (ToDo: reinstate)
2337 getPackageModuleInfo :: HscEnv -> Module -> IO (Maybe ModuleInfo)
2339 getPackageModuleInfo hsc_env mdl = do
2340 (_msgs, mb_avails) <- getModuleExports hsc_env mdl
2342 Nothing -> return Nothing
2344 eps <- readIORef (hsc_EPS hsc_env)
2346 names = availsToNameSet avails
2348 tys = [ ty | name <- concatMap availNames avails,
2349 Just ty <- [lookupTypeEnv pte name] ]
2351 return (Just (ModuleInfo {
2352 minf_type_env = mkTypeEnv tys,
2353 minf_exports = names,
2354 minf_rdr_env = Just $! nameSetToGlobalRdrEnv names (moduleName mdl),
2355 minf_instances = error "getModuleInfo: instances for package module unimplemented",
2356 minf_modBreaks = emptyModBreaks
2359 getPackageModuleInfo _hsc_env _mdl = do
2360 -- bogusly different for non-GHCI (ToDo)
2364 getHomeModuleInfo :: HscEnv -> ModuleName -> IO (Maybe ModuleInfo)
2365 getHomeModuleInfo hsc_env mdl =
2366 case lookupUFM (hsc_HPT hsc_env) mdl of
2367 Nothing -> return Nothing
2369 let details = hm_details hmi
2370 return (Just (ModuleInfo {
2371 minf_type_env = md_types details,
2372 minf_exports = availsToNameSet (md_exports details),
2373 minf_rdr_env = mi_globals $! hm_iface hmi,
2374 minf_instances = md_insts details
2376 ,minf_modBreaks = getModBreaks hmi
2380 -- | The list of top-level entities defined in a module
2381 modInfoTyThings :: ModuleInfo -> [TyThing]
2382 modInfoTyThings minf = typeEnvElts (minf_type_env minf)
2384 modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]
2385 modInfoTopLevelScope minf
2386 = fmap (map gre_name . globalRdrEnvElts) (minf_rdr_env minf)
2388 modInfoExports :: ModuleInfo -> [Name]
2389 modInfoExports minf = nameSetToList $! minf_exports minf
2391 -- | Returns the instances defined by the specified module.
2392 -- Warning: currently unimplemented for package modules.
2393 modInfoInstances :: ModuleInfo -> [Instance]
2394 modInfoInstances = minf_instances
2396 modInfoIsExportedName :: ModuleInfo -> Name -> Bool
2397 modInfoIsExportedName minf name = elemNameSet name (minf_exports minf)
2399 mkPrintUnqualifiedForModule :: GhcMonad m =>
2401 -> m (Maybe PrintUnqualified) -- XXX: returns a Maybe X
2402 mkPrintUnqualifiedForModule minf = withSession $ \hsc_env -> do
2403 return (fmap (mkPrintUnqualified (hsc_dflags hsc_env)) (minf_rdr_env minf))
2405 modInfoLookupName :: GhcMonad m =>
2407 -> m (Maybe TyThing) -- XXX: returns a Maybe X
2408 modInfoLookupName minf name = withSession $ \hsc_env -> do
2409 case lookupTypeEnv (minf_type_env minf) name of
2410 Just tyThing -> return (Just tyThing)
2412 eps <- liftIO $ readIORef (hsc_EPS hsc_env)
2413 return $! lookupType (hsc_dflags hsc_env)
2414 (hsc_HPT hsc_env) (eps_PTE eps) name
2417 modInfoModBreaks :: ModuleInfo -> ModBreaks
2418 modInfoModBreaks = minf_modBreaks
2421 isDictonaryId :: Id -> Bool
2423 = case tcSplitSigmaTy (idType id) of { (_tvs, _theta, tau) -> isDictTy tau }
2425 -- | Looks up a global name: that is, any top-level name in any
2426 -- visible module. Unlike 'lookupName', lookupGlobalName does not use
2427 -- the interactive context, and therefore does not require a preceding
2429 lookupGlobalName :: GhcMonad m => Name -> m (Maybe TyThing)
2430 lookupGlobalName name = withSession $ \hsc_env -> do
2431 liftIO $ lookupTypeHscEnv hsc_env name
2433 findGlobalAnns :: (GhcMonad m, Typeable a) => ([Word8] -> a) -> AnnTarget Name -> m [a]
2434 findGlobalAnns deserialize target = withSession $ \hsc_env -> do
2435 ann_env <- liftIO $ prepareAnnotations hsc_env Nothing
2436 return (findAnns deserialize ann_env target)
2439 -- | get the GlobalRdrEnv for a session
2440 getGRE :: GhcMonad m => m GlobalRdrEnv
2441 getGRE = withSession $ \hsc_env-> return $ ic_rn_gbl_env (hsc_IC hsc_env)
2444 -- -----------------------------------------------------------------------------
2446 -- | Return all /external/ modules available in the package database.
2447 -- Modules from the current session (i.e., from the 'HomePackageTable') are
2449 packageDbModules :: GhcMonad m =>
2450 Bool -- ^ Only consider exposed packages.
2452 packageDbModules only_exposed = do
2453 dflags <- getSessionDynFlags
2454 let pkgs = UFM.eltsUFM (pkgIdMap (pkgState dflags))
2456 [ mkModule pid modname | p <- pkgs
2457 , not only_exposed || exposed p
2458 , pid <- [mkPackageId (package p)]
2459 , modname <- exposedModules p ]
2461 -- -----------------------------------------------------------------------------
2462 -- Misc exported utils
2464 dataConType :: DataCon -> Type
2465 dataConType dc = idType (dataConWrapId dc)
2467 -- | print a 'NamedThing', adding parentheses if the name is an operator.
2468 pprParenSymName :: NamedThing a => a -> SDoc
2469 pprParenSymName a = parenSymOcc (getOccName a) (ppr (getName a))
2471 -- ----------------------------------------------------------------------------
2476 -- - Data and Typeable instances for HsSyn.
2478 -- ToDo: check for small transformations that happen to the syntax in
2479 -- the typechecker (eg. -e ==> negate e, perhaps for fromIntegral)
2481 -- ToDo: maybe use TH syntax instead of IfaceSyn? There's already a way
2482 -- to get from TyCons, Ids etc. to TH syntax (reify).
2484 -- :browse will use either lm_toplev or inspect lm_interface, depending
2485 -- on whether the module is interpreted or not.
2489 -- Extract the filename, stringbuffer content and dynflags associed to a module
2491 -- XXX: Explain pre-conditions
2492 getModuleSourceAndFlags :: GhcMonad m => Module -> m (String, StringBuffer, DynFlags)
2493 getModuleSourceAndFlags mod = do
2494 m <- getModSummary (moduleName mod)
2495 case ml_hs_file $ ms_location m of
2496 Nothing -> throw $ mkApiErr (text "No source available for module " <+> ppr mod)
2497 Just sourceFile -> do
2498 source <- liftIO $ hGetStringBuffer sourceFile
2499 return (sourceFile, source, ms_hspp_opts m)
2502 -- | Return module source as token stream, including comments.
2504 -- The module must be in the module graph and its source must be available.
2505 -- Throws a 'HscTypes.SourceError' on parse error.
2506 getTokenStream :: GhcMonad m => Module -> m [Located Token]
2507 getTokenStream mod = do
2508 (sourceFile, source, flags) <- getModuleSourceAndFlags mod
2509 let startLoc = mkSrcLoc (mkFastString sourceFile) 0 0
2510 case lexTokenStream source startLoc flags of
2511 POk _ ts -> return ts
2512 PFailed span err -> throw $ mkSrcErr (unitBag $ mkPlainErrMsg span err)
2514 -- | Give even more information on the source than 'getTokenStream'
2515 -- This function allows reconstructing the source completely with
2516 -- 'showRichTokenStream'.
2517 getRichTokenStream :: GhcMonad m => Module -> m [(Located Token, String)]
2518 getRichTokenStream mod = do
2519 (sourceFile, source, flags) <- getModuleSourceAndFlags mod
2520 let startLoc = mkSrcLoc (mkFastString sourceFile) 0 0
2521 case lexTokenStream source startLoc flags of
2522 POk _ ts -> return $ addSourceToTokens startLoc source ts
2523 PFailed span err -> throw $ mkSrcErr (unitBag $ mkPlainErrMsg span err)
2525 -- | Given a source location and a StringBuffer corresponding to this
2526 -- location, return a rich token stream with the source associated to the
2528 addSourceToTokens :: SrcLoc -> StringBuffer -> [Located Token]
2529 -> [(Located Token, String)]
2530 addSourceToTokens _ _ [] = []
2531 addSourceToTokens loc buf (t@(L span _) : ts)
2532 | not (isGoodSrcSpan span) = (t,"") : addSourceToTokens loc buf ts
2533 | otherwise = (t,str) : addSourceToTokens newLoc newBuf ts
2535 (newLoc, newBuf, str) = go "" loc buf
2536 start = srcSpanStart span
2537 end = srcSpanEnd span
2538 go acc loc buf | loc < start = go acc nLoc nBuf
2539 | start <= loc && loc < end = go (ch:acc) nLoc nBuf
2540 | otherwise = (loc, buf, reverse acc)
2541 where (ch, nBuf) = nextChar buf
2542 nLoc = advanceSrcLoc loc ch
2545 -- | Take a rich token stream such as produced from 'getRichTokenStream' and
2546 -- return source code almost identical to the original code (except for
2547 -- insignificant whitespace.)
2548 showRichTokenStream :: [(Located Token, String)] -> String
2549 showRichTokenStream ts = go startLoc ts ""
2550 where sourceFile = srcSpanFile (getLoc . fst . head $ ts)
2551 startLoc = mkSrcLoc sourceFile 0 0
2553 go loc ((L span _, str):ts)
2554 | not (isGoodSrcSpan span) = go loc ts
2555 | locLine == tokLine = ((replicate (tokCol - locCol) ' ') ++)
2558 | otherwise = ((replicate (tokLine - locLine) '\n') ++)
2559 . ((replicate tokCol ' ') ++)
2562 where (locLine, locCol) = (srcLocLine loc, srcLocCol loc)
2563 (tokLine, tokCol) = (srcSpanStartLine span, srcSpanStartCol span)
2564 tokEnd = srcSpanEnd span
2566 -- -----------------------------------------------------------------------------
2567 -- Interactive evaluation
2569 -- | Takes a 'ModuleName' and possibly a 'PackageId', and consults the
2570 -- filesystem and package database to find the corresponding 'Module',
2571 -- using the algorithm that is used for an @import@ declaration.
2572 findModule :: GhcMonad m => ModuleName -> Maybe FastString -> m Module
2573 findModule mod_name maybe_pkg = withSession $ \hsc_env -> liftIO $ -- XXX
2575 dflags = hsc_dflags hsc_env
2576 hpt = hsc_HPT hsc_env
2577 this_pkg = thisPackage dflags
2579 case lookupUFM hpt mod_name of
2580 Just mod_info -> return (mi_module (hm_iface mod_info))
2581 _not_a_home_module -> do
2582 res <- findImportedModule hsc_env mod_name maybe_pkg
2584 Found _ m | modulePackageId m /= this_pkg -> return m
2585 | otherwise -> ghcError (CmdLineError (showSDoc $
2586 text "module" <+> quotes (ppr (moduleName m)) <+>
2587 text "is not loaded"))
2588 err -> let msg = cannotFindModule dflags mod_name err in
2589 ghcError (CmdLineError (showSDoc msg))
2592 getHistorySpan :: GhcMonad m => History -> m SrcSpan
2593 getHistorySpan h = withSession $ \hsc_env ->
2594 return$ InteractiveEval.getHistorySpan hsc_env h
2596 obtainTermFromVal :: GhcMonad m => Int -> Bool -> Type -> a -> m Term
2597 obtainTermFromVal bound force ty a =
2598 withSession $ \hsc_env ->
2599 liftIO $ InteractiveEval.obtainTermFromVal hsc_env bound force ty a
2601 obtainTermFromId :: GhcMonad m => Int -> Bool -> Id -> m Term
2602 obtainTermFromId bound force id =
2603 withSession $ \hsc_env ->
2604 liftIO $ InteractiveEval.obtainTermFromId hsc_env bound force id
projects / ghc-hetmet.git / blob