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   /// Skeleton unit associated with this unit.
  37   DwarfCompileUnit *Skeleton;
  38
  39   /// A label at the start of the non-dwo section related to this unit.
  40   MCSymbol *SectionSym;
  41
  42   /// \brief Construct a DIE for the given DbgVariable without initializing the
  43   /// DbgVariable's DIE reference.
  44   std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
  45                                                 bool Abstract);
  46
  47 public:
  48   DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
  49                    DwarfDebug *DW, DwarfFile *DWU);
  50
  51   DwarfCompileUnit *getSkeleton() const {
  52     return Skeleton;
  53   }
  54
  55   void initStmtList(MCSymbol *DwarfLineSectionSym);
  56
  57   /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
  58   void applyStmtList(DIE &D);
  59
  60   /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
  61   DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
  62
  63   /// addLabelAddress - Add a dwarf label attribute data and value using
  64   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
  65   void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  66                        const MCSymbol *Label);
  67
  68   /// addLocalLabelAddress - Add a dwarf label attribute data and value using
  69   /// DW_FORM_addr only.
  70   void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  71                             const MCSymbol *Label);
  72
  73   /// addSectionDelta - Add a label delta attribute data and value.
  74   void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
  75                        const MCSymbol *Lo);
  76
  77   DwarfCompileUnit &getCU() override { return *this; }
  78
  79   unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
  80
  81   /// addRange - Add an address range to the list of ranges for this unit.
  82   void addRange(RangeSpan Range);
  83
  84   void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
  85
  86   /// addSectionLabel - Add a Dwarf section label attribute data and value.
  87   ///
  88   void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
  89                        const MCSymbol *Label, const MCSymbol *Sec);
  90
  91   /// \brief Find DIE for the given subprogram and attach appropriate
  92   /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
  93   /// variables in this scope then create and insert DIEs for these
  94   /// variables.
  95   DIE &updateSubprogramScopeDIE(DISubprogram SP);
  96
  97   void constructScopeDIE(LexicalScope *Scope,
  98                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
  99
 100   /// \brief A helper function to construct a RangeSpanList for a given
 101   /// lexical scope.
 102   void addScopeRangeList(DIE &ScopeDIE,
 103                          const SmallVectorImpl<InsnRange> &Range);
 104
 105   void attachRangesOrLowHighPC(DIE &D,
 106                                const SmallVectorImpl<InsnRange> &Ranges);
 107
 108   /// \brief This scope represents inlined body of a function. Construct
 109   /// DIE to represent this concrete inlined copy of the function.
 110   std::unique_ptr<DIE> constructInlinedScopeDIE(LexicalScope *Scope);
 111
 112   /// \brief Construct new DW_TAG_lexical_block for this scope and
 113   /// attach DW_AT_low_pc/DW_AT_high_pc labels.
 114   std::unique_ptr<DIE> constructLexicalScopeDIE(LexicalScope *Scope);
 115
 116   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 117   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
 118                                             bool Abstract = false);
 119
 120   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
 121                                             const LexicalScope &Scope,
 122                                             DIE *&ObjectPointer);
 123
 124   /// A helper function to create children of a Scope DIE.
 125   DIE *createScopeChildrenDIE(LexicalScope *Scope,
 126                               SmallVectorImpl<std::unique_ptr<DIE>> &Children,
 127                               unsigned *ChildScopeCount = nullptr);
 128
 129   /// \brief Construct a DIE for this subprogram scope.
 130   void constructSubprogramScopeDIE(LexicalScope *Scope);
 131
 132   DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
 133
 134   void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
 135
 136   /// \brief Construct import_module DIE.
 137   std::unique_ptr<DIE>
 138   constructImportedEntityDIE(const DIImportedEntity &Module);
 139
 140   void finishSubprogramDefinition(DISubprogram SP);
 141
 142   void collectDeadVariables(DISubprogram SP);
 143
 144   /// If there's a skeleton then return the begin label for the skeleton unit,
 145   /// otherwise return the local label for this unit.
 146   MCSymbol *getLocalLabelBegin() const {
 147     if (Skeleton)
 148       return Skeleton->getLabelBegin();
 149     return getLabelBegin();
 150   }
 151
 152   /// If there's a skeleton then return the section symbol for the skeleton
 153   /// unit, otherwise return the section symbol for this unit.
 154   MCSymbol *getLocalSectionSym() const {
 155     if (Skeleton)
 156       return Skeleton->getSectionSym();
 157     return getSectionSym();
 158   }
 159
 160   /// Set the skeleton unit associated with this unit.
 161   void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
 162
 163   MCSymbol *getSectionSym() const {
 164     assert(Section);
 165     return SectionSym;
 166   }
 167
 168   /// Pass in the SectionSym even though we could recreate it in every compile
 169   /// unit (type units will have actually distinct symbols once they're in
 170   /// comdat sections).
 171   void initSection(const MCSection *Section, MCSymbol *SectionSym) {
 172     DwarfUnit::initSection(Section);
 173     this->SectionSym = SectionSym;
 174   }
 175
 176   unsigned getLength() {
 177     return sizeof(uint32_t) + // Length field
 178         getHeaderSize() + UnitDie.getSize();
 179   }
 180
 181   void emitHeader(const MCSymbol *ASectionSym) const override;
 182 };
 183
 184 } // end llvm namespace
 185
 186 #endif