X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FcompMan%2FCompManager.lhs;h=ce6302afb07b780fbd30d90d37badfbd59aec558;hb=423d477bfecd490de1449c59325c8776f91d7aac;hp=327f716dc33e5e2e98746c4b22873adab2532c1e;hpb=094b0ead13edc9aebfc55ef864036f55bbddd63a;p=ghc-hetmet.git diff --git a/ghc/compiler/compMan/CompManager.lhs b/ghc/compiler/compMan/CompManager.lhs index 327f716..ce6302a 100644 --- a/ghc/compiler/compMan/CompManager.lhs +++ b/ghc/compiler/compMan/CompManager.lhs @@ -1,481 +1,1027 @@ % -% (c) The University of Glasgow, 2000 +% (c) The University of Glasgow, 2002 +% +% The Compilation Manager % -\section[CompManager]{The Compilation Manager} - \begin{code} -module CompManager ( cmInit, cmLoadModule, - cmGetExpr, cmRunExpr, - CmState, emptyCmState -- abstract - ) -where +module CompManager ( + ModuleGraph, ModSummary(..), -#include "HsVersions.h" + CmState, -- abstract -import List ( nub ) -import Maybe ( catMaybes, maybeToList, fromMaybe ) -import Outputable -import UniqFM ( emptyUFM, lookupUFM, addToUFM, delListFromUFM ) -import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs ) -import Panic ( panic ) - -import CmLink ( PersistentLinkerState, emptyPLS, Linkable(..), - link, LinkResult(..), - filterModuleLinkables, modname_of_linkable, - is_package_linkable ) -import Interpreter ( HValue ) -import CmSummarise ( summarise, ModSummary(..), - name_of_summary, deps_of_summary, - mimp_name, ms_get_imports ) -import Module ( ModuleName, moduleName, packageOfModule, - isModuleInThisPackage, PackageName ) -import CmStaticInfo ( Package(..), PackageConfigInfo ) -import DriverPipeline ( compile, CompResult(..) ) -import HscTypes ( HomeSymbolTable, HomeIfaceTable, - PersistentCompilerState ) -import HscMain ( initPersistentCompilerState ) -import Finder ( findModule, emptyHomeDirCache ) -\end{code} + cmInit, -- :: GhciMode -> DynFlags -> IO CmState + cmDepAnal, -- :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph + cmLoadModules, -- :: CmState -> DynFlags -> ModuleGraph + -- -> IO (CmState, Bool, [String]) -\begin{code} -cmInit :: PackageConfigInfo -> IO CmState -cmInit raw_package_info - = emptyCmState raw_package_info - -cmGetExpr :: CmState - -> ModuleName - -> String - -> IO (CmState, Either [SDoc] HValue) -cmGetExpr cmstate modhdl expr - = return (panic "cmGetExpr:unimp") - -cmRunExpr :: HValue -> IO () -cmRunExpr hval - = return (panic "cmRunExpr:unimp") - - --- Persistent state just for CM, excluding link & compile subsystems -data PersistentCMState - = PersistentCMState { - hst :: HomeSymbolTable, -- home symbol table - hit :: HomeIfaceTable, -- home interface table - ui :: UnlinkedImage, -- the unlinked images - mg :: ModuleGraph, -- the module graph - pci :: PackageConfigInfo -- NEVER CHANGES - } + cmUnload, -- :: CmState -> DynFlags -> IO CmState -emptyPCMS :: PackageConfigInfo -> PersistentCMState -emptyPCMS pci - = PersistentCMState { hst = emptyHST, hit = emptyHIT, - ui = emptyUI, mg = emptyMG, pci = pci } +#ifdef GHCI + cmModuleIsInterpreted, -- :: CmState -> String -> IO Bool -emptyHIT :: HomeIfaceTable -emptyHIT = emptyUFM -emptyHST :: HomeSymbolTable -emptyHST = emptyUFM + cmSetContext, -- :: CmState -> DynFlags -> [String] -> [String] -> IO CmState + cmGetContext, -- :: CmState -> IO ([String],[String]) + cmInfoThing, -- :: CmState -> String -> IO (CmState, [(TyThing,Fixity)]) + cmBrowseModule, -- :: CmState -> IO [TyThing] + CmRunResult(..), + cmRunStmt, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, CmRunResult) --- Persistent state for the entire system -data CmState - = CmState { - pcms :: PersistentCMState, -- CM's persistent state - pcs :: PersistentCompilerState, -- compile's persistent state - pls :: PersistentLinkerState -- link's persistent state - } + cmTypeOfExpr, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe String) -emptyCmState :: PackageConfigInfo -> IO CmState -emptyCmState pci - = do let pcms = emptyPCMS pci - pcs <- initPersistentCompilerState - pls <- emptyPLS - return (CmState { pcms = pcms, - pcs = pcs, - pls = pls }) + cmKindOfType, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe String) --- CM internal types -type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really) -emptyUI :: UnlinkedImage -emptyUI = [] + cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) -type ModuleGraph = [SCC ModSummary] -- the module graph, topologically sorted -emptyMG :: ModuleGraph -emptyMG = [] + HValue, + cmCompileExpr, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe HValue) + + cmGetModInfo, -- :: CmState -> (ModuleGraph, HomePackageTable) + + cmSetDFlags, + cmGetBindings, -- :: CmState -> [TyThing] + cmGetPrintUnqual, -- :: CmState -> PrintUnqualified +#endif + ) +where + +#include "HsVersions.h" +import DriverPipeline ( CompResult(..), preprocess, compile, link ) +import HscMain ( newHscEnv ) +import DriverState ( v_Output_file, v_NoHsMain, v_MainModIs ) +import DriverPhases +import Finder +import HscTypes +import PrelNames ( gHC_PRIM_Name ) +import Module ( Module, ModuleName, moduleName, mkModuleName, isHomeModule, + ModuleEnv, lookupModuleEnvByName, mkModuleEnv, moduleEnvElts, + extendModuleEnvList, extendModuleEnv, + moduleNameUserString, + ModLocation(..) ) +import GetImports +import UniqFM +import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs ) +import ErrUtils ( showPass ) +import SysTools ( cleanTempFilesExcept ) +import BasicTypes ( SuccessFlag(..), succeeded, failed ) +import Util +import Outputable +import Panic +import CmdLineOpts ( DynFlags(..), getDynFlags ) +import Maybes ( expectJust, orElse, mapCatMaybes ) + +import DATA_IOREF ( readIORef ) + +#ifdef GHCI +import HscMain ( hscThing, hscStmt, hscTcExpr, hscKcType ) +import TcRnDriver ( mkExportEnv, getModuleContents ) +import IfaceSyn ( IfaceDecl ) +import RdrName ( GlobalRdrEnv, plusGlobalRdrEnv ) +import Name ( Name ) +import NameEnv +import Id ( idType ) +import Type ( tidyType ) +import VarEnv ( emptyTidyEnv ) +import BasicTypes ( Fixity ) +import Linker ( HValue, unload, extendLinkEnv ) +import GHC.Exts ( unsafeCoerce# ) +import Foreign +import SrcLoc ( SrcLoc ) +import Control.Exception as Exception ( Exception, try ) +#endif + +import EXCEPTION ( throwDyn ) + +-- std +import Directory ( getModificationTime, doesFileExist ) +import IO +import Monad +import List ( nub ) +import Maybe +import Time ( ClockTime ) \end{code} -The real business of the compilation manager: given a system state and -a module name, try and bring the module up to date, probably changing -the system state at the same time. \begin{code} -cmLoadModule :: CmState - -> ModuleName - -> IO (CmState, Maybe ModuleName) +-- Persistent state for the entire system +data CmState + = CmState { + cm_hsc :: HscEnv, -- Includes the home-package table + cm_mg :: ModuleGraph, -- The module graph + cm_ic :: InteractiveContext -- Command-line binding info + } -cmLoadModule cmstate1 modname - = do -- version 1's are the original, before downsweep - let pcms1 = pcms cmstate1 - let pls1 = pls cmstate1 - let pcs1 = pcs cmstate1 - let mg1 = mg pcms1 - let hst1 = hst pcms1 - let hit1 = hit pcms1 - let ui1 = ui pcms1 - - let pcii = pci pcms1 -- this never changes +#ifdef GHCI +cmGetModInfo cmstate = (cm_mg cmstate, hsc_HPT (cm_hsc cmstate)) +cmGetBindings cmstate = nameEnvElts (ic_type_env (cm_ic cmstate)) +cmGetPrintUnqual cmstate = icPrintUnqual (cm_ic cmstate) +cmHPT cmstate = hsc_HPT (cm_hsc cmstate) +#endif + +cmInit :: GhciMode -> DynFlags -> IO CmState +cmInit ghci_mode dflags + = do { hsc_env <- newHscEnv ghci_mode dflags + ; return (CmState { cm_hsc = hsc_env, + cm_mg = emptyMG, + cm_ic = emptyInteractiveContext })} + +discardCMInfo :: CmState -> CmState +-- Forget the compilation manager's state, including the home package table +-- but retain the persistent info in HscEnv +discardCMInfo cm_state + = cm_state { cm_mg = emptyMG, cm_ic = emptyInteractiveContext, + cm_hsc = (cm_hsc cm_state) { hsc_HPT = emptyHomePackageTable } } + +------------------------------------------------------------------- +-- The unlinked image +-- +-- The compilation manager keeps a list of compiled, but as-yet unlinked +-- binaries (byte code or object code). Even when it links bytecode +-- it keeps the unlinked version so it can re-link it later without +-- recompiling. + +type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really) - -- do the downsweep to reestablish the module graph - -- then generate version 2's by removing from HIT,HST,UI any - -- modules in the old MG which are not in the new one. +findModuleLinkable_maybe :: [Linkable] -> ModuleName -> Maybe Linkable +findModuleLinkable_maybe lis mod + = case [LM time nm us | LM time nm us <- lis, nm == mod] of + [] -> Nothing + [li] -> Just li + many -> pprPanic "findModuleLinkable" (ppr mod) +\end{code} - -- Throw away the old home dir cache - emptyHomeDirCache - putStr "cmLoadModule: downsweep begins\n" - mg2unsorted <- downsweep modname - putStrLn (showSDoc (vcat (map ppr mg2unsorted))) +%************************************************************************ +%* * + GHCI stuff +%* * +%************************************************************************ - let modnames1 = map name_of_summary (flattenSCCs mg1) - let modnames2 = map name_of_summary mg2unsorted - let mods_to_zap = filter (`notElem` modnames2) modnames1 +\begin{code} +#ifdef GHCI +----------------------------------------------------------------------------- +-- Setting the context doesn't throw away any bindings; the bindings +-- we've built up in the InteractiveContext simply move to the new +-- module. They always shadow anything in scope in the current context. + +cmSetContext + :: CmState + -> [String] -- take the top-level scopes of these modules + -> [String] -- and the just the exports from these + -> IO CmState +cmSetContext cmstate toplevs exports = do + let old_ic = cm_ic cmstate + hsc_env = cm_hsc cmstate + hpt = hsc_HPT hsc_env + + export_env <- mkExportEnv hsc_env (map mkModuleName exports) + toplev_envs <- mapM (mkTopLevEnv hpt) toplevs + + let all_env = foldr plusGlobalRdrEnv export_env toplev_envs + return cmstate{ cm_ic = old_ic { ic_toplev_scope = toplevs, + ic_exports = exports, + ic_rn_gbl_env = all_env } } + +mkTopLevEnv :: HomePackageTable -> String -> IO GlobalRdrEnv +mkTopLevEnv hpt mod + = case lookupModuleEnvByName hpt (mkModuleName mod) of + Nothing -> throwDyn (ProgramError ("mkTopLevEnv: not a home module " ++ mod)) + Just details -> case hm_globals details of + Nothing -> throwDyn (ProgramError ("mkTopLevEnv: not interpreted " ++ mod)) + Just env -> return env + +cmGetContext :: CmState -> IO ([String],[String]) +cmGetContext CmState{cm_ic=ic} = + return (ic_toplev_scope ic, ic_exports ic) + +cmModuleIsInterpreted :: CmState -> String -> IO Bool +cmModuleIsInterpreted cmstate str + = case lookupModuleEnvByName (cmHPT cmstate) (mkModuleName str) of + Just details -> return (isJust (hm_globals details)) + _not_a_home_module -> return False + +----------------------------------------------------------------------------- +cmSetDFlags :: CmState -> DynFlags -> CmState +cmSetDFlags cm_state dflags + = cm_state { cm_hsc = (cm_hsc cm_state) { hsc_dflags = dflags } } + +----------------------------------------------------------------------------- +-- cmInfoThing: convert a String to a TyThing + +-- A string may refer to more than one TyThing (eg. a constructor, +-- and type constructor), so we return a list of all the possible TyThings. + +cmInfoThing :: CmState -> String -> IO [(IfaceDecl,Fixity,SrcLoc)] +cmInfoThing cmstate id + = hscThing (cm_hsc cmstate) (cm_ic cmstate) id + +-- --------------------------------------------------------------------------- +-- cmBrowseModule: get all the TyThings defined in a module + +cmBrowseModule :: CmState -> String -> Bool -> IO [IfaceDecl] +cmBrowseModule cmstate str exports_only + = do { mb_decls <- getModuleContents (cm_hsc cmstate) (cm_ic cmstate) + (mkModuleName str) exports_only + ; case mb_decls of + Nothing -> return [] -- An error of some kind + Just ds -> return ds + } + + +----------------------------------------------------------------------------- +-- cmRunStmt: Run a statement/expr. + +data CmRunResult + = CmRunOk [Name] -- names bound by this evaluation + | CmRunFailed + | CmRunException Exception -- statement raised an exception + +cmRunStmt :: CmState -> String -> IO (CmState, CmRunResult) +cmRunStmt cmstate@CmState{ cm_hsc=hsc_env, cm_ic=icontext } expr + = do + maybe_stuff <- hscStmt hsc_env icontext expr + + case maybe_stuff of + Nothing -> return (cmstate, CmRunFailed) + Just (new_ic, names, hval) -> do + + let thing_to_run = unsafeCoerce# hval :: IO [HValue] + either_hvals <- sandboxIO thing_to_run + + case either_hvals of + Left e -> do + -- on error, keep the *old* interactive context, + -- so that 'it' is not bound to something + -- that doesn't exist. + return ( cmstate, CmRunException e ) + + Right hvals -> do + -- Get the newly bound things, and bind them. + -- Don't need to delete any shadowed bindings; + -- the new ones override the old ones. + extendLinkEnv (zip names hvals) + + return (cmstate{ cm_ic=new_ic }, + CmRunOk names) + + +-- We run the statement in a "sandbox" to protect the rest of the +-- system from anything the expression might do. For now, this +-- consists of just wrapping it in an exception handler, but see below +-- for another version. + +sandboxIO :: IO a -> IO (Either Exception a) +sandboxIO thing = Exception.try thing + +{- +-- This version of sandboxIO runs the expression in a completely new +-- RTS main thread. It is disabled for now because ^C exceptions +-- won't be delivered to the new thread, instead they'll be delivered +-- to the (blocked) GHCi main thread. + +-- SLPJ: when re-enabling this, reflect a wrong-stat error as an exception + +sandboxIO :: IO a -> IO (Either Int (Either Exception a)) +sandboxIO thing = do + st_thing <- newStablePtr (Exception.try thing) + alloca $ \ p_st_result -> do + stat <- rts_evalStableIO st_thing p_st_result + freeStablePtr st_thing + if stat == 1 + then do st_result <- peek p_st_result + result <- deRefStablePtr st_result + freeStablePtr st_result + return (Right result) + else do + return (Left (fromIntegral stat)) + +foreign import "rts_evalStableIO" {- safe -} + rts_evalStableIO :: StablePtr (IO a) -> Ptr (StablePtr a) -> IO CInt + -- more informative than the C type! +-} + +----------------------------------------------------------------------------- +-- cmTypeOfExpr: returns a string representing the type of an expression + +cmTypeOfExpr :: CmState -> String -> IO (Maybe String) +cmTypeOfExpr cmstate expr + = do maybe_stuff <- hscTcExpr (cm_hsc cmstate) (cm_ic cmstate) expr + + case maybe_stuff of + Nothing -> return Nothing + Just ty -> return (Just res_str) + where + res_str = showSDocForUser unqual (text expr <+> dcolon <+> ppr tidy_ty) + unqual = icPrintUnqual (cm_ic cmstate) + tidy_ty = tidyType emptyTidyEnv ty + + +----------------------------------------------------------------------------- +-- cmKindOfType: returns a string representing the kind of a type + +cmKindOfType :: CmState -> String -> IO (Maybe String) +cmKindOfType cmstate str + = do maybe_stuff <- hscKcType (cm_hsc cmstate) (cm_ic cmstate) str + case maybe_stuff of + Nothing -> return Nothing + Just kind -> return (Just res_str) + where + res_str = showSDocForUser unqual (text str <+> dcolon <+> ppr kind) + unqual = icPrintUnqual (cm_ic cmstate) + +----------------------------------------------------------------------------- +-- cmTypeOfName: returns a string representing the type of a name. + +cmTypeOfName :: CmState -> Name -> IO (Maybe String) +cmTypeOfName CmState{ cm_ic=ic } name + = do + hPutStrLn stderr ("cmTypeOfName: " ++ showSDoc (ppr name)) + case lookupNameEnv (ic_type_env ic) name of + Nothing -> return Nothing + Just (AnId id) -> return (Just str) + where + unqual = icPrintUnqual ic + ty = tidyType emptyTidyEnv (idType id) + str = showSDocForUser unqual (ppr ty) + + _ -> panic "cmTypeOfName" + +----------------------------------------------------------------------------- +-- cmCompileExpr: compile an expression and deliver an HValue + +cmCompileExpr :: CmState -> String -> IO (Maybe HValue) +cmCompileExpr cmstate expr + = do + maybe_stuff + <- hscStmt (cm_hsc cmstate) (cm_ic cmstate) + ("let __cmCompileExpr = "++expr) + + case maybe_stuff of + Nothing -> return Nothing + Just (new_ic, names, hval) -> do + + -- Run it! + hvals <- (unsafeCoerce# hval) :: IO [HValue] + + case (names,hvals) of + ([n],[hv]) -> return (Just hv) + _ -> panic "cmCompileExpr" + +#endif /* GHCI */ +\end{code} - let (hst2, hit2, ui2) - = removeFromTopLevelEnvs mods_to_zap (hst1, hit1, ui1) - let mg2 = topological_sort mg2unsorted +%************************************************************************ +%* * + Loading and unloading +%* * +%************************************************************************ - putStrLn "after tsort:\n" - putStrLn (showSDoc (vcat (map ppr (flattenSCCs mg2)))) +\begin{code} +----------------------------------------------------------------------------- +-- Unload the compilation manager's state: everything it knows about the +-- current collection of modules in the Home package. + +cmUnload :: CmState -> IO CmState +cmUnload state@CmState{ cm_hsc = hsc_env } + = do -- Throw away the old home dir cache + flushFinderCache + + -- Unload everything the linker knows about + cm_unload hsc_env [] + + -- Start with a fresh CmState, but keep the PersistentCompilerState + return (discardCMInfo state) + +cm_unload hsc_env linkables + = case hsc_mode hsc_env of + Batch -> return () +#ifdef GHCI + Interactive -> Linker.unload (hsc_dflags hsc_env) linkables +#else + Interactive -> panic "unload: no interpreter" +#endif + + +----------------------------------------------------------------------------- +-- Trace dependency graph + +-- This is a seperate pass so that the caller can back off and keep +-- the current state if the downsweep fails. Typically the caller +-- might go cmDepAnal +-- cmUnload +-- cmLoadModules +-- He wants to do the dependency analysis before the unload, so that +-- if the former fails he can use the later + +cmDepAnal :: CmState -> [FilePath] -> IO ModuleGraph +cmDepAnal cmstate rootnames + = do showPass dflags "Chasing dependencies" + when (verbosity dflags >= 1 && gmode == Batch) $ + hPutStrLn stderr (showSDoc (hcat [ + text "Chasing modules from: ", + hcat (punctuate comma (map text rootnames))])) + downsweep rootnames (cm_mg cmstate) + where + hsc_env = cm_hsc cmstate + dflags = hsc_dflags hsc_env + gmode = hsc_mode hsc_env + +----------------------------------------------------------------------------- +-- The real business of the compilation manager: given a system state and +-- a module name, try and bring the module up to date, probably changing +-- the system state at the same time. + +cmLoadModules :: CmState -- The HPT may not be as up to date + -> ModuleGraph -- Bang up to date + -> IO (CmState, -- new state + SuccessFlag, -- was successful + [String]) -- list of modules loaded + +cmLoadModules cmstate1 mg2unsorted + = do -- version 1's are the original, before downsweep + let hsc_env = cm_hsc cmstate1 + let hpt1 = hsc_HPT hsc_env + let ghci_mode = hsc_mode hsc_env -- this never changes + let dflags = hsc_dflags hsc_env -- this never changes + + -- Do the downsweep to reestablish the module graph + let verb = verbosity dflags + + -- Find out if we have a Main module + mb_main_mod <- readIORef v_MainModIs + let + main_mod = mb_main_mod `orElse` "Main" + a_root_is_Main + = any ((==main_mod).moduleNameUserString.modSummaryName) + mg2unsorted + + let mg2unsorted_names = map modSummaryName mg2unsorted + + -- reachable_from follows source as well as normal imports + let reachable_from :: ModuleName -> [ModuleName] + reachable_from = downwards_closure_of_module mg2unsorted + + -- should be cycle free; ignores 'import source's + let mg2 = topological_sort False mg2unsorted + -- ... whereas this takes them into account. Used for + -- backing out partially complete cycles following a failed + -- upsweep, and for removing from hpt all the modules + -- not in strict downwards closure, during calls to compile. + let mg2_with_srcimps = topological_sort True mg2unsorted + + -- Sort out which linkables we wish to keep in the unlinked image. + -- See getValidLinkables below for details. + (valid_old_linkables, new_linkables) + <- getValidLinkables ghci_mode (hptLinkables hpt1) + mg2unsorted_names mg2_with_srcimps + + -- putStrLn (showSDoc (vcat [ppr valid_old_linkables, ppr new_linkables])) + + -- Uniq of ModuleName is the same as Module, fortunately... + let hpt2 = delListFromUFM hpt1 (map linkableModName new_linkables) + hsc_env2 = hsc_env { hsc_HPT = hpt2 } + + -- When (verb >= 2) $ + -- putStrLn (showSDoc (text "Valid linkables:" + -- <+> ppr valid_linkables)) + + -- Figure out a stable set of modules which can be retained + -- the top level envs, to avoid upsweeping them. Goes to a + -- bit of trouble to avoid upsweeping module cycles. + -- + -- Construct a set S of stable modules like this: + -- Travel upwards, over the sccified graph. For each scc + -- of modules ms, add ms to S only if: + -- 1. All home imports of ms are either in ms or S + -- 2. A valid old linkable exists for each module in ms + + stable_mods <- preUpsweep valid_old_linkables + mg2unsorted_names [] mg2_with_srcimps + + let stable_summaries + = concatMap (findInSummaries mg2unsorted) stable_mods + + stable_linkables + = filter (\m -> linkableModName m `elem` stable_mods) + valid_old_linkables + + when (verb >= 2) $ + hPutStrLn stderr (showSDoc (text "Stable modules:" + <+> sep (map (text.moduleNameUserString) stable_mods))) + + -- Unload any modules which are going to be re-linked this + -- time around. + cm_unload hsc_env2 stable_linkables + + -- we can now glom together our linkable sets + let valid_linkables = valid_old_linkables ++ new_linkables + + -- We could at this point detect cycles which aren't broken by + -- a source-import, and complain immediately, but it seems better + -- to let upsweep_mods do this, so at least some useful work gets + -- done before the upsweep is abandoned. + let upsweep_these + = filter (\scc -> any (`notElem` stable_mods) + (map modSummaryName (flattenSCC scc))) + mg2 + + --hPutStrLn stderr "after tsort:\n" + --hPutStrLn stderr (showSDoc (vcat (map ppr mg2))) + + -- Because we don't take into account source imports when doing + -- the topological sort, there shouldn't be any cycles in mg2. + -- If there is, we complain and give up -- the user needs to + -- break the cycle using a boot file. -- Now do the upsweep, calling compile for each module in -- turn. Final result is version 3 of everything. - let threaded2 = ModThreaded pcs1 hst2 hit2 + -- clean up between compilations + let cleanup = cleanTempFilesExcept verb + (ppFilesFromSummaries (flattenSCCs mg2)) + + (upsweep_ok, hsc_env3, modsUpswept) + <- upsweep_mods hsc_env2 valid_linkables reachable_from + cleanup upsweep_these - (upsweepOK, threaded3, sccOKs, newLis) - <- upsweep_sccs threaded2 [] [] mg2 + -- At this point, modsUpswept and newLis should have the same + -- length, so there is one new (or old) linkable for each + -- mod which was processed (passed to compile). - let ui3 = add_to_ui ui2 newLis - let (ModThreaded pcs3 hst3 hit3) = threaded3 + -- Make modsDone be the summaries for each home module now + -- available; this should equal the domain of hpt3. + -- (NOT STRICTLY TRUE if an interactive session was started + -- with some object on disk ???) + -- Get in in a roughly top .. bottom order (hence reverse). + + let modsDone = reverse modsUpswept ++ stable_summaries -- Try and do linking in some form, depending on whether the -- upsweep was completely or only partially successful. - if upsweepOK + if succeeded upsweep_ok then - do let mods_to_relink = upwards_closure mg2 - (map modname_of_linkable newLis) - pkg_linkables <- find_pkg_linkables_for pcii - mg2 mods_to_relink - putStrLn ("needed package modules =\n" - ++ showSDoc (vcat (map ppr pkg_linkables))) - let sccs_to_relink = group_uis ui3 mg2 mods_to_relink - let all_to_relink = map AcyclicSCC pkg_linkables - ++ sccs_to_relink - linkresult <- link pcii all_to_relink pls1 - case linkresult of - LinkErrs _ _ - -> panic "cmLoadModule: link failed (1)" - LinkOK pls3 - -> do let pcms3 = PersistentCMState { hst=hst3, hit=hit3, - ui=ui3, mg=mg2, pci=pcii } - let cmstate3 - = CmState { pcms=pcms3, pcs=pcs3, pls=pls3 } - return (cmstate3, Just modname) + -- Easy; just relink it all. + do when (verb >= 2) $ + hPutStrLn stderr "Upsweep completely successful." - else - do let mods_to_relink = downwards_closure mg2 - (map name_of_summary (flattenSCCs sccOKs)) - pkg_linkables <- find_pkg_linkables_for pcii - mg2 mods_to_relink - let sccs_to_relink = group_uis ui3 mg2 mods_to_relink - let all_to_relink = map AcyclicSCC pkg_linkables - ++ sccs_to_relink - linkresult <- link pcii all_to_relink pls1 - let (hst4, hit4, ui4) - = removeFromTopLevelEnvs mods_to_relink (hst3,hit3,ui3) - case linkresult of - LinkErrs _ _ - -> panic "cmLoadModule: link failed (2)" - LinkOK pls4 - -> do let pcms4 = PersistentCMState { hst=hst4, hit=hit4, - ui=ui4, mg=mg2, pci=pcii } - let cmstate4 - = CmState { pcms=pcms4, pcs=pcs3, pls=pls4 } - return (cmstate4, Just modname) - - --- Given a (home) module graph and a bunch of names of (home) modules --- within that graph, return the names of any packages needed by the --- named modules. Do this by looking at their imports. Assumes, and --- checks, that all of "mods" are mentioned in "mg". --- --- Then, having found the packages directly needed by "mods", --- (1) round up, by looking in "pci", all packages they directly or --- indirectly depend on, and (2) put these packages in topological --- order, since that's important for some linkers. Since cycles in --- the package dependency graph aren't allowed, we can just return --- the list of (package) linkables, rather than a list of SCCs. -find_pkg_linkables_for :: PackageConfigInfo -> [SCC ModSummary] -> [ModuleName] - -> IO [Linkable] -find_pkg_linkables_for pcii mg mods - = let mg_summaries = flattenSCCs mg - mg_names = map name_of_summary mg_summaries - in - -- Assert that the modules for which we seek the required packages - -- are all in the module graph, i.e. are all home modules. - if not (all (`elem` mg_names) mods) - then panic "find_pkg_linkables_for" - else - do let all_imports - = concat - [deps_of_summary summ - | summ <- mg_summaries, name_of_summary summ `elem` mods] - let imports_not_in_home -- imports which must be from packages - = nub (filter (`notElem` mg_names) all_imports) - - -- Figure out the packages directly imported by the home modules - maybe_locs_n_mods <- mapM findModule imports_not_in_home - let home_pkgs_needed - = nub (concatMap get_pkg maybe_locs_n_mods) - where get_pkg Nothing = [] - get_pkg (Just (mod, loc)) - = case packageOfModule mod of - Just p -> [p]; _ -> [] - - -- Discover the package dependency graph, and use it to find the - -- transitive closure of all the needed packages - let pkg_depend_graph :: [(PackageName,[PackageName])] - pkg_depend_graph = map (\pkg -> (_PK_ (name pkg), map _PK_ (package_deps pkg))) pcii - - let all_pkgs_needed = simple_transitive_closure - pkg_depend_graph home_pkgs_needed - - -- Make a graph, in the style which Digraph.stronglyConnComp expects, - -- containing entries only for the needed packages. - let needed_graph - = concat - [if srcP `elem` all_pkgs_needed - then [(srcP, srcP, dstsP)] - else [] - | (srcP, dstsP) <- pkg_depend_graph] - tsorted = flattenSCCs (stronglyConnComp needed_graph) - - return (map LP tsorted) + -- clean up after ourselves + cleanTempFilesExcept verb (ppFilesFromSummaries modsDone) + ofile <- readIORef v_Output_file + no_hs_main <- readIORef v_NoHsMain -simple_transitive_closure :: Eq a => [(a,[a])] -> [a] -> [a] -simple_transitive_closure graph set - = let set2 = nub (concatMap dsts set ++ set) - dsts node = fromMaybe [] (lookup node graph) - in - if length set == length set2 - then set - else simple_transitive_closure graph set2 + -- Issue a warning for the confusing case where the user + -- said '-o foo' but we're not going to do any linking. + -- We attempt linking if either (a) one of the modules is + -- called Main, or (b) the user said -no-hs-main, indicating + -- that main() is going to come from somewhere else. + -- + let do_linking = a_root_is_Main || no_hs_main + when (ghci_mode == Batch && isJust ofile && not do_linking + && verb > 0) $ + hPutStrLn stderr ("Warning: output was redirected with -o, but no output will be generated\nbecause there is no " ++ main_mod ++ " module.") + -- link everything together + linkresult <- link ghci_mode dflags do_linking (hsc_HPT hsc_env3) --- For each module in mods_to_group, extract the relevant linkable --- out of "ui", and arrange these linkables in SCCs as defined by modGraph. --- All this is so that we can pass SCCified Linkable groups to the --- linker. A constraint that should be recorded somewhere is that --- all sccs should either be all-interpreted or all-object, not a mixture. -group_uis :: UnlinkedImage -> [SCC ModSummary] -> [ModuleName] -> [SCC Linkable] -group_uis ui modGraph mods_to_group - = map extract (cleanup (fishOut modGraph mods_to_group)) - where - fishOut :: [SCC ModSummary] -> [ModuleName] -> [(Bool,[ModuleName])] - fishOut [] unused - | null unused = [] - | otherwise = panic "group_uis: modnames not in modgraph" - fishOut ((AcyclicSCC ms):sccs) unused - = case split (== (name_of_summary ms)) unused of - (eq, not_eq) -> (False, eq) : fishOut sccs not_eq - fishOut ((CyclicSCC mss):sccs) unused - = case split (`elem` (map name_of_summary mss)) unused of - (eq, not_eq) -> (True, eq) : fishOut sccs not_eq - - cleanup :: [(Bool,[ModuleName])] -> [SCC ModuleName] - cleanup [] = [] - cleanup ((isRec,names):rest) - | null names = cleanup rest - | isRec = CyclicSCC names : cleanup rest - | not isRec = case names of [name] -> AcyclicSCC name : cleanup rest - other -> panic "group_uis(cleanup)" - - extract :: SCC ModuleName -> SCC Linkable - extract (AcyclicSCC nm) = AcyclicSCC (getLi nm) - extract (CyclicSCC nms) = CyclicSCC (map getLi nms) - - getLi nm = case [li | li <- ui, not (is_package_linkable li), - nm == modname_of_linkable li] of - [li] -> li - other -> panic "group_uis:getLi" - - split f xs = (filter f xs, filter (not.f) xs) - - --- Add the given (LM-form) Linkables to the UI, overwriting previous --- versions if they exist. -add_to_ui :: UnlinkedImage -> [Linkable] -> UnlinkedImage -add_to_ui ui lis - = foldr add1 ui lis + let cmstate3 = cmstate1 { cm_mg = modsDone, cm_hsc = hsc_env3 } + cmLoadFinish Succeeded linkresult cmstate3 + + else + -- Tricky. We need to back out the effects of compiling any + -- half-done cycles, both so as to clean up the top level envs + -- and to avoid telling the interactive linker to link them. + do when (verb >= 2) $ + hPutStrLn stderr "Upsweep partially successful." + + let modsDone_names + = map modSummaryName modsDone + let mods_to_zap_names + = findPartiallyCompletedCycles modsDone_names + mg2_with_srcimps + let mods_to_keep + = filter ((`notElem` mods_to_zap_names).modSummaryName) + modsDone + + let hpt4 = retainInTopLevelEnvs (map modSummaryName mods_to_keep) + (hsc_HPT hsc_env3) + + -- Clean up after ourselves + cleanTempFilesExcept verb (ppFilesFromSummaries mods_to_keep) + + -- Link everything together + linkresult <- link ghci_mode dflags False hpt4 + + let cmstate3 = cmstate1 { cm_mg = mods_to_keep, + cm_hsc = hsc_env3 { hsc_HPT = hpt4 } } + cmLoadFinish Failed linkresult cmstate3 + + +-- Finish up after a cmLoad. + +-- If the link failed, unload everything and return. +cmLoadFinish ok Failed cmstate + = do cm_unload (cm_hsc cmstate) [] + return (discardCMInfo cmstate, Failed, []) + +-- Empty the interactive context and set the module context to the topmost +-- newly loaded module, or the Prelude if none were loaded. +cmLoadFinish ok Succeeded cmstate + = do let new_cmstate = cmstate { cm_ic = emptyInteractiveContext } + mods_loaded = map (moduleNameUserString.modSummaryName) + (cm_mg cmstate) + + return (new_cmstate, ok, mods_loaded) + +-- used to fish out the preprocess output files for the purposes of +-- cleaning up. The preprocessed file *might* be the same as the +-- source file, but that doesn't do any harm. +ppFilesFromSummaries summaries + = [ fn | Just fn <- map (ml_hspp_file.ms_location) summaries ] + +----------------------------------------------------------------------------- +-- getValidLinkables + +-- For each module (or SCC of modules), we take: +-- +-- - an on-disk linkable, if this is the first time around and one +-- is available. +-- +-- - the old linkable, otherwise (and if one is available). +-- +-- and we throw away the linkable if it is older than the source file. +-- In interactive mode, we also ignore the on-disk linkables unless +-- all of the dependents of this SCC also have on-disk linkables (we +-- can't have dynamically loaded objects that depend on interpreted +-- modules in GHCi). +-- +-- If a module has a valid linkable, then it may be STABLE (see below), +-- and it is classified as SOURCE UNCHANGED for the purposes of calling +-- compile. +-- +-- ToDo: this pass could be merged with the preUpsweep. + +getValidLinkables + :: GhciMode + -> [Linkable] -- old linkables + -> [ModuleName] -- all home modules + -> [SCC ModSummary] -- all modules in the program, dependency order + -> IO ( [Linkable], -- still-valid linkables + [Linkable] -- new linkables we just found + ) + +getValidLinkables mode old_linkables all_home_mods module_graph = do + ls <- foldM (getValidLinkablesSCC mode old_linkables all_home_mods) + [] module_graph + return (partition_it ls [] []) + where + partition_it [] valid new = (valid,new) + partition_it ((l,b):ls) valid new + | b = partition_it ls valid (l:new) + | otherwise = partition_it ls (l:valid) new + + +getValidLinkablesSCC mode old_linkables all_home_mods new_linkables scc0 + = let + scc = flattenSCC scc0 + scc_names = map modSummaryName scc + home_module m = m `elem` all_home_mods && m `notElem` scc_names + scc_allhomeimps = nub (filter home_module (concatMap ms_imps scc)) + -- NB. ms_imps, not ms_allimps above. We don't want to + -- force a module's SOURCE imports to be already compiled for + -- its object linkable to be valid. + + has_object m = + case findModuleLinkable_maybe (map fst new_linkables) m of + Nothing -> False + Just l -> isObjectLinkable l + + objects_allowed = mode == Batch || all has_object scc_allhomeimps + in do + + new_linkables' + <- foldM (getValidLinkable old_linkables objects_allowed) [] scc + + -- since an scc can contain only all objects or no objects at all, + -- we have to check whether we got all objects or not, and re-do + -- the linkable check if not. + new_linkables' <- + if objects_allowed + && not (all isObjectLinkable (map fst new_linkables')) + then foldM (getValidLinkable old_linkables False) [] scc + else return new_linkables' + + return (new_linkables ++ new_linkables') + + +getValidLinkable :: [Linkable] -> Bool -> [(Linkable,Bool)] -> ModSummary + -> IO [(Linkable,Bool)] + -- True <=> linkable is new; i.e. freshly discovered on the disk + -- presumably generated 'on the side' + -- by a separate GHC run +getValidLinkable old_linkables objects_allowed new_linkables summary + -- 'objects_allowed' says whether we permit this module to + -- have a .o-file linkable. We only permit it if all the + -- modules it depends on also have .o files; a .o file can't + -- link to a bytecode module + = do let mod_name = modSummaryName summary + + maybe_disk_linkable + <- if (not objects_allowed) + then return Nothing + + else findLinkable mod_name (ms_location summary) + + let old_linkable = findModuleLinkable_maybe old_linkables mod_name + + new_linkables' = + case (old_linkable, maybe_disk_linkable) of + (Nothing, Nothing) -> [] + + -- new object linkable just appeared + (Nothing, Just l) -> up_to_date l True + + (Just l, Nothing) + | isObjectLinkable l -> [] + -- object linkable disappeared! In case we need to + -- relink the module, disregard the old linkable and + -- just interpret the module from now on. + | otherwise -> up_to_date l False + -- old byte code linkable + + (Just l, Just l') + | not (isObjectLinkable l) -> up_to_date l False + -- if the previous linkable was interpreted, then we + -- ignore a newly compiled version, because the version + -- numbers in the interface file will be out-of-sync with + -- our internal ones. + | linkableTime l' > linkableTime l -> up_to_date l' True + | linkableTime l' == linkableTime l -> up_to_date l False + | otherwise -> [] + -- on-disk linkable has been replaced by an older one! + -- again, disregard the previous one. + + up_to_date l b + | linkableTime l < ms_hs_date summary = [] + | otherwise = [(l,b)] + -- why '<' rather than '<=' above? If the filesystem stores + -- times to the nearset second, we may occasionally find that + -- the object & source have the same modification time, + -- especially if the source was automatically generated + -- and compiled. Using >= is slightly unsafe, but it matches + -- make's behaviour. + + return (new_linkables' ++ new_linkables) + + +hptLinkables :: HomePackageTable -> [Linkable] +-- Get all the linkables from the home package table, one for each module +-- Once the HPT is up to date, these are the ones we should link +hptLinkables hpt = map hm_linkable (moduleEnvElts hpt) + + +----------------------------------------------------------------------------- +-- Do a pre-upsweep without use of "compile", to establish a +-- (downward-closed) set of stable modules for which we won't call compile. + +-- a stable module: +-- * has a valid linkable (see getValidLinkables above) +-- * depends only on stable modules +-- * has an interface in the HPT (interactive mode only) + +preUpsweep :: [Linkable] -- new valid linkables + -> [ModuleName] -- names of all mods encountered in downsweep + -> [ModuleName] -- accumulating stable modules + -> [SCC ModSummary] -- scc-ified mod graph, including src imps + -> IO [ModuleName] -- stable modules + +preUpsweep valid_lis all_home_mods stable [] = return stable +preUpsweep valid_lis all_home_mods stable (scc0:sccs) + = do let scc = flattenSCC scc0 + scc_allhomeimps :: [ModuleName] + scc_allhomeimps + = nub (filter (`elem` all_home_mods) (concatMap ms_allimps scc)) + all_imports_in_scc_or_stable + = all in_stable_or_scc scc_allhomeimps + scc_names + = map modSummaryName scc + in_stable_or_scc m + = m `elem` scc_names || m `elem` stable + + -- now we check for valid linkables: each module in the SCC must + -- have a valid linkable (see getValidLinkables above). + has_valid_linkable new_summary + = isJust (findModuleLinkable_maybe valid_lis modname) + where modname = modSummaryName new_summary + + scc_is_stable = all_imports_in_scc_or_stable + && all has_valid_linkable scc + + if scc_is_stable + then preUpsweep valid_lis all_home_mods (scc_names++stable) sccs + else preUpsweep valid_lis all_home_mods stable sccs + + +-- Helper for preUpsweep. Assuming that new_summary's imports are all +-- stable (in the sense of preUpsweep), determine if new_summary is itself +-- stable, and, if so, in batch mode, return its linkable. +findInSummaries :: [ModSummary] -> ModuleName -> [ModSummary] +findInSummaries old_summaries mod_name + = [s | s <- old_summaries, modSummaryName s == mod_name] + +findModInSummaries :: [ModSummary] -> Module -> Maybe ModSummary +findModInSummaries old_summaries mod + = case [s | s <- old_summaries, ms_mod s == mod] of + [] -> Nothing + (s:_) -> Just s + +-- Return (names of) all those in modsDone who are part of a cycle +-- as defined by theGraph. +findPartiallyCompletedCycles :: [ModuleName] -> [SCC ModSummary] -> [ModuleName] +findPartiallyCompletedCycles modsDone theGraph + = chew theGraph where - add1 :: Linkable -> UnlinkedImage -> UnlinkedImage - add1 li ui - = li : filter (\li2 -> not (for_same_module li li2)) ui - - for_same_module :: Linkable -> Linkable -> Bool - for_same_module li1 li2 - = not (is_package_linkable li1) - && not (is_package_linkable li2) - && modname_of_linkable li1 == modname_of_linkable li2 - - --- Compute upwards and downwards closures in the (home-) module graph. -downwards_closure, - upwards_closure :: [SCC ModSummary] -> [ModuleName] -> [ModuleName] - -upwards_closure = up_down_closure True -downwards_closure = up_down_closure False - -up_down_closure :: Bool -> [SCC ModSummary] -> [ModuleName] -> [ModuleName] -up_down_closure up modGraph roots - = let mgFlat = flattenSCCs modGraph - nodes = map name_of_summary mgFlat - - fwdEdges, backEdges :: [(ModuleName, [ModuleName])] - -- have an entry for each mod in mgFlat, and do not - -- mention edges leading out of the home package - fwdEdges - = map mkEdge mgFlat - backEdges -- Only calculated if needed, which is just as well! - = [(n, [m | (m, m_imports) <- fwdEdges, n `elem` m_imports]) - | (n, n_imports) <- fwdEdges] - - mkEdge summ - = (name_of_summary summ, - -- ignore imports not from the home package - filter (`elem` nodes) (deps_of_summary summ)) - in - simple_transitive_closure - (if up then backEdges else fwdEdges) (nub roots) + chew [] = [] + chew ((AcyclicSCC v):rest) = chew rest -- acyclic? not interesting. + chew ((CyclicSCC vs):rest) + = let names_in_this_cycle = nub (map modSummaryName vs) + mods_in_this_cycle + = nub ([done | done <- modsDone, + done `elem` names_in_this_cycle]) + chewed_rest = chew rest + in + if notNull mods_in_this_cycle + && length mods_in_this_cycle < length names_in_this_cycle + then mods_in_this_cycle ++ chewed_rest + else chewed_rest + + +-- Compile multiple modules, stopping as soon as an error appears. +-- There better had not be any cyclic groups here -- we check for them. +upsweep_mods :: HscEnv -- Includes up-to-date HPT + -> [Linkable] -- Valid linkables + -> (ModuleName -> [ModuleName]) -- to construct downward closures + -> IO () -- how to clean up unwanted tmp files + -> [SCC ModSummary] -- mods to do (the worklist) + -- ...... RETURNING ...... + -> IO (SuccessFlag, + HscEnv, -- With an updated HPT + [ModSummary]) -- Mods which succeeded + +upsweep_mods hsc_env oldUI reachable_from cleanup + [] + = return (Succeeded, hsc_env, []) + +upsweep_mods hsc_env oldUI reachable_from cleanup + ((CyclicSCC ms):_) + = do hPutStrLn stderr ("Module imports form a cycle for modules:\n\t" ++ + unwords (map (moduleNameUserString.modSummaryName) ms)) + return (Failed, hsc_env, []) + +upsweep_mods hsc_env oldUI reachable_from cleanup + ((AcyclicSCC mod):mods) + = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++ + -- show (map (moduleNameUserString.moduleName.mi_module.hm_iface) (eltsUFM (hsc_HPT hsc_env))) + + (ok_flag, hsc_env1) <- upsweep_mod hsc_env oldUI mod + (reachable_from (modSummaryName mod)) + + cleanup -- Remove unwanted tmp files between compilations + + if failed ok_flag then + return (Failed, hsc_env1, []) + else do + (restOK, hsc_env2, modOKs) + <- upsweep_mods hsc_env1 oldUI reachable_from cleanup mods + return (restOK, hsc_env2, mod:modOKs) + + +-- Compile a single module. Always produce a Linkable for it if +-- successful. If no compilation happened, return the old Linkable. +upsweep_mod :: HscEnv + -> UnlinkedImage + -> ModSummary + -> [ModuleName] + -> IO (SuccessFlag, + HscEnv) -- With updated HPT +upsweep_mod hsc_env oldUI summary1 reachable_inc_me + = do + let this_mod = ms_mod summary1 + location = ms_location summary1 + mod_name = moduleName this_mod + hpt1 = hsc_HPT hsc_env + let mb_old_iface = case lookupModuleEnvByName hpt1 mod_name of + Just mod_info -> Just (hm_iface mod_info) + Nothing -> Nothing -data ModThreaded -- stuff threaded through individual module compilations - = ModThreaded PersistentCompilerState HomeSymbolTable HomeIfaceTable + let maybe_old_linkable = findModuleLinkable_maybe oldUI mod_name + source_unchanged = isJust maybe_old_linkable --- Compile multiple SCCs, stopping as soon as an error appears -upsweep_sccs :: ModThreaded -- PCS & HST & HIT - -> [SCC ModSummary] -- accum: SCCs which succeeded - -> [Linkable] -- accum: new Linkables - -> [SCC ModSummary] -- SCCs to do (the worklist) - -- ...... RETURNING ...... - -> IO (Bool{-success?-}, - ModThreaded, - [SCC ModSummary], -- SCCs which succeeded - [Linkable]) -- new linkables - -upsweep_sccs threaded sccOKs newLis [] - = -- No more SCCs to do. - return (True, threaded, sccOKs, newLis) - -upsweep_sccs threaded sccOKs newLis (scc:sccs) - = -- Start work on a new SCC. - do (sccOK, threaded2, lisSCC) - <- upsweep_scc threaded (flattenSCC scc) - if sccOK - then -- all the modules in the scc were ok - -- move on to the next SCC - upsweep_sccs threaded2 - (scc:sccOKs) (lisSCC++newLis) sccs - else -- we got a compilation error; give up now - return - (False, threaded2, sccOKs, lisSCC++newLis) - - --- Compile multiple modules (one SCC), stopping as soon as an error appears -upsweep_scc :: ModThreaded - -> [ModSummary] - -> IO (Bool{-success?-}, ModThreaded, [Linkable]) -upsweep_scc threaded [] - = return (True, threaded, []) -upsweep_scc threaded (mod:mods) - = do (moduleOK, threaded1, maybe_linkable) - <- upsweep_mod threaded mod - if moduleOK - then -- No errors; get contribs from the rest - do (restOK, threaded2, linkables) - <- upsweep_scc threaded1 mods - return - (restOK, threaded2, maybeToList maybe_linkable ++ linkables) - else -- Errors; give up _now_ - return (False, threaded1, []) - --- Compile a single module. -upsweep_mod :: ModThreaded - -> ModSummary - -> IO (Bool{-success?-}, ModThreaded, Maybe Linkable) + reachable_only = filter (/= mod_name) reachable_inc_me + + -- In interactive mode, all home modules below us *must* have an + -- interface in the HPT. We never demand-load home interfaces in + -- interactive mode. + hpt1_strictDC + = ASSERT(hsc_mode hsc_env == Batch || all (`elemUFM` hpt1) reachable_only) + retainInTopLevelEnvs reachable_only hpt1 + hsc_env_strictDC = hsc_env { hsc_HPT = hpt1_strictDC } + + old_linkable = expectJust "upsweep_mod:old_linkable" maybe_old_linkable + + have_object + | Just l <- maybe_old_linkable, isObjectLinkable l = True + | otherwise = False -upsweep_mod threaded1 summary1 - = do let mod_name = name_of_summary summary1 - let (ModThreaded pcs1 hst1 hit1) = threaded1 - let old_iface = lookupUFM hit1 (name_of_summary summary1) - compresult <- compile summary1 old_iface hst1 hit1 pcs1 + compresult <- compile hsc_env_strictDC this_mod location + (ms_hs_date summary1) + source_unchanged have_object mb_old_iface case compresult of - -- Compilation "succeeded", but didn't return a new iface or - -- linkable, meaning that compilation wasn't needed, and the - -- new details were manufactured from the old iface. - CompOK details Nothing pcs2 - -> let hst2 = addToUFM hst1 mod_name details - hit2 = hit1 - threaded2 = ModThreaded pcs2 hst2 hit2 - in return (True, threaded2, Nothing) - - -- Compilation really did happen, and succeeded. A new - -- details, iface and linkable are returned. - CompOK details (Just (new_iface, new_linkable)) pcs2 - -> let hst2 = addToUFM hst1 mod_name details - hit2 = addToUFM hit1 mod_name new_iface - threaded2 = ModThreaded pcs2 hst2 hit2 - in return (True, threaded2, Just new_linkable) - - -- Compilation failed. compile may still have updated - -- the PCS, tho. - CompErrs pcs2 - -> let threaded2 = ModThreaded pcs2 hst1 hit1 - in return (False, threaded2, Nothing) - - -removeFromTopLevelEnvs :: [ModuleName] - -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage) - -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage) -removeFromTopLevelEnvs zap_these (hst, hit, ui) - = (delListFromUFM hst zap_these, - delListFromUFM hit zap_these, - filterModuleLinkables (`notElem` zap_these) ui - ) - -topological_sort :: [ModSummary] -> [SCC ModSummary] -topological_sort summaries + -- Compilation "succeeded", and may or may not have returned a new + -- linkable (depending on whether compilation was actually performed + -- or not). + CompOK new_details new_globals new_iface maybe_new_linkable + -> do let + new_linkable = maybe_new_linkable `orElse` old_linkable + new_info = HomeModInfo { hm_iface = new_iface, + hm_globals = new_globals, + hm_details = new_details, + hm_linkable = new_linkable } + hpt2 = extendModuleEnv hpt1 this_mod new_info + + return (Succeeded, hsc_env { hsc_HPT = hpt2 }) + + -- Compilation failed. Compile may still have updated the PCS, tho. + CompErrs -> return (Failed, hsc_env) + +-- Filter modules in the HPT +retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable +retainInTopLevelEnvs keep_these hpt + = listToUFM (concatMap (maybeLookupUFM hpt) keep_these) + where + maybeLookupUFM ufm u = case lookupUFM ufm u of + Nothing -> [] + Just val -> [(u, val)] + +-- Needed to clean up HPT so that we don't get duplicates in inst env +downwards_closure_of_module :: [ModSummary] -> ModuleName -> [ModuleName] +downwards_closure_of_module summaries root + = let toEdge :: ModSummary -> (ModuleName,[ModuleName]) + toEdge summ = (modSummaryName summ, + filter (`elem` all_mods) (ms_allimps summ)) + + all_mods = map modSummaryName summaries + + res = simple_transitive_closure (map toEdge summaries) [root] + in +-- trace (showSDoc (text "DC of mod" <+> ppr root +-- <+> text "=" <+> ppr res)) $ + res + +-- Calculate transitive closures from a set of roots given an adjacency list +simple_transitive_closure :: Eq a => [(a,[a])] -> [a] -> [a] +simple_transitive_closure graph set + = let set2 = nub (concatMap dsts set ++ set) + dsts node = fromMaybe [] (lookup node graph) + in + if length set == length set2 + then set + else simple_transitive_closure graph set2 + + +-- Calculate SCCs of the module graph, with or without taking into +-- account source imports. +topological_sort :: Bool -> [ModSummary] -> [SCC ModSummary] +topological_sort include_source_imports summaries = let toEdge :: ModSummary -> (ModSummary,ModuleName,[ModuleName]) toEdge summ - = (summ, name_of_summary summ, deps_of_summary summ) - + = (summ, modSummaryName summ, + (if include_source_imports + then ms_srcimps summ else []) ++ ms_imps summ) + mash_edge :: (ModSummary,ModuleName,[ModuleName]) -> (ModSummary,Int,[Int]) mash_edge (summ, m, m_imports) = case lookup m key_map of Nothing -> panic "reverse_topological_sort" Just mk -> (summ, mk, -- ignore imports not from the home package - catMaybes (map (flip lookup key_map) m_imports)) + mapCatMaybes (flip lookup key_map) m_imports) edges = map toEdge summaries key_map = zip [nm | (s,nm,imps) <- edges] [1 ..] :: [(ModuleName,Int)] @@ -484,36 +1030,236 @@ topological_sort summaries in sccs -downsweep :: ModuleName -- module to chase from - -> IO [ModSummary] -downsweep rootNm - = do rootLoc <- getSummary rootNm - loop [rootLoc] + +----------------------------------------------------------------------------- +-- Downsweep (dependency analysis) + +-- Chase downwards from the specified root set, returning summaries +-- for all home modules encountered. Only follow source-import +-- links. + +-- We pass in the previous collection of summaries, which is used as a +-- cache to avoid recalculating a module summary if the source is +-- unchanged. + +downsweep :: [FilePath] -> [ModSummary] -> IO [ModSummary] +downsweep roots old_summaries + = do rootSummaries <- mapM getRootSummary roots + checkDuplicates rootSummaries + all_summaries + <- loop (concat (map (\ m -> zip (repeat (fromMaybe "" (ml_hs_file (ms_location m)))) + (ms_imps m)) rootSummaries)) + (mkModuleEnv [ (mod, s) | s <- rootSummaries, + let mod = ms_mod s, isHomeModule mod + ]) + return all_summaries where - getSummary :: ModuleName -> IO ModSummary - getSummary nm + getRootSummary :: FilePath -> IO ModSummary + getRootSummary file + | isHaskellSrcFilename file + = do exists <- doesFileExist file + if exists then summariseFile file else do + throwDyn (CmdLineError ("can't find file `" ++ file ++ "'")) + | otherwise + = do exists <- doesFileExist hs_file + if exists then summariseFile hs_file else do + exists <- doesFileExist lhs_file + if exists then summariseFile lhs_file else do + let mod_name = mkModuleName file + maybe_summary <- getSummary (file, mod_name) + case maybe_summary of + Nothing -> packageModErr mod_name + Just s -> return s + where + hs_file = file ++ ".hs" + lhs_file = file ++ ".lhs" + + -- In a root module, the filename is allowed to diverge from the module + -- name, so we have to check that there aren't multiple root files + -- defining the same module (otherwise the duplicates will be silently + -- ignored, leading to confusing behaviour). + checkDuplicates :: [ModSummary] -> IO () + checkDuplicates summaries = mapM_ check summaries + where check summ = + case dups of + [] -> return () + [_one] -> return () + many -> multiRootsErr modl many + where modl = ms_mod summ + dups = + [ fromJust (ml_hs_file (ms_location summ')) + | summ' <- summaries, ms_mod summ' == modl ] + + getSummary :: (FilePath,ModuleName) -> IO (Maybe ModSummary) + getSummary (currentMod,nm) = do found <- findModule nm case found of - Just (mod, location) -> summarise mod location - Nothing -> panic ("CompManager: can't find module `" ++ - showSDoc (ppr nm) ++ "'") - - -- loop invariant: homeSummaries doesn't contain package modules - loop :: [ModSummary] -> IO [ModSummary] - loop homeSummaries - = do let allImps :: [ModuleName] - allImps -- all imports - = (nub . map mimp_name . concat . map ms_get_imports) - homeSummaries - let allHome -- all modules currently in homeSummaries - = map (moduleName.ms_mod) homeSummaries - let neededImps - = filter (`notElem` allHome) allImps - neededSummaries - <- mapM getSummary neededImps - let newHomeSummaries - = filter (isModuleInThisPackage.ms_mod) neededSummaries - if null newHomeSummaries - then return homeSummaries - else loop (newHomeSummaries ++ homeSummaries) + Right (mod, location) -> do + let old_summary = findModInSummaries old_summaries mod + summarise mod location old_summary + + Left files -> do + dflags <- getDynFlags + throwDyn (noModError dflags currentMod nm files) + + -- loop invariant: env doesn't contain package modules + loop :: [(FilePath,ModuleName)] -> ModuleEnv ModSummary -> IO [ModSummary] + loop [] env = return (moduleEnvElts env) + loop imps env + = do -- imports for modules we don't already have + let needed_imps = nub (filter (not . (`elemUFM` env).snd) imps) + + -- summarise them + needed_summaries <- mapM getSummary needed_imps + + -- get just the "home" modules + let new_home_summaries = [ s | Just s <- needed_summaries ] + + -- loop, checking the new imports + let new_imps = concat (map (\ m -> zip (repeat (fromMaybe "" (ml_hs_file (ms_location m)))) + (ms_imps m)) new_home_summaries) + loop new_imps (extendModuleEnvList env + [ (ms_mod s, s) | s <- new_home_summaries ]) + +-- ToDo: we don't have a proper line number for this error +noModError dflags loc mod_nm files = ProgramError (showSDoc ( + hang (text loc <> colon) 4 $ + (text "Can't find module" <+> quotes (ppr mod_nm) $$ extra) + )) + where + extra + | verbosity dflags < 3 = + text "(use -v to see a list of the files searched for)" + | otherwise = + hang (ptext SLIT("locations searched:")) 4 (vcat (map text files)) + +----------------------------------------------------------------------------- +-- Summarising modules + +-- We have two types of summarisation: +-- +-- * Summarise a file. This is used for the root module(s) passed to +-- cmLoadModules. The file is read, and used to determine the root +-- module name. The module name may differ from the filename. +-- +-- * Summarise a module. We are given a module name, and must provide +-- a summary. The finder is used to locate the file in which the module +-- resides. + +summariseFile :: FilePath -> IO ModSummary +summariseFile file + = do hspp_fn <- preprocess file + (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn + + let -- GHC.Prim doesn't exist physically, so don't go looking for it. + the_imps = filter (/= gHC_PRIM_Name) imps + + (mod, location) <- mkHomeModLocation mod_name file + + src_timestamp + <- case ml_hs_file location of + Nothing -> noHsFileErr mod_name + Just src_fn -> getModificationTime src_fn + + return (ModSummary { ms_mod = mod, + ms_location = location{ml_hspp_file=Just hspp_fn}, + ms_srcimps = srcimps, ms_imps = the_imps, + ms_hs_date = src_timestamp }) + +-- Summarise a module, and pick up source and timestamp. +summarise :: Module -> ModLocation -> Maybe ModSummary + -> IO (Maybe ModSummary) +summarise mod location old_summary + | not (isHomeModule mod) = return Nothing + | otherwise + = do let hs_fn = expectJust "summarise" (ml_hs_file location) + + case ml_hs_file location of { + Nothing -> noHsFileErr mod; + Just src_fn -> do + + src_timestamp <- getModificationTime src_fn + + -- return the cached summary if the source didn't change + case old_summary of { + Just s | ms_hs_date s == src_timestamp -> return (Just s); + _ -> do + + hspp_fn <- preprocess hs_fn + (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn + let + -- GHC.Prim doesn't exist physically, so don't go looking for it. + the_imps = filter (/= gHC_PRIM_Name) imps + + when (mod_name /= moduleName mod) $ + throwDyn (ProgramError + (showSDoc (text hs_fn + <> text ": file name does not match module name" + <+> quotes (ppr (moduleName mod))))) + + return (Just (ModSummary mod location{ml_hspp_file=Just hspp_fn} + srcimps the_imps src_timestamp)) + } + } + + +noHsFileErr mod + = throwDyn (CmdLineError (showSDoc (text "no source file for module" <+> quotes (ppr mod)))) + +packageModErr mod + = throwDyn (CmdLineError (showSDoc (text "module" <+> + quotes (ppr mod) <+> + text "is a package module"))) + +multiRootsErr mod files + = throwDyn (ProgramError (showSDoc ( + text "module" <+> quotes (ppr mod) <+> + text "is defined in multiple files:" <+> + sep (map text files)))) +\end{code} + + +%************************************************************************ +%* * + The ModSummary Type +%* * +%************************************************************************ + +\begin{code} +-- The ModLocation contains both the original source filename and the +-- filename of the cleaned-up source file after all preprocessing has been +-- done. The point is that the summariser will have to cpp/unlit/whatever +-- all files anyway, and there's no point in doing this twice -- just +-- park the result in a temp file, put the name of it in the location, +-- and let @compile@ read from that file on the way back up. + + +type ModuleGraph = [ModSummary] -- the module graph, topologically sorted + +emptyMG :: ModuleGraph +emptyMG = [] + +data ModSummary + = ModSummary { + ms_mod :: Module, -- name, package + ms_location :: ModLocation, -- location + ms_srcimps :: [ModuleName], -- source imports + ms_imps :: [ModuleName], -- non-source imports + ms_hs_date :: ClockTime -- timestamp of summarised file + } + +instance Outputable ModSummary where + ppr ms + = sep [text "ModSummary {", + nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)), + text "ms_mod =" <+> ppr (ms_mod ms) <> comma, + text "ms_imps =" <+> ppr (ms_imps ms), + text "ms_srcimps =" <+> ppr (ms_srcimps ms)]), + char '}' + ] + +ms_allimps ms = ms_srcimps ms ++ ms_imps ms + +modSummaryName :: ModSummary -> ModuleName +modSummaryName = moduleName . ms_mod \end{code}