X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2FbasicTypes%2FModule.lhs;h=4b59757c6a286c560a621611a80518859d2ffed7;hb=2b57ddc3e802a5d93b30a21e198077b016e2e008;hp=9fcf38ce627c21a31329a1ab08cb9976d96d09bf;hpb=5f9909528a61d57609fcb7394be969cef7525e27;p=ghc-hetmet.git diff --git a/ghc/compiler/basicTypes/Module.lhs b/ghc/compiler/basicTypes/Module.lhs index 9fcf38c..4b59757 100644 --- a/ghc/compiler/basicTypes/Module.lhs +++ b/ghc/compiler/basicTypes/Module.lhs @@ -1,62 +1,97 @@ % -% (c) The GRASP/AQUA Project, Glasgow University, 1992-1998 +% (c) The GRASP/AQUA Project, Glasgow University, 1992-2002 % -\section[Module]{The @Module@ module.} -Representing modules and their flavours. +ModuleName +~~~~~~~~~~ +Simply the name of a module, represented as a Z-encoded FastString. +These are Uniquable, hence we can build FiniteMaps with ModuleNames as +the keys. + +Module +~~~~~~ + +A ModuleName with some additional information, namely whether the +module resides in the Home package or in a different package. We need +to know this for two reasons: + + * generating cross-DLL calls is different from intra-DLL calls + (see below). + * we don't record version information in interface files for entities + in a different package. + +The unique of a Module is identical to the unique of a ModuleName, so +it is safe to look up in a Module map using a ModuleName and vice +versa. + +Notes on DLLs +~~~~~~~~~~~~~ +When compiling module A, which imports module B, we need to +know whether B will be in the same DLL as A. + If it's in the same DLL, we refer to B_f_closure + If it isn't, we refer to _imp__B_f_closure +When compiling A, we record in B's Module value whether it's +in a different DLL, by setting the DLL flag. + + + \begin{code} module Module ( - Module -- abstract, instance of Eq, Ord, Outputable + Module, -- Abstract, instance of Eq, Ord, Outputable + + , ModLocation(..), + , showModMsg + , ModuleName + , pprModuleName -- :: ModuleName -> SDoc + , printModulePrefix + , moduleName -- :: Module -> ModuleName , moduleNameString -- :: ModuleName -> EncodedString , moduleNameUserString -- :: ModuleName -> UserString + , moduleNameFS -- :: ModuleName -> EncodedFS - , moduleString -- :: Module -> EncodedString - , moduleUserString -- :: Module -> UserString - , moduleName -- :: Module -> ModuleName - - , mkVanillaModule -- :: ModuleName -> Module - , mkThisModule -- :: ModuleName -> Module - , mkPrelModule -- :: UserString -> Module - - , isDynamicModule -- :: Module -> Bool - , isPrelModule + , moduleString -- :: Module -> EncodedString + , moduleUserString -- :: Module -> UserString - , mkSrcModule + , mkBasePkgModule -- :: UserString -> Module + , mkThPkgModule -- :: UserString -> Module + , mkHomeModule -- :: ModuleName -> Module + , isHomeModule -- :: Module -> Bool + , mkPackageModule -- :: ModuleName -> Module - , mkSrcModuleFS -- :: UserFS -> ModuleName - , mkSysModuleFS -- :: EncodedFS -> ModuleName + , mkModuleName -- :: UserString -> ModuleName + , mkModuleNameFS -- :: UserFS -> ModuleName + , mkSysModuleNameFS -- :: EncodedFS -> ModuleName - , pprModule, pprModuleName + , pprModule, - -- DllFlavour - , DllFlavour, dll, notDll + , ModuleEnv, + , elemModuleEnv, extendModuleEnv, extendModuleEnvList, plusModuleEnv_C + , delModuleEnvList, delModuleEnv, plusModuleEnv, lookupModuleEnv + , lookupWithDefaultModuleEnv, mapModuleEnv, mkModuleEnv, emptyModuleEnv + , moduleEnvElts, unitModuleEnv, isEmptyModuleEnv, foldModuleEnv + , extendModuleEnv_C + , lookupModuleEnvByName, extendModuleEnvByName, unitModuleEnvByName - -- ModFlavour - , ModFlavour, - - -- Where to find a .hi file - , WhereFrom(..), SearchPath, mkSearchPath - , ModuleHiMap, mkModuleHiMaps + , ModuleSet, emptyModuleSet, mkModuleSet, moduleSetElts, extendModuleSet, elemModuleSet ) where #include "HsVersions.h" import OccName import Outputable -import FiniteMap -import CmdLineOpts ( opt_Static, opt_CompilingPrelude, opt_WarnHiShadows, opt_HiMapSep ) -import Constants ( interfaceFileFormatVersion ) -import Maybes ( seqMaybe ) -import Maybe ( fromMaybe ) -import Directory ( doesFileExist ) -import DirUtils ( getDirectoryContents ) -import List ( intersperse ) -import Monad ( foldM ) -import IO ( hPutStrLn, stderr, isDoesNotExistError ) +import Packages ( PackageName, basePackage, thPackage ) +import CmdLineOpts ( opt_InPackage ) +import FastString ( FastString ) +import Unique ( Uniquable(..) ) +import Maybes ( expectJust ) +import UniqFM +import UniqSet +import Binary +import FastString \end{code} @@ -66,72 +101,84 @@ import IO ( hPutStrLn, stderr, isDoesNotExistError ) %* * %************************************************************************ -A further twist to the tale is the support for dynamically linked libraries under -Win32. Here, dealing with the use of global variables that's residing in a DLL -requires special handling at the point of use (there's an extra level of indirection, -i.e., (**v) to get at v's value, rather than just (*v) .) When slurping in an -interface file we then record whether it's coming from a .hi corresponding to a -module that's packaged up in a DLL or not, so that we later can emit the +A further twist to the tale is the support for dynamically linked +libraries under Win32. Here, dealing with the use of global variables +that's residing in a DLL requires special handling at the point of use +(there's an extra level of indirection, i.e., (**v) to get at v's +value, rather than just (*v) .) When slurping in an interface file we +then record whether it's coming from a .hi corresponding to a module +that's packaged up in a DLL or not, so that we later can emit the appropriate code. -The logic for how an interface file is marked as corresponding to a module that's -hiding in a DLL is explained elsewhere (ToDo: give renamer href here.) +The logic for how an interface file is marked as corresponding to a +module that's hiding in a DLL is explained elsewhere (ToDo: give +renamer href here.) \begin{code} -data DllFlavour = NotDll -- Ordinary module - | Dll -- The module's object code lives in a DLL. - deriving( Eq ) +data Module = Module ModuleName !PackageInfo + +data PackageInfo + = ThisPackage -- A module from the same package + -- as the one being compiled + | AnotherPackage -- A module from a different package -dll = Dll -notDll = NotDll +packageInfoPackage :: PackageInfo -> PackageName +packageInfoPackage ThisPackage = opt_InPackage +packageInfoPackage AnotherPackage = FSLIT("") -instance Text DllFlavour where -- Just used in debug prints of lex tokens - showsPrec n NotDll s = s - showsPrec n Dll s = "dll " ++ s +instance Outputable PackageInfo where + -- Just used in debug prints of lex tokens and in debug modde + ppr pkg_info = ppr (packageInfoPackage pkg_info) \end{code} %************************************************************************ %* * -\subsection{System/user module} +\subsection{Module locations} %* * %************************************************************************ -We also track whether an imported module is from a 'system-ish' place. In this case -we don't record the fact that this module depends on it, nor usages of things -inside it. - -Apr 00: We want to record dependencies on all modules other than -prelude modules else STG Hugs gets confused because it uses this -info to know what modules to link. (Compiled GHC uses command line -options to specify this.) - \begin{code} -data ModFlavour = PrelMod -- A Prelude module - | UserMod -- Not library-ish +data ModLocation + = ModLocation { + ml_hs_file :: Maybe FilePath, + + ml_hspp_file :: Maybe FilePath, -- Path of preprocessed source + + ml_hi_file :: FilePath, -- Where the .hi file is, whether or not it exists + -- Always of form foo.hi, even if there is an hi-boot + -- file (we add the -boot suffix later) + + ml_obj_file :: FilePath -- Where the .o file is, whether or not it exists + -- (might not exist either because the module + -- hasn't been compiled yet, or because + -- it is part of a package with a .a file) + } + deriving Show + +instance Outputable ModLocation where + ppr = text . show + +-- Rather a gruesome function to have in Module + +showModMsg :: Bool -> Module -> ModLocation -> String +showModMsg use_object mod location = + mod_str ++ replicate (max 0 (16 - length mod_str)) ' ' + ++" ( " ++ expectJust "showModMsg" (ml_hs_file location) ++ ", " + ++ (if use_object + then ml_obj_file location + else "interpreted") + ++ " )" + where mod_str = moduleUserString mod \end{code} +For a module in another package, the hs_file and obj_file +components of ModLocation are undefined. -%************************************************************************ -%* * -\subsection{Where from} -%* * -%************************************************************************ - -The @WhereFrom@ type controls where the renamer looks for an interface file - -\begin{code} -data WhereFrom = ImportByUser -- Ordinary user import: look for M.hi - | ImportByUserSource -- User {- SOURCE -}: look for M.hi-boot - | ImportBySystem -- Non user import. Look for M.hi if M is in - -- the module this module depends on, or is a system-ish module; - -- M.hi-boot otherwise - -instance Outputable WhereFrom where - ppr ImportByUser = empty - ppr ImportByUserSource = ptext SLIT("{- SOURCE -}") - ppr ImportBySystem = ptext SLIT("{- SYSTEM IMPORT -}") -\end{code} +The locations specified by a ModLocation may or may not +correspond to actual files yet: for example, even if the object +file doesn't exist, the ModLocation still contains the path to +where the object file will reside if/when it is created. %************************************************************************ @@ -141,275 +188,201 @@ instance Outputable WhereFrom where %************************************************************************ \begin{code} -type ModuleName = EncodedFS +newtype ModuleName = ModuleName EncodedFS -- Haskell module names can include the quote character ', -- so the module names have the z-encoding applied to them -isPrelModuleName :: ModuleName -> Bool - -- True for names of prelude modules -isPrelModuleName m = take 4 (_UNPK_ m) == "Prel" +instance Binary ModuleName where + put_ bh (ModuleName m) = put_ bh m + get bh = do m <- get bh; return (ModuleName m) + +instance Uniquable ModuleName where + getUnique (ModuleName nm) = getUnique nm + +instance Eq ModuleName where + nm1 == nm2 = getUnique nm1 == getUnique nm2 + +-- Warning: gives an ordering relation based on the uniques of the +-- FastStrings which are the (encoded) module names. This is _not_ +-- a lexicographical ordering. +instance Ord ModuleName where + nm1 `compare` nm2 = getUnique nm1 `compare` getUnique nm2 + +instance Outputable ModuleName where + ppr = pprModuleName + pprModuleName :: ModuleName -> SDoc -pprModuleName nm = pprEncodedFS nm +pprModuleName (ModuleName nm) = pprEncodedFS nm + +moduleNameFS :: ModuleName -> EncodedFS +moduleNameFS (ModuleName mod) = mod moduleNameString :: ModuleName -> EncodedString -moduleNameString mod = _UNPK_ mod +moduleNameString (ModuleName mod) = unpackFS mod moduleNameUserString :: ModuleName -> UserString -moduleNameUserString mod = decode (_UNPK_ mod) +moduleNameUserString (ModuleName mod) = decode (unpackFS mod) -mkSrcModule :: UserString -> ModuleName -mkSrcModule s = _PK_ (encode s) +-- used to be called mkSrcModule +mkModuleName :: UserString -> ModuleName +mkModuleName s = ModuleName (mkFastString (encode s)) -mkSrcModuleFS :: UserFS -> ModuleName -mkSrcModuleFS s = encodeFS s +-- used to be called mkSrcModuleFS +mkModuleNameFS :: UserFS -> ModuleName +mkModuleNameFS s = ModuleName (encodeFS s) -mkSysModuleFS :: EncodedFS -> ModuleName -mkSysModuleFS s = s -\end{code} - -\begin{code} -data Module = Module - ModuleName - ModFlavour - DllFlavour +-- used to be called mkSysModuleFS +mkSysModuleNameFS :: EncodedFS -> ModuleName +mkSysModuleNameFS s = ModuleName s \end{code} \begin{code} instance Outputable Module where ppr = pprModule +instance Uniquable Module where + getUnique (Module nm _) = getUnique nm + +-- Same if they have the same name. instance Eq Module where - (Module m1 _ _) == (Module m2 _ _) = m1 == m2 + m1 == m2 = getUnique m1 == getUnique m2 +-- Warning: gives an ordering relation based on the uniques of the +-- FastStrings which are the (encoded) module names. This is _not_ +-- a lexicographical ordering. instance Ord Module where - (Module m1 _ _) `compare` (Module m2 _ _) = m1 `compare` m2 + m1 `compare` m2 = getUnique m1 `compare` getUnique m2 \end{code} \begin{code} pprModule :: Module -> SDoc -pprModule (Module mod _ _) = getPprStyle $ \ sty -> - if userStyle sty then - text (moduleNameUserString mod) - else +pprModule (Module mod p) = getPprStyle $ \ sty -> + if debugStyle sty then + -- Print the package too + -- Don't use '.' because it gets confused + -- with module names + brackets (ppr p) <> pprModuleName mod + else pprModuleName mod \end{code} \begin{code} -mkModule :: FilePath -- Directory in which this module is - -> ModuleName -- Name of the module - -> DllFlavour - -> Module -mkModule dir_path mod_nm is_dll - | isPrelModuleName mod_nm = mkPrelModule mod_nm - | otherwise = Module mod_nm UserMod is_dll - -- Make every module into a 'user module' - -- except those constructed by mkPrelModule - - -mkVanillaModule :: ModuleName -> Module -mkVanillaModule name = Module name UserMod dell - where - main_mod = mkSrcModuleFS SLIT("Main") - - -- Main can never be in a DLL - need this - -- special case in order to correctly - -- compile PrelMain - dell | opt_Static || opt_CompilingPrelude || - name == main_mod = NotDll - | otherwise = Dll - - -mkThisModule :: ModuleName -> Module -- The module being comiled -mkThisModule name = - Module name UserMod NotDll -- This is fine, a Dll flag is only - -- pinned on imported modules. - -mkPrelModule :: ModuleName -> Module -mkPrelModule name = Module name sys dll - where - sys | opt_CompilingPrelude = UserMod - | otherwise = PrelMod - - dll | opt_Static || opt_CompilingPrelude = NotDll - | otherwise = Dll +mkBasePkgModule :: ModuleName -> Module +mkBasePkgModule mod_nm + = Module mod_nm pack_info + where + pack_info + | opt_InPackage == basePackage = ThisPackage + | otherwise = AnotherPackage + +mkThPkgModule :: ModuleName -> Module +mkThPkgModule mod_nm + = Module mod_nm pack_info + where + pack_info + | opt_InPackage == thPackage = ThisPackage + | otherwise = AnotherPackage + +mkHomeModule :: ModuleName -> Module +mkHomeModule mod_nm = Module mod_nm ThisPackage + +isHomeModule :: Module -> Bool +isHomeModule (Module nm ThisPackage) = True +isHomeModule _ = False + +mkPackageModule :: ModuleName -> Module +mkPackageModule mod_nm = Module mod_nm AnotherPackage moduleString :: Module -> EncodedString -moduleString (Module mod _ _) = _UNPK_ mod +moduleString (Module (ModuleName fs) _) = unpackFS fs moduleName :: Module -> ModuleName -moduleName (Module mod _ _) = mod +moduleName (Module mod pkg_info) = mod moduleUserString :: Module -> UserString -moduleUserString (Module mod _ _) = moduleNameUserString mod -\end{code} +moduleUserString (Module mod _) = moduleNameUserString mod -\begin{code} -isDynamicModule :: Module -> Bool -isDynamicModule (Module _ _ Dll) = True -isDynamicModule _ = False - -isPrelModule :: Module -> Bool -isPrelModule (Module _ PrelMod _) = True -isPrelModule _ = False +printModulePrefix :: Module -> Bool + -- When printing, say M.x +printModulePrefix (Module nm ThisPackage) = False +printModulePrefix _ = True \end{code} %************************************************************************ -%* * -\subsection{Finding modules in the file system -%* * +%* * +\subsection{@ModuleEnv@s} +%* * %************************************************************************ \begin{code} -type ModuleHiMap = FiniteMap ModuleName (String, Module) - -- Mapping from module name to - -- * the file path of its corresponding interface file, - -- * the Module, decorated with it's properties +type ModuleEnv elt = UniqFM elt +-- A ModuleName and Module have the same Unique, +-- so both will work as keys. +-- The 'ByName' variants work on ModuleNames + +emptyModuleEnv :: ModuleEnv a +mkModuleEnv :: [(Module, a)] -> ModuleEnv a +unitModuleEnv :: Module -> a -> ModuleEnv a +extendModuleEnv :: ModuleEnv a -> Module -> a -> ModuleEnv a +extendModuleEnv_C :: (a->a->a) -> ModuleEnv a -> Module -> a -> ModuleEnv a +plusModuleEnv :: ModuleEnv a -> ModuleEnv a -> ModuleEnv a +extendModuleEnvList :: ModuleEnv a -> [(Module, a)] -> ModuleEnv a + +delModuleEnvList :: ModuleEnv a -> [Module] -> ModuleEnv a +delModuleEnv :: ModuleEnv a -> Module -> ModuleEnv a +plusModuleEnv_C :: (a -> a -> a) -> ModuleEnv a -> ModuleEnv a -> ModuleEnv a +mapModuleEnv :: (a -> b) -> ModuleEnv a -> ModuleEnv b +moduleEnvElts :: ModuleEnv a -> [a] + +isEmptyModuleEnv :: ModuleEnv a -> Bool +lookupModuleEnv :: ModuleEnv a -> Module -> Maybe a +lookupWithDefaultModuleEnv :: ModuleEnv a -> a -> Module -> a +elemModuleEnv :: Module -> ModuleEnv a -> Bool +foldModuleEnv :: (a -> b -> b) -> b -> ModuleEnv a -> b + +-- The ByName variants +lookupModuleEnvByName :: ModuleEnv a -> ModuleName -> Maybe a +unitModuleEnvByName :: ModuleName -> a -> ModuleEnv a +extendModuleEnvByName :: ModuleEnv a -> ModuleName -> a -> ModuleEnv a + +elemModuleEnv = elemUFM +extendModuleEnv = addToUFM +extendModuleEnvByName = addToUFM +extendModuleEnv_C = addToUFM_C +extendModuleEnvList = addListToUFM +plusModuleEnv_C = plusUFM_C +delModuleEnvList = delListFromUFM +delModuleEnv = delFromUFM +plusModuleEnv = plusUFM +lookupModuleEnv = lookupUFM +lookupModuleEnvByName = lookupUFM +lookupWithDefaultModuleEnv = lookupWithDefaultUFM +mapModuleEnv = mapUFM +mkModuleEnv = listToUFM +emptyModuleEnv = emptyUFM +moduleEnvElts = eltsUFM +unitModuleEnv = unitUFM +unitModuleEnvByName = unitUFM +isEmptyModuleEnv = isNullUFM +foldModuleEnv = foldUFM \end{code} -(We allege that) it is quicker to build up a mapping from module names -to the paths to their corresponding interface files once, than to search -along the import part every time we slurp in a new module (which we -do quite a lot of.) - \begin{code} -type SearchPath = [(String,String)] -- List of (directory,suffix) pairs to search - -- for interface files. - -mkModuleHiMaps :: SearchPath -> IO (ModuleHiMap, ModuleHiMap) -mkModuleHiMaps dirs = foldM (getAllFilesMatching dirs) (env,env) dirs - where - env = emptyFM - -{- A pseudo file, currently "dLL_ifs.hi", - signals that the interface files - contained in a particular directory have got their - corresponding object codes stashed away in a DLL - - This stuff is only needed to deal with Win32 DLLs, - and conceivably we conditionally compile in support - for handling it. (ToDo?) --} -dir_contain_dll_his = "dLL_ifs.hi" - -getAllFilesMatching :: SearchPath - -> (ModuleHiMap, ModuleHiMap) - -> (FilePath, String) - -> IO (ModuleHiMap, ModuleHiMap) -getAllFilesMatching dirs hims (dir_path, suffix) = ( do - -- fpaths entries do not have dir_path prepended - fpaths <- getDirectoryContents dir_path - is_dll <- catch - (if opt_Static || dir_path == "." then - return NotDll - else - do exists <- doesFileExist (dir_path ++ '/': dir_contain_dll_his) - return (if exists then Dll else NotDll) - ) - (\ _ {-don't care-} -> return NotDll) - return (foldl (addModules is_dll) hims fpaths)) - -- soft failure - `catch` - (\ err -> do - hPutStrLn stderr - ("Import path element `" ++ dir_path ++ - if (isDoesNotExistError err) then - "' does not exist, ignoring." - else - "' couldn't read, ignoring.") - - return hims - ) - where - xiffus = reverse dotted_suffix - dotted_suffix = case suffix of - [] -> [] - ('.':xs) -> suffix - ls -> '.':ls - - hi_boot_version_xiffus = - reverse (show interfaceFileFormatVersion) ++ '-':hi_boot_xiffus - hi_boot_xiffus = "toob-ih." -- .hi-boot reversed! - - addModules is_dll his@(hi_env, hib_env) filename = fromMaybe his $ - FMAP add_hi (go xiffus rev_fname) `seqMaybe` - - FMAP add_vhib (go hi_boot_version_xiffus rev_fname) `seqMaybe` - -- If there's a Foo.hi-boot-N file then override any Foo.hi-boot - - FMAP add_hib (go hi_boot_xiffus rev_fname) - where - rev_fname = reverse filename - path = dir_path ++ '/':filename - - -- In these functions file_nm is the base of the filename, - -- with the path and suffix both stripped off. The filename - -- is the *unencoded* module name (else 'make' gets confused). - -- But the domain of the HiMaps is ModuleName which is encoded. - add_hi file_nm = (add_to_map addNewOne hi_env file_nm, hib_env) - add_vhib file_nm = (hi_env, add_to_map overrideNew hib_env file_nm) - add_hib file_nm = (hi_env, add_to_map addNewOne hib_env file_nm) - - add_to_map combiner env file_nm - = addToFM_C combiner env mod_nm (path, mkModule dir_path mod_nm is_dll) - where - mod_nm = mkSrcModuleFS file_nm - - -- go prefix (prefix ++ stuff) == Just (reverse stuff) - go [] xs = Just (_PK_ (reverse xs)) - go _ [] = Nothing - go (x:xs) (y:ys) | x == y = go xs ys - | otherwise = Nothing - - addNewOne | opt_WarnHiShadows = conflict - | otherwise = stickWithOld - - stickWithOld old new = old - overrideNew old new = new - - conflict (old_path,mod) (new_path,_) - | old_path /= new_path = - pprTrace "Warning: " (text "Identically named interface files present on the import path, " $$ - text (show old_path) <+> text "shadows" $$ - text (show new_path) $$ - text "on the import path: " <+> - text (concat (intersperse ":" (map fst dirs)))) - (old_path,mod) - | otherwise = (old_path,mod) -- don't warn about innocous shadowings. -\end{code} - -%********************************************************* -%* * -\subsection{Making a search path} -%* * -%********************************************************* - -@mkSearchPath@ takes a string consisting of a colon-separated list -of directories and corresponding suffixes, and turns it into a list -of (directory, suffix) pairs. For example: - -\begin{verbatim} - mkSearchPath "foo%.hi:.%.p_hi:baz%.mc_hi" - = [("foo",".hi"),( ".", ".p_hi"), ("baz",".mc_hi")] -\begin{verbatim} - -\begin{code} -mkSearchPath :: Maybe String -> SearchPath -mkSearchPath Nothing = [(".",".hi")] -- ToDo: default should be to look in - -- the directory the module we're compiling - -- lives. -mkSearchPath (Just s) = go s - where - go "" = [] - go s = - case span (/= '%') s of - (dir,'%':rs) -> - case span (/= opt_HiMapSep) rs of - (hisuf,_:rest) -> (dir,hisuf):go rest - (hisuf,[]) -> [(dir,hisuf)] +type ModuleSet = UniqSet Module +mkModuleSet :: [Module] -> ModuleSet +extendModuleSet :: ModuleSet -> Module -> ModuleSet +emptyModuleSet :: ModuleSet +moduleSetElts :: ModuleSet -> [Module] +elemModuleSet :: Module -> ModuleSet -> Bool + +emptyModuleSet = emptyUniqSet +mkModuleSet = mkUniqSet +extendModuleSet = addOneToUniqSet +moduleSetElts = uniqSetToList +elemModuleSet = elementOfUniqSet \end{code} -