Moduleghc-10.0.0.20260917GHC2024

GHC.Linker.Loader

The loader

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

2 types
22 values

Packageghc-10.0.0.20260917
Exports24
LanguageGHC2024
LicenceBSD-3-Clause
SourceLoader.hs

newtypenewtype Loader

Constructors

Loader
- loader_state :: MVar (Maybe LoaderState)

datadata LoaderState

Constructors

LoaderState
- bco_loader_state :: !BytecodeLoaderState
  Information about bytecode objects we have loaded into the interpreter.
- bcos_loaded :: !LinkableSet LinkableUsage
  The currently loaded interpreted modules (home package)
- objs_loaded :: !LinkableSet LinkableUsage
  And the currently-loaded compiled modules (home package)
- pkgs_loaded :: !PkgsLoaded
  The currently-loaded packages; haskell libraries, system libraries, transitive dependencies
- temp_sos :: ![(FilePath, String)]
  We need to remember the name of previous temporary DLL/.so libraries so we can link them (see #10322)

valueinitLoaderState :: Interp -> HscEnv -> IO ()

Initialise the dynamic linker. This entails

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 ldInputs,

e) Loading any MacOS frameworks.

NOTE: 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.

valueuninitializedLoader :: IO Loader

valueshowLoaderState :: Interp -> IO SDoc

Display the loader state.

valuegetLoaderState :: Interp -> IO (Maybe LoaderState)

Load & Unload

6 declarations

valueloadDecls

:: Interp
-> HscEnv
-> SrcSpan
-> Linkable
-> IO ([LinkableUsage], PkgsLoaded)

Load the dependencies of a linkable, and then load the linkable itself.

valueloadPackages :: Interp -> HscEnv -> [UnitId] -> IO ()

Load exactly the specified packages, and their dependents (unless of course they are already loaded). The dependents are loaded automatically, and it doesn't matter what order you specify the input packages.

valueloadModule :: Interp -> HscEnv -> Module -> IO ()

valueloadCmdLineLibs :: Interp -> HscEnv -> IO ()

valueloadName

:: Interp
-> HscEnv
-> Name
-> IO (ForeignHValue, [LinkableUsage], PkgsLoaded)

Load the module containing the given Name and get its associated HValue.

Throws a ProgramError if loading fails or the name cannot be found.

valueunload :: Interp -> HscEnv -> IO ()

Unloading old objects ready for a new compilation sweep. * compilation artifacts for home modules that we might be about to recompile are unloaded from the interpreter. * we also implicitly unload all temporary bindings at this point.

LoadedEnv

4 declarations

valuewithExtendedLoadedEnv

:: ExceptionMonad m
=> Interp
-> [(Name, ForeignHValue)]
-> m a
-> m a

Temporarily extend the loaded env.

valueextendLoadedEnv

valuedeleteFromLoadedHomeEnv :: Interp -> [Name] -> IO ()

valuelookupFromLoadedEnv :: Interp -> Name -> IO (Maybe ForeignHValue)

Have we already loaded a name into the interpreter?

Internals

8 declarations

valueallocateBreakArrays

:: Interp
-> ModuleEnv (ForeignRef BreakArray)
-> [InternalModBreaks]
-> IO (ModuleEnv (ForeignRef BreakArray))

Given a list of InternalModBreaks collected from a list of CompiledByteCode, allocate the BreakArray used to trigger breakpoints.

valuermDupLinkables

:: LinkableSet LinkableUsage
Already loaded
-> [Linkable]
New linkables
-> (LinkableSet LinkableUsage, [Linkable])

valuemodifyLoaderState :: Interp -> (LoaderState -> IO (LoaderState, a)) -> IO a

valueinitLinkDepsOpts :: HscEnv -> LinkDepsOpts

valuegetGccSearchDirectory :: Logger -> LdConfig -> String -> IO [FilePath]

valuemkDynLoadLib

:: HscEnv
-> Ways -> Ways
-> [(FilePath, String)]
-> [UnitId]
-> [FilePath]
-> IO (Maybe (FilePath, FilePath, String))

Create a shared library containing the given object files

valueloadMoreUnits

:: HscEnv
-> [UnitId]
New packages to process (not yet in PkgsLoaded)
-> PkgsLoaded
Existing loaded packages (used for memoization)
-> IO ([UnitInfo], PkgsLoaded)
Reverse topologically-sorted new package infos + updated PkgsLoaded

Compute LoadedPkgInfo metadata (with transitive deps) for new packages, without loading any native libraries. Used for recompilation-avoidance tracking and as the first pass of loadPackages'.

The returned '[UnitInfo]' list is an accumulated *reverse* topologically sorted list of new packages. The returned PkgsLoaded is populated with placeholder LoadedPkgInfo for new packages (empty artifact fields, correct loaded_pkg_trans_deps).

valuefilterNeededPkgsLoaded :: UniqDSet UnitId -> PkgsLoaded -> PkgsLoaded

Restrict a PkgsLoaded map to the packages directly needed and their full transitive closure (via loaded_pkg_trans_deps).