lib/CodeGen/AsmPrinter/AsmPrinterHandler.h

   1 //===-- lib/CodeGen/AsmPrinter/AsmPrinterHandler.h -------------*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains a generic interface for AsmPrinter handlers,
  11 // like debug and EH info emitters.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_ASMPRINTERHANDLER_H
  16 #define LLVM_LIB_CODEGEN_ASMPRINTER_ASMPRINTERHANDLER_H
  17
  18 #include "llvm/Support/DataTypes.h"
  19
  20 namespace llvm {
  21
  22 class MachineBasicBlock;
  23 class MachineFunction;
  24 class MachineInstr;
  25 class MCSymbol;
  26
  27 /// \brief Collects and handles AsmPrinter objects required to build debug
  28 /// or EH information.
  29 class AsmPrinterHandler {
  30 public:
  31   virtual ~AsmPrinterHandler();
  32
  33   /// \brief For symbols that have a size designated (e.g. common symbols),
  34   /// this tracks that size.
  35   virtual void setSymbolSize(const MCSymbol *Sym, uint64_t Size) = 0;
  36
  37   /// \brief Emit all sections that should come after the content.
  38   virtual void endModule() = 0;
  39
  40   /// \brief Gather pre-function debug information.
  41   /// Every beginFunction(MF) call should be followed by an endFunction(MF)
  42   /// call.
  43   virtual void beginFunction(const MachineFunction *MF) = 0;
  44
  45   // \brief Emit any of function marker (like .cfi_endproc). This is called
  46   // before endFunction and cannot switch sections.
  47   virtual void markFunctionEnd();
  48
  49   /// \brief Gather post-function debug information.
  50   /// Please note that some AsmPrinter implementations may not call
  51   /// beginFunction at all.
  52   virtual void endFunction(const MachineFunction *MF) = 0;
  53
  54   /// \brief Emit target-specific EH funclet machinery.
  55   virtual void beginFunclet(const MachineBasicBlock &MBB,
  56                             MCSymbol *Sym = nullptr) {}
  57   virtual void endFunclet() {}
  58
  59   /// \brief Process beginning of an instruction.
  60   virtual void beginInstruction(const MachineInstr *MI) = 0;
  61
  62   /// \brief Process end of an instruction.
  63   virtual void endInstruction() = 0;
  64 };
  65 } // End of namespace llvm
  66
  67 #endif