X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FcompMan%2FCompManager.lhs;h=2e56d3779485a08f6859c3274ef0f2f760133cc9;hb=2cc5b907318f97e19b28b2ad8ed9ff8c1f401dcc;hp=8d711b20a1efd723ac92927e9cfac86324fac1c8;hpb=85c61e765ba330c71ba872e2c54c3b76d76adf5b;p=ghc-hetmet.git diff --git a/ghc/compiler/compMan/CompManager.lhs b/ghc/compiler/compMan/CompManager.lhs index 8d711b2..2e56d37 100644 --- a/ghc/compiler/compMan/CompManager.lhs +++ b/ghc/compiler/compMan/CompManager.lhs @@ -1,82 +1,116 @@ % -% (c) The University of Glasgow, 2000 +% (c) The University of Glasgow, 2002 +% +% The Compilation Manager % -\section[CompManager]{The Compilation Manager} - \begin{code} +{-# OPTIONS -fvia-C #-} module CompManager ( - cmInit, -- :: GhciMode -> IO CmState + ModuleGraph, - cmLoadModule, -- :: CmState -> FilePath -> IO (CmState, [String]) + CmState, emptyCmState, -- abstract - cmUnload, -- :: CmState -> IO CmState + cmInit, -- :: GhciMode -> IO CmState - cmSetContext, -- :: CmState -> String -> IO CmState + cmDepAnal, -- :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph - cmGetContext, -- :: CmState -> IO String + cmLoadModules, -- :: CmState -> DynFlags -> ModuleGraph + -- -> IO (CmState, [String]) + + cmUnload, -- :: CmState -> DynFlags -> IO CmState #ifdef GHCI - cmRunStmt, -- :: CmState -> DynFlags -> String -> IO (CmState, [Name]) + cmModuleIsInterpreted, -- :: CmState -> String -> IO Bool + + cmSetContext, -- :: CmState -> DynFlags -> [String] -> [String] -> IO CmState + cmGetContext, -- :: CmState -> IO ([String],[String]) + + cmInfoThing, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, [(TyThing,Fixity)]) + + cmBrowseModule, -- :: CmState -> IO [TyThing] + + CmRunResult(..), + cmRunStmt, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, CmRunResult) + + cmTypeOfExpr, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe String) - cmTypeOfExpr, -- :: CmState -> DynFlags -> String - -- -> IO (CmState, Maybe String) + cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) - cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) + HValue, + cmCompileExpr, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe HValue) - cmCompileExpr,-- :: CmState -> DynFlags -> String - -- -> IO (CmState, Maybe HValue)#endif + cmGetModuleGraph, -- :: CmState -> ModuleGraph + cmGetLinkables, -- :: CmState -> [Linkable] + + cmGetBindings, -- :: CmState -> [TyThing] + cmGetPrintUnqual, -- :: CmState -> PrintUnqualified #endif - CmState, emptyCmState -- abstract + + -- utils + showModMsg, -- ) where #include "HsVersions.h" +import MkIface --tmp +import HsSyn -- tmp + import CmLink import CmTypes +import DriverPipeline +import DriverState ( v_Output_file ) +import DriverPhases +import DriverUtil +import Finder +#ifdef GHCI +import HscMain ( initPersistentCompilerState, hscThing, + hscModuleContents ) +#else +import HscMain ( initPersistentCompilerState ) +#endif import HscTypes -import RnEnv ( unQualInScope ) -import Id ( idType, idName ) -import Name ( Name, lookupNameEnv, extendNameEnvList, - NamedThing(..) ) +import Name ( Name, NamedThing(..), nameRdrName, nameModule, + isHomePackageName, isGlobalName ) +import NameEnv +import Rename ( mkGlobalContext ) import RdrName ( emptyRdrEnv ) -import Module ( Module, ModuleName, moduleName, isHomeModule, - mkModuleName, moduleNameUserString, moduleUserString ) -import CmStaticInfo ( GhciMode(..) ) -import DriverPipeline +import Module import GetImports -import Type ( tidyType ) -import VarEnv ( emptyTidyEnv ) -import HscTypes -import HscMain ( initPersistentCompilerState ) -import Finder -import UniqFM ( lookupUFM, addToUFM, delListFromUFM, - UniqFM, listToUFM ) +import UniqFM import Unique ( Uniquable ) -import Digraph ( SCC(..), stronglyConnComp, flattenSCC ) -import DriverFlags ( getDynFlags ) -import DriverPhases -import DriverUtil ( splitFilename3 ) +import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs ) import ErrUtils ( showPass ) +import SysTools ( cleanTempFilesExcept ) import Util -import DriverUtil -import TmpFiles import Outputable import Panic -import CmdLineOpts ( DynFlags(..) ) +import CmdLineOpts ( DynFlags(..), getDynFlags ) + import IOExts #ifdef GHCI +import RdrName ( lookupRdrEnv ) +import Id ( idType, idName ) +import Type ( tidyType ) +import VarEnv ( emptyTidyEnv ) +import BasicTypes ( Fixity, defaultFixity ) import Interpreter ( HValue ) import HscMain ( hscStmt ) -import PrelGHC ( unsafeCoerce# ) +import GlaExts ( unsafeCoerce# ) +import Foreign +import CForeign +import Exception ( Exception, try ) #endif -- lang import Exception ( throwDyn ) -- std -import Time ( ClockTime ) import Directory ( getModificationTime, doesFileExist ) import IO import Monad @@ -100,8 +134,8 @@ data CmState pls :: PersistentLinkerState -- link's persistent state } -emptyCmState :: GhciMode -> Module -> IO CmState -emptyCmState gmode mod +emptyCmState :: GhciMode -> IO CmState +emptyCmState gmode = do pcs <- initPersistentCompilerState pls <- emptyPLS return (CmState { hst = emptySymbolTable, @@ -109,18 +143,18 @@ emptyCmState gmode mod ui = emptyUI, mg = emptyMG, gmode = gmode, - ic = emptyInteractiveContext mod, + ic = emptyInteractiveContext, pcs = pcs, pls = pls }) -emptyInteractiveContext mod - = InteractiveContext { ic_module = mod, - ic_rn_env = emptyRdrEnv, +emptyInteractiveContext + = InteractiveContext { ic_toplev_scope = [], + ic_exports = [], + ic_rn_gbl_env = emptyRdrEnv, + ic_print_unqual = alwaysQualify, + ic_rn_local_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 @@ -134,92 +168,223 @@ emptyMG = [] -- Produce an initial CmState. cmInit :: GhciMode -> IO CmState -cmInit mode = do - prel <- moduleNameToModule defaultCurrentModuleName - writeIORef defaultCurrentModule prel - emptyCmState mode prel +cmInit mode = emptyCmState mode + +----------------------------------------------------------------------------- +-- Grab information from the CmState + +cmGetModuleGraph = mg +cmGetLinkables = ui + +cmGetBindings cmstate = nameEnvElts (ic_type_env (ic cmstate)) +cmGetPrintUnqual cmstate = ic_print_unqual (ic cmstate) ----------------------------------------------------------------------------- -- 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 (OtherError (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 (OtherError ("can't find module `" - ++ moduleNameUserString mn ++ "'")) - Just (m,_) -> return m +cmSetContext + :: CmState -> DynFlags + -> [String] -- take the top-level scopes of these modules + -> [String] -- and the just the exports from these + -> IO CmState +cmSetContext cmstate dflags toplevs exports = do + let CmState{ hit=hit, hst=hst, pcs=pcs, ic=old_ic } = cmstate + + toplev_mods <- mapM (getTopLevModule hit) (map mkModuleName toplevs) + export_mods <- mapM (moduleNameToModule hit) (map mkModuleName exports) + + (new_pcs, print_unqual, maybe_env) + <- mkGlobalContext dflags hit hst pcs toplev_mods export_mods + + case maybe_env of + Nothing -> return cmstate + Just env -> return cmstate{ pcs = new_pcs, + ic = old_ic{ ic_toplev_scope = toplev_mods, + ic_exports = export_mods, + ic_rn_gbl_env = env, + ic_print_unqual = print_unqual } } + +getTopLevModule hit mn = + case lookupModuleEnvByName hit mn of + Just iface + | Just _ <- mi_globals iface -> return (mi_module iface) + _other -> throwDyn (CmdLineError ( + "cannot enter the top-level scope of a compiled module (module `" ++ + moduleNameUserString mn ++ "')")) + +moduleNameToModule :: HomeIfaceTable -> ModuleName -> IO Module +moduleNameToModule hit mn = do + case lookupModuleEnvByName hit mn of + Just iface -> return (mi_module iface) + _not_a_home_module -> do + maybe_stuff <- findModule mn + case maybe_stuff of + Nothing -> throwDyn (CmdLineError ("can't find module `" + ++ moduleNameUserString mn ++ "'")) + Just (m,_) -> return m + +cmGetContext :: CmState -> IO ([String],[String]) +cmGetContext CmState{ic=ic} = + return (map moduleUserString (ic_toplev_scope ic), + map moduleUserString (ic_exports ic)) + +cmModuleIsInterpreted :: CmState -> String -> IO Bool +cmModuleIsInterpreted cmstate str + = case lookupModuleEnvByName (hit cmstate) (mkModuleName str) of + Just iface -> return (not (isNothing (mi_globals iface))) + _not_a_home_module -> return False + +----------------------------------------------------------------------------- +-- 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, [(TyThing,Fixity)]) +cmInfoThing cmstate dflags id + = do (new_pcs, things) <- hscThing dflags hst hit pcs icontext id + let pairs = map (\x -> (x, getFixity new_pcs (getName x))) things + return (cmstate{ pcs=new_pcs }, pairs) + where + CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate + + getFixity :: PersistentCompilerState -> Name -> Fixity + getFixity pcs name + | isGlobalName name, + Just iface <- lookupModuleEnv iface_table (nameModule name), + Just fixity <- lookupNameEnv (mi_fixities iface) name + = fixity + | otherwise + = defaultFixity + where iface_table | isHomePackageName name = hit + | otherwise = pcs_PIT pcs +#endif + +-- --------------------------------------------------------------------------- +-- cmBrowseModule: get all the TyThings defined in a module + +#ifdef GHCI +cmBrowseModule :: CmState -> DynFlags -> String -> Bool + -> IO (CmState, [TyThing]) +cmBrowseModule cmstate dflags str exports_only = do + let mn = mkModuleName str + mod <- moduleNameToModule hit mn + (pcs1, maybe_ty_things) + <- hscModuleContents dflags hst hit pcs mod exports_only + case maybe_ty_things of + Nothing -> return (cmstate{pcs=pcs1}, []) + Just ty_things -> return (cmstate{pcs=pcs1}, ty_things) + where + CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate +#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 +data CmRunResult + = CmRunOk [Name] -- names bound by this evaluation + | CmRunFailed + | CmRunException Exception -- statement raised an exception + +cmRunStmt :: CmState -> DynFlags -> String -> IO (CmState, CmRunResult) +cmRunStmt cmstate@CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } + dflags expr = do let InteractiveContext { - ic_rn_env = rn_env, - ic_type_env = type_env, - ic_module = this_mod } = icontext + ic_rn_local_env = rn_env, + ic_type_env = type_env } = icontext (new_pcs, maybe_stuff) - <- hscStmt dflags hst hit pcs icontext expr + <- hscStmt dflags hst hit pcs icontext expr False{-stmt-} case maybe_stuff of - Nothing -> return (cmstate{ pcs=new_pcs }, []) - Just (ids, bcos) -> do + Nothing -> return (cmstate{ pcs=new_pcs }, CmRunFailed) + Just (ids, _, bcos) -> do -- update the interactive context let - new_rn_env = extendLocalRdrEnv rn_env (map idName ids) + 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 - -- Extend the renamer-env from bound_ids, not - -- bound_names, because the latter may contain - -- [it] when the former is empty - new_type_env = extendNameEnvList type_env + -- 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 } + new_ic = icontext { ic_rn_local_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 - let names = map idName ids - new_pls <- updateClosureEnv 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 + either_hvals <- sandboxIO thing_to_run + case either_hvals of + Left err + -> do hPutStrLn stderr ("unknown failure, code " ++ show err) + return ( cmstate{ pcs=new_pcs, ic=new_ic }, CmRunFailed ) + + Right maybe_hvals -> + case maybe_hvals of + Left e -> + return ( cmstate{ pcs=new_pcs, ic=new_ic }, + CmRunException e ) + Right hvals -> do + -- 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 }, + 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 Int (Either Exception a)) +sandboxIO thing = do + r <- Exception.try thing + return (Right r) + +{- +-- 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. + +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! +-} #endif ----------------------------------------------------------------------------- @@ -228,12 +393,20 @@ cmRunStmt cmstate dflags expr #ifdef GHCI cmTypeOfExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe String) cmTypeOfExpr cmstate dflags expr - = do (new_cmstate, names) - <- cmRunStmt cmstate dflags ("let __cmTypeOfExpr=" ++ expr) - case names of - [name] -> do maybe_tystr <- cmTypeOfName new_cmstate name - return (new_cmstate, maybe_tystr) - _other -> pprPanic "cmTypeOfExpr" (ppr names) + = 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 = ic_print_unqual ic + tidy_ty = tidyType emptyTidyEnv ty + where + CmState{ hst=hst, hit=hit, pcs=pcs, ic=ic } = cmstate #endif ----------------------------------------------------------------------------- @@ -244,15 +417,11 @@ 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) -> - let pit = pcs_PIT pcs - modname = moduleName (ic_module ic) - ty = tidyType emptyTidyEnv (idType id) - str = case lookupIfaceByModName hit pit modname of - Nothing -> showSDoc (ppr ty) - Just iface -> showSDocForUser unqual (ppr ty) - where unqual = unQualInScope (mi_globals iface) - in return (Just str) + Just (AnId id) -> return (Just str) + where + unqual = ic_print_unqual ic + ty = tidyType emptyTidyEnv (idType id) + str = showSDocForUser unqual (ppr ty) _ -> panic "cmTypeOfName" #endif @@ -265,17 +434,16 @@ 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 + ic_rn_local_env = rn_env, + ic_type_env = type_env } = icontext (new_pcs, maybe_stuff) <- hscStmt dflags hst hit pcs icontext - ("let __cmCompileExpr="++expr) + ("let __cmCompileExpr = "++expr) False{-stmt-} case maybe_stuff of Nothing -> return (cmstate{ pcs=new_pcs }, Nothing) - Just (ids, bcos) -> do + Just (ids, _, bcos) -> do -- link it hval <- linkExpr pls bcos @@ -293,46 +461,50 @@ cmCompileExpr cmstate dflags expr #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 -> IO CmState -cmUnload state +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) + + -- 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 } + + +----------------------------------------------------------------------------- +-- Trace dependency graph + +-- This is a seperate pass so that the caller can back off and keep +-- the current state if the downsweep fails. + +cmDepAnal :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph +cmDepAnal cmstate dflags rootnames + = do showPass dflags "Chasing dependencies" + when (verbosity dflags >= 1 && gmode cmstate == Batch) $ + hPutStrLn stderr (showSDoc (hcat [ + text progName, text ": chasing modules from: ", + hcat (punctuate comma (map text rootnames))])) + downsweep rootnames (mg cmstate) ----------------------------------------------------------------------------- -- 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. -cmLoadModule :: CmState - -> FilePath +cmLoadModules :: CmState + -> DynFlags + -> ModuleGraph -> IO (CmState, -- new state Bool, -- was successful [String]) -- list of modules loaded -cmLoadModule cmstate1 rootname +cmLoadModules cmstate1 dflags mg2unsorted = do -- version 1's are the original, before downsweep let pls1 = pls cmstate1 let pcs1 = pcs cmstate1 @@ -341,24 +513,18 @@ 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) + -- Find out if we have a Main module + let a_root_is_Main + = any ((=="Main").moduleNameUserString.modSummaryName) + mg2unsorted - (mg2unsorted, a_root_is_Main) <- downsweep [rootname] mg1 - let mg2unsorted_names = map name_of_summary mg2unsorted + let mg2unsorted_names = map modSummaryName mg2unsorted -- reachable_from follows source as well as normal imports let reachable_from :: ModuleName -> [ModuleName] @@ -374,8 +540,17 @@ cmLoadModule cmstate1 rootname -- Sort out which linkables we wish to keep in the unlinked image. -- See getValidLinkables below for details. - valid_linkables <- getValidLinkables ui1 mg2unsorted_names - mg2_with_srcimps + (valid_old_linkables, new_linkables) + <- getValidLinkables ui1 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 hit2 = delListFromUFM hit1 (map linkableModName new_linkables) + + -- 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 @@ -385,25 +560,28 @@ cmLoadModule cmstate1 rootname -- 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 linkable exists for each module in ms + -- 2. A valid old linkable exists for each module in ms - stable_mods - <- preUpsweep valid_linkables mg2unsorted_names [] mg2_with_srcimps + 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_linkables + valid_old_linkables when (verb >= 2) $ putStrLn (showSDoc (text "Stable modules:" <+> sep (map (text.moduleNameUserString) stable_mods))) - -- unload any modules which aren't going to be re-linked this + -- unload any modules which are going to be re-linked this -- time around. - pls2 <- unload ghci_mode dflags stable_linkables pls1 + pls2 <- CmLink.unload ghci_mode dflags stable_linkables pls1 + + -- 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 @@ -411,7 +589,7 @@ cmLoadModule cmstate1 rootname -- done before the upsweep is abandoned. let upsweep_these = filter (\scc -> any (`notElem` stable_mods) - (map name_of_summary (flattenSCC scc))) + (map modSummaryName (flattenSCC scc))) mg2 --hPutStrLn stderr "after tsort:\n" @@ -425,11 +603,15 @@ cmLoadModule cmstate1 rootname -- Now do the upsweep, calling compile for each module in -- turn. Final result is version 3 of everything. - let threaded2 = CmThreaded pcs1 hst1 hit1 + let threaded2 = CmThreaded pcs1 hst1 hit2 + + -- clean up between compilations + let cleanup = cleanTempFilesExcept verb + (ppFilesFromSummaries (flattenSCCs upsweep_these)) (upsweep_complete_success, threaded3, modsUpswept, newLis) <- upsweep_mods ghci_mode dflags valid_linkables reachable_from - threaded2 upsweep_these + threaded2 cleanup upsweep_these let ui3 = add_to_ui valid_linkables newLis let (CmThreaded pcs3 hst3 hit3) = threaded3 @@ -459,6 +641,13 @@ cmLoadModule cmstate1 rootname -- clean up after ourselves cleanTempFilesExcept verb (ppFilesFromSummaries modsDone) + -- issue a warning for the confusing case where the user said '-o foo' + -- but we're not going to do any linking. + ofile <- readIORef v_Output_file + when (ghci_mode == Batch && isJust ofile && not a_root_is_Main + && verb > 0) $ + hPutStrLn stderr "Warning: output was redirected with -o, but no output will be generated\nbecause there is no Main module." + -- link everything together linkresult <- link ghci_mode dflags a_root_is_Main ui3 pls2 @@ -473,17 +662,18 @@ cmLoadModule cmstate1 rootname hPutStrLn stderr "Upsweep partially successful." let modsDone_names - = map name_of_summary modsDone + = map modSummaryName modsDone let mods_to_zap_names = findPartiallyCompletedCycles modsDone_names mg2_with_srcimps - let (hst4, hit4, ui4) - = removeFromTopLevelEnvs mods_to_zap_names (hst3,hit3,ui3) - let mods_to_keep - = filter ((`notElem` mods_to_zap_names).name_of_summary) + = filter ((`notElem` mods_to_zap_names).modSummaryName) modsDone + let (hst4, hit4, ui4) + = retainInTopLevelEnvs (map modSummaryName mods_to_keep) + (hst3,hit3,ui3) + -- clean up after ourselves cleanTempFilesExcept verb (ppFilesFromSummaries mods_to_keep) @@ -495,36 +685,39 @@ cmLoadModule cmstate1 rootname -- Finish up after a cmLoad. --- --- Empty the interactive context and set the module context to the topmost --- newly loaded module, or the Prelude if none were loaded. -cmLoadFinish ok linkresult hst hit ui mods ghci_mode pcs - = do case linkresult of { - LinkErrs _ _ -> panic "cmLoadModule: link failed (2)"; - LinkOK pls -> do - def_mod <- readIORef defaultCurrentModule - let current_mod = case mods of - [] -> def_mod - (x:_) -> ms_mod x +-- 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, []) - 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 +-- 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 let new_cmstate = CmState{ hst=hst, hit=hit, ui=ui, mg=mods, + gmode=ghci_mode, pcs=pcs, pls=pls, + ic = emptyInteractiveContext } + mods_loaded = map (moduleNameUserString.modSummaryName) 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 (ml_hspp_file . ms_location) 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 +-- getValidLin -- For each module (or SCC of modules), we take: -- @@ -547,89 +740,112 @@ getValidLinkables :: [Linkable] -- old linkables -> [ModuleName] -- all home modules -> [SCC ModSummary] -- all modules in the program, dependency order - -> IO [Linkable] -- still-valid linkables + -> IO ( [Linkable], -- still-valid linkables + [Linkable] -- new linkables we just found + ) + +getValidLinkables old_linkables all_home_mods module_graph = do + ls <- foldM (getValidLinkablesSCC 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 -getValidLinkables old_linkables all_home_mods module_graph - = foldM (getValidLinkablesSCC old_linkables all_home_mods) [] module_graph getValidLinkablesSCC old_linkables all_home_mods new_linkables scc0 = let scc = flattenSCC scc0 - scc_names = map name_of_summary scc + 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_allimps scc)) + 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 new_linkables m of - Nothing -> False - Just l -> isObjectLinkable l + has_object m = + case findModuleLinkable_maybe (map fst new_linkables) m of + Nothing -> False + Just l -> isObjectLinkable l objects_allowed = all has_object scc_allhomeimps in do - these_linkables + 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. - adjusted_linkables - <- if objects_allowed && not (all isObjectLinkable these_linkables) - then foldM (getValidLinkable old_linkables False) [] scc - else return these_linkables + new_linkables' <- + if objects_allowed + && not (all isObjectLinkable (map fst new_linkables')) + then foldM (getValidLinkable old_linkables False) [] scc + else return new_linkables' - return (adjusted_linkables ++ new_linkables) + return (new_linkables ++ new_linkables') -getValidLinkable :: [Linkable] -> Bool -> [Linkable] -> ModSummary - -> IO [Linkable] +getValidLinkable :: [Linkable] -> Bool -> [(Linkable,Bool)] -> ModSummary + -> IO [(Linkable,Bool)] + -- True <=> linkable is new getValidLinkable old_linkables objects_allowed new_linkables summary - = do let mod_name = name_of_summary summary + = do let mod_name = modSummaryName summary - -- 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. - maybe_disk_linkable + 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) - | otherwise - -> 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 - - linkable | null old_linkables = maybeToList maybe_disk_linkable - | otherwise = maybeToList maybe_old_linkable - - -- only linkables newer than the source code are valid - maybe_src_date = ms_hs_date summary - - valid_linkable - = case maybe_src_date of - Nothing -> panic "valid_linkable_list" - Just src_date - -> filter (\l -> linkableTime l > src_date) linkable - - return (valid_linkable ++ new_linkables) - + Nothing -> return Nothing + + 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) maybe_getFileLinkable :: ModuleName -> FilePath -> IO (Maybe Linkable) -maybe_getFileLinkable mod_name obj_fn +maybe_getFileLinkable mod obj_fn = do obj_exist <- doesFileExist obj_fn if not obj_exist then return Nothing @@ -639,17 +855,22 @@ maybe_getFileLinkable mod_name obj_fn stub_exist <- doesFileExist stub_fn obj_time <- getModificationTime obj_fn if stub_exist - then return (Just (LM obj_time mod_name [DotO obj_fn, DotO stub_fn])) - else return (Just (LM obj_time mod_name [DotO obj_fn])) + then return (Just (LM obj_time mod [DotO obj_fn, DotO stub_fn])) + else return (Just (LM obj_time mod [DotO obj_fn])) ----------------------------------------------------------------------------- -- 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 HIT (interactive mode only) + preUpsweep :: [Linkable] -- new valid linkables - -> [ModuleName] -- names of all mods encountered in downsweep - -> [ModuleName] -- accumulating stable modules + -> [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 @@ -662,7 +883,7 @@ preUpsweep valid_lis all_home_mods stable (scc0:sccs) all_imports_in_scc_or_stable = all in_stable_or_scc scc_allhomeimps scc_names - = map name_of_summary scc + = map modSummaryName scc in_stable_or_scc m = m `elem` scc_names || m `elem` stable @@ -670,7 +891,7 @@ preUpsweep valid_lis all_home_mods stable (scc0:sccs) -- 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 + where modname = modSummaryName new_summary scc_is_stable = all_imports_in_scc_or_stable && all has_valid_linkable scc @@ -679,15 +900,13 @@ preUpsweep valid_lis all_home_mods stable (scc0:sccs) then preUpsweep valid_lis all_home_mods (scc_names++stable) sccs else preUpsweep valid_lis all_home_mods stable sccs - where - -- 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, name_of_summary s == mod_name] + = [s | s <- old_summaries, modSummaryName s == mod_name] findModInSummaries :: [ModSummary] -> Module -> Maybe ModSummary findModInSummaries old_summaries mod @@ -704,7 +923,7 @@ findPartiallyCompletedCycles modsDone theGraph chew [] = [] chew ((AcyclicSCC v):rest) = chew rest -- acyclic? not interesting. chew ((CyclicSCC vs):rest) - = let names_in_this_cycle = nub (map name_of_summary vs) + = let names_in_this_cycle = nub (map modSummaryName vs) mods_in_this_cycle = nub ([done | done <- modsDone, done `elem` names_in_this_cycle]) @@ -739,6 +958,7 @@ upsweep_mods :: GhciMode -> UnlinkedImage -- valid linkables -> (ModuleName -> [ModuleName]) -- to construct downward closures -> CmThreaded -- PCS & HST & HIT + -> IO () -- how to clean up unwanted tmp files -> [SCC ModSummary] -- mods to do (the worklist) -- ...... RETURNING ...... -> IO (Bool{-complete success?-}, @@ -746,17 +966,17 @@ upsweep_mods :: GhciMode [ModSummary], -- mods which succeeded [Linkable]) -- new linkables -upsweep_mods ghci_mode dflags oldUI reachable_from threaded +upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup [] = return (True, threaded, [], []) -upsweep_mods ghci_mode dflags oldUI reachable_from threaded +upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup ((CyclicSCC ms):_) = do hPutStrLn stderr ("Module imports form a cycle for modules:\n\t" ++ - unwords (map (moduleNameUserString.name_of_summary) ms)) + unwords (map (moduleNameUserString.modSummaryName) ms)) return (False, threaded, [], []) -upsweep_mods ghci_mode dflags oldUI reachable_from threaded +upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup ((AcyclicSCC mod):mods) = do --case threaded of -- CmThreaded pcsz hstz hitz @@ -764,13 +984,17 @@ upsweep_mods ghci_mode dflags oldUI reachable_from threaded (threaded1, maybe_linkable) <- upsweep_mod ghci_mode dflags oldUI threaded mod - (reachable_from (name_of_summary mod)) + (reachable_from (modSummaryName mod)) + + -- remove unwanted tmp files between compilations + cleanup + case maybe_linkable of Just linkable -> -- No errors; do the rest do (restOK, threaded2, modOKs, linkables) <- upsweep_mods ghci_mode dflags oldUI reachable_from - threaded1 mods + threaded1 cleanup mods return (restOK, threaded2, mod:modOKs, linkable:linkables) Nothing -- we got a compilation error; give up now -> return (False, threaded1, [], []) @@ -786,10 +1010,9 @@ 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 + let mod_name = modSummaryName summary1 let (CmThreaded pcs1 hst1 hit1) = threaded1 let old_iface = lookupUFM hit1 mod_name @@ -798,49 +1021,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 (/= (modSummaryName 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 old_linkable of - (LM _ _ objs@(DotO _:_)) - -> do hPutStrLn stderr (showSDoc (space <> - parens (hsep (text "using": - punctuate comma - [ text o | DotO o <- objs ])))) - _ -> 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. @@ -848,22 +1062,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 @@ -876,13 +1082,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 = (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)) ( +-- 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] @@ -902,7 +1111,7 @@ topological_sort include_source_imports summaries = let toEdge :: ModSummary -> (ModSummary,ModuleName,[ModuleName]) toEdge summ - = (summ, name_of_summary summ, + = (summ, modSummaryName summ, (if include_source_imports then ms_srcimps summ else []) ++ ms_imps summ) @@ -922,80 +1131,84 @@ topological_sort include_source_imports summaries sccs +----------------------------------------------------------------------------- +-- Downsweep (dependency analysis) + -- Chase downwards from the specified root set, returning 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] -> [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 +-- 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 all_summaries <- loop (concat (map ms_imps rootSummaries)) - (filter (isHomeModule.ms_mod) rootSummaries) - return (all_summaries, a_root_is_Main) + (mkModuleEnv [ (mod, s) | s <- rootSummaries, + let mod = ms_mod s, isHomeModule mod + ]) + return all_summaries 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 = do found <- findModule nm case found of Just (mod, location) -> do let old_summary = findModInSummaries old_summaries mod - new_summary <- summarise mod location old_summary - case new_summary of - Nothing -> return (fromJust old_summary) - Just s -> return s + summarise mod location old_summary - Nothing -> throwDyn (OtherError + Nothing -> throwDyn (CmdLineError ("can't find module `" ++ showSDoc (ppr nm) ++ "'")) - - -- loop invariant: home_summaries doesn't contain package modules - loop :: [ModuleName] -> [ModSummary] -> IO [ModSummary] - loop [] home_summaries = return home_summaries - loop imps home_summaries - = do -- all modules currently in homeSummaries - let all_home = map (moduleName.ms_mod) home_summaries - -- imports for modules we don't already have - let needed_imps = nub (filter (`notElem` all_home) imps) + -- 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 - = filter (isHomeModule.ms_mod) needed_summaries + 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 (new_home_summaries ++ home_summaries) + loop new_imps (extendModuleEnvList env + [ (ms_mod s, s) | s <- new_home_summaries ]) ----------------------------------------------------------------------------- -- Summarising modules -- We have two types of summarisation: -- --- * Summarise a file. This is used for the root module passed to --- cmLoadModule. The file is read, and used to determine the root +-- * 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 @@ -1005,68 +1218,61 @@ downsweep rootNm old_summaries 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) + (mod, location) <- mkHomeModuleLocn mod_name (path ++ '/':basename) file - - maybe_src_timestamp + + 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 timestamp. -summarise :: Module -> ModuleLocation -> Maybe ModSummary - -> IO (Maybe ModSummary) +summarise :: Module -> ModuleLocation -> Maybe ModSummary + -> IO (Maybe ModSummary) summarise mod location old_summary - | isHomeModule mod + | not (isHomeModule mod) = return Nothing + | otherwise = do let hs_fn = unJust "summarise" (ml_hs_file location) - maybe_src_timestamp - <- case ml_hs_file location of - Nothing -> return Nothing - Just src_fn -> maybe_getModificationTime src_fn + 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 == maybe_src_timestamp -> return Nothing; + 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 - - maybe_src_timestamp - <- case ml_hs_file location of - Nothing -> return Nothing - Just src_fn -> maybe_getModificationTime src_fn + (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn when (mod_name /= moduleName mod) $ - throwDyn (OtherError - (showSDoc (text "file name does not match module name: " - <+> ppr (moduleName mod) <+> text "vs" - <+> ppr mod_name))) + 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 imps - maybe_src_timestamp)) + srcimps imps src_timestamp)) } + } - | otherwise - = return (Just (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}