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
148 lines
5.4 KiB
C
148 lines
5.4 KiB
C
/*===-- llvm-c/Transform/PassBuilder.h - PassBuilder for LLVM C ---*- 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 contains the LLVM-C interface into the new pass manager *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_TRANSFORMS_PASSBUILDER_H
|
|
#define LLVM_C_TRANSFORMS_PASSBUILDER_H
|
|
|
|
#include "llvm-c/Error.h"
|
|
#include "llvm-c/TargetMachine.h"
|
|
#include "llvm-c/Types.h"
|
|
#include "llvm-c/Visibility.h"
|
|
|
|
/**
|
|
* @defgroup LLVMCCoreNewPM New Pass Manager
|
|
* @ingroup LLVMCCore
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* A set of options passed which are attached to the Pass Manager upon run.
|
|
*
|
|
* This corresponds to an llvm::LLVMPassBuilderOptions instance
|
|
*
|
|
* The details for how the different properties of this structure are used can
|
|
* be found in the source for LLVMRunPasses
|
|
*/
|
|
typedef struct LLVMOpaquePassBuilderOptions *LLVMPassBuilderOptionsRef;
|
|
|
|
/**
|
|
* Construct and run a set of passes over a module
|
|
*
|
|
* This function takes a string with the passes that should be used. The format
|
|
* of this string is the same as opt's -passes argument for the new pass
|
|
* manager. Individual passes may be specified, separated by commas. Full
|
|
* pipelines may also be invoked using `default<O3>` and friends. See opt for
|
|
* full reference of the Passes format.
|
|
*/
|
|
LLVM_C_ABI LLVMErrorRef LLVMRunPasses(LLVMModuleRef M, const char *Passes,
|
|
LLVMTargetMachineRef TM,
|
|
LLVMPassBuilderOptionsRef Options);
|
|
|
|
/**
|
|
* Construct and run a set of passes over a function.
|
|
*
|
|
* This function behaves the same as LLVMRunPasses, but operates on a single
|
|
* function instead of an entire module.
|
|
*/
|
|
LLVM_C_ABI LLVMErrorRef LLVMRunPassesOnFunction(
|
|
LLVMValueRef F, const char *Passes, LLVMTargetMachineRef TM,
|
|
LLVMPassBuilderOptionsRef Options);
|
|
|
|
/**
|
|
* Create a new set of options for a PassBuilder
|
|
*
|
|
* Ownership of the returned instance is given to the client, and they are
|
|
* responsible for it. The client should call LLVMDisposePassBuilderOptions
|
|
* to free the pass builder options.
|
|
*/
|
|
LLVM_C_ABI LLVMPassBuilderOptionsRef LLVMCreatePassBuilderOptions(void);
|
|
|
|
/**
|
|
* Toggle adding the VerifierPass for the PassBuilder, ensuring all functions
|
|
* inside the module is valid.
|
|
*/
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetVerifyEach(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool VerifyEach);
|
|
|
|
/**
|
|
* Toggle debug logging when running the PassBuilder
|
|
*/
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetDebugLogging(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool DebugLogging);
|
|
|
|
/**
|
|
* Specify a custom alias analysis pipeline for the PassBuilder to be used
|
|
* instead of the default one. The string argument is not copied; the caller
|
|
* is responsible for ensuring it outlives the PassBuilderOptions instance.
|
|
*/
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetAAPipeline(LLVMPassBuilderOptionsRef Options,
|
|
const char *AAPipeline);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetLoopInterleaving(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool LoopInterleaving);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetLoopVectorization(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool LoopVectorization);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetSLPVectorization(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool SLPVectorization);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetLoopUnrolling(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool LoopUnrolling);
|
|
|
|
LLVM_C_ABI void LLVMPassBuilderOptionsSetForgetAllSCEVInLoopUnroll(
|
|
LLVMPassBuilderOptionsRef Options, LLVMBool ForgetAllSCEVInLoopUnroll);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetLicmMssaOptCap(LLVMPassBuilderOptionsRef Options,
|
|
unsigned LicmMssaOptCap);
|
|
|
|
LLVM_C_ABI void LLVMPassBuilderOptionsSetLicmMssaNoAccForPromotionCap(
|
|
LLVMPassBuilderOptionsRef Options, unsigned LicmMssaNoAccForPromotionCap);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetCallGraphProfile(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool CallGraphProfile);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetMergeFunctions(LLVMPassBuilderOptionsRef Options,
|
|
LLVMBool MergeFunctions);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMPassBuilderOptionsSetInlinerThreshold(LLVMPassBuilderOptionsRef Options,
|
|
int Threshold);
|
|
|
|
/**
|
|
* Dispose of a heap-allocated PassBuilderOptions instance
|
|
*/
|
|
LLVM_C_ABI void
|
|
LLVMDisposePassBuilderOptions(LLVMPassBuilderOptionsRef Options);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif // LLVM_C_TRANSFORMS_PASSBUILDER_H
|