X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FcompMan%2FCompManager.lhs;h=9f79a16abcd7e682967d62446164dd05378bbcf9;hb=6677029a5084f59b4cd35d76ce3f19b154f2ac87;hp=98c6b65c425849a49b19a28735716165c2161988;hpb=1965e001f7e023563c1d8925c4f75f63989a8720;p=ghc-hetmet.git diff --git a/ghc/compiler/compMan/CompManager.lhs b/ghc/compiler/compMan/CompManager.lhs index 98c6b65..9f79a16 100644 --- a/ghc/compiler/compMan/CompManager.lhs +++ b/ghc/compiler/compMan/CompManager.lhs @@ -1,83 +1,105 @@ % -% (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, ModSummary(..), - cmLoadModule, -- :: CmState -> FilePath -> IO (CmState, [String]) + CmState, emptyCmState, -- abstract - cmUnload, -- :: CmState -> DynFlags -> 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, Bool, [String]) + + cmUnload, -- :: CmState -> DynFlags -> IO CmState #ifdef GHCI - cmInfoThing, -- :: CmState -> DynFlags -> String -> IO (Maybe TyThing) + 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) - cmRunStmt, -- :: CmState -> DynFlags -> String -> IO (CmState, [Name]) + cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) - cmTypeOfExpr, -- :: CmState -> DynFlags -> String - -- -> IO (CmState, Maybe String) + HValue, + cmCompileExpr, -- :: CmState -> DynFlags -> String + -- -> IO (CmState, Maybe HValue) - cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) + cmGetModInfo, -- :: CmState -> (ModuleGraph, HomePackageTable) + findModuleLinkable_maybe, -- Exported to InteractiveUI - cmCompileExpr,-- :: CmState -> DynFlags -> String - -- -> IO (CmState, Maybe HValue)#endif + cmGetBindings, -- :: CmState -> [TyThing] + cmGetPrintUnqual, -- :: CmState -> PrintUnqualified + + sandboxIO -- Should be somewhere else #endif - CmState, emptyCmState -- abstract ) where #include "HsVersions.h" -import CmLink -import CmTypes -import DriverPipeline -import DriverFlags ( getDynFlags ) +import DriverPipeline ( CompResult(..), preprocess, compile, link ) +import DriverState ( v_Output_file, v_NoHsMain ) import DriverPhases import DriverUtil import Finder -#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, nameModule, - isHomePackageName ) +import HscTypes hiding ( moduleNameToModule ) import NameEnv -import RdrName ( lookupRdrEnv, emptyRdrEnv ) -import Module +import PrelNames ( gHC_PRIM_Name ) +import Module ( Module, ModuleName, moduleName, mkModuleName, isHomeModule, + ModuleEnv, lookupModuleEnvByName, mkModuleEnv, moduleEnvElts, + extendModuleEnvList, extendModuleEnv, + moduleNameUserString, + ModLocation(..) ) import GetImports -import Type ( tidyType ) -import VarEnv ( emptyTidyEnv ) import UniqFM -import Unique ( Uniquable ) -import Digraph ( SCC(..), stronglyConnComp, flattenSCC ) +import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs ) import ErrUtils ( showPass ) import SysTools ( cleanTempFilesExcept ) +import BasicTypes ( SuccessFlag(..), succeeded, failed ) import Util import Outputable -import BasicTypes ( Fixity, defaultFixity ) import Panic -import CmdLineOpts ( DynFlags(..) ) +import CmdLineOpts ( DynFlags(..), getDynFlags ) +import Maybes ( expectJust, orElse ) -import IOExts +import DATA_IOREF ( readIORef ) #ifdef GHCI -import Interpreter ( HValue ) -import HscMain ( hscStmt ) -import PrelGHC ( unsafeCoerce# ) +import HscMain ( hscThing, hscStmt, hscTcExpr ) +import Module ( moduleUserString ) +import TcRnDriver ( mkGlobalContext, getModuleContents ) +import Name ( Name, NamedThing(..), isExternalName, nameModule ) +import Id ( idType ) +import Type ( tidyType ) +import VarEnv ( emptyTidyEnv ) +import BasicTypes ( Fixity, FixitySig(..), defaultFixity ) +import Linker ( HValue, unload, extendLinkEnv ) +import GHC.Exts ( unsafeCoerce# ) +import Foreign +import Control.Exception as Exception ( Exception, try ) #endif --- lang -import Exception ( throwDyn ) +import EXCEPTION ( throwDyn ) -- std import Directory ( getModificationTime, doesFileExist ) @@ -85,6 +107,7 @@ import IO import Monad import List ( nub ) import Maybe +import Time ( ClockTime ) \end{code} @@ -92,88 +115,137 @@ import Maybe -- Persistent state for the entire system data CmState = CmState { - hst :: HomeSymbolTable, -- home symbol table - hit :: HomeIfaceTable, -- home interface table - 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 + hpt :: HomePackageTable, -- Info about home package module + mg :: ModuleGraph, -- the module graph + ic :: InteractiveContext, -- command-line binding info + + pcs :: PersistentCompilerState -- compile's persistent state } -emptyCmState :: GhciMode -> Module -> IO CmState -emptyCmState gmode mod +cmGetModInfo cmstate = (mg cmstate, hpt cmstate) +cmGetBindings cmstate = nameEnvElts (ic_type_env (ic cmstate)) +cmGetPrintUnqual cmstate = icPrintUnqual (ic cmstate) + +emptyCmState :: GhciMode -> IO CmState +emptyCmState gmode = do pcs <- initPersistentCompilerState - pls <- emptyPLS - return (CmState { hst = emptySymbolTable, - hit = emptyIfaceTable, - ui = emptyUI, + return (CmState { hpt = emptyHomePackageTable, mg = emptyMG, gmode = gmode, - ic = emptyInteractiveContext mod, - pcs = pcs, - pls = pls }) + ic = emptyInteractiveContext, + pcs = pcs }) + +cmInit :: GhciMode -> IO CmState +cmInit mode = emptyCmState mode -emptyInteractiveContext mod - = InteractiveContext { ic_module = mod, - ic_rn_env = emptyRdrEnv, - ic_type_env = emptyTypeEnv } -defaultCurrentModuleName = mkModuleName "Prelude" -GLOBAL_VAR(defaultCurrentModule, error "no defaultCurrentModule", Module) +------------------------------------------------------------------- +-- The unlinked image +-- +-- The compilation manager keeps a list of compiled, but as-yet unlinked +-- binaries (byte code or object code). Even when it links bytecode +-- it keeps the unlinked version so it can re-link it later without +-- recompiling. --- CM internal types type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really) emptyUI :: UnlinkedImage emptyUI = [] -type ModuleGraph = [ModSummary] -- the module graph, topologically sorted -emptyMG :: ModuleGraph -emptyMG = [] +findModuleLinkable_maybe :: [Linkable] -> ModuleName -> Maybe Linkable +findModuleLinkable_maybe lis mod + = case [LM time nm us | LM time nm us <- lis, nm == mod] of + [] -> Nothing + [li] -> Just li + many -> pprPanic "findModuleLinkable" (ppr mod) + +filterModuleLinkables :: (ModuleName -> Bool) -> [Linkable] -> [Linkable] +filterModuleLinkables p [] = [] +filterModuleLinkables p (li:lis) + = case li of + LM _ modnm _ -> if p modnm then retain else dump + where + dump = filterModuleLinkables p lis + retain = li : dump + +linkableInSet :: Linkable -> [Linkable] -> Bool +linkableInSet l objs_loaded = + case findModuleLinkable_maybe objs_loaded (linkableModName l) of + Nothing -> False + Just m -> linkableTime l == linkableTime m +\end{code} ------------------------------------------------------------------------------ --- Produce an initial CmState. -cmInit :: GhciMode -> IO CmState -cmInit mode = do - prel <- moduleNameToModule defaultCurrentModuleName - writeIORef defaultCurrentModule prel - emptyCmState mode prel +%************************************************************************ +%* * + GHCI stuff +%* * +%************************************************************************ +\begin{code} +#ifdef GHCI ----------------------------------------------------------------------------- -- Setting the context doesn't throw away any bindings; the bindings -- we've built up in the InteractiveContext simply move to the new -- module. They always shadow anything in scope in the current context. -cmSetContext :: CmState -> String -> 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 +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{ hpt=hpt, pcs=pcs, ic=old_ic } = cmstate + hsc_env = HscEnv { hsc_mode = Interactive, hsc_dflags = dflags, + hsc_HPT = hpt } + + toplev_mods <- mapM (getTopLevModule hpt) (map mkModuleName toplevs) + export_mods <- mapM (moduleNameToModule hpt) (map mkModuleName exports) + + (new_pcs, maybe_env) + <- mkGlobalContext hsc_env 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 } } + +getTopLevModule hpt mn = + case lookupModuleEnvByName hpt mn of + + Just mod_info + | isJust (mi_globals iface) -> return (mi_module iface) + where + iface = hm_iface mod_info + + _other -> throwDyn (CmdLineError ( + "cannot enter the top-level scope of a compiled module (module `" ++ + moduleNameUserString mn ++ "')")) + +moduleNameToModule :: HomePackageTable -> ModuleName -> IO Module +moduleNameToModule hpt mn = do + case lookupModuleEnvByName hpt mn of + Just mod_info -> return (mi_module (hm_iface mod_info)) + _not_a_home_module -> do + maybe_stuff <- findModule mn + case maybe_stuff of + Left _ -> throwDyn (CmdLineError ("can't find module `" + ++ moduleNameUserString mn ++ "'")) + Right (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 (hpt cmstate) (mkModuleName str) of + Just details -> return (isJust (mi_globals (hm_iface details))) + _not_a_home_module -> return False ----------------------------------------------------------------------------- -- cmInfoThing: convert a String to a TyThing @@ -181,236 +253,275 @@ moduleNameToModule mn -- 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,Fixity)]) +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 }, unqual, pairs) - where - CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate - unqual = getUnqual pcs hit icontext - - getFixity :: PersistentCompilerState -> Name -> Fixity - getFixity pcs name - | Just iface <- lookupModuleEnv iface_table (nameModule name), - Just fixity <- lookupNameEnv (mi_fixities iface) name - = fixity + = do (new_pcs, things) <- hscThing hsc_env pcs icontext id + let new_pit = eps_PIT (pcs_EPS new_pcs) + pairs = map (\x -> (x, getFixity new_pit (getName x))) things + return (cmstate{ pcs=new_pcs }, pairs) + where + CmState{ hpt=hpt, pcs=pcs, ic=icontext } = cmstate + hsc_env = HscEnv { hsc_mode = Interactive, + hsc_dflags = dflags, + hsc_HPT = hpt } + + getFixity :: PackageIfaceTable -> Name -> Fixity + getFixity pit name + | isExternalName name, + Just iface <- lookupIface hpt pit (nameModule name), + Just (FixitySig _ fixity _) <- lookupNameEnv (mi_fixities iface) name + = fixity | otherwise - = defaultFixity - where iface_table | isHomePackageName name = hit - | otherwise = pcs_PIT pcs -#endif + = defaultFixity + +-- --------------------------------------------------------------------------- +-- cmBrowseModule: get all the TyThings defined in a module + +cmBrowseModule :: CmState -> DynFlags -> String -> Bool + -> IO (CmState, [TyThing]) +cmBrowseModule cmstate dflags str exports_only = do + let mn = mkModuleName str + mod <- moduleNameToModule hpt mn + (pcs1, maybe_ty_things) + <- getModuleContents hsc_env pcs mod exports_only + case maybe_ty_things of + Nothing -> return (cmstate{pcs=pcs1}, []) + Just ty_things -> return (cmstate{pcs=pcs1}, ty_things) + where + hsc_env = HscEnv { hsc_mode = Interactive, hsc_dflags = dflags, + hsc_HPT = hpt } + CmState{ hpt=hpt, pcs=pcs, ic=icontext } = cmstate ----------------------------------------------------------------------------- -- 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 +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{ hpt=hpt, pcs=pcs, ic=icontext } + dflags expr + = do + let hsc_env = HscEnv { hsc_mode = Interactive, + hsc_dflags = dflags, + hsc_HPT = hpt } + (new_pcs, maybe_stuff) - <- hscStmt dflags hst hit pcs icontext expr False{-stmt-} + <- hscStmt hsc_env pcs icontext expr case maybe_stuff of - Nothing -> return (cmstate{ pcs=new_pcs }, []) - Just (ids, _, bcos) -> do - - -- update the interactive context - let - names = map idName ids + Nothing -> return (cmstate{ pcs=new_pcs }, CmRunFailed) + Just (new_ic, names, hval) -> do - -- 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 + either_hvals <- sandboxIO thing_to_run + + case either_hvals of + Left e -> do + -- on error, keep the *old* interactive context, + -- so that 'it' is not bound to something + -- that doesn't exist. + return ( cmstate{ pcs=new_pcs }, CmRunException e ) + + Right hvals -> do + -- Get the newly bound things, and bind them. + -- Don't need to delete any shadowed bindings; + -- the new ones override the old ones. + extendLinkEnv (zip names hvals) + + return (cmstate{ pcs=new_pcs, ic=new_ic }, + CmRunOk names) + + +-- We run the statement in a "sandbox" to protect the rest of the +-- system from anything the expression might do. For now, this +-- consists of just wrapping it in an exception handler, but see below +-- for another version. + +sandboxIO :: IO a -> IO (Either Exception a) +sandboxIO thing = Exception.try thing + +{- +-- This version of sandboxIO runs the expression in a completely new +-- RTS main thread. It is disabled for now because ^C exceptions +-- won't be delivered to the new thread, instead they'll be delivered +-- to the (blocked) GHCi main thread. + +-- SLPJ: when re-enabling this, reflect a wrong-stat error as an exception + +sandboxIO :: IO a -> IO (Either Int (Either Exception a)) +sandboxIO thing = do + st_thing <- newStablePtr (Exception.try thing) + alloca $ \ p_st_result -> do + stat <- rts_evalStableIO st_thing p_st_result + freeStablePtr st_thing + if stat == 1 + then do st_result <- peek p_st_result + result <- deRefStablePtr st_result + freeStablePtr st_result + return (Right result) + else do + return (Left (fromIntegral stat)) + +foreign import "rts_evalStableIO" {- safe -} + rts_evalStableIO :: StablePtr (IO a) -> Ptr (StablePtr a) -> IO CInt + -- more informative than the C type! +-} ----------------------------------------------------------------------------- -- cmTypeOfExpr: returns a string representing the type of an expression -#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-} + = do (new_pcs, maybe_stuff) <- hscTcExpr hsc_env pcs ic expr let new_cmstate = cmstate{pcs = new_pcs} case maybe_stuff of Nothing -> return (new_cmstate, Nothing) - Just (_, ty, _) -> return (new_cmstate, Just str) + Just ty -> return (new_cmstate, Just str) where - str = showSDocForUser unqual (ppr tidy_ty) - unqual = getUnqual pcs hit ic + str = showSDocForUser unqual (text expr <+> dcolon <+> ppr tidy_ty) + unqual = icPrintUnqual ic tidy_ty = tidyType emptyTidyEnv ty where - CmState{ hst=hst, hit=hit, pcs=pcs, ic=ic } = cmstate -#endif + CmState{ hpt=hpt, pcs=pcs, ic=ic } = cmstate + hsc_env = HscEnv { hsc_mode = Interactive, + hsc_dflags = dflags, + hsc_HPT = hpt } + -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 +cmTypeOfName CmState{ pcs=pcs, ic=ic } name + = do + hPutStrLn stderr ("cmTypeOfName: " ++ showSDoc (ppr name)) + case lookupNameEnv (ic_type_env ic) name of Nothing -> return Nothing Just (AnId id) -> return (Just str) where - unqual = getUnqual pcs hit ic + unqual = icPrintUnqual 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 - + let hsc_env = HscEnv { hsc_mode = Interactive, + hsc_dflags = dflags, + hsc_HPT = hpt } + (new_pcs, maybe_stuff) - <- hscStmt dflags hst hit pcs icontext - ("let __cmCompileExpr = "++expr) False{-stmt-} + <- hscStmt hsc_env pcs icontext + ("let __cmCompileExpr = "++expr) case maybe_stuff of Nothing -> return (cmstate{ pcs=new_pcs }, Nothing) - Just (ids, _, bcos) -> do + Just (new_ic, names, hval) -> do - -- link it - hval <- linkExpr pls bcos + -- Run it! + hvals <- (unsafeCoerce# hval) :: IO [HValue] - -- 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" + case (names,hvals) of + ([n],[hv]) -> return (cmstate{ pcs=new_pcs }, Just hv) + _ -> panic "cmCompileExpr" where - CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate -#endif + CmState{ hpt=hpt, pcs=pcs, ic=icontext } = cmstate +#endif /* GHCI */ +\end{code} ------------------------------------------------------------------------------ --- 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" +%************************************************************************ +%* * + Loading and unloading +%* * +%************************************************************************ +\begin{code} ----------------------------------------------------------------------------- -- 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 +cmUnload state@CmState{ gmode=mode, pcs=pcs } dflags = do -- Throw away the old home dir cache - emptyHomeDirCache + flushFinderCache -- Unload everything the linker knows about - new_pls <- CmLink.unload mode dflags [] pls + cm_unload mode dflags [] -- Start with a fresh CmState, but keep the PersistentCompilerState new_state <- cmInit mode - return new_state{ pcs=pcs, pls=new_pls } + return new_state{ pcs=pcs } + +cm_unload Batch dflags linkables = return () + +#ifdef GHCI +cm_unload Interactive dflags linkables = Linker.unload dflags linkables +#else +cm_unload Interactive dflags linkables = panic "unload: no interpreter" +#endif + + +----------------------------------------------------------------------------- +-- Trace dependency graph + +-- This is a seperate pass so that the caller can back off and keep +-- the current state if the downsweep fails. Typically the caller +-- might go cmDepAnal +-- cmUnload +-- cmLoadModules +-- He wants to do the dependency analysis before the unload, so that +-- if the former fails he can use the later + +cmDepAnal :: CmState -> 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 "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] - -> IO (CmState, -- new state - Bool, -- was successful - [String]) -- list of modules loaded +cmLoadModules :: CmState -- The HPT may not be as up to date + -> DynFlags -- as the ModuleGraph + -> ModuleGraph -- Bang up to date + -> IO (CmState, -- new state + SuccessFlag, -- was successful + [String]) -- list of modules loaded -cmLoadModule cmstate1 rootnames +cmLoadModules cmstate1 dflags mg2unsorted = do -- version 1's are the original, before downsweep - let pls1 = pls cmstate1 let pcs1 = pcs cmstate1 - let hst1 = hst cmstate1 - let hit1 = hit cmstate1 - -- 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 hpt1 = hpt cmstate1 let ghci_mode = gmode cmstate1 -- this never changes -- Do the downsweep to reestablish the module graph - dflags <- getDynFlags let verb = verbosity dflags - showPass dflags "Chasing dependencies" - when (verb >= 1 && ghci_mode == Batch) $ - hPutStrLn stderr (showSDoc (hcat [ - text progName, text ": chasing modules from: ", - hcat (punctuate comma (map text rootnames))])) + -- Find out if we have a Main module + let a_root_is_Main + = any ((=="Main").moduleNameUserString.modSummaryName) + mg2unsorted - (mg2unsorted, a_root_is_Main) <- downsweep rootnames 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] @@ -420,15 +531,22 @@ cmLoadModule cmstate1 rootnames let mg2 = topological_sort False mg2unsorted -- ... whereas this takes them into account. Used for -- backing out partially complete cycles following a failed - -- upsweep, and for removing from hst/hit all the modules + -- upsweep, and for removing from hpt all the modules -- not in strict downwards closure, during calls to compile. let mg2_with_srcimps = topological_sort True mg2unsorted -- Sort out which linkables we wish to keep in the unlinked image. -- See getValidLinkables below for details. - valid_linkables <- getValidLinkables ui1 mg2unsorted_names - mg2_with_srcimps - -- when (verb >= 2) $ + (valid_old_linkables, new_linkables) + <- getValidLinkables ghci_mode (hptLinkables hpt1) + mg2unsorted_names mg2_with_srcimps + + -- putStrLn (showSDoc (vcat [ppr valid_old_linkables, ppr new_linkables])) + + -- Uniq of ModuleName is the same as Module, fortunately... + let hpt2 = delListFromUFM hpt1 (map linkableModName new_linkables) + + -- When (verb >= 2) $ -- putStrLn (showSDoc (text "Valid linkables:" -- <+> ppr valid_linkables)) @@ -440,9 +558,9 @@ cmLoadModule cmstate1 rootnames -- 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 hit1 + stable_mods <- preUpsweep valid_old_linkables mg2unsorted_names [] mg2_with_srcimps let stable_summaries @@ -450,15 +568,18 @@ cmLoadModule cmstate1 rootnames stable_linkables = filter (\m -> linkableModName m `elem` stable_mods) - valid_linkables + valid_old_linkables when (verb >= 2) $ - putStrLn (showSDoc (text "Stable modules:" + hPutStrLn stderr (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 <- CmLink.unload ghci_mode dflags stable_linkables pls1 + cm_unload ghci_mode dflags stable_linkables + + -- we can now glom together our linkable sets + let valid_linkables = valid_old_linkables ++ new_linkables -- We could at this point detect cycles which aren't broken by -- a source-import, and complain immediately, but it seems better @@ -466,7 +587,7 @@ cmLoadModule cmstate1 rootnames -- 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" @@ -480,21 +601,24 @@ cmLoadModule cmstate1 rootnames -- 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 hpt2 - (upsweep_complete_success, threaded3, modsUpswept, newLis) + -- clean up between compilations + let cleanup = cleanTempFilesExcept verb + (ppFilesFromSummaries (flattenSCCs mg2)) + + (upsweep_ok, threaded3, modsUpswept) <- 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 + let (CmThreaded pcs3 hpt3) = threaded3 -- At this point, modsUpswept and newLis should have the same -- length, so there is one new (or old) linkable for each -- mod which was processed (passed to compile). -- Make modsDone be the summaries for each home module now - -- available; this should equal the domains of hst3 and hit3. + -- available; this should equal the domain of hpt3. -- (NOT STRICTLY TRUE if an interactive session was started -- with some object on disk ???) -- Get in in a roughly top .. bottom order (hence reverse). @@ -504,7 +628,7 @@ cmLoadModule cmstate1 rootnames -- Try and do linking in some form, depending on whether the -- upsweep was completely or only partially successful. - if upsweep_complete_success + if succeeded upsweep_ok then -- Easy; just relink it all. @@ -514,11 +638,25 @@ cmLoadModule cmstate1 rootnames -- clean up after ourselves cleanTempFilesExcept verb (ppFilesFromSummaries modsDone) + ofile <- readIORef v_Output_file + no_hs_main <- readIORef v_NoHsMain + + -- Issue a warning for the confusing case where the user + -- said '-o foo' but we're not going to do any linking. + -- We attempt linking if either (a) one of the modules is + -- called Main, or (b) the user said -no-hs-main, indicating + -- that main() is going to come from somewhere else. + -- + let do_linking = a_root_is_Main || no_hs_main + when (ghci_mode == Batch && isJust ofile && not do_linking + && verb > 0) $ + hPutStrLn stderr "Warning: output was redirected with -o, but no output will be generated\nbecause there is no Main module." + -- link everything together - linkresult <- link ghci_mode dflags a_root_is_Main ui3 pls2 + linkresult <- link ghci_mode dflags do_linking hpt3 - cmLoadFinish True linkresult - hst3 hit3 ui3 modsDone ghci_mode pcs3 + cmLoadFinish Succeeded linkresult + hpt3 modsDone ghci_mode pcs3 else -- Tricky. We need to back out the effects of compiling any @@ -528,51 +666,42 @@ cmLoadModule cmstate1 rootnames 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 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 name_of_summary mods_to_keep) - (hst3,hit3,ui3) + let hpt4 = retainInTopLevelEnvs (map modSummaryName mods_to_keep) hpt3 - -- clean up after ourselves + -- Clean up after ourselves cleanTempFilesExcept verb (ppFilesFromSummaries mods_to_keep) - -- link everything together - linkresult <- link ghci_mode dflags False ui4 pls2 + -- Link everything together + linkresult <- link ghci_mode dflags False hpt4 - cmLoadFinish False linkresult - hst4 hit4 ui4 mods_to_keep ghci_mode pcs3 + cmLoadFinish Failed linkresult + hpt4 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 +cmLoadFinish ok Failed hpt mods ghci_mode pcs = do + dflags <- getDynFlags + cm_unload ghci_mode dflags [] new_state <- cmInit ghci_mode - return (new_state{ pcs=pcs, pls=new_pls }, False, []) + return (new_state{ pcs=pcs }, Failed, []) -- Empty the interactive context and set the module context to the topmost -- newly loaded module, or the Prelude if none were loaded. -cmLoadFinish ok (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 +cmLoadFinish ok Succeeded hpt mods ghci_mode pcs + = do let new_cmstate = CmState{ hpt=hpt, mg=mods, + gmode=ghci_mode, pcs=pcs, + ic = emptyInteractiveContext } + mods_loaded = map (moduleNameUserString.modSummaryName) mods return (new_cmstate, ok, mods_loaded) @@ -582,12 +711,21 @@ ppFilesFromSummaries summaries = [ fn | Just fn <- map toPpFile summaries ] where toPpFile sum - | hspp /= ml_hs_file loc = hspp - | otherwise = Nothing + | not (isSameFilePath hspp hs) = hspp + | otherwise = Nothing where loc = ms_location sum hspp = ml_hspp_file loc + hs = ml_hs_file loc + + -- better make extra sure 'a' and 'b' are in canonical form + -- before using this equality test. + isSameFilePath a b = fmap normalise a == fmap normalise b + -- a hack, because sometimes we strip off the leading "./" from a + -- a filename. + normalise ('.':'/':f) = f + normalise f = f ----------------------------------------------------------------------------- -- getValidLinkables @@ -599,9 +737,11 @@ ppFilesFromSummaries summaries -- -- - 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. +-- and we throw away the linkable if it is older than the source file. +-- In interactive mode, we also ignore the on-disk linkables unless +-- all of the dependents of this SCC also have on-disk linkables (we +-- can't have dynamically loaded objects that depend on interpreted +-- modules in GHCi). -- -- If a module has a valid linkable, then it may be STABLE (see below), -- and it is classified as SOURCE UNCHANGED for the purposes of calling @@ -610,107 +750,122 @@ ppFilesFromSummaries summaries -- ToDo: this pass could be merged with the preUpsweep. getValidLinkables - :: [Linkable] -- old linkables + :: GhciMode + -> [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 mode old_linkables all_home_mods module_graph = do + ls <- foldM (getValidLinkablesSCC mode old_linkables all_home_mods) + [] module_graph + return (partition_it ls [] []) + where + partition_it [] valid new = (valid,new) + partition_it ((l,b):ls) valid new + | b = partition_it ls valid (l:new) + | otherwise = partition_it ls (l:valid) new -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 +getValidLinkablesSCC mode 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_imps scc)) - -- NOTE: ms_imps, not ms_allimps above. We don't want to + -- 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 + objects_allowed = mode == Batch || 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; i.e. freshly discovered on the disk + -- presumably generated 'on the side' + -- by a separate GHC run getValidLinkable old_linkables objects_allowed new_linkables summary - = do let mod_name = name_of_summary summary + -- 'objects_allowed' says whether we permit this module to + -- have a .o-file linkable. We only permit it if all the + -- modules it depends on also have .o files; a .o file can't + -- link to a bytecode module + = do let mod_name = modSummaryName summary - maybe_disk_linkable + 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 + + else findLinkable mod_name (ms_location summary) + + let old_linkable = findModuleLinkable_maybe old_linkables mod_name + + new_linkables' = + case (old_linkable, maybe_disk_linkable) of + (Nothing, Nothing) -> [] + + -- new object linkable just appeared + (Nothing, Just l) -> up_to_date l True + + (Just l, Nothing) + | isObjectLinkable l -> [] + -- object linkable disappeared! In case we need to + -- relink the module, disregard the old linkable and + -- just interpret the module from now on. + | otherwise -> up_to_date l False + -- old byte code linkable + + (Just l, Just l') + | not (isObjectLinkable l) -> up_to_date l False + -- if the previous linkable was interpreted, then we + -- ignore a newly compiled version, because the version + -- numbers in the interface file will be out-of-sync with + -- our internal ones. + | linkableTime l' > linkableTime l -> up_to_date l' True + | linkableTime l' == linkableTime l -> up_to_date l False + | otherwise -> [] + -- on-disk linkable has been replaced by an older one! + -- again, disregard the previous one. + + up_to_date l b + | linkableTime l < ms_hs_date summary = [] + | otherwise = [(l,b)] + -- why '<' rather than '<=' above? If the filesystem stores -- times to the nearset second, we may occasionally find that -- the object & source have the same modification time, -- especially if the source was automatically generated -- and compiled. Using >= is slightly unsafe, but it matches -- make's behaviour. - return (valid_linkable ++ new_linkables) + return (new_linkables' ++ new_linkables) -maybe_getFileLinkable :: ModuleName -> FilePath -> IO (Maybe Linkable) -maybe_getFileLinkable mod_name obj_fn - = do obj_exist <- doesFileExist obj_fn - if not obj_exist - then return Nothing - else - do let stub_fn = case splitFilename3 obj_fn of - (dir, base, ext) -> dir ++ "/" ++ base ++ ".stub_o" - 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])) +hptLinkables :: HomePackageTable -> [Linkable] +-- Get all the linkables from the home package table, one for each module +-- Once the HPT is up to date, these are the ones we should link +hptLinkables hpt = map hm_linkable (moduleEnvElts hpt) ----------------------------------------------------------------------------- @@ -720,17 +875,16 @@ maybe_getFileLinkable mod_name obj_fn -- a stable module: -- * has a valid linkable (see getValidLinkables above) -- * depends only on stable modules --- * has an interface in the HIT (interactive mode only) +-- * has an interface in the HPT (interactive mode only) preUpsweep :: [Linkable] -- new valid linkables - -> HomeIfaceTable - -> [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 -preUpsweep valid_lis hit all_home_mods stable [] = return stable -preUpsweep valid_lis hit all_home_mods stable (scc0:sccs) +preUpsweep valid_lis all_home_mods stable [] = return stable +preUpsweep valid_lis all_home_mods stable (scc0:sccs) = do let scc = flattenSCC scc0 scc_allhomeimps :: [ModuleName] scc_allhomeimps @@ -738,7 +892,7 @@ preUpsweep valid_lis hit 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 @@ -746,17 +900,14 @@ preUpsweep valid_lis hit 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 - - has_interface summary = ms_mod summary `elemUFM` hit + where modname = modSummaryName new_summary 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 + then preUpsweep valid_lis all_home_mods (scc_names++stable) sccs + else preUpsweep valid_lis all_home_mods stable sccs -- Helper for preUpsweep. Assuming that new_summary's imports are all @@ -764,7 +915,7 @@ preUpsweep valid_lis hit all_home_mods stable (scc0:sccs) -- 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 @@ -781,76 +932,65 @@ 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]) chewed_rest = chew rest in - if not (null mods_in_this_cycle) + if notNull mods_in_this_cycle && length mods_in_this_cycle < length names_in_this_cycle then mods_in_this_cycle ++ chewed_rest else chewed_rest --- Add the given (LM-form) Linkables to the UI, overwriting previous --- versions if they exist. -add_to_ui :: UnlinkedImage -> [Linkable] -> UnlinkedImage -add_to_ui ui lis - = filter (not_in lis) ui ++ lis - where - not_in :: [Linkable] -> Linkable -> Bool - not_in lis li - = all (\l -> linkableModName l /= mod) lis - where mod = linkableModName li - - data CmThreaded -- stuff threaded through individual module compilations - = CmThreaded PersistentCompilerState HomeSymbolTable HomeIfaceTable + = CmThreaded PersistentCompilerState HomePackageTable -- Compile multiple modules, stopping as soon as an error appears. -- There better had not be any cyclic groups here -- we check for them. upsweep_mods :: GhciMode -> DynFlags - -> UnlinkedImage -- valid linkables + -> [Linkable] -- Valid linkables -> (ModuleName -> [ModuleName]) -- to construct downward closures - -> CmThreaded -- PCS & HST & HIT + -> CmThreaded -- PCS & HPT + -> IO () -- how to clean up unwanted tmp files -> [SCC ModSummary] -- mods to do (the worklist) -- ...... RETURNING ...... - -> IO (Bool{-complete success?-}, - CmThreaded, - [ModSummary], -- mods which succeeded - [Linkable]) -- new linkables + -> IO (SuccessFlag, + CmThreaded, -- Includes linkables + [ModSummary]) -- Mods which succeeded -upsweep_mods ghci_mode dflags oldUI reachable_from threaded +upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup [] - = return (True, threaded, [], []) + = return (Succeeded, 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)) - return (False, threaded, [], []) + unwords (map (moduleNameUserString.modSummaryName) ms)) + return (Failed, 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 - -- -> putStrLn ("UPSWEEP_MOD: hit = " ++ show (map (moduleNameUserString.moduleName.mi_module) (eltsUFM hitz))) - - (threaded1, maybe_linkable) - <- upsweep_mod ghci_mode dflags oldUI threaded mod - (reachable_from (name_of_summary mod)) - case maybe_linkable of - Just linkable - -> -- No errors; do the rest - do (restOK, threaded2, modOKs, linkables) + -- CmThreaded pcsz hptz + -- -> putStrLn ("UPSWEEP_MOD: hpt = " ++ + -- show (map (moduleNameUserString.moduleName.mi_module.hm_iface) (eltsUFM hptz))) + + (ok_flag, threaded1) <- upsweep_mod ghci_mode dflags oldUI threaded mod + (reachable_from (modSummaryName mod)) + + cleanup -- Remove unwanted tmp files between compilations + + if failed ok_flag then + return (Failed, threaded1, []) + else do + (restOK, threaded2, modOKs) <- upsweep_mods ghci_mode dflags oldUI reachable_from - threaded1 mods - return (restOK, threaded2, mod:modOKs, linkable:linkables) - Nothing -- we got a compilation error; give up now - -> return (False, threaded1, [], []) + threaded1 cleanup mods + return (restOK, threaded2, mod:modOKs) -- Compile a single module. Always produce a Linkable for it if @@ -861,40 +1001,39 @@ upsweep_mod :: GhciMode -> CmThreaded -> ModSummary -> [ModuleName] - -> IO (CmThreaded, Maybe Linkable) + -> IO (SuccessFlag, CmThreaded) upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me = do - let mod_name = name_of_summary summary1 - let verb = verbosity dflags + let this_mod = ms_mod summary1 + location = ms_location summary1 + mod_name = moduleName this_mod - let (CmThreaded pcs1 hst1 hit1) = threaded1 - let old_iface = lookupUFM hit1 mod_name + let (CmThreaded pcs1 hpt1) = threaded1 + let mb_old_iface = case lookupModuleEnvByName hpt1 mod_name of + Just mod_info -> Just (hm_iface mod_info) + Nothing -> Nothing let maybe_old_linkable = findModuleLinkable_maybe oldUI mod_name + source_unchanged = isJust maybe_old_linkable - source_unchanged = isJust maybe_old_linkable - - reachable_only = filter (/= (name_of_summary summary1)) - reachable_inc_me + reachable_only = filter (/= mod_name) 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 + -- In interactive mode, all home modules below us *must* have an + -- interface in the HPT. 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,[]) + hpt1_strictDC + = ASSERT(ghci_mode == Batch || all (`elemUFM` hpt1) reachable_only) + retainInTopLevelEnvs reachable_only hpt1 - old_linkable - = unJust "upsweep_mod:old_linkable" maybe_old_linkable + old_linkable = expectJust "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 - have_object old_iface hst1_strictDC hit1_strictDC pcs1 + compresult <- compile ghci_mode this_mod location source_unchanged + have_object mb_old_iface hpt1_strictDC pcs1 case compresult of @@ -902,44 +1041,35 @@ upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me -- 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, if isJust maybe_new_linkable - then maybe_new_linkable - else Just old_linkable) - - -- Compilation failed. compile may still have updated - -- the PCS, tho. - CompErrs pcs2 - -> do let threaded2 = CmThreaded pcs2 hst1 hit1 - return (threaded2, Nothing) - --- Filter modules in the top level envs (HST, HIT, UI). -retainInTopLevelEnvs :: [ModuleName] - -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage) - -> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage) -retainInTopLevelEnvs keep_these (hst, hit, ui) - = (retainInUFM hst keep_these, - retainInUFM hit keep_these, - filterModuleLinkables (`elem` keep_these) ui - ) - where - retainInUFM :: Uniquable key => UniqFM elt -> [key] -> UniqFM elt - retainInUFM ufm keys_to_keep - = listToUFM (concatMap (maybeLookupUFM ufm) keys_to_keep) - maybeLookupUFM ufm u - = case lookupUFM ufm u of Nothing -> []; Just val -> [(u, val)] + -> do let + new_linkable = maybe_new_linkable `orElse` old_linkable + new_info = HomeModInfo { hm_iface = new_iface, + hm_details = new_details, + hm_linkable = new_linkable } + hpt2 = extendModuleEnv hpt1 this_mod new_info + + return (Succeeded, CmThreaded pcs2 hpt2) + + -- Compilation failed. Compile may still have updated the PCS, tho. + CompErrs pcs2 -> return (Failed, CmThreaded pcs2 hpt1) + +-- Filter modules in the HPT +retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable +retainInTopLevelEnvs keep_these hpt + = listToUFM (concatMap (maybeLookupUFM hpt) keep_these) + where + maybeLookupUFM ufm u = case lookupUFM ufm u of + Nothing -> [] + Just val -> [(u, val)] --- Needed to clean up HIT and HST so that we don't get duplicates in inst env +-- Needed to clean up HPT so that we don't get duplicates in inst env downwards_closure_of_module :: [ModSummary] -> ModuleName -> [ModuleName] downwards_closure_of_module summaries root = let toEdge :: ModSummary -> (ModuleName,[ModuleName]) - toEdge summ = (name_of_summary summ, + toEdge summ = (modSummaryName summ, filter (`elem` all_mods) (ms_allimps summ)) - all_mods = map name_of_summary summaries + all_mods = map modSummaryName summaries res = simple_transitive_closure (map toEdge summaries) [root] in @@ -965,7 +1095,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) @@ -985,22 +1115,28 @@ 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 + checkDuplicates rootSummaries all_summaries - <- loop (concat (map ms_imps rootSummaries)) + <- loop (concat (map (\ m -> zip (repeat (fromMaybe "" (ml_hs_file (ms_location m)))) + (ms_imps m)) rootSummaries)) (mkModuleEnv [ (mod, s) | s <- rootSummaries, let mod = ms_mod s, isHomeModule mod ]) - return (all_summaries, a_root_is_Main) + return all_summaries where getRootSummary :: FilePath -> IO ModSummary getRootSummary file @@ -1014,7 +1150,7 @@ downsweep rootNm old_summaries exists <- doesFileExist lhs_file if exists then summariseFile lhs_file else do let mod_name = mkModuleName file - maybe_summary <- getSummary mod_name + maybe_summary <- getSummary (file, mod_name) case maybe_summary of Nothing -> packageModErr mod_name Just s -> return s @@ -1022,24 +1158,40 @@ downsweep rootNm old_summaries hs_file = file ++ ".hs" lhs_file = file ++ ".lhs" - getSummary :: ModuleName -> IO (Maybe ModSummary) - getSummary nm + -- In a root module, the filename is allowed to diverge from the module + -- name, so we have to check that there aren't multiple root files + -- defining the same module (otherwise the duplicates will be silently + -- ignored, leading to confusing behaviour). + checkDuplicates :: [ModSummary] -> IO () + checkDuplicates summaries = mapM_ check summaries + where check summ = + case dups of + [] -> return () + [_one] -> return () + many -> multiRootsErr modl many + where modl = ms_mod summ + dups = + [ fromJust (ml_hs_file (ms_location summ')) + | summ' <- summaries, ms_mod summ' == modl ] + + getSummary :: (FilePath,ModuleName) -> IO (Maybe ModSummary) + getSummary (currentMod,nm) = do found <- findModule nm case found of - Just (mod, location) -> do + Right (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) ++ "'")) + Left files -> do + dflags <- getDynFlags + throwDyn (noModError dflags currentMod nm files) -- loop invariant: env doesn't contain package modules - loop :: [ModuleName] -> ModuleEnv ModSummary -> IO [ModSummary] + loop :: [(FilePath,ModuleName)] -> ModuleEnv ModSummary -> IO [ModSummary] loop [] env = return (moduleEnvElts env) loop imps env = do -- imports for modules we don't already have - let needed_imps = nub (filter (not . (`elemUFM` env)) imps) + let needed_imps = nub (filter (not . (`elemUFM` env).snd) imps) -- summarise them needed_summaries <- mapM getSummary needed_imps @@ -1048,17 +1200,30 @@ downsweep rootNm old_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) + let new_imps = concat (map (\ m -> zip (repeat (fromMaybe "" (ml_hs_file (ms_location m)))) + (ms_imps m)) new_home_summaries) loop new_imps (extendModuleEnvList env [ (ms_mod s, s) | s <- new_home_summaries ]) +-- ToDo: we don't have a proper line number for this error +noModError dflags loc mod_nm files = ProgramError (showSDoc ( + hang (text loc <> colon) 4 $ + (text "Can't find module" <+> quotes (ppr mod_nm) $$ extra) + )) + where + extra + | verbosity dflags < 3 = + text "(use -v to see a list of the files searched for)" + | otherwise = + hang (ptext SLIT("locations searched:")) 4 (vcat (map text files)) + ----------------------------------------------------------------------------- -- Summarising modules -- We have two types of summarisation: -- --- * Summarise a file. This is used for the root module 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 @@ -1070,37 +1235,32 @@ summariseFile file = do hspp_fn <- preprocess file (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn - let (path, basename, ext) = splitFilename3 file + let (basename, ext) = splitFilename file + -- GHC.Prim doesn't exist physically, so don't go looking for it. + the_imps = filter (/= gHC_PRIM_Name) imps - (mod, location) - <- mkHomeModuleLocn mod_name (path ++ '/':basename) (Just file) + (mod, location) <- mkHomeModLocation mod_name "." basename ext src_timestamp <- case ml_hs_file location of Nothing -> noHsFileErr mod_name Just src_fn -> getModificationTime src_fn - return (ModSummary mod - location{ml_hspp_file=Just hspp_fn} - srcimps imps src_timestamp) + return (ModSummary { ms_mod = mod, + ms_location = location{ml_hspp_file=Just hspp_fn}, + ms_srcimps = srcimps, ms_imps = the_imps, + ms_hs_date = src_timestamp }) -- Summarise a module, and pick up source and timestamp. -summarise :: Module -> ModuleLocation -> Maybe ModSummary +summarise :: Module -> ModLocation -> 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) + = do let hs_fn = expectJust "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; - }; - + Nothing -> noHsFileErr mod; Just src_fn -> do src_timestamp <- getModificationTime src_fn @@ -1112,6 +1272,9 @@ summarise mod location old_summary hspp_fn <- preprocess hs_fn (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn + let + -- GHC.Prim doesn't exist physically, so don't go looking for it. + the_imps = filter (/= gHC_PRIM_Name) imps when (mod_name /= moduleName mod) $ throwDyn (ProgramError @@ -1120,7 +1283,7 @@ summarise mod location old_summary <+> quotes (ppr (moduleName mod))))) return (Just (ModSummary mod location{ml_hspp_file=Just hspp_fn} - srcimps imps src_timestamp)) + srcimps the_imps src_timestamp)) } } @@ -1132,4 +1295,56 @@ packageModErr mod = throwDyn (CmdLineError (showSDoc (text "module" <+> quotes (ppr mod) <+> text "is a package module"))) + +multiRootsErr mod files + = throwDyn (ProgramError (showSDoc ( + text "module" <+> quotes (ppr mod) <+> + text "is defined in multiple files:" <+> + sep (map text files)))) +\end{code} + + +%************************************************************************ +%* * + The ModSummary Type +%* * +%************************************************************************ + +\begin{code} +-- The ModLocation contains both the original source filename and the +-- filename of the cleaned-up source file after all preprocessing has been +-- done. The point is that the summariser will have to cpp/unlit/whatever +-- all files anyway, and there's no point in doing this twice -- just +-- park the result in a temp file, put the name of it in the location, +-- and let @compile@ read from that file on the way back up. + + +type ModuleGraph = [ModSummary] -- the module graph, topologically sorted + +emptyMG :: ModuleGraph +emptyMG = [] + +data ModSummary + = ModSummary { + ms_mod :: Module, -- name, package + ms_location :: ModLocation, -- location + ms_srcimps :: [ModuleName], -- source imports + ms_imps :: [ModuleName], -- non-source imports + ms_hs_date :: ClockTime -- timestamp of summarised file + } + +instance Outputable ModSummary where + ppr ms + = sep [text "ModSummary {", + nest 3 (sep [text "ms_hs_date = " <> text (show (ms_hs_date ms)), + text "ms_mod =" <+> ppr (ms_mod ms) <> comma, + text "ms_imps =" <+> ppr (ms_imps ms), + text "ms_srcimps =" <+> ppr (ms_srcimps ms)]), + char '}' + ] + +ms_allimps ms = ms_srcimps ms ++ ms_imps ms + +modSummaryName :: ModSummary -> ModuleName +modSummaryName = moduleName . ms_mod \end{code}