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