2 % (c) The University of Glasgow, 2000
4 \section{Package manipulation}
10 -- * The PackageConfigMap
11 PackageConfigMap, emptyPackageConfigMap, lookupPackage,
12 extendPackageConfigMap, dumpPackages,
14 -- * Reading the package config, and processing cmdline args
15 PackageIdH(..), isHomePackage,
18 moduleToPackageConfig,
22 -- * Inspecting the set of packages in scope
23 getPackageIncludePath,
25 getPackageLibraryPath,
27 getPackageExtraCcOpts,
28 getPackageFrameworkPath,
30 getExplicitPackagesAnd,
37 #include "HsVersions.h"
40 import SysTools ( getTopDir, getPackageConfigPath )
41 import ParsePkgConf ( loadPackageConfig )
42 import DynFlags ( dopt, DynFlag(..), DynFlags(..), PackageFlag(..) )
43 import StaticFlags ( opt_Static )
44 import Config ( cProjectVersion )
45 import Name ( Name, nameModule_maybe )
46 import Module ( Module, mkModule )
53 #if __GLASGOW_HASKELL__ >= 603
54 import System.Directory ( getAppUserDataDirectory )
56 import Compat.Directory ( getAppUserDataDirectory )
59 import Distribution.InstalledPackageInfo
60 import Distribution.Package
61 import Distribution.Version
62 import System.IO ( hPutStrLn, stderr )
63 import Data.Maybe ( fromJust, isNothing )
64 import System.Directory ( doesFileExist )
65 import Control.Monad ( when, foldM )
66 import Data.List ( nub, partition )
68 #ifdef mingw32_TARGET_OS
69 import Data.List ( isPrefixOf )
74 import EXCEPTION ( throwDyn )
76 -- ---------------------------------------------------------------------------
79 -- Package state is all stored in DynFlags, including the details of
80 -- all packages, which packages are exposed, and which modules they
83 -- The package state is computed by initPackages, and kept in DynFlags.
85 -- * -package <pkg> causes <pkg> to become exposed, and all other packages
86 -- with the same name to become hidden.
88 -- * -hide-package <pkg> causes <pkg> to become hidden.
90 -- * Let exposedPackages be the set of packages thus exposed.
91 -- Let depExposedPackages be the transitive closure from exposedPackages of
92 -- their dependencies.
94 -- * It is an error for any two packages in depExposedPackages to provide the
97 -- * When searching for a module from an explicit import declaration,
98 -- only the exposed modules in exposedPackages are valid.
100 -- * When searching for a module from an implicit import, all modules
101 -- from depExposedPackages are valid.
103 -- * When linking in a comp manager mode, we link in packages the
104 -- program depends on (the compiler knows this list by the
105 -- time it gets to the link step). Also, we link in all packages
106 -- which were mentioned with explicit -package flags on the command-line,
107 -- or are a transitive dependency of same, or are "base"/"rts".
108 -- The reason for (b) is that we might need packages which don't
109 -- contain any Haskell modules, and therefore won't be discovered
110 -- by the normal mechanism of dependency tracking.
113 -- One important thing that the package state provides is a way to
114 -- tell, for a given module, whether it is part of the current package
115 -- or not. We need to know this for two reasons:
117 -- * generating cross-DLL calls is different from intra-DLL calls
119 -- * we don't record version information in interface files for entities
120 -- in a different package.
124 -- When compiling module A, which imports module B, we need to
125 -- know whether B will be in the same DLL as A.
126 -- If it's in the same DLL, we refer to B_f_closure
127 -- If it isn't, we refer to _imp__B_f_closure
128 -- When compiling A, we record in B's Module value whether it's
129 -- in a different DLL, by setting the DLL flag.
131 data PackageState = PackageState {
133 explicitPackages :: [PackageId],
134 -- The packages we're going to link in eagerly. This list
135 -- should be in reverse dependency order; that is, a package
136 -- is always mentioned before the packages it depends on.
138 pkgIdMap :: PackageConfigMap, -- PackageId -> PackageConfig
139 -- mapping derived from the package databases and
140 -- command-line package flags.
142 moduleToPkgConf :: UniqFM (PackageConfig,Bool),
143 -- Maps Module to (pkgconf,exposed), where pkgconf is the
144 -- PackageConfig for the package containing the module, and
145 -- exposed is True if the package exposes that module.
147 -- The PackageIds of some known packages
148 basePackageId :: PackageIdH,
149 rtsPackageId :: PackageIdH,
150 haskell98PackageId :: PackageIdH,
151 thPackageId :: PackageIdH
155 = HomePackage -- The "home" package is the package curently
157 | ExtPackage PackageId -- An "external" package is any other package
160 isHomePackage :: PackageIdH -> Bool
161 isHomePackage HomePackage = True
162 isHomePackage (ExtPackage _) = False
164 -- A PackageConfigMap maps a PackageId to a PackageConfig
165 type PackageConfigMap = UniqFM PackageConfig
167 emptyPackageConfigMap :: PackageConfigMap
168 emptyPackageConfigMap = emptyUFM
170 lookupPackage :: PackageConfigMap -> PackageId -> Maybe PackageConfig
171 lookupPackage = lookupUFM
173 extendPackageConfigMap
174 :: PackageConfigMap -> [PackageConfig] -> PackageConfigMap
175 extendPackageConfigMap pkg_map new_pkgs
176 = foldl add pkg_map new_pkgs
177 where add pkg_map p = addToUFM pkg_map (packageConfigId p) p
179 getPackageDetails :: PackageState -> PackageId -> PackageConfig
180 getPackageDetails dflags ps = fromJust (lookupPackage (pkgIdMap dflags) ps)
182 -- ----------------------------------------------------------------------------
183 -- Loading the package config files and building up the package state
185 initPackages :: DynFlags -> IO DynFlags
186 initPackages dflags = do
187 pkg_map <- readPackageConfigs dflags;
188 state <- mkPackageState dflags pkg_map
189 return dflags{ pkgState = state }
191 -- -----------------------------------------------------------------------------
192 -- Reading the package database(s)
194 readPackageConfigs :: DynFlags -> IO PackageConfigMap
195 readPackageConfigs dflags = do
196 -- System one always comes first
197 system_pkgconf <- getPackageConfigPath
198 pkg_map1 <- readPackageConfig dflags emptyPackageConfigMap system_pkgconf
200 -- Read user's package conf (eg. ~/.ghc/i386-linux-6.3/package.conf)
201 -- unless the -no-user-package-conf flag was given.
202 -- We only do this when getAppUserDataDirectory is available
204 (exists, pkgconf) <- catch (do
205 appdir <- getAppUserDataDirectory "ghc"
207 pkgconf = appdir ++ '/':TARGET_ARCH ++ '-':TARGET_OS
208 ++ '-':cProjectVersion ++ "/package.conf"
209 flg <- doesFileExist pkgconf
210 return (flg, pkgconf))
211 -- gobble them all up and turn into False.
212 (\ _ -> return (False, ""))
213 pkg_map2 <- if (dopt Opt_ReadUserPackageConf dflags && exists)
214 then readPackageConfig dflags pkg_map1 pkgconf
217 -- Read all the ones mentioned in -package-conf flags
218 pkg_map <- foldM (readPackageConfig dflags) pkg_map2
219 (extraPkgConfs dflags)
225 :: DynFlags -> PackageConfigMap -> FilePath -> IO PackageConfigMap
226 readPackageConfig dflags pkg_map conf_file = do
227 when (verbosity dflags >= 2) $
228 hPutStrLn stderr ("Using package config file: "
230 proto_pkg_configs <- loadPackageConfig conf_file
232 let pkg_configs = mungePackagePaths top_dir proto_pkg_configs
233 return (extendPackageConfigMap pkg_map pkg_configs)
236 mungePackagePaths :: String -> [PackageConfig] -> [PackageConfig]
237 -- Replace the string "$topdir" at the beginning of a path
238 -- with the current topdir (obtained from the -B option).
239 mungePackagePaths top_dir ps = map munge_pkg ps
241 munge_pkg p = p{ importDirs = munge_paths (importDirs p),
242 includeDirs = munge_paths (includeDirs p),
243 libraryDirs = munge_paths (libraryDirs p),
244 frameworkDirs = munge_paths (frameworkDirs p) }
246 munge_paths = map munge_path
249 | Just p' <- maybePrefixMatch "$topdir" p = top_dir ++ p'
253 -- -----------------------------------------------------------------------------
254 -- When all the command-line options are in, we can process our package
255 -- settings and populate the package state.
257 mkPackageState :: DynFlags -> PackageConfigMap -> IO PackageState
258 mkPackageState dflags pkg_db = do
260 -- Modify the package database according to the command-line flags
261 -- (-package, -hide-package, -ignore-package).
263 -- Also, here we build up a set of the packages mentioned in -package
264 -- flags on the command line; these are called the "explicit" packages.
265 -- we link these packages in eagerly. The explicit set should contain
266 -- at least rts & base, which is why we pretend that the command line
267 -- contains -package rts & -package base.
270 flags = reverse (packageFlags dflags)
272 procflags pkgs expl [] = return (pkgs,expl)
273 procflags pkgs expl (ExposePackage str : flags) = do
274 case partition (matches str) pkgs of
275 ([],_) -> missingPackageErr str
276 ([p],ps) -> procflags (p':ps) (addOneToUniqSet expl pkgid) flags
277 where pkgid = packageConfigId p
278 p' = p {exposed=True}
279 (ps,_) -> multiplePackagesErr str ps
280 procflags pkgs expl (HidePackage str : flags) = do
281 case partition (matches str) pkgs of
282 ([],_) -> missingPackageErr str
283 ([p],ps) -> procflags (p':ps) expl flags
284 where p' = p {exposed=False}
285 (ps,_) -> multiplePackagesErr str ps
286 procflags pkgs expl (IgnorePackage str : flags) = do
287 case partition (matches str) pkgs of
288 (ps,qs) -> procflags qs expl flags
289 -- missing package is not an error for -ignore-package,
290 -- because a common usage is to -ignore-package P as
291 -- a preventative measure just in case P exists.
293 -- A package named on the command line can either include the
294 -- version, or just the name if it is unambiguous.
296 = str == showPackageId (package p)
297 || str == pkgName (package p)
299 (pkgs1,explicit) <- procflags (eltsUFM pkg_db) emptyUniqSet flags
302 elimDanglingDeps pkgs =
303 case partition (hasDanglingDeps pkgs) pkgs of
305 (ps,qs) -> elimDanglingDeps qs
307 hasDanglingDeps pkgs p = any dangling (depends p)
308 where dangling pid = pid `notElem` all_pids
309 all_pids = map package pkgs
311 -- Eliminate any packages which have dangling dependencies (perhaps
312 -- because the package was removed by -ignore-package).
314 let pkgs = elimDanglingDeps pkgs1
315 pkg_db = extendPackageConfigMap emptyPackageConfigMap pkgs
317 -- Find the transitive closure of dependencies of exposed
319 let exposed_pkgids = [ packageConfigId p | p <- pkgs, exposed p ]
320 dep_exposed <- closeDeps pkg_db exposed_pkgids
322 -- Look up some known PackageIds
325 lookupPackageByName :: FastString -> PackageIdH
326 lookupPackageByName nm =
327 case [ conf | p <- dep_exposed,
328 Just conf <- [lookupPackage pkg_db p],
329 nm == mkFastString (pkgName (package conf)) ] of
331 (p:ps) -> ExtPackage (mkPackageId (package p))
333 -- Get the PackageIds for some known packages (we know the names,
334 -- but we don't know the versions). Some of these packages might
335 -- not exist in the database, so they are Maybes.
336 basePackageId = lookupPackageByName basePackageName
337 rtsPackageId = lookupPackageByName rtsPackageName
338 haskell98PackageId = lookupPackageByName haskell98PackageName
339 thPackageId = lookupPackageByName thPackageName
341 -- add base & rts to the explicit packages
342 basicLinkedPackages = [basePackageId,rtsPackageId]
343 explicit' = addListToUniqSet explicit
344 [ p | ExtPackage p <- basicLinkedPackages ]
346 -- Close the explicit packages with their dependencies
348 dep_explicit <- closeDeps pkg_db (uniqSetToList explicit')
350 -- Build up a mapping from Module -> PackageConfig for all modules.
351 -- Discover any conflicts at the same time, and factor in the new exposed
352 -- status of each package.
355 extend_modmap modmap pkgname = do
357 pkg = fromJust (lookupPackage pkg_db pkgname)
358 exposed_mods = map mkModule (exposedModules pkg)
359 hidden_mods = map mkModule (hiddenModules pkg)
360 all_mods = exposed_mods ++ hidden_mods
362 -- check for overlaps
365 overlaps = [ (m,pkg) | m <- all_mods,
366 Just (pkg,_) <- [lookupUFM modmap m] ]
368 when (not (null overlaps)) $ overlappingError pkg overlaps
371 return (addListToUFM modmap
372 [(m, (pkg, m `elem` exposed_mods))
375 mod_map <- foldM extend_modmap emptyUFM dep_exposed
377 return PackageState{ explicitPackages = dep_explicit,
379 moduleToPkgConf = mod_map,
380 basePackageId = basePackageId,
381 rtsPackageId = rtsPackageId,
382 haskell98PackageId = haskell98PackageId,
383 thPackageId = thPackageId
387 basePackageName = FSLIT("base")
388 rtsPackageName = FSLIT("rts")
389 haskell98PackageName = FSLIT("haskell98")
390 thPackageName = FSLIT("template-haskell")
391 -- Template Haskell libraries in here
393 overlappingError pkg overlaps
394 = throwDyn (CmdLineError (showSDoc (vcat (map msg overlaps))))
396 this_pkg = text (showPackageId (package pkg))
397 msg (mod,other_pkg) =
398 text "Error: module '" <> ppr mod
399 <> text "' is exposed by package "
400 <> this_pkg <> text " and package "
401 <> text (showPackageId (package other_pkg))
403 multiplePackagesErr str ps =
404 throwDyn (CmdLineError (showSDoc (
405 text "Error; multiple packages match" <+>
406 text str <> colon <+>
407 sep (punctuate comma (map (text.showPackageId.package) ps))
410 -- -----------------------------------------------------------------------------
411 -- Extracting information from the packages in scope
413 -- Many of these functions take a list of packages: in those cases,
414 -- the list is expected to contain the "dependent packages",
415 -- i.e. those packages that were found to be depended on by the
416 -- current module/program. These can be auto or non-auto packages, it
417 -- doesn't really matter. The list is always combined with the list
418 -- of explicit (command-line) packages to determine which packages to
421 getPackageIncludePath :: DynFlags -> [PackageId] -> IO [String]
422 getPackageIncludePath dflags pkgs = do
423 ps <- getExplicitPackagesAnd dflags pkgs
424 return (nub (filter notNull (concatMap includeDirs ps)))
426 -- includes are in reverse dependency order (i.e. rts first)
427 getPackageCIncludes :: [PackageConfig] -> IO [String]
428 getPackageCIncludes pkg_configs = do
429 return (reverse (nub (filter notNull (concatMap includes pkg_configs))))
431 getPackageLibraryPath :: DynFlags -> [PackageId] -> IO [String]
432 getPackageLibraryPath dflags pkgs = do
433 ps <- getExplicitPackagesAnd dflags pkgs
434 return (nub (filter notNull (concatMap libraryDirs ps)))
436 getPackageLinkOpts :: DynFlags -> [PackageId] -> IO [String]
437 getPackageLinkOpts dflags pkgs = do
438 ps <- getExplicitPackagesAnd dflags pkgs
439 let tag = buildTag dflags
440 rts_tag = rtsBuildTag dflags
442 imp = if opt_Static then "" else "_dyn"
443 libs p = map ((++imp) . addSuffix) (hACK (hsLibraries p)) ++ extraLibraries p
444 all_opts p = map ("-l" ++) (libs p) ++ ldOptions p
446 suffix = if null tag then "" else '_':tag
447 rts_suffix = if null rts_tag then "" else '_':rts_tag
449 addSuffix rts@"HSrts" = rts ++ rts_suffix
450 addSuffix other_lib = other_lib ++ suffix
452 return (concat (map all_opts ps))
455 -- This is a totally horrible (temporary) hack, for Win32. Problem is
456 -- that package.conf for Win32 says that the main prelude lib is
457 -- split into HSbase1, HSbase2 and HSbase3, which is needed due to a bug
458 -- in the GNU linker (PEi386 backend). However, we still only
459 -- have HSbase.a for static linking, not HSbase{1,2,3}.a
460 -- getPackageLibraries is called to find the .a's to add to the static
461 -- link line. On Win32, this hACK detects HSbase{1,2,3} and
462 -- replaces them with HSbase, so static linking still works.
463 -- Libraries needed for dynamic (GHCi) linking are discovered via
464 -- different route (in InteractiveUI.linkPackage).
465 -- See driver/PackageSrc.hs for the HSbase1/HSbase2 split definition.
466 -- THIS IS A STRICTLY TEMPORARY HACK (famous last words ...)
467 -- JRS 04 Sept 01: Same appalling hack for HSwin32[1,2]
468 -- KAA 29 Mar 02: Same appalling hack for HSobjectio[1,2,3,4]
470 # if !defined(mingw32_TARGET_OS) && !defined(cygwin32_TARGET_OS)
473 = if "HSbase1" `elem` libs && "HSbase2" `elem` libs && "HSbase3" `elem` libs
474 then "HSbase" : filter (not.(isPrefixOf "HSbase")) libs
476 if "HSwin321" `elem` libs && "HSwin322" `elem` libs
477 then "HSwin32" : filter (not.(isPrefixOf "HSwin32")) libs
479 if "HSobjectio1" `elem` libs && "HSobjectio2" `elem` libs && "HSobjectio3" `elem` libs && "HSobjectio4" `elem` libs
480 then "HSobjectio" : filter (not.(isPrefixOf "HSobjectio")) libs
485 getPackageExtraCcOpts :: DynFlags -> [PackageId] -> IO [String]
486 getPackageExtraCcOpts dflags pkgs = do
487 ps <- getExplicitPackagesAnd dflags pkgs
488 return (concatMap ccOptions ps)
490 getPackageFrameworkPath :: DynFlags -> [PackageId] -> IO [String]
491 getPackageFrameworkPath dflags pkgs = do
492 ps <- getExplicitPackagesAnd dflags pkgs
493 return (nub (filter notNull (concatMap frameworkDirs ps)))
495 getPackageFrameworks :: DynFlags -> [PackageId] -> IO [String]
496 getPackageFrameworks dflags pkgs = do
497 ps <- getExplicitPackagesAnd dflags pkgs
498 return (concatMap frameworks ps)
500 -- -----------------------------------------------------------------------------
503 -- Takes a Module, and if the module is in a package returns
504 -- (pkgconf,exposed) where pkgconf is the PackageConfig for that package,
505 -- and exposed is True if the package exposes the module.
506 moduleToPackageConfig :: DynFlags -> Module -> Maybe (PackageConfig,Bool)
507 moduleToPackageConfig dflags m =
508 lookupUFM (moduleToPkgConf (pkgState dflags)) m
510 isHomeModule :: DynFlags -> Module -> Bool
511 isHomeModule dflags mod = isNothing (moduleToPackageConfig dflags mod)
513 getExplicitPackagesAnd :: DynFlags -> [PackageId] -> IO [PackageConfig]
514 getExplicitPackagesAnd dflags pkgids =
516 state = pkgState dflags
517 pkg_map = pkgIdMap state
518 expl = explicitPackages state
520 all_pkgs <- foldM (add_package pkg_map) expl pkgids
521 return (map (getPackageDetails state) all_pkgs)
523 -- Takes a list of packages, and returns the list with dependencies included,
524 -- in reverse dependency order (a package appears before those it depends on).
525 closeDeps :: PackageConfigMap -> [PackageId] -> IO [PackageId]
526 closeDeps pkg_map ps = foldM (add_package pkg_map) [] ps
529 add_package :: PackageConfigMap -> [PackageId] -> PackageId -> IO [PackageId]
530 add_package pkg_db ps p
531 | p `elem` ps = return ps -- Check if we've already added this package
533 case lookupPackage pkg_db p of
534 Nothing -> missingPackageErr (packageIdString p)
536 -- Add the package's dependents also
537 let deps = map mkPackageId (depends pkg)
538 ps' <- foldM (add_package pkg_db) ps deps
541 missingPackageErr p = throwDyn (CmdLineError ("unknown package: " ++ p))
543 -- -----------------------------------------------------------------------------
544 -- Determining whether a Name refers to something in another package or not.
545 -- Cross-package references need to be handled differently when dynamically-
546 -- linked libraries are involved.
548 isDllName :: DynFlags -> Name -> Bool
549 isDllName dflags name
552 case nameModule_maybe name of
553 Nothing -> False -- no, it is not even an external name
555 case lookupUFM (moduleToPkgConf (pkgState dflags)) mod of
556 Just _ -> True -- yes, its a package module
557 Nothing -> False -- no, must be a home module
559 -- -----------------------------------------------------------------------------
560 -- Displaying packages
562 dumpPackages :: DynFlags -> IO ()
563 -- Show package info on console, if verbosity is >= 3
565 = do let pkg_map = pkgIdMap (pkgState dflags)
566 hPutStrLn stderr $ showSDoc $
567 vcat (map (text.showInstalledPackageInfo) (eltsUFM pkg_map))