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