llvm-party-12.1.1: General purpose LLVM bindings
Safe HaskellSafe-Inferred
LanguageHaskell2010

LLVM.OrcJIT

Synopsis

ExecutionSession

data ExecutionSession Source #

createExecutionSession :: IO ExecutionSession Source #

Create a new ExecutionSession.

disposeExecutionSession :: ExecutionSession -> IO () Source #

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

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

bracket-style wrapper around createExecutionSession and disposeExecutionSession.

JITDylib

newtype JITDylib Source #

Constructors

JITDylib (Ptr JITDylib) 

createJITDylib :: ExecutionSession -> ShortByteString -> IO JITDylib Source #

Create a new JITDylib with the given name.

Symbol search generators

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

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

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

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 () Source #

Symbol lookups

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

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 Source #

Constructors

JITSymbol 

Fields

Instances

Instances details
Show JITSymbol Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

showsPrec :: Int -> JITSymbol -> ShowS #

show :: JITSymbol -> String #

showList :: [JITSymbol] -> ShowS #

Eq JITSymbol Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

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

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

Ord JITSymbol Source # 
Instance details

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) Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

encodeM :: JITSymbol -> m (Ptr JITEvaluatedSymbol) Source #

(MonadIO m, MonadAnyCont IO m) => DecodeM m (Either JITSymbolError JITSymbol) (Ptr ExpectedJITEvaluatedSymbol) Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

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

data JITSymbolError Source #

Constructors

JITSymbolError ShortByteString 

Instances

Instances details
Show JITSymbolError Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

showsPrec :: Int -> JITSymbolError -> ShowS #

show :: JITSymbolError -> String #

showList :: [JITSymbolError] -> ShowS #

Eq JITSymbolError Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

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

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

(MonadIO m, MonadAnyCont IO m) => DecodeM m (Either JITSymbolError JITSymbol) (Ptr ExpectedJITEvaluatedSymbol) Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

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

data JITSymbolFlags Source #

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

Instances

Instances details
Show JITSymbolFlags Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

showsPrec :: Int -> JITSymbolFlags -> ShowS #

show :: JITSymbolFlags -> String #

showList :: [JITSymbolFlags] -> ShowS #

Eq JITSymbolFlags Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

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

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

Ord JITSymbolFlags Source # 
Instance details

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 Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

decodeM :: JITSymbolFlags0 -> m JITSymbolFlags Source #

Monad m => EncodeM m JITSymbolFlags JITSymbolFlags Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

encodeM :: JITSymbolFlags -> m JITSymbolFlags0 Source #

defaultJITSymbolFlags :: JITSymbolFlags Source #

Mangled symbols

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

disposeMangledSymbol :: MangledSymbol -> IO () Source #

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

ThreadSafeContext

data ThreadSafeContext Source #

Lifetime management

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

bracket-style wrapper around createThreadSafeContext and disposeThreadSafeContext.

createThreadSafeContext :: IO ThreadSafeContext Source #

Create a ThreadSafeContext

disposeThreadSafeContext :: ThreadSafeContext -> IO () Source #

Dispose of a ThreadSafeContext

ThreadSafeModule

newtype ThreadSafeModule Source #

Constructors

ThreadSafeModule (Ptr ThreadSafeModule) 

Lifetime management

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

bracket-style wrapper around cloneAsThreadSafeModule and disposeThreadSafeModule.

cloneAsThreadSafeModule :: Module -> IO ThreadSafeModule Source #

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 () Source #

Dispose of a ThreadSafeModule.

Object layers

class ObjectLayer l Source #

A type class implemented by the different OrcJIT object layers.

See e.g. RTDyldObjectLinkingLayer.

Minimal complete definition

getObjectLayer

Instances

Instances details
ObjectLayer ObjectLinkingLayer Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: ObjectLinkingLayer -> Ptr ObjectLayer Source #

ObjectLayer RTDyldObjectLinkingLayer Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: RTDyldObjectLinkingLayer -> Ptr ObjectLayer Source #

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

ObjectLinkingLayer

data ObjectLinkingLayer Source #

Instances

Instances details
ObjectLayer ObjectLinkingLayer Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: ObjectLinkingLayer -> Ptr ObjectLayer Source #

createObjectLinkingLayer :: ExecutionSession -> IO ObjectLinkingLayer Source #

RTDyldObjectLinkingLayer

data RTDyldObjectLinkingLayer Source #

Instances

Instances details
ObjectLayer RTDyldObjectLinkingLayer Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

getObjectLayer :: RTDyldObjectLinkingLayer -> Ptr ObjectLayer Source #

createRTDyldObjectLinkingLayer :: ExecutionSession -> IO RTDyldObjectLinkingLayer Source #

Create a new RTDyldObjectLinkingLayer.

The layer will get automatically disposed along with its ExecutionSession.

IR layers

class IRLayer l Source #

A type class implemented by the different OrcJIT IR layers.

See e.g. IRCompileLayer.

Minimal complete definition

getIRLayer, getDataLayout, getMangler

Instances

Instances details
IRLayer IRCompileLayer Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

getIRLayer :: IRCompileLayer -> Ptr IRLayer Source #

getDataLayout :: IRCompileLayer -> Ptr DataLayout Source #

getMangler :: IRCompileLayer -> Ptr MangleAndInterner Source #

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

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 Source #

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

Instances

Instances details
IRLayer IRCompileLayer Source # 
Instance details

Defined in LLVM.Internal.OrcJIT

Methods

getIRLayer :: IRCompileLayer -> Ptr IRLayer Source #

getDataLayout :: IRCompileLayer -> Ptr DataLayout Source #

getMangler :: IRCompileLayer -> Ptr MangleAndInterner Source #

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

Create a new IRCompileLayer.

The layer will get automatically disposed along with its ExecutionSession.