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
259 lines
10 KiB
C
259 lines
10 KiB
C
/*===-- llvm-c/TargetMachine.h - Target Machine Library 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 header declares the C interface to the Target and TargetMachine *|
|
|
|* classes, which can be used to generate assembly or object files. *|
|
|
|* *|
|
|
|* 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. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_TARGETMACHINE_H
|
|
#define LLVM_C_TARGETMACHINE_H
|
|
|
|
#include "llvm-c/ExternC.h"
|
|
#include "llvm-c/Target.h"
|
|
#include "llvm-c/Types.h"
|
|
#include "llvm-c/Visibility.h"
|
|
|
|
LLVM_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* @addtogroup LLVMCTarget
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
typedef struct LLVMOpaqueTargetMachineOptions *LLVMTargetMachineOptionsRef;
|
|
typedef struct LLVMOpaqueTargetMachine *LLVMTargetMachineRef;
|
|
typedef struct LLVMTarget *LLVMTargetRef;
|
|
|
|
typedef enum {
|
|
LLVMCodeGenLevelNone,
|
|
LLVMCodeGenLevelLess,
|
|
LLVMCodeGenLevelDefault,
|
|
LLVMCodeGenLevelAggressive
|
|
} LLVMCodeGenOptLevel;
|
|
|
|
typedef enum {
|
|
LLVMRelocDefault,
|
|
LLVMRelocStatic,
|
|
LLVMRelocPIC,
|
|
LLVMRelocDynamicNoPic,
|
|
LLVMRelocROPI,
|
|
LLVMRelocRWPI,
|
|
LLVMRelocROPI_RWPI
|
|
} LLVMRelocMode;
|
|
|
|
typedef enum {
|
|
LLVMCodeModelDefault,
|
|
LLVMCodeModelJITDefault,
|
|
LLVMCodeModelTiny,
|
|
LLVMCodeModelSmall,
|
|
LLVMCodeModelKernel,
|
|
LLVMCodeModelMedium,
|
|
LLVMCodeModelLarge
|
|
} LLVMCodeModel;
|
|
|
|
typedef enum {
|
|
LLVMAssemblyFile,
|
|
LLVMObjectFile
|
|
} LLVMCodeGenFileType;
|
|
|
|
typedef enum {
|
|
LLVMGlobalISelAbortEnable,
|
|
LLVMGlobalISelAbortDisable,
|
|
LLVMGlobalISelAbortDisableWithDiag,
|
|
} LLVMGlobalISelAbortMode;
|
|
|
|
/** Returns the first llvm::Target in the registered targets list. */
|
|
LLVM_C_ABI LLVMTargetRef LLVMGetFirstTarget(void);
|
|
/** Returns the next llvm::Target given a previous one (or null if there's none) */
|
|
LLVM_C_ABI LLVMTargetRef LLVMGetNextTarget(LLVMTargetRef T);
|
|
|
|
/*===-- Target ------------------------------------------------------------===*/
|
|
/** Finds the target corresponding to the given name and stores it in \p T.
|
|
Returns 0 on success. */
|
|
LLVM_C_ABI LLVMTargetRef LLVMGetTargetFromName(const char *Name);
|
|
|
|
/** Finds the target corresponding to the given triple and stores it in \p T.
|
|
Returns 0 on success. Optionally returns any error in ErrorMessage.
|
|
Use LLVMDisposeMessage to dispose the message. */
|
|
LLVM_C_ABI LLVMBool LLVMGetTargetFromTriple(const char *Triple,
|
|
LLVMTargetRef *T,
|
|
char **ErrorMessage);
|
|
|
|
/** Returns the name of a target. See llvm::Target::getName */
|
|
LLVM_C_ABI const char *LLVMGetTargetName(LLVMTargetRef T);
|
|
|
|
/** Returns the description of a target. See llvm::Target::getDescription */
|
|
LLVM_C_ABI const char *LLVMGetTargetDescription(LLVMTargetRef T);
|
|
|
|
/** Returns if the target has a JIT */
|
|
LLVM_C_ABI LLVMBool LLVMTargetHasJIT(LLVMTargetRef T);
|
|
|
|
/** Returns if the target has a TargetMachine associated */
|
|
LLVM_C_ABI LLVMBool LLVMTargetHasTargetMachine(LLVMTargetRef T);
|
|
|
|
/** Returns if the target as an ASM backend (required for emitting output) */
|
|
LLVM_C_ABI LLVMBool LLVMTargetHasAsmBackend(LLVMTargetRef T);
|
|
|
|
/*===-- Target Machine ----------------------------------------------------===*/
|
|
/**
|
|
* Create a new set of options for an llvm::TargetMachine.
|
|
*
|
|
* The returned option structure must be released with
|
|
* LLVMDisposeTargetMachineOptions() after the call to
|
|
* LLVMCreateTargetMachineWithOptions().
|
|
*/
|
|
LLVM_C_ABI LLVMTargetMachineOptionsRef LLVMCreateTargetMachineOptions(void);
|
|
|
|
/**
|
|
* Dispose of an LLVMTargetMachineOptionsRef instance.
|
|
*/
|
|
LLVM_C_ABI void
|
|
LLVMDisposeTargetMachineOptions(LLVMTargetMachineOptionsRef Options);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMTargetMachineOptionsSetCPU(LLVMTargetMachineOptionsRef Options,
|
|
const char *CPU);
|
|
|
|
/**
|
|
* Set the list of features for the target machine.
|
|
*
|
|
* \param Features a comma-separated list of features.
|
|
*/
|
|
LLVM_C_ABI void
|
|
LLVMTargetMachineOptionsSetFeatures(LLVMTargetMachineOptionsRef Options,
|
|
const char *Features);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMTargetMachineOptionsSetABI(LLVMTargetMachineOptionsRef Options,
|
|
const char *ABI);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMTargetMachineOptionsSetCodeGenOptLevel(LLVMTargetMachineOptionsRef Options,
|
|
LLVMCodeGenOptLevel Level);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMTargetMachineOptionsSetRelocMode(LLVMTargetMachineOptionsRef Options,
|
|
LLVMRelocMode Reloc);
|
|
|
|
LLVM_C_ABI void
|
|
LLVMTargetMachineOptionsSetCodeModel(LLVMTargetMachineOptionsRef Options,
|
|
LLVMCodeModel CodeModel);
|
|
|
|
/**
|
|
* Create a new llvm::TargetMachine.
|
|
*
|
|
* \param T the target to create a machine for.
|
|
* \param Triple a triple describing the target machine.
|
|
* \param Options additional configuration (see
|
|
* LLVMCreateTargetMachineOptions()).
|
|
*/
|
|
LLVM_C_ABI LLVMTargetMachineRef LLVMCreateTargetMachineWithOptions(
|
|
LLVMTargetRef T, const char *Triple, LLVMTargetMachineOptionsRef Options);
|
|
|
|
/** Creates a new llvm::TargetMachine. See llvm::Target::createTargetMachine */
|
|
LLVM_C_ABI LLVMTargetMachineRef LLVMCreateTargetMachine(
|
|
LLVMTargetRef T, const char *Triple, const char *CPU, const char *Features,
|
|
LLVMCodeGenOptLevel Level, LLVMRelocMode Reloc, LLVMCodeModel CodeModel);
|
|
|
|
/** Dispose the LLVMTargetMachineRef instance generated by
|
|
LLVMCreateTargetMachine. */
|
|
LLVM_C_ABI void LLVMDisposeTargetMachine(LLVMTargetMachineRef T);
|
|
|
|
/** Returns the Target used in a TargetMachine */
|
|
LLVM_C_ABI LLVMTargetRef LLVMGetTargetMachineTarget(LLVMTargetMachineRef T);
|
|
|
|
/** Returns the triple used creating this target machine. See
|
|
llvm::TargetMachine::getTriple. The result needs to be disposed with
|
|
LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMGetTargetMachineTriple(LLVMTargetMachineRef T);
|
|
|
|
/** Returns the cpu used creating this target machine. See
|
|
llvm::TargetMachine::getCPU. The result needs to be disposed with
|
|
LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMGetTargetMachineCPU(LLVMTargetMachineRef T);
|
|
|
|
/** Returns the feature string used creating this target machine. See
|
|
llvm::TargetMachine::getFeatureString. The result needs to be disposed with
|
|
LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMGetTargetMachineFeatureString(LLVMTargetMachineRef T);
|
|
|
|
/** Create a DataLayout based on the targetMachine. */
|
|
LLVM_C_ABI LLVMTargetDataRef LLVMCreateTargetDataLayout(LLVMTargetMachineRef T);
|
|
|
|
/** Set the target machine's ASM verbosity. */
|
|
LLVM_C_ABI void LLVMSetTargetMachineAsmVerbosity(LLVMTargetMachineRef T,
|
|
LLVMBool VerboseAsm);
|
|
|
|
/** Enable fast-path instruction selection. */
|
|
LLVM_C_ABI void LLVMSetTargetMachineFastISel(LLVMTargetMachineRef T,
|
|
LLVMBool Enable);
|
|
|
|
/** Enable global instruction selection. */
|
|
LLVM_C_ABI void LLVMSetTargetMachineGlobalISel(LLVMTargetMachineRef T,
|
|
LLVMBool Enable);
|
|
|
|
/** Set abort behaviour when global instruction selection fails to lower/select
|
|
* an instruction. */
|
|
LLVM_C_ABI void
|
|
LLVMSetTargetMachineGlobalISelAbort(LLVMTargetMachineRef T,
|
|
LLVMGlobalISelAbortMode Mode);
|
|
|
|
/** Enable the MachineOutliner pass. */
|
|
LLVM_C_ABI void LLVMSetTargetMachineMachineOutliner(LLVMTargetMachineRef T,
|
|
LLVMBool Enable);
|
|
|
|
/** Emits an asm or object file for the given module to the filename. This
|
|
wraps several c++ only classes (among them a file stream). Returns any
|
|
error in ErrorMessage. Use LLVMDisposeMessage to dispose the message. */
|
|
LLVM_C_ABI LLVMBool LLVMTargetMachineEmitToFile(LLVMTargetMachineRef T,
|
|
LLVMModuleRef M,
|
|
const char *Filename,
|
|
LLVMCodeGenFileType codegen,
|
|
char **ErrorMessage);
|
|
|
|
/** Compile the LLVM IR stored in \p M and store the result in \p OutMemBuf. */
|
|
LLVM_C_ABI LLVMBool LLVMTargetMachineEmitToMemoryBuffer(
|
|
LLVMTargetMachineRef T, LLVMModuleRef M, LLVMCodeGenFileType codegen,
|
|
char **ErrorMessage, LLVMMemoryBufferRef *OutMemBuf);
|
|
|
|
/*===-- Triple ------------------------------------------------------------===*/
|
|
/** Get a triple for the host machine as a string. The result needs to be
|
|
disposed with LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMGetDefaultTargetTriple(void);
|
|
|
|
/** Normalize a target triple. The result needs to be disposed with
|
|
LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMNormalizeTargetTriple(const char *triple);
|
|
|
|
/** Get the host CPU as a string. The result needs to be disposed with
|
|
LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMGetHostCPUName(void);
|
|
|
|
/** Get the host CPU's features as a string. The result needs to be disposed
|
|
with LLVMDisposeMessage. */
|
|
LLVM_C_ABI char *LLVMGetHostCPUFeatures(void);
|
|
|
|
/** Adds the target-specific analysis passes to the pass manager. */
|
|
LLVM_C_ABI void LLVMAddAnalysisPasses(LLVMTargetMachineRef T,
|
|
LLVMPassManagerRef PM);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_C_EXTERN_C_END
|
|
|
|
#endif
|