include/llvm-c/LLJITUtils.h

0001 /*===------- llvm-c/LLJITUtils.h - Advanced LLJIT features --------*- C -*-===*\
0002 |*                                                                            *|
0003 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
0004 |* Exceptions.                                                                *|
0005 |* See https://llvm.org/LICENSE.txt for license information.                  *|
0006 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
0007 |*                                                                            *|
0008 |*===----------------------------------------------------------------------===*|
0009 |*                                                                            *|
0010 |* This header declares the C interface for extra utilities to be used with   *|
0011 |* the LLJIT class from the llvm-c/LLJIT.h header. It requires to following   *|
0012 |* link libraries in addition to libLLVMOrcJIT.a:                             *|
0013 |*  - libLLVMOrcDebugging.a                                                   *|
0014 |*                                                                            *|
0015 |* Many exotic languages can interoperate with C code but have a harder time  *|
0016 |* with C++ due to name mangling. So in addition to C, this interface enables *|
0017 |* tools written in such languages.                                           *|
0018 |*                                                                            *|
0019 |* Note: This interface is experimental. It is *NOT* stable, and may be       *|
0020 |*       changed without warning. Only C API usage documentation is           *|
0021 |*       provided. See the C++ documentation for all higher level ORC API     *|
0022 |*       details.                                                             *|
0023 |*                                                                            *|
0024 \*===----------------------------------------------------------------------===*/
0025
0026 #ifndef LLVM_C_LLJITUTILS_H
0027 #define LLVM_C_LLJITUTILS_H
0028
0029 #include "llvm-c/LLJIT.h"
0030
0031 LLVM_C_EXTERN_C_BEGIN
0032
0033 /**
0034  * @defgroup LLVMCExecutionEngineLLJITUtils LLJIT Utilities
0035  * @ingroup LLVMCExecutionEngineLLJIT
0036  *
0037  * @{
0038  */
0039
0040 /**
0041  * Install the plugin that submits debug objects to the executor. Executors must
0042  * expose the llvm_orc_registerJITLoaderGDBWrapper symbol.
0043  */
0044 LLVMErrorRef LLVMOrcLLJITEnableDebugSupport(LLVMOrcLLJITRef J);
0045
0046 /**
0047  * @}
0048  */
0049
0050 LLVM_C_EXTERN_C_END
0051
0052 #endif /* LLVM_C_LLJITUTILS_H */