1 /*===----------- llvm-c/OrcBindings.h - Orc Lib C Iface ---------*- C++ -*-===*\
3 |* The LLVM Compiler Infrastructure *|
5 |* This file is distributed under the University of Illinois Open Source *|
6 |* License. See LICENSE.TXT for details. *|
8 |*===----------------------------------------------------------------------===*|
10 |* This header declares the C interface to libLLVMOrcJIT.a, which implements *|
11 |* JIT compilation of LLVM IR. *|
13 |* Many exotic languages can interoperate with C code but have a harder time *|
14 |* with C++ due to name mangling. So in addition to C, this interface enables *|
15 |* tools written in such languages. *|
17 |* Note: This interface is experimental. It is *NOT* stable, and may be *|
18 |* changed without warning. *|
20 \*===----------------------------------------------------------------------===*/
22 #ifndef LLVM_C_ORCBINDINGS_H
23 #define LLVM_C_ORCBINDINGS_H
25 #include "llvm-c/Object.h"
26 #include "llvm-c/Support.h"
27 #include "llvm-c/TargetMachine.h"
33 typedef struct LLVMOrcOpaqueJITStack *LLVMOrcJITStackRef;
34 typedef uint32_t LLVMOrcModuleHandle;
35 typedef uint64_t LLVMOrcTargetAddress;
36 typedef uint64_t (*LLVMOrcSymbolResolverFn)(const char *Name,
38 typedef uint64_t (*LLVMOrcLazyCompileCallbackFn)(LLVMOrcJITStackRef JITStack,
42 * Create an ORC JIT stack.
44 * The client owns the resulting stack, and must call OrcDisposeInstance(...)
45 * to destroy it and free its memory. The JIT stack will take ownership of the
46 * TargetMachine, which will be destroyed when the stack is destroyed. The
47 * client should not attempt to dispose of the Target Machine, or it will result
50 LLVMOrcJITStackRef LLVMOrcCreateInstance(LLVMTargetMachineRef TM,
51 LLVMContextRef Context);
54 * Mangle the given symbol.
55 * Memory will be allocated for MangledSymbol to hold the result. The client
57 void LLVMOrcGetMangledSymbol(LLVMOrcJITStackRef JITStack, char **MangledSymbol,
61 * Dispose of a mangled symbol.
64 void LLVMOrcDisposeMangledSymbol(char *MangledSymbol);
67 * Create a lazy compile callback.
70 LLVMOrcCreateLazyCompileCallback(LLVMOrcJITStackRef JITStack,
71 LLVMOrcLazyCompileCallbackFn Callback,
75 * Create a named indirect call stub.
77 void LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack,
79 LLVMOrcTargetAddress InitAddr);
82 * Set the pointer for the given indirect stub.
84 void LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack,
86 LLVMOrcTargetAddress NewAddr);
89 * Add module to be eagerly compiled.
92 LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack, LLVMModuleRef Mod,
93 LLVMOrcSymbolResolverFn SymbolResolver,
94 void *SymbolResolverCtx);
97 * Add module to be lazily compiled one function at a time.
100 LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, LLVMModuleRef Mod,
101 LLVMOrcSymbolResolverFn SymbolResolver,
102 void *SymbolResolverCtx);
105 * Add an object file.
108 LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, LLVMObjectFileRef Obj,
109 LLVMOrcSymbolResolverFn SymbolResolver,
110 void *SymbolResolverCtx);
113 * Remove a module set from the JIT.
115 * This works for all modules that can be added via OrcAdd*, including object
118 void LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack, LLVMOrcModuleHandle H);
121 * Get symbol address from JIT instance.
123 LLVMOrcTargetAddress LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack,
124 const char *SymbolName);
127 * Dispose of an ORC JIT stack.
129 void LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack);
133 #endif /* extern "C" */
135 #endif /* LLVM_C_ORCBINDINGS_H */