X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FFinder.lhs;h=3491a72d1c1063f368f0018deecea9e320497af8;hb=8f0c89cbbbad60c4f05356fcb9053b7ed0c18075;hp=ce01c28ad8fcc3069149cbf7980dc7f1cea3f7ec;hpb=4ff8aecd97c39f212bc334f28c7b8265d5ccc197;p=ghc-hetmet.git diff --git a/ghc/compiler/main/Finder.lhs b/ghc/compiler/main/Finder.lhs index ce01c28..3491a72 100644 --- a/ghc/compiler/main/Finder.lhs +++ b/ghc/compiler/main/Finder.lhs @@ -6,150 +6,150 @@ \begin{code} module Finder ( initFinder, -- :: [PackageConfig] -> IO (), - findModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation)) - findModuleDep, -- :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation)) - findPackageModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation)) - mkHomeModuleLocn, -- :: ModuleName -> String -> FilePath - -- -> IO ModuleLocation - emptyHomeDirCache, -- :: IO () - flushPackageCache -- :: [PackageConfig] -> IO () + flushFinderCache, -- :: IO () + + findModule, -- :: ModuleName -> IO (Maybe (Module, ModLocation)) + findPackageModule, -- :: ModuleName -> IO (Maybe (Module, ModLocation)) + + mkHomeModLocation, -- :: ModuleName -> String -> FilePath + -- -> IO ModLocation + + findLinkable, -- :: ModuleName -> ModLocation -> IO (Maybe Linkable) + + hiBootExt, -- :: String + hiBootVerExt, -- :: String + ) where #include "HsVersions.h" -import HscTypes ( ModuleLocation(..) ) +import Module +import UniqFM ( filterUFM ) import Packages ( PackageConfig(..) ) -import DriverPhases +import HscTypes ( Linkable(..), Unlinked(..) ) import DriverState -import DriverUtil -import Module +import DriverUtil ( split_longest_prefix, splitFilename3 ) import FastString import Config +import Util + +import DATA_IOREF ( IORef, writeIORef, readIORef ) -import IOExts import List import Directory import IO import Monad -\end{code} -The Finder provides a thin filesystem abstraction to the rest of the -compiler. For a given module, it knows (a) whether the module lives -in the home package or in another package, so it can make a Module -from a ModuleName, and (b) where the source, interface, and object -files for a module live. +-- ----------------------------------------------------------------------------- +-- The Finder -It does *not* know which particular package a module lives in, because -that information is only contained in the interface file. +-- The Finder provides a thin filesystem abstraction to the rest of the +-- compiler. For a given module, it knows (a) whether the module lives +-- in the home package or in another package, so it can make a Module +-- from a ModuleName, and (b) where the source, interface, and object +-- files for a module live. +-- +-- It does *not* know which particular package a module lives in, because +-- that information is only contained in the interface file. -\begin{code} initFinder :: [PackageConfig] -> IO () initFinder pkgs = return () --- empty, and lazilly fill in the package cache -flushPackageCache :: [PackageConfig] -> IO () -flushPackageCache pkgs = return () +-- ----------------------------------------------------------------------------- +-- The finder's cache + +GLOBAL_VAR(finder_cache, emptyModuleEnv, ModuleEnv (Module,ModLocation)) + +-- remove all the home modules from the cache; package modules are +-- assumed to not move around during a session. +flushFinderCache :: IO () +flushFinderCache = do + fm <- readIORef finder_cache + writeIORef finder_cache (filterUFM (not . isHomeModule . fst) fm) + +addToFinderCache :: ModuleName -> (Module,ModLocation) -> IO () +addToFinderCache mod_name stuff = do + fm <- readIORef finder_cache + writeIORef finder_cache (extendModuleEnvByName fm mod_name stuff) + +lookupFinderCache :: ModuleName -> IO (Maybe (Module,ModLocation)) +lookupFinderCache mod_name = do + fm <- readIORef finder_cache + return $! lookupModuleEnvByName fm mod_name + +-- ----------------------------------------------------------------------------- +-- Locating modules -emptyHomeDirCache :: IO () -emptyHomeDirCache = return () +-- This is the main interface to the finder, which maps ModuleNames to +-- Modules and ModLocations. +-- +-- The Module contains one crucial bit of information about a module: +-- whether it lives in the current ("home") package or not (see Module +-- for more details). +-- +-- The ModLocation contains the names of all the files associated with +-- that module: its source file, .hi file, object file, etc. -findModule :: ModuleName -> IO (Maybe (Module, ModuleLocation)) -findModule name = findModuleDep name False +findModule :: ModuleName -> IO (Maybe (Module, ModLocation)) +findModule name = do + r <- lookupFinderCache name + case r of + Just result -> return (Just result) + Nothing -> do + j <- maybeHomeModule name + case j of + Just home_module -> return (Just home_module) + Nothing -> findPackageMod name -findModuleDep :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation)) -findModuleDep name is_source - = do { j <- maybeHomeModule name is_source - ; case j of - Just home_module -> return (Just home_module) - Nothing -> findPackageMod name False - } +findPackageModule :: ModuleName -> IO (Maybe (Module, ModLocation)) +findPackageModule name = do + r <- lookupFinderCache name + case r of + Just result -> return (Just result) + Nothing -> findPackageMod name -maybeHomeModule :: ModuleName -> Bool -> IO (Maybe (Module, ModuleLocation)) -maybeHomeModule mod_name is_source = do +hiBootExt = "hi-boot" +hiBootVerExt = "hi-boot-" ++ cHscIfaceFileVersion + +maybeHomeModule :: ModuleName -> IO (Maybe (Module, ModLocation)) +maybeHomeModule mod_name = do home_path <- readIORef v_Import_paths hisuf <- readIORef v_Hi_suf mode <- readIORef v_GhcMode - let mod_str = moduleNameUserString mod_name - basename = map (\c -> if c == '.' then '/' else c) mod_str - - -- In compilation manager modes, we look for source files in the home - -- package because we can compile these automatically. In one-shot - -- compilation mode we look for .hi files only. - -- - -- When generating dependencies, we're interested in either category. - -- - source_exts = - [ ("hs", \ fName path -> mkHomeModuleLocn mod_name path fName) - , ("lhs", \ fName path -> mkHomeModuleLocn mod_name path fName) - ] - hi_exts = [ (hisuf, \ fName path -> mkHiOnlyModuleLocn mod_name fName) ] - - std_exts - | mode == DoMkDependHS = hi_exts ++ source_exts + let + source_exts = + [ ("hs", mkHomeModLocation mod_name False) + , ("lhs", mkHomeModLocation mod_name False) + ] + + hi_exts = [ (hisuf, mkHiOnlyModLocation hisuf mod_name) ] + + boot_exts = + [ (hiBootVerExt, mkHiOnlyModLocation hisuf mod_name) + , (hiBootExt, mkHiOnlyModLocation hisuf mod_name) + ] + + -- In compilation manager modes, we look for source files in the home + -- package because we can compile these automatically. In one-shot + -- compilation mode we look for .hi and .hi-boot files only. + -- + -- When generating dependencies, we're interested in either category. + -- + exts + | mode == DoMkDependHS = hi_exts ++ source_exts ++ boot_exts | isCompManagerMode mode = source_exts - | otherwise = hi_exts - - -- last chance: .hi-boot- and .hi-boot - hi_boot_ver = "hi-boot-" ++ cHscIfaceFileVersion - - boot_exts = - [ (hi_boot_ver, \ fName path -> mkHiOnlyModuleLocn mod_name fName) - , ("hi-boot", \ fName path -> mkHiOnlyModuleLocn mod_name fName) - ] - - searchPathExts home_path basename - (if is_source then boot_exts else (std_exts ++ boot_exts)) - -- for SOURCE imports, check the hi-boot extensions - -- before the source/iface ones, to avoid - -- creating circ Makefile deps. - -mkHiOnlyModuleLocn mod_name hi_file = - return - ( mkHomeModule mod_name - , ModuleLocation{ ml_hspp_file = Nothing - , ml_hs_file = Nothing - , ml_hi_file = hi_file - , ml_obj_file = Nothing - } - ) + | otherwise {-one-shot-} = hi_exts ++ boot_exts --- The .hi file always follows the module name, whereas the object --- file may follow the name of the source file in the case where the --- two differ (see summariseFile in compMan/CompManager.lhs). - -mkHomeModuleLocn mod_name - basename -- everything but the extension - source_fn -- full path to the source (required) - = do - - hisuf <- readIORef v_Hi_suf - hidir <- readIORef v_Hi_dir + searchPathExts home_path mod_name exts + +-- ----------------------------------------------------------------------------- +-- Looking for a package module - -- take the *last* component of the module name (if a hierarchical name), - -- and append it to the directory to get the .hi file name. - let (_,mod_str) = split_longest_prefix (moduleNameUserString mod_name) (=='.') - hi_filename = mod_str ++ '.':hisuf - hi_path | Just d <- hidir = d - | otherwise = getdir basename - hi = hi_path ++ '/':hi_filename - - -- figure out the .o file name. It also lives in the same dir - -- as the source, but can be overriden by a -odir flag. - o_file <- odir_ify (basename ++ '.':phaseInputExt Ln) >>= osuf_ify - - return (mkHomeModule mod_name, - ModuleLocation{ ml_hspp_file = Nothing - , ml_hs_file = Just source_fn - , ml_hi_file = hi - , ml_obj_file = Just o_file - }) - -findPackageMod :: ModuleName - -> Bool - -> IO (Maybe (Module, ModuleLocation)) -findPackageMod mod_name hiOnly = do - pkgs <- getPackageInfo +findPackageMod :: ModuleName -> IO (Maybe (Module, ModLocation)) +findPackageMod mod_name = do + mode <- readIORef v_GhcMode + imp_dirs <- getPackageImportPath -- including the 'auto' ones -- hi-suffix for packages depends on the build tag. package_hisuf <- @@ -157,37 +157,45 @@ findPackageMod mod_name hiOnly = do if null tag then return "hi" else return (tag ++ "_hi") - let imp_dirs = concatMap import_dirs pkgs - mod_str = moduleNameUserString mod_name - basename = map (\c -> if c == '.' then '/' else c) mod_str - - retPackageModule mod_name mbFName path = - return ( mkPackageModule mod_name - , ModuleLocation{ ml_hspp_file = Nothing - , ml_hs_file = mbFName - , ml_hi_file = path ++ '.':package_hisuf - , ml_obj_file = Nothing - }) - - searchPathExts - imp_dirs basename - ((package_hisuf,\ fName path -> retPackageModule mod_name Nothing path) : - -- can packages contain hi-boots? - (if hiOnly then [] else - [ ("hs", \ fName path -> retPackageModule mod_name (Just fName) path) - , ("lhs", \ fName path -> retPackageModule mod_name (Just fName) path) - ])) - where -findPackageModule :: ModuleName -> IO (Maybe (Module, ModuleLocation)) -findPackageModule mod_name = findPackageMod mod_name True + let + hi_exts = + [ (package_hisuf, mkPackageModLocation package_hisuf mod_name) ] + + source_exts = + [ ("hs", mkPackageModLocation package_hisuf mod_name) + , ("lhs", mkPackageModLocation package_hisuf mod_name) + ] + + -- mkdependHS needs to look for source files in packages too, so + -- that we can make dependencies between package before they have + -- been built. + exts + | mode == DoMkDependHS = hi_exts ++ source_exts + | otherwise = hi_exts + + -- we never look for a .hi-boot file in an external package; + -- .hi-boot files only make sense for the home package. + searchPathExts imp_dirs mod_name exts + +-- ----------------------------------------------------------------------------- +-- General path searching + +searchPathExts + :: [FilePath] -- paths to search + -> ModuleName -- module name + -> [ ( + String, -- suffix + String -> String -> String -> IO (Module, ModLocation) -- action + ) + ] + -> IO (Maybe (Module, ModLocation)) -searchPathExts :: [FilePath] - -> String - -> [(String, FilePath -> String -> IO (Module, ModuleLocation))] - -> IO (Maybe (Module, ModuleLocation)) -searchPathExts path basename exts = search path +searchPathExts path mod_name exts = search path where + mod_str = moduleNameUserString mod_name + basename = map (\c -> if c == '.' then '/' else c) mod_str + search [] = return Nothing search (p:ps) = loop exts where @@ -198,6 +206,133 @@ searchPathExts path basename exts = search path loop ((ext,fn):exts) = do let file = base ++ '.':ext b <- doesFileExist file - if b then Just `liftM` fn file base + if b then Just `liftM` fn p basename ext else loop exts + +-- ----------------------------------------------------------------------------- +-- Building ModLocations + +mkHiOnlyModLocation hisuf mod_name path basename extension = do + addToFinderCache mod_name result + return result + where + result = ( mkHomeModule mod_name, hiOnlyModLocation path basename hisuf ) + +mkPackageModLocation hisuf mod_name path basename _extension = do + addToFinderCache mod_name result + return result + where + result = ( mkPackageModule mod_name, hiOnlyModLocation path basename hisuf ) + +hiOnlyModLocation path basename hisuf = + ModLocation{ ml_hspp_file = Nothing, + ml_hs_file = Nothing, + -- remove the .hi-boot suffix from hi_file, if it + -- had one. We always want the name of the real + -- .hi file in the ml_hi_file field. + ml_hi_file = path ++ '/':basename ++ '.':hisuf, + ml_obj_file = Nothing + } + +-- ----------------------------------------------------------------------------- +-- Constructing a home module location + +-- The .hi file always follows the module name, whereas the object +-- file may follow the name of the source file in the case where the +-- two differ (see summariseFile in compMan/CompManager.lhs). + +-- The source filename is specified in three components. For example, +-- if we have a module "A.B.C" which was found along the patch "/P/Q/R" +-- with extension ".hs", then the full filename is "/P/Q/R/A/B/C.hs". The +-- components passed to mkHomeModLocation are +-- +-- path: "/P/Q/R" +-- basename: "A/B/C" +-- extension: "hs" +-- +-- the object file and interface file are constructed by possibly +-- replacing the path component with the values of the -odir or the +-- -hidr options respectively, and the extension with the values of +-- the -osuf and -hisuf options respectively. That is, the basename +-- always remains intact. +-- +-- mkHomeModLocation is called directly by the compilation manager to +-- construct the information for a root module. For a "root" module, +-- the rules are slightly different. The filename is allowed to +-- diverge from the module name, but we have to name the interface +-- file after the module name. For example, a root module +-- "/P/Q/R/foo.hs" will have components +-- +-- path: "/P/Q/R" +-- basename: "foo" +-- extension: "hs" +-- +-- and we set the flag is_root to True, to indicate that the basename +-- portion for the .hi file should be replaced by the last component +-- of the module name. eg. if the module name is "A.B.C" then basename +-- will be replaced by "C" for the .hi file only, resulting in an +-- .hi file like "/P/Q/R/C.hi" (subject to -hidir and -hisuf as usual). + +mkHomeModLocation mod_name is_root path basename extension = do + + hisuf <- readIORef v_Hi_suf + hidir <- readIORef v_Hi_dir + odir <- readIORef v_Output_dir + osuf <- readIORef v_Object_suf + + let -- hi filename + mod_str = moduleNameUserString mod_name + (_,mod_suf) = split_longest_prefix mod_str (=='.') + + hi_basename + | is_root = mod_suf + | otherwise = basename + + hi_path | Just d <- hidir = d + | otherwise = path + hi_fn = hi_path ++ '/':hi_basename ++ '.':hisuf + + -- source filename (extension is always .hs or .lhs) + source_fn + | path == "." = basename ++ '.':extension + | otherwise = path ++ '/':basename ++ '.':extension + + -- the object filename + obj_path | Just d <- odir = d + | otherwise = path + obj_fn = obj_path ++ '/':basename ++ '.':osuf + + + result = ( mkHomeModule mod_name, + ModLocation{ ml_hspp_file = Nothing, + ml_hs_file = Just source_fn, + ml_hi_file = hi_fn, + ml_obj_file = Just obj_fn, + }) + + addToFinderCache mod_name result + return result \end{code} + +-- ----------------------------------------------------------------------------- +-- findLinkable isn't related to the other stuff in here, +-- but there' no other obvious place for it + +\begin{code} +findLinkable :: ModuleName -> ModLocation -> IO (Maybe Linkable) +findLinkable mod locn + | Just obj_fn <- ml_obj_file locn + = 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 [DotO obj_fn, DotO stub_fn])) + else return (Just (LM obj_time mod [DotO obj_fn])) + | otherwise + = return Nothing +\end{code} \ No newline at end of file