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 )
50 import Maybes ( expectJust )
54 #if __GLASGOW_HASKELL__ >= 603
55 import System.Directory ( getAppUserDataDirectory )
57 import Compat.Directory ( getAppUserDataDirectory )
60 import Distribution.InstalledPackageInfo
61 import Distribution.Package
62 import Distribution.Version
63 import Data.Maybe ( 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 )
75 import ErrUtils ( debugTraceMsg, putMsg )
77 -- ---------------------------------------------------------------------------
80 -- Package state is all stored in DynFlags, including the details of
81 -- all packages, which packages are exposed, and which modules they
84 -- The package state is computed by initPackages, and kept in DynFlags.
86 -- * -package <pkg> causes <pkg> to become exposed, and all other packages
87 -- with the same name to become hidden.
89 -- * -hide-package <pkg> causes <pkg> to become hidden.
91 -- * Let exposedPackages be the set of packages thus exposed.
92 -- Let depExposedPackages be the transitive closure from exposedPackages of
93 -- their dependencies.
95 -- * It is an error for any two packages in depExposedPackages to provide the
98 -- * When searching for a module from an explicit import declaration,
99 -- only the exposed modules in exposedPackages are valid.
101 -- * When searching for a module from an implicit import, all modules
102 -- from depExposedPackages are valid.
104 -- * When linking in a comp manager mode, we link in packages the
105 -- program depends on (the compiler knows this list by the
106 -- time it gets to the link step). Also, we link in all packages
107 -- which were mentioned with explicit -package flags on the command-line,
108 -- or are a transitive dependency of same, or are "base"/"rts".
109 -- The reason for (b) is that we might need packages which don't
110 -- contain any Haskell modules, and therefore won't be discovered
111 -- by the normal mechanism of dependency tracking.
114 -- One important thing that the package state provides is a way to
115 -- tell, for a given module, whether it is part of the current package
116 -- or not. We need to know this for two reasons:
118 -- * generating cross-DLL calls is different from intra-DLL calls
120 -- * we don't record version information in interface files for entities
121 -- in a different package.
125 -- When compiling module A, which imports module B, we need to
126 -- know whether B will be in the same DLL as A.
127 -- If it's in the same DLL, we refer to B_f_closure
128 -- If it isn't, we refer to _imp__B_f_closure
129 -- When compiling A, we record in B's Module value whether it's
130 -- in a different DLL, by setting the DLL flag.
132 data PackageState = PackageState {
134 explicitPackages :: [PackageId],
135 -- The packages we're going to link in eagerly. This list
136 -- should be in reverse dependency order; that is, a package
137 -- is always mentioned before the packages it depends on.
139 pkgIdMap :: PackageConfigMap, -- PackageId -> PackageConfig
140 -- mapping derived from the package databases and
141 -- command-line package flags.
143 moduleToPkgConf :: UniqFM (PackageConfig,Bool),
144 -- Maps Module to (pkgconf,exposed), where pkgconf is the
145 -- PackageConfig for the package containing the module, and
146 -- exposed is True if the package exposes that module.
148 -- The PackageIds of some known packages
149 basePackageId :: PackageIdH,
150 rtsPackageId :: PackageIdH,
151 haskell98PackageId :: PackageIdH,
152 thPackageId :: PackageIdH
156 = HomePackage -- The "home" package is the package curently
158 | ExtPackage PackageId -- An "external" package is any other package
161 isHomePackage :: PackageIdH -> Bool
162 isHomePackage HomePackage = True
163 isHomePackage (ExtPackage _) = False
165 -- A PackageConfigMap maps a PackageId to a PackageConfig
166 type PackageConfigMap = UniqFM PackageConfig
168 emptyPackageConfigMap :: PackageConfigMap
169 emptyPackageConfigMap = emptyUFM
171 lookupPackage :: PackageConfigMap -> PackageId -> Maybe PackageConfig
172 lookupPackage = lookupUFM
174 extendPackageConfigMap
175 :: PackageConfigMap -> [PackageConfig] -> PackageConfigMap
176 extendPackageConfigMap pkg_map new_pkgs
177 = foldl add pkg_map new_pkgs
178 where add pkg_map p = addToUFM pkg_map (packageConfigId p) p
180 getPackageDetails :: PackageState -> PackageId -> PackageConfig
181 getPackageDetails dflags ps = expectJust "getPackageDetails" (lookupPackage (pkgIdMap dflags) ps)
183 -- ----------------------------------------------------------------------------
184 -- Loading the package config files and building up the package state
186 -- | Call this after parsing the DynFlags. It reads the package
187 -- configuration files, and sets up various internal tables of package
188 -- information, according to the package-related flags on the
189 -- command-line (@-package@, @-hide-package@ etc.)
190 initPackages :: DynFlags -> IO DynFlags
191 initPackages dflags = do
192 pkg_map <- readPackageConfigs dflags;
193 state <- mkPackageState dflags pkg_map
194 return dflags{ pkgState = state }
196 -- -----------------------------------------------------------------------------
197 -- Reading the package database(s)
199 readPackageConfigs :: DynFlags -> IO PackageConfigMap
200 readPackageConfigs dflags = do
201 -- System one always comes first
202 system_pkgconf <- getPackageConfigPath
203 pkg_map1 <- readPackageConfig dflags emptyPackageConfigMap system_pkgconf
205 -- Read user's package conf (eg. ~/.ghc/i386-linux-6.3/package.conf)
206 -- unless the -no-user-package-conf flag was given.
207 -- We only do this when getAppUserDataDirectory is available
209 (exists, pkgconf) <- catch (do
210 appdir <- getAppUserDataDirectory "ghc"
212 pkgconf = appdir ++ '/':TARGET_ARCH ++ '-':TARGET_OS
213 ++ '-':cProjectVersion ++ "/package.conf"
214 flg <- doesFileExist pkgconf
215 return (flg, pkgconf))
216 -- gobble them all up and turn into False.
217 (\ _ -> return (False, ""))
218 pkg_map2 <- if (dopt Opt_ReadUserPackageConf dflags && exists)
219 then readPackageConfig dflags pkg_map1 pkgconf
222 -- Read all the ones mentioned in -package-conf flags
223 pkg_map <- foldM (readPackageConfig dflags) pkg_map2
224 (extraPkgConfs dflags)
230 :: DynFlags -> PackageConfigMap -> FilePath -> IO PackageConfigMap
231 readPackageConfig dflags pkg_map conf_file = do
232 debugTraceMsg dflags 2 ("Using package config file: " ++ conf_file)
233 proto_pkg_configs <- loadPackageConfig conf_file
235 let pkg_configs1 = mungePackagePaths top_dir proto_pkg_configs
236 pkg_configs2 = maybeHidePackages dflags pkg_configs1
237 return (extendPackageConfigMap pkg_map pkg_configs2)
239 maybeHidePackages :: DynFlags -> [PackageConfig] -> [PackageConfig]
240 maybeHidePackages dflags pkgs
241 | dopt Opt_HideAllPackages dflags = map hide pkgs
244 hide pkg = pkg{ exposed = False }
246 mungePackagePaths :: String -> [PackageConfig] -> [PackageConfig]
247 -- Replace the string "$topdir" at the beginning of a path
248 -- with the current topdir (obtained from the -B option).
249 mungePackagePaths top_dir ps = map munge_pkg ps
251 munge_pkg p = p{ importDirs = munge_paths (importDirs p),
252 includeDirs = munge_paths (includeDirs p),
253 libraryDirs = munge_paths (libraryDirs p),
254 frameworkDirs = munge_paths (frameworkDirs p) }
256 munge_paths = map munge_path
259 | Just p' <- maybePrefixMatch "$topdir" p = top_dir ++ p'
263 -- -----------------------------------------------------------------------------
264 -- When all the command-line options are in, we can process our package
265 -- settings and populate the package state.
267 mkPackageState :: DynFlags -> PackageConfigMap -> IO PackageState
268 mkPackageState dflags pkg_db = do
270 -- Modify the package database according to the command-line flags
271 -- (-package, -hide-package, -ignore-package, -hide-all-packages).
273 -- Also, here we build up a set of the packages mentioned in -package
274 -- flags on the command line; these are called the "explicit" packages.
275 -- we link these packages in eagerly. The explicit set should contain
276 -- at least rts & base, which is why we pretend that the command line
277 -- contains -package rts & -package base.
280 flags = reverse (packageFlags dflags)
282 procflags pkgs expl [] = return (pkgs,expl)
283 procflags pkgs expl (ExposePackage str : flags) = do
284 case partition (matches str) pkgs of
285 ([],_) -> missingPackageErr str
286 ([p],ps) -> procflags (p':ps) (addOneToUniqSet expl pkgid) flags
287 where pkgid = packageConfigId p
288 p' = p {exposed=True}
289 (ps,_) -> multiplePackagesErr str ps
290 procflags pkgs expl (HidePackage str : flags) = do
291 case partition (matches str) pkgs of
292 ([],_) -> missingPackageErr str
293 ([p],ps) -> procflags (p':ps) expl flags
294 where p' = p {exposed=False}
295 (ps,_) -> multiplePackagesErr str ps
296 procflags pkgs expl (IgnorePackage str : flags) = do
297 case partition (matches str) pkgs of
298 (ps,qs) -> procflags qs expl flags
299 -- missing package is not an error for -ignore-package,
300 -- because a common usage is to -ignore-package P as
301 -- a preventative measure just in case P exists.
303 -- A package named on the command line can either include the
304 -- version, or just the name if it is unambiguous.
306 = str == showPackageId (package p)
307 || str == pkgName (package p)
309 (pkgs1,explicit) <- procflags (eltsUFM pkg_db) emptyUniqSet flags
312 elimDanglingDeps pkgs =
313 case partition (hasDanglingDeps pkgs) pkgs of
315 (ps,qs) -> elimDanglingDeps qs
317 hasDanglingDeps pkgs p = any dangling (depends p)
318 where dangling pid = pid `notElem` all_pids
319 all_pids = map package pkgs
321 -- Eliminate any packages which have dangling dependencies (perhaps
322 -- because the package was removed by -ignore-package).
324 let pkgs = elimDanglingDeps pkgs1
325 pkg_db = extendPackageConfigMap emptyPackageConfigMap pkgs
327 -- Find the transitive closure of dependencies of exposed
329 let exposed_pkgids = [ packageConfigId p | p <- pkgs, exposed p ]
330 dep_exposed <- closeDeps pkg_db exposed_pkgids
332 -- Look up some known PackageIds
335 lookupPackageByName :: FastString -> PackageIdH
336 lookupPackageByName nm =
337 case [ conf | p <- dep_exposed,
338 Just conf <- [lookupPackage pkg_db p],
339 nm == mkFastString (pkgName (package conf)) ] of
341 (p:ps) -> ExtPackage (mkPackageId (package p))
343 -- Get the PackageIds for some known packages (we know the names,
344 -- but we don't know the versions). Some of these packages might
345 -- not exist in the database, so they are Maybes.
346 basePackageId = lookupPackageByName basePackageName
347 rtsPackageId = lookupPackageByName rtsPackageName
348 haskell98PackageId = lookupPackageByName haskell98PackageName
349 thPackageId = lookupPackageByName thPackageName
351 -- add base & rts to the explicit packages
352 basicLinkedPackages = [basePackageId,rtsPackageId]
353 explicit' = addListToUniqSet explicit
354 [ p | ExtPackage p <- basicLinkedPackages ]
356 -- Close the explicit packages with their dependencies
358 dep_explicit <- closeDeps pkg_db (uniqSetToList explicit')
360 -- Build up a mapping from Module -> PackageConfig for all modules.
361 -- Discover any conflicts at the same time, and factor in the new exposed
362 -- status of each package.
365 extend_modmap modmap pkgname = do
367 pkg = expectJust "mkPackageState" (lookupPackage pkg_db pkgname)
368 exposed_mods = map mkModule (exposedModules pkg)
369 hidden_mods = map mkModule (hiddenModules pkg)
370 all_mods = exposed_mods ++ hidden_mods
372 -- check for overlaps
375 overlaps = [ (m,pkg) | m <- all_mods,
376 Just (pkg,_) <- [lookupUFM modmap m] ]
378 when (not (null overlaps)) $ overlappingError pkg overlaps
380 return (addListToUFM modmap
381 [(m, (pkg, m `elem` exposed_mods))
384 mod_map <- foldM extend_modmap emptyUFM dep_exposed
386 return PackageState{ explicitPackages = dep_explicit,
388 moduleToPkgConf = mod_map,
389 basePackageId = basePackageId,
390 rtsPackageId = rtsPackageId,
391 haskell98PackageId = haskell98PackageId,
392 thPackageId = thPackageId
396 basePackageName = FSLIT("base")
397 rtsPackageName = FSLIT("rts")
398 haskell98PackageName = FSLIT("haskell98")
399 thPackageName = FSLIT("template-haskell")
400 -- Template Haskell libraries in here
402 overlappingError pkg overlaps
403 = throwDyn (CmdLineError (showSDoc (vcat (map msg overlaps))))
405 this_pkg = text (showPackageId (package pkg))
406 msg (mod,other_pkg) =
407 text "Error: module '" <> ppr mod
408 <> text "' is exposed by package "
409 <> this_pkg <> text " and package "
410 <> text (showPackageId (package other_pkg))
412 multiplePackagesErr str ps =
413 throwDyn (CmdLineError (showSDoc (
414 text "Error; multiple packages match" <+>
415 text str <> colon <+>
416 sep (punctuate comma (map (text.showPackageId.package) ps))
419 -- -----------------------------------------------------------------------------
420 -- Extracting information from the packages in scope
422 -- Many of these functions take a list of packages: in those cases,
423 -- the list is expected to contain the "dependent packages",
424 -- i.e. those packages that were found to be depended on by the
425 -- current module/program. These can be auto or non-auto packages, it
426 -- doesn't really matter. The list is always combined with the list
427 -- of explicit (command-line) packages to determine which packages to
430 getPackageIncludePath :: DynFlags -> [PackageId] -> IO [String]
431 getPackageIncludePath dflags pkgs = do
432 ps <- getExplicitPackagesAnd dflags pkgs
433 return (nub (filter notNull (concatMap includeDirs ps)))
435 -- includes are in reverse dependency order (i.e. rts first)
436 getPackageCIncludes :: [PackageConfig] -> IO [String]
437 getPackageCIncludes pkg_configs = do
438 return (reverse (nub (filter notNull (concatMap includes pkg_configs))))
440 getPackageLibraryPath :: DynFlags -> [PackageId] -> IO [String]
441 getPackageLibraryPath dflags pkgs = do
442 ps <- getExplicitPackagesAnd dflags pkgs
443 return (nub (filter notNull (concatMap libraryDirs ps)))
445 getPackageLinkOpts :: DynFlags -> [PackageId] -> IO [String]
446 getPackageLinkOpts dflags pkgs = do
447 ps <- getExplicitPackagesAnd dflags pkgs
448 let tag = buildTag dflags
449 rts_tag = rtsBuildTag dflags
451 imp = if opt_Static then "" else "_dyn"
452 libs p = map ((++imp) . addSuffix) (hACK (hsLibraries p)) ++ extraLibraries p
453 all_opts p = map ("-l" ++) (libs p) ++ ldOptions p
455 suffix = if null tag then "" else '_':tag
456 rts_suffix = if null rts_tag then "" else '_':rts_tag
458 addSuffix rts@"HSrts" = rts ++ rts_suffix
459 addSuffix other_lib = other_lib ++ suffix
461 return (concat (map all_opts ps))
464 -- This is a totally horrible (temporary) hack, for Win32. Problem is
465 -- that package.conf for Win32 says that the main prelude lib is
466 -- split into HSbase1, HSbase2 and HSbase3, which is needed due to a bug
467 -- in the GNU linker (PEi386 backend). However, we still only
468 -- have HSbase.a for static linking, not HSbase{1,2,3}.a
469 -- getPackageLibraries is called to find the .a's to add to the static
470 -- link line. On Win32, this hACK detects HSbase{1,2,3} and
471 -- replaces them with HSbase, so static linking still works.
472 -- Libraries needed for dynamic (GHCi) linking are discovered via
473 -- different route (in InteractiveUI.linkPackage).
474 -- See driver/PackageSrc.hs for the HSbase1/HSbase2 split definition.
475 -- THIS IS A STRICTLY TEMPORARY HACK (famous last words ...)
476 -- JRS 04 Sept 01: Same appalling hack for HSwin32[1,2]
477 -- KAA 29 Mar 02: Same appalling hack for HSobjectio[1,2,3,4]
479 -- [sof 03/05: Renamed the (moribund) HSwin32 to HSwin_32 so as to
480 -- avoid filename conflicts with the 'Win32' package on a case-insensitive filesystem]
482 # if !defined(mingw32_TARGET_OS) && !defined(cygwin32_TARGET_OS)
485 = if "HSbase1" `elem` libs && "HSbase2" `elem` libs && "HSbase3" `elem` libs
486 then "HSbase" : filter (not.(isPrefixOf "HSbase")) libs
488 if "HSwin_321" `elem` libs && "HSwin_322" `elem` libs
489 then "HSwin_32" : filter (not.(isPrefixOf "HSwin_32")) libs
491 if "HSobjectio1" `elem` libs && "HSobjectio2" `elem` libs && "HSobjectio3" `elem` libs && "HSobjectio4" `elem` libs
492 then "HSobjectio" : filter (not.(isPrefixOf "HSobjectio")) libs
497 getPackageExtraCcOpts :: DynFlags -> [PackageId] -> IO [String]
498 getPackageExtraCcOpts dflags pkgs = do
499 ps <- getExplicitPackagesAnd dflags pkgs
500 return (concatMap ccOptions ps)
502 getPackageFrameworkPath :: DynFlags -> [PackageId] -> IO [String]
503 getPackageFrameworkPath dflags pkgs = do
504 ps <- getExplicitPackagesAnd dflags pkgs
505 return (nub (filter notNull (concatMap frameworkDirs ps)))
507 getPackageFrameworks :: DynFlags -> [PackageId] -> IO [String]
508 getPackageFrameworks dflags pkgs = do
509 ps <- getExplicitPackagesAnd dflags pkgs
510 return (concatMap frameworks ps)
512 -- -----------------------------------------------------------------------------
515 -- Takes a Module, and if the module is in a package returns
516 -- (pkgconf,exposed) where pkgconf is the PackageConfig for that package,
517 -- and exposed is True if the package exposes the module.
518 moduleToPackageConfig :: DynFlags -> Module -> Maybe (PackageConfig,Bool)
519 moduleToPackageConfig dflags m =
520 lookupUFM (moduleToPkgConf (pkgState dflags)) m
522 isHomeModule :: DynFlags -> Module -> Bool
523 isHomeModule dflags mod = isNothing (moduleToPackageConfig dflags mod)
525 getExplicitPackagesAnd :: DynFlags -> [PackageId] -> IO [PackageConfig]
526 getExplicitPackagesAnd dflags pkgids =
528 state = pkgState dflags
529 pkg_map = pkgIdMap state
530 expl = explicitPackages state
532 all_pkgs <- foldM (add_package pkg_map) expl pkgids
533 return (map (getPackageDetails state) all_pkgs)
535 -- Takes a list of packages, and returns the list with dependencies included,
536 -- in reverse dependency order (a package appears before those it depends on).
537 closeDeps :: PackageConfigMap -> [PackageId] -> IO [PackageId]
538 closeDeps pkg_map ps = foldM (add_package pkg_map) [] ps
541 add_package :: PackageConfigMap -> [PackageId] -> PackageId -> IO [PackageId]
542 add_package pkg_db ps p
543 | p `elem` ps = return ps -- Check if we've already added this package
545 case lookupPackage pkg_db p of
546 Nothing -> missingPackageErr (packageIdString p)
548 -- Add the package's dependents also
549 let deps = map mkPackageId (depends pkg)
550 ps' <- foldM (add_package pkg_db) ps deps
553 missingPackageErr p = throwDyn (CmdLineError ("unknown package: " ++ p))
555 -- -----------------------------------------------------------------------------
556 -- Determining whether a Name refers to something in another package or not.
557 -- Cross-package references need to be handled differently when dynamically-
558 -- linked libraries are involved.
560 isDllName :: DynFlags -> Name -> Bool
561 isDllName dflags name
564 case nameModule_maybe name of
565 Nothing -> False -- no, it is not even an external name
567 case lookupUFM (moduleToPkgConf (pkgState dflags)) mod of
568 Just _ -> True -- yes, its a package module
569 Nothing -> False -- no, must be a home module
571 -- -----------------------------------------------------------------------------
572 -- Displaying packages
574 dumpPackages :: DynFlags -> IO ()
575 -- Show package info on console, if verbosity is >= 3
577 = do let pkg_map = pkgIdMap (pkgState dflags)
579 vcat (map (text.showInstalledPackageInfo) (eltsUFM pkg_map))