GHC.Linker.Loader

ghc-9.2.5: The GHC API

Safe Haskell | Safe-Inferred
Language | Haskell2010

GHC.Linker.Loader

Contents

- Load & Unload
- LoadedEnv
- Misc

Description

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.

Synopsis

- newtype Loader = Loader {
  - loader_state :: MVar (Maybe LoaderState)
  }
- data LoaderState = LoaderState {
  - closure_env :: ClosureEnv
  - itbl_env :: !ItblEnv
  - bcos_loaded :: ![Linkable]
  - objs_loaded :: ![Linkable]
  - pkgs_loaded :: ![UnitId]
  - temp_sos :: ![(FilePath, String)]
  }
- initLoaderState :: Interp -> HscEnv -> IO ()
- uninitializedLoader :: IO Loader
- showLoaderState :: Interp -> IO SDoc
- loadExpr :: Interp -> HscEnv -> SrcSpan -> UnlinkedBCO -> IO ForeignHValue
- loadDecls :: Interp -> HscEnv -> SrcSpan -> CompiledByteCode -> IO [(Name, ForeignHValue)]
- loadPackages :: Interp -> HscEnv -> [UnitId] -> IO ()
- loadModule :: Interp -> HscEnv -> Module -> IO ()
- loadCmdLineLibs :: Interp -> HscEnv -> IO ()
- loadName :: Interp -> HscEnv -> Name -> IO ForeignHValue
- unload :: Interp -> HscEnv -> [Linkable] -> IO ()
- withExtendedLoadedEnv :: ExceptionMonad m => Interp -> [(Name, ForeignHValue)] -> m a -> m a
- extendLoadedEnv :: Interp -> [(Name, ForeignHValue)] -> IO ()
- deleteFromLoadedEnv :: Interp -> [Name] -> IO ()
- extendLoadedPkgs :: Interp -> [UnitId] -> IO ()

# Documentation

newtype Loader Source #

Constructors

Loader |
Fields loader_state :: MVar (Maybe LoaderState)

data LoaderState Source #

Constructors

LoaderState |
Fields closure_env :: ClosureEnv Current global mapping from Names to their true values itbl_env :: !ItblEnv 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. bcos_loaded :: ![Linkable] The currently loaded interpreted modules (home package) objs_loaded :: ![Linkable] And the currently-loaded compiled modules (home package) pkgs_loaded :: ![UnitId] The currently-loaded packages; always object code Held, as usual, in dependency order; though I am not sure if that is really important temp_sos :: ![(FilePath, String)] We need to remember the name of previous temporary DLL/.so libraries so we can link them (see #10322)

initLoaderState :: Interp -> HscEnv -> IO () Source #

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.

uninitializedLoader :: IO Loader Source #

showLoaderState :: Interp -> IO SDoc Source #

Display the loader state.

# Load & Unload

loadExpr :: Interp -> HscEnv -> SrcSpan -> UnlinkedBCO -> IO ForeignHValue Source #

Load a single expression, including first loading packages and modules that this expression depends on.

Raises an IO exception (`ProgramError`) if it can't find a compiled version of the dependents to load.

loadDecls :: Interp -> HscEnv -> SrcSpan -> CompiledByteCode -> IO [(Name, ForeignHValue)] Source #

loadPackages :: Interp -> HscEnv -> [UnitId] -> IO () Source #

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.

loadModule :: Interp -> HscEnv -> Module -> IO () Source #

loadCmdLineLibs :: Interp -> HscEnv -> IO () Source #

loadName :: Interp -> HscEnv -> Name -> IO ForeignHValue Source #

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

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

unload Source #

Arguments

:: Interp |
-> HscEnv |
-> [Linkable] | The linkables to *keep*.
-> IO () |

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.

# LoadedEnv

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

Temporarily extend the loaded env.

extendLoadedEnv :: Interp -> [(Name, ForeignHValue)] -> IO () Source #

deleteFromLoadedEnv :: Interp -> [Name] -> IO () Source #

# Misc

extendLoadedPkgs :: Interp -> [UnitId] -> IO () Source #