%
\begin{code}
module CompManager (
- ModuleGraph, ModSummary(..),
+ ModSummary, -- Abstract
+ ModuleGraph, -- All the modules from the home package
- CmState, -- abstract
+ CmState, -- Abstract
cmInit, -- :: GhciMode -> IO CmState
cmDepAnal, -- :: CmState -> [FilePath] -> IO ModuleGraph
+ cmDownsweep,
+ cmTopSort, -- :: Bool -> ModuleGraph -> [SCC ModSummary]
+ cyclicModuleErr, -- :: [ModSummary] -> String -- Used by DriverMkDepend
cmLoadModules, -- :: CmState -> ModuleGraph
-- -> IO (CmState, Bool, [String])
cmUnload, -- :: CmState -> IO CmState
+
#ifdef GHCI
cmModuleIsInterpreted, -- :: CmState -> String -> IO Bool
cmGetInfo, -- :: CmState -> String -> IO (CmState, [(TyThing,Fixity)])
GetInfoResult,
cmBrowseModule, -- :: CmState -> IO [TyThing]
+ cmShowModule,
CmRunResult(..),
cmRunStmt, -- :: CmState -> String -> IO (CmState, CmRunResult)
HValue,
cmCompileExpr, -- :: CmState -> String -> IO (CmState, Maybe HValue)
-
- cmGetModInfo, -- :: CmState -> (ModuleGraph, HomePackageTable)
-
+ cmGetModuleGraph, -- :: CmState -> ModuleGraph
cmSetDFlags,
cmGetDFlags,
#include "HsVersions.h"
-import Packages ( isHomeModule )
+import Packages ( isHomePackage )
import DriverPipeline ( CompResult(..), preprocess, compile, link )
import HscMain ( newHscEnv )
import DriverState ( v_Output_file, v_NoHsMain, v_MainModIs )
-import DriverPhases
-import Finder
-import HscTypes
-import PrelNames ( gHC_PRIM )
-import Module ( Module, mkModule,
- ModuleEnv, lookupModuleEnv, mkModuleEnv,
- moduleEnvElts, extendModuleEnvList, extendModuleEnv,
- moduleUserString,
+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 LoadIface ( noIfaceErr )
-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(..), DynFlag(..), dopt_unset )
+import CmdLineOpts ( DynFlags(..) )
import Maybes ( expectJust, orElse, mapCatMaybes )
+import FiniteMap
import DATA_IOREF ( readIORef )
#ifdef GHCI
+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 )
import Linker ( HValue, unload, extendLinkEnv )
import GHC.Exts ( unsafeCoerce# )
import Foreign
-import SrcLoc ( SrcLoc )
import Control.Exception as Exception ( Exception, try )
+import CmdLineOpts ( DynFlag(..), dopt_unset, dopt )
#endif
import EXCEPTION ( throwDyn )
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
}
#ifdef GHCI
-cmGetModInfo cmstate = (cm_mg cmstate, hsc_HPT (cm_hsc cmstate))
+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)
[] -> Nothing
[li] -> Just li
many -> pprPanic "findModuleLinkable" (ppr mod)
+
+delModuleLinkable :: [Linkable] -> Module -> [Linkable]
+delModuleLinkable ls mod = [ l | l@(LM _ nm _) <- ls, nm /= mod ]
\end{code}
hsc_env = cm_hsc cmstate
hpt = hsc_HPT hsc_env
- export_env <- mkExportEnv hsc_env (map mkModule exports)
+ 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
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
+ 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 hm_globals details of
+ Just details -> case mi_globals (hm_iface details) of
Nothing -> throwDyn (ProgramError ("mkTopLevEnv: not interpreted " ++ mod))
Just env -> return env
cmModuleIsInterpreted :: CmState -> String -> IO Bool
cmModuleIsInterpreted cmstate str
= case lookupModuleEnv (cmHPT cmstate) (mkModule str) of
- Just details -> return (isJust (hm_globals details))
+ Just details -> return (isJust (mi_globals (hm_iface details)))
_not_a_home_module -> return False
-----------------------------------------------------------------------------
-----------------------------------------------------------------------------
+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
+ hpt = hsc_HPT (cm_hsc cmstate)
+
+-----------------------------------------------------------------------------
-- cmRunStmt: Run a statement/expr.
data CmRunResult
case maybe_stuff of
Nothing -> return Nothing
- Just ty -> return (Just res_str)
+ Just ty -> return (Just (showSDocForUser unqual doc))
where
- res_str = showSDocForUser unqual (text expr <+> dcolon <+> ppr tidy_ty)
+ doc = text expr <+> dcolon <+> ppr final_ty
unqual = icPrintUnqual (cm_ic cmstate)
tidy_ty = tidyType emptyTidyEnv ty
-
+ 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
-- Start with a fresh CmState, but keep the PersistentCompilerState
return (discardCMInfo state)
-cm_unload hsc_env linkables
+cm_unload hsc_env stable_linkables -- Unload everthing *except* 'stable_linkables'
= case hsc_mode hsc_env of
Batch -> return ()
#ifdef GHCI
- Interactive -> Linker.unload (hsc_dflags hsc_env) linkables
+ Interactive -> Linker.unload (hsc_dflags hsc_env) stable_linkables
#else
- Interactive -> panic "unload: no interpreter"
+ Interactive -> panic "cm_unload: no interpreter"
#endif
+ other -> panic "cm_unload: strange mode"
-----------------------------------------------------------------------------
hPutStrLn stderr (showSDoc (hcat [
text "Chasing modules from: ",
hcat (punctuate comma (map text rootnames))]))
- downsweep dflags rootnames (cm_mg cmstate)
+ cmDownsweep dflags rootnames (cm_mg cmstate) []
where
hsc_env = cm_hsc cmstate
dflags = hsc_dflags hsc_env
-- the system state at the same time.
cmLoadModules :: CmState -- The HPT may not be as up to date
- -> 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
let mg2unsorted_names = map ms_mod mg2unsorted
- -- reachable_from follows source as well as normal imports
- let reachable_from :: Module -> [Module]
- 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.
-- putStrLn (showSDoc (vcat [ppr valid_old_linkables, ppr new_linkables]))
- let hpt2 = delListFromUFM hpt1 (map linkableModule new_linkables)
- hsc_env2 = hsc_env { hsc_HPT = hpt2 }
+ -- 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:"
-- 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 -> linkableModule 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.moduleUserString) stable_mods)))
- -- Unload any modules which are going to be re-linked this
- -- time around.
- cm_unload hsc_env2 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 ms_mod (flattenSCC scc)))
- mg2
-
--hPutStrLn stderr "after tsort:\n"
--hPutStrLn stderr (showSDoc (vcat (map ppr mg2)))
(ppFilesFromSummaries (flattenSCCs mg2))
(upsweep_ok, hsc_env3, modsUpswept)
- <- upsweep_mods hsc_env2 valid_linkables reachable_from
+ <- 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
-- 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 (ml_hspp_file.ms_location) summaries ]
+ppFilesFromSummaries summaries = [ fn | Just fn <- map ms_hspp_file summaries ]
-----------------------------------------------------------------------------
-- getValidLinkables
-> [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
| 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
-- 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
preUpsweep :: [Linkable] -- new valid linkables
-> [Module] -- names of all mods encountered in downsweep
- -> [Module] -- accumulating stable modules
+ -> [ModSummary] -- accumulating stable modules
-> [SCC ModSummary] -- scc-ified mod graph, including src imps
- -> IO [Module] -- stable modules
+ -> IO [ModSummary] -- stable modules
preUpsweep valid_lis all_home_mods stable [] = return stable
preUpsweep valid_lis all_home_mods stable (scc0:sccs)
= 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 ms_mod 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 = ms_mod 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] -> Module -> [ModSummary]
-findInSummaries old_summaries mod_name
- = [s | s <- old_summaries, ms_mod 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.
-- 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 :: HscEnv -- Includes up-to-date HPT
- -> [Linkable] -- Valid linkables
- -> (Module -> [Module]) -- to construct downward closures
- -> 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,
HscEnv, -- With an updated HPT
[ModSummary]) -- Mods which succeeded
-upsweep_mods hsc_env oldUI reachable_from cleanup
+upsweep_mods hsc_env oldUI cleanup
[]
= return (Succeeded, hsc_env, [])
-upsweep_mods hsc_env oldUI reachable_from cleanup
- ((CyclicSCC ms):_)
- = do hPutStrLn stderr ("Module imports form a cycle for modules:\n\t" ++
- unwords (map (moduleUserString.ms_mod) ms))
+upsweep_mods hsc_env oldUI cleanup
+ (CyclicSCC ms:_)
+ = do hPutStrLn stderr (showSDoc (cyclicModuleErr ms))
return (Failed, hsc_env, [])
-upsweep_mods hsc_env oldUI reachable_from cleanup
- ((AcyclicSCC mod):mods)
+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) (eltsUFM (hsc_HPT hsc_env)))
+ -- show (map (moduleUserString.moduleName.mi_module.hm_iface)
+ -- (moduleEnvElts (hsc_HPT hsc_env)))
- (ok_flag, hsc_env1) <- upsweep_mod hsc_env oldUI mod
- (reachable_from (ms_mod mod))
+ mb_mod_info <- upsweep_mod hsc_env oldUI mod
cleanup -- Remove unwanted tmp files between compilations
- if failed ok_flag then
- return (Failed, hsc_env1, [])
- else do
- (restOK, hsc_env2, modOKs)
- <- upsweep_mods hsc_env1 oldUI reachable_from cleanup mods
- return (restOK, hsc_env2, 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 :: HscEnv
- -> UnlinkedImage
+ -> (HomePackageTable, UnlinkedImage)
-> ModSummary
- -> [Module]
- -> IO (SuccessFlag,
- HscEnv) -- With updated HPT
+ -> IO (Maybe HomeModInfo) -- Nothing => Failed
-upsweep_mod hsc_env oldUI summary1 reachable_inc_me
+upsweep_mod hsc_env (old_hpt, old_linkables) summary
= do
- let this_mod = ms_mod summary1
- location = ms_location summary1
- hpt1 = hsc_HPT hsc_env
-
- let mb_old_iface = case lookupModuleEnv hpt1 this_mod of
- Just mod_info -> Just (hm_iface mod_info)
- Nothing -> Nothing
-
- let maybe_old_linkable = findModuleLinkable_maybe oldUI this_mod
+ 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 (/= this_mod) 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(hsc_mode hsc_env == Batch || all (`elemUFM` hpt1) reachable_only)
- retainInTopLevelEnvs reachable_only hpt1
- hsc_env_strictDC = hsc_env { hsc_HPT = hpt1_strictDC }
-
old_linkable = expectJust "upsweep_mod:old_linkable" maybe_old_linkable
have_object
| Just l <- maybe_old_linkable, isObjectLinkable l = True
| otherwise = False
- compresult <- compile hsc_env_strictDC this_mod location
- (ms_hs_date summary1)
- source_unchanged have_object mb_old_iface
+ 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 new_details new_globals 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_globals = new_globals,
hm_details = new_details,
hm_linkable = new_linkable }
- hpt2 = extendModuleEnv hpt1 this_mod new_info
-
- return (Succeeded, hsc_env { hsc_HPT = hpt2 })
+ return (Just new_info)
-- Compilation failed. Compile may still have updated the PCS, tho.
- CompErrs -> return (Failed, hsc_env)
+ CompErrs -> return Nothing
-- Filter modules in the HPT
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] -> Module -> [Module]
-downwards_closure_of_module summaries root
- = let toEdge :: ModSummary -> (Module,[Module])
- toEdge summ = (ms_mod summ,
- filter (`elem` all_mods) (ms_allimps summ))
-
- all_mods = map ms_mod 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,Module,[Module])
- toEdge summ
- = (summ, ms_mod summ,
- (if include_source_imports
- then ms_srcimps summ else []) ++ ms_imps summ)
-
- mash_edge :: (ModSummary,Module,[Module]) -> (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
- mapCatMaybes (flip lookup key_map) m_imports)
-
- edges = map toEdge summaries
- key_map = zip [nm | (s,nm,imps) <- edges] [1 ..] :: [(Module,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
-----------------------------------------------------------------------------
-- 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 :: DynFlags -> [FilePath] -> [ModSummary] -> IO [ModSummary]
-downsweep dflags 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 "<unknown>" (ml_hs_file (ms_location m))))
- (ms_imps m)) rootSummaries))
- (mkModuleEnv [ (mod, s) | s <- rootSummaries,
- let mod = ms_mod s,
- isHomeModule dflags 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
| isHaskellSrcFilename file
exists <- doesFileExist lhs_file
if exists then summariseFile dflags lhs_file else do
let mod_name = mkModule file
- maybe_summary <- getSummary (file, mod_name)
+ maybe_summary <- summarise dflags emptyNodeMap Nothing False
+ mod_name excl_mods
case maybe_summary of
Nothing -> packageModErr mod_name
Just s -> return s
[ fromJust (ml_hs_file (ms_location summ'))
| summ' <- summaries, ms_mod summ' == modl ]
- getSummary :: (FilePath,Module) -> IO (Maybe ModSummary)
- getSummary (currentMod,mod)
- = do found <- findModule dflags mod True{-explicit-}
- case found of
- Found location pkg -> do
- let old_summary = findModInSummaries old_summaries mod
- summarise dflags mod location old_summary
+ 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
- err -> throwDyn (noModError dflags currentMod mod err)
-
- -- loop invariant: env doesn't contain package modules
- loop :: [(FilePath,Module)] -> 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 "<unknown>" (ml_hs_file (ms_location m))))
- (ms_imps m)) new_home_summaries)
- loop new_imps (extendModuleEnvList env
- [ (ms_mod s, s) | s <- new_home_summaries ])
-
--- ToDo: we don't have a proper line number for this error
-noModError dflags loc mod_nm err
- = ProgramError (showSDoc (hang (text loc <> colon) 4 $
- noIfaceErr dflags mod_nm err))
-----------------------------------------------------------------------------
-- Summarising modules
-- resides.
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 hspp_fn <- preprocess dflags file
- (srcimps,imps,mod) <- getImportsFromFile hspp_fn
+ = do (dflags', hspp_fn) <- preprocess dflags file
+ -- The dflags' contains the OPTIONS pragmas
- let -- GHC.Prim doesn't exist physically, so don't go looking for it.
- the_imps = filter (/= gHC_PRIM) imps
+ -- 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
- src_timestamp
- <- case ml_hs_file location of
- Nothing -> noHsFileErr mod
- Just src_fn -> getModificationTime src_fn
+ -- 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
- return (ModSummary { ms_mod = mod,
- ms_location = location{ml_hspp_file=Just hspp_fn},
+ 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 :: DynFlags -> Module -> ModLocation -> Maybe ModSummary
- -> IO (Maybe ModSummary)
-summarise dflags mod location old_summary
- | not (isHomeModule dflags 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 dflags 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) imps
-
- when (mod_name /= 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 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" <+>
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 :: [Module], -- source imports
- ms_imps :: [Module], -- 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
+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}
+
projects / ghc-hetmet.git / blobdiff