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
93 lines
2.8 KiB
C
93 lines
2.8 KiB
C
/*===------- llvm-c/Error.h - llvm::Error class 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 LLVM's Error class. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_ERROR_H
|
|
#define LLVM_C_ERROR_H
|
|
|
|
#include "llvm-c/ExternC.h"
|
|
#include "llvm-c/Visibility.h"
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* @defgroup LLVMCError Error Handling
|
|
* @ingroup LLVMC
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
#define LLVMErrorSuccess 0
|
|
|
|
/**
|
|
* Opaque reference to an error instance. Null serves as the 'success' value.
|
|
*/
|
|
typedef struct LLVMOpaqueError *LLVMErrorRef;
|
|
|
|
/**
|
|
* Error type identifier.
|
|
*/
|
|
typedef const void *LLVMErrorTypeId;
|
|
|
|
/**
|
|
* Returns the type id for the given error instance, which must be a failure
|
|
* value (i.e. non-null).
|
|
*/
|
|
LLVM_C_ABI LLVMErrorTypeId LLVMGetErrorTypeId(LLVMErrorRef Err);
|
|
|
|
/**
|
|
* Dispose of the given error without handling it. This operation consumes the
|
|
* error, and the given LLVMErrorRef value is not usable once this call returns.
|
|
* Note: This method *only* needs to be called if the error is not being passed
|
|
* to some other consuming operation, e.g. LLVMGetErrorMessage.
|
|
*/
|
|
LLVM_C_ABI void LLVMConsumeError(LLVMErrorRef Err);
|
|
|
|
/**
|
|
* Report a fatal error if Err is a failure value.
|
|
*
|
|
* This function can be used to wrap calls to fallible functions ONLY when it is
|
|
* known that the Error will always be a success value.
|
|
*/
|
|
LLVM_C_ABI void LLVMCantFail(LLVMErrorRef Err);
|
|
|
|
/**
|
|
* Returns the given string's error message. This operation consumes the error,
|
|
* and the given LLVMErrorRef value is not usable once this call returns.
|
|
* The caller is responsible for disposing of the string by calling
|
|
* LLVMDisposeErrorMessage.
|
|
*/
|
|
LLVM_C_ABI char *LLVMGetErrorMessage(LLVMErrorRef Err);
|
|
|
|
/**
|
|
* Dispose of the given error message.
|
|
*/
|
|
LLVM_C_ABI void LLVMDisposeErrorMessage(char *ErrMsg);
|
|
|
|
/**
|
|
* Returns the type id for llvm StringError.
|
|
*/
|
|
LLVM_C_ABI LLVMErrorTypeId LLVMGetStringErrorTypeId(void);
|
|
|
|
/**
|
|
* Create a StringError.
|
|
*/
|
|
LLVM_C_ABI LLVMErrorRef LLVMCreateStringError(const char *ErrMsg);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif
|