Linker.lhs 42.2 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

17 18 19
{-# OPTIONS -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

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

28
#include "HsVersions.h"
29

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

-- Standard libraries
67
import Control.Monad
68

69
import Data.Char
70 71
import Data.IORef
import Data.List
72
import Foreign
73

Ian Lynagh's avatar
Ian Lynagh committed
74
import System.FilePath
75 76
import System.IO
import System.Directory
77

Ian Lynagh's avatar
Ian Lynagh committed
78 79
import Distribution.Package hiding (depends)

80 81
import Control.Exception
import Data.Maybe
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
\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}
99 100
GLOBAL_VAR(v_PersistentLinkerState, panic "Dynamic linker not initialised", PersistentLinkerState)
GLOBAL_VAR(v_InitLinkerDone, False, Bool)	-- Set True when dynamic linker is initialised
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123

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
124
	pkgs_loaded :: [PackageId]
125 126
     }

127
emptyPLS :: DynFlags -> PersistentLinkerState
Ian Lynagh's avatar
Ian Lynagh committed
128
emptyPLS _ = PersistentLinkerState { 
129 130 131 132
			closure_env = emptyNameEnv,
			itbl_env    = emptyNameEnv,
			pkgs_loaded = init_pkgs,
			bcos_loaded = [],
133 134
			objs_loaded = [] }
                    
135 136 137 138 139
  -- 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
140
  where init_pkgs = [rtsPackageId]
141 142 143
\end{code}

\begin{code}
144 145 146 147
extendLoadedPkgs :: [PackageId] -> IO ()
extendLoadedPkgs pkgs
    = modifyIORef v_PersistentLinkerState (\s -> s{pkgs_loaded = pkgs ++ pkgs_loaded s})

148 149 150 151 152 153 154 155
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

156 157 158 159 160 161 162
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

163 164 165 166
-- | 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:
167 168 169 170 171
--
--    Package:Module.Name
--
--   We use this string to lookup the interpreter's internal representation of the name
--   using the lookupOrig.    
172

173
dataConInfoPtrToName :: Ptr () -> TcM (Either String Name)
174
dataConInfoPtrToName x = do 
twanvl's avatar
twanvl committed
175
   theString <- liftIO $ do
176
      let ptr = castPtr x :: Ptr StgInfoTable
177
      conDescAddress <- getConDescAddress ptr 
178
      peekArray0 0 conDescAddress  
179
   let (pkg, mod, occ) = parse theString 
180 181 182 183 184
       pkgFS = mkFastStringByteList pkg
       modFS = mkFastStringByteList mod
       occFS = mkFastStringByteList occ
       occName = mkOccNameFS OccName.dataName occFS
       modName = mkModule (fsToPackageId pkgFS) (mkModuleNameFS modFS) 
185 186
   return (Left$ showSDoc$ ppr modName <> dot <> ppr occName ) 
    `recoverM` (Right `fmap` lookupOrig modName occName)
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 225 226 227 228 229

   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
   -}

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

   -- 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.
245
   parse :: [Word8] -> ([Word8], [Word8], [Word8])
246 247 248
   parse input 
      = ASSERT (all (>0) (map length [pkg, mod, occ])) (pkg, mod, occ)
      where
249 250
      dot = fromIntegral (ord '.')
      (pkg, rest1) = break (== fromIntegral (ord ':')) input 
251
      (mod, occ) 
252
         = (concat $ intersperse [dot] $ reverse modWords, occWord)
253 254
         where
         (modWords, occWord) = ASSERT (length rest1 > 0) (parseModOcc [] (tail rest1))
255
      parseModOcc :: [[Word8]] -> [Word8] -> ([[Word8]], [Word8])
256
      parseModOcc acc str
257
         = case break (== dot) str of
258
              (top, []) -> (acc, top)
259
              (top, _:bot) -> parseModOcc (top : acc) bot
260
       
261

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
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

289

290 291
-- | Temporarily extend the linker state.

292 293
withExtendedLinkEnv :: [(Name,HValue)] -> IO a -> IO a
withExtendedLinkEnv new_env action
294 295 296
    = bracket_ set_new_env
               reset_old_env
               action
297 298 299 300 301
    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
302
            return ()
303 304 305 306 307 308

        -- 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.
309
          reset_old_env = do
310 311 312 313 314
            modifyIORef v_PersistentLinkerState $ \pls ->
                let cur = closure_env pls
                    new = delListFromNameEnv cur (map fst new_env)
                in
                pls{ closure_env = new }
315

316 317 318 319 320 321
-- 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

322
filterNameMap :: [Module] -> NameEnv (Name, a) -> NameEnv (Name, a)
323 324 325 326
filterNameMap mods env 
   = filterNameEnv keep_elt env
   where
     keep_elt (n,_) = isExternalName n 
327
		      && (nameModule n `elem` mods)
328 329 330 331 332 333 334 335 336 337 338
\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),
339
			text "BCOs:" <+> ppr (bcos_loaded pls)])
340 341 342 343
\end{code}
			
	

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

%************************************************************************
%*									*
\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}
366
initDynLinker :: DynFlags -> IO ()
367 368
-- 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
369
initDynLinker dflags
370 371 372
  = do	{ done <- readIORef v_InitLinkerDone
	; if done then return () 
		  else do { writeIORef v_InitLinkerDone True
373
			  ; reallyInitDynLinker dflags }
374 375
	}

Ian Lynagh's avatar
Ian Lynagh committed
376
reallyInitDynLinker :: DynFlags -> IO ()
377 378 379
reallyInitDynLinker dflags
  = do  {  -- Initialise the linker state
	; writeIORef v_PersistentLinkerState (emptyPLS dflags)
380 381 382 383 384

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

		-- (b) Load packages from the command-line
385
	; linkPackages dflags (preloadPackages (pkgState dflags))
386 387

	   	-- (c) Link libraries from the command-line
388 389
	; let optl = getOpts dflags opt_l
	; let minus_ls = [ lib | '-':'l':lib <- optl ]
390 391

	   	-- (d) Link .o files from the command-line
392
	; let lib_paths = libraryPaths dflags
393 394
	; cmdline_ld_inputs <- readIORef v_Ld_inputs

395
	; classified_ld_inputs <- mapM classifyLdInput cmdline_ld_inputs
396 397

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

419 420 421 422 423 424 425
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
426

427 428 429 430 431 432 433 434 435 436 437 438 439 440
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
441 442 443 444 445 446 447

	  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

448
	  Framework framework
Ian Lynagh's avatar
Ian Lynagh committed
449
           | isDarwinTarget
450 451 452 453
             -> 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
454 455
           | otherwise -> panic "preloadLib Framework"

456 457 458 459 460 461 462 463 464 465 466
  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
467
    preload_static _paths name
468 469 470 471 472 473 474 475 476
       = 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}


477 478 479 480 481 482 483
%************************************************************************
%*									*
		Link a byte-code expression
%*									*
%************************************************************************

\begin{code}
484
linkExpr :: HscEnv -> SrcSpan -> UnlinkedBCO -> IO HValue
485 486 487 488 489 490

-- 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.
491 492
--
-- Note: This function side-effects the linker state (Pepe)
493

494
linkExpr hsc_env span root_ul_bco
495
  = do {  
496
	-- Initialise the linker (if it's not been done already)
497 498
     let dflags = hsc_dflags hsc_env
   ; initDynLinker dflags
499

500
	-- Link the packages and modules required
501
   ; ok <- linkDependencies hsc_env span needed_mods
502
   ; if failed ok then
503
	throwDyn (ProgramError "")
504 505 506 507 508 509 510 511
     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
512
   ; (_, (root_hval:_)) <- linkSomeBCOs False ie ce [root_ul_bco]
513
   ; return root_hval
514
   }}
515
   where
516 517
     free_names = nameSetToList (bcoFreeNames root_ul_bco)

518
     needed_mods :: [Module]
519 520 521 522 523 524 525 526
     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.
527
 
Ian Lynagh's avatar
Ian Lynagh committed
528
dieWith :: SrcSpan -> Message -> IO a
529 530 531 532 533 534 535 536 537 538 539 540
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
541
failNonStd :: SrcSpan -> IO (Maybe String)
542
failNonStd srcspan = dieWith srcspan $
Ian Lynagh's avatar
Ian Lynagh committed
543 544 545
  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.")
546
  
547

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

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

561
	let {
562 563
	-- 2.  Exclude ones already linked
	--	Main reason: avoid findModule calls in get_linkable
Simon Marlow's avatar
Simon Marlow committed
564 565
	    mods_needed = mods_s `minusList` linked_mods     ;
	    pkgs_needed = pkgs_s `minusList` pkgs_loaded pls ;
566

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

577
	return (lnks_needed, pkgs_needed) }
578
  where
Simon Marlow's avatar
Simon Marlow committed
579 580 581
    dflags = hsc_dflags hsc_env
    this_pkg = thisPackage dflags

Simon Marlow's avatar
Simon Marlow committed
582 583 584 585 586 587 588 589
        -- 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
590
                -> IO ([ModuleName], [PackageId]) -- result
Simon Marlow's avatar
Simon Marlow committed
591
    follow_deps []     acc_mods acc_pkgs
592
        = return (uniqSetToList acc_mods, uniqSetToList acc_pkgs)
Simon Marlow's avatar
Simon Marlow committed
593
    follow_deps (mod:mods) acc_mods acc_pkgs
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
        = 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
623 624 625 626 627 628


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

630
    no_obj mod = dieWith span $
Ian Lynagh's avatar
Ian Lynagh committed
631
		     ptext (sLit "cannot find object file for module ") <> 
632 633 634
			quotes (ppr mod) $$
		     while_linking_expr
		
Ian Lynagh's avatar
Ian Lynagh committed
635
    while_linking_expr = ptext (sLit "while linking an interpreted expression")
636

637 638
	-- This one is a build-system bug

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

	    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
667
		let new_file = replaceExtension file osuf
668 669 670
		ok <- doesFileExist new_file
		if (not ok)
		   then dieWith span $
Ian Lynagh's avatar
Ian Lynagh committed
671
			  ptext (sLit "cannot find normal object file ")
672 673
				<> quotes (text new_file) $$ while_linking_expr
		   else return (DotO new_file)
Ian Lynagh's avatar
Ian Lynagh committed
674
	    adjust_ul _ _ = panic "adjust_ul"
675
\end{code}
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 707 708 709 710 711


%************************************************************************
%*									*
		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
712 713 714
            (_:_, _:_) -> [li {linkableUnlinked=li_uls_obj},
                           li {linkableUnlinked=li_uls_bco}]
            _ -> [li]
715

716
findModuleLinkable_maybe :: [Linkable] -> Module -> Maybe Linkable
717 718 719 720
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
721
        _    -> pprPanic "findModuleLinkable" (ppr mod)
722 723 724

linkableInSet :: Linkable -> [Linkable] -> Bool
linkableInSet l objs_loaded =
725
  case findModuleLinkable_maybe objs_loaded (linkableModule l) of
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 799 800 801 802 803
	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
804 805
        (final_gce, _linked_bcos) <- linkSomeBCOs True final_ie gce ul_bcos
		-- XXX What happens to these linked_bcos?
806 807 808 809 810 811 812 813 814 815 816 817 818

	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]
819
             -> IO (ClosureEnv, [HValue])
820 821 822 823
			-- The returned HValues are associated 1-1 with
			-- the incoming unlinked BCOs.  Each gives the
			-- value of the corresponding unlinked BCO
					
824
linkSomeBCOs toplevs_only ie ce_in ul_bcos
825
   = do let nms = map unlinkedBCOName ul_bcos
826 827 828 829 830 831 832 833 834 835 836
        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
837
        return (ce_out, hvals)
838

839 840 841 842 843 844 845 846 847 848
\end{code}


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

\begin{code}
sof's avatar
sof committed
849
-- ---------------------------------------------------------------------------
850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867
-- 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
868 869 870
  
	-- Initialise the linker (if it's not been done already)
	initDynLinker dflags
sof's avatar
sof committed
871

872 873 874
	pls	<- readIORef v_PersistentLinkerState
	new_pls <- unload_wkr dflags linkables pls
	writeIORef v_PersistentLinkerState new_pls
875

876 877 878
	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 ()
879

880 881 882 883 884 885
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)
886

Ian Lynagh's avatar
Ian Lynagh committed
887
unload_wkr _ linkables pls
888 889 890 891 892
  = 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)

893
       	let bcos_retained = map linkableModule bcos_loaded'
894 895 896 897 898 899 900 901 902 903 904
	    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
905
      | linkableInSet lnk keep_linkables = return True
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 932 933 934 935 936
      | 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
937

938 939 940
   | DLLPath FilePath   -- Absolute or relative pathname to a dynamic library
			-- (ends with .dll or .so).

941
   | Framework String	-- Only used for darwin, but does no harm
942 943 944 945 946 947 948 949 950 951

-- 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
952
partOfGHCi :: [PackageName]
953
partOfGHCi
Ian Lynagh's avatar
Ian Lynagh committed
954
 | isWindowsTarget || isDarwinTarget = []
Ian Lynagh's avatar
Ian Lynagh committed
955 956
 | otherwise = map PackageName
                   ["base", "haskell98", "template-haskell", "editline"]
957

Ian Lynagh's avatar
Ian Lynagh committed
958
showLS :: LibrarySpec -> String
959 960
showLS (Object nm)    = "(static) " ++ nm
showLS (DLL nm)       = "(dynamic) " ++ nm
961
showLS (DLLPath nm)   = "(dynamic) " ++ nm
962 963
showLS (Framework nm) = "(framework) " ++ nm

964
linkPackages :: DynFlags -> [PackageId] -> IO ()
965 966 967 968
-- 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.
969 970 971 972 973 974 975
--
-- 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.
976 977 978

linkPackages dflags new_pkgs
   = do	{ pls 	  <- readIORef v_PersistentLinkerState
979
	; let pkg_map = pkgIdMap (pkgState dflags)
980 981 982 983 984 985

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

	; writeIORef v_PersistentLinkerState (pls { pkgs_loaded = pkgs' })
	}
   where
986
     link :: PackageConfigMap -> [PackageId] -> [PackageId] -> IO [PackageId]
987 988 989 990 991 992 993
     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

994
	| Just pkg_cfg <- lookupPackage pkg_map new_pkg
995
	= do { 	-- Link dependents first
996
	       pkgs' <- link pkg_map pkgs (map mkPackageId (depends pkg_cfg))
997 998 999 1000 1001
		-- Now link the package itself
	     ; linkPackage dflags pkg_cfg
	     ; return (new_pkg : pkgs') }

	| otherwise
1002
	= throwDyn (CmdLineError ("unknown package: " ++ packageIdString new_pkg))
1003 1004 1005 1006 1007


linkPackage :: DynFlags -> PackageConfig -> IO ()
linkPackage dflags pkg
   = do 
1008
        let dirs      =  Packages.libraryDirs pkg
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

        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 ]
1022 1023 1024 1025 1026 1027
        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 ]

1028
	maybePutStr dflags ("Loading package " ++ display (package pkg) ++ " ... ")
1029 1030

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

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

Ian Lynagh's avatar
Ian Lynagh committed
1054
load_dyn :: [FilePath] -> FilePath -> IO ()
1055 1056 1057 1058 1059
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
1060

Ian Lynagh's avatar
Ian Lynagh committed
1061
loadFrameworks :: InstalledPackageInfo_ ModuleName -> IO ()
Ian Lynagh's avatar
Ian Lynagh committed
1062 1063 1064
loadFrameworks pkg
 | isDarwinTarget = mapM_ load frameworks
 | otherwise = return ()
1065
  where
1066
    fw_dirs    = Packages.frameworkDirs pkg
ross's avatar
ross committed
1067
    frameworks = Packages.frameworks pkg
1068 1069 1070 1071 1072 1073

    load fw = do  r <- loadFramework fw_dirs fw
		  case r of
		    Nothing  -> return ()
		    Just err -> throwDyn (CmdLineError ("can't load framework: " 
                               			        ++ fw ++ " (" ++ err ++ ")" ))
1074 1075 1076 1077 1078

-- 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
1079 1080 1081
 | not picIsOn
    -- When the GHC package was not compiled as dynamic library 
    -- (=__PIC__ not set), we search for .o libraries first.
1082 1083 1084
  = do	{ mb_obj_path <- findFile mk_obj_path dirs 
	; case mb_obj_path of
	    Just obj_path -> return (Object obj_path)
1085 1086 1087
	    Nothing	  -> 
                do { mb_lib_path <- findFile mk_dyn_lib_path dirs
                   ; case mb_lib_path of
Simon Marlow's avatar
Simon Marlow committed
1088
                       Just _  -> return (DLL dyn_lib_name)
Ian Lynagh's avatar
Ian Lynagh committed
1089
                       Nothing -> return (DLL lib) }} -- We assume
Ian Lynagh's avatar
Ian Lynagh committed
1090 1091 1092
 | otherwise
    -- When the GHC package was compiled as dynamic library (=__PIC__ set),
    -- we search for .so libraries first.
1093 1094
  = do	{ mb_lib_path <- findFile mk_dyn_lib_path dirs
	; case mb_lib_path of
Ian Lynagh's avatar
Ian Lynagh committed
1095
	    Just _ -> return (DLL (lib ++ "-ghc" ++ cProjectVersion))
1096 1097 1098 1099 1100 1101
	    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
1102
     mk_obj_path dir = dir </> (lib <.> "o")
Simon Marlow's avatar
Simon Marlow committed
1103 1104
     dyn_lib_name = lib ++ "-ghc" ++ cProjectVersion
     mk_dyn_lib_path dir = dir </> mkSOName dyn_lib_name
1105 1106 1107 1108 1109

-- ----------------------------------------------------------------------------
-- 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
1110
loadDynamic :: [FilePath] -> FilePath -> IO (Maybe String)
1111 1112 1113 1114 1115 1116 1117 1118
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
1119
    mk_dll_path dir = dir </> mkSOName rootname
1120

Ian Lynagh's avatar
Ian Lynagh committed
1121
mkSOName :: FilePath -> FilePath
Ian Lynagh's avatar
Ian Lynagh committed
1122 1123 1124 1125 1126 1127
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"
1128 1129 1130 1131

-- 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
1132
loadFramework :: [FilePath] -> FilePath -> IO (Maybe String)
1133
loadFramework extraPaths rootname
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
   = 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
1145
   where
Ian Lynagh's avatar
Ian Lynagh committed
1146
     mk_fwk dir = dir </> (rootname ++ ".framework/" ++ rootname)
1147
        -- sorry for the hardcoded paths, I hope they won't change anytime soon:
1148
     defaultFrameworkPaths = ["/Library/Frameworks", "/System/Library/Frameworks"]
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
\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
1161
findFile _ [] 
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
  = 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
1173
maybePutStr :: DynFlags -> String -> IO ()
1174 1175
maybePutStr dflags s | verbosity dflags > 0 = putStr s
		     | otherwise	    = return ()
1176

Ian Lynagh's avatar
Ian Lynagh committed
1177
maybePutStrLn :: DynFlags -> String -> IO ()
1178 1179
maybePutStrLn dflags s | verbosity dflags > 0 = putStrLn s
		       | otherwise	      = return ()
1180
\end{code}