\begin{code}
module Finder (
- initFinder, -- :: [PackageConfig] -> IO (),
- findModule, -- :: ModuleName -> IO (Maybe (Module, ModuleLocation))
- mkHomeModuleLocn, -- :: ModuleName -> String -> Maybe FilePath
- -- -> IO ModuleLocation
- emptyHomeDirCache, -- :: IO ()
- flushPackageCache -- :: [PackageConfig] -> IO ()
+ flushFinderCache, -- :: IO ()
+
+ findModule, -- :: ModuleName
+ -- -> IO (Either [FilePath] (Module, ModLocation))
+
+ findPackageModule, -- :: ModuleName
+ -- -> IO (Either [FilePath] (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 Packages ( PackageConfig(..) )
-import DriverPhases
-import DriverState
import Module
+import UniqFM ( filterUFM )
+import HscTypes ( Linkable(..), Unlinked(..) )
+import DriverState
+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
-import Outputable
-\end{code}
-The Finder provides a thin filesystem abstraction to the rest of the
-compiler. For a given module, it knows (a) which package the module
-lives in, so it can make a Module from a ModuleName, and (b) where the
-source, interface, and object files for a module live.
+-- -----------------------------------------------------------------------------
+-- The Finder
-\begin{code}
-initFinder :: [PackageConfig] -> IO ()
-initFinder pkgs = return ()
+-- 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.
+
+-- -----------------------------------------------------------------------------
+-- The finder's cache
+
+GLOBAL_VAR(finder_cache, emptyModuleEnv, ModuleEnv (Module,ModLocation))
--- empty, and lazilly fill in the package cache
-flushPackageCache :: [PackageConfig] -> IO ()
-flushPackageCache pkgs = return ()
+-- 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)
-emptyHomeDirCache :: IO ()
-emptyHomeDirCache = return ()
+addToFinderCache :: ModuleName -> (Module,ModLocation) -> IO ()
+addToFinderCache mod_name stuff = do
+ fm <- readIORef finder_cache
+ writeIORef finder_cache (extendModuleEnvByName fm mod_name stuff)
-findModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
-findModule name
- = do { j <- maybeHomeModule name
- ; case j of
- Just home_module -> return (Just home_module)
- Nothing -> maybePackageModule name
- }
+lookupFinderCache :: ModuleName -> IO (Maybe (Module,ModLocation))
+lookupFinderCache mod_name = do
+ fm <- readIORef finder_cache
+ return $! lookupModuleEnvByName fm mod_name
-maybeHomeModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
+-- -----------------------------------------------------------------------------
+-- Locating modules
+
+-- 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 (Either [FilePath] (Module, ModLocation))
+findModule name = do
+ r <- lookupFinderCache name
+ case r of
+ Just result -> return (Right result)
+ Nothing -> do
+ j <- maybeHomeModule name
+ case j of
+ Right home_module -> return (Right home_module)
+ Left home_files -> do
+ r <- findPackageMod name
+ case r of
+ Right pkg_module -> return (Right pkg_module)
+ Left pkg_files -> return (Left (home_files ++ pkg_files))
+
+findPackageModule :: ModuleName -> IO (Either [FilePath] (Module, ModLocation))
+findPackageModule name = do
+ r <- lookupFinderCache name
+ case r of
+ Just result -> return (Right result)
+ Nothing -> findPackageMod name
+
+hiBootExt = "hi-boot"
+hiBootVerExt = "hi-boot-" ++ cHscIfaceFileVersion
+
+maybeHomeModule :: ModuleName -> IO (Either [FilePath] (Module, ModLocation))
maybeHomeModule mod_name = do
home_path <- readIORef v_Import_paths
+ hisuf <- readIORef v_Hi_suf
+ mode <- readIORef v_GhcMode
+
+ 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 {-one-shot-} = hi_exts ++ boot_exts
- let mod_str = moduleNameUserString mod_name
- basename = map (\c -> if c == '.' then '/' else c) mod_str
- hs = basename ++ ".hs"
- lhs = basename ++ ".lhs"
-
- found <- findOnPath home_path hs
- case found of {
- -- special case to avoid getting "./foo.hs" all the time
- Just "." -> mkHomeModuleLocn mod_name basename (Just hs);
- Just path -> mkHomeModuleLocn mod_name
- (path ++ '/':basename) (Just (path ++ '/':hs));
- Nothing -> do
-
- found <- findOnPath home_path lhs
- case found of {
- -- special case to avoid getting "./foo.hs" all the time
- Just "." -> mkHomeModuleLocn mod_name basename (Just lhs);
- Just path -> mkHomeModuleLocn mod_name
- (path ++ '/':basename) (Just (path ++ '/':lhs));
- Nothing -> do
-
- -- can't find a source file anywhere, check for a lone .hi file.
- hisuf <- readIORef v_Hi_suf
- let hi = basename ++ '.':hisuf
- found <- findOnPath home_path hi
- case found of {
- Just path -> mkHiOnlyModuleLocn mod_name hi;
- Nothing -> do
-
- -- last chance: .hi-boot-<ver> and .hi-boot
- let hi_boot = basename ++ ".hi-boot"
- let hi_boot_ver = basename ++ ".hi-boot-" ++ cHscIfaceFileVersion
- found <- findOnPath home_path hi_boot_ver
- case found of {
- Just path -> mkHiOnlyModuleLocn mod_name hi;
- Nothing -> do
- found <- findOnPath home_path hi_boot
- case found of {
- Just path -> mkHiOnlyModuleLocn mod_name hi;
- Nothing -> return Nothing
- }}}}}
-
-
-mkHiOnlyModuleLocn mod_name hi_file = do
- return (Just (mkHomeModule mod_name,
- ModuleLocation{
- ml_hspp_file = Nothing,
- ml_hs_file = Nothing,
- ml_hi_file = hi_file,
- ml_obj_file = Nothing
- }
- ))
+ searchPathExts home_path mod_name exts
+
+-- -----------------------------------------------------------------------------
+-- Looking for a package module
+
+findPackageMod :: ModuleName -> IO (Either [FilePath] (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 <-
+ do tag <- readIORef v_Build_tag
+ if null tag
+ then return "hi"
+ else return (tag ++ "_hi")
+
+ 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 (Either [FilePath] (Module, ModLocation))
+
+searchPathExts path mod_name exts = search to_search
+ where
+ mod_str = moduleNameUserString mod_name
+ basename = map (\c -> if c == '.' then '/' else c) mod_str
+
+ to_search :: [(FilePath, IO (Module,ModLocation))]
+ to_search = [ (file, fn p basename ext)
+ | p <- path,
+ (ext,fn) <- exts,
+ let base | p == "." = basename
+ | otherwise = p ++ '/':basename
+ file = base ++ '.':ext
+ ]
+
+ search [] = return (Left (map fst to_search))
+ search ((file, result) : rest) = do
+ b <- doesFileExist file
+ if b
+ then Right `liftM` result
+ else search rest
+
+-- -----------------------------------------------------------------------------
+-- Building ModLocations
+
+mkHiOnlyModLocation hisuf mod_name path basename extension = do
+ loc <- hiOnlyModLocation path basename hisuf
+ let result = (mkHomeModule mod_name, loc)
+ addToFinderCache mod_name result
+ return result
+
+mkPackageModLocation hisuf mod_name path basename _extension = do
+ loc <- hiOnlyModLocation path basename hisuf
+ let result = (mkPackageModule mod_name, loc)
+ addToFinderCache mod_name result
+ return result
+
+hiOnlyModLocation path basename hisuf
+ = do { obj_fn <- mkObjPath path basename ;
+ return (ModLocation{ ml_hspp_file = Nothing,
+ ml_hs_file = Nothing,
+ ml_hi_file = path ++ '/':basename ++ '.':hisuf,
+ -- 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_obj_file = obj_fn
+ })}
+
+-- -----------------------------------------------------------------------------
+-- 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).
-mkHomeModuleLocn mod_name basename maybe_source_fn = do
+-- 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
- let hi_rest = basename ++ '.':hisuf
- hi_file | Just d <- hidir = d ++ '/':hi_rest
- | otherwise = hi_rest
+ obj_fn <- mkObjPath path basename
- -- 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
+ let -- hi filename
+ mod_str = moduleNameUserString mod_name
+ (_,mod_suf) = split_longest_prefix mod_str (=='.')
- return (Just (mkHomeModule mod_name,
- ModuleLocation{
- ml_hspp_file = Nothing,
- ml_hs_file = maybe_source_fn,
- ml_hi_file = hi_file,
- ml_obj_file = Just o_file
- }
- ))
+ hi_basename
+ | is_root = mod_suf
+ | otherwise = basename
+ hi_path | Just d <- hidir = d
+ | otherwise = path
+ hi_fn = hi_path ++ '/':hi_basename ++ '.':hisuf
-maybePackageModule :: ModuleName -> IO (Maybe (Module, ModuleLocation))
-maybePackageModule mod_name = do
- pkgs <- getPackageInfo
+ -- source filename (extension is always .hs or .lhs)
+ source_fn
+ | path == "." = basename ++ '.':extension
+ | otherwise = path ++ '/':basename ++ '.':extension
- -- hi-suffix for packages depends on the build tag.
- package_hisuf <-
- do tag <- readIORef v_Build_tag
- if null tag
- then return "hi"
- else return (tag ++ "_hi")
+ result = ( mkHomeModule mod_name,
+ ModLocation{ ml_hspp_file = Nothing,
+ ml_hs_file = Just source_fn,
+ ml_hi_file = hi_fn,
+ ml_obj_file = obj_fn,
+ })
+
+ addToFinderCache mod_name result
+ return result
+
+mkObjPath :: String -> FilePath -> IO FilePath
+-- Construct the filename of a .o file from the path/basename
+-- derived either from a .hs file or a .hi file.
+--
+-- Does *not* check whether the .o file exists
+mkObjPath path basename
+ = do odir <- readIORef v_Output_dir
+ osuf <- readIORef v_Object_suf
+ let obj_path | Just d <- odir = d
+ | otherwise = path
+ return (obj_path ++ '/':basename ++ '.':osuf)
+
+
+
+-- -----------------------------------------------------------------------------
+-- findLinkable isn't related to the other stuff in here,
+-- but there' no other obvious place for it
- let mod_str = moduleNameUserString mod_name
- basename = map (\c -> if c == '.' then '/' else c) mod_str
- hi = basename ++ '.':package_hisuf
-
- found <- findOnPackagePath pkgs hi
- case found of
- Nothing -> return Nothing
- Just (pkg_name,path) ->
- return (Just (mkModule mod_name pkg_name,
- ModuleLocation{
- ml_hspp_file = Nothing,
- ml_hs_file = Nothing,
- ml_hi_file = path ++ '/':hi,
- ml_obj_file = Nothing
- }
- ))
-
-findOnPackagePath :: [PackageConfig] -> String
- -> IO (Maybe (PackageName,FilePath))
-findOnPackagePath pkgs file = loop pkgs
- where
- loop [] = return Nothing
- loop (p:ps) = do
- found <- findOnPath (import_dirs p) file
- case found of
- Nothing -> loop ps
- Just path -> return (Just (mkFastString (name p), path ++ '/':file))
-
-findOnPath :: [String] -> String -> IO (Maybe FilePath)
-findOnPath path s = loop path
- where
- loop [] = return Nothing
- loop (d:ds) = do
- let file = d ++ '/':s
- b <- doesFileExist file
- if b then return (Just d) else loop ds
+findLinkable :: ModuleName -> ModLocation -> IO (Maybe Linkable)
+findLinkable mod locn
+ = do let obj_fn = ml_obj_file locn
+ 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]))
\end{code}
projects / ghc-hetmet.git / blobdiff