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