Linker.lhs 42 KB
Newer Older
1
%
2
% (c) The University of Glasgow 2005-2006
3
%
4 5 6 7 8 9 10 11 12

-- --------------------------------------
-- 	The dynamic linker for GHCi      
-- --------------------------------------

This module deals with the top-level issues of dynamic linking,
calling the object-code linker and the byte-code linker where
necessary.

13 14

\begin{code}
15
{-# OPTIONS -optc-DNON_POSIX_SOURCE -#include "Linker.h" #-}
16

mnislaih's avatar
mnislaih committed
17
module Linker ( HValue, getHValue, showLinkerState,
18 19 20
		linkExpr, unload, withExtendedLinkEnv,
                extendLinkEnv, deleteFromLinkEnv,
                extendLoadedPkgs, 
mnislaih's avatar
mnislaih committed
21
		linkPackages,initDynLinker,
22
                dataConInfoPtrToName
23
	) where
sof's avatar
sof committed
24

25
#include "HsVersions.h"
26

27
import LoadIface
28 29 30 31
import ObjLink
import ByteCodeLink
import ByteCodeItbls
import ByteCodeAsm
32 33
import CgInfoTbls
import SMRep
34 35
import IfaceEnv
import TcRnMonad
36
import Packages
37 38
import DriverPhases
import Finder
39
import HscTypes
40
import Name
41
import NameEnv
42
import NameSet
43
import qualified OccName
44
import LazyUniqFM
45
import Module
46 47 48
import ListSetOps
import DynFlags
import BasicTypes
49
import Outputable
50 51 52 53 54 55 56
import PackageConfig
import Panic
import Util
import StaticFlags
import ErrUtils
import DriverPhases
import SrcLoc
57
import qualified Maybes
Simon Marlow's avatar
Simon Marlow committed
58
import UniqSet
59
import Constants
60
import FastString
61
import Config		( cProjectVersion )
62 63

-- Standard libraries
64
import Control.Monad
65

66
import Data.Char
67 68
import Data.IORef
import Data.List
69
import Foreign
70

Ian Lynagh's avatar
Ian Lynagh committed
71
import System.FilePath
72 73
import System.IO
import System.Directory
74

75 76
import Control.Exception
import Data.Maybe
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
\end{code}


%************************************************************************
%*									*
			The Linker's state
%*									*
%************************************************************************

The persistent linker state *must* match the actual state of the 
C dynamic linker at all times, so we keep it in a private global variable.


The PersistentLinkerState maps Names to actual closures (for
interpreted code only), for use during linking.

\begin{code}
94 95
GLOBAL_VAR(v_PersistentLinkerState, panic "Dynamic linker not initialised", PersistentLinkerState)
GLOBAL_VAR(v_InitLinkerDone, False, Bool)	-- Set True when dynamic linker is initialised
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118

data PersistentLinkerState
   = PersistentLinkerState {

	-- Current global mapping from Names to their true values
        closure_env :: ClosureEnv,

	-- The current global mapping from RdrNames of DataCons to
	-- info table addresses.
	-- When a new Unlinked is linked into the running image, or an existing
	-- module in the image is replaced, the itbl_env must be updated
	-- appropriately.
        itbl_env    :: ItblEnv,

	-- The currently loaded interpreted modules (home package)
	bcos_loaded :: [Linkable],

	-- And the currently-loaded compiled modules (home package)
	objs_loaded :: [Linkable],

	-- The currently-loaded packages; always object code
	-- Held, as usual, in dependency order; though I am not sure if
	-- that is really important
119
	pkgs_loaded :: [PackageId]
120 121
     }

122
emptyPLS :: DynFlags -> PersistentLinkerState
Ian Lynagh's avatar
Ian Lynagh committed
123
emptyPLS _ = PersistentLinkerState { 
124 125 126 127
			closure_env = emptyNameEnv,
			itbl_env    = emptyNameEnv,
			pkgs_loaded = init_pkgs,
			bcos_loaded = [],
128 129
			objs_loaded = [] }
                    
130 131 132 133 134
  -- 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.
Simon Marlow's avatar
Simon Marlow committed
135
  where init_pkgs = [rtsPackageId]
136 137 138
\end{code}

\begin{code}
139 140 141 142
extendLoadedPkgs :: [PackageId] -> IO ()
extendLoadedPkgs pkgs
    = modifyIORef v_PersistentLinkerState (\s -> s{pkgs_loaded = pkgs ++ pkgs_loaded s})

143 144 145 146 147 148 149 150
extendLinkEnv :: [(Name,HValue)] -> IO ()
-- Automatically discards shadowed bindings
extendLinkEnv new_bindings
  = do	pls <- readIORef v_PersistentLinkerState
	let new_closure_env = extendClosureEnv (closure_env pls) new_bindings
	    new_pls = pls { closure_env = new_closure_env }
	writeIORef v_PersistentLinkerState new_pls

151 152 153 154 155 156 157
deleteFromLinkEnv :: [Name] -> IO ()
deleteFromLinkEnv to_remove
  = do	pls <- readIORef v_PersistentLinkerState
	let new_closure_env = delListFromNameEnv (closure_env pls) to_remove
	    new_pls = pls { closure_env = new_closure_env }
	writeIORef v_PersistentLinkerState new_pls

158 159 160 161
-- | Given a data constructor in the heap, find its Name.
--   The info tables for data constructors have a field which records
--   the source name of the constructor as a Ptr Word8 (UTF-8 encoded
--   string). The format is:
162 163 164 165 166
--
--    Package:Module.Name
--
--   We use this string to lookup the interpreter's internal representation of the name
--   using the lookupOrig.    
167

168
dataConInfoPtrToName :: Ptr () -> TcM (Either String Name)
169
dataConInfoPtrToName x = do 
twanvl's avatar
twanvl committed
170
   theString <- liftIO $ do
171
      let ptr = castPtr x :: Ptr StgInfoTable
172
      conDescAddress <- getConDescAddress ptr 
173
      peekArray0 0 conDescAddress  
174
   let (pkg, mod, occ) = parse theString 
175 176 177 178 179
       pkgFS = mkFastStringByteList pkg
       modFS = mkFastStringByteList mod
       occFS = mkFastStringByteList occ
       occName = mkOccNameFS OccName.dataName occFS
       modName = mkModule (fsToPackageId pkgFS) (mkModuleNameFS modFS) 
180 181
   return (Left$ showSDoc$ ppr modName <> dot <> ppr occName ) 
    `recoverM` (Right `fmap` lookupOrig modName occName)
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224

   where

   {- To find the string in the constructor's info table we need to consider 
      the layout of info tables relative to the entry code for a closure.

      An info table can be next to the entry code for the closure, or it can
      be separate. The former (faster) is used in registerised versions of ghc, 
      and the latter (portable) is for non-registerised versions. 

      The diagrams below show where the string is to be found relative to 
      the normal info table of the closure.

      1) Code next to table:

         --------------
         |            |   <- pointer to the start of the string
         --------------
         |            |   <- the (start of the) info table structure
         |            |
         |            |
         --------------
         | entry code | 
         |    ....    |

         In this case the pointer to the start of the string can be found in
         the memory location _one word before_ the first entry in the normal info 
         table.

      2) Code NOT next to table:

                                 --------------
         info table structure -> |     *------------------> --------------
                                 |            |             | entry code |
                                 |            |             |    ....    | 
                                 --------------
         ptr to start of str ->  |            |   
                                 --------------

         In this case the pointer to the start of the string can be found
         in the memory location: info_table_ptr + info_table_size
   -}

225
   getConDescAddress :: Ptr StgInfoTable -> IO (Ptr Word8)
Ian Lynagh's avatar
Ian Lynagh committed
226 227
   getConDescAddress ptr
    | ghciTablesNextToCode = do
228 229
       offsetToString <- peek $ ptr `plusPtr` (- wORD_SIZE)
       return $ (ptr `plusPtr` stdInfoTableSizeB) `plusPtr` (fromIntegral (offsetToString :: StgWord))
Ian Lynagh's avatar
Ian Lynagh committed
230
    | otherwise =
231
       peek $ intPtrToPtr $ (ptrToIntPtr ptr) + fromIntegral stdInfoTableSizeB
232 233 234 235 236 237 238 239

   -- parsing names is a little bit fiddly because we have a string in the form: 
   -- pkg:A.B.C.foo, and we want to split it into three parts: ("pkg", "A.B.C", "foo").
   -- Thus we split at the leftmost colon and the rightmost occurrence of the dot.
   -- It would be easier if the string was in the form pkg:A.B.C:foo, but alas
   -- this is not the conventional way of writing Haskell names. We stick with
   -- convention, even though it makes the parsing code more troublesome.
   -- Warning: this code assumes that the string is well formed.
240
   parse :: [Word8] -> ([Word8], [Word8], [Word8])
241 242 243
   parse input 
      = ASSERT (all (>0) (map length [pkg, mod, occ])) (pkg, mod, occ)
      where
244 245
      dot = fromIntegral (ord '.')
      (pkg, rest1) = break (== fromIntegral (ord ':')) input 
246
      (mod, occ) 
247
         = (concat $ intersperse [dot] $ reverse modWords, occWord)
248 249
         where
         (modWords, occWord) = ASSERT (length rest1 > 0) (parseModOcc [] (tail rest1))
250
      parseModOcc :: [[Word8]] -> [Word8] -> ([[Word8]], [Word8])
251
      parseModOcc acc str
252
         = case break (== dot) str of
253
              (top, []) -> (acc, top)
254
              (top, _:bot) -> parseModOcc (top : acc) bot
255
       
256

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
getHValue :: HscEnv -> Name -> IO HValue
getHValue hsc_env name = do
   when (isExternalName name) $ do
        ok <- linkDependencies hsc_env noSrcSpan [nameModule name]
        when (failed ok) $ throwDyn (ProgramError "")
   pls <- readIORef v_PersistentLinkerState
   lookupName (closure_env pls) name
        
linkDependencies :: HscEnv -> SrcSpan -> [Module] -> IO SuccessFlag
linkDependencies hsc_env span needed_mods = do
   let hpt = hsc_HPT hsc_env
       dflags = hsc_dflags hsc_env
	-- The interpreter and dynamic linker can only handle object code built
	-- the "normal" way, i.e. no non-std ways like profiling or ticky-ticky.
	-- So here we check the build tag: if we're building a non-standard way
	-- then we need to find & link object files built the "normal" way.
   maybe_normal_osuf <- checkNonStdWay dflags span

	-- Find what packages and linkables are required
   eps <- readIORef (hsc_EPS hsc_env)
   (lnks, pkgs) <- getLinkDeps hsc_env hpt (eps_PIT eps) 
				maybe_normal_osuf span needed_mods

	-- Link the packages and modules required
   linkPackages dflags pkgs
   linkModules dflags lnks

284

285 286
-- | Temporarily extend the linker state.

287 288
withExtendedLinkEnv :: [(Name,HValue)] -> IO a -> IO a
withExtendedLinkEnv new_env action
289 290 291
    = bracket_ set_new_env
               reset_old_env
               action
292 293 294 295 296
    where set_new_env = do 
            pls <- readIORef v_PersistentLinkerState
            let new_closure_env = extendClosureEnv (closure_env pls) new_env
                new_pls = pls { closure_env = new_closure_env }
            writeIORef v_PersistentLinkerState new_pls
297
            return ()
298 299 300 301 302 303

        -- Remember that the linker state might be side-effected
        -- during the execution of the IO action, and we don't want to
        -- lose those changes (we might have linked a new module or
        -- package), so the reset action only removes the names we
        -- added earlier.
304
          reset_old_env = do
305 306 307 308 309
            modifyIORef v_PersistentLinkerState $ \pls ->
                let cur = closure_env pls
                    new = delListFromNameEnv cur (map fst new_env)
                in
                pls{ closure_env = new }
310

311 312 313 314 315 316
-- filterNameMap removes from the environment all entries except 
-- 	those for a given set of modules;
-- Note that this removes all *local* (i.e. non-isExternal) names too 
--	(these are the temporary bindings from the command line).
-- Used to filter both the ClosureEnv and ItblEnv

317
filterNameMap :: [Module] -> NameEnv (Name, a) -> NameEnv (Name, a)
318 319 320 321
filterNameMap mods env 
   = filterNameEnv keep_elt env
   where
     keep_elt (n,_) = isExternalName n 
322
		      && (nameModule n `elem` mods)
323 324 325 326 327 328 329 330 331 332 333
\end{code}


\begin{code}
showLinkerState :: IO ()
-- Display the persistent linker state
showLinkerState
  = do pls <- readIORef v_PersistentLinkerState
       printDump (vcat [text "----- Linker state -----",
			text "Pkgs:" <+> ppr (pkgs_loaded pls),
			text "Objs:" <+> ppr (objs_loaded pls),
334
			text "BCOs:" <+> ppr (bcos_loaded pls)])
335 336 337 338
\end{code}
			
	

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

%************************************************************************
%*									*
\subsection{Initialisation}
%*									*
%************************************************************************

We initialise the dynamic linker by

a) calling the C initialisation procedure

b) Loading any packages specified on the command line,

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}
361
initDynLinker :: DynFlags -> IO ()
362 363
-- 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
364
initDynLinker dflags
365 366 367
  = do	{ done <- readIORef v_InitLinkerDone
	; if done then return () 
		  else do { writeIORef v_InitLinkerDone True
368
			  ; reallyInitDynLinker dflags }
369 370
	}

Ian Lynagh's avatar
Ian Lynagh committed
371
reallyInitDynLinker :: DynFlags -> IO ()
372 373 374
reallyInitDynLinker dflags
  = do  {  -- Initialise the linker state
	; writeIORef v_PersistentLinkerState (emptyPLS dflags)
375 376 377 378 379

	 	-- (a) initialise the C dynamic linker
	; initObjLinker 

		-- (b) Load packages from the command-line
380
	; linkPackages dflags (preloadPackages (pkgState dflags))
381 382

	   	-- (c) Link libraries from the command-line
383 384
	; let optl = getOpts dflags opt_l
	; let minus_ls = [ lib | '-':'l':lib <- optl ]
385 386

	   	-- (d) Link .o files from the command-line
387
	; let lib_paths = libraryPaths dflags
388 389
	; cmdline_ld_inputs <- readIORef v_Ld_inputs

390
	; classified_ld_inputs <- mapM classifyLdInput cmdline_ld_inputs
391 392

	   	-- (e) Link any MacOS frameworks
Ian Lynagh's avatar
Ian Lynagh committed
393 394 395 396 397 398
	; let framework_paths
               | isDarwinTarget = frameworkPaths dflags
               | otherwise      = []
	; let frameworks
               | isDarwinTarget = cmdlineFrameworks dflags
               | otherwise      = []
399
		-- Finally do (c),(d),(e)	
400
        ; let cmdline_lib_specs = [ l | Just l <- classified_ld_inputs ]
401 402 403 404 405 406 407 408 409 410 411 412 413
			       ++ 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")
	}}

414 415 416 417 418 419 420
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
421

422 423 424 425 426 427 428 429 430 431 432 433 434 435
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
436 437 438 439 440 441 442

	  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

443
	  Framework framework
Ian Lynagh's avatar
Ian Lynagh committed
444
           | isDarwinTarget
445 446 447 448
             -> do maybe_errstr <- loadFramework framework_paths framework
                   case maybe_errstr of
                      Nothing -> maybePutStrLn dflags "done"
                      Just mm -> preloadFailed mm framework_paths lib_spec
Ian Lynagh's avatar
Ian Lynagh committed
449 450
           | otherwise -> panic "preloadLib Framework"

451 452 453 454 455 456 457 458 459 460 461
  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.
Ian Lynagh's avatar
Ian Lynagh committed
462
    preload_static _paths name
463 464 465 466 467 468 469 470 471
       = 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}


472 473 474 475 476 477 478
%************************************************************************
%*									*
		Link a byte-code expression
%*									*
%************************************************************************

\begin{code}
479
linkExpr :: HscEnv -> SrcSpan -> UnlinkedBCO -> IO HValue
480 481 482 483 484 485

-- Link a single expression, *including* first linking packages and 
-- modules that this expression depends on.
--
-- Raises an IO exception if it can't find a compiled version of the
-- dependents to link.
486 487
--
-- Note: This function side-effects the linker state (Pepe)
488

489
linkExpr hsc_env span root_ul_bco
490
  = do {  
491
	-- Initialise the linker (if it's not been done already)
492 493
     let dflags = hsc_dflags hsc_env
   ; initDynLinker dflags
494

495
	-- Link the packages and modules required
496
   ; ok <- linkDependencies hsc_env span needed_mods
497
   ; if failed ok then
498
	throwDyn (ProgramError "")
499 500 501 502 503 504 505 506
     else do {

	-- Link the expression itself
     pls <- readIORef v_PersistentLinkerState
   ; let ie = itbl_env pls
	 ce = closure_env pls

	-- Link the necessary packages and linkables
507
   ; (_, (root_hval:_)) <- linkSomeBCOs False ie ce [root_ul_bco]
508
   ; return root_hval
509
   }}
510
   where
511 512
     free_names = nameSetToList (bcoFreeNames root_ul_bco)

513
     needed_mods :: [Module]
514 515 516 517 518 519 520 521
     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.
522
 
Ian Lynagh's avatar
Ian Lynagh committed
523
dieWith :: SrcSpan -> Message -> IO a
524 525 526 527 528 529 530 531 532 533 534 535
dieWith span msg = throwDyn (ProgramError (showSDoc (mkLocMessage span msg)))


checkNonStdWay :: DynFlags -> SrcSpan -> IO (Maybe String)
checkNonStdWay dflags srcspan = do
  tag <- readIORef v_Build_tag
  if null tag then return Nothing else do
  let default_osuf = phaseInputExt StopLn
  if objectSuf dflags == default_osuf
	then failNonStd srcspan
	else return (Just default_osuf)

Ian Lynagh's avatar
Ian Lynagh committed
536
failNonStd :: SrcSpan -> IO (Maybe String)
537
failNonStd srcspan = dieWith srcspan $
Ian Lynagh's avatar
Ian Lynagh committed
538 539 540
  ptext (sLit "Dynamic linking required, but this is a non-standard build (eg. prof).") $$
  ptext (sLit "You need to build the program twice: once the normal way, and then") $$
  ptext (sLit "in the desired way using -osuf to set the object file suffix.")
541
  
542

543
getLinkDeps :: HscEnv -> HomePackageTable -> PackageIfaceTable
544 545
	    -> Maybe String			-- the "normal" object suffix
	    -> SrcSpan				-- for error messages
546
	    -> [Module]				-- If you need these
547
	    -> IO ([Linkable], [PackageId])	-- ... then link these first
548
-- Fails with an IO exception if it can't find enough files
549

Ian Lynagh's avatar
Ian Lynagh committed
550
getLinkDeps hsc_env hpt _ maybe_normal_osuf span mods
551
-- Find all the packages and linkables that a set of modules depends on
552
 = do {	pls <- readIORef v_PersistentLinkerState ;
553
	-- 1.  Find the dependent home-pkg-modules/packages from each iface
554
        (mods_s, pkgs_s) <- follow_deps mods emptyUniqSet emptyUniqSet;
555

556
	let {
557 558
	-- 2.  Exclude ones already linked
	--	Main reason: avoid findModule calls in get_linkable
Simon Marlow's avatar
Simon Marlow committed
559 560
	    mods_needed = mods_s `minusList` linked_mods     ;
	    pkgs_needed = pkgs_s `minusList` pkgs_loaded pls ;
561

Simon Marlow's avatar
Simon Marlow committed
562 563
	    linked_mods = map (moduleName.linkableModule) 
                                (objs_loaded pls ++ bcos_loaded pls)
564
	} ;
565
	
Simon Marlow's avatar
Simon Marlow committed
566
--        putStrLn (showSDoc (ppr mods_s)) ;
567
	-- 3.  For each dependent module, find its linkable
568 569
	--     This will either be in the HPT or (in the case of one-shot
	--     compilation) we may need to use maybe_getFileLinkable
570
	lnks_needed <- mapM (get_linkable maybe_normal_osuf) mods_needed ;
571

572
	return (lnks_needed, pkgs_needed) }
573
  where
Simon Marlow's avatar
Simon Marlow committed
574 575 576
    dflags = hsc_dflags hsc_env
    this_pkg = thisPackage dflags

Simon Marlow's avatar
Simon Marlow committed
577 578 579 580 581 582 583 584
        -- The ModIface contains the transitive closure of the module dependencies
        -- within the current package, *except* for boot modules: if we encounter
        -- a boot module, we have to find its real interface and discover the
        -- dependencies of that.  Hence we need to traverse the dependency
        -- tree recursively.  See bug #936, testcase ghci/prog007.
    follow_deps :: [Module]             -- modules to follow
                -> UniqSet ModuleName         -- accum. module dependencies
                -> UniqSet PackageId          -- accum. package dependencies
585
                -> IO ([ModuleName], [PackageId]) -- result
Simon Marlow's avatar
Simon Marlow committed
586
    follow_deps []     acc_mods acc_pkgs
587
        = return (uniqSetToList acc_mods, uniqSetToList acc_pkgs)
Simon Marlow's avatar
Simon Marlow committed
588
    follow_deps (mod:mods) acc_mods acc_pkgs
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
        = do
          mb_iface <- initIfaceCheck hsc_env $
                        loadInterface msg mod (ImportByUser False)
          iface <- case mb_iface of
        	    Maybes.Failed err      -> ghcError (ProgramError (showSDoc err))
	            Maybes.Succeeded iface -> return iface

          when (mi_boot iface) $ link_boot_mod_error mod

          let
            pkg = modulePackageId mod
            deps  = mi_deps iface

            pkg_deps = dep_pkgs deps
            (boot_deps, mod_deps) = partitionWith is_boot (dep_mods deps)
                    where is_boot (m,True)  = Left m
                          is_boot (m,False) = Right m

            boot_deps' = filter (not . (`elementOfUniqSet` acc_mods)) boot_deps
            acc_mods'  = addListToUniqSet acc_mods (moduleName mod : mod_deps)
            acc_pkgs'  = addListToUniqSet acc_pkgs pkg_deps
          --
          if pkg /= this_pkg
             then follow_deps mods acc_mods (addOneToUniqSet acc_pkgs' pkg)
             else follow_deps (map (mkModule this_pkg) boot_deps' ++ mods)
                              acc_mods' acc_pkgs'
        where
            msg = text "need to link module" <+> ppr mod <+>
                  text "due to use of Template Haskell"
Simon Marlow's avatar
Simon Marlow committed
618 619 620 621 622 623


    link_boot_mod_error mod = 
        throwDyn (ProgramError (showSDoc (
            text "module" <+> ppr mod <+> 
            text "cannot be linked; it is only available as a boot module")))
624

625
    no_obj mod = dieWith span $
Ian Lynagh's avatar
Ian Lynagh committed
626
		     ptext (sLit "cannot find object file for module ") <> 
627 628 629
			quotes (ppr mod) $$
		     while_linking_expr
		
Ian Lynagh's avatar
Ian Lynagh committed
630
    while_linking_expr = ptext (sLit "while linking an interpreted expression")
631

632 633
	-- This one is a build-system bug

634
    get_linkable maybe_normal_osuf mod_name	-- A home-package module
Simon Marlow's avatar
Simon Marlow committed
635
	| Just mod_info <- lookupUFM hpt mod_name 
636
	= ASSERT(isJust (hm_linkable mod_info))
637
	  adjust_linkable (fromJust (hm_linkable mod_info))
638
	| otherwise	
Simon Marlow's avatar
Simon Marlow committed
639
	= do	-- It's not in the HPT because we are in one shot mode, 
640
		-- so use the Finder to get a ModLocation...
Simon Marlow's avatar
Simon Marlow committed
641 642 643
	     mb_stuff <- findHomeModule hsc_env mod_name
	     case mb_stuff of
		  Found loc mod -> found loc mod
644
		  _ -> no_obj mod_name
645 646
        where
            found loc mod = do {
647
		-- ...and then find the linkable for it
Simon Marlow's avatar
Simon Marlow committed
648
	       mb_lnk <- findObjectLinkableMaybe mod loc ;
649
	       case mb_lnk of {
Simon Marlow's avatar
Simon Marlow committed
650
		  Nothing -> no_obj mod ;
651
		  Just lnk -> adjust_linkable lnk
652
	      }}
653 654 655 656 657 658 659 660 661

	    adjust_linkable lnk
		| Just osuf <- maybe_normal_osuf = do
			new_uls <- mapM (adjust_ul osuf) (linkableUnlinked lnk)
        		return lnk{ linkableUnlinked=new_uls }
		| otherwise =
			return lnk

	    adjust_ul osuf (DotO file) = do
Ian Lynagh's avatar
Ian Lynagh committed
662
		let new_file = replaceExtension file osuf
663 664 665
		ok <- doesFileExist new_file
		if (not ok)
		   then dieWith span $
Ian Lynagh's avatar
Ian Lynagh committed
666
			  ptext (sLit "cannot find normal object file ")
667 668
				<> quotes (text new_file) $$ while_linking_expr
		   else return (DotO new_file)
Ian Lynagh's avatar
Ian Lynagh committed
669
	    adjust_ul _ _ = panic "adjust_ul"
670
\end{code}
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706


%************************************************************************
%*									*
		Link some linkables
	The linkables may consist of a mixture of 
	byte-code modules and object modules
%*									*
%************************************************************************

\begin{code}
linkModules :: DynFlags -> [Linkable] -> IO SuccessFlag
linkModules dflags linkables
  = block $ do  -- don't want to be interrupted by ^C in here
	
	let (objs, bcos) = partition isObjectLinkable 
                              (concatMap partitionLinkable linkables)

		-- Load objects first; they can't depend on BCOs
	ok_flag <- dynLinkObjs dflags objs

	if failed ok_flag then 
		return Failed
	  else do
		dynLinkBCOs bcos
		return Succeeded
		

-- HACK to support f-x-dynamic in the interpreter; no other purpose
partitionLinkable :: Linkable -> [Linkable]
partitionLinkable li
   = let li_uls = linkableUnlinked li
         li_uls_obj = filter isObject li_uls
         li_uls_bco = filter isInterpretable li_uls
     in 
         case (li_uls_obj, li_uls_bco) of
Ian Lynagh's avatar
Ian Lynagh committed
707 708 709
            (_:_, _:_) -> [li {linkableUnlinked=li_uls_obj},
                           li {linkableUnlinked=li_uls_bco}]
            _ -> [li]
710

711
findModuleLinkable_maybe :: [Linkable] -> Module -> Maybe Linkable
712 713 714 715
findModuleLinkable_maybe lis mod
   = case [LM time nm us | LM time nm us <- lis, nm == mod] of
        []   -> Nothing
        [li] -> Just li
Ian Lynagh's avatar
Ian Lynagh committed
716
        _    -> pprPanic "findModuleLinkable" (ppr mod)
717 718 719

linkableInSet :: Linkable -> [Linkable] -> Bool
linkableInSet l objs_loaded =
720
  case findModuleLinkable_maybe objs_loaded (linkableModule l) of
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
	Nothing -> False
	Just m  -> linkableTime l == linkableTime m
\end{code}


%************************************************************************
%*									*
\subsection{The object-code linker}
%*									*
%************************************************************************

\begin{code}
dynLinkObjs :: DynFlags -> [Linkable] -> IO SuccessFlag
	-- Side-effects the PersistentLinkerState

dynLinkObjs dflags objs
  = do	pls <- readIORef v_PersistentLinkerState

	-- Load the object files and link them
	let (objs_loaded', new_objs) = rmDupLinkables (objs_loaded pls) objs
	    pls1 		     = pls { objs_loaded = objs_loaded' }
	    unlinkeds 		     = concatMap linkableUnlinked new_objs

	mapM loadObj (map nameOfObject unlinkeds)

	-- Link the all together
	ok <- resolveObjs

	-- If resolving failed, unload all our 
	-- object modules and carry on
	if succeeded ok then do
		writeIORef v_PersistentLinkerState pls1
		return Succeeded
	  else do
		pls2 <- unload_wkr dflags [] pls1
		writeIORef v_PersistentLinkerState pls2
		return Failed


rmDupLinkables :: [Linkable] 	-- Already loaded
	       -> [Linkable]	-- New linkables
	       -> ([Linkable],	-- New loaded set (including new ones)
		   [Linkable])	-- New linkables (excluding dups)
rmDupLinkables already ls
  = go already [] ls
  where
    go already extras [] = (already, extras)
    go already extras (l:ls)
	| linkableInSet l already = go already     extras     ls
	| otherwise		  = go (l:already) (l:extras) ls
\end{code}

%************************************************************************
%*									*
\subsection{The byte-code linker}
%*									*
%************************************************************************

\begin{code}
dynLinkBCOs :: [Linkable] -> IO ()
	-- Side-effects the persistent linker state
dynLinkBCOs bcos
  = do	pls <- readIORef v_PersistentLinkerState

	let (bcos_loaded', new_bcos) = rmDupLinkables (bcos_loaded pls) bcos
	    pls1 		     = pls { bcos_loaded = bcos_loaded' }
	    unlinkeds :: [Unlinked]
	    unlinkeds 		     = concatMap linkableUnlinked new_bcos

	    cbcs :: [CompiledByteCode]
	    cbcs      = map byteCodeOfObject unlinkeds
		      
	    	      
	    ul_bcos    = [b | ByteCode bs _  <- cbcs, b <- bs]
	    ies	       = [ie | ByteCode _ ie <- cbcs]
	    gce	      = closure_env pls
            final_ie  = foldr plusNameEnv (itbl_env pls) ies

Ian Lynagh's avatar
Ian Lynagh committed
799 800
        (final_gce, _linked_bcos) <- linkSomeBCOs True final_ie gce ul_bcos
		-- XXX What happens to these linked_bcos?
801 802 803 804 805 806 807 808 809 810 811 812 813

	let pls2 = pls1 { closure_env = final_gce,
			  itbl_env    = final_ie }

	writeIORef v_PersistentLinkerState pls2
	return ()

-- Link a bunch of BCOs and return them + updated closure env.
linkSomeBCOs :: Bool 	-- False <=> add _all_ BCOs to returned closure env
                        -- True  <=> add only toplevel BCOs to closure env
             -> ItblEnv 
             -> ClosureEnv 
             -> [UnlinkedBCO]
814
             -> IO (ClosureEnv, [HValue])
815 816 817 818
			-- The returned HValues are associated 1-1 with
			-- the incoming unlinked BCOs.  Each gives the
			-- value of the corresponding unlinked BCO
					
819
linkSomeBCOs toplevs_only ie ce_in ul_bcos
820
   = do let nms = map unlinkedBCOName ul_bcos
821 822 823 824 825 826 827 828 829 830 831
        hvals <- fixIO 
                    ( \ hvs -> let ce_out = extendClosureEnv ce_in (zipLazy nms hvs)
                               in  mapM (linkBCO ie ce_out) ul_bcos )
        let ce_all_additions = zip nms hvals
            ce_top_additions = filter (isExternalName.fst) ce_all_additions
            ce_additions     = if toplevs_only then ce_top_additions 
                                               else ce_all_additions
            ce_out = -- make sure we're not inserting duplicate names into the 
		     -- closure environment, which leads to trouble.
		     ASSERT (all (not . (`elemNameEnv` ce_in)) (map fst ce_additions))
		     extendClosureEnv ce_in ce_additions
832
        return (ce_out, hvals)
833

834 835 836 837 838 839 840 841 842 843
\end{code}


%************************************************************************
%*									*
		Unload some object modules
%*									*
%************************************************************************

\begin{code}
sof's avatar
sof committed
844
-- ---------------------------------------------------------------------------
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
-- Unloading old objects ready for a new compilation sweep.
--
-- The compilation manager provides us with a list of linkables that it
-- considers "stable", i.e. won't be recompiled this time around.  For
-- each of the modules current linked in memory,
--
--	* if the linkable is stable (and it's the same one - the
--	  user may have recompiled the module on the side), we keep it,
--
--	* otherwise, we unload it.
--
--      * we also implicitly unload all temporary bindings at this point.

unload :: DynFlags -> [Linkable] -> IO ()
-- The 'linkables' are the ones to *keep*

unload dflags linkables
  = block $ do -- block, so we're safe from Ctrl-C in here
863 864 865
  
	-- Initialise the linker (if it's not been done already)
	initDynLinker dflags
sof's avatar
sof committed
866

867 868 869
	pls	<- readIORef v_PersistentLinkerState
	new_pls <- unload_wkr dflags linkables pls
	writeIORef v_PersistentLinkerState new_pls
870

871 872 873
	debugTraceMsg dflags 3 (text "unload: retaining objs" <+> ppr (objs_loaded new_pls))
	debugTraceMsg dflags 3 (text "unload: retaining bcos" <+> ppr (bcos_loaded new_pls))
	return ()
874

875 876 877 878 879 880
unload_wkr :: DynFlags
           -> [Linkable]		-- stable linkables
	   -> PersistentLinkerState
           -> IO PersistentLinkerState
-- Does the core unload business
-- (the wrapper blocks exceptions and deals with the PLS get and put)
881

Ian Lynagh's avatar
Ian Lynagh committed
882
unload_wkr _ linkables pls
883 884 885 886 887
  = do	let (objs_to_keep, bcos_to_keep) = partition isObjectLinkable linkables

	objs_loaded' <- filterM (maybeUnload objs_to_keep) (objs_loaded pls)
        bcos_loaded' <- filterM (maybeUnload bcos_to_keep) (bcos_loaded pls)

888
       	let bcos_retained = map linkableModule bcos_loaded'
889 890 891 892 893 894 895 896 897 898 899
	    itbl_env'     = filterNameMap bcos_retained (itbl_env pls)
            closure_env'  = filterNameMap bcos_retained (closure_env pls)
  	    new_pls = pls { itbl_env = itbl_env',
			    closure_env = closure_env',
			    bcos_loaded = bcos_loaded',
			    objs_loaded = objs_loaded' }

	return new_pls
  where
    maybeUnload :: [Linkable] -> Linkable -> IO Bool
    maybeUnload keep_linkables lnk
900
      | linkableInSet lnk keep_linkables = return True
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
      | otherwise		    
      = do mapM_ unloadObj [f | DotO f <- linkableUnlinked lnk]
		-- The components of a BCO linkable may contain
		-- dot-o files.  Which is very confusing.
		--
		-- But the BCO parts can be unlinked just by 
		-- letting go of them (plus of course depopulating
		-- the symbol table which is done in the main body)
	   return False
\end{code}


%************************************************************************
%*									*
		Loading packages
%*									*
%************************************************************************


\begin{code}
data LibrarySpec 
   = Object FilePath 	-- Full path name of a .o file, including trailing .o
			-- For dynamic objects only, try to find the object 
			-- file in all the directories specified in 
			-- v_Library_paths before giving up.

   | DLL String		-- "Unadorned" name of a .DLL/.so
			--  e.g.    On unix     "qt"  denotes "libqt.so"
			--          On WinDoze  "burble"  denotes "burble.DLL"
			--  loadDLL is platform-specific and adds the lib/.so/.DLL
			--  suffixes platform-dependently
932

933 934 935
   | DLLPath FilePath   -- Absolute or relative pathname to a dynamic library
			-- (ends with .dll or .so).

936
   | Framework String	-- Only used for darwin, but does no harm
937 938 939 940 941 942 943 944 945 946

-- 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
-- load them again.
-- 
-- But on Win32 we must load them 'again'; doing so is a harmless no-op
-- as far as the loader is concerned, but it does initialise the list
-- 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.
Ian Lynagh's avatar
Ian Lynagh committed
947
partOfGHCi :: [String]
948
partOfGHCi
Ian Lynagh's avatar
Ian Lynagh committed
949 950
 | isWindowsTarget || isDarwinTarget = []
 | otherwise = [ "base", "haskell98", "template-haskell", "editline" ]
951

Ian Lynagh's avatar
Ian Lynagh committed
952
showLS :: LibrarySpec -> String
953 954
showLS (Object nm)    = "(static) " ++ nm
showLS (DLL nm)       = "(dynamic) " ++ nm
955
showLS (DLLPath nm)   = "(dynamic) " ++ nm
956 957
showLS (Framework nm) = "(framework) " ++ nm

958
linkPackages :: DynFlags -> [PackageId] -> IO ()
959 960 961 962
-- Link exactly the specified packages, and their dependents
-- (unless of course they are already linked)
-- The dependents are linked automatically, and it doesn't matter
-- what order you specify the input packages.
963 964 965 966 967 968 969
--
-- NOTE: in fact, since each module tracks all the packages it depends on,
--	 we don't really need to use the package-config dependencies.
-- However we do need the package-config stuff (to find aux libs etc),
-- and following them lets us load libraries in the right order, which 
-- perhaps makes the error message a bit more localised if we get a link
-- failure.  So the dependency walking code is still here.
970 971 972

linkPackages dflags new_pkgs
   = do	{ pls 	  <- readIORef v_PersistentLinkerState
973
	; let pkg_map = pkgIdMap (pkgState dflags)
974 975 976 977 978 979

	; pkgs' <- link pkg_map (pkgs_loaded pls) new_pkgs

	; writeIORef v_PersistentLinkerState (pls { pkgs_loaded = pkgs' })
	}
   where
980
     link :: PackageConfigMap -> [PackageId] -> [PackageId] -> IO [PackageId]
981 982 983 984 985 986 987
     link pkg_map pkgs new_pkgs 
	= foldM (link_one pkg_map) pkgs new_pkgs

     link_one pkg_map pkgs new_pkg
	| new_pkg `elem` pkgs	-- Already linked
	= return pkgs

988
	| Just pkg_cfg <- lookupPackage pkg_map new_pkg
989
	= do { 	-- Link dependents first
990
	       pkgs' <- link pkg_map pkgs (map mkPackageId (depends pkg_cfg))
991 992 993 994 995
		-- Now link the package itself
	     ; linkPackage dflags pkg_cfg
	     ; return (new_pkg : pkgs') }

	| otherwise
996
	= throwDyn (CmdLineError ("unknown package: " ++ packageIdString new_pkg))
997 998 999 1000 1001


linkPackage :: DynFlags -> PackageConfig -> IO ()
linkPackage dflags pkg
   = do 
1002
        let dirs      =  Packages.libraryDirs pkg
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015

        let libs      =  Packages.hsLibraries pkg
        -- Because of slight differences between the GHC dynamic linker and
        -- the native system linker some packages have to link with a
        -- different list of libraries when using GHCi. Examples include: libs
        -- that are actually gnu ld scripts, and the possability that the .a
        -- libs do not exactly match the .so/.dll equivalents. So if the
        -- package file provides an "extra-ghci-libraries" field then we use
        -- that instead of the "extra-libraries" field.
                      ++ (if null (Packages.extraGHCiLibraries pkg)
                            then Packages.extraLibraries pkg
                            else Packages.extraGHCiLibraries pkg)
                      ++ [ lib | '-':'l':lib <- Packages.ldOptions pkg ]
1016 1017 1018 1019 1020 1021
        classifieds   <- mapM (locateOneObj dirs) libs

        -- Complication: all the .so's must be loaded before any of the .o's.  
	let dlls = [ dll | DLL dll    <- classifieds ]
	    objs = [ obj | Object obj <- classifieds ]

1022
	maybePutStr dflags ("Loading package " ++ display (package pkg) ++ " ... ")
1023 1024

	-- See comments with partOfGHCi
1025
	when (pkgName (package pkg) `notElem` partOfGHCi) $ do
1026
	    loadFrameworks pkg
1027 1028 1029 1030 1031 1032 1033
            -- 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.
1034 1035
	    -- This fixes a problem with the HOpenGL package (see "Compiling
	    -- HOpenGL under recent versions of GHC" on the HOpenGL list).
1036
	    mapM_ (load_dyn dirs) (reverse dlls)
1037 1038
	
	-- After loading all the DLLs, we can load the static objects.
1039 1040
	-- Ordering isn't important here, because we do one final link
	-- step to resolve everything.
1041 1042 1043 1044 1045
	mapM_ loadObj objs

        maybePutStr dflags "linking ... "
        ok <- resolveObjs
	if succeeded ok then maybePutStrLn dflags "done."
1046
	      else throwDyn (InstallationError ("unable to load package `" ++ display (package pkg) ++ "'"))
1047

Ian Lynagh's avatar
Ian Lynagh committed
1048
load_dyn :: [FilePath] -> FilePath -> IO ()
1049 1050 1051 1052 1053
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 ++ ")" ))
Ian Lynagh's avatar
Ian Lynagh committed
1054

Ian Lynagh's avatar
Ian Lynagh committed
1055
loadFrameworks :: InstalledPackageInfo_ ModuleName -> IO ()
Ian Lynagh's avatar
Ian Lynagh committed
1056 1057 1058
loadFrameworks pkg
 | isDarwinTarget = mapM_ load frameworks
 | otherwise = return ()
1059
  where
1060
    fw_dirs    = Packages.frameworkDirs pkg
ross's avatar
ross committed
1061
    frameworks = Packages.frameworks pkg
1062 1063 1064 1065 1066 1067

    load fw = do  r <- loadFramework fw_dirs fw
		  case r of
		    Nothing  -> return ()
		    Just err -> throwDyn (CmdLineError ("can't load framework: " 
                               			        ++ fw ++ " (" ++ err ++ ")" ))
1068 1069 1070 1071 1072

-- Try to find an object file for a given library in the given paths.
-- If it isn't present, we assume it's a dynamic library.
locateOneObj :: [FilePath] -> String -> IO LibrarySpec
locateOneObj dirs lib
Ian Lynagh's avatar
Ian Lynagh committed
1073 1074 1075
 | not picIsOn
    -- When the GHC package was not compiled as dynamic library 
    -- (=__PIC__ not set), we search for .o libraries first.
1076 1077 1078
  = do	{ mb_obj_path <- findFile mk_obj_path dirs 
	; case mb_obj_path of
	    Just obj_path -> return (Object obj_path)
1079 1080 1081
	    Nothing	  -> 
                do { mb_lib_path <- findFile mk_dyn_lib_path dirs
                   ; case mb_lib_path of
Ian Lynagh's avatar
Ian Lynagh committed
1082 1083
                       Just _  -> return (DLL (lib ++ "-ghc" ++ cProjectVersion))
                       Nothing -> return (DLL lib) }} -- We assume
Ian Lynagh's avatar
Ian Lynagh committed
1084 1085 1086
 | otherwise
    -- When the GHC package was compiled as dynamic library (=__PIC__ set),
    -- we search for .so libraries first.
1087 1088
  = do	{ mb_lib_path <- findFile mk_dyn_lib_path dirs
	; case mb_lib_path of
Ian Lynagh's avatar
Ian Lynagh committed
1089
	    Just _ -> return (DLL (lib ++ "-ghc" ++ cProjectVersion))
1090 1091 1092 1093 1094 1095
	    Nothing	  ->
                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
   where
Ian Lynagh's avatar
Ian Lynagh committed
1096 1097
     mk_obj_path dir = dir </> (lib <.> "o")
     mk_dyn_lib_path dir = dir </> mkSOName (lib ++ "-ghc" ++ cProjectVersion)
1098 1099 1100 1101 1102

-- ----------------------------------------------------------------------------
-- Loading a dyanmic library (dlopen()-ish on Unix, LoadLibrary-ish on Win32)

-- return Nothing == success, else Just error message from dlopen
Ian Lynagh's avatar
Ian Lynagh committed
1103
loadDynamic :: [FilePath] -> FilePath -> IO (Maybe String)
1104 1105 1106 1107 1108 1109 1110 1111
loadDynamic paths rootname
  = do	{ mb_dll <- findFile mk_dll_path paths
	; case mb_dll of
	    Just dll -> loadDLL dll
	    Nothing  -> loadDLL (mkSOName rootname) }
			-- Tried all our known library paths, so let 
			-- dlopen() search its own builtin paths now.
  where
Ian Lynagh's avatar
Ian Lynagh committed
1112
    mk_dll_path dir = dir </> mkSOName rootname
1113

Ian Lynagh's avatar
Ian Lynagh committed
1114
mkSOName :: FilePath -> FilePath
Ian Lynagh's avatar
Ian Lynagh committed
1115 1116 1117 1118 1119 1120
mkSOName root
 | isDarwinTarget  = ("lib" ++ root) <.> "dylib"
 | isWindowsTarget = -- Win32 DLLs have no .dll extension here, because
                     -- addDLL tries both foo.dll and foo.drv
                     root
 | otherwise       = ("lib" ++ root) <.> "so"
1121 1122 1123 1124

-- Darwin / MacOS X only: load a framework
-- a framework is a dynamic library packaged inside a directory of the same
-- name. They are searched for in different paths than normal libraries.
Ian Lynagh's avatar
Ian Lynagh committed
1125
loadFramework :: [FilePath] -> FilePath -> IO (Maybe String)
1126
loadFramework extraPaths rootname
1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137
   = do { either_dir <- Control.Exception.try getHomeDirectory
        ; let homeFrameworkPath = case either_dir of
                                  Left _ -> []
                                  Right dir -> [dir ++ "/Library/Frameworks"]
              ps = extraPaths ++ homeFrameworkPath ++ defaultFrameworkPaths
        ; mb_fwk <- findFile mk_fwk ps
        ; case mb_fwk of
            Just fwk_path -> loadDLL fwk_path
            Nothing       -> return (Just "not found") }
                -- Tried all our known library paths, but dlopen()
                -- has no built-in paths for frameworks: give up
1138
   where
Ian Lynagh's avatar
Ian Lynagh committed
1139
     mk_fwk dir = dir </> (rootname ++ ".framework/" ++ rootname)
1140
        -- sorry for the hardcoded paths, I hope they won't change anytime soon:
1141
     defaultFrameworkPaths = ["/Library/Frameworks", "/System/Library/Frameworks"]
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
\end{code}

%************************************************************************
%*									*
		Helper functions
%*									*
%************************************************************************

\begin{code}
findFile :: (FilePath -> FilePath)	-- Maps a directory path to a file path
	 -> [FilePath]			-- Directories to look in
	 -> IO (Maybe FilePath)		-- The first file path to match
Ian Lynagh's avatar
Ian Lynagh committed
1154
findFile _ [] 
1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
  = return Nothing
findFile mk_file_path (dir:dirs)
  = do	{ let file_path = mk_file_path dir
	; b <- doesFileExist file_path
	; if b then 
	     return (Just file_path)
	  else
	     findFile mk_file_path dirs }
\end{code}

\begin{code}
Ian Lynagh's avatar
Ian Lynagh committed
1166
maybePutStr :: DynFlags -> String -> IO ()
1167 1168
maybePutStr dflags s | verbosity dflags > 0 = putStr s
		     | otherwise	    = return ()
1169

Ian Lynagh's avatar
Ian Lynagh committed
1170
maybePutStrLn :: DynFlags -> String -> IO ()
1171 1172
maybePutStrLn dflags s | verbosity dflags > 0 = putStrLn s
		       | otherwise	      = return ()
1173
\end{code}