X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fghci%2FLinker.lhs;h=0849859bae8ad5aa5405a64856f20fe608ae3a06;hb=423d477bfecd490de1449c59325c8776f91d7aac;hp=f7e0c80edad20862b2c6b08f174c6d8552233571;hpb=b918acdbbfc645337de1fed4a6e6b39d674c6223;p=ghc-hetmet.git diff --git a/ghc/compiler/ghci/Linker.lhs b/ghc/compiler/ghci/Linker.lhs index f7e0c80..0849859 100644 --- a/ghc/compiler/ghci/Linker.lhs +++ b/ghc/compiler/ghci/Linker.lhs @@ -13,44 +13,40 @@ necessary. \begin{code} -{-# OPTIONS -optc-DNON_POSIX_SOURCE #-} +{-# OPTIONS -optc-DNON_POSIX_SOURCE -#include "Linker.h" #-} -module Linker ( HValue, initLinker, showLinkerState, - linkLibraries, linkExpr, - unload, extendLinkEnv, - LibrarySpec(..) +module Linker ( HValue, showLinkerState, + linkExpr, unload, extendLinkEnv, + linkPackages, ) where -#include "../includes/config.h" +#include "../includes/ghcconfig.h" #include "HsVersions.h" -import ObjLink ( loadDLL, loadObj, unloadObj, resolveObjs, initLinker ) +import ObjLink ( loadDLL, loadObj, unloadObj, resolveObjs, initObjLinker ) import ByteCodeLink ( HValue, ClosureEnv, extendClosureEnv, linkBCO ) import ByteCodeItbls ( ItblEnv ) -import ByteCodeAsm ( CompiledByteCode(..), bcosFreeNames, - UnlinkedBCO, UnlinkedBCOExpr, nameOfUnlinkedBCO ) +import ByteCodeAsm ( CompiledByteCode(..), bcoFreeNames, UnlinkedBCO(..)) -import Packages ( PackageConfig(..), PackageName, PackageConfigMap, lookupPkg, - packageDependents, packageNameString ) -import DriverState ( v_Library_paths, v_Cmdline_libraries, getPackageConfigMap ) +import Packages +import DriverState ( v_Library_paths, v_Opt_l, v_Ld_inputs, getStaticOpts, v_ExplicitPackages ) +import DriverPhases ( isObjectFilename, isDynLibFilename ) +import DriverUtil ( getFileSuffix ) +#ifdef darwin_TARGET_OS +import DriverState ( v_Cmdline_frameworks, v_Framework_paths ) +#endif import Finder ( findModule, findLinkable ) -import HscTypes ( Linkable(..), isObjectLinkable, nameOfObject, byteCodeOfObject, - Unlinked(..), isInterpretable, isObject, Dependencies(..), - HscEnv(..), PersistentCompilerState(..), ExternalPackageState(..), - HomePackageTable, PackageIfaceTable, ModIface(..), HomeModInfo(..), - lookupIface ) -import Name ( Name, nameModule, isExternalName ) +import HscTypes +import Name ( Name, nameModule, nameModuleName, isExternalName, isWiredInName ) import NameEnv import NameSet ( nameSetToList ) -import Module ( ModLocation(..), Module, ModuleName, isHomeModule, moduleName, lookupModuleEnvByName ) -import FastString ( FastString(..), unpackFS ) +import Module import ListSetOps ( minusList ) -import CmdLineOpts ( DynFlags(verbosity) ) +import CmdLineOpts ( DynFlags(verbosity), getDynFlags ) import BasicTypes ( SuccessFlag(..), succeeded, failed ) import Outputable import Panic ( GhcException(..) ) import Util ( zipLazy, global ) -import ErrUtils ( Message ) -- Standard libraries import Control.Monad ( when, filterM, foldM ) @@ -59,7 +55,7 @@ import Data.IORef ( IORef, readIORef, writeIORef ) import Data.List ( partition, nub ) import System.IO ( putStr, putStrLn, hPutStrLn, stderr, fixIO ) -import System.Directory ( doesFileExist, getModificationTime ) +import System.Directory ( doesFileExist ) import Control.Exception ( block, throwDyn ) @@ -85,7 +81,8 @@ The PersistentLinkerState maps Names to actual closures (for interpreted code only), for use during linking. \begin{code} -GLOBAL_VAR(v_PersistentLinkerState, emptyPLS, PersistentLinkerState) +GLOBAL_VAR(v_PersistentLinkerState, panic "Dynamic linker not initialised", PersistentLinkerState) +GLOBAL_VAR(v_InitLinkerDone, False, Bool) -- Set True when dynamic linker is initialised data PersistentLinkerState = PersistentLinkerState { @@ -121,6 +118,9 @@ emptyPLS = PersistentLinkerState { closure_env = emptyNameEnv, -- Packages that don't need loading, because the compiler -- shares them with the interpreted program. +-- +-- The linker's symbol table is populated with RTS symbols using an +-- explicit list. See rts/Linker.c for details. init_pkgs_loaded = [ FSLIT("rts") ] \end{code} @@ -144,7 +144,7 @@ filterNameMap mods env = filterNameEnv keep_elt env where keep_elt (n,_) = isExternalName n - && (moduleName (nameModule n) `elem` mods) + && (nameModuleName n `elem` mods) \end{code} @@ -161,6 +161,142 @@ showLinkerState + +%************************************************************************ +%* * +\subsection{Initialisation} +%* * +%************************************************************************ + +We initialise the dynamic linker by + +a) calling the C initialisation procedure + +b) Loading any packages specified on the command line, + now held in v_ExplicitPackages + +c) Loading any packages specified on the command line, + now held in the -l options in v_Opt_l + +d) Loading any .o/.dll files specified on the command line, + now held in v_Ld_inputs + +e) Loading any MacOS frameworks + +\begin{code} +initDynLinker :: IO () +-- This function is idempotent; if called more than once, it does nothing +-- This is useful in Template Haskell, where we call it before trying to link +initDynLinker + = do { done <- readIORef v_InitLinkerDone + ; if done then return () + else do { writeIORef v_InitLinkerDone True + ; reallyInitDynLinker } + } + +reallyInitDynLinker + = do { dflags <- getDynFlags + + -- Initialise the linker state + ; writeIORef v_PersistentLinkerState emptyPLS + + -- (a) initialise the C dynamic linker + ; initObjLinker + + -- (b) Load packages from the command-line + ; expl <- readIORef v_ExplicitPackages + ; linkPackages dflags expl + + -- (c) Link libraries from the command-line + ; opt_l <- getStaticOpts v_Opt_l + ; let minus_ls = [ lib | '-':'l':lib <- opt_l ] + + -- (d) Link .o files from the command-line + ; lib_paths <- readIORef v_Library_paths + ; cmdline_ld_inputs <- readIORef v_Ld_inputs + + ; classified_ld_inputs <- mapM classifyLdInput cmdline_ld_inputs + + -- (e) Link any MacOS frameworks +#ifdef darwin_TARGET_OS + ; framework_paths <- readIORef v_Framework_paths + ; frameworks <- readIORef v_Cmdline_frameworks +#else + ; let frameworks = [] + ; let framework_paths = [] +#endif + -- Finally do (c),(d),(e) + ; let cmdline_lib_specs = [ l | Just l <- classified_ld_inputs ] + ++ map DLL minus_ls + ++ map Framework frameworks + ; if null cmdline_lib_specs then return () + else do + + { mapM_ (preloadLib dflags lib_paths framework_paths) cmdline_lib_specs + ; maybePutStr dflags "final link ... " + ; ok <- resolveObjs + + ; if succeeded ok then maybePutStrLn dflags "done" + else throwDyn (InstallationError "linking extra libraries/objects failed") + }} + +classifyLdInput :: FilePath -> IO (Maybe LibrarySpec) +classifyLdInput f + | isObjectFilename f = return (Just (Object f)) + | isDynLibFilename f = return (Just (DLLPath f)) + | otherwise = do + hPutStrLn stderr ("Warning: ignoring unrecognised input `" ++ f ++ "'") + return Nothing + +preloadLib :: DynFlags -> [String] -> [String] -> LibrarySpec -> IO () +preloadLib dflags lib_paths framework_paths lib_spec + = do maybePutStr dflags ("Loading object " ++ showLS lib_spec ++ " ... ") + case lib_spec of + Object static_ish + -> do b <- preload_static lib_paths static_ish + maybePutStrLn dflags (if b then "done" + else "not found") + + DLL dll_unadorned + -> do maybe_errstr <- loadDynamic lib_paths dll_unadorned + case maybe_errstr of + Nothing -> maybePutStrLn dflags "done" + Just mm -> preloadFailed mm lib_paths lib_spec + + DLLPath dll_path + -> do maybe_errstr <- loadDLL dll_path + case maybe_errstr of + Nothing -> maybePutStrLn dflags "done" + Just mm -> preloadFailed mm lib_paths lib_spec + +#ifdef darwin_TARGET_OS + Framework framework + -> do maybe_errstr <- loadFramework framework_paths framework + case maybe_errstr of + Nothing -> maybePutStrLn dflags "done" + Just mm -> preloadFailed mm framework_paths lib_spec +#endif + where + preloadFailed :: String -> [String] -> LibrarySpec -> IO () + preloadFailed sys_errmsg paths spec + = do maybePutStr dflags + ("failed.\nDynamic linker error message was:\n " + ++ sys_errmsg ++ "\nWhilst trying to load: " + ++ showLS spec ++ "\nDirectories to search are:\n" + ++ unlines (map (" "++) paths) ) + give_up + + -- Not interested in the paths in the static case. + preload_static paths name + = do b <- doesFileExist name + if not b then return False + else loadObj name >> return True + + give_up = throwDyn $ + CmdLineError "user specified .o/.so/.DLL could not be loaded." +\end{code} + + %************************************************************************ %* * Link a byte-code expression @@ -168,8 +304,7 @@ showLinkerState %************************************************************************ \begin{code} -linkExpr :: HscEnv -> PersistentCompilerState - -> UnlinkedBCOExpr -> IO HValue -- IO BCO# really +linkExpr :: HscEnv -> UnlinkedBCO -> IO HValue -- Link a single expression, *including* first linking packages and -- modules that this expression depends on. @@ -177,14 +312,18 @@ linkExpr :: HscEnv -> PersistentCompilerState -- Raises an IO exception if it can't find a compiled version of the -- dependents to link. -linkExpr hsc_env pcs (root_ul_bco, aux_ul_bcos) +linkExpr hsc_env root_ul_bco = do { + -- Initialise the linker (if it's not been done already) + initDynLinker + -- Find what packages and linkables are required - (lnks, pkgs) <- getLinkDeps hpt pit needed_mods ; + ; eps <- readIORef (hsc_EPS hsc_env) + ; (lnks, pkgs) <- getLinkDeps hpt (eps_PIT eps) needed_mods -- Link the packages and modules required - linkPackages dflags pkgs - ; ok <- linkModules dflags lnks + ; linkPackages dflags pkgs + ; ok <- linkModules dflags lnks ; if failed ok then dieWith empty else do { @@ -195,20 +334,25 @@ linkExpr hsc_env pcs (root_ul_bco, aux_ul_bcos) ce = closure_env pls -- Link the necessary packages and linkables - ; (_, (root_hval:_)) <- linkSomeBCOs False ie ce all_bcos + ; (_, (root_hval:_)) <- linkSomeBCOs False ie ce [root_ul_bco] ; return root_hval }} where - pit = eps_PIT (pcs_EPS pcs) hpt = hsc_HPT hsc_env dflags = hsc_dflags hsc_env - all_bcos = root_ul_bco : aux_ul_bcos - free_names = nameSetToList (bcosFreeNames all_bcos) - + free_names = nameSetToList (bcoFreeNames root_ul_bco) + needed_mods :: [Module] - needed_mods = [ nameModule n | n <- free_names, isExternalName n ] + needed_mods = [ nameModule n | n <- free_names, + isExternalName n, -- Names from other modules + not (isWiredInName n) -- Exclude wired-in names + ] -- (see note below) + -- Exclude wired-in names because we may not have read + -- their interface files, so getLinkDeps will fail + -- All wired-in names are in the base package, which we link + -- by default, so we can safely ignore them here. -dieWith msg = throwDyn (UsageError (showSDoc msg)) +dieWith msg = throwDyn (ProgramError (showSDoc msg)) getLinkDeps :: HomePackageTable -> PackageIfaceTable -> [Module] -- If you need these @@ -231,8 +375,8 @@ getLinkDeps hpt pit mods } ; -- 3. For each dependent module, find its linkable - -- This will either be in the HPT or (in the case of one-shot compilation) - -- we may need to use maybe_getFileLinkable + -- This will either be in the HPT or (in the case of one-shot + -- compilation) we may need to use maybe_getFileLinkable lnks_needed <- mapM get_linkable mods_needed ; return (lnks_needed, pkgs_needed) } @@ -255,7 +399,7 @@ getLinkDeps hpt pit mods no_iface mod = ptext SLIT("No iface for") <+> ppr mod -- This one is a GHC bug - no_obj mod = dieWith (ptext SLIT("No compiled code for for") <+> ppr mod) + no_obj mod = dieWith (ptext SLIT("No compiled code for") <+> ppr mod) -- This one is a build-system bug get_linkable mod_name -- A home-package module @@ -266,8 +410,8 @@ getLinkDeps hpt pit mods -- so use the Finder to get a ModLocation... do { mb_stuff <- findModule mod_name ; case mb_stuff of { - Nothing -> no_obj mod_name ; - Just (_, loc) -> do { + Left _ -> no_obj mod_name ; + Right (_, loc) -> do { -- ...and then find the linkable for it mb_lnk <- findLinkable mod_name loc ; @@ -275,7 +419,7 @@ getLinkDeps hpt pit mods Nothing -> no_obj mod_name ; Just lnk -> return lnk }}}} -\end{code} +\end{code} %************************************************************************ @@ -324,9 +468,6 @@ findModuleLinkable_maybe lis mod [li] -> Just li many -> pprPanic "findModuleLinkable" (ppr mod) -filterModuleLinkables :: (ModuleName -> Bool) -> [Linkable] -> [Linkable] -filterModuleLinkables p ls = filter (p . linkableModName) ls - linkableInSet :: Linkable -> [Linkable] -> Bool linkableInSet l objs_loaded = case findModuleLinkable_maybe objs_loaded (linkableModName l) of @@ -382,66 +523,6 @@ rmDupLinkables already ls | otherwise = go (l:already) (l:extras) ls \end{code} - -\begin{code} -linkLibraries :: DynFlags - -> [String] -- foo.o files specified on command line - -> IO () --- Used just at initialisation time to link in libraries --- specified on the command line. -linkLibraries dflags objs - = do { lib_paths <- readIORef v_Library_paths - ; minus_ls <- readIORef v_Cmdline_libraries - ; let cmdline_lib_specs = map Object objs ++ map DLL minus_ls - - ; if (null cmdline_lib_specs) then return () - else do { - - -- Now link them - ; mapM_ (preloadLib dflags lib_paths) cmdline_lib_specs - - ; maybePutStr dflags "final link ... " - ; ok <- resolveObjs - ; if succeeded ok then maybePutStrLn dflags "done." - else throwDyn (InstallationError "linking extra libraries/objects failed") - }} - where - preloadLib :: DynFlags -> [String] -> LibrarySpec -> IO () - preloadLib dflags lib_paths lib_spec - = do maybePutStr dflags ("Loading object " ++ showLS lib_spec ++ " ... ") - case lib_spec of - Object static_ish - -> do b <- preload_static lib_paths static_ish - maybePutStrLn dflags (if b then "done." - else "not found") - DLL dll_unadorned - -> do maybe_errstr <- loadDynamic lib_paths dll_unadorned - case maybe_errstr of - Nothing -> return () - Just mm -> preloadFailed mm lib_paths lib_spec - maybePutStrLn dflags "done" - - preloadFailed :: String -> [String] -> LibrarySpec -> IO () - preloadFailed sys_errmsg paths spec - = do maybePutStr dflags - ("failed.\nDynamic linker error message was:\n " - ++ sys_errmsg ++ "\nWhilst trying to load: " - ++ showLS spec ++ "\nDirectories to search are:\n" - ++ unlines (map (" "++) paths) ) - give_up - - -- not interested in the paths in the static case. - preload_static paths name - = do b <- doesFileExist name - if not b then return False - else loadObj name >> return True - - give_up - = (throwDyn . CmdLineError) - "user specified .o/.so/.DLL could not be loaded." -\end{code} - - %************************************************************************ %* * \subsection{The byte-code linker} @@ -490,7 +571,7 @@ linkSomeBCOs :: Bool -- False <=> add _all_ BCOs to returned closure env linkSomeBCOs toplevs_only ie ce_in ul_bcos - = do let nms = map nameOfUnlinkedBCO ul_bcos + = do let nms = map unlinkedBCOName ul_bcos hvals <- fixIO ( \ hvs -> let ce_out = extendClosureEnv ce_in (zipLazy nms hvs) in mapM (linkBCO ie ce_out) ul_bcos ) @@ -561,8 +642,7 @@ unload_wkr dflags linkables pls objs_loaded' <- filterM (maybeUnload objs_to_keep) (objs_loaded pls) bcos_loaded' <- filterM (maybeUnload bcos_to_keep) (bcos_loaded pls) - let objs_retained = map linkableModName objs_loaded' - bcos_retained = map linkableModName bcos_loaded' + let bcos_retained = map linkableModName bcos_loaded' itbl_env' = filterNameMap bcos_retained (itbl_env pls) closure_env' = filterNameMap bcos_retained (closure_env pls) new_pls = pls { itbl_env = itbl_env', @@ -606,9 +686,11 @@ data LibrarySpec -- On WinDoze "burble" denotes "burble.DLL" -- loadDLL is platform-specific and adds the lib/.so/.DLL -- suffixes platform-dependently -#ifdef darwin_TARGET_OS - | Framework String -#endif + + | DLLPath FilePath -- Absolute or relative pathname to a dynamic library + -- (ends with .dll or .so). + + | Framework String -- Only used for darwin, but does no harm -- If this package is already part of the GHCi binary, we'll already -- have the right DLLs for this package loaded, so don't try to @@ -619,18 +701,17 @@ data LibrarySpec -- of DLL handles that rts/Linker.c maintains, and that in turn is -- used by lookupSymbol. So we must call addDLL for each library -- just to get the DLL handle into the list. -partOfGHCi -# ifndef mingw32_TARGET_OS - = [ "base", "haskell98", "haskell-src", "readline" ] +partOfGHCi +# if defined(mingw32_TARGET_OS) || defined(darwin_TARGET_OS) + = [ ] # else - = [ ] + = [ "base", "haskell98", "template-haskell", "readline" ] # endif -showLS (Object nm) = "(static) " ++ nm -showLS (DLL nm) = "(dynamic) " ++ nm -#ifdef darwin_TARGET_OS +showLS (Object nm) = "(static) " ++ nm +showLS (DLL nm) = "(dynamic) " ++ nm +showLS (DLLPath nm) = "(dynamic) " ++ nm showLS (Framework nm) = "(framework) " ++ nm -#endif linkPackages :: DynFlags -> [PackageName] -> IO () -- Link exactly the specified packages, and their dependents @@ -678,11 +759,8 @@ linkPackage dflags pkg = do let dirs = Packages.library_dirs pkg let libs = Packages.hs_libraries pkg ++ extra_libraries pkg + ++ [ lib | '-':'l':lib <- extra_ld_opts pkg ] classifieds <- mapM (locateOneObj dirs) libs -#ifdef darwin_TARGET_OS - let fwDirs = Packages.framework_dirs pkg - let frameworks= Packages.extra_frameworks pkg -#endif -- Complication: all the .so's must be loaded before any of the .o's. let dlls = [ dll | DLL dll <- classifieds ] @@ -692,34 +770,46 @@ linkPackage dflags pkg -- See comments with partOfGHCi when (Packages.name pkg `notElem` partOfGHCi) $ do -#ifdef darwin_TARGET_OS - loadFrameworks fwDirs frameworks -#endif - loadDynamics dirs dlls + loadFrameworks pkg + -- When a library A needs symbols from a library B, the order in + -- extra_libraries/extra_ld_opts is "-lA -lB", because that's the + -- way ld expects it for static linking. Dynamic linking is a + -- different story: When A has no dependency information for B, + -- dlopen-ing A with RTLD_NOW (see addDLL in Linker.c) will fail + -- when B has not been loaded before. In a nutshell: Reverse the + -- order of DLLs for dynamic linking. + -- This fixes a problem with the HOpenGL package (see "Compiling + -- HOpenGL under recent versions of GHC" on the HOpenGL list). + mapM_ (load_dyn dirs) (reverse dlls) -- After loading all the DLLs, we can load the static objects. + -- Ordering isn't important here, because we do one final link + -- step to resolve everything. mapM_ loadObj objs maybePutStr dflags "linking ... " ok <- resolveObjs if succeeded ok then maybePutStrLn dflags "done." - else panic ("can't load package `" ++ name pkg ++ "'") - -loadDynamics dirs [] = return () -loadDynamics dirs (dll:dlls) = do - r <- loadDynamic dirs dll - case r of - Nothing -> loadDynamics dirs dlls - Just err -> throwDyn (CmdLineError ("can't load .so/.DLL for: " - ++ dll ++ " (" ++ err ++ ")" )) -#ifdef darwin_TARGET_OS -loadFrameworks dirs [] = return () -loadFrameworks dirs (fw:fws) = do - r <- loadFramework dirs fw - case r of - Nothing -> loadFrameworks dirs fws - Just err -> throwDyn (CmdLineError ("can't load framework: " - ++ fw ++ " (" ++ err ++ ")" )) + else throwDyn (InstallationError ("unable to load package `" ++ name pkg ++ "'")) + +load_dyn dirs dll = do r <- loadDynamic dirs dll + case r of + Nothing -> return () + Just err -> throwDyn (CmdLineError ("can't load .so/.DLL for: " + ++ dll ++ " (" ++ err ++ ")" )) +#ifndef darwin_TARGET_OS +loadFrameworks pkg = return () +#else +loadFrameworks pkg = mapM_ load frameworks + where + fw_dirs = Packages.framework_dirs pkg + frameworks = Packages.extra_frameworks pkg + + load fw = do r <- loadFramework fw_dirs fw + case r of + Nothing -> return () + Just err -> throwDyn (CmdLineError ("can't load framework: " + ++ fw ++ " (" ++ err ++ ")" )) #endif -- Try to find an object file for a given library in the given paths. @@ -729,7 +819,7 @@ locateOneObj dirs lib = do { mb_obj_path <- findFile mk_obj_path dirs ; case mb_obj_path of Just obj_path -> return (Object obj_path) - Nothing -> return (DLL lib) } -- we assume + Nothing -> return (DLL lib) } -- We assume where mk_obj_path dir = dir ++ '/':lib ++ ".o"