LLVM.Internal.OrcJIT.CompileLayer

Documentation

class CompileLayer l where

There are two main types of operations provided by instances of CompileLayer.

1. You can add / remove modules using addModuleSet / removeModuleSet.
2. You can search for symbols using findSymbol / findSymbolIn in the previously added modules.

Minimal complete definition

getCompileLayer, getDataLayout, getCleanups

Methods

getCompileLayer :: l -> Ptr CompileLayer

getDataLayout :: l -> Ptr DataLayout

getCleanups :: l -> IORef [IO ()]

Instances

CompileLayer (CompileOnDemandLayer l)

Methods

getCompileLayer :: CompileOnDemandLayer l -> Ptr CompileLayer

getDataLayout :: CompileOnDemandLayer l -> Ptr DataLayout

getCleanups :: CompileOnDemandLayer l -> IORef [IO ()]

CompileLayer (IRCompileLayer l)

Methods

getCompileLayer :: IRCompileLayer l -> Ptr CompileLayer

getDataLayout :: IRCompileLayer l -> Ptr DataLayout

getCleanups :: IRCompileLayer l -> IORef [IO ()]

CompileLayer (IRTransformLayer l)

Methods

getCompileLayer :: IRTransformLayer l -> Ptr CompileLayer

getDataLayout :: IRTransformLayer l -> Ptr DataLayout

getCleanups :: IRTransformLayer l -> IORef [IO ()]

mangleSymbol :: CompileLayer l => l -> ShortByteString -> IO MangledSymbol

Mangle a symbol according to the data layout stored in the CompileLayer.

findSymbol :: CompileLayer l => l -> MangledSymbol -> Bool -> IO JITSymbol

findSymbol layer symbol exportedSymbolsOnly searches for symbol in all modules added to layer. If exportedSymbolsOnly is True only exported symbols are searched.

findSymbolIn :: CompileLayer l => l -> ModuleSetHandle -> MangledSymbol -> Bool -> IO JITSymbol

findSymbolIn layer handle symbol exportedSymbolsOnly searches for symbol in the context of the modules represented by handle. If exportedSymbolsOnly is True only exported symbols are searched.

addModuleSet :: CompileLayer l => l -> [Module] -> SymbolResolver -> IO ModuleSetHandle

Add a list of modules to the CompileLayer. The SymbolResolver is used to resolve external symbols in these modules.

Note: This function consumes the modules passed be it and they must not be used after calling this method.

removeModuleSet :: CompileLayer l => l -> ModuleSetHandle -> IO ()

Remove a set of previously added modules.

withModuleSet :: CompileLayer l => l -> [Module] -> SymbolResolver -> (ModuleSetHandle -> IO a) -> IO a

bracket-style wrapper around addModuleSet and removeModuleSet.

Note: This function consumes the modules passed to it and they must not be used after calling this method.

disposeCompileLayer :: CompileLayer l => l -> IO ()

Dispose of a CompileLayer. This should called when the CompileLayer is not needed anymore.

data ModuleSetHandle

Abstract type representing a set of modules in a CompileLayer.