0580563299
## Purpose This patch is one in a series of code-mods that annotate LLVM’s public interface for export. This patch annotates the `llvm-c` interface with a new `LLVM_C_ABI` annotation, which behaves like the `LLVM_ABI`. This annotation currently has no meaningful impact on the LLVM build; however, it is a prerequisite to support an LLVM Windows DLL (shared library) build. ## Overview 1. Add a new `llvm-c/Visibility.h` header file that defines a new `LLVM_C_ABI` macro. The macro resolves to the proper DLL export/import annotation on Windows and a "default" visibility annotation elsewhere. 2. Add a new `LLVM_ENABLE_LLVM_C_EXPORT_ANNOTATIONS` `#cmakedefine` that is used to gate the definition of `LLVM_C_ABI`. 3. Remove the existing `LLVM_C_ABI` definition from `llvm/Support/Compiler.h`. Update the small number of `LLVM_C_ABI` references to get it from the new `llvm-c/Visibility.h` header. 4. Code-mod annotate the public `llvm-c` interface using the [Interface Definition Scanner (IDS)](https://github.com/compnerd/ids) tool. 5. Format the changes with `clang-format`. ## Background This effort is tracked in #109483. Additional context is provided in [this discourse](https://discourse.llvm.org/t/psa-annotating-llvm-public-interface/85307), and documentation for `LLVM_ABI` and related annotations is found in the LLVM repo [here](https://github.com/llvm/llvm-project/blob/main/llvm/docs/InterfaceExportAnnotations.rst). ## Validation Local builds and tests to validate cross-platform compatibility. This included llvm, clang, and lldb on the following configurations: - Windows with MSVC - Windows with Clang - Linux with GCC - Linux with Clang - Darwin with Clang
105 lines
4.5 KiB
C++
105 lines
4.5 KiB
C++
/*===-- llvm-c/OrcEE.h - OrcV2 C bindings ExecutionEngine utils -*- C++ -*-===*\
|
|
|* *|
|
|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
|
|
|* Exceptions. *|
|
|
|* See https://llvm.org/LICENSE.txt for license information. *|
|
|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header declares the C interface to ExecutionEngine based utils, e.g. *|
|
|
|* RTDyldObjectLinkingLayer (based on RuntimeDyld) in Orc. *|
|
|
|* *|
|
|
|* Many exotic languages can interoperate with C code but have a harder time *|
|
|
|* with C++ due to name mangling. So in addition to C, this interface enables *|
|
|
|* tools written in such languages. *|
|
|
|* *|
|
|
|* Note: This interface is experimental. It is *NOT* stable, and may be *|
|
|
|* changed without warning. Only C API usage documentation is *|
|
|
|* provided. See the C++ documentation for all higher level ORC API *|
|
|
|* details. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_ORCEE_H
|
|
#define LLVM_C_ORCEE_H
|
|
|
|
#include "llvm-c/Error.h"
|
|
#include "llvm-c/ExecutionEngine.h"
|
|
#include "llvm-c/Orc.h"
|
|
#include "llvm-c/TargetMachine.h"
|
|
#include "llvm-c/Types.h"
|
|
#include "llvm-c/Visibility.h"
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
typedef void *(*LLVMMemoryManagerCreateContextCallback)(void *CtxCtx);
|
|
typedef void (*LLVMMemoryManagerNotifyTerminatingCallback)(void *CtxCtx);
|
|
|
|
/**
|
|
* @defgroup LLVMCExecutionEngineORCEE ExecutionEngine-based ORC Utils
|
|
* @ingroup LLVMCExecutionEngine
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* Create a RTDyldObjectLinkingLayer instance using the standard
|
|
* SectionMemoryManager for memory management.
|
|
*/
|
|
LLVM_C_ABI LLVMOrcObjectLayerRef
|
|
LLVMOrcCreateRTDyldObjectLinkingLayerWithSectionMemoryManager(
|
|
LLVMOrcExecutionSessionRef ES);
|
|
|
|
/**
|
|
* Create a RTDyldObjectLinkingLayer instance using MCJIT-memory-manager-like
|
|
* callbacks.
|
|
*
|
|
* This is intended to simplify transitions for existing MCJIT clients. The
|
|
* callbacks used are similar (but not identical) to the callbacks for
|
|
* LLVMCreateSimpleMCJITMemoryManager: Unlike MCJIT, RTDyldObjectLinkingLayer
|
|
* will create a new memory manager for each object linked by calling the given
|
|
* CreateContext callback. This allows for code removal by destroying each
|
|
* allocator individually. Every allocator will be destroyed (if it has not been
|
|
* already) at RTDyldObjectLinkingLayer destruction time, and the
|
|
* NotifyTerminating callback will be called to indicate that no further
|
|
* allocation contexts will be created.
|
|
*
|
|
* To implement MCJIT-like behavior clients can implement CreateContext,
|
|
* NotifyTerminating, and Destroy as:
|
|
*
|
|
* void *CreateContext(void *CtxCtx) { return CtxCtx; }
|
|
* void NotifyTerminating(void *CtxCtx) { MyOriginalDestroy(CtxCtx); }
|
|
* void Destroy(void *Ctx) { }
|
|
*
|
|
* This scheme simply reuses the CreateContextCtx pointer as the one-and-only
|
|
* allocation context.
|
|
*/
|
|
LLVM_C_ABI LLVMOrcObjectLayerRef
|
|
LLVMOrcCreateRTDyldObjectLinkingLayerWithMCJITMemoryManagerLikeCallbacks(
|
|
LLVMOrcExecutionSessionRef ES, void *CreateContextCtx,
|
|
LLVMMemoryManagerCreateContextCallback CreateContext,
|
|
LLVMMemoryManagerNotifyTerminatingCallback NotifyTerminating,
|
|
LLVMMemoryManagerAllocateCodeSectionCallback AllocateCodeSection,
|
|
LLVMMemoryManagerAllocateDataSectionCallback AllocateDataSection,
|
|
LLVMMemoryManagerFinalizeMemoryCallback FinalizeMemory,
|
|
LLVMMemoryManagerDestroyCallback Destroy);
|
|
|
|
/**
|
|
* Add the given listener to the given RTDyldObjectLinkingLayer.
|
|
*
|
|
* Note: Layer must be an RTDyldObjectLinkingLayer instance or
|
|
* behavior is undefined.
|
|
*/
|
|
LLVM_C_ABI void LLVMOrcRTDyldObjectLinkingLayerRegisterJITEventListener(
|
|
LLVMOrcObjectLayerRef RTDyldObjLinkingLayer,
|
|
LLVMJITEventListenerRef Listener);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif /* LLVM_C_ORCEE_H */
|