Moduleghc-lib-parser-9.14.1.20251220GHC2021

GHC.Linker.Types

14 types
22 values

Packageghc-lib-parser-9.14.1.20251220
Exports36
LanguageGHC2021
LicenceBSD-3-Clause
SourceTypes.hs

newtypenewtype Loader

Constructors

Loader
- loader_state :: MVar (Maybe LoaderState)

datadata LoaderState

Constructors

LoaderState
- linker_env :: !LinkerEnv
  Current global mapping from Names to their true values
- bcos_loaded :: !LinkableSet
  The currently loaded interpreted modules (home package)
- objs_loaded :: !LinkableSet
  And the currently-loaded compiled modules (home package)
- pkgs_loaded :: !PkgsLoaded
  The currently-loaded packages; always object code 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)
- linked_breaks :: !LinkedBreaks
  Mapping from loaded modules to their breakpoint arrays

valueuninitializedLoader :: IO Loader

valuemodifyClosureEnv :: LoaderState -> (ClosureEnv -> ClosureEnv) -> LoaderState

datadata LinkerEnv

Constructors

LinkerEnv
- closure_env :: !ClosureEnv
  Current global mapping from closure Names to their true values
- itbl_env :: !ItblEnv
  The current global mapping from RdrNames of DataCons to info table addresses. When a new LinkablePart is linked into the running image, or an existing module in the image is replaced, the itbl_env must be updated appropriately.
- addr_env :: !AddrEnv
  Like closure_env and itbl_env, but for top-level Addr# literals, see Note [Generating code for top-level string literal bindings] in GHC.StgToByteCode.

valuefilterLinkerEnv :: (Name -> Bool) -> LinkerEnv -> LinkerEnv

typetype ClosureEnv = NameEnv (Name, ForeignHValue)

valueemptyClosureEnv :: ClosureEnv

valueextendClosureEnv :: ClosureEnv -> [(Name, ForeignHValue)] -> ClosureEnv

datadata LinkedBreaks

BreakArrays and CCSs are allocated per-module at link-time.

Specifically, a module's BreakArray is allocated either: - When a BCO for that module is linked - When :break is used on a given module *before* the BCO has been linked.

We keep this structure in the LoaderState

Constructors

LinkedBreaks
- breakarray_env :: !ModuleEnv (ForeignRef BreakArray)
  Each Modules remote pointer of BreakArray.
- ccs_env :: !ModuleEnv (Array BreakTickIndex (RemotePtr CostCentre))
  Each Modules array of remote pointers of CostCentre. Untouched when not profiling.

valuefilterLinkedBreaks :: (Module -> Bool) -> LinkedBreaks -> LinkedBreaks

typetype LinkableSet = ModuleEnv Linkable

valuemkLinkableSet :: [Linkable] -> LinkableSet

valueunionLinkableSet :: LinkableSet -> LinkableSet -> LinkableSet

Union of LinkableSets.

In case of conflict, keep the most recent Linkable (as per linkableTime)

typetype ObjFile = FilePath

datadata SptEntry

An entry to be inserted into a module's static pointer table. See Note [Grand plan for static forms] in GHC.Iface.Tidy.StaticPtrTable.

Constructors

SptEntry Id Fingerprint

Instances1Outputable

Outputable SptEntryDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Types.SptEntry

datadata LibrarySpec

Constructors

Instances1Outputable

Outputable LibrarySpecDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Linker.Types

datadata LoadedPkgInfo

Constructors

LoadedPkgInfo
- loaded_pkg_uid :: !UnitId
- loaded_pkg_hs_objs :: ![LibrarySpec]
- loaded_pkg_non_hs_objs :: ![LibrarySpec]
- loaded_pkg_hs_dlls :: ![RemotePtr LoadedDLL]
  See Note [Looking up symbols in the relevant objects]
- loaded_pkg_trans_deps :: UniqDSet UnitId

Instances1Outputable

Outputable LoadedPkgInfoDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Linker.Types

typetype PkgsLoaded = UniqDFM UnitId LoadedPkgInfo

Linkable

17 declarations

datadata Linkable

Information we can use to dynamically link modules into the compiler

Constructors

Linkable
- linkableTime :: !UTCTime
  Time at which this linkable was built (i.e. when the bytecodes were produced, or the mod date on the files)
- linkableModule :: !Module
  The linkable module itself
- linkableParts :: NonEmpty LinkablePart
  Files and chunks of code to link.

Instances1Outputable

Outputable LinkableDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Linker.Types

datadata LinkablePart

Objects which have yet to be linked by the compiler

Constructors

DotO ObjFile LinkableObjectSort
DotA FilePath
Static archive file (.a)
DotDLL FilePath
Dynamically linked library file (.so, .dll, .dylib)
CoreBindings WholeCoreBindings
Serialised core which we can turn into BCOs (or object files), or used by some other backend See Note [Interface Files with Core Definitions]
LazyBCOs CompiledByteCode [FilePath]
BCOs CompiledByteCode
A byte-code object, lives only in memory.

Instances1Outputable

Outputable LinkablePartDefined in ghc-lib-parser-9.14.1.20251220 · GHC.Linker.Types

datadata LinkableObjectSort

Classify the provenance of .o products.

Constructors

ModuleObject
The object is the final product for a module. When linking splices, its file extension will be adapted to the interpreter's way if needed.
ForeignObject
The object was created from generated code for foreign stubs or foreign sources added by the user. Its file extension must be preserved, since there are no objects for alternative ways available.

valuelinkableIsNativeCodeOnly :: Linkable -> Bool

Return true if the linkable only consists of native code (no BCO)

valuelinkableObjs :: Linkable -> [FilePath]

List the native objects (.o) of a linkable

valuelinkableLibs :: Linkable -> [LinkablePart]

List the native libraries (.so/.dll) of a linkable

valuelinkableFiles :: Linkable -> [FilePath]

List the paths of the native objects and libraries (.o.so.dll)

valuelinkableBCOs :: Linkable -> [CompiledByteCode]

List the BCOs parts of a linkable.

This excludes the LazyBCOs and the CoreBindings parts

valuelinkableNativeParts :: Linkable -> [LinkablePart]

List the native linkable parts (.o.so.dll) of a linkable

valuelinkablePartitionParts :: Linkable -> ([LinkablePart], [LinkablePart])

Split linkable parts into (native code parts, BCOs parts)

valuelinkablePartPath :: LinkablePart -> Maybe FilePath

Get the FilePath of linkable part (if applicable)

valuelinkablePartAllBCOs :: LinkablePart -> [CompiledByteCode]

Retrieve the compiled byte-code from the linkable part.

Contrary to linkableBCOs, this includes byte-code from LazyBCOs.

valueisNativeCode :: LinkablePart -> Bool

Is the part a native object or library? (.o.so.dll)

valueisNativeLib :: LinkablePart -> Bool

Is the part a native library? (.so/.dll)

valuelinkableFilterByteCode :: Linkable -> Maybe Linkable

Transform the LinkablePart list in this Linkable to contain only byte code without LazyBCOs. If no LinkablePart remains, return Nothing.

valuelinkableFilterNative :: Linkable -> Maybe Linkable

Transform the LinkablePart list in this Linkable to contain only object code files (.o, .a, .so) without LazyBCOs. If no LinkablePart remains, return Nothing.

valuepartitionLinkables :: [Linkable] -> ([Linkable], [Linkable])

Split the LinkablePart lists in each Linkable into only object code files (.o, .a, .so) and only byte code, without LazyBCOs, and return two lists containing the nonempty Linkables for each.