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   /// The start of the unit within its section.
  43   MCSymbol *LabelBegin;
  44
  45   /// GlobalNames - A map of globally visible named entities for this unit.
  46   StringMap<const DIE *> GlobalNames;
  47
  48   /// GlobalTypes - A map of globally visible types for this unit.
  49   StringMap<const DIE *> GlobalTypes;
  50
  51   /// \brief Construct a DIE for the given DbgVariable without initializing the
  52   /// DbgVariable's DIE reference.
  53   std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
  54                                                 bool Abstract);
  55
  56 public:
  57   DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
  58                    DwarfDebug *DW, DwarfFile *DWU);
  59
  60   DwarfCompileUnit *getSkeleton() const {
  61     return Skeleton;
  62   }
  63
  64   void initStmtList(MCSymbol *DwarfLineSectionSym);
  65
  66   /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
  67   void applyStmtList(DIE &D);
  68
  69   /// getOrCreateGlobalVariableDIE - get or create global variable DIE.
  70   DIE *getOrCreateGlobalVariableDIE(DIGlobalVariable GV);
  71
  72   /// addLabelAddress - Add a dwarf label attribute data and value using
  73   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
  74   void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  75                        const MCSymbol *Label);
  76
  77   /// addLocalLabelAddress - Add a dwarf label attribute data and value using
  78   /// DW_FORM_addr only.
  79   void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
  80                             const MCSymbol *Label);
  81
  82   /// addSectionDelta - Add a label delta attribute data and value.
  83   void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
  84                        const MCSymbol *Lo);
  85
  86   DwarfCompileUnit &getCU() override { return *this; }
  87
  88   unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
  89
  90   /// addRange - Add an address range to the list of ranges for this unit.
  91   void addRange(RangeSpan Range);
  92
  93   void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
  94
  95   /// addSectionLabel - Add a Dwarf section label attribute data and value.
  96   ///
  97   void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
  98                        const MCSymbol *Label, const MCSymbol *Sec);
  99
 100   /// \brief Find DIE for the given subprogram and attach appropriate
 101   /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
 102   /// variables in this scope then create and insert DIEs for these
 103   /// variables.
 104   DIE &updateSubprogramScopeDIE(DISubprogram SP);
 105
 106   void constructScopeDIE(LexicalScope *Scope,
 107                          SmallVectorImpl<std::unique_ptr<DIE>> &FinalChildren);
 108
 109   /// \brief A helper function to construct a RangeSpanList for a given
 110   /// lexical scope.
 111   void addScopeRangeList(DIE &ScopeDIE,
 112                          const SmallVectorImpl<InsnRange> &Range);
 113
 114   void attachRangesOrLowHighPC(DIE &D,
 115                                const SmallVectorImpl<InsnRange> &Ranges);
 116
 117   /// \brief This scope represents inlined body of a function. Construct
 118   /// DIE to represent this concrete inlined copy of the function.
 119   std::unique_ptr<DIE> constructInlinedScopeDIE(LexicalScope *Scope);
 120
 121   /// \brief Construct new DW_TAG_lexical_block for this scope and
 122   /// attach DW_AT_low_pc/DW_AT_high_pc labels.
 123   std::unique_ptr<DIE> constructLexicalScopeDIE(LexicalScope *Scope);
 124
 125   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 126   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
 127                                             bool Abstract = false);
 128
 129   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
 130                                             const LexicalScope &Scope,
 131                                             DIE *&ObjectPointer);
 132
 133   /// A helper function to create children of a Scope DIE.
 134   DIE *createScopeChildrenDIE(LexicalScope *Scope,
 135                               SmallVectorImpl<std::unique_ptr<DIE>> &Children,
 136                               unsigned *ChildScopeCount = nullptr);
 137
 138   /// \brief Construct a DIE for this subprogram scope.
 139   void constructSubprogramScopeDIE(LexicalScope *Scope);
 140
 141   DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
 142
 143   void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
 144
 145   /// \brief Construct import_module DIE.
 146   std::unique_ptr<DIE>
 147   constructImportedEntityDIE(const DIImportedEntity &Module);
 148
 149   void finishSubprogramDefinition(DISubprogram SP);
 150
 151   void collectDeadVariables(DISubprogram SP);
 152
 153   /// Set the skeleton unit associated with this unit.
 154   void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
 155
 156   MCSymbol *getSectionSym() const {
 157     assert(Section);
 158     return SectionSym;
 159   }
 160
 161   /// Pass in the SectionSym even though we could recreate it in every compile
 162   /// unit (type units will have actually distinct symbols once they're in
 163   /// comdat sections).
 164   void initSection(const MCSection *Section, MCSymbol *SectionSym) {
 165     DwarfUnit::initSection(Section);
 166     this->SectionSym = SectionSym;
 167
 168     // Don't bother labeling the .dwo unit, as its offset isn't used.
 169     if (!Skeleton)
 170       LabelBegin =
 171           Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
 172   }
 173
 174   unsigned getLength() {
 175     return sizeof(uint32_t) + // Length field
 176         getHeaderSize() + UnitDie.getSize();
 177   }
 178
 179   void emitHeader(const MCSymbol *ASectionSym) const override;
 180
 181   MCSymbol *getLabelBegin() const {
 182     assert(Section);
 183     return LabelBegin;
 184   }
 185
 186   /// Add a new global name to the compile unit.
 187   void addGlobalName(StringRef Name, DIE &Die, DIScope Context) override;
 188
 189   /// Add a new global type to the compile unit.
 190   void addGlobalType(DIType Ty, const DIE &Die, DIScope Context) override;
 191
 192   const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
 193   const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
 194
 195   /// Add DW_AT_location attribute for a DbgVariable based on provided
 196   /// MachineLocation.
 197   void addVariableAddress(const DbgVariable &DV, DIE &Die,
 198                           MachineLocation Location);
 199   /// Add an address attribute to a die based on the location provided.
 200   void addAddress(DIE &Die, dwarf::Attribute Attribute,
 201                   const MachineLocation &Location, bool Indirect = false);
 202
 203   /// Start with the address based on the location provided, and generate the
 204   /// DWARF information necessary to find the actual variable (navigating the
 205   /// extra location information encoded in the type) based on the starting
 206   /// location.  Add the DWARF information to the die.
 207   void addComplexAddress(const DbgVariable &DV, DIE &Die,
 208                          dwarf::Attribute Attribute,
 209                          const MachineLocation &Location);
 210
 211   /// Add a Dwarf loclistptr attribute data and value.
 212   void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
 213 };
 214
 215 } // end llvm namespace
 216
 217 #endif