%
-% (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,
+
+ CmState, emptyCmState, -- abstract
- cmLoadModule, -- :: CmState -> FilePath -> IO (CmState, [String])
+ cmInit, -- :: GhciMode -> IO CmState
- cmUnload, -- :: CmState -> DynFlags -> IO CmState
+ cmDepAnal, -- :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph
- cmSetContext, -- :: CmState -> String -> IO CmState
+ cmLoadModules, -- :: CmState -> DynFlags -> ModuleGraph
+ -- -> IO (CmState, [String])
- cmGetContext, -- :: CmState -> IO 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)
+ cmRunStmt, -- :: CmState -> DynFlags -> String
+ -- -> IO (CmState, CmRunResult)
+
+ cmTypeOfExpr, -- :: CmState -> DynFlags -> String
+ -- -> IO (CmState, Maybe String)
+
+ 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)
+ cmGetModuleGraph, -- :: CmState -> ModuleGraph
+ cmGetLinkables, -- :: CmState -> [Linkable]
- cmCompileExpr,-- :: CmState -> DynFlags -> String
- -- -> IO (CmState, Maybe HValue)#endif
+ cmGetBindings, -- :: CmState -> [TyThing]
+ cmGetPrintUnqual, -- :: CmState -> PrintUnqualified
#endif
- CmState, emptyCmState -- abstract
+
+ -- utils
+ showModMsg, --
)
where
#include "HsVersions.h"
+import MkIface --tmp
+import HsSyn -- tmp
+
import CmLink
import CmTypes
import DriverPipeline
-import DriverFlags ( getDynFlags )
import DriverState ( v_Output_file )
import DriverPhases
import DriverUtil
import Finder
#ifdef GHCI
-import HscMain ( initPersistentCompilerState, hscThing )
+import HscMain ( initPersistentCompilerState, hscThing,
+ hscModuleContents )
#else
import HscMain ( initPersistentCompilerState )
#endif
-import HscTypes
-import RnEnv ( unQualInScope )
-import Id ( idType, idName )
+import HscTypes hiding ( moduleNameToModule )
import Name ( Name, NamedThing(..), nameRdrName, nameModule,
- isHomePackageName )
+ isHomePackageName, isExternalName )
import NameEnv
-import RdrName ( lookupRdrEnv, emptyRdrEnv )
+import Rename ( mkGlobalContext )
+import RdrName ( emptyRdrEnv )
import Module
import GetImports
-import Type ( tidyType )
-import VarEnv ( emptyTidyEnv )
import UniqFM
import Unique ( Uniquable )
import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs )
import SysTools ( cleanTempFilesExcept )
import Util
import Outputable
-import BasicTypes ( Fixity, defaultFixity )
import Panic
-import CmdLineOpts ( DynFlags(..) )
+import CmdLineOpts ( DynFlags(..), getDynFlags )
+import Maybes ( expectJust )
import IOExts
#ifdef GHCI
+import RdrName ( lookupRdrEnv )
+import Id ( idType, idName )
+import Type ( tidyType )
+import VarEnv ( emptyTidyEnv )
+import BasicTypes ( Fixity, defaultFixity )
import Interpreter ( HValue )
import HscMain ( hscStmt )
-import PrelGHC ( unsafeCoerce# )
-
--- lang
+import GlaExts ( unsafeCoerce# )
import Foreign
import CForeign
+import Exception ( Exception, try )
#endif
-import Exception ( Exception, try, throwDyn )
+-- lang
+import Exception ( throwDyn )
-- std
import Directory ( getModificationTime, doesFileExist )
pls :: PersistentLinkerState -- link's persistent state
}
-emptyCmState :: GhciMode -> Module -> IO CmState
-emptyCmState gmode mod
+emptyCmState :: GhciMode -> IO CmState
+emptyCmState gmode
= do pcs <- initPersistentCompilerState
pls <- emptyPLS
return (CmState { hst = emptySymbolTable,
ui = emptyUI,
mg = emptyMG,
gmode = gmode,
- ic = emptyInteractiveContext mod,
+ ic = emptyInteractiveContext,
pcs = pcs,
pls = pls })
-emptyInteractiveContext mod
- = InteractiveContext { ic_module = mod,
- ic_rn_env = emptyRdrEnv,
+emptyInteractiveContext
+ = InteractiveContext { ic_toplev_scope = [],
+ ic_exports = [],
+ ic_rn_gbl_env = emptyRdrEnv,
+ ic_print_unqual = alwaysQualify,
+ ic_rn_local_env = emptyRdrEnv,
ic_type_env = emptyTypeEnv }
-defaultCurrentModuleName = mkModuleName "Prelude"
-GLOBAL_VAR(defaultCurrentModule, error "no defaultCurrentModule", Module)
-
-- CM internal types
type UnlinkedImage = [Linkable] -- the unlinked images (should be a set, really)
emptyUI :: UnlinkedImage
-- Produce an initial CmState.
cmInit :: GhciMode -> IO CmState
-cmInit mode = do
- prel <- moduleNameToModule defaultCurrentModuleName
- writeIORef defaultCurrentModule prel
- emptyCmState mode prel
+cmInit mode = emptyCmState mode
+
+-----------------------------------------------------------------------------
+-- Grab information from the CmState
+
+cmGetModuleGraph = mg
+cmGetLinkables = ui
+
+cmGetBindings cmstate = nameEnvElts (ic_type_env (ic cmstate))
+cmGetPrintUnqual cmstate = ic_print_unqual (ic cmstate)
-----------------------------------------------------------------------------
-- Setting the context doesn't throw away any bindings; the bindings
-- we've built up in the InteractiveContext simply move to the new
-- module. They always shadow anything in scope in the current context.
-cmSetContext :: CmState -> String -> IO CmState
-cmSetContext cmstate str
- = do let mn = mkModuleName str
- modules_loaded = [ (name_of_summary s, ms_mod s) | s <- mg cmstate ]
-
- m <- case lookup mn modules_loaded of
- Just m -> return m
- Nothing -> do
- mod <- moduleNameToModule mn
- if isHomeModule mod
- then throwDyn (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{ hit=hit, hst=hst, pcs=pcs, ic=old_ic } = cmstate
+
+ toplev_mods <- mapM (getTopLevModule hit) (map mkModuleName toplevs)
+ export_mods <- mapM (moduleNameToModule hit) (map mkModuleName exports)
+
+ (new_pcs, print_unqual, maybe_env)
+ <- mkGlobalContext dflags hit hst pcs toplev_mods export_mods
+
+ case maybe_env of
+ Nothing -> return cmstate
+ Just env -> return cmstate{ pcs = new_pcs,
+ ic = old_ic{ ic_toplev_scope = toplev_mods,
+ ic_exports = export_mods,
+ ic_rn_gbl_env = env,
+ ic_print_unqual = print_unqual } }
+
+getTopLevModule hit mn =
+ case lookupModuleEnvByName hit mn of
+ Just iface
+ | Just _ <- mi_globals iface -> return (mi_module iface)
+ _other -> throwDyn (CmdLineError (
+ "cannot enter the top-level scope of a compiled module (module `" ++
+ moduleNameUserString mn ++ "')"))
+
+moduleNameToModule :: HomeIfaceTable -> ModuleName -> IO Module
+moduleNameToModule hit mn = do
+ case lookupModuleEnvByName hit mn of
+ Just iface -> return (mi_module iface)
+ _not_a_home_module -> do
+ maybe_stuff <- findModule mn
+ case maybe_stuff of
+ Nothing -> throwDyn (CmdLineError ("can't find module `"
+ ++ moduleNameUserString mn ++ "'"))
+ Just (m,_) -> return m
+
+cmGetContext :: CmState -> IO ([String],[String])
+cmGetContext CmState{ic=ic} =
+ return (map moduleUserString (ic_toplev_scope ic),
+ map moduleUserString (ic_exports ic))
+
+cmModuleIsInterpreted :: CmState -> String -> IO Bool
+cmModuleIsInterpreted cmstate str
+ = case lookupModuleEnvByName (hit cmstate) (mkModuleName str) of
+ Just iface -> return (not (isNothing (mi_globals iface)))
+ _not_a_home_module -> return False
-----------------------------------------------------------------------------
-- cmInfoThing: convert a String to a TyThing
-- 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
+ return (cmstate{ pcs=new_pcs }, 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),
+ | isExternalName name,
+ Just iface <- lookupModuleEnv iface_table (nameModule name),
Just fixity <- lookupNameEnv (mi_fixities iface) name
= fixity
| otherwise
| otherwise = pcs_PIT pcs
#endif
+-- ---------------------------------------------------------------------------
+-- cmBrowseModule: get all the TyThings defined in a module
+
+#ifdef GHCI
+cmBrowseModule :: CmState -> DynFlags -> String -> Bool
+ -> IO (CmState, [TyThing])
+cmBrowseModule cmstate dflags str exports_only = do
+ let mn = mkModuleName str
+ mod <- moduleNameToModule hit mn
+ (pcs1, maybe_ty_things)
+ <- hscModuleContents dflags hst hit pcs mod exports_only
+ case maybe_ty_things of
+ Nothing -> return (cmstate{pcs=pcs1}, [])
+ Just ty_things -> return (cmstate{pcs=pcs1}, ty_things)
+ where
+ CmState{ hst=hst, hit=hit, pcs=pcs, pls=pls, ic=icontext } = cmstate
+#endif
+
-----------------------------------------------------------------------------
-- cmRunStmt: Run a statement/expr.
data CmRunResult
= CmRunOk [Name] -- names bound by this evaluation
| CmRunFailed
- | CmRunDeadlocked -- statement deadlocked
| CmRunException Exception -- statement raised an exception
cmRunStmt :: CmState -> DynFlags -> String -> IO (CmState, CmRunResult)
dflags expr
= do
let InteractiveContext {
- ic_rn_env = rn_env,
- ic_type_env = type_env,
- ic_module = this_mod } = icontext
+ ic_rn_local_env = rn_env,
+ ic_type_env = type_env } = icontext
(new_pcs, maybe_stuff)
<- hscStmt dflags hst hit pcs icontext expr False{-stmt-}
new_type_env = extendNameEnvList filtered_type_env
[ (getName id, AnId id) | id <- ids]
- new_ic = icontext { ic_rn_env = new_rn_env,
- ic_type_env = new_type_env }
+ new_ic = icontext { ic_rn_local_env = new_rn_env,
+ ic_type_env = new_type_env }
-- link it
hval <- linkExpr pls bcos
either_hvals <- sandboxIO thing_to_run
case either_hvals of
Left err
- | err == dEADLOCKED
- -> return ( cmstate{ pcs=new_pcs, ic=new_ic },
- CmRunDeadlocked )
- | otherwise
-> do hPutStrLn stderr ("unknown failure, code " ++ show err)
return ( cmstate{ pcs=new_pcs, ic=new_ic }, CmRunFailed )
return (cmstate{ pcs=new_pcs, pls=new_pls, ic=new_ic },
CmRunOk names)
--- We run the statement in a "sandbox", which amounts to calling into
--- the RTS to request a new main thread. The main benefit is that we
--- get to detect a deadlock this way, but also there's no danger that
--- exceptions raised by the expression can affect the interpreter.
+
+-- We run the statement in a "sandbox" to protect the rest of the
+-- system from anything the expression might do. For now, this
+-- consists of just wrapping it in an exception handler, but see below
+-- for another version.
+
+sandboxIO :: IO a -> IO (Either Int (Either Exception a))
+sandboxIO thing = do
+ r <- Exception.try thing
+ return (Right r)
+
+{-
+-- This version of sandboxIO runs the expression in a completely new
+-- RTS main thread. It is disabled for now because ^C exceptions
+-- won't be delivered to the new thread, instead they'll be delivered
+-- to the (blocked) GHCi main thread.
sandboxIO :: IO a -> IO (Either Int (Either Exception a))
sandboxIO thing = do
else do
return (Left (fromIntegral stat))
--- ToDo: slurp this in from ghc/includes/RtsAPI.h somehow
-dEADLOCKED = 4 :: Int
-
foreign import "rts_evalStableIO" {- safe -}
rts_evalStableIO :: StablePtr (IO a) -> Ptr (StablePtr a) -> IO CInt
-- more informative than the C type!
+-}
#endif
-----------------------------------------------------------------------------
Just (_, ty, _) -> return (new_cmstate, Just str)
where
str = showSDocForUser unqual (ppr tidy_ty)
- unqual = getUnqual pcs hit ic
+ unqual = ic_print_unqual ic
tidy_ty = tidyType emptyTidyEnv ty
where
CmState{ hst=hst, hit=hit, pcs=pcs, ic=ic } = cmstate
#endif
-getUnqual pcs hit ic
- = case lookupIfaceByModName hit pit modname of
- Nothing -> alwaysQualify
- Just iface -> unQualInScope (mi_globals iface)
- where
- pit = pcs_PIT pcs
- modname = moduleName (ic_module ic)
-
-----------------------------------------------------------------------------
-- cmTypeOfName: returns a string representing the type of a name.
Nothing -> return Nothing
Just (AnId id) -> return (Just str)
where
- unqual = getUnqual pcs hit ic
+ unqual = ic_print_unqual ic
ty = tidyType emptyTidyEnv (idType id)
str = showSDocForUser unqual (ppr ty)
cmCompileExpr cmstate dflags expr
= do
let InteractiveContext {
- ic_rn_env = rn_env,
- ic_type_env = type_env,
- ic_module = this_mod } = icontext
+ ic_rn_local_env = rn_env,
+ ic_type_env = type_env } = icontext
(new_pcs, maybe_stuff)
<- hscStmt dflags hst hit pcs icontext
#endif
-----------------------------------------------------------------------------
--- cmInfo: return "info" about an expression. The info might be:
---
--- * its type, for an expression,
--- * the class definition, for a class
--- * the datatype definition, for a tycon (or synonym)
--- * the export list, for a module
---
--- Can be used to find the type of the last expression compiled, by looking
--- for "it".
-
-cmInfo :: CmState -> String -> IO (Maybe String)
-cmInfo cmstate str
- = do error "cmInfo not implemented yet"
-
------------------------------------------------------------------------------
-- Unload the compilation manager's state: everything it knows about the
-- current collection of modules in the Home package.
new_state <- cmInit mode
return new_state{ pcs=pcs, pls=new_pls }
+
+-----------------------------------------------------------------------------
+-- Trace dependency graph
+
+-- This is a seperate pass so that the caller can back off and keep
+-- the current state if the downsweep fails.
+
+cmDepAnal :: CmState -> DynFlags -> [FilePath] -> IO ModuleGraph
+cmDepAnal cmstate dflags rootnames
+ = do showPass dflags "Chasing dependencies"
+ when (verbosity dflags >= 1 && gmode cmstate == Batch) $
+ hPutStrLn stderr (showSDoc (hcat [
+ text progName, text ": chasing modules from: ",
+ hcat (punctuate comma (map text rootnames))]))
+ downsweep rootnames (mg cmstate)
+
-----------------------------------------------------------------------------
-- The real business of the compilation manager: given a system state and
-- a module name, try and bring the module up to date, probably changing
-- the system state at the same time.
-cmLoadModule :: CmState
- -> [FilePath]
+cmLoadModules :: CmState
+ -> DynFlags
+ -> ModuleGraph
-> IO (CmState, -- new state
Bool, -- was successful
[String]) -- list of modules loaded
-cmLoadModule cmstate1 rootnames
+cmLoadModules cmstate1 dflags mg2unsorted
= do -- version 1's are the original, before downsweep
let pls1 = pls cmstate1
let pcs1 = pcs 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 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]
-- 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 ui1
+ mg2unsorted_names mg2_with_srcimps
+
+ -- putStrLn (showSDoc (vcat [ppr valid_old_linkables, ppr new_linkables]))
+
+ -- uniq of ModuleName is the same as Module, fortunately...
+ let hit2 = delListFromUFM hit1 (map linkableModName new_linkables)
+
+ -- When (verb >= 2) $
-- putStrLn (showSDoc (text "Valid linkables:"
-- <+> ppr valid_linkables))
-- 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
stable_linkables
= filter (\m -> linkableModName m `elem` stable_mods)
- valid_linkables
+ valid_old_linkables
when (verb >= 2) $
putStrLn (showSDoc (text "Stable modules:"
<+> sep (map (text.moduleNameUserString) stable_mods)))
- -- unload any modules which aren't going to be re-linked this
+ -- unload any modules which are going to be re-linked this
-- time around.
pls2 <- CmLink.unload ghci_mode dflags stable_linkables pls1
+ -- we can now glom together our linkable sets
+ let valid_linkables = valid_old_linkables ++ new_linkables
+
-- We could at this point detect cycles which aren't broken by
-- a source-import, and complain immediately, but it seems better
-- 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 name_of_summary (flattenSCC scc)))
+ (map modSummaryName (flattenSCC scc)))
mg2
--hPutStrLn stderr "after tsort:\n"
-- Now do the upsweep, calling compile for each module in
-- turn. Final result is version 3 of everything.
- let threaded2 = CmThreaded pcs1 hst1 hit1
+ let threaded2 = CmThreaded pcs1 hst1 hit2
-- clean up between compilations
let cleanup = cleanTempFilesExcept verb
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)
+ = retainInTopLevelEnvs (map modSummaryName mods_to_keep)
(hst3,hit3,ui3)
-- clean up after ourselves
-- 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,
+ = do let 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
+ ic = emptyInteractiveContext }
+ mods_loaded = map (moduleNameUserString.modSummaryName) mods
return (new_cmstate, ok, mods_loaded)
--
-- - 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
-- 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
getValidLinkable old_linkables objects_allowed new_linkables summary
- = do let mod_name = name_of_summary summary
+ = 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
+ Nothing -> return Nothing
+
+ let old_linkable = findModuleLinkable_maybe old_linkables mod_name
+
+ new_linkables' =
+ case (old_linkable, maybe_disk_linkable) of
+ (Nothing, Nothing) -> []
+
+ -- new object linkable just appeared
+ (Nothing, Just l) -> up_to_date l True
+
+ (Just l, Nothing)
+ | isObjectLinkable l -> []
+ -- object linkable disappeared! In case we need to
+ -- relink the module, disregard the old linkable and
+ -- just interpret the module from now on.
+ | otherwise -> up_to_date l False
+ -- old byte code linkable
+
+ (Just l, Just l')
+ | not (isObjectLinkable l) -> up_to_date l False
+ -- if the previous linkable was interpreted, then we
+ -- ignore a newly compiled version, because the version
+ -- numbers in the interface file will be out-of-sync with
+ -- our internal ones.
+ | linkableTime l' > linkableTime l -> up_to_date l' True
+ | linkableTime l' == linkableTime l -> up_to_date l False
+ | otherwise -> []
+ -- on-disk linkable has been replaced by an older one!
+ -- again, disregard the previous one.
+
+ up_to_date l b
+ | linkableTime l < ms_hs_date summary = []
+ | otherwise = [(l,b)]
+ -- why '<' rather than '<=' above? If the filesystem stores
-- times to the nearset second, we may occasionally find that
-- the object & source have the same modification time,
-- especially if the source was automatically generated
-- and compiled. Using >= is slightly unsafe, but it matches
-- make's behaviour.
- return (valid_linkable ++ new_linkables)
+ return (new_linkables' ++ new_linkables)
maybe_getFileLinkable :: ModuleName -> FilePath -> IO (Maybe Linkable)
-maybe_getFileLinkable mod_name obj_fn
+maybe_getFileLinkable mod obj_fn
= do obj_exist <- doesFileExist obj_fn
if not obj_exist
then return Nothing
stub_exist <- doesFileExist stub_fn
obj_time <- getModificationTime obj_fn
if stub_exist
- then return (Just (LM obj_time mod_name [DotO obj_fn, DotO stub_fn]))
- else return (Just (LM obj_time mod_name [DotO obj_fn]))
+ then return (Just (LM obj_time mod [DotO obj_fn, DotO stub_fn]))
+ else return (Just (LM obj_time mod [DotO obj_fn]))
-----------------------------------------------------------------------------
-- * has an interface in the HIT (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
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
-- 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
-- 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
- = listToMaybe [s | s <- old_summaries, ms_mod s == 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.
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)
- && compareLength mods_in_this_cycle names_in_this_cycle == LT
+ 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
upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup
((CyclicSCC ms):_)
= do hPutStrLn stderr ("Module imports form a cycle for modules:\n\t" ++
- unwords (map (moduleNameUserString.name_of_summary) ms))
+ unwords (map (moduleNameUserString.modSummaryName) ms))
return (False, threaded, [], [])
upsweep_mods ghci_mode dflags oldUI reachable_from threaded cleanup
(threaded1, maybe_linkable)
<- upsweep_mod ghci_mode dflags oldUI threaded mod
- (reachable_from (name_of_summary mod))
+ (reachable_from (modSummaryName mod))
-- remove unwanted tmp files between compilations
cleanup
upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me
= do
- let mod_name = name_of_summary summary1
- let verb = verbosity dflags
+ let mod_name = modSummaryName summary1
let (CmThreaded pcs1 hst1 hit1) = threaded1
let old_iface = lookupUFM hit1 mod_name
source_unchanged = isJust maybe_old_linkable
- reachable_only = filter (/= (name_of_summary summary1))
+ reachable_only = filter (/= (modSummaryName summary1))
reachable_inc_me
-- in interactive mode, all home modules below us *must* have an
retainInTopLevelEnvs reachable_only (hst1,hit1,[])
old_linkable
- = unJust "upsweep_mod:old_linkable" maybe_old_linkable
+ = expectJust "upsweep_mod:old_linkable" maybe_old_linkable
have_object
| Just l <- maybe_old_linkable, isObjectLinkable l = True
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
= let set2 = nub (concatMap dsts set ++ set)
dsts node = fromMaybe [] (lookup node graph)
in
- if equalLength set set2
+ if length set == length set2
then set
else simple_transitive_closure graph set2
= 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)
sccs
+-----------------------------------------------------------------------------
+-- Downsweep (dependency analysis)
+
-- Chase downwards from the specified root set, returning summaries
-- for all home modules encountered. Only follow source-import
--- links. Also returns a Bool to indicate whether any of the roots
--- are module Main.
-downsweep :: [FilePath] -> [ModSummary] -> IO ([ModSummary], Bool)
-downsweep rootNm old_summaries
- = do rootSummaries <- mapM getRootSummary rootNm
- let a_root_is_Main
- = any ((=="Main").moduleNameUserString.name_of_summary)
- rootSummaries
+-- links.
+
+-- We pass in the previous collection of summaries, which is used as a
+-- cache to avoid recalculating a module summary if the source is
+-- unchanged.
+
+downsweep :: [FilePath] -> [ModSummary] -> IO [ModSummary]
+downsweep roots old_summaries
+ = do rootSummaries <- mapM getRootSummary roots
all_summaries
<- loop (concat (map ms_imps rootSummaries))
(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
| haskellish_src_file file
= do exists <- doesFileExist file
- when (not exists)
- (throwDyn (CmdLineError ("can't find file `" ++ file ++ "'")))
- summariseFile file
+ if exists then summariseFile file else do
+ throwDyn (CmdLineError ("can't find file `" ++ file ++ "'"))
| otherwise
- = do mb_file <- findFile [hs_file, lhs_file]
- case mb_file of
- Just x -> summariseFile x
- Nothing -> do
- let mod_name = mkModuleName file
- maybe_summary <- getSummary mod_name
- case maybe_summary of
- Nothing -> packageModErr mod_name
- Just s -> return s
+ = do exists <- doesFileExist hs_file
+ if exists then summariseFile hs_file else do
+ exists <- doesFileExist lhs_file
+ if exists then summariseFile lhs_file else do
+ let mod_name = mkModuleName file
+ maybe_summary <- getSummary mod_name
+ case maybe_summary of
+ Nothing -> packageModErr mod_name
+ Just s -> return s
where
hs_file = file ++ ".hs"
lhs_file = file ++ ".lhs"
- findFile :: [FilePath] -> IO (Maybe FilePath)
- findFile [] = return Nothing
- findFile (x:xs) = do
- flg <- doesFileExist x
- if flg then return (Just x) else findFile xs
-
getSummary :: ModuleName -> IO (Maybe ModSummary)
getSummary nm
= do found <- findModule nm
-- 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
= do hspp_fn <- preprocess file
(srcimps,imps,mod_name) <- getImportsFromFile hspp_fn
- let (path, basename, ext) = splitFilename3 file
+ let (path, basename, _ext) = splitFilename3 file
(mod, location)
<- mkHomeModuleLocn mod_name (path ++ '/':basename) file
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 -> noHsFileErr mod;