lib/CodeGen/AsmPrinter/DwarfCompileUnit.h

   1 //===-- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit ---*- 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 support for writing dwarf compile unit.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
  15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
  16
  17 #include "DwarfUnit.h"
  18 #include "llvm/Support/Dwarf.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/IR/DebugInfo.h"
  21
  22 namespace llvm {
  23
  24 class AsmPrinter;
  25 class DIE;
  26 class DwarfDebug;
  27 class DwarfFile;
  28 class MCSymbol;
  29 class LexicalScope;
  30
  31 class DwarfCompileUnit : public DwarfUnit {
  32   /// The attribute index of DW_AT_stmt_list in the compile unit DIE, avoiding
  33   /// the need to search for it in applyStmtList.
  34   unsigned stmtListIndex;
  35
  36 public:
  37   DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
  38                    DwarfDebug *DW, DwarfFile *DWU);
  39
  40   void initStmtList(MCSymbol *DwarfLineSectionSym);
  41
  42   /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
  43   void applyStmtList(DIE &D);
  44
  45   /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
  46   DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
  47
  48   /// addLabelAddress - Add a dwarf label attribute data and value using
  49   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
  50   void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  51                        const MCSymbol *Label);
  52
  53   /// addLocalLabelAddress - Add a dwarf label attribute data and value using
  54   /// DW_FORM_addr only.
  55   void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  56                             const MCSymbol *Label);
  57
  58   /// addSectionDelta - Add a label delta attribute data and value.
  59   void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
  60                        const MCSymbol *Lo);
  61
  62   DwarfCompileUnit &getCU() override { return *this; }
  63
  64   unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
  65
  66   /// addRange - Add an address range to the list of ranges for this unit.
  67   void addRange(RangeSpan Range);
  68
  69   void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
  70
  71   /// addSectionLabel - Add a Dwarf section label attribute data and value.
  72   ///
  73   void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
  74                        const MCSymbol *Label, const MCSymbol *Sec);
  75
  76   /// \brief Find DIE for the given subprogram and attach appropriate
  77   /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
  78   /// variables in this scope then create and insert DIEs for these
  79   /// variables.
  80   DIE &updateSubprogramScopeDIE(DISubprogram SP);
  81
  82   void constructScopeDIE(LexicalScope *Scope,
  83                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
  84 };
  85
  86 } // end llvm namespace
  87
  88 #endif