7e4bdb427f
## Purpose This patch is one in a series of code-mods that annotate LLVM’s public interface for export. This patch annotates the `llvm/CGData` and `llvm/CodeGen` libraries. These annotations currently have no meaningful impact on the LLVM build; however, they are a prerequisite to support an LLVM Windows DLL (shared library) build. ## 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). The bulk of these changes were generated automatically using the [Interface Definition Scanner (IDS)](https://github.com/compnerd/ids) tool, followed formatting with `git clang-format`. The following manual adjustments were also applied after running IDS on Linux: - Add `LLVM_ABI` to a subset of private class methods and fields that require export - Add `LLVM_TEMPLATE_ABI` and `LLVM_EXPORT_TEMPLATE` to exported instantiated templates defined via X-macro - Add `LLVM_ABI_FRIEND` to friend member functions declared with `LLVM_ABI` - Explicitly make classes non-copyable where needed to due IDS adding LLVM_ABI at the class level - Add `#include "llvm/Support/Compiler.h"` to files where it was not auto-added by IDS due to no pre-existing block of include statements. - Add `LLVM_ABI` to a small number of symbols that require export but are not declared in headers ## 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
89 lines
3.0 KiB
C++
89 lines
3.0 KiB
C++
//===-- llvm/CodeGen/AsmPrinterHandler.h -----------------------*- 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 contains a generic interface for AsmPrinter handlers,
|
|
// like debug and EH info emitters.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CODEGEN_ASMPRINTERHANDLER_H
|
|
#define LLVM_CODEGEN_ASMPRINTERHANDLER_H
|
|
|
|
#include "llvm/Support/Compiler.h"
|
|
#include "llvm/Support/DataTypes.h"
|
|
|
|
namespace llvm {
|
|
|
|
class AsmPrinter;
|
|
class MachineBasicBlock;
|
|
class MachineFunction;
|
|
class MachineInstr;
|
|
class MCSymbol;
|
|
class Module;
|
|
|
|
typedef MCSymbol *ExceptionSymbolProvider(AsmPrinter *Asm,
|
|
const MachineBasicBlock *MBB);
|
|
|
|
/// Collects and handles AsmPrinter objects required to build debug
|
|
/// or EH information.
|
|
class LLVM_ABI AsmPrinterHandler {
|
|
public:
|
|
virtual ~AsmPrinterHandler();
|
|
|
|
virtual void beginModule(Module *M) {}
|
|
|
|
/// Emit all sections that should come after the content.
|
|
virtual void endModule() = 0;
|
|
|
|
/// Gather pre-function debug information.
|
|
/// Every beginFunction(MF) call should be followed by an endFunction(MF)
|
|
/// call.
|
|
virtual void beginFunction(const MachineFunction *MF) = 0;
|
|
|
|
// Emit any of function marker (like .cfi_endproc). This is called
|
|
// before endFunction and cannot switch sections.
|
|
virtual void markFunctionEnd();
|
|
|
|
/// Gather post-function debug information.
|
|
virtual void endFunction(const MachineFunction *MF) = 0;
|
|
|
|
/// Process the beginning of a new basic-block-section within a
|
|
/// function. Always called immediately after beginFunction for the first
|
|
/// basic-block. When basic-block-sections are enabled, called before the
|
|
/// first block of each such section.
|
|
virtual void beginBasicBlockSection(const MachineBasicBlock &MBB) {}
|
|
|
|
/// Process the end of a basic-block-section within a function. When
|
|
/// basic-block-sections are enabled, called after the last block in each such
|
|
/// section (including the last section in the function). When
|
|
/// basic-block-sections are disabled, called at the end of a function,
|
|
/// immediately prior to markFunctionEnd.
|
|
virtual void endBasicBlockSection(const MachineBasicBlock &MBB) {}
|
|
|
|
/// For symbols that have a size designated (e.g. common symbols),
|
|
/// this tracks that size.
|
|
virtual void setSymbolSize(const MCSymbol *Sym, uint64_t Size) {}
|
|
|
|
/// Process beginning of an instruction.
|
|
virtual void beginInstruction(const MachineInstr *MI) {}
|
|
|
|
/// Process end of an instruction.
|
|
virtual void endInstruction() {}
|
|
|
|
virtual void beginCodeAlignment(const MachineBasicBlock &MBB) {}
|
|
|
|
/// Emit target-specific EH funclet machinery.
|
|
virtual void beginFunclet(const MachineBasicBlock &MBB,
|
|
MCSymbol *Sym = nullptr) {}
|
|
virtual void endFunclet() {}
|
|
};
|
|
|
|
} // End of namespace llvm
|
|
|
|
#endif
|