\section[CompManager]{The Compilation Manager}
\begin{code}
-module CompManager ( cmInit, cmLoadModule,
+module CompManager ( cmInit, cmLoadModule,
+#ifdef GHCI
cmGetExpr, cmRunExpr,
+#endif
CmState, emptyCmState -- abstract
)
where
#include "HsVersions.h"
-import List ( nub )
-import Maybe ( catMaybes, maybeToList, fromMaybe )
-import Maybes ( maybeToBool )
-import Outputable
-import UniqFM ( emptyUFM, lookupUFM, addToUFM, delListFromUFM )
-import Digraph ( SCC(..), stronglyConnComp, flattenSCC, flattenSCCs )
-import Panic ( panic )
-
-import CmLink ( PersistentLinkerState, emptyPLS, Linkable(..),
- link, LinkResult(..),
- filterModuleLinkables, modname_of_linkable,
- is_package_linkable, findModuleLinkable )
-import Interpreter ( HValue )
-import CmSummarise ( summarise, ModSummary(..),
- name_of_summary, {-, is_source_import-} )
-import Module ( ModuleName, moduleName, packageOfModule,
- isModuleInThisPackage, PackageName, moduleEnvElts,
+import CmLink
+import CmTypes
+import HscTypes
+import Module ( ModuleName, moduleName,
+ isModuleInThisPackage, moduleEnvElts,
moduleNameUserString )
-import CmStaticInfo ( Package(..), PackageConfigInfo, GhciMode )
-import DriverPipeline ( compile, preprocess, doLink, CompResult(..) )
+import CmStaticInfo ( PackageConfigInfo, GhciMode(..) )
+import DriverPipeline
+import GetImports
import HscTypes ( HomeSymbolTable, HomeIfaceTable,
PersistentCompilerState, ModDetails(..) )
import Name ( lookupNameEnv )
+import Module
import PrelNames ( mainName )
import HscMain ( initPersistentCompilerState )
-import Finder ( findModule, emptyHomeDirCache )
-import DriverUtil ( BarfKind(..) )
+import Finder
+import UniqFM ( emptyUFM, lookupUFM, addToUFM, delListFromUFM,
+ UniqFM, listToUFM )
+import Unique ( Uniquable )
+import Digraph ( SCC(..), stronglyConnComp )
+import DriverPhases
+import DriverUtil ( BarfKind(..), splitFilename3 )
+import Util
+import Outputable
+import Panic ( panic )
+
+#ifdef GHCI
+import CmdLineOpts ( DynFlags )
+import Interpreter ( HValue )
+import HscMain ( hscExpr )
+import RdrName
+import PrelGHC ( unsafeCoerce# )
+#endif
+
+-- lang
import Exception ( throwDyn )
-import IO ( hPutStrLn, stderr )
-\end{code}
+-- std
+import Time ( ClockTime )
+import Directory ( getModificationTime, doesFileExist )
+import IO
+import List ( nub )
+import Maybe ( catMaybes, fromMaybe, isJust )
+\end{code}
\begin{code}
cmInit raw_package_info gmode
= emptyCmState raw_package_info gmode
+#ifdef GHCI
cmGetExpr :: CmState
+ -> DynFlags
-> ModuleName
-> String
- -> IO (CmState, Either [SDoc] HValue)
-cmGetExpr cmstate modhdl expr
- = return (panic "cmGetExpr:unimp")
-
+ -> IO (CmState, Maybe HValue)
+cmGetExpr cmstate dflags modname expr
+ = do (new_pcs, maybe_unlinked_iexpr) <-
+ hscExpr dflags hst hit pcs (mkModuleInThisPackage modname) expr
+ case maybe_unlinked_iexpr of
+ Nothing -> return (cmstate{ pcs=new_pcs }, Nothing)
+ Just uiexpr -> do
+ hValue <- linkExpr pls uiexpr
+ return (cmstate{ pcs=new_pcs }, Just hValue)
+
+ -- ToDo: check that the module we passed in is sane/exists?
+ where
+ CmState{ pcs=pcs, pcms=pcms, pls=pls } = cmstate
+ PersistentCMState{ hst=hst, hit=hit } = pcms
+
+-- The HValue should represent a value of type IO () (Perhaps IO a?)
cmRunExpr :: HValue -> IO ()
cmRunExpr hval
- = return (panic "cmRunExpr:unimp")
-
+ = do unsafeCoerce# hval :: IO ()
+ -- putStrLn "done."
+#endif
-- Persistent state just for CM, excluding link & compile subsystems
data PersistentCMState
\begin{code}
cmLoadModule :: CmState
- -> ModuleName
- -> IO (CmState, Maybe ModuleName)
+ -> FilePath
+ -> IO (CmState, -- new state
+ Bool, -- was successful
+ [ModuleName]) -- list of modules loaded
cmLoadModule cmstate1 rootname
= do -- version 1's are the original, before downsweep
-- Throw away the old home dir cache
emptyHomeDirCache
- putStr "cmLoadModule: downsweep begins\n"
+ hPutStr stderr "cmLoadModule: downsweep begins\n"
mg2unsorted <- downsweep [rootname]
let modnames1 = map name_of_summary mg1
= removeFromTopLevelEnvs mods_to_zap (hst1, hit1, ui1)
-- should be cycle free; ignores 'import source's
let mg2 = topological_sort False mg2unsorted
- -- ... whereas this takes them into account. Only used for
+ -- ... whereas this takes them into account. Used for
-- backing out partially complete cycles following a failed
- -- upsweep.
+ -- upsweep, and for removing from hst/hit all the modules
+ -- not in strict downwards closure, during calls to compile.
let mg2_with_srcimps = topological_sort True mg2unsorted
- putStrLn "after tsort:\n"
- putStrLn (showSDoc (vcat (map ppr mg2)))
+ let reachable_from :: ModuleName -> [ModuleName]
+ reachable_from = downwards_closure_of_module mg2unsorted
+
+ hPutStrLn stderr "after tsort:\n"
+ hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
-- Because we don't take into account source imports when doing
-- the topological sort, there shouldn't be any cycles in mg2.
let threaded2 = CmThreaded pcs1 hst2 hit2
(upsweep_complete_success, threaded3, modsDone, newLis)
- <- upsweep_mods ui2 threaded2 mg2
+ <- upsweep_mods ghci_mode ui2 reachable_from threaded2 mg2
let ui3 = add_to_ui ui2 newLis
let (CmThreaded pcs3 hst3 hit3) = threaded3
then
-- Easy; just relink it all.
- do putStrLn "UPSWEEP COMPLETELY SUCCESSFUL"
+ do hPutStrLn stderr "UPSWEEP COMPLETELY SUCCESSFUL"
linkresult
- <- link doLink ghci_mode (any exports_main (moduleEnvElts hst3))
+ <- link ghci_mode (any exports_main (moduleEnvElts hst3))
newLis pls1
case linkresult of
LinkErrs _ _
pci=pcii, gmode=ghci_mode }
let cmstate3
= CmState { pcms=pcms3, pcs=pcs3, pls=pls3 }
- return (cmstate3, Just rootname)
+ return (cmstate3, True, map name_of_summary modsDone)
else
-- Tricky. We need to back out the effects of compiling any
-- half-done cycles, both so as to clean up the top level envs
-- and to avoid telling the interactive linker to link them.
- do putStrLn "UPSWEEP PARTIALLY SUCCESSFUL"
+ do hPutStrLn stderr "UPSWEEP PARTIALLY SUCCESSFUL"
let modsDone_names
= map name_of_summary modsDone
-- we could get the relevant linkables by filtering newLis, but
-- it seems easier to drag them out of the updated, cleaned-up UI
let linkables_to_link
- = map (findModuleLinkable ui4) mods_to_keep_names
+ = map (unJust "linkables_to_link" . findModuleLinkable_maybe ui4)
+ mods_to_keep_names
- linkresult <- link doLink ghci_mode False linkables_to_link pls1
+ linkresult <- link ghci_mode False linkables_to_link pls1
case linkresult of
LinkErrs _ _
-> panic "cmLoadModule: link failed (2)"
pci=pcii, gmode=ghci_mode }
let cmstate4
= CmState { pcms=pcms4, pcs=pcs3, pls=pls4 }
- return (cmstate4,
- -- choose rather arbitrarily who to return
- if null mods_to_keep then Nothing
- else Just (last mods_to_keep_names))
+ return (cmstate4, False, mods_to_keep_names)
-- Return (names of) all those in modsDone who are part of a cycle
else chewed_rest
+-- Does this ModDetails export Main.main?
exports_main :: ModDetails -> Bool
exports_main md
- = maybeToBool (lookupNameEnv (md_types md) mainName)
+ = isJust (lookupNameEnv (md_types md) mainName)
-- Add the given (LM-form) Linkables to the UI, overwriting previous
-- 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 :: UnlinkedImage -- old linkables
+upsweep_mods :: GhciMode
+ -> UnlinkedImage -- old linkables
+ -> (ModuleName -> [ModuleName]) -- to construct downward closures
-> CmThreaded -- PCS & HST & HIT
-> [SCC ModSummary] -- mods to do (the worklist)
-- ...... RETURNING ......
[ModSummary], -- mods which succeeded
[Linkable]) -- new linkables
-upsweep_mods oldUI threaded []
+upsweep_mods ghci_mode oldUI reachable_from threaded
+ []
= return (True, threaded, [], [])
-upsweep_mods oldUI threaded ((CyclicSCC ms):_)
+upsweep_mods ghci_mode oldUI reachable_from threaded
+ ((CyclicSCC ms):_)
= do hPutStrLn stderr ("ghc: module imports form a cycle for modules:\n\t" ++
unwords (map (moduleNameUserString.name_of_summary) ms))
return (False, threaded, [], [])
-upsweep_mods oldUI threaded ((AcyclicSCC mod):mods)
- = do (threaded1, maybe_linkable) <- upsweep_mod oldUI threaded mod
+upsweep_mods ghci_mode oldUI reachable_from threaded
+ ((AcyclicSCC mod):mods)
+ = do (threaded1, maybe_linkable)
+ <- upsweep_mod ghci_mode oldUI threaded mod
+ (reachable_from (name_of_summary mod))
case maybe_linkable of
Just linkable
-> -- No errors; do the rest
do (restOK, threaded2, modOKs, linkables)
- <- upsweep_mods oldUI threaded1 mods
+ <- upsweep_mods ghci_mode oldUI reachable_from
+ threaded1 mods
return (restOK, threaded2, mod:modOKs, linkable:linkables)
Nothing -- we got a compilation error; give up now
-> return (False, threaded1, [], [])
-- Compile a single module. Always produce a Linkable for it if
-- successful. If no compilation happened, return the old Linkable.
-upsweep_mod :: UnlinkedImage
+maybe_getFileLinkable :: ModuleName -> FilePath -> IO (Maybe Linkable)
+maybe_getFileLinkable mod_name obj_fn
+ = do obj_exist <- doesFileExist obj_fn
+ if not obj_exist
+ then return Nothing
+ else
+ do let stub_fn = case splitFilename3 obj_fn of
+ (dir, base, ext) -> dir ++ "/" ++ base ++ ".stub_o"
+ stub_exist <- doesFileExist stub_fn
+ obj_time <- getModificationTime obj_fn
+ if stub_exist
+ then return (Just (LM obj_time mod_name [DotO obj_fn, DotO stub_fn]))
+ else return (Just (LM obj_time mod_name [DotO obj_fn]))
+
+
+upsweep_mod :: GhciMode
+ -> UnlinkedImage
-> CmThreaded
-> ModSummary
+ -> [ModuleName]
-> IO (CmThreaded, Maybe Linkable)
-upsweep_mod oldUI threaded1 summary1
+upsweep_mod ghci_mode oldUI threaded1 summary1 reachable_from_here
= do let mod_name = name_of_summary summary1
let (CmThreaded pcs1 hst1 hit1) = threaded1
let old_iface = lookupUFM hit1 (name_of_summary summary1)
- compresult <- compile summary1 old_iface hst1 hit1 pcs1
+
+ -- We *have* to compile it if we're in batch mode and we can't see
+ -- a previous linkable for it on disk.
+ compilation_mandatory
+ <- if ghci_mode /= Batch then return False
+ else case ml_obj_file (ms_location summary1) of
+ Nothing -> do --putStrLn "cmcm: object?!"
+ return True
+ Just obj_fn -> do --putStrLn ("cmcm: old obj " ++ obj_fn)
+ b <- doesFileExist obj_fn
+ return (not b)
+
+ let maybe_oldUI_linkable = findModuleLinkable_maybe oldUI mod_name
+ maybe_oldDisk_linkable
+ <- case ml_obj_file (ms_location summary1) of
+ Nothing -> return Nothing
+ Just obj_fn -> maybe_getFileLinkable mod_name obj_fn
+
+ -- The most recent of the old UI linkable or whatever we could
+ -- find on disk. Is returned as the linkable if compile
+ -- doesn't think we need to recompile.
+ let maybe_old_linkable
+ = case (maybe_oldUI_linkable, maybe_oldDisk_linkable) of
+ (Nothing, Nothing) -> Nothing
+ (Nothing, Just di) -> Just di
+ (Just ui, Nothing) -> Just ui
+ (Just ui, Just di)
+ | linkableTime ui >= linkableTime di -> Just ui
+ | otherwise -> Just di
+
+ let compilation_mandatory
+ = case maybe_old_linkable of
+ Nothing -> True
+ Just li -> case ms_hs_date summary1 of
+ Nothing -> panic "compilation_mandatory:no src date"
+ Just src_date -> src_date >= linkableTime li
+ source_unchanged
+ = not compilation_mandatory
+
+ (hst1_strictDC, hit1_strictDC)
+ = retainInTopLevelEnvs reachable_from_here (hst1,hit1)
+
+ old_linkable
+ = unJust "upsweep_mod:old_linkable" maybe_old_linkable
+
+ compresult <- compile ghci_mode summary1 source_unchanged
+ old_iface hst1_strictDC hit1_strictDC pcs1
case compresult of
-> let hst2 = addToUFM hst1 mod_name details
hit2 = hit1
threaded2 = CmThreaded pcs2 hst2 hit2
- old_linkable = findModuleLinkable oldUI mod_name
in return (threaded2, Just old_linkable)
-- Compilation really did happen, and succeeded. A new
in return (threaded2, Nothing)
+-- Remove unwanted modules from the top level envs (HST, HIT, UI).
removeFromTopLevelEnvs :: [ModuleName]
-> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage)
-> (HomeSymbolTable, HomeIfaceTable, UnlinkedImage)
filterModuleLinkables (`notElem` zap_these) ui
)
+retainInTopLevelEnvs :: [ModuleName]
+ -> (HomeSymbolTable, HomeIfaceTable)
+ -> (HomeSymbolTable, HomeIfaceTable)
+retainInTopLevelEnvs keep_these (hst, hit)
+ = (retainInUFM hst keep_these,
+ retainInUFM hit keep_these
+ )
+ where
+ retainInUFM :: Uniquable key => UniqFM elt -> [key] -> UniqFM elt
+ retainInUFM ufm keys_to_keep
+ = listToUFM (concatMap (maybeLookupUFM ufm) keys_to_keep)
+ maybeLookupUFM ufm u
+ = case lookupUFM ufm u of Nothing -> []; Just val -> [(u, val)]
+
+-- Needed to clean up HIT and HST so that we don't get duplicates in inst env
+downwards_closure_of_module :: [ModSummary] -> ModuleName -> [ModuleName]
+downwards_closure_of_module summaries root
+ = let toEdge :: ModSummary -> (ModuleName,[ModuleName])
+ toEdge summ
+ = (name_of_summary summ, ms_srcimps summ ++ ms_imps summ)
+ 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
-- Chase downwards from the specified root set, returning summaries
-- for all home modules encountered. Only follow source-import
-- links.
-downsweep :: [ModuleName] -> IO [ModSummary]
+downsweep :: [FilePath] -> IO [ModSummary]
downsweep rootNm
- = do rootSummaries <- mapM getSummary rootNm
+ = do rootSummaries <- mapM getRootSummary rootNm
loop (filter (isModuleInThisPackage.ms_mod) rootSummaries)
where
+ getRootSummary :: FilePath -> IO ModSummary
+ getRootSummary file
+ | haskellish_file file
+ = do exists <- doesFileExist file
+ if exists then summariseFile file
+ else getSummary (mkModuleName file)
+ -- ToDo: should check import paths
+ | otherwise
+ = getSummary (mkModuleName file)
+
getSummary :: ModuleName -> IO ModSummary
getSummary nm
| trace ("getSummary: "++ showSDoc (ppr nm)) True
= do found <- findModule nm
case found of
- Just (mod, location) -> summarise preprocess mod location
+ -- Be sure not to use the mod and location passed in to
+ -- summarise for any other purpose -- summarise may change
+ -- the module names in them if name of module /= name of file,
+ -- and put the changed versions in the returned summary.
+ -- These will then conflict with the passed-in versions.
+ Just (mod, location) -> summarise mod location
Nothing -> throwDyn (OtherError
("no signs of life for module `"
++ showSDoc (ppr nm) ++ "'"))
if null newHomeSummaries
then return homeSummaries
else loop (newHomeSummaries ++ homeSummaries)
+
+
+-----------------------------------------------------------------------------
+-- Summarising modules
+
+-- We have two types of summarisation:
+--
+-- * Summarise a file. This is used for the root module passed to
+-- cmLoadModule. The file is read, and used to determine the root
+-- module name. The module name may differ from the filename.
+--
+-- * Summarise a module. We are given a module name, and must provide
+-- 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
+ modsrc <- readFile hspp_fn
+
+ let (srcimps,imps,mod_name) = getImports modsrc
+ (path, basename, ext) = splitFilename3 file
+
+ Just (mod, location)
+ <- mkHomeModuleLocn mod_name (path ++ '/':basename) file
+
+ maybe_src_timestamp
+ <- case ml_hs_file location of
+ Nothing -> return Nothing
+ Just src_fn -> maybe_getModificationTime src_fn
+
+ return (ModSummary mod
+ location{ml_hspp_file=Just hspp_fn}
+ srcimps imps
+ maybe_src_timestamp)
+
+-- Summarise a module, and pick up source and interface timestamps.
+summarise :: Module -> ModuleLocation -> IO ModSummary
+summarise mod location
+ | isModuleInThisPackage mod
+ = do let hs_fn = unJust "summarise" (ml_hs_file location)
+ hspp_fn <- preprocess hs_fn
+ modsrc <- readFile hspp_fn
+ let (srcimps,imps,mod_name) = getImports modsrc
+
+ maybe_src_timestamp
+ <- case ml_hs_file location of
+ Nothing -> return Nothing
+ Just src_fn -> maybe_getModificationTime src_fn
+
+ if mod_name == moduleName mod
+ then return ()
+ else throwDyn (OtherError
+ (showSDoc (text "file name does not match module name: "
+ <+> ppr (moduleName mod) <+> text "vs"
+ <+> ppr mod_name)))
+
+ return (ModSummary mod location{ml_hspp_file=Just hspp_fn}
+ srcimps imps
+ maybe_src_timestamp)
+
+ | otherwise
+ = return (ModSummary mod location [] [] Nothing)
+
+maybe_getModificationTime :: FilePath -> IO (Maybe ClockTime)
+maybe_getModificationTime fn
+ = (do time <- getModificationTime fn
+ return (Just time))
+ `catch`
+ (\err -> return Nothing)
\end{code}