LLVM.OrcJIT

ExecutionSession

data ExecutionSession

createExecutionSession :: IO ExecutionSession

Create a new ExecutionSession.

disposeExecutionSession :: ExecutionSession -> IO ()

Dispose of an ExecutionSession. This should be called when the ExecutionSession is not needed anymore.

withExecutionSession :: (ExecutionSession -> IO a) -> IO a

bracket-style wrapper around createExecutionSession and disposeExecutionSession.

JITDylib

newtype JITDylib

Constructors

JITDylib (Ptr JITDylib)

createJITDylib :: ExecutionSession -> ShortByteString -> IO JITDylib

Create a new JITDylib with the given name.

Symbol search generators

addDynamicLibrarySearchGeneratorForCurrentProcess :: IRLayer l => l -> JITDylib -> IO ()

Adds a JITDylib definition generator that looks up missing symbols in the namespace of the current process.

addDynamicLibrarySearchGenerator :: IRLayer l => l -> JITDylib -> FilePath -> IO ()

Adds a JITDylib definition generator that looks up missing symbols in the namespace of a shared library located at the specified FilePath.

Symbol definitions

defineAbsoluteSymbols :: JITDylib -> [(MangledSymbol, JITSymbol)] -> IO ()

Symbol lookups

lookupSymbol :: IRLayer l => ExecutionSession -> l -> JITDylib -> ShortByteString -> IO (Either JITSymbolError JITSymbol)

Looks up an (unmangled) symbol name in the given JITDylib.

The symbol is expected to have been added to the JITDylib by the same IRLayer as specified in this function. Using a different IRLayer can cause the lookup to fail due to differences in mangling schemes.

data JITSymbol

Constructors

JITSymbol

Fields

• jitSymbolAddress :: !WordPtr

  The address of the symbol. If you’ve looked up a function, you need to cast this to a FunPtr.

• jitSymbolFlags :: !JITSymbolFlags

  The flags of this symbol.

Instances

Show JITSymbol

Defined in LLVM.Internal.OrcJIT

Methods

showsPrec :: Int -> JITSymbol -> ShowS

show :: JITSymbol -> String

showList :: [JITSymbol] -> ShowS

Eq JITSymbol

Defined in LLVM.Internal.OrcJIT

Methods

(==) :: JITSymbol -> JITSymbol -> Bool

(/=) :: JITSymbol -> JITSymbol -> Bool

Ord JITSymbol

Defined in LLVM.Internal.OrcJIT

Methods

compare :: JITSymbol -> JITSymbol -> Ordering

(<) :: JITSymbol -> JITSymbol -> Bool

(<=) :: JITSymbol -> JITSymbol -> Bool

(>) :: JITSymbol -> JITSymbol -> Bool

(>=) :: JITSymbol -> JITSymbol -> Bool

max :: JITSymbol -> JITSymbol -> JITSymbol

min :: JITSymbol -> JITSymbol -> JITSymbol

(Monad m, MonadIO m, MonadAnyCont IO m) => EncodeM m JITSymbol (Ptr JITEvaluatedSymbol)

Defined in LLVM.Internal.OrcJIT

Methods

encodeM :: JITSymbol -> m (Ptr JITEvaluatedSymbol)

(MonadIO m, MonadAnyCont IO m) => DecodeM m (Either JITSymbolError JITSymbol) (Ptr ExpectedJITEvaluatedSymbol)

Defined in LLVM.Internal.OrcJIT

Methods

decodeM :: Ptr ExpectedJITEvaluatedSymbol -> m (Either JITSymbolError JITSymbol)

data JITSymbolError

Constructors

JITSymbolError ShortByteString

Instances

Show JITSymbolError

Defined in LLVM.Internal.OrcJIT

Methods

showsPrec :: Int -> JITSymbolError -> ShowS

show :: JITSymbolError -> String

showList :: [JITSymbolError] -> ShowS

Eq JITSymbolError

Defined in LLVM.Internal.OrcJIT

Methods

(==) :: JITSymbolError -> JITSymbolError -> Bool

(/=) :: JITSymbolError -> JITSymbolError -> Bool

(MonadIO m, MonadAnyCont IO m) => DecodeM m (Either JITSymbolError JITSymbol) (Ptr ExpectedJITEvaluatedSymbol)

Defined in LLVM.Internal.OrcJIT

Methods

decodeM :: Ptr ExpectedJITEvaluatedSymbol -> m (Either JITSymbolError JITSymbol)

data JITSymbolFlags

Contrary to the C++ interface, we do not store the HasError flag here. Instead decoding a JITSymbol produces a sumtype based on whether that flag is set or not.

Constructors

JITSymbolFlags

Fields

• jitSymbolWeak :: !Bool

  Is this a weak symbol?

• jitSymbolCommon :: !Bool

  Is this a common symbol?

• jitSymbolAbsolute :: !Bool

  Is this an absolute symbol? This will cause LLVM to use absolute relocations for the symbol even in position independent code.

• jitSymbolExported :: !Bool

  Is this symbol exported?

• jitSymbolCallable :: !Bool
• jitSymbolMaterializationSideEffectsOnly :: !Bool

Instances

Show JITSymbolFlags

Defined in LLVM.Internal.OrcJIT

Methods

showsPrec :: Int -> JITSymbolFlags -> ShowS

show :: JITSymbolFlags -> String

showList :: [JITSymbolFlags] -> ShowS

Eq JITSymbolFlags

Defined in LLVM.Internal.OrcJIT

Methods

(==) :: JITSymbolFlags -> JITSymbolFlags -> Bool

(/=) :: JITSymbolFlags -> JITSymbolFlags -> Bool

Ord JITSymbolFlags

Defined in LLVM.Internal.OrcJIT

Methods

compare :: JITSymbolFlags -> JITSymbolFlags -> Ordering

(<) :: JITSymbolFlags -> JITSymbolFlags -> Bool

(<=) :: JITSymbolFlags -> JITSymbolFlags -> Bool

(>) :: JITSymbolFlags -> JITSymbolFlags -> Bool

(>=) :: JITSymbolFlags -> JITSymbolFlags -> Bool

max :: JITSymbolFlags -> JITSymbolFlags -> JITSymbolFlags

min :: JITSymbolFlags -> JITSymbolFlags -> JITSymbolFlags

Monad m => DecodeM m JITSymbolFlags JITSymbolFlags

Defined in LLVM.Internal.OrcJIT

Methods

decodeM :: JITSymbolFlags0 -> m JITSymbolFlags

Monad m => EncodeM m JITSymbolFlags JITSymbolFlags

Defined in LLVM.Internal.OrcJIT

Methods

encodeM :: JITSymbolFlags -> m JITSymbolFlags0

defaultJITSymbolFlags :: JITSymbolFlags

Mangled symbols

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

disposeMangledSymbol :: MangledSymbol -> IO ()

withMangledSymbol :: IRLayer l => l -> ShortByteString -> (MangledSymbol -> IO a) -> IO a

ThreadSafeContext

data ThreadSafeContext

Lifetime management

withThreadSafeContext :: (ThreadSafeContext -> IO a) -> IO a

bracket-style wrapper around createThreadSafeContext and disposeThreadSafeContext.

createThreadSafeContext :: IO ThreadSafeContext

Create a ThreadSafeContext

disposeThreadSafeContext :: ThreadSafeContext -> IO ()

Dispose of a ThreadSafeContext

ThreadSafeModule

newtype ThreadSafeModule

Constructors

ThreadSafeModule (Ptr ThreadSafeModule)

Lifetime management

withClonedThreadSafeModule :: Module -> (ThreadSafeModule -> IO a) -> IO a

bracket-style wrapper around cloneAsThreadSafeModule and disposeThreadSafeModule.

cloneAsThreadSafeModule :: Module -> IO ThreadSafeModule

Create a ThreadSafeModule with the same content as the input Module.

The module will get cloned into a fresh LLVM context. The lifetime of the new context is bound to the lifetime of the returned ThreadSafeModule.

disposeThreadSafeModule :: ThreadSafeModule -> IO ()

Dispose of a ThreadSafeModule.

Object layers

class ObjectLayer l

A type class implemented by the different OrcJIT object layers.

See e.g. RTDyldObjectLinkingLayer.

Minimal complete definition

getObjectLayer

Instances

ObjectLayer ObjectLinkingLayer

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: ObjectLinkingLayer -> Ptr ObjectLayer

ObjectLayer RTDyldObjectLinkingLayer

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: RTDyldObjectLinkingLayer -> Ptr ObjectLayer

addObjectFile :: ObjectLayer l => l -> JITDylib -> FilePath -> IO ()

ObjectLinkingLayer

data ObjectLinkingLayer

Instances

ObjectLayer ObjectLinkingLayer

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: ObjectLinkingLayer -> Ptr ObjectLayer

createObjectLinkingLayer :: ExecutionSession -> IO ObjectLinkingLayer

RTDyldObjectLinkingLayer

data RTDyldObjectLinkingLayer

Instances

ObjectLayer RTDyldObjectLinkingLayer

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: RTDyldObjectLinkingLayer -> Ptr ObjectLayer

createRTDyldObjectLinkingLayer :: ExecutionSession -> IO RTDyldObjectLinkingLayer

Create a new RTDyldObjectLinkingLayer.

The layer will get automatically disposed along with its ExecutionSession.

IR layers

class IRLayer l

A type class implemented by the different OrcJIT IR layers.

See e.g. IRCompileLayer.

Minimal complete definition

getIRLayer, getDataLayout, getMangler

Instances

IRLayer IRCompileLayer

Defined in LLVM.Internal.OrcJIT

Methods

getIRLayer :: IRCompileLayer -> Ptr IRLayer

getDataLayout :: IRCompileLayer -> Ptr DataLayout

getMangler :: IRCompileLayer -> Ptr MangleAndInterner

addModule :: IRLayer l => ThreadSafeModule -> JITDylib -> l -> IO ()

Add a Module to the specified JITDylib.

The specified IRLayer will be responsible for compiling the symbols present in the module. The module itself is consumed and should not be used again.

IRCompileLayer

data IRCompileLayer

An IR layer that compiles the symbols in a module eagerly.

Instances

IRLayer IRCompileLayer

Defined in LLVM.Internal.OrcJIT

Methods

getIRLayer :: IRCompileLayer -> Ptr IRLayer

getDataLayout :: IRCompileLayer -> Ptr DataLayout

getMangler :: IRCompileLayer -> Ptr MangleAndInterner

createIRCompileLayer :: ObjectLayer l => ExecutionSession -> l -> TargetMachine -> IO IRCompileLayer

Create a new IRCompileLayer.

The layer will get automatically disposed along with its ExecutionSession.