1 //===-- llvm/CodeGen/DwarfUnit.h - Dwarf Compile Unit ---*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf compile unit.
12 //===----------------------------------------------------------------------===//
14 #ifndef CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
15 #define CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
18 #include "DwarfDebug.h"
19 #include "llvm/ADT/DenseMap.h"
20 #include "llvm/ADT/Optional.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/CodeGen/AsmPrinter.h"
23 #include "llvm/IR/DIBuilder.h"
24 #include "llvm/IR/DebugInfo.h"
25 #include "llvm/MC/MCExpr.h"
26 #include "llvm/MC/MCSection.h"
27 #include "llvm/MC/MCDwarf.h"
31 class MachineLocation;
36 class DwarfCompileUnit;
38 // Data structure to hold a range for range lists.
41 RangeSpan(MCSymbol *S, MCSymbol *E) : Start(S), End(E) {}
42 const MCSymbol *getStart() const { return Start; }
43 const MCSymbol *getEnd() const { return End; }
44 void setEnd(const MCSymbol *E) { End = E; }
47 const MCSymbol *Start, *End;
52 // Index for locating within the debug_range section this particular span.
55 SmallVector<RangeSpan, 2> Ranges;
58 RangeSpanList(MCSymbol *Sym) : RangeSym(Sym) {}
59 MCSymbol *getSym() const { return RangeSym; }
60 const SmallVectorImpl<RangeSpan> &getRanges() const { return Ranges; }
61 void addRange(RangeSpan Range) { Ranges.push_back(Range); }
64 enum AbstractOrInlined { AOI_None, AOI_Inlined, AOI_Abstract };
66 //===----------------------------------------------------------------------===//
67 /// Unit - This dwarf writer support class manages information associated
68 /// with a source file.
71 /// UniqueID - a numeric ID unique among all CUs in the module
74 /// Node - MDNode for the compile unit.
77 /// Unit debug information entry.
80 /// Offset of the UnitDie from beginning of debug info section.
81 unsigned DebugInfoOffset;
83 /// Asm - Target of Dwarf emission.
86 // Holders for some common dwarf information.
90 /// IndexTyDie - An anonymous type for index type. Owned by UnitDie.
93 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
94 /// variables to debug information entries.
95 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
97 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
98 /// descriptors to debug information entries using a DIEEntry proxy.
99 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
101 /// GlobalNames - A map of globally visible named entities for this unit.
102 StringMap<const DIE *> GlobalNames;
104 /// GlobalTypes - A map of globally visible types for this unit.
105 StringMap<const DIE *> GlobalTypes;
107 /// DIEBlocks - A list of all the DIEBlocks in use.
108 std::vector<DIEBlock *> DIEBlocks;
110 /// DIELocs - A list of all the DIELocs in use.
111 std::vector<DIELoc *> DIELocs;
113 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
114 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
115 /// corresponds to the MDNode mapped with the subprogram DIE.
116 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
118 // List of ranges for a given compile unit.
119 SmallVector<RangeSpan, 1> CURanges;
121 // List of range lists for a given compile unit, separate from the ranges for
123 SmallVector<RangeSpanList, 1> CURangeLists;
125 // DIEValueAllocator - All DIEValues are allocated through this allocator.
126 BumpPtrAllocator DIEValueAllocator;
128 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
129 DIEInteger *DIEIntegerOne;
131 /// The section this unit will be emitted in.
132 const MCSection *Section;
134 /// A label at the start of the non-dwo section related to this unit.
135 MCSymbol *SectionSym;
137 /// The start of the unit within its section.
138 MCSymbol *LabelBegin;
140 /// The end of the unit within its section.
143 /// Skeleton unit associated with this unit.
146 DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
147 DwarfDebug *DW, DwarfFile *DWU);
150 virtual ~DwarfUnit();
152 /// Set the skeleton unit associated with this unit.
153 void setSkeleton(DwarfUnit &Skel) { Skeleton = &Skel; }
155 /// Get the skeleton unit associated with this unit.
156 DwarfUnit *getSkeleton() const { return Skeleton; }
158 /// Pass in the SectionSym even though we could recreate it in every compile
159 /// unit (type units will have actually distinct symbols once they're in
160 /// comdat sections).
161 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
162 assert(!this->Section);
163 this->Section = Section;
164 this->SectionSym = SectionSym;
166 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
168 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
171 const MCSection *getSection() const {
176 /// If there's a skeleton then return the section symbol for the skeleton
177 /// unit, otherwise return the section symbol for this unit.
178 MCSymbol *getLocalSectionSym() const {
180 return Skeleton->getSectionSym();
181 return getSectionSym();
184 MCSymbol *getSectionSym() const {
189 /// If there's a skeleton then return the begin label for the skeleton unit,
190 /// otherwise return the local label for this unit.
191 MCSymbol *getLocalLabelBegin() const {
193 return Skeleton->getLabelBegin();
194 return getLabelBegin();
197 MCSymbol *getLabelBegin() const {
202 MCSymbol *getLabelEnd() const {
208 unsigned getUniqueID() const { return UniqueID; }
209 uint16_t getLanguage() const { return CUNode.getLanguage(); }
210 DICompileUnit getCUNode() const { return CUNode; }
211 DIE &getUnitDie() { return UnitDie; }
212 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
213 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
215 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
216 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
218 /// hasContent - Return true if this compile unit has something to write out.
219 bool hasContent() const { return !UnitDie.getChildren().empty(); }
221 /// addRange - Add an address range to the list of ranges for this unit.
222 void addRange(RangeSpan Range);
224 /// getRanges - Get the list of ranges for this unit.
225 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
226 SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
228 /// addRangeList - Add an address range list to the list of range lists.
229 void addRangeList(RangeSpanList Ranges) { CURangeLists.push_back(Ranges); }
231 /// getRangeLists - Get the vector of range lists.
232 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
235 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
237 /// getParentContextString - Get a string containing the language specific
238 /// context for a global name.
239 std::string getParentContextString(DIScope Context) const;
241 /// addGlobalName - Add a new global entity to the compile unit.
243 void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
245 /// addAccelNamespace - Add a new name to the namespace accelerator table.
246 void addAccelNamespace(StringRef Name, const DIE &Die);
248 /// getDIE - Returns the debug information entry map slot for the
249 /// specified debug variable. We delegate the request to DwarfDebug
250 /// when the MDNode can be part of the type system, since DIEs for
251 /// the type system can be shared across CUs and the mappings are
252 /// kept in DwarfDebug.
253 DIE *getDIE(DIDescriptor D) const;
255 /// getDIELoc - Returns a fresh newly allocated DIELoc.
256 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
258 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
259 /// when the MDNode can be part of the type system, since DIEs for
260 /// the type system can be shared across CUs and the mappings are
261 /// kept in DwarfDebug.
262 void insertDIE(DIDescriptor Desc, DIE *D);
264 /// addFlag - Add a flag that is true to the DIE.
265 void addFlag(DIE &Die, dwarf::Attribute Attribute);
267 /// addUInt - Add an unsigned integer attribute data and value.
268 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
271 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
273 /// addSInt - Add an signed integer attribute data and value.
274 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
277 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
279 /// addString - Add a string attribute data and value.
280 void addString(DIE &Die, dwarf::Attribute Attribute, const StringRef Str);
282 /// addLocalString - Add a string attribute data and value.
283 void addLocalString(DIE &Die, dwarf::Attribute Attribute,
284 const StringRef Str);
286 /// addExpr - Add a Dwarf expression attribute data and value.
287 void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
289 /// addLabel - Add a Dwarf label attribute data and value.
290 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
291 const MCSymbol *Label);
293 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
295 /// addLocationList - Add a Dwarf loclistptr attribute data and value.
296 void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
298 /// addSectionLabel - Add a Dwarf section label attribute data and value.
300 void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
301 const MCSymbol *Label);
303 /// addSectionOffset - Add an offset into a section attribute data and value.
305 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
307 /// addOpAddress - Add a dwarf op address data and value using the
308 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
309 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
311 /// addSectionDelta - Add a label delta attribute data and value.
312 void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
315 /// addLabelDelta - Add a label delta attribute data and value.
316 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
319 /// addDIEEntry - Add a DIE attribute data and value.
320 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
322 /// addDIEEntry - Add a DIE attribute data and value.
323 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
325 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
327 /// addBlock - Add block data.
328 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
330 /// addBlock - Add block data.
331 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
333 /// addSourceLine - Add location information to specified debug information
335 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
336 StringRef Directory);
337 void addSourceLine(DIE &Die, DIVariable V);
338 void addSourceLine(DIE &Die, DIGlobalVariable G);
339 void addSourceLine(DIE &Die, DISubprogram SP);
340 void addSourceLine(DIE &Die, DIType Ty);
341 void addSourceLine(DIE &Die, DINameSpace NS);
342 void addSourceLine(DIE &Die, DIObjCProperty Ty);
344 /// addAddress - Add an address attribute to a die based on the location
346 void addAddress(DIE &Die, dwarf::Attribute Attribute,
347 const MachineLocation &Location, bool Indirect = false);
349 /// addConstantValue - Add constant value entry in variable DIE.
350 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
351 void addConstantValue(DIE &Die, const ConstantInt *CI, bool Unsigned);
352 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
354 /// addConstantFPValue - Add constant value entry in variable DIE.
355 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
356 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
358 /// addTemplateParams - Add template parameters in buffer.
359 void addTemplateParams(DIE &Buffer, DIArray TParams);
361 /// addRegisterOp - Add register operand.
362 void addRegisterOp(DIELoc &TheDie, unsigned Reg);
364 /// addRegisterOffset - Add register offset.
365 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
367 /// addComplexAddress - Start with the address based on the location provided,
368 /// and generate the DWARF information necessary to find the actual variable
369 /// (navigating the extra location information encoded in the type) based on
370 /// the starting location. Add the DWARF information to the die.
371 void addComplexAddress(const DbgVariable &DV, DIE &Die,
372 dwarf::Attribute Attribute,
373 const MachineLocation &Location);
375 // FIXME: Should be reformulated in terms of addComplexAddress.
376 /// addBlockByrefAddress - Start with the address based on the location
377 /// provided, and generate the DWARF information necessary to find the
378 /// actual Block variable (navigating the Block struct) based on the
379 /// starting location. Add the DWARF information to the die. Obsolete,
380 /// please use addComplexAddress instead.
381 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
382 dwarf::Attribute Attribute,
383 const MachineLocation &Location);
385 /// addVariableAddress - Add DW_AT_location attribute for a
386 /// DbgVariable based on provided MachineLocation.
387 void addVariableAddress(const DbgVariable &DV, DIE &Die,
388 MachineLocation Location);
390 /// addType - Add a new type attribute to the specified entity. This takes
391 /// and attribute parameter because DW_AT_friend attributes are also
393 void addType(DIE &Entity, DIType Ty,
394 dwarf::Attribute Attribute = dwarf::DW_AT_type);
396 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
397 DIE *getOrCreateNameSpace(DINameSpace NS);
399 /// getOrCreateSubprogramDIE - Create new DIE using SP.
400 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
402 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
404 DIE *getOrCreateTypeDIE(const MDNode *N);
406 /// getOrCreateContextDIE - Get context owner's DIE.
407 DIE *createTypeDIE(DICompositeType Ty);
409 /// getOrCreateContextDIE - Get context owner's DIE.
410 DIE *getOrCreateContextDIE(DIScope Context);
412 /// constructContainingTypeDIEs - Construct DIEs for types that contain
414 void constructContainingTypeDIEs();
416 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
417 std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
418 AbstractOrInlined AbsIn = AOI_None);
420 /// constructSubprogramArguments - Construct function argument DIEs.
421 void constructSubprogramArguments(DIE &Buffer, DIArray Args);
423 /// Create a DIE with the given Tag, add the DIE to its parent, and
424 /// call insertDIE if MD is not null.
425 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
426 DIDescriptor N = DIDescriptor());
428 /// Compute the size of a header for this unit, not including the initial
430 virtual unsigned getHeaderSize() const {
431 return sizeof(int16_t) + // DWARF version number
432 sizeof(int32_t) + // Offset Into Abbrev. Section
433 sizeof(int8_t); // Pointer Size (in bytes)
436 /// Emit the header for this unit, not including the initial length field.
437 virtual void emitHeader(const MCSymbol *ASectionSym) const;
439 virtual DwarfCompileUnit &getCU() = 0;
441 /// constructTypeDIE - Construct type DIE from DICompositeType.
442 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
445 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
446 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
448 /// Look up the source ID with the given directory and source file names. If
449 /// none currently exists, create a new ID and insert it in the line table.
450 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
453 /// \brief Construct a DIE for the given DbgVariable without initializing the
454 /// DbgVariable's DIE reference.
455 std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
456 AbstractOrInlined AbsIn);
458 /// constructTypeDIE - Construct basic type die from DIBasicType.
459 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
461 /// constructTypeDIE - Construct derived type die from DIDerivedType.
462 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
464 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
465 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
467 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
468 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
470 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
471 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
473 /// constructMemberDIE - Construct member DIE from DIDerivedType.
474 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
476 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
477 /// DITemplateTypeParameter.
478 void constructTemplateTypeParameterDIE(DIE &Buffer,
479 DITemplateTypeParameter TP);
481 /// constructTemplateValueParameterDIE - Construct new DIE for the given
482 /// DITemplateValueParameter.
483 void constructTemplateValueParameterDIE(DIE &Buffer,
484 DITemplateValueParameter TVP);
486 /// getLowerBoundDefault - Return the default lower bound for an array. If the
487 /// DWARF version doesn't handle the language, return -1.
488 int64_t getDefaultLowerBound() const;
490 /// getDIEEntry - Returns the debug information entry for the specified
492 DIEEntry *getDIEEntry(const MDNode *N) const {
493 return MDNodeToDIEEntryMap.lookup(N);
496 /// insertDIEEntry - Insert debug information entry into the map.
497 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
498 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
501 // getIndexTyDie - Get an anonymous type for index type.
502 DIE *getIndexTyDie() { return IndexTyDie; }
504 // setIndexTyDie - Set D as anonymous type for index which can be reused
506 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
508 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
509 /// information entry.
510 DIEEntry *createDIEEntry(DIE &Entry);
512 /// resolve - Look in the DwarfDebug map for the MDNode that
513 /// corresponds to the reference.
514 template <typename T> T resolve(DIRef<T> Ref) const {
515 return DD->resolve(Ref);
518 /// If this is a named finished type then include it in the list of types for
519 /// the accelerator tables.
520 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
523 class DwarfCompileUnit : public DwarfUnit {
524 /// The attribute index of DW_AT_stmt_list in the compile unit DIE, avoiding
525 /// the need to search for it in applyStmtList.
526 unsigned stmtListIndex;
529 DwarfCompileUnit(unsigned UID, DICompileUnit Node, AsmPrinter *A,
530 DwarfDebug *DW, DwarfFile *DWU);
532 void initStmtList(MCSymbol *DwarfLineSectionSym);
534 /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
535 void applyStmtList(DIE &D);
537 /// createGlobalVariableDIE - create global variable DIE.
538 void createGlobalVariableDIE(DIGlobalVariable GV);
540 /// addLabelAddress - Add a dwarf label attribute data and value using
541 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
542 void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
543 const MCSymbol *Label);
545 /// addLocalLabelAddress - Add a dwarf label attribute data and value using
546 /// DW_FORM_addr only.
547 void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
548 const MCSymbol *Label);
550 DwarfCompileUnit &getCU() override { return *this; }
552 unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
555 class DwarfTypeUnit : public DwarfUnit {
557 uint64_t TypeSignature;
559 DwarfCompileUnit &CU;
560 MCDwarfDwoLineTable *SplitLineTable;
563 DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
564 DwarfDebug *DW, DwarfFile *DWU,
565 MCDwarfDwoLineTable *SplitLineTable = nullptr);
567 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
568 uint64_t getTypeSignature() const { return TypeSignature; }
569 void setType(const DIE *Ty) { this->Ty = Ty; }
571 /// Emit the header for this unit, not including the initial length field.
572 void emitHeader(const MCSymbol *ASectionSym) const override;
573 unsigned getHeaderSize() const override {
574 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
575 sizeof(uint32_t); // Type DIE Offset
577 void initSection(const MCSection *Section);
578 DwarfCompileUnit &getCU() override { return CU; }
581 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
583 } // end llvm namespace