%
-% (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)])
CmRunResult(..),
- cmRunStmt, -- :: CmState -> DynFlags -> String -> IO (CmState, CmRunResult)
+ cmRunStmt, -- :: CmState -> DynFlags -> String
+ -- -> IO (CmState, CmRunResult)
- cmTypeOfExpr, -- :: CmState -> DynFlags -> String
- -- -> IO (CmState, Maybe String)
+ cmTypeOfExpr, -- :: CmState -> DynFlags -> String
+ -- -> IO (CmState, Maybe String)
- cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String)
+ cmTypeOfName, -- :: CmState -> Name -> IO (Maybe String)
- cmCompileExpr,-- :: CmState -> DynFlags -> String
- -- -> IO (CmState, Maybe HValue)#endif
+ HValue,
+ cmCompileExpr, -- :: CmState -> DynFlags -> String
+ -- -> IO (CmState, Maybe HValue)
+
+ cmGetModuleGraph, -- :: CmState -> ModuleGraph
+ cmGetLinkables, -- :: CmState -> [Linkable]
+
+ cmGetBindings, -- :: CmState -> [TyThing]
+ cmGetPrintUnqual, -- :: CmState -> PrintUnqualified
#endif
- CmState, emptyCmState -- abstract
+
+ -- utils
+ showModMsg, --
)
where
#include "HsVersions.h"
+import MkIface --tmp
+import HsSyn -- tmp
+
import CmLink
import CmTypes
import DriverPipeline
-import DriverFlags ( getDynFlags )
import DriverState ( v_Output_file )
import DriverPhases
import DriverUtil
import HscMain ( initPersistentCompilerState )
#endif
import HscTypes
-import RnEnv ( unQualInScope )
-import Id ( idType, idName )
import Name ( Name, NamedThing(..), nameRdrName, nameModule,
- isHomePackageName )
-import NameEnv
-import RdrName ( lookupRdrEnv, emptyRdrEnv )
+ isHomePackageName, isGlobalName )
+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 IOExts
#ifdef GHCI
+import RdrName ( lookupRdrEnv )
+import Id ( idType, idName )
+import NameEnv
+import Type ( tidyType )
+import VarEnv ( emptyTidyEnv )
+import BasicTypes ( Fixity, defaultFixity )
import Interpreter ( HValue )
import HscMain ( hscStmt )
import PrelGHC ( unsafeCoerce# )
-#endif
--- lang
import Foreign
import CForeign
-import Exception ( Exception, try, throwDyn )
+import Exception ( Exception, try )
+#endif
+
+-- 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 `"
+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
+ 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),
+ | isGlobalName name,
+ Just iface <- lookupModuleEnv iface_table (nameModule name),
Just fixity <- lookupNameEnv (mi_fixities iface) name
= fixity
| otherwise
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.name_of_summary)
+ mg2unsorted
- (mg2unsorted, a_root_is_Main) <- downsweep rootnames mg1
let mg2unsorted_names = map name_of_summary mg2unsorted
-- reachable_from follows source as well as normal imports
-- 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 }
+ ic = emptyInteractiveContext }
mods_loaded = map (moduleNameUserString.name_of_summary) mods
return (new_cmstate, ok, mods_loaded)
upsweep_mod ghci_mode dflags oldUI threaded1 summary1 reachable_inc_me
= do
let mod_name = name_of_summary summary1
- let verb = verbosity dflags
let (CmThreaded pcs1 hst1 hit1) = threaded1
let old_iface = lookupUFM hit1 mod_name
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
-- 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
projects / ghc-hetmet.git / blobdiff