xref: /freebsd-src/contrib/llvm-project/llvm/include/llvm-c/OrcEE.h (revision e8d8bef961a50d4dc22501cde4fb9fb0be1b2532)
1*e8d8bef9SDimitry Andric /*===-- llvm-c/OrcEE.h - OrcV2 C bindings ExecutionEngine utils -*- C++ -*-===*\
2*e8d8bef9SDimitry Andric |*                                                                            *|
3*e8d8bef9SDimitry Andric |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
4*e8d8bef9SDimitry Andric |* Exceptions.                                                                *|
5*e8d8bef9SDimitry Andric |* See https://llvm.org/LICENSE.txt for license information.                  *|
6*e8d8bef9SDimitry Andric |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
7*e8d8bef9SDimitry Andric |*                                                                            *|
8*e8d8bef9SDimitry Andric |*===----------------------------------------------------------------------===*|
9*e8d8bef9SDimitry Andric |*                                                                            *|
10*e8d8bef9SDimitry Andric |* This header declares the C interface to ExecutionEngine based utils, e.g.  *|
11*e8d8bef9SDimitry Andric |* RTDyldObjectLinkingLayer (based on RuntimeDyld) in Orc.                    *|
12*e8d8bef9SDimitry Andric |*                                                                            *|
13*e8d8bef9SDimitry Andric |* Many exotic languages can interoperate with C code but have a harder time  *|
14*e8d8bef9SDimitry Andric |* with C++ due to name mangling. So in addition to C, this interface enables *|
15*e8d8bef9SDimitry Andric |* tools written in such languages.                                           *|
16*e8d8bef9SDimitry Andric |*                                                                            *|
17*e8d8bef9SDimitry Andric |* Note: This interface is experimental. It is *NOT* stable, and may be       *|
18*e8d8bef9SDimitry Andric |*       changed without warning. Only C API usage documentation is           *|
19*e8d8bef9SDimitry Andric |*       provided. See the C++ documentation for all higher level ORC API     *|
20*e8d8bef9SDimitry Andric |*       details.                                                             *|
21*e8d8bef9SDimitry Andric |*                                                                            *|
22*e8d8bef9SDimitry Andric \*===----------------------------------------------------------------------===*/
23*e8d8bef9SDimitry Andric 
24*e8d8bef9SDimitry Andric #ifndef LLVM_C_ORCEE_H
25*e8d8bef9SDimitry Andric #define LLVM_C_ORCEE_H
26*e8d8bef9SDimitry Andric 
27*e8d8bef9SDimitry Andric #include "llvm-c/Error.h"
28*e8d8bef9SDimitry Andric #include "llvm-c/ExecutionEngine.h"
29*e8d8bef9SDimitry Andric #include "llvm-c/Orc.h"
30*e8d8bef9SDimitry Andric #include "llvm-c/TargetMachine.h"
31*e8d8bef9SDimitry Andric #include "llvm-c/Types.h"
32*e8d8bef9SDimitry Andric 
33*e8d8bef9SDimitry Andric LLVM_C_EXTERN_C_BEGIN
34*e8d8bef9SDimitry Andric 
35*e8d8bef9SDimitry Andric /**
36*e8d8bef9SDimitry Andric  * Create a RTDyldObjectLinkingLayer instance using the standard
37*e8d8bef9SDimitry Andric  * SectionMemoryManager for memory management.
38*e8d8bef9SDimitry Andric  */
39*e8d8bef9SDimitry Andric LLVMOrcObjectLayerRef
40*e8d8bef9SDimitry Andric LLVMOrcCreateRTDyldObjectLinkingLayerWithSectionMemoryManager(
41*e8d8bef9SDimitry Andric     LLVMOrcExecutionSessionRef ES);
42*e8d8bef9SDimitry Andric 
43*e8d8bef9SDimitry Andric /**
44*e8d8bef9SDimitry Andric  * Add the given listener to the given RTDyldObjectLinkingLayer.
45*e8d8bef9SDimitry Andric  *
46*e8d8bef9SDimitry Andric  * Note: Layer must be an RTDyldObjectLinkingLayer instance or
47*e8d8bef9SDimitry Andric  * behavior is undefined.
48*e8d8bef9SDimitry Andric  */
49*e8d8bef9SDimitry Andric void LLVMOrcRTDyldObjectLinkingLayerRegisterJITEventListener(
50*e8d8bef9SDimitry Andric     LLVMOrcObjectLayerRef RTDyldObjLinkingLayer,
51*e8d8bef9SDimitry Andric     LLVMJITEventListenerRef Listener);
52*e8d8bef9SDimitry Andric 
53*e8d8bef9SDimitry Andric LLVM_C_EXTERN_C_END
54*e8d8bef9SDimitry Andric 
55*e8d8bef9SDimitry Andric #endif /* LLVM_C_ORCEE_H */
56