X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FcompMan%2FCompManager.lhs;h=e87f07405009e2e1b57d0fa82323be6bc8a051af;hb=d1dcd244551d89d205c58fcea2a686d43079a38d;hp=498ee07bf8a842157feabd6a6ddee9edfadf8344;hpb=10983d10cdc064ef5eca564d3bf1ab120fe6100b;p=ghc-hetmet.git diff --git a/ghc/compiler/compMan/CompManager.lhs b/ghc/compiler/compMan/CompManager.lhs index 498ee07..e87f074 100644 --- a/ghc/compiler/compMan/CompManager.lhs +++ b/ghc/compiler/compMan/CompManager.lhs @@ -4,38 +4,64 @@ \section[CompManager]{The Compilation Manager} \begin{code} -module CompManager ( cmInit, cmLoadModule, cmUnload, +module CompManager ( + cmInit, -- :: GhciMode -> IO CmState + + cmLoadModule, -- :: CmState -> FilePath -> IO (CmState, [String]) + + cmUnload, -- :: CmState -> DynFlags -> IO CmState + + cmSetContext, -- :: CmState -> String -> IO CmState + + cmGetContext, -- :: CmState -> IO String + #ifdef GHCI - cmGetExpr, cmRunExpr, + cmInfoThing, -- :: CmState -> DynFlags -> String -> IO (Maybe TyThing) + + cmRunStmt, -- :: CmState -> DynFlags -> String -> IO (CmState, [Name]) + + cmTypeOfExpr, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe String) + + cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) + + cmCompileExpr,-- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe HValue)#endif #endif - CmState, emptyCmState -- abstract - ) + CmState, emptyCmState -- abstract + ) where #include "HsVersions.h" import CmLink import CmTypes -import HscTypes -import Module ( Module, ModuleName, moduleName, isHomeModule, - mkModuleName, moduleNameUserString ) -import CmStaticInfo ( GhciMode(..) ) import DriverPipeline -import GetImports -import HscTypes ( HomeSymbolTable, HomeIfaceTable, - PersistentCompilerState, ModDetails(..) ) -import HscMain ( initPersistentCompilerState ) +import DriverFlags ( getDynFlags ) +import DriverPhases +import DriverUtil import Finder -import UniqFM ( emptyUFM, lookupUFM, addToUFM, delListFromUFM, - UniqFM, listToUFM ) +#ifdef GHCI +import HscMain ( initPersistentCompilerState, hscThing ) +#else +import HscMain ( initPersistentCompilerState ) +#endif +import HscTypes +import RnEnv ( unQualInScope ) +import Id ( idType, idName ) +import Name ( Name, NamedThing(..), nameRdrName ) +import NameEnv +import RdrName ( lookupRdrEnv, emptyRdrEnv ) +import Module +import GetImports +import Type ( tidyType ) +import VarEnv ( emptyTidyEnv ) +import UniqFM import Unique ( Uniquable ) import Digraph ( SCC(..), stronglyConnComp, flattenSCC ) -import DriverFlags ( getDynFlags ) -import DriverPhases -import DriverUtil ( splitFilename3 ) import ErrUtils ( showPass ) +import SysTools ( cleanTempFilesExcept ) import Util -import DriverUtil import Outputable import Panic import CmdLineOpts ( DynFlags(..) ) @@ -43,8 +69,7 @@ import IOExts #ifdef GHCI import Interpreter ( HValue ) -import HscMain ( hscExpr ) -import Type ( Type ) +import HscMain ( hscStmt ) import PrelGHC ( unsafeCoerce# ) #endif @@ -52,53 +77,15 @@ import PrelGHC ( unsafeCoerce# ) import Exception ( throwDyn ) -- std -import Time ( ClockTime ) import Directory ( getModificationTime, doesFileExist ) import IO import Monad import List ( nub ) -import Maybe ( catMaybes, fromMaybe, isJust ) +import Maybe \end{code} \begin{code} -cmInit :: GhciMode -> IO CmState -cmInit gmode - = emptyCmState gmode - -#ifdef GHCI -cmGetExpr :: CmState - -> DynFlags - -> Bool -- True <=> wrap in 'print' to get an IO-typed result - -> Module - -> String - -> IO (CmState, Maybe (HValue, PrintUnqualified, Type)) -cmGetExpr cmstate dflags wrap_io mod expr - = do (new_pcs, maybe_stuff) <- - hscExpr dflags wrap_io hst hit pcs mod expr - case maybe_stuff of - Nothing -> return (cmstate{ pcs=new_pcs }, Nothing) - Just (bcos, print_unqual, ty) -> do - hValue <- linkExpr pls bcos - return (cmstate{ pcs=new_pcs }, - Just (hValue, print_unqual, ty)) - - -- ToDo: check that the module we passed in is sane/exists? - where - CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls } = cmstate - --- The HValue should represent a value of type IO () (Perhaps IO a?) -cmRunExpr :: HValue -> IO () -cmRunExpr hval - = do unsafeCoerce# hval :: IO () - -- putStrLn "done." -#endif - -emptyHIT :: HomeIfaceTable -emptyHIT = emptyUFM -emptyHST :: HomeSymbolTable -emptyHST = emptyUFM - -- Persistent state for the entire system data CmState = CmState { @@ -107,23 +94,33 @@ data CmState ui :: UnlinkedImage, -- the unlinked images mg :: ModuleGraph, -- the module graph gmode :: GhciMode, -- NEVER CHANGES + ic :: InteractiveContext, -- command-line binding info pcs :: PersistentCompilerState, -- compile's persistent state pls :: PersistentLinkerState -- link's persistent state } -emptyCmState :: GhciMode -> IO CmState -emptyCmState gmode +emptyCmState :: GhciMode -> Module -> IO CmState +emptyCmState gmode mod = do pcs <- initPersistentCompilerState pls <- emptyPLS - return (CmState { hst = emptyHST, - hit = emptyHIT, - ui = emptyUI, - mg = emptyMG, - gmode = gmode, + return (CmState { hst = emptySymbolTable, + hit = emptyIfaceTable, + ui = emptyUI, + mg = emptyMG, + gmode = gmode, + ic = emptyInteractiveContext mod, pcs = pcs, pls = pls }) +emptyInteractiveContext mod + = InteractiveContext { ic_module = mod, + ic_rn_env = emptyRdrEnv, + ic_type_env = emptyTypeEnv } + +defaultCurrentModuleName = mkModuleName "Prelude" +GLOBAL_VAR(defaultCurrentModule, error "no defaultCurrentModule", Module) + -- CM internal types type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really) emptyUI :: UnlinkedImage @@ -133,35 +130,248 @@ type ModuleGraph = [ModSummary] -- the module graph, topologically sorted emptyMG :: ModuleGraph emptyMG = [] -\end{code} +----------------------------------------------------------------------------- +-- Produce an initial CmState. -Unload the compilation manager's state: everything it knows about the -current collection of modules in the Home package. +cmInit :: GhciMode -> IO CmState +cmInit mode = do + prel <- moduleNameToModule defaultCurrentModuleName + writeIORef defaultCurrentModule prel + emptyCmState mode prel -\begin{code} -cmUnload :: CmState -> IO CmState -cmUnload state +----------------------------------------------------------------------------- +-- 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 -> IO CmState +cmSetContext cmstate str + = do let mn = mkModuleName str + modules_loaded = [ (name_of_summary s, ms_mod s) | s <- mg cmstate ] + + m <- case lookup mn modules_loaded of + Just m -> return m + Nothing -> do + mod <- moduleNameToModule mn + if isHomeModule mod + then throwDyn (CmdLineError (showSDoc + (quotes (ppr (moduleName mod)) + <+> text "is not currently loaded"))) + else return mod + + return cmstate{ ic = (ic cmstate){ic_module=m} } + +cmGetContext :: CmState -> IO String +cmGetContext cmstate = return (moduleUserString (ic_module (ic cmstate))) + +moduleNameToModule :: ModuleName -> IO Module +moduleNameToModule mn + = do maybe_stuff <- findModule mn + case maybe_stuff of + Nothing -> throwDyn (CmdLineError ("can't find module `" + ++ moduleNameUserString mn ++ "'")) + Just (m,_) -> return m + +----------------------------------------------------------------------------- +-- 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. + +#ifdef GHCI +cmInfoThing :: CmState -> DynFlags -> String + -> IO (CmState, PrintUnqualified, [TyThing]) +cmInfoThing cmstate dflags id + = do (new_pcs, things) <- hscThing dflags hst hit pcs icontext id + return (cmstate{ pcs=new_pcs }, unqual, things) + where + CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate + unqual = getUnqual pcs hit icontext +#endif + +----------------------------------------------------------------------------- +-- cmRunStmt: Run a statement/expr. + +#ifdef GHCI +cmRunStmt :: CmState -> DynFlags -> String + -> IO (CmState, -- new state + [Name]) -- names bound by this evaluation +cmRunStmt cmstate dflags expr + = do + let InteractiveContext { + ic_rn_env = rn_env, + ic_type_env = type_env, + ic_module = this_mod } = icontext + + (new_pcs, maybe_stuff) + <- hscStmt dflags hst hit pcs icontext expr False{-stmt-} + + case maybe_stuff of + Nothing -> return (cmstate{ pcs=new_pcs }, []) + Just (ids, _, bcos) -> do + + -- update the interactive context + let + names = map idName ids + + -- these names have just been shadowed + shadowed = [ n | r <- map nameRdrName names, + Just n <- [lookupRdrEnv rn_env r] ] + + new_rn_env = extendLocalRdrEnv rn_env names + + -- remove any shadowed bindings from the type_env + filtered_type_env = delListFromNameEnv type_env shadowed + + new_type_env = extendNameEnvList filtered_type_env + [ (getName id, AnId id) | id <- ids] + + new_ic = icontext { ic_rn_env = new_rn_env, + ic_type_env = new_type_env } + + -- link it + hval <- linkExpr pls bcos + + -- run it! + let thing_to_run = unsafeCoerce# hval :: IO [HValue] + hvals <- thing_to_run + + -- Get the newly bound things, and bind them. Don't forget + -- to delete any shadowed bindings from the closure_env, lest + -- we end up with a space leak. + pls <- delListFromClosureEnv pls shadowed + new_pls <- addListToClosureEnv pls (zip names hvals) + + return (cmstate{ pcs=new_pcs, pls=new_pls, ic=new_ic }, names) + where + CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate +#endif + +----------------------------------------------------------------------------- +-- cmTypeOfExpr: returns a string representing the type of an expression + +#ifdef GHCI +cmTypeOfExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe String) +cmTypeOfExpr cmstate dflags expr + = do (new_pcs, maybe_stuff) + <- hscStmt dflags hst hit pcs ic expr True{-just an expr-} + + let new_cmstate = cmstate{pcs = new_pcs} + + case maybe_stuff of + Nothing -> return (new_cmstate, Nothing) + Just (_, ty, _) -> return (new_cmstate, Just str) + where + str = showSDocForUser unqual (ppr tidy_ty) + unqual = getUnqual pcs hit ic + tidy_ty = tidyType emptyTidyEnv ty + where + CmState{ hst=hst, hit=hit, pcs=pcs, ic=ic } = cmstate +#endif + +getUnqual pcs hit ic + = case lookupIfaceByModName hit pit modname of + Nothing -> alwaysQualify + Just iface -> unQualInScope (mi_globals iface) + where + pit = pcs_PIT pcs + modname = moduleName (ic_module ic) + +----------------------------------------------------------------------------- +-- cmTypeOfName: returns a string representing the type of a name. + +#ifdef GHCI +cmTypeOfName :: CmState -> Name -> IO (Maybe String) +cmTypeOfName CmState{ hit=hit, pcs=pcs, ic=ic } name + = case lookupNameEnv (ic_type_env ic) name of + Nothing -> return Nothing + Just (AnId id) -> return (Just str) + where + unqual = getUnqual pcs hit ic + ty = tidyType emptyTidyEnv (idType id) + str = showSDocForUser unqual (ppr ty) + + _ -> panic "cmTypeOfName" +#endif + +----------------------------------------------------------------------------- +-- cmCompileExpr: compile an expression and deliver an HValue + +#ifdef GHCI +cmCompileExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe HValue) +cmCompileExpr cmstate dflags expr + = do + let InteractiveContext { + ic_rn_env = rn_env, + ic_type_env = type_env, + ic_module = this_mod } = icontext + + (new_pcs, maybe_stuff) + <- hscStmt dflags hst hit pcs icontext + ("let __cmCompileExpr = "++expr) False{-stmt-} + + case maybe_stuff of + Nothing -> return (cmstate{ pcs=new_pcs }, Nothing) + Just (ids, _, bcos) -> do + + -- link it + hval <- linkExpr pls bcos + + -- run it! + let thing_to_run = unsafeCoerce# hval :: IO [HValue] + hvals <- thing_to_run + + case (ids,hvals) of + ([id],[hv]) -> return (cmstate{ pcs=new_pcs }, Just hv) + _ -> panic "cmCompileExpr" + + where + CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate +#endif + +----------------------------------------------------------------------------- +-- cmInfo: return "info" about an expression. The info might be: +-- +-- * its type, for an expression, +-- * the class definition, for a class +-- * the datatype definition, for a tycon (or synonym) +-- * the export list, for a module +-- +-- Can be used to find the type of the last expression compiled, by looking +-- for "it". + +cmInfo :: CmState -> String -> IO (Maybe String) +cmInfo cmstate str + = do error "cmInfo not implemented yet" + +----------------------------------------------------------------------------- +-- Unload the compilation manager's state: everything it knows about the +-- current collection of modules in the Home package. + +cmUnload :: CmState -> DynFlags -> IO CmState +cmUnload state@CmState{ gmode=mode, pls=pls, pcs=pcs } dflags = do -- Throw away the old home dir cache emptyHomeDirCache - -- Throw away the HIT and the HST - return state{ hst=new_hst, hit=new_hit, ui=emptyUI } - where - CmState{ hst=hst, hit=hit } = state - (new_hst, new_hit) = retainInTopLevelEnvs [] (hst,hit) -\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. + -- Unload everything the linker knows about + new_pls <- CmLink.unload mode dflags [] pls + + -- Start with a fresh CmState, but keep the PersistentCompilerState + new_state <- cmInit mode + return new_state{ pcs=pcs, pls=new_pls } + +----------------------------------------------------------------------------- +-- 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 - -> FilePath + -> [FilePath] -> IO (CmState, -- new state Bool, -- was successful - [Module]) -- list of modules loaded + [String]) -- list of modules loaded -cmLoadModule cmstate1 rootname +cmLoadModule cmstate1 rootnames = do -- version 1's are the original, before downsweep let pls1 = pls cmstate1 let pcs1 = pcs cmstate1 @@ -170,21 +380,22 @@ cmLoadModule cmstate1 rootname -- similarly, ui1 is the (complete) set of linkables from -- the previous pass, if any. let ui1 = ui cmstate1 - + let mg1 = mg cmstate1 + let ic1 = ic cmstate1 + let ghci_mode = gmode cmstate1 -- this never changes -- Do the downsweep to reestablish the module graph - -- then generate version 2's by retaining in HIT,HST,UI a - -- stable set S of modules, as defined below. - dflags <- getDynFlags let verb = verbosity dflags showPass dflags "Chasing dependencies" when (verb >= 1 && ghci_mode == Batch) $ - hPutStrLn stderr (progName ++ ": chasing modules from: " ++ rootname) + hPutStrLn stderr (showSDoc (hcat [ + text progName, text ": chasing modules from: ", + hcat (punctuate comma (map text rootnames))])) - (mg2unsorted, a_root_is_Main) <- downsweep [rootname] + (mg2unsorted, a_root_is_Main) <- downsweep rootnames mg1 let mg2unsorted_names = map name_of_summary mg2unsorted -- reachable_from follows source as well as normal imports @@ -200,18 +411,12 @@ cmLoadModule cmstate1 rootname let mg2_with_srcimps = topological_sort True mg2unsorted -- Sort out which linkables we wish to keep in the unlinked image. - -- For each module, we take: - -- - -- - the old in-core linkable, if available - -- - an on-disk linkable, if available - -- - -- and we take the youngest of these, provided it is younger than the - -- source file. - -- - -- 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. - valid_linkables <- getValidLinkables ui1 mg2unsorted + -- See getValidLinkables below for details. + valid_linkables <- getValidLinkables ui1 mg2unsorted_names + mg2_with_srcimps + -- 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 @@ -223,16 +428,24 @@ cmLoadModule cmstate1 rootname -- 1. All home imports of ms are either in ms or S -- 2. A valid linkable exists for each module in ms - stable_mods - <- preUpsweep valid_linkables mg2unsorted_names [] mg2_with_srcimps + stable_mods <- preUpsweep valid_linkables hit1 + mg2unsorted_names [] mg2_with_srcimps let stable_summaries = concatMap (findInSummaries mg2unsorted) stable_mods + stable_linkables + = filter (\m -> linkableModName m `elem` stable_mods) + valid_linkables + when (verb >= 2) $ - putStrLn (showSDoc (text "STABLE MODULES:" + putStrLn (showSDoc (text "Stable modules:" <+> sep (map (text.moduleNameUserString) stable_mods))) + -- unload any modules which aren't going to be re-linked this + -- time around. + pls2 <- CmLink.unload ghci_mode dflags stable_linkables pls1 + -- 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 @@ -283,19 +496,15 @@ cmLoadModule cmstate1 rootname -- Easy; just relink it all. do when (verb >= 2) $ hPutStrLn stderr "Upsweep completely successful." - linkresult - <- link ghci_mode dflags a_root_is_Main ui3 pls1 - case linkresult of - LinkErrs _ _ - -> panic "cmLoadModule: link failed (1)" - LinkOK pls3 - -> do let cmstate3 - = CmState { hst=hst3, hit=hit3, - ui=ui3, mg=modsDone, - gmode=ghci_mode, - pcs=pcs3, pls=pls3 } - return (cmstate3, True, - map ms_mod modsDone) + + -- clean up after ourselves + cleanTempFilesExcept verb (ppFilesFromSummaries modsDone) + + -- link everything together + linkresult <- link ghci_mode dflags a_root_is_Main ui3 pls2 + + cmLoadFinish True linkresult + hst3 hit3 ui3 modsDone ghci_mode pcs3 else -- Tricky. We need to back out the effects of compiling any @@ -307,84 +516,173 @@ cmLoadModule cmstate1 rootname let modsDone_names = map name_of_summary modsDone let mods_to_zap_names - = findPartiallyCompletedCycles modsDone_names mg2_with_srcimps - let (hst4, hit4, ui4) - = removeFromTopLevelEnvs mods_to_zap_names (hst3,hit3,ui3) + = findPartiallyCompletedCycles modsDone_names + mg2_with_srcimps let mods_to_keep - = filter ((`notElem` mods_to_zap_names).name_of_summary) modsDone - let mods_to_keep_names - = map name_of_summary mods_to_keep - -- we could get the relevant linkables by filtering newLis, but - -- it seems easier to drag them out of the updated, cleaned-up UI - let linkables_to_link - = map (unJust "linkables_to_link" . findModuleLinkable_maybe ui4) - mods_to_keep_names - - linkresult <- link ghci_mode dflags False linkables_to_link pls1 - case linkresult of - LinkErrs _ _ - -> panic "cmLoadModule: link failed (2)" - LinkOK pls4 - -> do let cmstate4 - = CmState { hst=hst4, hit=hit4, - ui=ui4, mg=mods_to_keep, - gmode=ghci_mode, pcs=pcs3, pls=pls4 } - return (cmstate4, False, - map ms_mod mods_to_keep) + = filter ((`notElem` mods_to_zap_names).name_of_summary) + modsDone + + let (hst4, hit4, ui4) + = retainInTopLevelEnvs (map name_of_summary mods_to_keep) + (hst3,hit3,ui3) + + -- clean up after ourselves + cleanTempFilesExcept verb (ppFilesFromSummaries mods_to_keep) + + -- link everything together + linkresult <- link ghci_mode dflags False ui4 pls2 + + cmLoadFinish False linkresult + hst4 hit4 ui4 mods_to_keep ghci_mode pcs3 + + +-- Finish up after a cmLoad. + +-- If the link failed, unload everything and return. +cmLoadFinish ok (LinkFailed pls) hst hit ui mods ghci_mode pcs = do + dflags <- getDynFlags + new_pls <- CmLink.unload ghci_mode dflags [] pls + new_state <- cmInit ghci_mode + return (new_state{ pcs=pcs, pls=new_pls }, False, []) + +-- Empty the interactive context and set the module context to the topmost +-- newly loaded module, or the Prelude if none were loaded. +cmLoadFinish ok (LinkOK pls) hst hit ui mods ghci_mode pcs + = do def_mod <- readIORef defaultCurrentModule + let current_mod = case mods of + [] -> def_mod + (x:_) -> ms_mod x + + new_ic = emptyInteractiveContext current_mod + + new_cmstate = CmState{ hst=hst, hit=hit, ui=ui, mg=mods, + gmode=ghci_mode, pcs=pcs, pls=pls, + ic = new_ic } + mods_loaded = map (moduleNameUserString.name_of_summary) mods + + return (new_cmstate, ok, mods_loaded) + +-- used to fish out the preprocess output files for the purposes +-- of cleaning up. +ppFilesFromSummaries summaries + = [ fn | Just fn <- map toPpFile summaries ] + where + toPpFile sum + | hspp /= ml_hs_file loc = hspp + | otherwise = Nothing + where + loc = ms_location sum + hspp = ml_hspp_file loc ----------------------------------------------------------------------------- -- 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. We ignore the on-disk linkables unless all of the dependents +-- of this SCC also have on-disk linkables. +-- +-- 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 - :: [Linkable] -- old linkables - -> [ModSummary] -- all modules in the program - -> IO [Linkable] -- still-valid linkables + :: [Linkable] -- old linkables + -> [ModuleName] -- all home modules + -> [SCC ModSummary] -- all modules in the program, dependency order + -> IO [Linkable] -- still-valid linkables -getValidLinkables old_linkables summaries - = do lis <- mapM (getValidLinkable old_linkables) summaries - return (concat lis) +getValidLinkables old_linkables all_home_mods module_graph + = foldM (getValidLinkablesSCC old_linkables all_home_mods) [] module_graph -getValidLinkable old_linkables summary - = do let mod_name = moduleName (ms_mod summary) - maybe_disk_linkable - <- case ml_obj_file (ms_location summary) of - Nothing -> return Nothing - Just obj_fn -> maybe_getFileLinkable mod_name obj_fn +getValidLinkablesSCC old_linkables all_home_mods new_linkables scc0 + = let + scc = flattenSCC scc0 + scc_names = map name_of_summary scc + home_module m = m `elem` all_home_mods && m `notElem` scc_names + scc_allhomeimps = nub (filter home_module (concatMap ms_imps scc)) + -- NOTE: 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. - -- find an old in-core linkable if we have one. (forget about - -- on-disk linkables for now, we'll check again whether there's - -- one here below, just in case a new one has popped up recently). - let old_linkable = findModuleLinkable_maybe old_linkables mod_name - maybe_old_linkable = - case old_linkable of - Just (LM _ _ ls) | all isInterpretable ls -> old_linkable - _ -> Nothing + has_object m = case findModuleLinkable_maybe new_linkables m of + Nothing -> False + Just l -> isObjectLinkable l - -- The most recent of the old UI linkable or whatever we could - -- find on disk is returned as the linkable if compile - -- doesn't think we need to recompile. - let linkable_list - = case (maybe_old_linkable, maybe_disk_linkable) of - (Nothing, Nothing) -> [] - (Nothing, Just di) -> [di] - (Just ui, Nothing) -> [ui] - (Just ui, Just di) - | linkableTime ui >= linkableTime di -> [ui] - | otherwise -> [di] + objects_allowed = all has_object scc_allhomeimps + in do - -- only linkables newer than the source code are valid - let maybe_src_date = ms_hs_date summary + these_linkables + <- foldM (getValidLinkable old_linkables objects_allowed) [] scc - valid_linkable_list - = case maybe_src_date of - Nothing -> panic "valid_linkable_list" - Just src_date - -> filter (\li -> linkableTime li > src_date) linkable_list + -- 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. + adjusted_linkables + <- if objects_allowed && not (all isObjectLinkable these_linkables) + then foldM (getValidLinkable old_linkables False) [] scc + else return these_linkables - return valid_linkable_list + return (adjusted_linkables ++ new_linkables) +getValidLinkable :: [Linkable] -> Bool -> [Linkable] -> ModSummary + -> IO [Linkable] +getValidLinkable old_linkables objects_allowed new_linkables summary + = do let mod_name = name_of_summary summary + + maybe_disk_linkable + <- if (not objects_allowed) + then return Nothing + else case ml_obj_file (ms_location summary) of + Just obj_fn -> maybe_getFileLinkable mod_name obj_fn + Nothing -> return Nothing + + let old_linkable = findModuleLinkable_maybe old_linkables mod_name + maybe_old_linkable = + case old_linkable of + Just l | not (isObjectLinkable l) || stillThere l + -> old_linkable + -- ToDo: emit a warning if not (stillThere l) + other -> Nothing + + -- make sure that if we had an old disk linkable around, that it's + -- still there on the disk (in case we need to re-link it). + stillThere l = + case maybe_disk_linkable of + Nothing -> False + Just l_disk -> linkableTime l == linkableTime l_disk + + -- we only look for objects on disk the first time around; + -- if the user compiles a module on the side during a GHCi session, + -- it won't be picked up until the next ":load". This is what the + -- "null old_linkables" test below is. + linkable | null old_linkables = maybeToList maybe_disk_linkable + | otherwise = maybeToList maybe_old_linkable + + -- only linkables newer than the source code are valid + src_date = ms_hs_date summary + + valid_linkable + = filter (\l -> linkableTime l >= src_date) linkable + -- 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 (valid_linkable ++ new_linkables) + maybe_getFileLinkable :: ModuleName -> FilePath -> IO (Maybe Linkable) maybe_getFileLinkable mod_name obj_fn @@ -403,20 +701,22 @@ maybe_getFileLinkable mod_name obj_fn ----------------------------------------------------------------------------- -- Do a pre-upsweep without use of "compile", to establish a --- (downward-closed) set of stable modules which can be retained --- in the top-level environments. Also return linkables for those --- modules determined to be stable, since (in Batch mode, at least) --- there's no other way for them to get into UI. +-- (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 HIT (interactive mode only) -preUpsweep :: [Linkable] -- valid linkables +preUpsweep :: [Linkable] -- new valid linkables + -> HomeIfaceTable -> [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) +preUpsweep valid_lis hit all_home_mods stable [] = return stable +preUpsweep valid_lis hit all_home_mods stable (scc0:sccs) = do let scc = flattenSCC scc0 scc_allhomeimps :: [ModuleName] scc_allhomeimps @@ -426,21 +726,23 @@ preUpsweep valid_lis all_home_mods stable (scc0:sccs) scc_names = map name_of_summary scc in_stable_or_scc m - = --trace (showSDoc (text "ISOS" <+> ppr m <+> ppr scc_names <+> ppr stable)) ( - m `elem` scc_names || m `elem` stable - --) - all_scc_stable - <- if not all_imports_in_scc_or_stable - then do --putStrLn ("PART1 fail " ++ showSDoc (ppr scc_allhomeimps <+> ppr (filter (not.in_stable_or_scc) scc_allhomeimps))) - return False - else do --when (not (and bools)) (putStrLn ("PART2 fail: " ++ showSDoc (ppr scc_names))) - return (all is_stable scc) - if not all_scc_stable - then preUpsweep valid_lis all_home_mods stable sccs - else preUpsweep valid_lis all_home_mods (scc_names++stable) sccs - - where is_stable new_summary - = isJust (findModuleLinkable_maybe valid_lis (name_of_summary new_summary)) + = 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 = name_of_summary new_summary + + has_interface summary = ms_mod summary `elemUFM` hit + + scc_is_stable = all_imports_in_scc_or_stable + && all has_valid_linkable scc + && all has_interface scc + + if scc_is_stable + then preUpsweep valid_lis hit all_home_mods (scc_names++stable) sccs + else preUpsweep valid_lis hit all_home_mods stable sccs -- Helper for preUpsweep. Assuming that new_summary's imports are all @@ -450,6 +752,11 @@ findInSummaries :: [ModSummary] -> ModuleName -> [ModSummary] findInSummaries old_summaries mod_name = [s | s <- old_summaries, name_of_summary 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. @@ -480,8 +787,8 @@ add_to_ui ui lis where not_in :: [Linkable] -> Linkable -> Bool not_in lis li - = all (\l -> modname_of_linkable l /= mod) lis - where mod = modname_of_linkable li + = all (\l -> linkableModName l /= mod) lis + where mod = linkableModName li data CmThreaded -- stuff threaded through individual module compilations @@ -542,20 +849,11 @@ upsweep_mod :: GhciMode -> [ModuleName] -> IO (CmThreaded, Maybe Linkable) -upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_from_here +upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me = do let mod_name = name_of_summary summary1 let verb = verbosity dflags - when (verb == 1) $ - if (ghci_mode == Batch) - then hPutStr stderr (progName ++ ": module " - ++ moduleNameUserString mod_name - ++ ": ") - else hPutStr stderr ("Compiling " - ++ moduleNameUserString mod_name - ++ " ... ") - let (CmThreaded pcs1 hst1 hit1) = threaded1 let old_iface = lookupUFM hit1 mod_name @@ -563,50 +861,40 @@ upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_from_here source_unchanged = isJust maybe_old_linkable - (hst1_strictDC, hit1_strictDC) - = retainInTopLevelEnvs - (filter (/= (name_of_summary summary1)) reachable_from_here) - (hst1,hit1) + reachable_only = filter (/= (name_of_summary summary1)) + reachable_inc_me + + -- in interactive mode, all home modules below us *must* have an + -- interface in the HIT. We never demand-load home interfaces in + -- interactive mode. + (hst1_strictDC, hit1_strictDC, []) + = ASSERT(ghci_mode == Batch || + all (`elemUFM` hit1) reachable_only) + retainInTopLevelEnvs reachable_only (hst1,hit1,[]) old_linkable = unJust "upsweep_mod:old_linkable" maybe_old_linkable + have_object + | Just l <- maybe_old_linkable, isObjectLinkable l = True + | otherwise = False + compresult <- compile ghci_mode summary1 source_unchanged - old_iface hst1_strictDC hit1_strictDC pcs1 + have_object old_iface hst1_strictDC hit1_strictDC pcs1 case compresult of - -- Compilation "succeeded", but didn't return a new - -- linkable, meaning that compilation wasn't needed, and the - -- new details were manufactured from the old iface. - CompOK pcs2 new_details new_iface Nothing - -> do let hst2 = addToUFM hst1 mod_name new_details - hit2 = addToUFM hit1 mod_name new_iface - threaded2 = CmThreaded pcs2 hst2 hit2 - - if ghci_mode == Interactive && verb >= 1 then - -- if we're using an object file, tell the user - case maybe_old_linkable of - Just (LM _ _ objs@(DotO _:_)) - -> do hPutStr stderr (showSDoc (space <> - parens (hsep (text "using": - punctuate comma - [ text o | DotO o <- objs ])))) - when (verb > 1) $ hPutStrLn stderr "" - _ -> return () - else - return () - - return (threaded2, Just old_linkable) - - -- Compilation really did happen, and succeeded. A new - -- details, iface and linkable are returned. - CompOK pcs2 new_details new_iface (Just new_linkable) + -- Compilation "succeeded", and may or may not have returned a new + -- linkable (depending on whether compilation was actually performed + -- or not). + CompOK pcs2 new_details new_iface maybe_new_linkable -> do let hst2 = addToUFM hst1 mod_name new_details hit2 = addToUFM hit1 mod_name new_iface threaded2 = CmThreaded pcs2 hst2 hit2 - return (threaded2, Just new_linkable) + return (threaded2, if isJust maybe_new_linkable + then maybe_new_linkable + else Just old_linkable) -- Compilation failed. compile may still have updated -- the PCS, tho. @@ -614,22 +902,14 @@ upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_from_here -> do let threaded2 = CmThreaded pcs2 hst1 hit1 return (threaded2, Nothing) --- Remove unwanted modules from the top level envs (HST, HIT, UI). -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 - ) - +-- Filter modules in the top level envs (HST, HIT, UI). retainInTopLevelEnvs :: [ModuleName] - -> (HomeSymbolTable, HomeIfaceTable) - -> (HomeSymbolTable, HomeIfaceTable) -retainInTopLevelEnvs keep_these (hst, hit) + -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage) + -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage) +retainInTopLevelEnvs keep_these (hst, hit, ui) = (retainInUFM hst keep_these, - retainInUFM hit keep_these + retainInUFM hit keep_these, + filterModuleLinkables (`elem` keep_these) ui ) where retainInUFM :: Uniquable key => UniqFM elt -> [key] -> UniqFM elt @@ -642,13 +922,16 @@ retainInTopLevelEnvs keep_these (hst, hit) downwards_closure_of_module :: [ModSummary] -> ModuleName -> [ModuleName] downwards_closure_of_module summaries root = let toEdge :: ModSummary -> (ModuleName,[ModuleName]) - toEdge summ = (name_of_summary summ, ms_allimps summ) - res = simple_transitive_closure (map toEdge summaries) [root] + toEdge summ = (name_of_summary summ, + filter (`elem` all_mods) (ms_allimps summ)) + + all_mods = map name_of_summary summaries + + res = simple_transitive_closure (map toEdge summaries) [root] in - --trace (showSDoc (text "DC of mod" <+> ppr root - -- <+> text "=" <+> ppr res)) ( +-- 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] @@ -692,64 +975,68 @@ topological_sort include_source_imports summaries -- for all home modules encountered. Only follow source-import -- links. Also returns a Bool to indicate whether any of the roots -- are module Main. -downsweep :: [FilePath] -> IO ([ModSummary], Bool) -downsweep rootNm +downsweep :: [FilePath] -> [ModSummary] -> IO ([ModSummary], Bool) +downsweep rootNm old_summaries = do rootSummaries <- mapM getRootSummary rootNm let a_root_is_Main = any ((=="Main").moduleNameUserString.name_of_summary) rootSummaries all_summaries - <- loop (filter (isHomeModule.ms_mod) rootSummaries) + <- loop (concat (map ms_imps rootSummaries)) + (mkModuleEnv [ (mod, s) | s <- rootSummaries, + let mod = ms_mod s, isHomeModule mod + ]) return (all_summaries, a_root_is_Main) where getRootSummary :: FilePath -> IO ModSummary getRootSummary file - | haskellish_file file + | haskellish_src_file file = do exists <- doesFileExist file if exists then summariseFile file else do - throwDyn (OtherError ("can't find file `" ++ file ++ "'")) + 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 - getSummary (mkModuleName file) + let mod_name = mkModuleName file + maybe_summary <- getSummary mod_name + case maybe_summary of + Nothing -> packageModErr mod_name + Just s -> return s where hs_file = file ++ ".hs" lhs_file = file ++ ".lhs" - getSummary :: ModuleName -> IO ModSummary + getSummary :: ModuleName -> IO (Maybe ModSummary) getSummary nm - -- | trace ("getSummary: "++ showSDoc (ppr nm)) True = do found <- findModule nm case found of - -- Be sure not to use the mod and location passed in to - -- summarise for any other purpose -- summarise may change - -- the module names in them if name of module /= name of file, - -- and put the changed versions in the returned summary. - -- These will then conflict with the passed-in versions. - Just (mod, location) -> summarise mod location - Nothing -> throwDyn (OtherError + Just (mod, location) -> do + let old_summary = findModInSummaries old_summaries mod + summarise mod location old_summary + + Nothing -> throwDyn (CmdLineError ("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 = (nub . concatMap ms_imps) 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 (isHomeModule.ms_mod) neededSummaries - if null newHomeSummaries - then return homeSummaries - else loop (newHomeSummaries ++ homeSummaries) + -- loop invariant: env doesn't contain package modules + loop :: [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)) 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 ms_imps new_home_summaries) + loop new_imps (extendModuleEnvList env + [ (ms_mod s, s) | s <- new_home_summaries ]) ----------------------------------------------------------------------------- -- Summarising modules @@ -767,56 +1054,68 @@ downsweep rootNm summariseFile :: FilePath -> IO ModSummary summariseFile file = do hspp_fn <- preprocess file - modsrc <- readFile hspp_fn + (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn - let (srcimps,imps,mod_name) = getImports modsrc - (path, basename, ext) = splitFilename3 file + let (path, basename, ext) = splitFilename3 file - Just (mod, location) - <- mkHomeModuleLocn mod_name (path ++ '/':basename) file - - maybe_src_timestamp + (mod, location) + <- mkHomeModuleLocn mod_name (path ++ '/':basename) (Just file) + + src_timestamp <- case ml_hs_file location of - Nothing -> return Nothing - Just src_fn -> maybe_getModificationTime src_fn + Nothing -> noHsFileErr mod_name + Just src_fn -> getModificationTime src_fn return (ModSummary mod location{ml_hspp_file=Just hspp_fn} - srcimps imps - maybe_src_timestamp) + srcimps imps src_timestamp) --- Summarise a module, and pick up source and interface timestamps. -summarise :: Module -> ModuleLocation -> IO ModSummary -summarise mod location - | isHomeModule mod +-- Summarise a module, and pick up source and timestamp. +summarise :: Module -> ModuleLocation -> Maybe ModSummary + -> IO (Maybe ModSummary) +summarise mod location old_summary + | not (isHomeModule mod) = return Nothing + | otherwise = do let hs_fn = unJust "summarise" (ml_hs_file location) + + case ml_hs_file location of { + Nothing -> do { + dflags <- getDynFlags; + when (verbosity dflags >= 1) $ + hPutStrLn stderr ("WARNING: module `" ++ + moduleUserString mod ++ "' has no source file."); + return Nothing; + }; + + 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 - modsrc <- readFile hspp_fn - let (srcimps,imps,mod_name) = getImports modsrc + (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn - maybe_src_timestamp - <- case ml_hs_file location of - Nothing -> return Nothing - Just src_fn -> maybe_getModificationTime src_fn + when (mod_name /= moduleName mod) $ + throwDyn (ProgramError + (showSDoc (text hs_fn + <> text ": file name does not match module name" + <+> quotes (ppr (moduleName mod))))) - if mod_name == moduleName mod - then return () - else throwDyn (OtherError - (showSDoc (text "file name does not match module name: " - <+> ppr (moduleName mod) <+> text "vs" - <+> ppr mod_name))) + return (Just (ModSummary mod location{ml_hspp_file=Just hspp_fn} + srcimps imps src_timestamp)) + } + } - return (ModSummary mod location{ml_hspp_file=Just hspp_fn} - srcimps imps - maybe_src_timestamp) - | otherwise - = return (ModSummary mod location [] [] Nothing) - -maybe_getModificationTime :: FilePath -> IO (Maybe ClockTime) -maybe_getModificationTime fn - = (do time <- getModificationTime fn - return (Just time)) - `catch` - (\err -> return Nothing) +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"))) \end{code}