X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FFinder.lhs;h=a260f3e7cae9f170c52cda76943c9ddc411bbe42;hb=cbc7228335a0489362d8f5deadaecacc8731a4ce;hp=348eee641021158ba21f58451dcb56c9deb52a5d;hpb=eedc3d35d08d8542e6e3f5f78138b480281e67b2;p=ghc-hetmet.git diff --git a/ghc/compiler/main/Finder.lhs b/ghc/compiler/main/Finder.lhs index 348eee6..a260f3e 100644 --- a/ghc/compiler/main/Finder.lhs +++ b/ghc/compiler/main/Finder.lhs @@ -5,77 +5,78 @@ \begin{code} module Finder ( - initFinder, -- :: [PackageConfig] -> IO (), flushFinderCache, -- :: IO () - - findModule, -- :: ModuleName -> IO (Maybe (Module, ModLocation)) - findPackageModule, -- :: ModuleName -> IO (Maybe (Module, ModLocation)) - - mkHomeModLocation, -- :: ModuleName -> String -> FilePath - -- -> IO ModLocation + FindResult(..), + findModule, -- :: ModuleName -> Bool -> IO FindResult + findPackageModule, -- :: ModuleName -> Bool -> IO FindResult + mkHomeModLocation, -- :: ModuleName -> FilePath -> IO ModLocation + mkHomeModLocation2, -- :: ModuleName -> FilePath -> String -> IO ModLocation + addHomeModuleToFinder, -- :: Module -> ModLocation -> IO () findLinkable, -- :: ModuleName -> ModLocation -> IO (Maybe Linkable) - hiBootExt, -- :: String - hiBootVerExt, -- :: String - + cantFindError, -- :: DynFlags -> Module -> FindResult -> SDoc ) where #include "HsVersions.h" import Module import UniqFM ( filterUFM ) -import Packages ( PackageConfig(..) ) import HscTypes ( Linkable(..), Unlinked(..) ) +import Packages import DriverState -import DriverUtil ( split_longest_prefix, splitFilename3 ) +import DriverUtil import FastString -import Config import Util +import CmdLineOpts ( DynFlags(..) ) +import Outputable import DATA_IOREF ( IORef, writeIORef, readIORef ) -import List -import Directory -import IO -import Monad +import Data.List +import System.Directory +import System.IO +import Control.Monad +import Maybes ( MaybeErr(..) ) +import Data.Maybe ( isNothing ) + + +type FileExt = String -- Filename extension +type BaseName = String -- Basename of file -- ----------------------------------------------------------------------------- -- The Finder --- 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 provides a thin filesystem abstraction to the rest of +-- the compiler. For a given module, it can tell you where the +-- source, interface, and object files for that module live. -- --- It does *not* know which particular package a module lives in, because --- that information is only contained in the interface file. - -initFinder :: [PackageConfig] -> IO () -initFinder pkgs = return () +-- It does *not* know which particular package a module lives in. Use +-- Packages.moduleToPackageConfig for that. -- ----------------------------------------------------------------------------- -- The finder's cache -GLOBAL_VAR(finder_cache, emptyModuleEnv, ModuleEnv (Module,ModLocation)) +GLOBAL_VAR(finder_cache, emptyModuleEnv, ModuleEnv FinderCacheEntry) + +type FinderCacheEntry = (ModLocation, Maybe (PackageConfig,Bool)) -- 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) + writeIORef finder_cache (filterUFM (\(loc,m) -> isNothing m) fm) -addToFinderCache :: ModuleName -> (Module,ModLocation) -> IO () -addToFinderCache mod_name stuff = do +addToFinderCache :: Module -> FinderCacheEntry -> IO () +addToFinderCache mod_name entry = do fm <- readIORef finder_cache - writeIORef finder_cache (extendModuleEnvByName fm mod_name stuff) + writeIORef finder_cache (extendModuleEnv fm mod_name entry) -lookupFinderCache :: ModuleName -> IO (Maybe (Module,ModLocation)) +lookupFinderCache :: Module -> IO (Maybe FinderCacheEntry) lookupFinderCache mod_name = do fm <- readIORef finder_cache - return $! lookupModuleEnvByName fm mod_name + return $! lookupModuleEnv fm mod_name -- ----------------------------------------------------------------------------- -- Locating modules @@ -90,237 +91,311 @@ lookupFinderCache mod_name = do -- 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, 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 - -findPackageModule :: ModuleName -> IO (Maybe (Module, ModLocation)) -findPackageModule name = do - r <- lookupFinderCache name - case r of - Just result -> return (Just result) - Nothing -> findPackageMod name - -hiBootExt = "hi-boot" -hiBootVerExt = "hi-boot-" ++ cHscIfaceFileVersion - -maybeHomeModule :: ModuleName -> IO (Maybe (Module, ModLocation)) -maybeHomeModule mod_name = do - home_path <- readIORef v_Import_paths +data FindResult + = Found ModLocation PackageIdH + -- the module was found + | PackageHidden PackageId + -- for an explicit source import: the package containing the module is + -- not exposed. + | ModuleHidden PackageId + -- for an explicit source import: the package containing the module is + -- exposed, but the module itself is hidden. + | NotFound [FilePath] + -- the module was not found, the specified places were searched. + +type LocalFindResult = MaybeErr [FilePath] FinderCacheEntry + -- LocalFindResult is used for internal functions which + -- return a more informative type; it's munged into + -- the external FindResult by 'cached' + +cached :: Bool + -> (DynFlags -> Module -> IO LocalFindResult) + -> DynFlags -> Module -> Bool -> IO FindResult +cached home_allowed wrapped_fn dflags name explicit + = do { -- First try the cache + mb_entry <- lookupFinderCache name + ; case mb_entry of { + Just old_entry -> return (found old_entry) ; + Nothing -> do + + { -- Now try the wrapped function + mb_entry <- wrapped_fn dflags name + ; case mb_entry of + Failed paths -> return (NotFound paths) + Succeeded new_entry -> do { addToFinderCache name new_entry + ; return (found new_entry) } + }}} + where + -- We've found the module, so the remaining question is + -- whether it's visible or not + found :: FinderCacheEntry -> FindResult + found (loc, Nothing) + | home_allowed = Found loc HomePackage + | otherwise = NotFound [] + found (loc, Just (pkg, exposed_mod)) + | explicit && not exposed_mod = ModuleHidden pkg_name + | explicit && not (exposed pkg) = PackageHidden pkg_name + | otherwise = Found loc (ExtPackage (mkPackageId (package pkg))) + where + pkg_name = packageConfigId pkg + +addHomeModuleToFinder :: Module -> ModLocation -> IO () +addHomeModuleToFinder mod loc = addToFinderCache mod (loc, Nothing) + + +-- ----------------------------------------------------------------------------- +-- The two external entry points + + +findModule :: DynFlags -> Module -> Bool -> IO FindResult +findModule = cached True findModule' + +findPackageModule :: DynFlags -> Module -> Bool -> IO FindResult +findPackageModule = cached False findPackageModule' + +-- ----------------------------------------------------------------------------- +-- The internal workers + +findModule' :: DynFlags -> Module -> IO LocalFindResult +-- Find home or package module +findModule' dflags name = do + r <- findPackageModule' dflags name + case r of + Failed pkg_files -> do + j <- findHomeModule' dflags name + case j of + Failed home_files -> + return (Failed (home_files ++ pkg_files)) + other_result + -> return other_result + other_result + -> return other_result + +findHomeModule' :: DynFlags -> Module -> IO LocalFindResult +findHomeModule' dflags mod = do + let home_path = importPaths dflags hisuf <- readIORef v_Hi_suf mode <- readIORef v_GhcMode let source_exts = - [ ("hs", mkHomeModLocation mod_name False) - , ("lhs", mkHomeModLocation mod_name False) + [ ("hs", mkHomeModLocationSearched mod "hs") + , ("lhs", mkHomeModLocationSearched mod "lhs") ] - hi_exts = [ (hisuf, mkHiOnlyModLocation hisuf mod_name) ] - - boot_exts = - [ (hiBootVerExt, mkHiOnlyModLocation hisuf mod_name) - , (hiBootExt, mkHiOnlyModLocation hisuf mod_name) - ] + hi_exts = [ (hisuf, mkHiOnlyModLocation hisuf) + , (addBootSuffix hisuf, mkHiOnlyModLocation hisuf) + ] -- 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 + | DoMkDependHS <- mode = source_exts | isCompManagerMode mode = source_exts - | otherwise {-one-shot-} = hi_exts ++ boot_exts + | otherwise {-one-shot-} = hi_exts - searchPathExts home_path mod_name exts + searchPathExts home_path mod exts --- ----------------------------------------------------------------------------- --- Looking for a package module - -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 <- - do tag <- readIORef v_Build_tag - if null tag - then return "hi" - else return (tag ++ "_hi") - +findPackageModule' :: DynFlags -> Module -> IO LocalFindResult +findPackageModule' dflags mod + = case moduleToPackageConfig dflags mod of + Nothing -> return (Failed []) + Just pkg_info -> findPackageIface mod pkg_info + +findPackageIface :: Module -> (PackageConfig,Bool) -> IO LocalFindResult +findPackageIface mod pkg_info@(pkg_conf, _) = do + mode <- readIORef v_GhcMode + tag <- readIORef v_Build_tag let + -- hi-suffix for packages depends on the build tag. + package_hisuf | null tag = "hi" + | otherwise = tag ++ "_hi" hi_exts = - [ (package_hisuf, mkPackageModLocation package_hisuf mod_name) ] + [ (package_hisuf, + mkPackageModLocation pkg_info package_hisuf) ] source_exts = - [ ("hs", mkPackageModLocation package_hisuf mod_name) - , ("lhs", mkPackageModLocation package_hisuf mod_name) + [ ("hs", mkPackageModLocation pkg_info package_hisuf) + , ("lhs", mkPackageModLocation pkg_info package_hisuf) ] - + -- 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 - + | DoMkDependHS <- mode = 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 + + searchPathExts (importDirs pkg_conf) mod exts -- ----------------------------------------------------------------------------- -- General path searching searchPathExts :: [FilePath] -- paths to search - -> ModuleName -- module name + -> Module -- module name -> [ ( - String, -- suffix - String -> String -> String -> IO (Module, ModLocation) -- action + FileExt, -- suffix + FilePath -> BaseName -> IO FinderCacheEntry -- action ) ] - -> IO (Maybe (Module, ModLocation)) + -> IO LocalFindResult + +searchPathExts paths mod exts + = do result <- search to_search +{- + hPutStrLn stderr (showSDoc $ + vcat [text "Search" <+> ppr mod <+> sep (map (text. fst) exts) + , nest 2 (vcat (map text paths)) + , case result of + Succeeded (loc, p) -> text "Found" <+> ppr loc + Failed fs -> text "not found"]) +-} + return result -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 - base | p == "." = basename - | otherwise = p ++ '/':basename - - loop [] = search ps - loop ((ext,fn):exts) = do - let file = base ++ '.':ext - b <- doesFileExist file - 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 - } + basename = dots_to_slashes (moduleUserString mod) + + to_search :: [(FilePath, IO FinderCacheEntry)] + to_search = [ (file, fn path basename) + | path <- paths, + (ext,fn) <- exts, + let base | path == "." = basename + | otherwise = path ++ '/':basename + file = base ++ '.':ext + ] + + search [] = return (Failed (map fst to_search)) + search ((file, mk_result) : rest) = do + b <- doesFileExist file + if b + then do { res <- mk_result; return (Succeeded res) } + else search rest + +mkHomeModLocationSearched :: Module -> FileExt + -> FilePath -> BaseName -> IO FinderCacheEntry +mkHomeModLocationSearched mod suff path basename = do + loc <- mkHomeModLocation2 mod (path ++ '/':basename) suff + return (loc, Nothing) + +mkHiOnlyModLocation :: FileExt -> FilePath -> BaseName -> IO FinderCacheEntry +mkHiOnlyModLocation hisuf path basename = do + loc <- hiOnlyModLocation path basename hisuf + return (loc, Nothing) + +mkPackageModLocation :: (PackageConfig, Bool) -> FileExt + -> FilePath -> BaseName -> IO FinderCacheEntry +mkPackageModLocation pkg_info hisuf path basename = do + loc <- hiOnlyModLocation path basename hisuf + return (loc, Just pkg_info) -- ----------------------------------------------------------------------------- -- 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 +-- This is where we construct the ModLocation for a module in the home +-- package, for which we have a source file. It is called from three +-- places: -- --- path: "/P/Q/R" --- basename: "A/B/C" --- extension: "hs" +-- (a) Here in the finder, when we are searching for a module to import, +-- using the search path (-i option). -- --- 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. +-- (b) The compilation manager, when constructing the ModLocation for +-- a "root" module (a source file named explicitly on the command line +-- or in a :load command in GHCi). -- --- 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 +-- (c) The driver in one-shot mode, when we need to construct a +-- ModLocation for a source file named on the command-line. -- --- 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, - }) +-- Parameters are: +-- +-- mod +-- The name of the module +-- +-- path +-- (a): The search path component where the source file was found. +-- (b) and (c): "." +-- +-- src_basename +-- (a): dots_to_slashes (moduleNameUserString mod) +-- (b) and (c): The filename of the source file, minus its extension +-- +-- ext +-- The filename extension of the source file (usually "hs" or "lhs"). + +mkHomeModLocation :: Module -> FilePath -> IO ModLocation +mkHomeModLocation mod src_filename = do + let (basename,extension) = splitFilename src_filename + mkHomeModLocation2 mod basename extension + +mkHomeModLocation2 :: Module + -> FilePath -- Of source module, without suffix + -> String -- Suffix + -> IO ModLocation +mkHomeModLocation2 mod src_basename ext = do + let mod_basename = dots_to_slashes (moduleUserString mod) + + obj_fn <- mkObjPath src_basename mod_basename + hi_fn <- mkHiPath src_basename mod_basename + + return (ModLocation{ ml_hs_file = Just (src_basename ++ '.':ext), + ml_hi_file = hi_fn, + ml_obj_file = obj_fn }) + +hiOnlyModLocation :: FilePath -> String -> Suffix -> IO ModLocation +hiOnlyModLocation path basename hisuf + = do let full_basename = path++'/':basename + obj_fn <- mkObjPath full_basename basename + return ModLocation{ ml_hs_file = Nothing, + ml_hi_file = full_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 + } + +-- | Constructs the filename of a .o file for a given source file. +-- Does /not/ check whether the .o file exists +mkObjPath + :: FilePath -- the filename of the source file, minus the extension + -> String -- the module name with dots replaced by slashes + -> IO FilePath +mkObjPath basename mod_basename + = do odir <- readIORef v_Output_dir + osuf <- readIORef v_Object_suf + + let obj_basename | Just dir <- odir = dir ++ '/':mod_basename + | otherwise = basename + + return (obj_basename ++ '.':osuf) + +-- | Constructs the filename of a .hi file for a given source file. +-- Does /not/ check whether the .hi file exists +mkHiPath + :: FilePath -- the filename of the source file, minus the extension + -> String -- the module name with dots replaced by slashes + -> IO FilePath +mkHiPath basename mod_basename + = do hidir <- readIORef v_Hi_dir + hisuf <- readIORef v_Hi_suf + + let hi_basename | Just dir <- hidir = dir ++ '/':mod_basename + | otherwise = basename + + return (hi_basename ++ '.':hisuf) - addToFinderCache mod_name result - return result -- ----------------------------------------------------------------------------- -- findLinkable isn't related to the other stuff in here, --- but there' no other obvious place for it +-- but there's no other obvious place for it -findLinkable :: ModuleName -> ModLocation -> IO (Maybe Linkable) +findLinkable :: Module -> ModLocation -> IO (Maybe Linkable) findLinkable mod locn - | Just obj_fn <- ml_obj_file locn - = do obj_exist <- doesFileExist obj_fn + = do let obj_fn = ml_obj_file locn + obj_exist <- doesFileExist obj_fn if not obj_exist then return Nothing else @@ -331,6 +406,39 @@ findLinkable mod locn 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 + +-- ----------------------------------------------------------------------------- +-- Utils + +dots_to_slashes = map (\c -> if c == '.' then '/' else c) + + +-- ----------------------------------------------------------------------------- +-- Error messages + +cantFindError :: DynFlags -> Module -> FindResult -> SDoc +cantFindError dflags mod_name find_result + = hang (ptext SLIT("Could not find module") <+> quotes (ppr mod_name) <> colon) + 2 more_info + where + more_info + = case find_result of + PackageHidden pkg + -> ptext SLIT("it is a member of package") <+> ppr pkg <> comma + <+> ptext SLIT("which is hidden") + + ModuleHidden pkg + -> ptext SLIT("it is hidden") <+> parens (ptext SLIT("in package") + <+> ppr pkg) + + NotFound files + | null files + -> ptext SLIT("it is not a module in the current program, or in any known package.") + | verbosity dflags < 3 + -> ptext SLIT("use -v to see a list of the files searched for") + | otherwise + -> hang (ptext SLIT("locations searched:")) + 2 (vcat (map text files)) + + Found _ _ -> panic "cantFindErr" \end{code}