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
74 lines
2.6 KiB
C
74 lines
2.6 KiB
C
/*===-- llvm-c/Support.h - Support C Interface --------------------*- 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 file defines the C interface to the LLVM support library. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_SUPPORT_H
|
|
#define LLVM_C_SUPPORT_H
|
|
|
|
#include "llvm-c/DataTypes.h"
|
|
#include "llvm-c/ExternC.h"
|
|
#include "llvm-c/Types.h"
|
|
#include "llvm-c/Visibility.h"
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* @addtogroup LLVMCCore
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* This function permanently loads the dynamic library at the given path.
|
|
* It is safe to call this function multiple times for the same library.
|
|
*
|
|
* @see sys::DynamicLibrary::LoadLibraryPermanently()
|
|
*/
|
|
LLVM_C_ABI LLVMBool LLVMLoadLibraryPermanently(const char *Filename);
|
|
|
|
/**
|
|
* This function parses the given arguments using the LLVM command line parser.
|
|
* Note that the only stable thing about this function is its signature; you
|
|
* cannot rely on any particular set of command line arguments being interpreted
|
|
* the same way across LLVM versions.
|
|
*
|
|
* @see llvm::cl::ParseCommandLineOptions()
|
|
*/
|
|
LLVM_C_ABI void LLVMParseCommandLineOptions(int argc, const char *const *argv,
|
|
const char *Overview);
|
|
|
|
/**
|
|
* This function will search through all previously loaded dynamic
|
|
* libraries for the symbol \p symbolName. If it is found, the address of
|
|
* that symbol is returned. If not, null is returned.
|
|
*
|
|
* @see sys::DynamicLibrary::SearchForAddressOfSymbol()
|
|
*/
|
|
LLVM_C_ABI void *LLVMSearchForAddressOfSymbol(const char *symbolName);
|
|
|
|
/**
|
|
* This functions permanently adds the symbol \p symbolName with the
|
|
* value \p symbolValue. These symbols are searched before any
|
|
* libraries.
|
|
*
|
|
* @see sys::DynamicLibrary::AddSymbol()
|
|
*/
|
|
LLVM_C_ABI void LLVMAddSymbol(const char *symbolName, void *symbolValue);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif
|