LLVM 20.0.0git
AsmPrinterHandler.h
Go to the documentation of this file.
1//===-- llvm/CodeGen/AsmPrinterHandler.h -----------------------*- C++ -*--===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains a generic interface for AsmPrinter handlers,
10// like debug and EH info emitters.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_CODEGEN_ASMPRINTERHANDLER_H
15#define LLVM_CODEGEN_ASMPRINTERHANDLER_H
16
18
19namespace llvm {
20
21class AsmPrinter;
22class MachineBasicBlock;
23class MachineFunction;
24class MachineInstr;
25class MCSymbol;
26class Module;
27
29 const MachineBasicBlock *MBB);
30
31/// Collects and handles AsmPrinter objects required to build debug
32/// or EH information.
34public:
36
37 virtual void beginModule(Module *M) {}
38
39 /// Emit all sections that should come after the content.
40 virtual void endModule() = 0;
41
42 /// Gather pre-function debug information.
43 /// Every beginFunction(MF) call should be followed by an endFunction(MF)
44 /// call.
45 virtual void beginFunction(const MachineFunction *MF) = 0;
46
47 // Emit any of function marker (like .cfi_endproc). This is called
48 // before endFunction and cannot switch sections.
49 virtual void markFunctionEnd();
50
51 /// Gather post-function debug information.
52 virtual void endFunction(const MachineFunction *MF) = 0;
53
54 /// Process the beginning of a new basic-block-section within a
55 /// function. Always called immediately after beginFunction for the first
56 /// basic-block. When basic-block-sections are enabled, called before the
57 /// first block of each such section.
59
60 /// Process the end of a basic-block-section within a function. When
61 /// basic-block-sections are enabled, called after the last block in each such
62 /// section (including the last section in the function). When
63 /// basic-block-sections are disabled, called at the end of a function,
64 /// immediately prior to markFunctionEnd.
66
67 /// Emit target-specific EH funclet machinery.
68 virtual void beginFunclet(const MachineBasicBlock &MBB,
69 MCSymbol *Sym = nullptr) {}
70 virtual void endFunclet() {}
71};
72
73} // End of namespace llvm
74
75#endif
MachineBasicBlock & MBB
Symbol * Sym
Definition: ELF_riscv.cpp:479
Machine Check Debug Module
Collects and handles AsmPrinter objects required to build debug or EH information.
virtual ~AsmPrinterHandler()
Pin vtable to this file.
virtual void beginModule(Module *M)
virtual void beginFunction(const MachineFunction *MF)=0
Gather pre-function debug information.
virtual void markFunctionEnd()
virtual void endBasicBlockSection(const MachineBasicBlock &MBB)
Process the end of a basic-block-section within a function.
virtual void beginBasicBlockSection(const MachineBasicBlock &MBB)
Process the beginning of a new basic-block-section within a function.
virtual void endModule()=0
Emit all sections that should come after the content.
virtual void beginFunclet(const MachineBasicBlock &MBB, MCSymbol *Sym=nullptr)
Emit target-specific EH funclet machinery.
virtual void endFunction(const MachineFunction *MF)=0
Gather post-function debug information.
This class is intended to be used as a driving class for all asm writers.
Definition: AsmPrinter.h:86
MCSymbol - Instances of this class represent a symbol name in the MC file, and MCSymbols are created ...
Definition: MCSymbol.h:41
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
MCSymbol * ExceptionSymbolProvider(AsmPrinter *Asm, const MachineBasicBlock *MBB)