X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FcompMan%2FCompManager.lhs;h=829664d2a74fa4ec57820253c9476b710061a977;hb=8e67f5502e2e316245806ee3735a2f41a844b611;hp=1f5aa9a48cbf17610fb8ee5d5e2f52b6af6c1b36;hpb=1ebe3eb69364cef574cb6636afa1413965928597;p=ghc-hetmet.git diff --git a/ghc/compiler/compMan/CompManager.lhs b/ghc/compiler/compMan/CompManager.lhs index 1f5aa9a..829664d 100644 --- a/ghc/compiler/compMan/CompManager.lhs +++ b/ghc/compiler/compMan/CompManager.lhs @@ -4,99 +4,105 @@ % The Compilation Manager % \begin{code} -{-# OPTIONS -fvia-C #-} module CompManager ( - ModuleGraph, ModSummary(..), + ModSummary, -- Abstract + ModuleGraph, -- All the modules from the home package - CmState, emptyCmState, -- abstract + CmState, -- Abstract cmInit, -- :: GhciMode -> IO CmState - cmDepAnal, -- :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph + cmDepAnal, -- :: CmState -> [FilePath] -> IO ModuleGraph + cmDownsweep, + cmTopSort, -- :: Bool -> ModuleGraph -> [SCC ModSummary] + cyclicModuleErr, -- :: [ModSummary] -> String -- Used by DriverMkDepend - cmLoadModules, -- :: CmState -> DynFlags -> ModuleGraph + cmLoadModules, -- :: CmState -> ModuleGraph -- -> IO (CmState, Bool, [String]) - cmUnload, -- :: CmState -> DynFlags -> IO CmState + cmUnload, -- :: CmState -> IO CmState + #ifdef GHCI cmModuleIsInterpreted, -- :: CmState -> String -> IO Bool - cmSetContext, -- :: CmState -> DynFlags -> [String] -> [String] -> IO CmState + cmSetContext, -- :: CmState -> [String] -> [String] -> IO CmState cmGetContext, -- :: CmState -> IO ([String],[String]) - cmInfoThing, -- :: CmState -> DynFlags -> String - -- -> IO (CmState, [(TyThing,Fixity)]) - + cmGetInfo, -- :: CmState -> String -> IO (CmState, [(TyThing,Fixity)]) + GetInfoResult, cmBrowseModule, -- :: CmState -> IO [TyThing] + cmShowModule, CmRunResult(..), - cmRunStmt, -- :: CmState -> DynFlags -> String - -- -> IO (CmState, CmRunResult) - - cmTypeOfExpr, -- :: CmState -> DynFlags -> String - -- -> IO (CmState, Maybe String) + cmRunStmt, -- :: CmState -> String -> IO (CmState, CmRunResult) - cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) + cmTypeOfExpr, -- :: CmState -> String -> IO (CmState, Maybe String) + cmKindOfType, -- :: CmState -> String -> IO (CmState, Maybe String) + cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String) HValue, - cmCompileExpr, -- :: CmState -> DynFlags -> String - -- -> IO (CmState, Maybe HValue) - - cmGetModInfo, -- :: CmState -> (ModuleGraph, HomePackageTable) - findModuleLinkable_maybe, -- Exported to InteractiveUI + cmCompileExpr, -- :: CmState -> String -> IO (CmState, Maybe HValue) + cmGetModuleGraph, -- :: CmState -> ModuleGraph + cmSetDFlags, + cmGetDFlags, cmGetBindings, -- :: CmState -> [TyThing] cmGetPrintUnqual, -- :: CmState -> PrintUnqualified - - sandboxIO -- Should be somewhere else #endif ) where #include "HsVersions.h" +import Packages ( isHomePackage ) import DriverPipeline ( CompResult(..), preprocess, compile, link ) -import DriverState ( v_Output_file ) -import DriverPhases -import DriverUtil -import Finder -import HscMain ( initPersistentCompilerState ) -import HscTypes hiding ( moduleNameToModule ) -import NameEnv -import PrelNames ( gHC_PRIM_Name ) -import Module ( Module, ModuleName, moduleName, mkModuleName, isHomeModule, - ModuleEnv, lookupModuleEnvByName, mkModuleEnv, moduleEnvElts, - extendModuleEnvList, extendModuleEnv, - moduleNameUserString, +import HscMain ( newHscEnv ) +import DriverState ( v_Output_file, v_NoHsMain, v_MainModIs ) +import DriverPhases ( HscSource(..), isHsBoot, hscSourceString, isHaskellSrcFilename ) +import Finder ( findModule, findLinkable, addHomeModuleToFinder, + flushFinderCache, mkHomeModLocation, FindResult(..), cantFindError ) +import HscTypes ( ModSummary(..), HomeModInfo(..), ModIface(..), msHsFilePath, + HscEnv(..), GhciMode(..), + InteractiveContext(..), emptyInteractiveContext, + HomePackageTable, emptyHomePackageTable, IsBootInterface, + Linkable(..), isObjectLinkable ) +import Module ( Module, mkModule, delModuleEnv, delModuleEnvList, mkModuleEnv, + lookupModuleEnv, moduleEnvElts, extendModuleEnv, filterModuleEnv, + moduleUserString, addBootSuffixLocn, ModLocation(..) ) -import GetImports -import UniqFM +import GetImports ( getImports ) import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs ) import ErrUtils ( showPass ) import SysTools ( cleanTempFilesExcept ) -import BasicTypes ( SuccessFlag(..), succeeded, failed ) +import BasicTypes ( SuccessFlag(..), succeeded ) +import StringBuffer ( hGetStringBuffer ) import Util import Outputable import Panic -import CmdLineOpts ( DynFlags(..), getDynFlags ) -import Maybes ( expectJust, orElse ) +import CmdLineOpts ( DynFlags(..) ) +import Maybes ( expectJust, orElse, mapCatMaybes ) +import FiniteMap import DATA_IOREF ( readIORef ) #ifdef GHCI -import HscMain ( hscThing, hscStmt, hscTcExpr ) -import Module ( moduleUserString ) -import TcRnDriver ( mkGlobalContext, getModuleContents ) -import Name ( Name, NamedThing(..), isExternalName, nameModule ) +import Finder ( findPackageModule ) +import HscMain ( hscGetInfo, GetInfoResult, hscStmt, hscTcExpr, hscKcType ) +import HscTypes ( TyThing(..), icPrintUnqual, showModMsg ) +import TcRnDriver ( mkExportEnv, getModuleContents ) +import IfaceSyn ( IfaceDecl ) +import RdrName ( GlobalRdrEnv, plusGlobalRdrEnv ) +import Name ( Name ) +import NameEnv import Id ( idType ) -import Type ( tidyType ) +import Type ( tidyType, dropForAlls ) 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 ) +import CmdLineOpts ( DynFlag(..), dopt_unset, dopt ) #endif import EXCEPTION ( throwDyn ) @@ -107,39 +113,89 @@ import IO import Monad import List ( nub ) import Maybe -import Time ( ClockTime ) \end{code} +%************************************************************************ +%* * + The module dependency graph + ModSummary, ModGraph, NodeKey, NodeMap +%* * +%************************************************************************ + +The nodes of the module graph are + EITHER a regular Haskell source module + OR a hi-boot source module + +A ModuleGraph contains all the nodes from the home package (only). +There will be a node for each source module, plus a node for each hi-boot +module. + +\begin{code} +type ModuleGraph = [ModSummary] -- The module graph, + -- NOT NECESSARILY IN TOPOLOGICAL ORDER + +emptyMG :: ModuleGraph +emptyMG = [] + +-------------------- +ms_allimps :: ModSummary -> [Module] +ms_allimps ms = ms_srcimps ms ++ ms_imps ms + +-------------------- +type NodeKey = (Module, HscSource) -- The nodes of the graph are +type NodeMap a = FiniteMap NodeKey a -- keyed by (mod, src_file_type) pairs + +msKey :: ModSummary -> NodeKey +msKey (ModSummary { ms_mod = mod, ms_hsc_src = boot }) = (mod,boot) + +emptyNodeMap :: NodeMap a +emptyNodeMap = emptyFM + +mkNodeMap :: [ModSummary] -> NodeMap ModSummary +mkNodeMap summaries = listToFM [ (msKey s, s) | s <- summaries] + +nodeMapElts :: NodeMap a -> [a] +nodeMapElts = eltsFM +\end{code} + + +%************************************************************************ +%* * + The compilation manager state +%* * +%************************************************************************ + + \begin{code} -- Persistent state for the entire system data CmState = CmState { - gmode :: GhciMode, -- NEVER CHANGES - - hpt :: HomePackageTable, -- Info about home package module - mg :: ModuleGraph, -- the module graph - ic :: InteractiveContext, -- command-line binding info - - pcs :: PersistentCompilerState -- compile's persistent state + cm_hsc :: HscEnv, -- Includes the home-package table + cm_mg :: ModuleGraph, -- The module graph + cm_ic :: InteractiveContext -- Command-line binding info } -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 - return (CmState { hpt = emptyHomePackageTable, - mg = emptyMG, - gmode = gmode, - ic = emptyInteractiveContext, - pcs = pcs }) +#ifdef GHCI +cmGetModuleGraph cmstate = cm_mg cmstate +cmGetBindings cmstate = nameEnvElts (ic_type_env (cm_ic cmstate)) +cmGetPrintUnqual cmstate = icPrintUnqual (cm_ic cmstate) +cmHPT cmstate = hsc_HPT (cm_hsc cmstate) +#endif -cmInit :: GhciMode -> IO CmState -cmInit mode = emptyCmState mode +cmInit :: GhciMode -> DynFlags -> IO CmState +cmInit ghci_mode dflags + = do { hsc_env <- newHscEnv ghci_mode dflags + ; return (CmState { cm_hsc = hsc_env, + cm_mg = emptyMG, + cm_ic = emptyInteractiveContext })} +discardCMInfo :: CmState -> CmState +-- Forget the compilation manager's state, including the home package table +-- but retain the persistent info in HscEnv +discardCMInfo cm_state + = cm_state { cm_mg = emptyMG, cm_ic = emptyInteractiveContext, + cm_hsc = (cm_hsc cm_state) { hsc_HPT = emptyHomePackageTable } } ------------------------------------------------------------------- -- The unlinked image @@ -150,30 +206,16 @@ cmInit mode = emptyCmState mode -- recompiling. type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really) -emptyUI :: UnlinkedImage -emptyUI = [] -findModuleLinkable_maybe :: [Linkable] -> ModuleName -> Maybe Linkable +findModuleLinkable_maybe :: [Linkable] -> Module -> 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 +delModuleLinkable :: [Linkable] -> Module -> [Linkable] +delModuleLinkable ls mod = [ l | l@(LM _ nm _) <- ls, nm /= mod ] \end{code} @@ -191,106 +233,95 @@ linkableInSet l objs_loaded = -- module. They always shadow anything in scope in the current context. cmSetContext - :: CmState -> DynFlags + :: CmState -> [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)) +cmSetContext cmstate toplevs exports = do + let old_ic = cm_ic cmstate + hsc_env = cm_hsc cmstate + hpt = hsc_HPT hsc_env + + let export_mods = map mkModule exports + mapM_ (checkModuleExists (hsc_dflags hsc_env) hpt) export_mods + export_env <- mkExportEnv hsc_env export_mods + toplev_envs <- mapM (mkTopLevEnv hpt) toplevs + + let all_env = foldr plusGlobalRdrEnv export_env toplev_envs + return cmstate{ cm_ic = old_ic { ic_toplev_scope = toplevs, + ic_exports = exports, + ic_rn_gbl_env = all_env } } + +checkModuleExists :: DynFlags -> HomePackageTable -> Module -> IO () +checkModuleExists dflags hpt mod = + case lookupModuleEnv hpt mod of + Just mod_info -> return () _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 + res <- findPackageModule dflags mod True + case res of + Found _ _ -> return () + err -> let msg = cantFindError dflags mod err in + throwDyn (CmdLineError (showSDoc msg)) + +mkTopLevEnv :: HomePackageTable -> String -> IO GlobalRdrEnv +mkTopLevEnv hpt mod + = case lookupModuleEnv hpt (mkModule mod) of + Nothing -> throwDyn (ProgramError ("mkTopLevEnv: not a home module " ++ mod)) + Just details -> case mi_globals (hm_iface details) of + Nothing -> throwDyn (ProgramError ("mkTopLevEnv: not interpreted " ++ mod)) + Just env -> return env cmGetContext :: CmState -> IO ([String],[String]) -cmGetContext CmState{ic=ic} = - return (map moduleUserString (ic_toplev_scope ic), - map moduleUserString (ic_exports ic)) +cmGetContext CmState{cm_ic=ic} = + return (ic_toplev_scope ic, ic_exports ic) cmModuleIsInterpreted :: CmState -> String -> IO Bool cmModuleIsInterpreted cmstate str - = case lookupModuleEnvByName (hpt cmstate) (mkModuleName str) of + = case lookupModuleEnv (cmHPT cmstate) (mkModule str) of Just details -> return (isJust (mi_globals (hm_iface details))) _not_a_home_module -> return False ----------------------------------------------------------------------------- + +cmSetDFlags :: CmState -> DynFlags -> CmState +cmSetDFlags cm_state dflags + = cm_state { cm_hsc = (cm_hsc cm_state) { hsc_dflags = dflags } } + +cmGetDFlags :: CmState -> DynFlags +cmGetDFlags cm_state = hsc_dflags (cm_hsc cm_state) + +----------------------------------------------------------------------------- -- cmInfoThing: convert a String to a TyThing -- A string may refer to more than one TyThing (eg. a constructor, -- and type constructor), so we return a list of all the possible TyThings. -cmInfoThing :: CmState -> DynFlags -> String -> IO (CmState, [(TyThing,Fixity)]) -cmInfoThing cmstate dflags id - = 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 +cmGetInfo :: CmState -> String -> IO [GetInfoResult] +cmGetInfo cmstate id = hscGetInfo (cm_hsc cmstate) (cm_ic cmstate) id -- --------------------------------------------------------------------------- -- 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) +cmBrowseModule :: CmState -> String -> Bool -> IO [IfaceDecl] +cmBrowseModule cmstate str exports_only + = do { mb_decls <- getModuleContents (cm_hsc cmstate) (cm_ic cmstate) + (mkModule str) exports_only + ; case mb_decls of + Nothing -> return [] -- An error of some kind + Just ds -> return ds + } + + +----------------------------------------------------------------------------- +cmShowModule :: CmState -> ModSummary -> String +cmShowModule cmstate mod_summary + = case lookupModuleEnv hpt (ms_mod mod_summary) of + Nothing -> panic "missing linkable" + Just mod_info -> showModMsg obj_linkable mod_summary + where + obj_linkable = isObjectLinkable (hm_linkable mod_info) where - hsc_env = HscEnv { hsc_mode = Interactive, hsc_dflags = dflags, - hsc_HPT = hpt } - CmState{ hpt=hpt, pcs=pcs, ic=icontext } = cmstate + hpt = hsc_HPT (cm_hsc cmstate) ----------------------------------------------------------------------------- -- cmRunStmt: Run a statement/expr. @@ -300,19 +331,18 @@ data CmRunResult | 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 +cmRunStmt :: CmState -> String -> IO (CmState, CmRunResult) +cmRunStmt cmstate@CmState{ cm_hsc=hsc_env, cm_ic=icontext } expr = do - let hsc_env = HscEnv { hsc_mode = Interactive, - hsc_dflags = dflags, - hsc_HPT = hpt } - - (new_pcs, maybe_stuff) - <- hscStmt hsc_env pcs icontext expr + -- Turn off -fwarn-unused-bindings when running a statement, to hide + -- warnings about the implicit bindings we introduce. + let dflags' = dopt_unset (hsc_dflags hsc_env) Opt_WarnUnusedBinds + hsc_env' = hsc_env{ hsc_dflags = dflags' } + + maybe_stuff <- hscStmt hsc_env' icontext expr case maybe_stuff of - Nothing -> return (cmstate{ pcs=new_pcs }, CmRunFailed) + Nothing -> return (cmstate, CmRunFailed) Just (new_ic, names, hval) -> do let thing_to_run = unsafeCoerce# hval :: IO [HValue] @@ -323,7 +353,7 @@ cmRunStmt cmstate@CmState{ hpt=hpt, pcs=pcs, ic=icontext } -- 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 ) + return ( cmstate, CmRunException e ) Right hvals -> do -- Get the newly bound things, and bind them. @@ -331,7 +361,7 @@ cmRunStmt cmstate@CmState{ hpt=hpt, pcs=pcs, ic=icontext } -- the new ones override the old ones. extendLinkEnv (zip names hvals) - return (cmstate{ pcs=new_pcs, ic=new_ic }, + return (cmstate{ cm_ic=new_ic }, CmRunOk names) @@ -373,36 +403,46 @@ foreign import "rts_evalStableIO" {- safe -} ----------------------------------------------------------------------------- -- cmTypeOfExpr: returns a string representing the type of an expression -cmTypeOfExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe String) -cmTypeOfExpr cmstate dflags expr - = do (new_pcs, maybe_stuff) <- hscTcExpr hsc_env pcs ic expr - - let new_cmstate = cmstate{pcs = new_pcs} +cmTypeOfExpr :: CmState -> String -> IO (Maybe String) +cmTypeOfExpr cmstate expr + = do maybe_stuff <- hscTcExpr (cm_hsc cmstate) (cm_ic cmstate) expr case maybe_stuff of - Nothing -> return (new_cmstate, Nothing) - Just ty -> return (new_cmstate, Just str) + Nothing -> return Nothing + Just ty -> return (Just (showSDocForUser unqual doc)) where - str = showSDocForUser unqual (text expr <+> dcolon <+> ppr tidy_ty) - unqual = icPrintUnqual ic + doc = text expr <+> dcolon <+> ppr final_ty + unqual = icPrintUnqual (cm_ic cmstate) tidy_ty = tidyType emptyTidyEnv ty - where - CmState{ hpt=hpt, pcs=pcs, ic=ic } = cmstate - hsc_env = HscEnv { hsc_mode = Interactive, - hsc_dflags = dflags, - hsc_HPT = hpt } - + dflags = hsc_dflags (cm_hsc cmstate) + -- if -fglasgow-exts is on we show the foralls, otherwise + -- we don't. + final_ty + | dopt Opt_GlasgowExts dflags = tidy_ty + | otherwise = dropForAlls tidy_ty +----------------------------------------------------------------------------- +-- cmKindOfType: returns a string representing the kind of a type + +cmKindOfType :: CmState -> String -> IO (Maybe String) +cmKindOfType cmstate str + = do maybe_stuff <- hscKcType (cm_hsc cmstate) (cm_ic cmstate) str + case maybe_stuff of + Nothing -> return Nothing + Just kind -> return (Just res_str) + where + res_str = showSDocForUser unqual (text str <+> dcolon <+> ppr kind) + unqual = icPrintUnqual (cm_ic cmstate) ----------------------------------------------------------------------------- -- cmTypeOfName: returns a string representing the type of a name. cmTypeOfName :: CmState -> Name -> IO (Maybe String) -cmTypeOfName CmState{ pcs=pcs, ic=ic } name +cmTypeOfName CmState{ cm_ic=ic } name = do hPutStrLn stderr ("cmTypeOfName: " ++ showSDoc (ppr name)) case lookupNameEnv (ic_type_env ic) name of - Nothing -> return Nothing + Nothing -> return Nothing Just (AnId id) -> return (Just str) where unqual = icPrintUnqual ic @@ -414,30 +454,24 @@ cmTypeOfName CmState{ pcs=pcs, ic=ic } name ----------------------------------------------------------------------------- -- cmCompileExpr: compile an expression and deliver an HValue -cmCompileExpr :: CmState -> DynFlags -> String -> IO (CmState, Maybe HValue) -cmCompileExpr cmstate dflags expr +cmCompileExpr :: CmState -> String -> IO (Maybe HValue) +cmCompileExpr cmstate expr = do - let hsc_env = HscEnv { hsc_mode = Interactive, - hsc_dflags = dflags, - hsc_HPT = hpt } - - (new_pcs, maybe_stuff) - <- hscStmt hsc_env pcs icontext + maybe_stuff + <- hscStmt (cm_hsc cmstate) (cm_ic cmstate) ("let __cmCompileExpr = "++expr) case maybe_stuff of - Nothing -> return (cmstate{ pcs=new_pcs }, Nothing) + Nothing -> return Nothing Just (new_ic, names, hval) -> do -- Run it! hvals <- (unsafeCoerce# hval) :: IO [HValue] case (names,hvals) of - ([n],[hv]) -> return (cmstate{ pcs=new_pcs }, Just hv) + ([n],[hv]) -> return (Just hv) _ -> panic "cmCompileExpr" - where - CmState{ hpt=hpt, pcs=pcs, ic=icontext } = cmstate #endif /* GHCI */ \end{code} @@ -453,26 +487,27 @@ cmCompileExpr cmstate dflags expr -- 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, pcs=pcs } dflags +cmUnload :: CmState -> IO CmState +cmUnload state@CmState{ cm_hsc = hsc_env } = do -- Throw away the old home dir cache flushFinderCache -- Unload everything the linker knows about - cm_unload mode dflags [] + cm_unload hsc_env [] -- Start with a fresh CmState, but keep the PersistentCompilerState - new_state <- cmInit mode - return new_state{ pcs=pcs } - -cm_unload Batch dflags linkables = return () + return (discardCMInfo state) +cm_unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables' + = case hsc_mode hsc_env of + Batch -> return () #ifdef GHCI -cm_unload Interactive dflags linkables = Linker.unload dflags linkables + Interactive -> Linker.unload (hsc_dflags hsc_env) stable_linkables #else -cm_unload Interactive dflags linkables = panic "unload: no interpreter" + Interactive -> panic "cm_unload: no interpreter" #endif - + other -> panic "cm_unload: strange mode" + ----------------------------------------------------------------------------- -- Trace dependency graph @@ -485,14 +520,18 @@ cm_unload Interactive dflags linkables = panic "unload: no interpreter" -- 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 +cmDepAnal :: CmState -> [FilePath] -> IO ModuleGraph +cmDepAnal cmstate rootnames = do showPass dflags "Chasing dependencies" - when (verbosity dflags >= 1 && gmode cmstate == Batch) $ + when (verbosity dflags >= 1 && gmode == Batch) $ hPutStrLn stderr (showSDoc (hcat [ text "Chasing modules from: ", hcat (punctuate comma (map text rootnames))])) - downsweep rootnames (mg cmstate) + cmDownsweep dflags rootnames (cm_mg cmstate) [] + where + hsc_env = cm_hsc cmstate + dflags = hsc_dflags hsc_env + gmode = hsc_mode hsc_env ----------------------------------------------------------------------------- -- The real business of the compilation manager: given a system state and @@ -500,40 +539,42 @@ cmDepAnal cmstate dflags rootnames -- the system state at the same time. cmLoadModules :: CmState -- The HPT may not be as up to date - -> DynFlags -- as the ModuleGraph - -> ModuleGraph -- Bang up to date + -> ModuleGraph -- Bang up to date; but may contain hi-boot no -> IO (CmState, -- new state SuccessFlag, -- was successful [String]) -- list of modules loaded -cmLoadModules cmstate1 dflags mg2unsorted +cmLoadModules cmstate1 mg2unsorted = do -- version 1's are the original, before downsweep - let pcs1 = pcs cmstate1 - let hpt1 = hpt cmstate1 - - let ghci_mode = gmode cmstate1 -- this never changes + let hsc_env = cm_hsc cmstate1 + let hpt1 = hsc_HPT hsc_env + let ghci_mode = hsc_mode hsc_env -- this never changes + let dflags = hsc_dflags hsc_env -- this never changes -- Do the downsweep to reestablish the module graph let verb = verbosity dflags -- Find out if we have a Main module - let a_root_is_Main - = any ((=="Main").moduleNameUserString.modSummaryName) + mb_main_mod <- readIORef v_MainModIs + let + main_mod = mb_main_mod `orElse` "Main" + a_root_is_Main + = any ((==main_mod).moduleUserString.ms_mod) mg2unsorted - let mg2unsorted_names = map modSummaryName mg2unsorted + let mg2unsorted_names = map ms_mod mg2unsorted - -- reachable_from follows source as well as normal imports - let reachable_from :: ModuleName -> [ModuleName] - reachable_from = downwards_closure_of_module mg2unsorted - - -- should be cycle free; ignores 'import source's - let mg2 = topological_sort False mg2unsorted - -- ... whereas this takes them into account. Used for + -- mg2 should be cycle free; but it includes hi-boot ModSummary nodes + let mg2 :: [SCC ModSummary] + mg2 = cmTopSort False mg2unsorted + + -- mg2_with_srcimps drops the hi-boot nodes, returning a + -- graph with cycles. Among other things, it is used for -- backing out partially complete cycles following a failed -- upsweep, and for removing from hpt all the modules -- not in strict downwards closure, during calls to compile. - let mg2_with_srcimps = topological_sort True mg2unsorted + let mg2_with_srcimps :: [SCC ModSummary] + mg2_with_srcimps = cmTopSort True mg2unsorted -- Sort out which linkables we wish to keep in the unlinked image. -- See getValidLinkables below for details. @@ -543,8 +584,10 @@ cmLoadModules cmstate1 dflags mg2unsorted -- 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) + -- The new_linkables are .o files we found on the disk, presumably + -- as a result of a GHC run "on the side". So we'd better forget + -- everything we know abouut those modules! + let old_hpt = delModuleEnvList hpt1 (map linkableModule new_linkables) -- When (verb >= 2) $ -- putStrLn (showSDoc (text "Valid linkables:" @@ -560,36 +603,36 @@ cmLoadModules cmstate1 dflags mg2unsorted -- 1. All home imports of ms are either in ms or S -- 2. A valid old linkable exists for each module in ms - stable_mods <- preUpsweep valid_old_linkables - mg2unsorted_names [] mg2_with_srcimps + -- mg2_with_srcimps has no hi-boot nodes, + -- and hence neither does stable_mods + stable_summaries <- preUpsweep valid_old_linkables + mg2unsorted_names [] mg2_with_srcimps + let stable_mods = map ms_mod stable_summaries + stable_linkables = filter (\m -> linkableModule m `elem` stable_mods) + valid_old_linkables - let stable_summaries - = concatMap (findInSummaries mg2unsorted) stable_mods + stable_hpt = filterModuleEnv is_stable_hm hpt1 + is_stable_hm hm_info = mi_module (hm_iface hm_info) `elem` stable_mods - stable_linkables - = filter (\m -> linkableModName m `elem` stable_mods) - valid_old_linkables + upsweep_these + = filter (\scc -> any (`notElem` stable_mods) + (map ms_mod (flattenSCC scc))) + mg2 when (verb >= 2) $ hPutStrLn stderr (showSDoc (text "Stable modules:" - <+> sep (map (text.moduleNameUserString) stable_mods))) + <+> sep (map (text.moduleUserString) stable_mods))) - -- Unload any modules which are going to be re-linked this - -- time around. - cm_unload ghci_mode dflags stable_linkables + -- Unload any modules which are going to be re-linked this time around. + cm_unload hsc_env stable_linkables - -- we can now glom together our linkable sets + -- We can now glom together our linkable sets let valid_linkables = valid_old_linkables ++ new_linkables -- We could at this point detect cycles which aren't broken by -- a source-import, and complain immediately, but it seems better -- to let upsweep_mods do this, so at least some useful work gets -- done before the upsweep is abandoned. - let upsweep_these - = filter (\scc -> any (`notElem` stable_mods) - (map modSummaryName (flattenSCC scc))) - mg2 - --hPutStrLn stderr "after tsort:\n" --hPutStrLn stderr (showSDoc (vcat (map ppr mg2))) @@ -601,17 +644,14 @@ cmLoadModules cmstate1 dflags mg2unsorted -- Now do the upsweep, calling compile for each module in -- turn. Final result is version 3 of everything. - let threaded2 = CmThreaded pcs1 hpt2 - -- clean up between compilations - let cleanup = cleanTempFilesExcept verb + let cleanup = cleanTempFilesExcept dflags (ppFilesFromSummaries (flattenSCCs mg2)) - (upsweep_ok, threaded3, modsUpswept) - <- upsweep_mods ghci_mode dflags valid_linkables reachable_from - threaded2 cleanup upsweep_these - - let (CmThreaded pcs3 hpt3) = threaded3 + (upsweep_ok, hsc_env3, modsUpswept) + <- upsweep_mods (hsc_env { hsc_HPT = stable_hpt }) + (old_hpt, valid_linkables) + cleanup upsweep_these -- At this point, modsUpswept and newLis should have the same -- length, so there is one new (or old) linkable for each @@ -636,20 +676,27 @@ cmLoadModules cmstate1 dflags mg2unsorted hPutStrLn stderr "Upsweep completely successful." -- clean up after ourselves - cleanTempFilesExcept verb (ppFilesFromSummaries modsDone) + cleanTempFilesExcept dflags (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 + 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." + hPutStrLn stderr ("Warning: output was redirected with -o, but no output will be generated\nbecause there is no " ++ main_mod ++ " module.") -- link everything together - linkresult <- link ghci_mode dflags a_root_is_Main hpt3 + linkresult <- link ghci_mode dflags do_linking (hsc_HPT hsc_env3) - cmLoadFinish Succeeded linkresult - hpt3 modsDone ghci_mode pcs3 + let cmstate3 = cmstate1 { cm_mg = modsDone, cm_hsc = hsc_env3 } + cmLoadFinish Succeeded linkresult cmstate3 else -- Tricky. We need to back out the effects of compiling any @@ -659,57 +706,48 @@ cmLoadModules cmstate1 dflags mg2unsorted hPutStrLn stderr "Upsweep partially successful." let modsDone_names - = map modSummaryName modsDone + = map ms_mod modsDone let mods_to_zap_names = findPartiallyCompletedCycles modsDone_names mg2_with_srcimps let mods_to_keep - = filter ((`notElem` mods_to_zap_names).modSummaryName) + = filter ((`notElem` mods_to_zap_names).ms_mod) modsDone - let hpt4 = retainInTopLevelEnvs (map modSummaryName mods_to_keep) hpt3 + let hpt4 = retainInTopLevelEnvs (map ms_mod mods_to_keep) + (hsc_HPT hsc_env3) -- Clean up after ourselves - cleanTempFilesExcept verb (ppFilesFromSummaries mods_to_keep) + cleanTempFilesExcept dflags (ppFilesFromSummaries mods_to_keep) -- Link everything together linkresult <- link ghci_mode dflags False hpt4 - cmLoadFinish Failed linkresult - hpt4 mods_to_keep ghci_mode pcs3 + let cmstate3 = cmstate1 { cm_mg = mods_to_keep, + cm_hsc = hsc_env3 { hsc_HPT = hpt4 } } + cmLoadFinish Failed linkresult cmstate3 -- Finish up after a cmLoad. -- If the link failed, unload everything and return. -cmLoadFinish ok Failed hpt mods ghci_mode pcs = do - dflags <- getDynFlags - cm_unload ghci_mode dflags [] - new_state <- cmInit ghci_mode - return (new_state{ pcs=pcs }, Failed, []) +cmLoadFinish ok Failed cmstate + = do cm_unload (cm_hsc cmstate) [] + return (discardCMInfo cmstate, Failed, []) -- Empty the interactive context and set the module context to the topmost -- newly loaded module, or the Prelude if none were loaded. -cmLoadFinish ok Succeeded 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 +cmLoadFinish ok Succeeded cmstate + = do let new_cmstate = cmstate { cm_ic = emptyInteractiveContext } + mods_loaded = map (moduleUserString.ms_mod) + (cm_mg cmstate) return (new_cmstate, ok, mods_loaded) --- used to fish out the preprocess output files for the purposes --- of cleaning up. -ppFilesFromSummaries summaries - = [ fn | Just fn <- map toPpFile summaries ] - where - toPpFile sum - | hspp /= ml_hs_file loc = hspp - | otherwise = Nothing - where - loc = ms_location sum - hspp = ml_hspp_file loc - +-- used to fish out the preprocess output files for the purposes of +-- cleaning up. The preprocessed file *might* be the same as the +-- source file, but that doesn't do any harm. +ppFilesFromSummaries summaries = [ fn | Just fn <- map ms_hspp_file summaries ] ----------------------------------------------------------------------------- -- getValidLinkables @@ -736,16 +774,19 @@ ppFilesFromSummaries summaries getValidLinkables :: GhciMode -> [Linkable] -- old linkables - -> [ModuleName] -- all home modules + -> [Module] -- all home modules -> [SCC ModSummary] -- all modules in the program, dependency order -> IO ( [Linkable], -- still-valid linkables - [Linkable] -- new linkables we just found + [Linkable] -- new linkables we just found on the disk + -- presumably generated by separate run of ghc ) -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 [] []) +getValidLinkables mode old_linkables all_home_mods module_graph + = do { -- Process the SCCs in bottom-to-top order + -- (foldM works left-to-right) + 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 @@ -753,20 +794,28 @@ getValidLinkables mode old_linkables all_home_mods module_graph = do | otherwise = partition_it ls (l:valid) new +getValidLinkablesSCC + :: GhciMode + -> [Linkable] -- old linkables + -> [Module] -- all home modules + -> [(Linkable,Bool)] + -> SCC ModSummary + -> IO [(Linkable,Bool)] + getValidLinkablesSCC mode old_linkables all_home_mods new_linkables scc0 = let scc = flattenSCC scc0 - scc_names = map modSummaryName scc + scc_names = map ms_mod scc home_module m = m `elem` all_home_mods && m `notElem` scc_names scc_allhomeimps = nub (filter home_module (concatMap ms_imps scc)) -- NB. ms_imps, not ms_allimps above. We don't want to -- force a module's SOURCE imports to be already compiled for -- its object linkable to be valid. - has_object m = - case findModuleLinkable_maybe (map fst new_linkables) m of - Nothing -> False - Just l -> isObjectLinkable l + -- The new_linkables is only the *valid* linkables below here + has_object m = case findModuleLinkable_maybe (map fst new_linkables) m of + Nothing -> False + Just l -> isObjectLinkable l objects_allowed = mode == Batch || all has_object scc_allhomeimps in do @@ -796,7 +845,7 @@ getValidLinkable old_linkables objects_allowed new_linkables summary -- 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 + = do let mod_name = ms_mod summary maybe_disk_linkable <- if (not objects_allowed) @@ -862,61 +911,46 @@ hptLinkables hpt = map hm_linkable (moduleEnvElts hpt) -- * has an interface in the HPT (interactive mode only) preUpsweep :: [Linkable] -- new valid linkables - -> [ModuleName] -- names of all mods encountered in downsweep - -> [ModuleName] -- accumulating stable modules + -> [Module] -- names of all mods encountered in downsweep + -> [ModSummary] -- accumulating stable modules -> [SCC ModSummary] -- scc-ified mod graph, including src imps - -> IO [ModuleName] -- stable modules + -> IO [ModSummary] -- stable modules preUpsweep valid_lis all_home_mods stable [] = return stable preUpsweep valid_lis all_home_mods stable (scc0:sccs) = do let scc = flattenSCC scc0 - scc_allhomeimps :: [ModuleName] + scc_allhomeimps :: [Module] scc_allhomeimps = nub (filter (`elem` all_home_mods) (concatMap ms_allimps scc)) all_imports_in_scc_or_stable = all in_stable_or_scc scc_allhomeimps - scc_names - = map modSummaryName scc - in_stable_or_scc m - = m `elem` scc_names || m `elem` stable + scc_mods = map ms_mod scc + stable_names = scc_mods ++ map ms_mod stable + in_stable_or_scc m = m `elem` stable_names -- now we check for valid linkables: each module in the SCC must -- have a valid linkable (see getValidLinkables above). - has_valid_linkable new_summary - = isJust (findModuleLinkable_maybe valid_lis modname) - where modname = modSummaryName new_summary + has_valid_linkable scc_mod + = isJust (findModuleLinkable_maybe valid_lis scc_mod) scc_is_stable = all_imports_in_scc_or_stable - && all has_valid_linkable scc + && all has_valid_linkable scc_mods if scc_is_stable - then preUpsweep valid_lis all_home_mods (scc_names++stable) sccs - else preUpsweep valid_lis all_home_mods stable sccs - + then preUpsweep valid_lis all_home_mods (scc ++ stable) sccs + else preUpsweep valid_lis all_home_mods stable sccs --- Helper for preUpsweep. Assuming that new_summary's imports are all --- stable (in the sense of preUpsweep), determine if new_summary is itself --- stable, and, if so, in batch mode, return its linkable. -findInSummaries :: [ModSummary] -> ModuleName -> [ModSummary] -findInSummaries old_summaries mod_name - = [s | s <- old_summaries, modSummaryName s == mod_name] - -findModInSummaries :: [ModSummary] -> Module -> Maybe ModSummary -findModInSummaries old_summaries mod - = case [s | s <- old_summaries, ms_mod s == mod] of - [] -> Nothing - (s:_) -> Just s -- Return (names of) all those in modsDone who are part of a cycle -- as defined by theGraph. -findPartiallyCompletedCycles :: [ModuleName] -> [SCC ModSummary] -> [ModuleName] +findPartiallyCompletedCycles :: [Module] -> [SCC ModSummary] -> [Module] findPartiallyCompletedCycles modsDone theGraph = chew theGraph where chew [] = [] chew ((AcyclicSCC v):rest) = chew rest -- acyclic? not interesting. chew ((CyclicSCC vs):rest) - = let names_in_this_cycle = nub (map modSummaryName vs) + = let names_in_this_cycle = nub (map ms_mod vs) mods_in_this_cycle = nub ([done | done <- modsDone, done `elem` names_in_this_cycle]) @@ -928,175 +962,162 @@ findPartiallyCompletedCycles modsDone theGraph else chewed_rest -data CmThreaded -- stuff threaded through individual module compilations - = 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 - -> [Linkable] -- Valid linkables - -> (ModuleName -> [ModuleName]) -- to construct downward closures - -> CmThreaded -- PCS & HPT - -> IO () -- how to clean up unwanted tmp files - -> [SCC ModSummary] -- mods to do (the worklist) - -- ...... RETURNING ...... +upsweep_mods :: HscEnv -- Includes initially-empty HPT + -> (HomePackageTable, [Linkable]) -- HPT and valid linkables from last time round + -> IO () -- How to clean up unwanted tmp files + -> [SCC ModSummary] -- Mods to do (the worklist) -> IO (SuccessFlag, - CmThreaded, -- Includes linkables + HscEnv, -- With an updated HPT [ModSummary]) -- Mods which succeeded -upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup +upsweep_mods hsc_env oldUI cleanup [] - = return (Succeeded, threaded, []) + = return (Succeeded, hsc_env, []) -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.modSummaryName) ms)) - return (Failed, threaded, []) +upsweep_mods hsc_env oldUI cleanup + (CyclicSCC ms:_) + = do hPutStrLn stderr (showSDoc (cyclicModuleErr ms)) + return (Failed, hsc_env, []) -upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup - ((AcyclicSCC mod):mods) - = do --case threaded of - -- CmThreaded pcsz hptz - -- -> putStrLn ("UPSWEEP_MOD: hpt = " ++ - -- show (map (moduleNameUserString.moduleName.mi_module.hm_iface) (eltsUFM hptz))) +upsweep_mods hsc_env oldUI@(old_hpt, old_linkables) cleanup + (AcyclicSCC mod:mods) + = do -- putStrLn ("UPSWEEP_MOD: hpt = " ++ + -- show (map (moduleUserString.moduleName.mi_module.hm_iface) + -- (moduleEnvElts (hsc_HPT hsc_env))) - (ok_flag, threaded1) <- upsweep_mod ghci_mode dflags oldUI threaded mod - (reachable_from (modSummaryName mod)) + mb_mod_info <- upsweep_mod hsc_env oldUI 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 cleanup mods - return (restOK, threaded2, mod:modOKs) + case mb_mod_info of + Nothing -> return (Failed, hsc_env, []) + Just mod_info -> do + { let this_mod = ms_mod mod + + -- Add new info to hsc_env + hpt1 = extendModuleEnv (hsc_HPT hsc_env) this_mod mod_info + hsc_env1 = hsc_env { hsc_HPT = hpt1 } + + -- Space-saving: delete the old HPT entry and linkable for mod + -- BUT if mod is a hs-boot node, don't delete it + -- For the linkable this is dead right: the linkable relates only + -- to the main Haskell source file. + -- For the interface, the HPT entry is probaby for the main Haskell + -- source file. Deleting it would force + oldUI1 | isHsBoot (ms_hsc_src mod) = oldUI + | otherwise + = (delModuleEnv old_hpt this_mod, + delModuleLinkable old_linkables this_mod) + + ; (restOK, hsc_env2, modOKs) <- upsweep_mods hsc_env1 oldUI1 cleanup mods + ; return (restOK, hsc_env2, mod:modOKs) } -- Compile a single module. Always produce a Linkable for it if -- successful. If no compilation happened, return the old Linkable. -upsweep_mod :: GhciMode - -> DynFlags - -> UnlinkedImage - -> CmThreaded +upsweep_mod :: HscEnv + -> (HomePackageTable, UnlinkedImage) -> ModSummary - -> [ModuleName] - -> IO (SuccessFlag, CmThreaded) + -> IO (Maybe HomeModInfo) -- Nothing => Failed -upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me +upsweep_mod hsc_env (old_hpt, old_linkables) summary = do - let this_mod = ms_mod summary1 - location = ms_location summary1 - mod_name = moduleName this_mod - - 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 + let this_mod = ms_mod summary + + -- The old interface is ok if it's in the old HPT + -- a) we're compiling a source file, and the old HPT entry is for a source file + -- b) we're compiling a hs-boot file + -- Case (b) allows an hs-boot file to get the interface of its real source file + -- on the second iteration of the compilation manager, but that does no harm. + -- Otherwise the hs-boot file will always be recompiled + mb_old_iface + = case lookupModuleEnv old_hpt this_mod of + Nothing -> Nothing + Just hm_info | isHsBoot (ms_hsc_src summary) -> Just iface + | not (mi_boot iface) -> Just iface + | otherwise -> Nothing + where + iface = hm_iface hm_info + + maybe_old_linkable = findModuleLinkable_maybe old_linkables this_mod source_unchanged = isJust maybe_old_linkable - reachable_only = filter (/= mod_name) reachable_inc_me - - -- In interactive mode, all home modules below us *must* have an - -- interface in the HPT. We never demand-load home interfaces in - -- interactive mode. - hpt1_strictDC - = ASSERT(ghci_mode == Batch || all (`elemUFM` hpt1) reachable_only) - retainInTopLevelEnvs reachable_only hpt1 - 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 this_mod location source_unchanged - have_object mb_old_iface hpt1_strictDC pcs1 + compresult <- compile hsc_env summary source_unchanged have_object mb_old_iface case compresult of -- 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 + CompOK new_details new_iface maybe_new_linkable -> 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) + return (Just new_info) -- Compilation failed. Compile may still have updated the PCS, tho. - CompErrs pcs2 -> return (Failed, CmThreaded pcs2 hpt1) + CompErrs -> return Nothing -- Filter modules in the HPT -retainInTopLevelEnvs :: [ModuleName] -> HomePackageTable -> HomePackageTable +retainInTopLevelEnvs :: [Module] -> HomePackageTable -> HomePackageTable retainInTopLevelEnvs keep_these hpt - = listToUFM (concatMap (maybeLookupUFM hpt) keep_these) + = mkModuleEnv [ (mod, fromJust mb_mod_info) + | mod <- keep_these + , let mb_mod_info = lookupModuleEnv hpt mod + , isJust mb_mod_info ] + +----------------------------------------------------------------------------- +cmTopSort :: Bool -- Drop hi-boot nodes? (see below) + -> [ModSummary] + -> [SCC ModSummary] +-- Calculate SCCs of the module graph, possibly dropping the hi-boot nodes +-- +-- Drop hi-boot nodes (first boolean arg)? +-- +-- False: treat the hi-boot summaries as nodes of the graph, +-- so the graph must be acyclic +-- +-- True: eliminate the hi-boot nodes, and instead pretend +-- the a source-import of Foo is an import of Foo +-- The resulting graph has no hi-boot nodes, but can by cyclic + +cmTopSort drop_hs_boot_nodes summaries + = stronglyConnComp nodes where - maybeLookupUFM ufm u = case lookupUFM ufm u of - Nothing -> [] - Just val -> [(u, val)] - --- Needed to clean up HPT so that we don't get duplicates in inst env -downwards_closure_of_module :: [ModSummary] -> ModuleName -> [ModuleName] -downwards_closure_of_module summaries root - = let toEdge :: ModSummary -> (ModuleName,[ModuleName]) - toEdge summ = (modSummaryName summ, - filter (`elem` all_mods) (ms_allimps summ)) - - all_mods = map modSummaryName summaries - - res = simple_transitive_closure (map toEdge summaries) [root] - in --- trace (showSDoc (text "DC of mod" <+> ppr root --- <+> text "=" <+> ppr res)) $ - res - --- Calculate transitive closures from a set of roots given an adjacency list -simple_transitive_closure :: Eq a => [(a,[a])] -> [a] -> [a] -simple_transitive_closure graph set - = let set2 = nub (concatMap dsts set ++ set) - dsts node = fromMaybe [] (lookup node graph) - in - if length set == length set2 - then set - else simple_transitive_closure graph set2 - - --- Calculate SCCs of the module graph, with or without taking into --- account source imports. -topological_sort :: Bool -> [ModSummary] -> [SCC ModSummary] -topological_sort include_source_imports summaries - = let - toEdge :: ModSummary -> (ModSummary,ModuleName,[ModuleName]) - toEdge summ - = (summ, modSummaryName summ, - (if include_source_imports - then ms_srcimps summ else []) ++ ms_imps summ) - - mash_edge :: (ModSummary,ModuleName,[ModuleName]) -> (ModSummary,Int,[Int]) - mash_edge (summ, m, m_imports) - = case lookup m key_map of - Nothing -> panic "reverse_topological_sort" - Just mk -> (summ, mk, - -- ignore imports not from the home package - catMaybes (map (flip lookup key_map) m_imports)) - - edges = map toEdge summaries - key_map = zip [nm | (s,nm,imps) <- edges] [1 ..] :: [(ModuleName,Int)] - scc_input = map mash_edge edges - sccs = stronglyConnComp scc_input - in - sccs + -- Drop hs-boot nodes by using HsSrcFile as the key + hs_boot_key | drop_hs_boot_nodes = HsSrcFile + | otherwise = HsBootFile + + -- We use integers as the keys for the SCC algorithm + nodes :: [(ModSummary, Int, [Int])] + nodes = [(s, fromJust (lookup_key (ms_hsc_src s) (ms_mod s)), + out_edge_keys hs_boot_key (ms_srcimps s) ++ + out_edge_keys HsSrcFile (ms_imps s) ) + | s <- summaries + , not (ms_hsc_src s == HsBootFile && drop_hs_boot_nodes) ] + -- Drop the hi-boot ones if told to do so + + key_map :: NodeMap Int + key_map = listToFM ([(ms_mod s, ms_hsc_src s) | s <- summaries] + `zip` [1..]) + + lookup_key :: HscSource -> Module -> Maybe Int + lookup_key hs_src mod = lookupFM key_map (mod, hs_src) + + out_edge_keys :: HscSource -> [Module] -> [Int] + out_edge_keys hi_boot ms = mapCatMaybes (lookup_key hi_boot) ms + -- If we want keep_hi_boot_nodes, then we do lookup_key with + -- the IsBootInterface parameter True; else False ----------------------------------------------------------------------------- @@ -1109,32 +1130,40 @@ topological_sort include_source_imports summaries -- 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 +-- +-- The returned list of [ModSummary] nodes has one node for each home-package +-- module. The imports of these nodes are all there, including the imports +-- of non-home-package modules. + +cmDownsweep :: DynFlags + -> [FilePath] -- Roots + -> [ModSummary] -- Old summaries + -> [Module] -- Ignore dependencies on these; treat them as + -- if they were package modules + -> IO [ModSummary] +cmDownsweep dflags roots old_summaries excl_mods = do rootSummaries <- mapM getRootSummary roots checkDuplicates rootSummaries - all_summaries - <- loop (concat (map (\ m -> zip (repeat (fromMaybe "" (ml_hs_file (ms_location m)))) - (ms_imps m)) rootSummaries)) - (mkModuleEnv [ (mod, s) | s <- rootSummaries, - let mod = ms_mod s, isHomeModule mod - ]) - return all_summaries + loop (concatMap msImports rootSummaries) + (mkNodeMap rootSummaries) where + old_summary_map :: NodeMap ModSummary + old_summary_map = mkNodeMap old_summaries + getRootSummary :: FilePath -> IO ModSummary getRootSummary file - | haskellish_src_file file + | isHaskellSrcFilename file = do exists <- doesFileExist file - if exists then summariseFile file else do + if exists then summariseFile dflags file else do throwDyn (CmdLineError ("can't find file `" ++ file ++ "'")) | otherwise = do exists <- doesFileExist hs_file - if exists then summariseFile hs_file else do + if exists then summariseFile dflags hs_file else do exists <- doesFileExist lhs_file - if exists then summariseFile lhs_file else do - let mod_name = mkModuleName file - maybe_summary <- getSummary (file, mod_name) + if exists then summariseFile dflags lhs_file else do + let mod_name = mkModule file + maybe_summary <- summarise dflags emptyNodeMap Nothing False + mod_name excl_mods case maybe_summary of Nothing -> packageModErr mod_name Just s -> return s @@ -1158,48 +1187,31 @@ downsweep roots old_summaries [ 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 - Right (mod, location) -> do - let old_summary = findModInSummaries old_summaries mod - summarise mod location old_summary - - Left files -> do - dflags <- getDynFlags - throwDyn (noModError dflags currentMod nm files) - - -- loop invariant: env doesn't contain package modules - loop :: [(FilePath,ModuleName)] -> ModuleEnv ModSummary -> IO [ModSummary] - loop [] env = return (moduleEnvElts env) - loop imps env - = do -- imports for modules we don't already have - let needed_imps = nub (filter (not . (`elemUFM` env).snd) imps) - - -- summarise them - needed_summaries <- mapM getSummary needed_imps - - -- get just the "home" modules - let new_home_summaries = [ s | Just s <- needed_summaries ] - - -- loop, checking the new imports - let new_imps = concat (map (\ m -> zip (repeat (fromMaybe "" (ml_hs_file (ms_location m)))) - (ms_imps m)) new_home_summaries) - loop new_imps (extendModuleEnvList env - [ (ms_mod s, s) | s <- new_home_summaries ]) + loop :: [(FilePath,Module,IsBootInterface)] -- Work list: process these modules + -> NodeMap ModSummary -- Visited set + -> IO [ModSummary] -- The result includes the worklist, except + -- for those mentioned in the visited set + loop [] done = return (nodeMapElts done) + loop ((cur_path, wanted_mod, is_boot) : ss) done + | key `elemFM` done = loop ss done + | otherwise = do { mb_s <- summarise dflags old_summary_map + (Just cur_path) is_boot + wanted_mod excl_mods + ; case mb_s of + Nothing -> loop ss done + Just s -> loop (msImports s ++ ss) + (addToFM done key s) } + where + key = (wanted_mod, if is_boot then HsBootFile else HsSrcFile) + +msImports :: ModSummary -> [(FilePath, -- Importing module + Module, -- Imported module + IsBootInterface)] -- {-# SOURCE #-} import or not +msImports s = [(f, m,True) | m <- ms_srcimps s] + ++ [(f, m,False) | m <- ms_imps s] + where + f = msHsFilePath s -- Keep the importing module for error reporting --- 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 @@ -1214,67 +1226,129 @@ noModError dflags loc mod_nm files = ProgramError (showSDoc ( -- a summary. The finder is used to locate the file in which the module -- resides. -summariseFile :: FilePath -> IO ModSummary -summariseFile file - = do hspp_fn <- preprocess file - (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn - - let (path, basename, ext) = splitFilename3 file - -- GHC.Prim doesn't exist physically, so don't go looking for it. - the_imps = filter (/= gHC_PRIM_Name) imps - - (mod, location) <- mkHomeModLocation mod_name True{-is a root-} - path basename ext - - src_timestamp - <- case ml_hs_file location of - Nothing -> noHsFileErr mod_name - Just src_fn -> getModificationTime src_fn - - return (ModSummary { ms_mod = mod, - ms_location = location{ml_hspp_file=Just hspp_fn}, +summariseFile :: DynFlags -> FilePath -> IO ModSummary +-- Used for Haskell source only, I think +-- We know the file name, and we know it exists, +-- but we don't necessarily know the module name (might differ) +summariseFile dflags file + = do (dflags', hspp_fn) <- preprocess dflags file + -- The dflags' contains the OPTIONS pragmas + + -- Read the file into a buffer. We're going to cache + -- this buffer in the ModLocation (ml_hspp_buf) so that it + -- doesn't have to be slurped again when hscMain parses the + -- file later. + buf <- hGetStringBuffer hspp_fn + (srcimps,the_imps,mod) <- getImports dflags' buf hspp_fn + + -- Make a ModLocation for this file + location <- mkHomeModLocation mod file + + -- Tell the Finder cache where it is, so that subsequent calls + -- to findModule will find it, even if it's not on any search path + addHomeModuleToFinder mod location + + src_timestamp <- getModificationTime file + return (ModSummary { ms_mod = mod, ms_hsc_src = HsSrcFile, + ms_location = location, + ms_hspp_file = Just hspp_fn, + ms_hspp_buf = Just buf, ms_srcimps = srcimps, ms_imps = the_imps, ms_hs_date = src_timestamp }) -- Summarise a module, and pick up source and timestamp. -summarise :: Module -> ModLocation -> Maybe ModSummary - -> IO (Maybe ModSummary) -summarise mod location old_summary - | not (isHomeModule mod) = return Nothing - | otherwise - = do let hs_fn = expectJust "summarise" (ml_hs_file location) - - case ml_hs_file location of { - Nothing -> noHsFileErr mod; - Just src_fn -> do - - src_timestamp <- getModificationTime src_fn - - -- return the cached summary if the source didn't change - case old_summary of { - Just s | ms_hs_date s == src_timestamp -> return (Just s); - _ -> do - - hspp_fn <- preprocess hs_fn - (srcimps,imps,mod_name) <- getImportsFromFile hspp_fn - let - -- GHC.Prim doesn't exist physically, so don't go looking for it. - the_imps = filter (/= gHC_PRIM_Name) imps - - when (mod_name /= moduleName mod) $ +summarise :: DynFlags + -> NodeMap ModSummary -- Map of old summaries + -> Maybe FilePath -- Importing module (for error messages) + -> IsBootInterface -- True <=> a {-# SOURCE #-} import + -> Module -- Imported module to be summarised + -> [Module] -- Modules to exclude + -> IO (Maybe ModSummary) -- Its new summary + +summarise dflags old_summary_map cur_mod is_boot wanted_mod excl_mods + | wanted_mod `elem` excl_mods + = return Nothing + + | Just old_summary <- lookupFM old_summary_map (wanted_mod, hsc_src) + = do { -- Find its new timestamp; all the + -- ModSummaries in the old map have valid ml_hs_files + let location = ms_location old_summary + src_fn = fromJust (ml_hs_file location) + + ; src_timestamp <- getModificationTime src_fn + + -- return the cached summary if the source didn't change + ; if ms_hs_date old_summary == src_timestamp + then return (Just old_summary) + else new_summary location + } + + | otherwise + = do { found <- findModule dflags wanted_mod True {-explicit-} + ; case found of + Found location pkg + | not (isHomePackage pkg) -> return Nothing -- Drop external-pkg + | isJust (ml_hs_file location) -> new_summary location -- Home package + err -> noModError dflags cur_mod wanted_mod err -- Not found + } + where + hsc_src = if is_boot then HsBootFile else HsSrcFile + + new_summary location + = do { -- Adjust location to point to the hs-boot source file, + -- hi file, object file, when is_boot says so + let location' | is_boot = addBootSuffixLocn location + | otherwise = location + src_fn = fromJust (ml_hs_file location') + + -- Check that it exists + -- It might have been deleted since the Finder last found it + ; exists <- doesFileExist src_fn + ; if exists then return () else noHsFileErr cur_mod src_fn + + -- Preprocess the source file and get its imports + -- The dflags' contains the OPTIONS pragmas + ; (dflags', hspp_fn) <- preprocess dflags src_fn + ; buf <- hGetStringBuffer hspp_fn + ; (srcimps, the_imps, mod_name) <- getImports dflags' buf hspp_fn + + ; when (mod_name /= wanted_mod) $ throwDyn (ProgramError - (showSDoc (text hs_fn + (showSDoc (text src_fn <> text ": file name does not match module name" - <+> quotes (ppr (moduleName mod))))) + <+> quotes (ppr mod_name)))) - return (Just (ModSummary mod location{ml_hspp_file=Just hspp_fn} - srcimps the_imps src_timestamp)) - } - } + -- Find its timestamp, and return the summary + ; src_timestamp <- getModificationTime src_fn + ; return (Just ( ModSummary { ms_mod = wanted_mod, + ms_hsc_src = hsc_src, + ms_location = location', + ms_hspp_file = Just hspp_fn, + ms_hspp_buf = Just buf, + ms_srcimps = srcimps, + ms_imps = the_imps, + ms_hs_date = src_timestamp })) + } -noHsFileErr mod - = throwDyn (CmdLineError (showSDoc (text "no source file for module" <+> quotes (ppr mod)))) +----------------------------------------------------------------------------- +-- Error messages +----------------------------------------------------------------------------- + +noModError :: DynFlags -> Maybe FilePath -> Module -> FindResult -> IO ab +-- ToDo: we don't have a proper line number for this error +noModError dflags cur_mod wanted_mod err + = throwDyn $ ProgramError $ showSDoc $ + vcat [cantFindError dflags wanted_mod err, + nest 2 (parens (pp_where cur_mod))] + +noHsFileErr cur_mod path + = throwDyn $ CmdLineError $ showSDoc $ + vcat [text "Can't find" <+> text path, + nest 2 (parens (pp_where cur_mod))] + +pp_where Nothing = text "one of the roots of the dependency analysis" +pp_where (Just p) = text "imported from" <+> text p packageModErr mod = throwDyn (CmdLineError (showSDoc (text "module" <+> @@ -1286,50 +1360,17 @@ multiRootsErr mod files 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 +cyclicModuleErr :: [ModSummary] -> SDoc +cyclicModuleErr ms + = hang (ptext SLIT("Module imports form a cycle for modules:")) + 2 (vcat (map show_one ms)) + where + show_one ms = sep [ show_mod (ms_hsc_src ms) (ms_mod ms), + nest 2 $ ptext SLIT("imports:") <+> + (pp_imps HsBootFile (ms_srcimps ms) + $$ pp_imps HsSrcFile (ms_imps ms))] + show_mod hsc_src mod = ppr mod <> text (hscSourceString hsc_src) + pp_imps src mods = fsep (map (show_mod src) mods) \end{code} +