xref: /freebsd/contrib/llvm-project/llvm/include/llvm-c/OrcEE.h (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*===-- llvm-c/OrcEE.h - OrcV2 C bindings ExecutionEngine utils -*- C++ -*-===*\
2 |*                                                                            *|
3 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
4 |* Exceptions.                                                                *|
5 |* See https://llvm.org/LICENSE.txt for license information.                  *|
6 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
7 |*                                                                            *|
8 |*===----------------------------------------------------------------------===*|
9 |*                                                                            *|
10 |* This header declares the C interface to ExecutionEngine based utils, e.g.  *|
11 |* RTDyldObjectLinkingLayer (based on RuntimeDyld) in Orc.                    *|
12 |*                                                                            *|
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.                                           *|
16 |*                                                                            *|
17 |* Note: This interface is experimental. It is *NOT* stable, and may be       *|
18 |*       changed without warning. Only C API usage documentation is           *|
19 |*       provided. See the C++ documentation for all higher level ORC API     *|
20 |*       details.                                                             *|
21 |*                                                                            *|
22 \*===----------------------------------------------------------------------===*/
23 
24 #ifndef LLVM_C_ORCEE_H
25 #define LLVM_C_ORCEE_H
26 
27 #include "llvm-c/Error.h"
28 #include "llvm-c/ExecutionEngine.h"
29 #include "llvm-c/Orc.h"
30 #include "llvm-c/TargetMachine.h"
31 #include "llvm-c/Types.h"
32 
33 LLVM_C_EXTERN_C_BEGIN
34 
35 /**
36  * @defgroup LLVMCExecutionEngineORCEE ExecutionEngine-based ORC Utils
37  * @ingroup LLVMCExecutionEngine
38  *
39  * @{
40  */
41 
42 /**
43  * Create a RTDyldObjectLinkingLayer instance using the standard
44  * SectionMemoryManager for memory management.
45  */
46 LLVMOrcObjectLayerRef
47 LLVMOrcCreateRTDyldObjectLinkingLayerWithSectionMemoryManager(
48     LLVMOrcExecutionSessionRef ES);
49 
50 /**
51  * Add the given listener to the given RTDyldObjectLinkingLayer.
52  *
53  * Note: Layer must be an RTDyldObjectLinkingLayer instance or
54  * behavior is undefined.
55  */
56 void LLVMOrcRTDyldObjectLinkingLayerRegisterJITEventListener(
57     LLVMOrcObjectLayerRef RTDyldObjLinkingLayer,
58     LLVMJITEventListenerRef Listener);
59 
60 /**
61  * @}
62  */
63 
64 LLVM_C_EXTERN_C_END
65 
66 #endif /* LLVM_C_ORCEE_H */
67