1 //===- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit -----*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This file contains support for writing dwarf compile unit.
11 //===----------------------------------------------------------------------===//
13 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
14 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
16 #include "DwarfDebug.h"
17 #include "DwarfUnit.h"
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/SmallVector.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/BinaryFormat/Dwarf.h"
24 #include "llvm/CodeGen/DbgEntityHistoryCalculator.h"
25 #include "llvm/CodeGen/DIE.h"
26 #include "llvm/CodeGen/LexicalScopes.h"
27 #include "llvm/IR/DebugInfoMetadata.h"
28 #include "llvm/Support/Casting.h"
43 class DwarfCompileUnit final : public DwarfUnit {
44 /// A numeric ID unique among all CUs in the module
46 bool HasRangeLists = false;
48 /// The attribute index of DW_AT_stmt_list in the compile unit DIE, avoiding
49 /// the need to search for it in applyStmtList.
50 DIE::value_iterator StmtListValue;
52 /// Skeleton unit associated with this unit.
53 DwarfCompileUnit *Skeleton = nullptr;
55 /// The start of the unit within its section.
58 /// The start of the unit macro info within macro section.
59 MCSymbol *MacroLabelBegin;
61 using ImportedEntityList = SmallVector<const MDNode *, 8>;
62 using ImportedEntityMap = DenseMap<const MDNode *, ImportedEntityList>;
64 ImportedEntityMap ImportedEntities;
66 /// GlobalNames - A map of globally visible named entities for this unit.
67 StringMap<const DIE *> GlobalNames;
69 /// GlobalTypes - A map of globally visible types for this unit.
70 StringMap<const DIE *> GlobalTypes;
72 // List of ranges for a given compile unit.
73 SmallVector<RangeSpan, 2> CURanges;
75 // The base address of this unit, if any. Used for relative references in
77 const MCSymbol *BaseAddress = nullptr;
79 DenseMap<const MDNode *, DIE *> AbstractSPDies;
80 DenseMap<const DINode *, std::unique_ptr<DbgEntity>> AbstractEntities;
82 /// DWO ID for correlating skeleton and split units.
85 /// Construct a DIE for the given DbgVariable without initializing the
86 /// DbgVariable's DIE reference.
87 DIE *constructVariableDIEImpl(const DbgVariable &DV, bool Abstract);
89 bool isDwoUnit() const override;
91 DenseMap<const MDNode *, DIE *> &getAbstractSPDies() {
92 if (isDwoUnit() && !DD->shareAcrossDWOCUs())
93 return AbstractSPDies;
94 return DU->getAbstractSPDies();
97 DenseMap<const DINode *, std::unique_ptr<DbgEntity>> &getAbstractEntities() {
98 if (isDwoUnit() && !DD->shareAcrossDWOCUs())
99 return AbstractEntities;
100 return DU->getAbstractEntities();
103 void finishNonUnitTypeDIE(DIE& D, const DICompositeType *CTy) override;
106 DwarfCompileUnit(unsigned UID, const DICompileUnit *Node, AsmPrinter *A,
107 DwarfDebug *DW, DwarfFile *DWU);
109 bool hasRangeLists() const { return HasRangeLists; }
110 unsigned getUniqueID() const { return UniqueID; }
112 DwarfCompileUnit *getSkeleton() const {
116 bool includeMinimalInlineScopes() const;
120 /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
121 void applyStmtList(DIE &D);
123 /// A pair of GlobalVariable and DIExpression.
125 const GlobalVariable *Var;
126 const DIExpression *Expr;
130 BaseTypeRef(unsigned BitSize, dwarf::TypeKind Encoding) :
131 BitSize(BitSize), Encoding(Encoding) {}
133 dwarf::TypeKind Encoding;
137 std::vector<BaseTypeRef> ExprRefedBaseTypes;
139 /// Get or create global variable DIE.
141 getOrCreateGlobalVariableDIE(const DIGlobalVariable *GV,
142 ArrayRef<GlobalExpr> GlobalExprs);
144 DIE *getOrCreateCommonBlock(const DICommonBlock *CB,
145 ArrayRef<GlobalExpr> GlobalExprs);
147 void addLocationAttribute(DIE *ToDIE, const DIGlobalVariable *GV,
148 ArrayRef<GlobalExpr> GlobalExprs);
150 /// addLabelAddress - Add a dwarf label attribute data and value using
151 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
152 void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
153 const MCSymbol *Label);
155 /// addLocalLabelAddress - Add a dwarf label attribute data and value using
156 /// DW_FORM_addr only.
157 void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
158 const MCSymbol *Label);
160 DwarfCompileUnit &getCU() override { return *this; }
162 unsigned getOrCreateSourceID(const DIFile *File) override;
164 void addImportedEntity(const DIImportedEntity* IE) {
165 DIScope *Scope = IE->getScope();
166 assert(Scope && "Invalid Scope encoding!");
167 if (!isa<DILocalScope>(Scope))
168 // No need to add imported enities that are not local declaration.
171 auto *LocalScope = cast<DILocalScope>(Scope)->getNonLexicalBlockFileScope();
172 ImportedEntities[LocalScope].push_back(IE);
175 /// addRange - Add an address range to the list of ranges for this unit.
176 void addRange(RangeSpan Range);
178 void attachLowHighPC(DIE &D, const MCSymbol *Begin, const MCSymbol *End);
180 /// Find DIE for the given subprogram and attach appropriate
181 /// DW_AT_low_pc and DW_AT_high_pc attributes. If there are global
182 /// variables in this scope then create and insert DIEs for these
184 DIE &updateSubprogramScopeDIE(const DISubprogram *SP);
186 void constructScopeDIE(LexicalScope *Scope,
187 SmallVectorImpl<DIE *> &FinalChildren);
189 /// A helper function to construct a RangeSpanList for a given
191 void addScopeRangeList(DIE &ScopeDIE, SmallVector<RangeSpan, 2> Range);
193 void attachRangesOrLowHighPC(DIE &D, SmallVector<RangeSpan, 2> Ranges);
195 void attachRangesOrLowHighPC(DIE &D,
196 const SmallVectorImpl<InsnRange> &Ranges);
198 /// This scope represents inlined body of a function. Construct
199 /// DIE to represent this concrete inlined copy of the function.
200 DIE *constructInlinedScopeDIE(LexicalScope *Scope);
202 /// Construct new DW_TAG_lexical_block for this scope and
203 /// attach DW_AT_low_pc/DW_AT_high_pc labels.
204 DIE *constructLexicalScopeDIE(LexicalScope *Scope);
206 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
207 DIE *constructVariableDIE(DbgVariable &DV, bool Abstract = false);
209 DIE *constructVariableDIE(DbgVariable &DV, const LexicalScope &Scope,
210 DIE *&ObjectPointer);
212 /// Construct a DIE for the given DbgLabel.
213 DIE *constructLabelDIE(DbgLabel &DL, const LexicalScope &Scope);
215 /// A helper function to create children of a Scope DIE.
216 DIE *createScopeChildrenDIE(LexicalScope *Scope,
217 SmallVectorImpl<DIE *> &Children,
218 bool *HasNonScopeChildren = nullptr);
220 void createBaseTypeDIEs();
222 /// Construct a DIE for this subprogram scope.
223 DIE &constructSubprogramScopeDIE(const DISubprogram *Sub,
224 LexicalScope *Scope);
226 DIE *createAndAddScopeChildren(LexicalScope *Scope, DIE &ScopeDIE);
228 void constructAbstractSubprogramScopeDIE(LexicalScope *Scope);
230 /// Construct a call site entry DIE describing a call within \p Scope to a
231 /// callee described by \p CalleeSP. \p IsTail specifies whether the call is
232 /// a tail call. \p PCOffset must be non-zero for non-tail calls or be the
233 /// function-local offset to PC value after the call instruction.
234 DIE &constructCallSiteEntryDIE(DIE &ScopeDIE, const DISubprogram &CalleeSP,
235 bool IsTail, const MCExpr *PCOffset);
237 /// Construct import_module DIE.
238 DIE *constructImportedEntityDIE(const DIImportedEntity *Module);
240 void finishSubprogramDefinition(const DISubprogram *SP);
241 void finishEntityDefinition(const DbgEntity *Entity);
243 /// Find abstract variable associated with Var.
244 using InlinedEntity = DbgValueHistoryMap::InlinedEntity;
245 DbgEntity *getExistingAbstractEntity(const DINode *Node);
246 void createAbstractEntity(const DINode *Node, LexicalScope *Scope);
248 /// Set the skeleton unit associated with this unit.
249 void setSkeleton(DwarfCompileUnit &Skel) { Skeleton = &Skel; }
251 unsigned getHeaderSize() const override {
252 // DWARF v5 added the DWO ID to the header for split/skeleton units.
254 DD->getDwarfVersion() >= 5 && DD->useSplitDwarf() ? sizeof(uint64_t)
256 return DwarfUnit::getHeaderSize() + DWOIdSize;
258 unsigned getLength() {
259 return sizeof(uint32_t) + // Length field
260 getHeaderSize() + getUnitDie().getSize();
263 void emitHeader(bool UseOffsets) override;
265 /// Add the DW_AT_addr_base attribute to the unit DIE.
266 void addAddrTableBase();
268 MCSymbol *getLabelBegin() const {
269 assert(getSection());
273 MCSymbol *getMacroLabelBegin() const {
274 return MacroLabelBegin;
277 /// Add a new global name to the compile unit.
278 void addGlobalName(StringRef Name, const DIE &Die,
279 const DIScope *Context) override;
281 /// Add a new global name present in a type unit to this compile unit.
282 void addGlobalNameForTypeUnit(StringRef Name, const DIScope *Context);
284 /// Add a new global type to the compile unit.
285 void addGlobalType(const DIType *Ty, const DIE &Die,
286 const DIScope *Context) override;
288 /// Add a new global type present in a type unit to this compile unit.
289 void addGlobalTypeUnitType(const DIType *Ty, const DIScope *Context);
291 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
292 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
294 /// Add DW_AT_location attribute for a DbgVariable based on provided
296 void addVariableAddress(const DbgVariable &DV, DIE &Die,
297 MachineLocation Location);
298 /// Add an address attribute to a die based on the location provided.
299 void addAddress(DIE &Die, dwarf::Attribute Attribute,
300 const MachineLocation &Location);
302 /// Start with the address based on the location provided, and generate the
303 /// DWARF information necessary to find the actual variable (navigating the
304 /// extra location information encoded in the type) based on the starting
305 /// location. Add the DWARF information to the die.
306 void addComplexAddress(const DbgVariable &DV, DIE &Die,
307 dwarf::Attribute Attribute,
308 const MachineLocation &Location);
310 /// Add a Dwarf loclistptr attribute data and value.
311 void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
312 void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
314 /// Add a Dwarf expression attribute data and value.
315 void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
317 /// Add an attribute containing an address expression to \p Die.
318 void addAddressExpr(DIE &Die, dwarf::Attribute Attribute, const MCExpr *Expr);
320 void applySubprogramAttributesToDefinition(const DISubprogram *SP,
323 void applyLabelAttributes(const DbgLabel &Label, DIE &LabelDie);
325 /// getRanges - Get the list of ranges for this unit.
326 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
327 SmallVector<RangeSpan, 2> takeRanges() { return std::move(CURanges); }
329 void setBaseAddress(const MCSymbol *Base) { BaseAddress = Base; }
330 const MCSymbol *getBaseAddress() const { return BaseAddress; }
332 uint64_t getDWOId() const { return DWOId; }
333 void setDWOId(uint64_t DwoId) { DWOId = DwoId; }
335 bool hasDwarfPubSections() const;
337 void addBaseTypeRef(DIEValueList &Die, int64_t Idx);
340 } // end namespace llvm
342 #endif // LLVM_LIB_CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H