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);
53 * Mangle the given symbol.
54 * Memory will be allocated for MangledSymbol to hold the result. The client
56 void LLVMOrcGetMangledSymbol(LLVMOrcJITStackRef JITStack, char **MangledSymbol,
60 * Dispose of a mangled symbol.
63 void LLVMOrcDisposeMangledSymbol(char *MangledSymbol);
66 * Create a lazy compile callback.
69 LLVMOrcCreateLazyCompileCallback(LLVMOrcJITStackRef JITStack,
70 LLVMOrcLazyCompileCallbackFn Callback,
74 * Create a named indirect call stub.
76 void LLVMOrcCreateIndirectStub(LLVMOrcJITStackRef JITStack,
78 LLVMOrcTargetAddress InitAddr);
81 * Set the pointer for the given indirect stub.
83 void LLVMOrcSetIndirectStubPointer(LLVMOrcJITStackRef JITStack,
85 LLVMOrcTargetAddress NewAddr);
88 * Add module to be eagerly compiled.
91 LLVMOrcAddEagerlyCompiledIR(LLVMOrcJITStackRef JITStack, LLVMModuleRef Mod,
92 LLVMOrcSymbolResolverFn SymbolResolver,
93 void *SymbolResolverCtx);
96 * Add module to be lazily compiled one function at a time.
99 LLVMOrcAddLazilyCompiledIR(LLVMOrcJITStackRef JITStack, LLVMModuleRef Mod,
100 LLVMOrcSymbolResolverFn SymbolResolver,
101 void *SymbolResolverCtx);
104 * Add an object file.
107 LLVMOrcAddObjectFile(LLVMOrcJITStackRef JITStack, LLVMObjectFileRef Obj,
108 LLVMOrcSymbolResolverFn SymbolResolver,
109 void *SymbolResolverCtx);
112 * Remove a module set from the JIT.
114 * This works for all modules that can be added via OrcAdd*, including object
117 void LLVMOrcRemoveModule(LLVMOrcJITStackRef JITStack, LLVMOrcModuleHandle H);
120 * Get symbol address from JIT instance.
122 LLVMOrcTargetAddress LLVMOrcGetSymbolAddress(LLVMOrcJITStackRef JITStack,
123 const char *SymbolName);
126 * Dispose of an ORC JIT stack.
128 void LLVMOrcDisposeInstance(LLVMOrcJITStackRef JITStack);
132 #endif /* extern "C" */
134 #endif /* LLVM_C_ORCBINDINGS_H */