Safe Haskell	None
Language	Haskell2010

LLVM.OrcJIT

Contents

CompileLayer
LinkingLayer
JITCompileCallbackManager
IndirectStubsManagerBuilder

Synopsis

class CompileLayer l
data ModuleHandle
addModule :: CompileLayer l => l -> Module -> SymbolResolver -> IO ModuleHandle
removeModule :: CompileLayer l => l -> ModuleHandle -> IO ()
withModule :: CompileLayer l => l -> Module -> SymbolResolver -> (ModuleHandle -> IO a) -> IO a
data JITSymbol = JITSymbol {
- jitSymbolAddress :: !WordPtr
- jitSymbolFlags :: !JITSymbolFlags
}
data JITSymbolError = JITSymbolError ShortByteString
data JITSymbolFlags = JITSymbolFlags {
- jitSymbolWeak :: !Bool
- jitSymbolCommon :: !Bool
- jitSymbolAbsolute :: !Bool
- jitSymbolExported :: !Bool
}
defaultJITSymbolFlags :: JITSymbolFlags
data SymbolResolver = SymbolResolver {
- dylibResolver :: !SymbolResolverFn
- externalResolver :: !SymbolResolverFn
}
data MangledSymbol
mangleSymbol :: CompileLayer l => l -> ShortByteString -> IO MangledSymbol
data IRCompileLayer linkingLayer
newIRCompileLayer :: LinkingLayer l => l -> TargetMachine -> IO (IRCompileLayer l)
withIRCompileLayer :: LinkingLayer l => l -> TargetMachine -> (IRCompileLayer l -> IO a) -> IO a
data CompileOnDemandLayer baseLayer
newCompileOnDemandLayer :: CompileLayer l => l -> TargetMachine -> (Ptr Function -> IO [Ptr Function]) -> JITCompileCallbackManager -> IndirectStubsManagerBuilder -> Bool -> IO (CompileOnDemandLayer l)
withCompileOnDemandLayer :: CompileLayer l => l -> TargetMachine -> (Ptr Function -> IO [Ptr Function]) -> JITCompileCallbackManager -> IndirectStubsManagerBuilder -> Bool -> (CompileOnDemandLayer l -> IO a) -> IO a
data IRTransformLayer baseLayer
newIRTransformLayer :: CompileLayer l => l -> TargetMachine -> (Ptr Module -> IO (Ptr Module)) -> IO (IRTransformLayer l)
withIRTransformLayer :: CompileLayer l => l -> TargetMachine -> (Ptr Module -> IO (Ptr Module)) -> (IRTransformLayer l -> IO a) -> IO a
disposeCompileLayer :: CompileLayer l => l -> IO ()
class LinkingLayer l
data ObjectLinkingLayer
newObjectLinkingLayer :: IO ObjectLinkingLayer
withObjectLinkingLayer :: (ObjectLinkingLayer -> IO a) -> IO a
disposeLinkingLayer :: LinkingLayer l => l -> IO ()
addObjectFile :: LinkingLayer l => l -> ObjectFile -> SymbolResolver -> IO ObjectHandle
data JITCompileCallbackManager
newJITCompileCallbackManager :: ShortByteString -> Maybe (IO ()) -> IO JITCompileCallbackManager
disposeJITCompileCallbackManager :: JITCompileCallbackManager -> IO ()
withJITCompileCallbackManager :: ShortByteString -> Maybe (IO ()) -> (JITCompileCallbackManager -> IO a) -> IO a
data IndirectStubsManagerBuilder
newIndirectStubsManagerBuilder :: ShortByteString -> IO IndirectStubsManagerBuilder
disposeIndirectStubsManagerBuilder :: IndirectStubsManagerBuilder -> IO ()
withIndirectStubsManagerBuilder :: ShortByteString -> (IndirectStubsManagerBuilder -> IO a) -> IO a

CompileLayer

class CompileLayer l Source #

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

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

Minimal complete definition

getCompileLayer, getDataLayout, getCleanups

Instances

CompileLayer (IRTransformLayer l) Source #
Instance details Defined in LLVM.Internal.OrcJIT.IRTransformLayer Methods getCompileLayer :: IRTransformLayer l -> Ptr CompileLayer Source # getDataLayout :: IRTransformLayer l -> Ptr DataLayout Source # getCleanups :: IRTransformLayer l -> IORef [IO ()] Source #
CompileLayer (IRCompileLayer l) Source #
Instance details Defined in LLVM.Internal.OrcJIT.IRCompileLayer Methods getCompileLayer :: IRCompileLayer l -> Ptr CompileLayer Source # getDataLayout :: IRCompileLayer l -> Ptr DataLayout Source # getCleanups :: IRCompileLayer l -> IORef [IO ()] Source #
CompileLayer (CompileOnDemandLayer l) Source #
Instance details Defined in LLVM.Internal.OrcJIT.CompileOnDemandLayer Methods getCompileLayer :: CompileOnDemandLayer l -> Ptr CompileLayer Source # getDataLayout :: CompileOnDemandLayer l -> Ptr DataLayout Source # getCleanups :: CompileOnDemandLayer l -> IORef [IO ()] Source #

Add/remove modules

data ModuleHandle Source #

Abstract type representing a module in a CompileLayer.

addModule :: CompileLayer l => l -> Module -> SymbolResolver -> IO ModuleHandle Source #

Add a module to the CompileLayer. The SymbolResolver is used to resolve external symbols in the module.

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

removeModule :: CompileLayer l => l -> ModuleHandle -> IO () Source #

Remove a previously added module.

withModule :: CompileLayer l => l -> Module -> SymbolResolver -> (ModuleHandle -> IO a) -> IO a Source #

bracket-style wrapper around addModule and removeModule.

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

Search for symbols

data JITSymbol Source #

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

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 #
Show JITSymbol Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods showsPrec :: Int -> JITSymbol -> ShowS # show :: JITSymbol -> String # showList :: [JITSymbol] -> ShowS #
MonadIO m => EncodeM m SymbolResolverFn (FunPtr SymbolResolverFn) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods encodeM :: SymbolResolverFn -> m (FunPtr SymbolResolverFn0) Source #
(MonadIO m, MonadAnyCont IO m) => DecodeM m (Either JITSymbolError JITSymbol) (Ptr JITSymbol) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods decodeM :: Ptr JITSymbol0 -> m (Either JITSymbolError JITSymbol) Source #
MonadIO m => EncodeM m (Either JITSymbolError JITSymbol) (Ptr JITSymbol -> IO ()) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods encodeM :: Either JITSymbolError JITSymbol -> m (Ptr JITSymbol0 -> IO ()) Source #

data JITSymbolError Source #

Constructors

JITSymbolError ShortByteString

Instances

Eq JITSymbolError Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods (==) :: JITSymbolError -> JITSymbolError -> Bool # (/=) :: JITSymbolError -> JITSymbolError -> Bool #
Show JITSymbolError Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods showsPrec :: Int -> JITSymbolError -> ShowS # show :: JITSymbolError -> String # showList :: [JITSymbolError] -> ShowS #
MonadIO m => EncodeM m SymbolResolverFn (FunPtr SymbolResolverFn) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods encodeM :: SymbolResolverFn -> m (FunPtr SymbolResolverFn0) Source #
(MonadIO m, MonadAnyCont IO m) => DecodeM m (Either JITSymbolError JITSymbol) (Ptr JITSymbol) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods decodeM :: Ptr JITSymbol0 -> m (Either JITSymbolError JITSymbol) Source #
MonadIO m => EncodeM m (Either JITSymbolError JITSymbol) (Ptr JITSymbol -> IO ()) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods encodeM :: Either JITSymbolError JITSymbol -> m (Ptr JITSymbol0 -> IO ()) 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 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?

Instances

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 #
Show JITSymbolFlags Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods showsPrec :: Int -> JITSymbolFlags -> ShowS # show :: JITSymbolFlags -> String # showList :: [JITSymbolFlags] -> ShowS #
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 #

data SymbolResolver Source #

Specifies how external symbols in a module added to a CompielLayer should be resolved.

Constructors

SymbolResolver
Fields dylibResolver :: !SymbolResolverFn This is used to find symbols in the same logical dynamic library as the module referencing them. externalResolver :: !SymbolResolverFn When `dylibResolver` fails to resolve a symbol, `externalResolver` is used as a fallback to find external symbols.

Instances

MonadIO m => EncodeM m SymbolResolver (IORef [IO ()] -> IO (Ptr LambdaResolver)) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods encodeM :: SymbolResolver -> m (IORef [IO ()] -> IO (Ptr LambdaResolver)) Source #

Symbol mangling

data MangledSymbol Source #

A mangled symbol which can be used in findSymbol. This can be created using mangleSymbol.

Instances

Eq MangledSymbol Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods (==) :: MangledSymbol -> MangledSymbol -> Bool # (/=) :: MangledSymbol -> MangledSymbol -> Bool #
Ord MangledSymbol Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods compare :: MangledSymbol -> MangledSymbol -> Ordering # (<) :: MangledSymbol -> MangledSymbol -> Bool # (<=) :: MangledSymbol -> MangledSymbol -> Bool # (>) :: MangledSymbol -> MangledSymbol -> Bool # (>=) :: MangledSymbol -> MangledSymbol -> Bool # max :: MangledSymbol -> MangledSymbol -> MangledSymbol # min :: MangledSymbol -> MangledSymbol -> MangledSymbol #
Show MangledSymbol Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods showsPrec :: Int -> MangledSymbol -> ShowS # show :: MangledSymbol -> String # showList :: [MangledSymbol] -> ShowS #
MonadIO m => DecodeM m MangledSymbol CString Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods decodeM :: CString -> m MangledSymbol Source #
MonadIO m => EncodeM m SymbolResolverFn (FunPtr SymbolResolverFn) Source #
Instance details Defined in LLVM.Internal.OrcJIT Methods encodeM :: SymbolResolverFn -> m (FunPtr SymbolResolverFn0) Source #

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

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

IRCompileLayer

data IRCompileLayer linkingLayer Source #

IRCompileLayer compiles modules immediately when they are added. It parametrized by a LinkingLayer which handles linking of the generated object files.

Instances

Eq (IRCompileLayer linkingLayer) Source #
Instance details Defined in LLVM.Internal.OrcJIT.IRCompileLayer Methods (==) :: IRCompileLayer linkingLayer -> IRCompileLayer linkingLayer -> Bool # (/=) :: IRCompileLayer linkingLayer -> IRCompileLayer linkingLayer -> Bool #
CompileLayer (IRCompileLayer l) Source #
Instance details Defined in LLVM.Internal.OrcJIT.IRCompileLayer Methods getCompileLayer :: IRCompileLayer l -> Ptr CompileLayer Source # getDataLayout :: IRCompileLayer l -> Ptr DataLayout Source # getCleanups :: IRCompileLayer l -> IORef [IO ()] Source #

newIRCompileLayer :: LinkingLayer l => l -> TargetMachine -> IO (IRCompileLayer l) Source #

Create a new IRCompileLayer.

When the layer is no longer needed, it should be disposed using 'disposeCompileLayer.

withIRCompileLayer :: LinkingLayer l => l -> TargetMachine -> (IRCompileLayer l -> IO a) -> IO a Source #

bracket-style wrapper around newIRCompileLayer and disposeCompileLayer.

CompileOnDemandLayer

data CompileOnDemandLayer baseLayer Source #

Adding a module to a CompileOnDemandLayer creates stubs for its functions definitions. When one of those stubs is called, the corresponding function body is extracted and compiled.

Instances

Eq (CompileOnDemandLayer baseLayer) Source #
Instance details Defined in LLVM.Internal.OrcJIT.CompileOnDemandLayer Methods (==) :: CompileOnDemandLayer baseLayer -> CompileOnDemandLayer baseLayer -> Bool # (/=) :: CompileOnDemandLayer baseLayer -> CompileOnDemandLayer baseLayer -> Bool #
CompileLayer (CompileOnDemandLayer l) Source #
Instance details Defined in LLVM.Internal.OrcJIT.CompileOnDemandLayer Methods getCompileLayer :: CompileOnDemandLayer l -> Ptr CompileLayer Source # getDataLayout :: CompileOnDemandLayer l -> Ptr DataLayout Source # getCleanups :: CompileOnDemandLayer l -> IORef [IO ()] Source #

newCompileOnDemandLayer Source #

Arguments

:: CompileLayer l
=> l
-> TargetMachine
-> (Ptr Function -> IO [Ptr Function])	partitioning function
-> JITCompileCallbackManager
-> IndirectStubsManagerBuilder
-> Bool	clone stubs into partitions
-> IO (CompileOnDemandLayer l)

Create a new CompileOnDemandLayer. The partitioning function specifies which functions should be compiled when a function is called.

When the layer is no longer needed, it should be disposed using disposeCompileLayer.

withCompileOnDemandLayer Source #

Arguments

:: CompileLayer l
=> l
-> TargetMachine
-> (Ptr Function -> IO [Ptr Function])	partitioning function
-> JITCompileCallbackManager
-> IndirectStubsManagerBuilder
-> Bool	clone stubs into partitions
-> (CompileOnDemandLayer l -> IO a)
-> IO a

bracket-style wrapper around newCompileOnDemandLayer and disposeCompileLayer.

IRTRansformLayer

data IRTransformLayer baseLayer Source #

IRTransformLayer allows transforming modules before handing off compilation to the underlying CompileLayer.

Instances

Eq (IRTransformLayer baseLayer) Source #
Instance details Defined in LLVM.Internal.OrcJIT.IRTransformLayer Methods (==) :: IRTransformLayer baseLayer -> IRTransformLayer baseLayer -> Bool # (/=) :: IRTransformLayer baseLayer -> IRTransformLayer baseLayer -> Bool #
CompileLayer (IRTransformLayer l) Source #
Instance details Defined in LLVM.Internal.OrcJIT.IRTransformLayer Methods getCompileLayer :: IRTransformLayer l -> Ptr CompileLayer Source # getDataLayout :: IRTransformLayer l -> Ptr DataLayout Source # getCleanups :: IRTransformLayer l -> IORef [IO ()] Source #

newIRTransformLayer Source #

Arguments

:: CompileLayer l
=> l
-> TargetMachine
-> (Ptr Module -> IO (Ptr Module))	module transformation
-> IO (IRTransformLayer l)

Create a new IRTransformLayer.

When the layer is no longer needed, it should be disposed using disposeCompileLayer.

withIRTransformLayer Source #

Arguments

:: CompileLayer l
=> l
-> TargetMachine
-> (Ptr Module -> IO (Ptr Module))	module transformation
-> (IRTransformLayer l -> IO a)
-> IO a

bracket-style wrapper around newIRTransformLayer and disposeCompileLayer.

Dispose of compile layers

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

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

LinkingLayer

class LinkingLayer l Source #

After a CompileLayer has compiled the modules to object code, it passes the resulting object files to a LinkingLayer.

Minimal complete definition

getLinkingLayer, getCleanups

Instances

LinkingLayer ObjectLinkingLayer Source #
Instance details Defined in LLVM.Internal.OrcJIT.LinkingLayer Methods getLinkingLayer :: ObjectLinkingLayer -> Ptr LinkingLayer Source # getCleanups :: ObjectLinkingLayer -> IORef [IO ()] Source #

Create linking layers

data ObjectLinkingLayer Source #

Bare bones implementation of a LinkingLayer.

Instances

LinkingLayer ObjectLinkingLayer Source #
Instance details Defined in LLVM.Internal.OrcJIT.LinkingLayer Methods getLinkingLayer :: ObjectLinkingLayer -> Ptr LinkingLayer Source # getCleanups :: ObjectLinkingLayer -> IORef [IO ()] Source #

newObjectLinkingLayer :: IO ObjectLinkingLayer Source #

Create a new ObjectLinkingLayer. This should be disposed using disposeLinkingLayer when it is no longer needed.

withObjectLinkingLayer :: (ObjectLinkingLayer -> IO a) -> IO a Source #

bracket-style wrapper around newObjectLinkingLayer and disposeLinkingLayer.

Dispose of linking layers

disposeLinkingLayer :: LinkingLayer l => l -> IO () Source #

Dispose of a LinkingLayer.

Add an object file

addObjectFile :: LinkingLayer l => l -> ObjectFile -> SymbolResolver -> IO ObjectHandle Source #

Add an object file to the LinkingLayer. The SymbolResolver is used to resolve external symbols in the module.

JITCompileCallbackManager

data JITCompileCallbackManager Source #

This is used by CompileOnDemandLayer to create callback that compile functions when they are called.

newJITCompileCallbackManager Source #

Arguments

:: ShortByteString	target triple
-> Maybe (IO ())	called on compilation errors
-> IO JITCompileCallbackManager

Create a new JITCompileCallbackManager.

When the callback manager is no longer needed, it should be freed using disposeJITCompileCallbackManager.

disposeJITCompileCallbackManager :: JITCompileCallbackManager -> IO () Source #

Dispose of a JITCompileCallbackManager.

withJITCompileCallbackManager Source #

Arguments

:: ShortByteString	target triple
-> Maybe (IO ())	called on compilation errors
-> (JITCompileCallbackManager -> IO a)
-> IO a

Execute a computation using a new JITCompileCallbackManager.

IndirectStubsManagerBuilder

data IndirectStubsManagerBuilder Source #

This is used by CompileOnDemandLayer to manage the stubs created for function definitions that have not yet been compiled.

newIndirectStubsManagerBuilder Source #

Arguments

:: ShortByteString	target triple
-> IO IndirectStubsManagerBuilder

Create a new IndirectStubsManagerBuilder.

When the stubs manager is no longer needed, it should be freed using disposeIndirectStubsManagerBuilder.

disposeIndirectStubsManagerBuilder :: IndirectStubsManagerBuilder -> IO () Source #

Dispose of an IndirectStubsManagerBuilder.

withIndirectStubsManagerBuilder Source #

Arguments

:: ShortByteString	target triple
-> (IndirectStubsManagerBuilder -> IO a)
-> IO a

bracket-style wrapper around newIndirectStubsManagerBuilder and disposeIndirectStubsManagerBuilder.