1 -- -----------------------------------------------------------------------------
3 -- (c) The University of Glasgow, 2005
7 -- -----------------------------------------------------------------------------
13 defaultCleanupHandler,
17 -- * Flags and settings
18 DynFlags(..), DynFlag(..), GhcMode(..), HscTarget(..), dopt,
26 Target(..), TargetId(..), Phase,
33 -- * Loading\/compiling the program
35 load, LoadHowMuch(..), SuccessFlag(..), -- also does depanal
37 workingDirectoryChanged,
38 checkModule, CheckedModule(..),
39 TypecheckedSource, ParsedSource, RenamedSource,
41 -- * Inspecting the module structure of the program
42 ModuleGraph, ModSummary(..),
47 -- * Inspecting modules
52 modInfoPrintUnqualified,
55 modInfoIsExportedName,
60 PrintUnqualified, alwaysQualify,
62 -- * Interactive evaluation
63 getBindings, getPrintUnqual,
65 setContext, getContext,
79 -- * Abstract syntax elements
82 Module, mkModule, pprModule,
86 nameModule, nameParent_maybe, pprParenSymName, nameSrcLoc,
91 isImplicitId, isDeadBinder,
92 isSpecPragmaId, isExportedId, isLocalId, isGlobalId,
94 isPrimOpId, isFCallId, isClassOpId_maybe,
95 isDataConWorkId, idDataCon,
96 isBottomingId, isDictonaryId,
97 recordSelectorFieldLabel,
99 -- ** Type constructors
101 tyConTyVars, tyConDataCons,
102 isClassTyCon, isSynTyCon, isNewTyCon,
105 -- ** Data constructors
107 dataConSig, dataConType, dataConTyCon, dataConFieldLabels,
108 dataConIsInfix, isVanillaDataCon,
110 StrictnessMark(..), isMarkedStrict,
114 classMethods, classSCTheta, classTvsFds,
119 instanceDFunId, pprInstance,
121 -- ** Types and Kinds
122 Type, dropForAlls, splitForAllTys, funResultTy, pprParendType,
125 ThetaType, pprThetaArrow,
131 module HsSyn, -- ToDo: remove extraneous bits
135 defaultFixity, maxPrecedence,
139 -- ** Source locations
143 GhcException(..), showGhcException,
153 * inline bits of HscMain here to simplify layering: hscTcExpr, hscStmt.
154 * we need to expose DynFlags, so should parseDynamicFlags really be
155 part of this interface?
156 * what StaticFlags should we expose, if any?
159 #include "HsVersions.h"
162 import qualified Linker
163 import Linker ( HValue, extendLinkEnv )
164 import TcRnDriver ( tcRnLookupRdrName, tcRnGetInfo,
165 tcRnLookupName, getModuleExports )
166 import RdrName ( plusGlobalRdrEnv, Provenance(..),
167 ImportSpec(..), ImpDeclSpec(..), ImpItemSpec(..),
168 emptyGlobalRdrEnv, mkGlobalRdrEnv )
169 import HscMain ( hscParseIdentifier, hscStmt, hscTcExpr, hscKcType )
170 import Type ( tidyType )
171 import VarEnv ( emptyTidyEnv )
172 import GHC.Exts ( unsafeCoerce# )
175 import Packages ( PackageIdH(..), initPackages )
176 import NameSet ( NameSet, nameSetToList, elemNameSet )
177 import RdrName ( GlobalRdrEnv, GlobalRdrElt(..), RdrName,
180 import Type ( Kind, Type, dropForAlls, PredType, ThetaType,
181 pprThetaArrow, pprParendType, splitForAllTys,
183 import Id ( Id, idType, isImplicitId, isDeadBinder,
184 isSpecPragmaId, isExportedId, isLocalId, isGlobalId,
185 isRecordSelector, recordSelectorFieldLabel,
186 isPrimOpId, isFCallId, isClassOpId_maybe,
187 isDataConWorkId, idDataCon,
189 import TyCon ( TyCon, isClassTyCon, isSynTyCon, isNewTyCon,
190 tyConTyVars, tyConDataCons, getSynTyConDefn )
191 import Class ( Class, classSCTheta, classTvsFds, classMethods )
192 import FunDeps ( pprFundeps )
193 import DataCon ( DataCon, dataConWrapId, dataConSig, dataConTyCon,
194 dataConFieldLabels, dataConStrictMarks,
195 dataConIsInfix, isVanillaDataCon )
196 import Name ( Name, nameModule, NamedThing(..), nameParent_maybe,
198 import OccName ( parenSymOcc )
199 import NameEnv ( nameEnvElts )
200 import InstEnv ( Instance, instanceDFunId, pprInstance )
202 import DriverPipeline
203 import DriverPhases ( Phase(..), isHaskellSrcFilename, startPhase )
204 import GetImports ( getImports )
205 import Packages ( isHomePackage )
207 import HscMain ( newHscEnv, hscFileCheck, HscResult(..) )
211 import SysTools ( initSysTools, cleanTempFiles )
216 import Bag ( unitBag, emptyBag )
217 import ErrUtils ( showPass, Messages, putMsg, debugTraceMsg,
218 mkPlainErrMsg, pprBagOfErrors )
219 import qualified ErrUtils
221 import StringBuffer ( StringBuffer, hGetStringBuffer )
223 import SysTools ( cleanTempFilesExcept )
225 import TcType ( tcSplitSigmaTy, isDictTy )
226 import FastString ( mkFastString )
228 import Directory ( getModificationTime, doesFileExist )
229 import Maybe ( isJust, isNothing, fromJust )
230 import Maybes ( orElse, expectJust, mapCatMaybes )
231 import qualified Maybes (MaybeErr(..))
232 import List ( partition, nub )
233 import qualified List
234 import Monad ( unless, when )
235 import System ( exitWith, ExitCode(..) )
236 import Time ( ClockTime )
237 import EXCEPTION as Exception hiding (handle)
240 import Prelude hiding (init)
242 -- -----------------------------------------------------------------------------
243 -- Exception handlers
245 -- | Install some default exception handlers and run the inner computation.
246 -- Unless you want to handle exceptions yourself, you should wrap this around
247 -- the top level of your program. The default handlers output the error
248 -- message(s) to stderr and exit cleanly.
249 defaultErrorHandler :: IO a -> IO a
250 defaultErrorHandler inner =
251 -- top-level exception handler: any unrecognised exception is a compiler bug.
252 handle (\exception -> do
255 -- an IO exception probably isn't our fault, so don't panic
256 IOException _ -> putMsg (show exception)
257 AsyncException StackOverflow ->
258 putMsg "stack overflow: use +RTS -K<size> to increase it"
259 _other -> putMsg (show (Panic (show exception)))
260 exitWith (ExitFailure 1)
263 -- program errors: messages with locations attached. Sometimes it is
264 -- convenient to just throw these as exceptions.
265 handleDyn (\dyn -> do printErrs (pprBagOfErrors (unitBag dyn))
266 exitWith (ExitFailure 1)) $
268 -- error messages propagated as exceptions
269 handleDyn (\dyn -> do
272 PhaseFailed _ code -> exitWith code
273 Interrupted -> exitWith (ExitFailure 1)
274 _ -> do putMsg (show (dyn :: GhcException))
275 exitWith (ExitFailure 1)
279 -- | Install a default cleanup handler to remove temporary files
280 -- deposited by a GHC run. This is seperate from
281 -- 'defaultErrorHandler', because you might want to override the error
282 -- handling, but still get the ordinary cleanup behaviour.
283 defaultCleanupHandler :: DynFlags -> IO a -> IO a
284 defaultCleanupHandler dflags inner =
285 -- make sure we clean up after ourselves
286 later (unless (dopt Opt_KeepTmpFiles dflags) $
287 cleanTempFiles dflags)
288 -- exceptions will be blocked while we clean the temporary files,
289 -- so there shouldn't be any difficulty if we receive further
294 -- | Initialises GHC. This must be done /once/ only. Takes the
295 -- command-line arguments. All command-line arguments which aren't
296 -- understood by GHC will be returned.
298 init :: [String] -> IO [String]
301 installSignalHandlers
303 -- Grab the -B option if there is one
304 let (minusB_args, argv1) = partition (prefixMatch "-B") args
305 dflags0 <- initSysTools minusB_args defaultDynFlags
306 writeIORef v_initDynFlags dflags0
308 -- Parse the static flags
309 argv2 <- parseStaticFlags argv1
312 GLOBAL_VAR(v_initDynFlags, error "initDynFlags", DynFlags)
313 -- stores the DynFlags between the call to init and subsequent
314 -- calls to newSession.
316 -- | Starts a new session. A session consists of a set of loaded
317 -- modules, a set of options (DynFlags), and an interactive context.
318 -- ToDo: GhcMode should say "keep typechecked code" and\/or "keep renamed
320 newSession :: GhcMode -> IO Session
322 dflags0 <- readIORef v_initDynFlags
323 dflags <- initDynFlags dflags0
324 env <- newHscEnv dflags{ ghcMode=mode }
328 -- tmp: this breaks the abstraction, but required because DriverMkDepend
329 -- needs to call the Finder. ToDo: untangle this.
330 sessionHscEnv :: Session -> IO HscEnv
331 sessionHscEnv (Session ref) = readIORef ref
333 withSession :: Session -> (HscEnv -> IO a) -> IO a
334 withSession (Session ref) f = do h <- readIORef ref; f h
336 modifySession :: Session -> (HscEnv -> HscEnv) -> IO ()
337 modifySession (Session ref) f = do h <- readIORef ref; writeIORef ref $! f h
339 -- -----------------------------------------------------------------------------
342 -- | Grabs the DynFlags from the Session
343 getSessionDynFlags :: Session -> IO DynFlags
344 getSessionDynFlags s = withSession s (return . hsc_dflags)
346 -- | Updates the DynFlags in a Session
347 setSessionDynFlags :: Session -> DynFlags -> IO ()
348 setSessionDynFlags s dflags = modifySession s (\h -> h{ hsc_dflags = dflags })
350 -- | Messages during compilation (eg. warnings and progress messages)
351 -- are reported using this callback. By default, these messages are
352 -- printed to stderr.
353 setMsgHandler :: (String -> IO ()) -> IO ()
354 setMsgHandler = ErrUtils.setMsgHandler
356 -- -----------------------------------------------------------------------------
359 -- ToDo: think about relative vs. absolute file paths. And what
360 -- happens when the current directory changes.
362 -- | Sets the targets for this session. Each target may be a module name
363 -- or a filename. The targets correspond to the set of root modules for
364 -- the program\/library. Unloading the current program is achieved by
365 -- setting the current set of targets to be empty, followed by load.
366 setTargets :: Session -> [Target] -> IO ()
367 setTargets s targets = modifySession s (\h -> h{ hsc_targets = targets })
369 -- | returns the current set of targets
370 getTargets :: Session -> IO [Target]
371 getTargets s = withSession s (return . hsc_targets)
373 -- | Add another target
374 addTarget :: Session -> Target -> IO ()
376 = modifySession s (\h -> h{ hsc_targets = target : hsc_targets h })
379 removeTarget :: Session -> TargetId -> IO ()
380 removeTarget s target_id
381 = modifySession s (\h -> h{ hsc_targets = filter (hsc_targets h) })
383 filter targets = [ t | t@(Target id _) <- targets, id /= target_id ]
385 -- Attempts to guess what Target a string refers to. This function implements
386 -- the --make/GHCi command-line syntax for filenames:
388 -- - if the string looks like a Haskell source filename, then interpret
390 -- - if adding a .hs or .lhs suffix yields the name of an existing file,
392 -- - otherwise interpret the string as a module name
394 guessTarget :: String -> Maybe Phase -> IO Target
395 guessTarget file (Just phase)
396 = return (Target (TargetFile file (Just phase)) Nothing)
397 guessTarget file Nothing
398 | isHaskellSrcFilename file
399 = return (Target (TargetFile file Nothing) Nothing)
401 = do exists <- doesFileExist hs_file
403 then return (Target (TargetFile hs_file Nothing) Nothing)
405 exists <- doesFileExist lhs_file
407 then return (Target (TargetFile lhs_file Nothing) Nothing)
409 return (Target (TargetModule (mkModule file)) Nothing)
411 hs_file = file `joinFileExt` "hs"
412 lhs_file = file `joinFileExt` "lhs"
414 -- -----------------------------------------------------------------------------
415 -- Loading the program
417 -- Perform a dependency analysis starting from the current targets
418 -- and update the session with the new module graph.
419 depanal :: Session -> [Module] -> IO (Either Messages ModuleGraph)
420 depanal (Session ref) excluded_mods = do
421 hsc_env <- readIORef ref
423 dflags = hsc_dflags hsc_env
424 gmode = ghcMode (hsc_dflags hsc_env)
425 targets = hsc_targets hsc_env
426 old_graph = hsc_mod_graph hsc_env
428 showPass dflags "Chasing dependencies"
429 when (gmode == BatchCompile) $
430 debugTraceMsg dflags 1 (showSDoc (hcat [
431 text "Chasing modules from: ",
432 hcat (punctuate comma (map pprTarget targets))]))
434 r <- downsweep hsc_env old_graph excluded_mods
436 Right mod_graph -> writeIORef ref hsc_env{ hsc_mod_graph = mod_graph }
441 -- | The result of load.
443 = LoadOk Errors -- ^ all specified targets were loaded successfully.
444 | LoadFailed Errors -- ^ not all modules were loaded.
446 type Errors = [String]
448 data ErrMsg = ErrMsg {
449 errMsgSeverity :: Severity, -- warning, error, etc.
450 errMsgSpans :: [SrcSpan],
451 errMsgShortDoc :: Doc,
452 errMsgExtraInfo :: Doc
459 | LoadDependenciesOf Module
461 -- | Try to load the program. If a Module is supplied, then just
462 -- attempt to load up to this target. If no Module is supplied,
463 -- then try to load all targets.
464 load :: Session -> LoadHowMuch -> IO SuccessFlag
465 load session how_much =
466 loadMsgs session how_much ErrUtils.printErrorsAndWarnings
468 -- | Version of 'load' that takes a callback function to be invoked
469 -- on compiler errors and warnings as they occur during compilation.
470 loadMsgs :: Session -> LoadHowMuch -> (Messages-> IO ()) -> IO SuccessFlag
471 loadMsgs s@(Session ref) how_much msg_act
473 -- Dependency analysis first. Note that this fixes the module graph:
474 -- even if we don't get a fully successful upsweep, the full module
475 -- graph is still retained in the Session. We can tell which modules
476 -- were successfully loaded by inspecting the Session's HPT.
477 mb_graph <- depanal s []
479 Left msgs -> do msg_act msgs; return Failed
480 Right mod_graph -> loadMsgs2 s how_much msg_act mod_graph
482 loadMsgs2 s@(Session ref) how_much msg_act mod_graph = do
483 hsc_env <- readIORef ref
485 let hpt1 = hsc_HPT hsc_env
486 let dflags = hsc_dflags hsc_env
487 let ghci_mode = ghcMode dflags -- this never changes
489 -- The "bad" boot modules are the ones for which we have
490 -- B.hs-boot in the module graph, but no B.hs
491 -- The downsweep should have ensured this does not happen
493 let all_home_mods = [ms_mod s | s <- mod_graph, not (isBootSummary s)]
495 bad_boot_mods = [s | s <- mod_graph, isBootSummary s,
496 not (ms_mod s `elem` all_home_mods)]
498 ASSERT( null bad_boot_mods ) return ()
500 -- mg2_with_srcimps drops the hi-boot nodes, returning a
501 -- graph with cycles. Among other things, it is used for
502 -- backing out partially complete cycles following a failed
503 -- upsweep, and for removing from hpt all the modules
504 -- not in strict downwards closure, during calls to compile.
505 let mg2_with_srcimps :: [SCC ModSummary]
506 mg2_with_srcimps = topSortModuleGraph True mod_graph Nothing
508 -- check the stability property for each module.
509 stable_mods@(stable_obj,stable_bco)
510 | BatchCompile <- ghci_mode = ([],[])
511 | otherwise = checkStability hpt1 mg2_with_srcimps all_home_mods
513 -- prune bits of the HPT which are definitely redundant now,
515 pruned_hpt = pruneHomePackageTable hpt1
516 (flattenSCCs mg2_with_srcimps)
521 debugTraceMsg dflags 2 (showSDoc (text "Stable obj:" <+> ppr stable_obj $$
522 text "Stable BCO:" <+> ppr stable_bco))
524 -- Unload any modules which are going to be re-linked this time around.
525 let stable_linkables = [ linkable
526 | m <- stable_obj++stable_bco,
527 Just hmi <- [lookupModuleEnv pruned_hpt m],
528 Just linkable <- [hm_linkable hmi] ]
529 unload hsc_env stable_linkables
531 -- We could at this point detect cycles which aren't broken by
532 -- a source-import, and complain immediately, but it seems better
533 -- to let upsweep_mods do this, so at least some useful work gets
534 -- done before the upsweep is abandoned.
535 --hPutStrLn stderr "after tsort:\n"
536 --hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
538 -- Now do the upsweep, calling compile for each module in
539 -- turn. Final result is version 3 of everything.
541 -- Topologically sort the module graph, this time including hi-boot
542 -- nodes, and possibly just including the portion of the graph
543 -- reachable from the module specified in the 2nd argument to load.
544 -- This graph should be cycle-free.
545 -- If we're restricting the upsweep to a portion of the graph, we
546 -- also want to retain everything that is still stable.
547 let full_mg :: [SCC ModSummary]
548 full_mg = topSortModuleGraph False mod_graph Nothing
550 maybe_top_mod = case how_much of
552 LoadDependenciesOf m -> Just m
555 partial_mg0 :: [SCC ModSummary]
556 partial_mg0 = topSortModuleGraph False mod_graph maybe_top_mod
558 -- LoadDependenciesOf m: we want the upsweep to stop just
559 -- short of the specified module (unless the specified module
562 | LoadDependenciesOf mod <- how_much
563 = ASSERT( case last partial_mg0 of
564 AcyclicSCC ms -> ms_mod ms == mod; _ -> False )
565 List.init partial_mg0
571 | AcyclicSCC ms <- full_mg,
572 ms_mod ms `elem` stable_obj++stable_bco,
573 ms_mod ms `notElem` [ ms_mod ms' |
574 AcyclicSCC ms' <- partial_mg ] ]
576 mg = stable_mg ++ partial_mg
578 -- clean up between compilations
579 let cleanup = cleanTempFilesExcept dflags
580 (ppFilesFromSummaries (flattenSCCs mg2_with_srcimps))
582 (upsweep_ok, hsc_env1, modsUpswept)
583 <- upsweep (hsc_env { hsc_HPT = emptyHomePackageTable })
584 pruned_hpt stable_mods cleanup msg_act mg
586 -- Make modsDone be the summaries for each home module now
587 -- available; this should equal the domain of hpt3.
588 -- Get in in a roughly top .. bottom order (hence reverse).
590 let modsDone = reverse modsUpswept
592 -- Try and do linking in some form, depending on whether the
593 -- upsweep was completely or only partially successful.
595 if succeeded upsweep_ok
598 -- Easy; just relink it all.
599 do debugTraceMsg dflags 2 "Upsweep completely successful."
601 -- Clean up after ourselves
602 cleanTempFilesExcept dflags (ppFilesFromSummaries modsDone)
604 -- Issue a warning for the confusing case where the user
605 -- said '-o foo' but we're not going to do any linking.
606 -- We attempt linking if either (a) one of the modules is
607 -- called Main, or (b) the user said -no-hs-main, indicating
608 -- that main() is going to come from somewhere else.
610 let ofile = outputFile dflags
611 let no_hs_main = dopt Opt_NoHsMain dflags
612 let mb_main_mod = mainModIs dflags
614 main_mod = mb_main_mod `orElse` "Main"
616 = any ((==main_mod).moduleUserString.ms_mod)
618 do_linking = a_root_is_Main || no_hs_main
620 when (ghci_mode == BatchCompile && isJust ofile && not do_linking) $
621 debugTraceMsg dflags 1 ("Warning: output was redirected with -o, " ++
622 "but no output will be generated\n" ++
623 "because there is no " ++ main_mod ++ " module.")
625 -- link everything together
626 linkresult <- link ghci_mode dflags do_linking (hsc_HPT hsc_env1)
628 loadFinish Succeeded linkresult ref hsc_env1
631 -- Tricky. We need to back out the effects of compiling any
632 -- half-done cycles, both so as to clean up the top level envs
633 -- and to avoid telling the interactive linker to link them.
634 do debugTraceMsg dflags 2 "Upsweep partially successful."
637 = map ms_mod modsDone
638 let mods_to_zap_names
639 = findPartiallyCompletedCycles modsDone_names
642 = filter ((`notElem` mods_to_zap_names).ms_mod)
645 let hpt4 = retainInTopLevelEnvs (map ms_mod mods_to_keep)
648 -- Clean up after ourselves
649 cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep)
651 -- there should be no Nothings where linkables should be, now
652 ASSERT(all (isJust.hm_linkable)
653 (moduleEnvElts (hsc_HPT hsc_env))) do
655 -- Link everything together
656 linkresult <- link ghci_mode dflags False hpt4
658 let hsc_env4 = hsc_env1{ hsc_HPT = hpt4 }
659 loadFinish Failed linkresult ref hsc_env4
661 -- Finish up after a load.
663 -- If the link failed, unload everything and return.
664 loadFinish all_ok Failed ref hsc_env
665 = do unload hsc_env []
666 writeIORef ref $! discardProg hsc_env
669 -- Empty the interactive context and set the module context to the topmost
670 -- newly loaded module, or the Prelude if none were loaded.
671 loadFinish all_ok Succeeded ref hsc_env
672 = do writeIORef ref $! hsc_env{ hsc_IC = emptyInteractiveContext }
676 -- Forget the current program, but retain the persistent info in HscEnv
677 discardProg :: HscEnv -> HscEnv
679 = hsc_env { hsc_mod_graph = emptyMG,
680 hsc_IC = emptyInteractiveContext,
681 hsc_HPT = emptyHomePackageTable }
683 -- used to fish out the preprocess output files for the purposes of
684 -- cleaning up. The preprocessed file *might* be the same as the
685 -- source file, but that doesn't do any harm.
686 ppFilesFromSummaries summaries = [ fn | Just fn <- map ms_hspp_file summaries ]
688 -- -----------------------------------------------------------------------------
692 CheckedModule { parsedSource :: ParsedSource,
693 renamedSource :: Maybe RenamedSource,
694 typecheckedSource :: Maybe TypecheckedSource,
695 checkedModuleInfo :: Maybe ModuleInfo
697 -- ToDo: improvements that could be made here:
698 -- if the module succeeded renaming but not typechecking,
699 -- we can still get back the GlobalRdrEnv and exports, so
700 -- perhaps the ModuleInfo should be split up into separate
701 -- fields within CheckedModule.
703 type ParsedSource = Located (HsModule RdrName)
704 type RenamedSource = HsGroup Name
705 type TypecheckedSource = LHsBinds Id
708 -- - things that aren't in the output of the renamer:
711 -- - things that aren't in the output of the typechecker right now:
715 -- - type/data/newtype declarations
716 -- - class declarations
718 -- - extra things in the typechecker's output:
719 -- - default methods are turned into top-level decls.
720 -- - dictionary bindings
723 -- | This is the way to get access to parsed and typechecked source code
724 -- for a module. 'checkModule' loads all the dependencies of the specified
725 -- module in the Session, and then attempts to typecheck the module. If
726 -- successful, it returns the abstract syntax for the module.
727 checkModule :: Session -> Module -> (Messages -> IO ())
728 -> IO (Maybe CheckedModule)
729 checkModule session@(Session ref) mod msg_act = do
730 -- load up the dependencies first
731 r <- loadMsgs session (LoadDependenciesOf mod) msg_act
732 if (failed r) then return Nothing else do
734 -- now parse & typecheck the module
735 hsc_env <- readIORef ref
736 let mg = hsc_mod_graph hsc_env
737 case [ ms | ms <- mg, ms_mod ms == mod ] of
740 -- Add in the OPTIONS from the source file This is nasty:
741 -- we've done this once already, in the compilation manager
742 -- It might be better to cache the flags in the
743 -- ml_hspp_file field, say
744 let dflags0 = hsc_dflags hsc_env
745 hspp_buf = expectJust "GHC.checkModule" (ms_hspp_buf ms)
746 opts = getOptionsFromStringBuffer hspp_buf
747 (dflags1,leftovers) <- parseDynamicFlags dflags0 (map snd opts)
748 if (not (null leftovers))
749 then do let filename = fromJust (ml_hs_file (ms_location ms))
750 msg_act (optionsErrorMsgs leftovers opts filename)
754 r <- hscFileCheck hsc_env{hsc_dflags=dflags1} msg_act ms
758 HscChecked parsed renamed Nothing ->
759 return (Just (CheckedModule {
760 parsedSource = parsed,
761 renamedSource = renamed,
762 typecheckedSource = Nothing,
763 checkedModuleInfo = Nothing }))
764 HscChecked parsed renamed
765 (Just (tc_binds, rdr_env, details)) -> do
766 let minf = ModuleInfo {
767 minf_type_env = md_types details,
768 minf_exports = md_exports details,
769 minf_rdr_env = Just rdr_env,
770 minf_instances = md_insts details
772 return (Just (CheckedModule {
773 parsedSource = parsed,
774 renamedSource = renamed,
775 typecheckedSource = Just tc_binds,
776 checkedModuleInfo = Just minf }))
780 -- ---------------------------------------------------------------------------
783 unload :: HscEnv -> [Linkable] -> IO ()
784 unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
785 = case ghcMode (hsc_dflags hsc_env) of
786 BatchCompile -> return ()
787 JustTypecheck -> return ()
789 Interactive -> Linker.unload (hsc_dflags hsc_env) stable_linkables
791 Interactive -> panic "unload: no interpreter"
793 other -> panic "unload: strange mode"
795 -- -----------------------------------------------------------------------------
799 Stability tells us which modules definitely do not need to be recompiled.
800 There are two main reasons for having stability:
802 - avoid doing a complete upsweep of the module graph in GHCi when
803 modules near the bottom of the tree have not changed.
805 - to tell GHCi when it can load object code: we can only load object code
806 for a module when we also load object code fo all of the imports of the
807 module. So we need to know that we will definitely not be recompiling
808 any of these modules, and we can use the object code.
810 NB. stability is of no importance to BatchCompile at all, only Interactive.
811 (ToDo: what about JustTypecheck?)
813 The stability check is as follows. Both stableObject and
814 stableBCO are used during the upsweep phase later.
817 stable m = stableObject m || stableBCO m
820 all stableObject (imports m)
821 && old linkable does not exist, or is == on-disk .o
822 && date(on-disk .o) > date(.hs)
825 all stable (imports m)
826 && date(BCO) > date(.hs)
829 These properties embody the following ideas:
831 - if a module is stable:
832 - if it has been compiled in a previous pass (present in HPT)
833 then it does not need to be compiled or re-linked.
834 - if it has not been compiled in a previous pass,
835 then we only need to read its .hi file from disk and
836 link it to produce a ModDetails.
838 - if a modules is not stable, we will definitely be at least
839 re-linking, and possibly re-compiling it during the upsweep.
840 All non-stable modules can (and should) therefore be unlinked
843 - Note that objects are only considered stable if they only depend
844 on other objects. We can't link object code against byte code.
848 :: HomePackageTable -- HPT from last compilation
849 -> [SCC ModSummary] -- current module graph (cyclic)
850 -> [Module] -- all home modules
851 -> ([Module], -- stableObject
852 [Module]) -- stableBCO
854 checkStability hpt sccs all_home_mods = foldl checkSCC ([],[]) sccs
856 checkSCC (stable_obj, stable_bco) scc0
857 | stableObjects = (scc_mods ++ stable_obj, stable_bco)
858 | stableBCOs = (stable_obj, scc_mods ++ stable_bco)
859 | otherwise = (stable_obj, stable_bco)
861 scc = flattenSCC scc0
862 scc_mods = map ms_mod scc
863 home_module m = m `elem` all_home_mods && m `notElem` scc_mods
865 scc_allimps = nub (filter home_module (concatMap ms_allimps scc))
866 -- all imports outside the current SCC, but in the home pkg
868 stable_obj_imps = map (`elem` stable_obj) scc_allimps
869 stable_bco_imps = map (`elem` stable_bco) scc_allimps
876 and (zipWith (||) stable_obj_imps stable_bco_imps)
880 | Just t <- ms_obj_date ms = t >= ms_hs_date ms
884 same_as_prev t = case lookupModuleEnv hpt (ms_mod ms) of
885 Just hmi | Just l <- hm_linkable hmi
886 -> isObjectLinkable l && t == linkableTime l
888 -- why '>=' rather than '>' above? If the filesystem stores
889 -- times to the nearset second, we may occasionally find that
890 -- the object & source have the same modification time,
891 -- especially if the source was automatically generated
892 -- and compiled. Using >= is slightly unsafe, but it matches
896 = case lookupModuleEnv hpt (ms_mod ms) of
897 Just hmi | Just l <- hm_linkable hmi ->
898 not (isObjectLinkable l) &&
899 linkableTime l >= ms_hs_date ms
902 ms_allimps :: ModSummary -> [Module]
903 ms_allimps ms = map unLoc (ms_srcimps ms ++ ms_imps ms)
905 -- -----------------------------------------------------------------------------
906 -- Prune the HomePackageTable
908 -- Before doing an upsweep, we can throw away:
910 -- - For non-stable modules:
911 -- - all ModDetails, all linked code
912 -- - all unlinked code that is out of date with respect to
915 -- This is VERY IMPORTANT otherwise we'll end up requiring 2x the
916 -- space at the end of the upsweep, because the topmost ModDetails of the
917 -- old HPT holds on to the entire type environment from the previous
920 pruneHomePackageTable
923 -> ([Module],[Module])
926 pruneHomePackageTable hpt summ (stable_obj, stable_bco)
927 = mapModuleEnv prune hpt
929 | is_stable modl = hmi'
930 | otherwise = hmi'{ hm_details = emptyModDetails }
932 modl = mi_module (hm_iface hmi)
933 hmi' | Just l <- hm_linkable hmi, linkableTime l < ms_hs_date ms
934 = hmi{ hm_linkable = Nothing }
937 where ms = expectJust "prune" (lookupModuleEnv ms_map modl)
939 ms_map = mkModuleEnv [(ms_mod ms, ms) | ms <- summ]
941 is_stable m = m `elem` stable_obj || m `elem` stable_bco
943 -- -----------------------------------------------------------------------------
945 -- Return (names of) all those in modsDone who are part of a cycle
946 -- as defined by theGraph.
947 findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module]
948 findPartiallyCompletedCycles modsDone theGraph
952 chew ((AcyclicSCC v):rest) = chew rest -- acyclic? not interesting.
953 chew ((CyclicSCC vs):rest)
954 = let names_in_this_cycle = nub (map ms_mod vs)
956 = nub ([done | done <- modsDone,
957 done `elem` names_in_this_cycle])
958 chewed_rest = chew rest
960 if notNull mods_in_this_cycle
961 && length mods_in_this_cycle < length names_in_this_cycle
962 then mods_in_this_cycle ++ chewed_rest
965 -- -----------------------------------------------------------------------------
968 -- This is where we compile each module in the module graph, in a pass
969 -- from the bottom to the top of the graph.
971 -- There better had not be any cyclic groups here -- we check for them.
974 :: HscEnv -- Includes initially-empty HPT
975 -> HomePackageTable -- HPT from last time round (pruned)
976 -> ([Module],[Module]) -- stable modules (see checkStability)
977 -> IO () -- How to clean up unwanted tmp files
978 -> (Messages -> IO ()) -- Compiler error message callback
979 -> [SCC ModSummary] -- Mods to do (the worklist)
981 HscEnv, -- With an updated HPT
982 [ModSummary]) -- Mods which succeeded
984 upsweep hsc_env old_hpt stable_mods cleanup msg_act mods
985 = upsweep' hsc_env old_hpt stable_mods cleanup msg_act mods 1 (length mods)
987 upsweep' hsc_env old_hpt stable_mods cleanup msg_act
989 = return (Succeeded, hsc_env, [])
991 upsweep' hsc_env old_hpt stable_mods cleanup msg_act
993 = do putMsg (showSDoc (cyclicModuleErr ms))
994 return (Failed, hsc_env, [])
996 upsweep' hsc_env old_hpt stable_mods cleanup msg_act
997 (AcyclicSCC mod:mods) mod_index nmods
998 = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++
999 -- show (map (moduleUserString.moduleName.mi_module.hm_iface)
1000 -- (moduleEnvElts (hsc_HPT hsc_env)))
1002 mb_mod_info <- upsweep_mod hsc_env old_hpt stable_mods msg_act mod
1005 cleanup -- Remove unwanted tmp files between compilations
1008 Nothing -> return (Failed, hsc_env, [])
1010 { let this_mod = ms_mod mod
1012 -- Add new info to hsc_env
1013 hpt1 = extendModuleEnv (hsc_HPT hsc_env)
1015 hsc_env1 = hsc_env { hsc_HPT = hpt1 }
1017 -- Space-saving: delete the old HPT entry
1018 -- for mod BUT if mod is a hs-boot
1019 -- node, don't delete it. For the
1020 -- interface, the HPT entry is probaby for the
1021 -- main Haskell source file. Deleting it
1022 -- would force .. (what?? --SDM)
1023 old_hpt1 | isBootSummary mod = old_hpt
1024 | otherwise = delModuleEnv old_hpt this_mod
1026 ; (restOK, hsc_env2, modOKs)
1027 <- upsweep' hsc_env1 old_hpt1 stable_mods cleanup
1028 msg_act mods (mod_index+1) nmods
1029 ; return (restOK, hsc_env2, mod:modOKs)
1033 -- Compile a single module. Always produce a Linkable for it if
1034 -- successful. If no compilation happened, return the old Linkable.
1035 upsweep_mod :: HscEnv
1037 -> ([Module],[Module])
1038 -> (Messages -> IO ())
1040 -> Int -- index of module
1041 -> Int -- total number of modules
1042 -> IO (Maybe HomeModInfo) -- Nothing => Failed
1044 upsweep_mod hsc_env old_hpt (stable_obj, stable_bco) msg_act summary mod_index nmods
1047 this_mod = ms_mod summary
1048 mb_obj_date = ms_obj_date summary
1049 obj_fn = ml_obj_file (ms_location summary)
1050 hs_date = ms_hs_date summary
1052 compile_it :: Maybe Linkable -> IO (Maybe HomeModInfo)
1053 compile_it = upsweep_compile hsc_env old_hpt this_mod
1054 msg_act summary mod_index nmods
1056 case ghcMode (hsc_dflags hsc_env) of
1059 -- Batch-compilating is easy: just check whether we have
1060 -- an up-to-date object file. If we do, then the compiler
1061 -- needs to do a recompilation check.
1062 _ | Just obj_date <- mb_obj_date, obj_date >= hs_date -> do
1064 findObjectLinkable this_mod obj_fn obj_date
1065 compile_it (Just linkable)
1072 _ | is_stable_obj, isJust old_hmi ->
1074 -- object is stable, and we have an entry in the
1075 -- old HPT: nothing to do
1077 | is_stable_obj, isNothing old_hmi -> do
1079 findObjectLinkable this_mod obj_fn
1080 (expectJust "upseep1" mb_obj_date)
1081 compile_it (Just linkable)
1082 -- object is stable, but we need to load the interface
1083 -- off disk to make a HMI.
1086 ASSERT(isJust old_hmi) -- must be in the old_hpt
1088 -- BCO is stable: nothing to do
1090 | Just hmi <- old_hmi,
1091 Just l <- hm_linkable hmi, not (isObjectLinkable l),
1092 linkableTime l >= ms_hs_date summary ->
1094 -- we have an old BCO that is up to date with respect
1095 -- to the source: do a recompilation check as normal.
1099 -- no existing code at all: we must recompile.
1101 is_stable_obj = this_mod `elem` stable_obj
1102 is_stable_bco = this_mod `elem` stable_bco
1104 old_hmi = lookupModuleEnv old_hpt this_mod
1106 -- Run hsc to compile a module
1107 upsweep_compile hsc_env old_hpt this_mod msg_act summary
1109 mb_old_linkable = do
1111 -- The old interface is ok if it's in the old HPT
1112 -- a) we're compiling a source file, and the old HPT
1113 -- entry is for a source file
1114 -- b) we're compiling a hs-boot file
1115 -- Case (b) allows an hs-boot file to get the interface of its
1116 -- real source file on the second iteration of the compilation
1117 -- manager, but that does no harm. Otherwise the hs-boot file
1118 -- will always be recompiled
1121 = case lookupModuleEnv old_hpt this_mod of
1123 Just hm_info | isBootSummary summary -> Just iface
1124 | not (mi_boot iface) -> Just iface
1125 | otherwise -> Nothing
1127 iface = hm_iface hm_info
1129 compresult <- compile hsc_env msg_act summary mb_old_linkable mb_old_iface
1133 -- Compilation failed. Compile may still have updated the PCS, tho.
1134 CompErrs -> return Nothing
1136 -- Compilation "succeeded", and may or may not have returned a new
1137 -- linkable (depending on whether compilation was actually performed
1139 CompOK new_details new_iface new_linkable
1140 -> do let new_info = HomeModInfo { hm_iface = new_iface,
1141 hm_details = new_details,
1142 hm_linkable = new_linkable }
1143 return (Just new_info)
1146 -- Filter modules in the HPT
1147 retainInTopLevelEnvs :: [Module] -> HomePackageTable -> HomePackageTable
1148 retainInTopLevelEnvs keep_these hpt
1149 = mkModuleEnv [ (mod, expectJust "retain" mb_mod_info)
1151 , let mb_mod_info = lookupModuleEnv hpt mod
1152 , isJust mb_mod_info ]
1154 -- ---------------------------------------------------------------------------
1155 -- Topological sort of the module graph
1158 :: Bool -- Drop hi-boot nodes? (see below)
1162 -- Calculate SCCs of the module graph, possibly dropping the hi-boot nodes
1163 -- The resulting list of strongly-connected-components is in topologically
1164 -- sorted order, starting with the module(s) at the bottom of the
1165 -- dependency graph (ie compile them first) and ending with the ones at
1168 -- Drop hi-boot nodes (first boolean arg)?
1170 -- False: treat the hi-boot summaries as nodes of the graph,
1171 -- so the graph must be acyclic
1173 -- True: eliminate the hi-boot nodes, and instead pretend
1174 -- the a source-import of Foo is an import of Foo
1175 -- The resulting graph has no hi-boot nodes, but can by cyclic
1177 topSortModuleGraph drop_hs_boot_nodes summaries Nothing
1178 = stronglyConnComp (fst (moduleGraphNodes drop_hs_boot_nodes summaries))
1179 topSortModuleGraph drop_hs_boot_nodes summaries (Just mod)
1180 = stronglyConnComp (map vertex_fn (reachable graph root))
1182 -- restrict the graph to just those modules reachable from
1183 -- the specified module. We do this by building a graph with
1184 -- the full set of nodes, and determining the reachable set from
1185 -- the specified node.
1186 (nodes, lookup_key) = moduleGraphNodes drop_hs_boot_nodes summaries
1187 (graph, vertex_fn, key_fn) = graphFromEdges' nodes
1189 | Just key <- lookup_key HsSrcFile mod, Just v <- key_fn key = v
1190 | otherwise = throwDyn (ProgramError "module does not exist")
1192 moduleGraphNodes :: Bool -> [ModSummary]
1193 -> ([(ModSummary, Int, [Int])], HscSource -> Module -> Maybe Int)
1194 moduleGraphNodes drop_hs_boot_nodes summaries = (nodes, lookup_key)
1196 -- Drop hs-boot nodes by using HsSrcFile as the key
1197 hs_boot_key | drop_hs_boot_nodes = HsSrcFile
1198 | otherwise = HsBootFile
1200 -- We use integers as the keys for the SCC algorithm
1201 nodes :: [(ModSummary, Int, [Int])]
1202 nodes = [(s, expectJust "topSort" (lookup_key (ms_hsc_src s) (ms_mod s)),
1203 out_edge_keys hs_boot_key (map unLoc (ms_srcimps s)) ++
1204 out_edge_keys HsSrcFile (map unLoc (ms_imps s)) )
1206 , not (isBootSummary s && drop_hs_boot_nodes) ]
1207 -- Drop the hi-boot ones if told to do so
1209 key_map :: NodeMap Int
1210 key_map = listToFM ([(ms_mod s, ms_hsc_src s) | s <- summaries]
1213 lookup_key :: HscSource -> Module -> Maybe Int
1214 lookup_key hs_src mod = lookupFM key_map (mod, hs_src)
1216 out_edge_keys :: HscSource -> [Module] -> [Int]
1217 out_edge_keys hi_boot ms = mapCatMaybes (lookup_key hi_boot) ms
1218 -- If we want keep_hi_boot_nodes, then we do lookup_key with
1219 -- the IsBootInterface parameter True; else False
1222 type NodeKey = (Module, HscSource) -- The nodes of the graph are
1223 type NodeMap a = FiniteMap NodeKey a -- keyed by (mod, src_file_type) pairs
1225 msKey :: ModSummary -> NodeKey
1226 msKey (ModSummary { ms_mod = mod, ms_hsc_src = boot }) = (mod,boot)
1228 mkNodeMap :: [ModSummary] -> NodeMap ModSummary
1229 mkNodeMap summaries = listToFM [ (msKey s, s) | s <- summaries]
1231 nodeMapElts :: NodeMap a -> [a]
1232 nodeMapElts = eltsFM
1234 -----------------------------------------------------------------------------
1235 -- Downsweep (dependency analysis)
1237 -- Chase downwards from the specified root set, returning summaries
1238 -- for all home modules encountered. Only follow source-import
1241 -- We pass in the previous collection of summaries, which is used as a
1242 -- cache to avoid recalculating a module summary if the source is
1245 -- The returned list of [ModSummary] nodes has one node for each home-package
1246 -- module, plus one for any hs-boot files. The imports of these nodes
1247 -- are all there, including the imports of non-home-package modules.
1250 -> [ModSummary] -- Old summaries
1251 -> [Module] -- Ignore dependencies on these; treat them as
1252 -- if they were package modules
1253 -> IO (Either Messages [ModSummary])
1254 downsweep hsc_env old_summaries excl_mods
1255 = -- catch error messages and return them
1256 handleDyn (\err_msg -> return (Left (emptyBag, unitBag err_msg))) $ do
1257 rootSummaries <- mapM getRootSummary roots
1258 checkDuplicates rootSummaries
1259 summs <- loop (concatMap msDeps rootSummaries) (mkNodeMap rootSummaries)
1260 return (Right summs)
1262 roots = hsc_targets hsc_env
1264 old_summary_map :: NodeMap ModSummary
1265 old_summary_map = mkNodeMap old_summaries
1267 getRootSummary :: Target -> IO ModSummary
1268 getRootSummary (Target (TargetFile file mb_phase) maybe_buf)
1269 = do exists <- doesFileExist file
1271 then summariseFile hsc_env old_summaries file mb_phase maybe_buf
1272 else throwDyn $ mkPlainErrMsg noSrcSpan $
1273 text "can't find file:" <+> text file
1274 getRootSummary (Target (TargetModule modl) maybe_buf)
1275 = do maybe_summary <- summariseModule hsc_env old_summary_map False
1276 (L rootLoc modl) maybe_buf excl_mods
1277 case maybe_summary of
1278 Nothing -> packageModErr modl
1281 rootLoc = mkGeneralSrcSpan FSLIT("<command line>")
1283 -- In a root module, the filename is allowed to diverge from the module
1284 -- name, so we have to check that there aren't multiple root files
1285 -- defining the same module (otherwise the duplicates will be silently
1286 -- ignored, leading to confusing behaviour).
1287 checkDuplicates :: [ModSummary] -> IO ()
1288 checkDuplicates summaries = mapM_ check summaries
1293 many -> multiRootsErr modl many
1294 where modl = ms_mod summ
1296 [ expectJust "checkDup" (ml_hs_file (ms_location summ'))
1297 | summ' <- summaries, ms_mod summ' == modl ]
1299 loop :: [(Located Module,IsBootInterface)]
1300 -- Work list: process these modules
1301 -> NodeMap ModSummary
1304 -- The result includes the worklist, except
1305 -- for those mentioned in the visited set
1306 loop [] done = return (nodeMapElts done)
1307 loop ((wanted_mod, is_boot) : ss) done
1308 | key `elemFM` done = loop ss done
1309 | otherwise = do { mb_s <- summariseModule hsc_env old_summary_map
1310 is_boot wanted_mod Nothing excl_mods
1312 Nothing -> loop ss done
1313 Just s -> loop (msDeps s ++ ss)
1314 (addToFM done key s) }
1316 key = (unLoc wanted_mod, if is_boot then HsBootFile else HsSrcFile)
1318 msDeps :: ModSummary -> [(Located Module, IsBootInterface)]
1319 -- (msDeps s) returns the dependencies of the ModSummary s.
1320 -- A wrinkle is that for a {-# SOURCE #-} import we return
1321 -- *both* the hs-boot file
1322 -- *and* the source file
1323 -- as "dependencies". That ensures that the list of all relevant
1324 -- modules always contains B.hs if it contains B.hs-boot.
1325 -- Remember, this pass isn't doing the topological sort. It's
1326 -- just gathering the list of all relevant ModSummaries
1328 concat [ [(m,True), (m,False)] | m <- ms_srcimps s ]
1329 ++ [ (m,False) | m <- ms_imps s ]
1331 -----------------------------------------------------------------------------
1332 -- Summarising modules
1334 -- We have two types of summarisation:
1336 -- * Summarise a file. This is used for the root module(s) passed to
1337 -- cmLoadModules. The file is read, and used to determine the root
1338 -- module name. The module name may differ from the filename.
1340 -- * Summarise a module. We are given a module name, and must provide
1341 -- a summary. The finder is used to locate the file in which the module
1346 -> [ModSummary] -- old summaries
1347 -> FilePath -- source file name
1348 -> Maybe Phase -- start phase
1349 -> Maybe (StringBuffer,ClockTime)
1352 summariseFile hsc_env old_summaries file mb_phase maybe_buf
1353 -- we can use a cached summary if one is available and the
1354 -- source file hasn't changed, But we have to look up the summary
1355 -- by source file, rather than module name as we do in summarise.
1356 | Just old_summary <- findSummaryBySourceFile old_summaries file
1358 let location = ms_location old_summary
1360 -- return the cached summary if the source didn't change
1361 src_timestamp <- case maybe_buf of
1362 Just (_,t) -> return t
1363 Nothing -> getModificationTime file
1364 -- The file exists; we checked in getRootSummary above.
1365 -- If it gets removed subsequently, then this
1366 -- getModificationTime may fail, but that's the right
1369 if ms_hs_date old_summary == src_timestamp
1370 then do -- update the object-file timestamp
1371 obj_timestamp <- getObjTimestamp location False
1372 return old_summary{ ms_obj_date = obj_timestamp }
1380 let dflags = hsc_dflags hsc_env
1382 (dflags', hspp_fn, buf)
1383 <- preprocessFile dflags file mb_phase maybe_buf
1385 (srcimps,the_imps, L _ mod) <- getImports dflags' buf hspp_fn
1387 -- Make a ModLocation for this file
1388 location <- mkHomeModLocation dflags mod file
1390 -- Tell the Finder cache where it is, so that subsequent calls
1391 -- to findModule will find it, even if it's not on any search path
1392 addHomeModuleToFinder hsc_env mod location
1394 src_timestamp <- case maybe_buf of
1395 Just (_,t) -> return t
1396 Nothing -> getModificationTime file
1397 -- getMofificationTime may fail
1399 obj_timestamp <- modificationTimeIfExists (ml_obj_file location)
1401 return (ModSummary { ms_mod = mod, ms_hsc_src = HsSrcFile,
1402 ms_location = location,
1403 ms_hspp_file = Just hspp_fn,
1404 ms_hspp_buf = Just buf,
1405 ms_srcimps = srcimps, ms_imps = the_imps,
1406 ms_hs_date = src_timestamp,
1407 ms_obj_date = obj_timestamp })
1409 findSummaryBySourceFile :: [ModSummary] -> FilePath -> Maybe ModSummary
1410 findSummaryBySourceFile summaries file
1411 = case [ ms | ms <- summaries, HsSrcFile <- [ms_hsc_src ms],
1412 fromJust (ml_hs_file (ms_location ms)) == file ] of
1416 -- Summarise a module, and pick up source and timestamp.
1419 -> NodeMap ModSummary -- Map of old summaries
1420 -> IsBootInterface -- True <=> a {-# SOURCE #-} import
1421 -> Located Module -- Imported module to be summarised
1422 -> Maybe (StringBuffer, ClockTime)
1423 -> [Module] -- Modules to exclude
1424 -> IO (Maybe ModSummary) -- Its new summary
1426 summariseModule hsc_env old_summary_map is_boot (L loc wanted_mod) maybe_buf excl_mods
1427 | wanted_mod `elem` excl_mods
1430 | Just old_summary <- lookupFM old_summary_map (wanted_mod, hsc_src)
1431 = do -- Find its new timestamp; all the
1432 -- ModSummaries in the old map have valid ml_hs_files
1433 let location = ms_location old_summary
1434 src_fn = expectJust "summariseModule" (ml_hs_file location)
1436 -- check the modification time on the source file, and
1437 -- return the cached summary if it hasn't changed. If the
1438 -- file has disappeared, we need to call the Finder again.
1440 Just (_,t) -> check_timestamp old_summary location src_fn t
1442 m <- IO.try (getModificationTime src_fn)
1444 Right t -> check_timestamp old_summary location src_fn t
1445 Left e | isDoesNotExistError e -> find_it
1446 | otherwise -> ioError e
1448 | otherwise = find_it
1450 dflags = hsc_dflags hsc_env
1452 hsc_src = if is_boot then HsBootFile else HsSrcFile
1454 check_timestamp old_summary location src_fn src_timestamp
1455 | ms_hs_date old_summary == src_timestamp = do
1456 -- update the object-file timestamp
1457 obj_timestamp <- getObjTimestamp location is_boot
1458 return (Just old_summary{ ms_obj_date = obj_timestamp })
1460 -- source changed: find and re-summarise. We call the finder
1461 -- again, because the user may have moved the source file.
1462 new_summary location src_fn src_timestamp
1465 -- Don't use the Finder's cache this time. If the module was
1466 -- previously a package module, it may have now appeared on the
1467 -- search path, so we want to consider it to be a home module. If
1468 -- the module was previously a home module, it may have moved.
1469 uncacheModule hsc_env wanted_mod
1470 found <- findModule hsc_env wanted_mod True {-explicit-}
1473 | not (isHomePackage pkg) -> return Nothing
1474 -- Drop external-pkg
1475 | isJust (ml_hs_file location) -> just_found location
1477 err -> noModError dflags loc wanted_mod err
1480 just_found location = do
1481 -- Adjust location to point to the hs-boot source file,
1482 -- hi file, object file, when is_boot says so
1483 let location' | is_boot = addBootSuffixLocn location
1484 | otherwise = location
1485 src_fn = expectJust "summarise2" (ml_hs_file location')
1487 -- Check that it exists
1488 -- It might have been deleted since the Finder last found it
1489 maybe_t <- modificationTimeIfExists src_fn
1491 Nothing -> noHsFileErr loc src_fn
1492 Just t -> new_summary location' src_fn t
1495 new_summary location src_fn src_timestamp
1497 -- Preprocess the source file and get its imports
1498 -- The dflags' contains the OPTIONS pragmas
1499 (dflags', hspp_fn, buf) <- preprocessFile dflags src_fn Nothing maybe_buf
1500 (srcimps, the_imps, L mod_loc mod_name) <- getImports dflags' buf hspp_fn
1502 when (mod_name /= wanted_mod) $
1503 throwDyn $ mkPlainErrMsg mod_loc $
1504 text "file name does not match module name"
1505 <+> quotes (ppr mod_name)
1507 -- Find the object timestamp, and return the summary
1508 obj_timestamp <- getObjTimestamp location is_boot
1510 return (Just ( ModSummary { ms_mod = wanted_mod,
1511 ms_hsc_src = hsc_src,
1512 ms_location = location,
1513 ms_hspp_file = Just hspp_fn,
1514 ms_hspp_buf = Just buf,
1515 ms_srcimps = srcimps,
1517 ms_hs_date = src_timestamp,
1518 ms_obj_date = obj_timestamp }))
1521 getObjTimestamp location is_boot
1522 = if is_boot then return Nothing
1523 else modificationTimeIfExists (ml_obj_file location)
1526 preprocessFile :: DynFlags -> FilePath -> Maybe Phase -> Maybe (StringBuffer,ClockTime)
1527 -> IO (DynFlags, FilePath, StringBuffer)
1528 preprocessFile dflags src_fn mb_phase Nothing
1530 (dflags', hspp_fn) <- preprocess dflags (src_fn, mb_phase)
1531 buf <- hGetStringBuffer hspp_fn
1532 return (dflags', hspp_fn, buf)
1534 preprocessFile dflags src_fn mb_phase (Just (buf, time))
1536 -- case we bypass the preprocessing stage?
1538 local_opts = getOptionsFromStringBuffer buf
1540 (dflags', errs) <- parseDynamicFlags dflags (map snd local_opts)
1544 | Just (Unlit _) <- mb_phase = True
1545 | Nothing <- mb_phase, Unlit _ <- startPhase src_fn = True
1546 -- note: local_opts is only required if there's no Unlit phase
1547 | dopt Opt_Cpp dflags' = True
1548 | dopt Opt_Pp dflags' = True
1551 when needs_preprocessing $
1552 ghcError (ProgramError "buffer needs preprocesing; interactive check disabled")
1554 return (dflags', src_fn, buf)
1557 -----------------------------------------------------------------------------
1559 -----------------------------------------------------------------------------
1561 noModError :: DynFlags -> SrcSpan -> Module -> FindResult -> IO ab
1562 -- ToDo: we don't have a proper line number for this error
1563 noModError dflags loc wanted_mod err
1564 = throwDyn $ mkPlainErrMsg loc $ cantFindError dflags wanted_mod err
1566 noHsFileErr loc path
1567 = throwDyn $ mkPlainErrMsg loc $ text "Can't find" <+> text path
1570 = throwDyn $ mkPlainErrMsg noSrcSpan $
1571 text "module" <+> quotes (ppr mod) <+> text "is a package module"
1573 multiRootsErr mod files
1574 = throwDyn $ mkPlainErrMsg noSrcSpan $
1575 text "module" <+> quotes (ppr mod) <+>
1576 text "is defined in multiple files:" <+>
1577 sep (map text files)
1579 cyclicModuleErr :: [ModSummary] -> SDoc
1581 = hang (ptext SLIT("Module imports form a cycle for modules:"))
1582 2 (vcat (map show_one ms))
1584 show_one ms = sep [ show_mod (ms_hsc_src ms) (ms_mod ms),
1585 nest 2 $ ptext SLIT("imports:") <+>
1586 (pp_imps HsBootFile (ms_srcimps ms)
1587 $$ pp_imps HsSrcFile (ms_imps ms))]
1588 show_mod hsc_src mod = ppr mod <> text (hscSourceString hsc_src)
1589 pp_imps src mods = fsep (map (show_mod src) mods)
1592 -- | Inform GHC that the working directory has changed. GHC will flush
1593 -- its cache of module locations, since it may no longer be valid.
1594 -- Note: if you change the working directory, you should also unload
1595 -- the current program (set targets to empty, followed by load).
1596 workingDirectoryChanged :: Session -> IO ()
1597 workingDirectoryChanged s = withSession s $ \hsc_env ->
1598 flushFinderCache (hsc_FC hsc_env)
1600 -- -----------------------------------------------------------------------------
1601 -- inspecting the session
1603 -- | Get the module dependency graph.
1604 getModuleGraph :: Session -> IO ModuleGraph -- ToDo: DiGraph ModSummary
1605 getModuleGraph s = withSession s (return . hsc_mod_graph)
1607 isLoaded :: Session -> Module -> IO Bool
1608 isLoaded s m = withSession s $ \hsc_env ->
1609 return $! isJust (lookupModuleEnv (hsc_HPT hsc_env) m)
1611 getBindings :: Session -> IO [TyThing]
1612 getBindings s = withSession s (return . nameEnvElts . ic_type_env . hsc_IC)
1614 getPrintUnqual :: Session -> IO PrintUnqualified
1615 getPrintUnqual s = withSession s (return . icPrintUnqual . hsc_IC)
1617 -- | Container for information about a 'Module'.
1618 data ModuleInfo = ModuleInfo {
1619 minf_type_env :: TypeEnv,
1620 minf_exports :: NameSet,
1621 minf_rdr_env :: Maybe GlobalRdrEnv, -- Nothing for a compiled/package mod
1622 minf_instances :: [Instance]
1623 -- ToDo: this should really contain the ModIface too
1625 -- We don't want HomeModInfo here, because a ModuleInfo applies
1626 -- to package modules too.
1628 -- | Request information about a loaded 'Module'
1629 getModuleInfo :: Session -> Module -> IO (Maybe ModuleInfo)
1630 getModuleInfo s mdl = withSession s $ \hsc_env -> do
1631 let mg = hsc_mod_graph hsc_env
1632 if mdl `elem` map ms_mod mg
1633 then getHomeModuleInfo hsc_env mdl
1635 {- if isHomeModule (hsc_dflags hsc_env) mdl
1637 else -} getPackageModuleInfo hsc_env mdl
1638 -- getPackageModuleInfo will attempt to find the interface, so
1639 -- we don't want to call it for a home module, just in case there
1640 -- was a problem loading the module and the interface doesn't
1641 -- exist... hence the isHomeModule test here. (ToDo: reinstate)
1643 getPackageModuleInfo :: HscEnv -> Module -> IO (Maybe ModuleInfo)
1644 getPackageModuleInfo hsc_env mdl = do
1646 (_msgs, mb_names) <- getModuleExports hsc_env mdl
1648 Nothing -> return Nothing
1650 eps <- readIORef (hsc_EPS hsc_env)
1653 n_list = nameSetToList names
1654 tys = [ ty | name <- n_list,
1655 Just ty <- [lookupTypeEnv pte name] ]
1657 return (Just (ModuleInfo {
1658 minf_type_env = mkTypeEnv tys,
1659 minf_exports = names,
1660 minf_rdr_env = Just $! nameSetToGlobalRdrEnv names mdl,
1661 minf_instances = error "getModuleInfo: instances for package module unimplemented"
1664 -- bogusly different for non-GHCI (ToDo)
1668 getHomeModuleInfo hsc_env mdl =
1669 case lookupModuleEnv (hsc_HPT hsc_env) mdl of
1670 Nothing -> return Nothing
1672 let details = hm_details hmi
1673 return (Just (ModuleInfo {
1674 minf_type_env = md_types details,
1675 minf_exports = md_exports details,
1676 minf_rdr_env = mi_globals $! hm_iface hmi,
1677 minf_instances = md_insts details
1680 -- | The list of top-level entities defined in a module
1681 modInfoTyThings :: ModuleInfo -> [TyThing]
1682 modInfoTyThings minf = typeEnvElts (minf_type_env minf)
1684 modInfoTopLevelScope :: ModuleInfo -> Maybe [Name]
1685 modInfoTopLevelScope minf
1686 = fmap (map gre_name . globalRdrEnvElts) (minf_rdr_env minf)
1688 modInfoExports :: ModuleInfo -> [Name]
1689 modInfoExports minf = nameSetToList $! minf_exports minf
1691 -- | Returns the instances defined by the specified module.
1692 -- Warning: currently unimplemented for package modules.
1693 modInfoInstances :: ModuleInfo -> [Instance]
1694 modInfoInstances = minf_instances
1696 modInfoIsExportedName :: ModuleInfo -> Name -> Bool
1697 modInfoIsExportedName minf name = elemNameSet name (minf_exports minf)
1699 modInfoPrintUnqualified :: ModuleInfo -> Maybe PrintUnqualified
1700 modInfoPrintUnqualified minf = fmap unQualInScope (minf_rdr_env minf)
1702 modInfoLookupName :: Session -> ModuleInfo -> Name -> IO (Maybe TyThing)
1703 modInfoLookupName s minf name = withSession s $ \hsc_env -> do
1704 case lookupTypeEnv (minf_type_env minf) name of
1705 Just tyThing -> return (Just tyThing)
1707 eps <- readIORef (hsc_EPS hsc_env)
1708 return $! lookupType (hsc_HPT hsc_env) (eps_PTE eps) name
1710 isDictonaryId :: Id -> Bool
1712 = case tcSplitSigmaTy (idType id) of { (tvs, theta, tau) -> isDictTy tau }
1714 -- | Looks up a global name: that is, any top-level name in any
1715 -- visible module. Unlike 'lookupName', lookupGlobalName does not use
1716 -- the interactive context, and therefore does not require a preceding
1718 lookupGlobalName :: Session -> Name -> IO (Maybe TyThing)
1719 lookupGlobalName s name = withSession s $ \hsc_env -> do
1720 eps <- readIORef (hsc_EPS hsc_env)
1721 return $! lookupType (hsc_HPT hsc_env) (eps_PTE eps) name
1723 -- -----------------------------------------------------------------------------
1724 -- Misc exported utils
1726 dataConType :: DataCon -> Type
1727 dataConType dc = idType (dataConWrapId dc)
1729 -- | print a 'NamedThing', adding parentheses if the name is an operator.
1730 pprParenSymName :: NamedThing a => a -> SDoc
1731 pprParenSymName a = parenSymOcc (getOccName a) (ppr (getName a))
1733 -- ----------------------------------------------------------------------------
1738 -- - Data and Typeable instances for HsSyn.
1740 -- ToDo: check for small transformations that happen to the syntax in
1741 -- the typechecker (eg. -e ==> negate e, perhaps for fromIntegral)
1743 -- ToDo: maybe use TH syntax instead of IfaceSyn? There's already a way
1744 -- to get from TyCons, Ids etc. to TH syntax (reify).
1746 -- :browse will use either lm_toplev or inspect lm_interface, depending
1747 -- on whether the module is interpreted or not.
1749 -- This is for reconstructing refactored source code
1750 -- Calls the lexer repeatedly.
1751 -- ToDo: add comment tokens to token stream
1752 getTokenStream :: Session -> Module -> IO [Located Token]
1755 -- -----------------------------------------------------------------------------
1756 -- Interactive evaluation
1760 -- | Set the interactive evaluation context.
1762 -- Setting the context doesn't throw away any bindings; the bindings
1763 -- we've built up in the InteractiveContext simply move to the new
1764 -- module. They always shadow anything in scope in the current context.
1765 setContext :: Session
1766 -> [Module] -- entire top level scope of these modules
1767 -> [Module] -- exports only of these modules
1769 setContext (Session ref) toplevs exports = do
1770 hsc_env <- readIORef ref
1771 let old_ic = hsc_IC hsc_env
1772 hpt = hsc_HPT hsc_env
1774 mapM_ (checkModuleExists hsc_env hpt) exports
1775 export_env <- mkExportEnv hsc_env exports
1776 toplev_envs <- mapM (mkTopLevEnv hpt) toplevs
1777 let all_env = foldr plusGlobalRdrEnv export_env toplev_envs
1778 writeIORef ref hsc_env{ hsc_IC = old_ic { ic_toplev_scope = toplevs,
1779 ic_exports = exports,
1780 ic_rn_gbl_env = all_env }}
1783 -- Make a GlobalRdrEnv based on the exports of the modules only.
1784 mkExportEnv :: HscEnv -> [Module] -> IO GlobalRdrEnv
1785 mkExportEnv hsc_env mods = do
1786 stuff <- mapM (getModuleExports hsc_env) mods
1788 (_msgs, mb_name_sets) = unzip stuff
1789 gres = [ nameSetToGlobalRdrEnv name_set mod
1790 | (Just name_set, mod) <- zip mb_name_sets mods ]
1792 return $! foldr plusGlobalRdrEnv emptyGlobalRdrEnv gres
1794 nameSetToGlobalRdrEnv :: NameSet -> Module -> GlobalRdrEnv
1795 nameSetToGlobalRdrEnv names mod =
1796 mkGlobalRdrEnv [ GRE { gre_name = name, gre_prov = vanillaProv mod }
1797 | name <- nameSetToList names ]
1799 vanillaProv :: Module -> Provenance
1800 -- We're building a GlobalRdrEnv as if the user imported
1801 -- all the specified modules into the global interactive module
1802 vanillaProv mod = Imported [ImpSpec { is_decl = decl, is_item = ImpAll}]
1804 decl = ImpDeclSpec { is_mod = mod, is_as = mod,
1806 is_dloc = srcLocSpan interactiveSrcLoc }
1808 checkModuleExists :: HscEnv -> HomePackageTable -> Module -> IO ()
1809 checkModuleExists hsc_env hpt mod =
1810 case lookupModuleEnv hpt mod of
1811 Just mod_info -> return ()
1812 _not_a_home_module -> do
1813 res <- findPackageModule hsc_env mod True
1815 Found _ _ -> return ()
1816 err -> let msg = cantFindError (hsc_dflags hsc_env) mod err in
1817 throwDyn (CmdLineError (showSDoc msg))
1819 mkTopLevEnv :: HomePackageTable -> Module -> IO GlobalRdrEnv
1820 mkTopLevEnv hpt modl
1821 = case lookupModuleEnv hpt modl of
1823 throwDyn (ProgramError ("mkTopLevEnv: not a home module "
1824 ++ showSDoc (pprModule modl)))
1826 case mi_globals (hm_iface details) of
1828 throwDyn (ProgramError ("mkTopLevEnv: not interpreted "
1829 ++ showSDoc (pprModule modl)))
1830 Just env -> return env
1832 -- | Get the interactive evaluation context, consisting of a pair of the
1833 -- set of modules from which we take the full top-level scope, and the set
1834 -- of modules from which we take just the exports respectively.
1835 getContext :: Session -> IO ([Module],[Module])
1836 getContext s = withSession s (\HscEnv{ hsc_IC=ic } ->
1837 return (ic_toplev_scope ic, ic_exports ic))
1839 -- | Returns 'True' if the specified module is interpreted, and hence has
1840 -- its full top-level scope available.
1841 moduleIsInterpreted :: Session -> Module -> IO Bool
1842 moduleIsInterpreted s modl = withSession s $ \h ->
1843 case lookupModuleEnv (hsc_HPT h) modl of
1844 Just details -> return (isJust (mi_globals (hm_iface details)))
1845 _not_a_home_module -> return False
1847 -- | Looks up an identifier in the current interactive context (for :info)
1848 getInfo :: Session -> Name -> IO (Maybe (TyThing,Fixity,[Instance]))
1849 getInfo s name = withSession s $ \hsc_env -> tcRnGetInfo hsc_env name
1851 -- | Returns all names in scope in the current interactive context
1852 getNamesInScope :: Session -> IO [Name]
1853 getNamesInScope s = withSession s $ \hsc_env -> do
1854 return (map gre_name (globalRdrEnvElts (ic_rn_gbl_env (hsc_IC hsc_env))))
1856 -- | Parses a string as an identifier, and returns the list of 'Name's that
1857 -- the identifier can refer to in the current interactive context.
1858 parseName :: Session -> String -> IO [Name]
1859 parseName s str = withSession s $ \hsc_env -> do
1860 maybe_rdr_name <- hscParseIdentifier (hsc_dflags hsc_env) str
1861 case maybe_rdr_name of
1862 Nothing -> return []
1863 Just (L _ rdr_name) -> do
1864 mb_names <- tcRnLookupRdrName hsc_env rdr_name
1866 Nothing -> return []
1867 Just ns -> return ns
1868 -- ToDo: should return error messages
1870 -- | Returns the 'TyThing' for a 'Name'. The 'Name' may refer to any
1871 -- entity known to GHC, including 'Name's defined using 'runStmt'.
1872 lookupName :: Session -> Name -> IO (Maybe TyThing)
1873 lookupName s name = withSession s $ \hsc_env -> tcRnLookupName hsc_env name
1875 -- -----------------------------------------------------------------------------
1876 -- Getting the type of an expression
1878 -- | Get the type of an expression
1879 exprType :: Session -> String -> IO (Maybe Type)
1880 exprType s expr = withSession s $ \hsc_env -> do
1881 maybe_stuff <- hscTcExpr hsc_env expr
1883 Nothing -> return Nothing
1884 Just ty -> return (Just tidy_ty)
1886 tidy_ty = tidyType emptyTidyEnv ty
1888 -- -----------------------------------------------------------------------------
1889 -- Getting the kind of a type
1891 -- | Get the kind of a type
1892 typeKind :: Session -> String -> IO (Maybe Kind)
1893 typeKind s str = withSession s $ \hsc_env -> do
1894 maybe_stuff <- hscKcType hsc_env str
1896 Nothing -> return Nothing
1897 Just kind -> return (Just kind)
1899 -----------------------------------------------------------------------------
1900 -- cmCompileExpr: compile an expression and deliver an HValue
1902 compileExpr :: Session -> String -> IO (Maybe HValue)
1903 compileExpr s expr = withSession s $ \hsc_env -> do
1904 maybe_stuff <- hscStmt hsc_env ("let __cmCompileExpr = "++expr)
1906 Nothing -> return Nothing
1907 Just (new_ic, names, hval) -> do
1909 hvals <- (unsafeCoerce# hval) :: IO [HValue]
1911 case (names,hvals) of
1912 ([n],[hv]) -> return (Just hv)
1913 _ -> panic "compileExpr"
1915 -- -----------------------------------------------------------------------------
1916 -- running a statement interactively
1919 = RunOk [Name] -- ^ names bound by this evaluation
1920 | RunFailed -- ^ statement failed compilation
1921 | RunException Exception -- ^ statement raised an exception
1923 -- | Run a statement in the current interactive context. Statemenet
1924 -- may bind multple values.
1925 runStmt :: Session -> String -> IO RunResult
1926 runStmt (Session ref) expr
1928 hsc_env <- readIORef ref
1930 -- Turn off -fwarn-unused-bindings when running a statement, to hide
1931 -- warnings about the implicit bindings we introduce.
1932 let dflags' = dopt_unset (hsc_dflags hsc_env) Opt_WarnUnusedBinds
1933 hsc_env' = hsc_env{ hsc_dflags = dflags' }
1935 maybe_stuff <- hscStmt hsc_env' expr
1938 Nothing -> return RunFailed
1939 Just (new_hsc_env, names, hval) -> do
1941 let thing_to_run = unsafeCoerce# hval :: IO [HValue]
1942 either_hvals <- sandboxIO thing_to_run
1944 case either_hvals of
1946 -- on error, keep the *old* interactive context,
1947 -- so that 'it' is not bound to something
1948 -- that doesn't exist.
1949 return (RunException e)
1952 -- Get the newly bound things, and bind them.
1953 -- Don't need to delete any shadowed bindings;
1954 -- the new ones override the old ones.
1955 extendLinkEnv (zip names hvals)
1957 writeIORef ref new_hsc_env
1958 return (RunOk names)
1961 -- We run the statement in a "sandbox" to protect the rest of the
1962 -- system from anything the expression might do. For now, this
1963 -- consists of just wrapping it in an exception handler, but see below
1964 -- for another version.
1966 sandboxIO :: IO a -> IO (Either Exception a)
1967 sandboxIO thing = Exception.try thing
1970 -- This version of sandboxIO runs the expression in a completely new
1971 -- RTS main thread. It is disabled for now because ^C exceptions
1972 -- won't be delivered to the new thread, instead they'll be delivered
1973 -- to the (blocked) GHCi main thread.
1975 -- SLPJ: when re-enabling this, reflect a wrong-stat error as an exception
1977 sandboxIO :: IO a -> IO (Either Int (Either Exception a))
1978 sandboxIO thing = do
1979 st_thing <- newStablePtr (Exception.try thing)
1980 alloca $ \ p_st_result -> do
1981 stat <- rts_evalStableIO st_thing p_st_result
1982 freeStablePtr st_thing
1984 then do st_result <- peek p_st_result
1985 result <- deRefStablePtr st_result
1986 freeStablePtr st_result
1987 return (Right result)
1989 return (Left (fromIntegral stat))
1991 foreign import "rts_evalStableIO" {- safe -}
1992 rts_evalStableIO :: StablePtr (IO a) -> Ptr (StablePtr a) -> IO CInt
1993 -- more informative than the C type!
1996 -----------------------------------------------------------------------------
1997 -- show a module and it's source/object filenames
1999 showModule :: Session -> ModSummary -> IO String
2000 showModule s mod_summary = withSession s $ \hsc_env -> do
2001 case lookupModuleEnv (hsc_HPT hsc_env) (ms_mod mod_summary) of
2002 Nothing -> panic "missing linkable"
2003 Just mod_info -> return (showModMsg obj_linkable mod_summary)
2005 obj_linkable = isObjectLinkable (fromJust (hm_linkable mod_info))