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 //===----------------------------------------------------------------------===//
65 /// Unit - This dwarf writer support class manages information associated
66 /// with a source file.
69 /// UniqueID - a numeric ID unique among all CUs in the module
72 /// Node - MDNode for the compile unit.
75 /// Unit debug information entry.
76 const std::unique_ptr<DIE> UnitDie;
78 /// Offset of the UnitDie from beginning of debug info section.
79 unsigned DebugInfoOffset;
81 /// Asm - Target of Dwarf emission.
84 // Holders for some common dwarf information.
88 /// IndexTyDie - An anonymous type for index type. Owned by UnitDie.
91 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
92 /// variables to debug information entries.
93 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
95 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
96 /// descriptors to debug information entries using a DIEEntry proxy.
97 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
99 /// GlobalNames - A map of globally visible named entities for this unit.
100 StringMap<const DIE *> GlobalNames;
102 /// GlobalTypes - A map of globally visible types for this unit.
103 StringMap<const DIE *> GlobalTypes;
105 /// DIEBlocks - A list of all the DIEBlocks in use.
106 std::vector<DIEBlock *> DIEBlocks;
108 /// DIELocs - A list of all the DIELocs in use.
109 std::vector<DIELoc *> DIELocs;
111 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
112 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
113 /// corresponds to the MDNode mapped with the subprogram DIE.
114 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
116 // List of ranges for a given compile unit.
117 SmallVector<RangeSpan, 1> CURanges;
119 // List of range lists for a given compile unit, separate from the ranges for
121 SmallVector<RangeSpanList, 1> CURangeLists;
123 // DIEValueAllocator - All DIEValues are allocated through this allocator.
124 BumpPtrAllocator DIEValueAllocator;
126 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
127 DIEInteger *DIEIntegerOne;
129 /// The section this unit will be emitted in.
130 const MCSection *Section;
132 /// A label at the start of the non-dwo section related to this unit.
133 MCSymbol *SectionSym;
135 /// The start of the unit within its section.
136 MCSymbol *LabelBegin;
138 /// The end of the unit within its section.
141 /// The label for the start of the range sets for the elements of this unit.
142 MCSymbol *LabelRange;
144 /// Skeleton unit associated with this unit.
147 DwarfUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
148 DwarfDebug *DW, DwarfFile *DWU);
151 virtual ~DwarfUnit();
153 /// Set the skeleton unit associated with this unit.
154 void setSkeleton(DwarfUnit &Skel) { Skeleton = &Skel; }
156 /// Get the skeleton unit associated with this unit.
157 DwarfUnit *getSkeleton() const { return Skeleton; }
159 /// Pass in the SectionSym even though we could recreate it in every compile
160 /// unit (type units will have actually distinct symbols once they're in
161 /// comdat sections).
162 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
163 assert(!this->Section);
164 this->Section = Section;
165 this->SectionSym = SectionSym;
167 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
169 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
170 this->LabelRange = Asm->GetTempSymbol("gnu_ranges", getUniqueID());
173 const MCSection *getSection() const {
178 /// If there's a skeleton then return the section symbol for the skeleton
179 /// unit, otherwise return the section symbol for this unit.
180 MCSymbol *getLocalSectionSym() const {
182 return Skeleton->getSectionSym();
183 return getSectionSym();
186 MCSymbol *getSectionSym() const {
191 /// If there's a skeleton then return the begin label for the skeleton unit,
192 /// otherwise return the local label for this unit.
193 MCSymbol *getLocalLabelBegin() const {
195 return Skeleton->getLabelBegin();
196 return getLabelBegin();
199 MCSymbol *getLabelBegin() const {
204 MCSymbol *getLabelEnd() const {
209 MCSymbol *getLabelRange() const {
215 unsigned getUniqueID() const { return UniqueID; }
216 uint16_t getLanguage() const { return CUNode.getLanguage(); }
217 DICompileUnit getCUNode() const { return CUNode; }
218 DIE &getUnitDie() const { return *UnitDie; }
219 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
220 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
222 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
223 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
225 /// hasContent - Return true if this compile unit has something to write out.
226 bool hasContent() const { return !UnitDie->getChildren().empty(); }
228 /// addRange - Add an address range to the list of ranges for this unit.
229 void addRange(RangeSpan Range);
231 /// getRanges - Get the list of ranges for this unit.
232 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
233 SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
235 /// addRangeList - Add an address range list to the list of range lists.
236 void addRangeList(RangeSpanList Ranges) { CURangeLists.push_back(Ranges); }
238 /// getRangeLists - Get the vector of range lists.
239 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
242 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
244 /// getParentContextString - Get a string containing the language specific
245 /// context for a global name.
246 std::string getParentContextString(DIScope Context) const;
248 /// addGlobalName - Add a new global entity to the compile unit.
250 void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
252 /// addAccelNamespace - Add a new name to the namespace accelerator table.
253 void addAccelNamespace(StringRef Name, const DIE &Die);
255 /// getDIE - Returns the debug information entry map slot for the
256 /// specified debug variable. We delegate the request to DwarfDebug
257 /// when the MDNode can be part of the type system, since DIEs for
258 /// the type system can be shared across CUs and the mappings are
259 /// kept in DwarfDebug.
260 DIE *getDIE(DIDescriptor D) const;
262 /// getDIELoc - Returns a fresh newly allocated DIELoc.
263 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
265 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
266 /// when the MDNode can be part of the type system, since DIEs for
267 /// the type system can be shared across CUs and the mappings are
268 /// kept in DwarfDebug.
269 void insertDIE(DIDescriptor Desc, DIE *D);
271 /// addFlag - Add a flag that is true to the DIE.
272 void addFlag(DIE &Die, dwarf::Attribute Attribute);
274 /// addUInt - Add an unsigned integer attribute data and value.
275 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
278 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
280 /// addSInt - Add an signed integer attribute data and value.
281 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
284 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
286 /// addString - Add a string attribute data and value.
287 void addString(DIE &Die, dwarf::Attribute Attribute, const StringRef Str);
289 /// addLocalString - Add a string attribute data and value.
290 void addLocalString(DIE &Die, dwarf::Attribute Attribute,
291 const StringRef Str);
293 /// addExpr - Add a Dwarf expression attribute data and value.
294 void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
296 /// addLabel - Add a Dwarf label attribute data and value.
297 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
298 const MCSymbol *Label);
300 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
302 /// addLocationList - Add a Dwarf loclistptr attribute data and value.
303 void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
305 /// addSectionLabel - Add a Dwarf section label attribute data and value.
307 void addSectionLabel(DIE &Die, dwarf::Attribute Attribute,
308 const MCSymbol *Label);
310 /// addSectionOffset - Add an offset into a section attribute data and value.
312 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
314 /// addOpAddress - Add a dwarf op address data and value using the
315 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
316 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
318 /// addSectionDelta - Add a label delta attribute data and value.
319 void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
322 /// addLabelDelta - Add a label delta attribute data and value.
323 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
326 /// addDIEEntry - Add a DIE attribute data and value.
327 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
329 /// addDIEEntry - Add a DIE attribute data and value.
330 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
332 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
334 /// addBlock - Add block data.
335 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
337 /// addBlock - Add block data.
338 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
340 /// addSourceLine - Add location information to specified debug information
342 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
343 StringRef Directory);
344 void addSourceLine(DIE &Die, DIVariable V);
345 void addSourceLine(DIE &Die, DIGlobalVariable G);
346 void addSourceLine(DIE &Die, DISubprogram SP);
347 void addSourceLine(DIE &Die, DIType Ty);
348 void addSourceLine(DIE &Die, DINameSpace NS);
349 void addSourceLine(DIE &Die, DIObjCProperty Ty);
351 /// addAddress - Add an address attribute to a die based on the location
353 void addAddress(DIE &Die, dwarf::Attribute Attribute,
354 const MachineLocation &Location, bool Indirect = false);
356 /// addConstantValue - Add constant value entry in variable DIE.
357 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
358 void addConstantValue(DIE &Die, const ConstantInt *CI, bool Unsigned);
359 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
361 /// addConstantFPValue - Add constant value entry in variable DIE.
362 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
363 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
365 /// addTemplateParams - Add template parameters in buffer.
366 void addTemplateParams(DIE &Buffer, DIArray TParams);
368 /// addRegisterOp - Add register operand.
369 void addRegisterOp(DIELoc &TheDie, unsigned Reg);
371 /// addRegisterOffset - Add register offset.
372 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
374 /// addComplexAddress - Start with the address based on the location provided,
375 /// and generate the DWARF information necessary to find the actual variable
376 /// (navigating the extra location information encoded in the type) based on
377 /// the starting location. Add the DWARF information to the die.
378 void addComplexAddress(const DbgVariable &DV, DIE &Die,
379 dwarf::Attribute Attribute,
380 const MachineLocation &Location);
382 // FIXME: Should be reformulated in terms of addComplexAddress.
383 /// addBlockByrefAddress - Start with the address based on the location
384 /// provided, and generate the DWARF information necessary to find the
385 /// actual Block variable (navigating the Block struct) based on the
386 /// starting location. Add the DWARF information to the die. Obsolete,
387 /// please use addComplexAddress instead.
388 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
389 dwarf::Attribute Attribute,
390 const MachineLocation &Location);
392 /// addVariableAddress - Add DW_AT_location attribute for a
393 /// DbgVariable based on provided MachineLocation.
394 void addVariableAddress(const DbgVariable &DV, DIE &Die,
395 MachineLocation Location);
397 /// addType - Add a new type attribute to the specified entity. This takes
398 /// and attribute parameter because DW_AT_friend attributes are also
400 void addType(DIE &Entity, DIType Ty,
401 dwarf::Attribute Attribute = dwarf::DW_AT_type);
403 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
404 DIE *getOrCreateNameSpace(DINameSpace NS);
406 /// getOrCreateSubprogramDIE - Create new DIE using SP.
407 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
409 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
411 DIE *getOrCreateTypeDIE(const MDNode *N);
413 /// getOrCreateContextDIE - Get context owner's DIE.
414 DIE *createTypeDIE(DICompositeType Ty);
416 /// getOrCreateContextDIE - Get context owner's DIE.
417 DIE *getOrCreateContextDIE(DIScope Context);
419 /// constructContainingTypeDIEs - Construct DIEs for types that contain
421 void constructContainingTypeDIEs();
423 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
424 std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
425 bool isScopeAbstract);
427 /// constructSubprogramArguments - Construct function argument DIEs.
428 void constructSubprogramArguments(DIE &Buffer, DIArray Args);
430 /// Create a DIE with the given Tag, add the DIE to its parent, and
431 /// call insertDIE if MD is not null.
432 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
433 DIDescriptor N = DIDescriptor());
435 /// Compute the size of a header for this unit, not including the initial
437 virtual unsigned getHeaderSize() const {
438 return sizeof(int16_t) + // DWARF version number
439 sizeof(int32_t) + // Offset Into Abbrev. Section
440 sizeof(int8_t); // Pointer Size (in bytes)
443 /// Emit the header for this unit, not including the initial length field.
444 virtual void emitHeader(const MCSymbol *ASectionSym) const;
446 virtual DwarfCompileUnit &getCU() = 0;
449 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
450 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
452 /// Look up the source ID with the given directory and source file names. If
453 /// none currently exists, create a new ID and insert it in the line table.
454 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
457 /// \brief Construct a DIE for the given DbgVariable without initializing the
458 /// DbgVariable's DIE reference.
459 std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
460 bool isScopeAbstract);
462 /// constructTypeDIE - Construct basic type die from DIBasicType.
463 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
465 /// constructTypeDIE - Construct derived type die from DIDerivedType.
466 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
468 /// constructTypeDIE - Construct type DIE from DICompositeType.
469 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
471 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
472 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
474 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
475 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
477 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
478 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
480 /// constructMemberDIE - Construct member DIE from DIDerivedType.
481 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
483 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
484 /// DITemplateTypeParameter.
485 void constructTemplateTypeParameterDIE(DIE &Buffer,
486 DITemplateTypeParameter TP);
488 /// constructTemplateValueParameterDIE - Construct new DIE for the given
489 /// DITemplateValueParameter.
490 void constructTemplateValueParameterDIE(DIE &Buffer,
491 DITemplateValueParameter TVP);
493 /// getLowerBoundDefault - Return the default lower bound for an array. If the
494 /// DWARF version doesn't handle the language, return -1.
495 int64_t getDefaultLowerBound() const;
497 /// getDIEEntry - Returns the debug information entry for the specified
499 DIEEntry *getDIEEntry(const MDNode *N) const {
500 return MDNodeToDIEEntryMap.lookup(N);
503 /// insertDIEEntry - Insert debug information entry into the map.
504 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
505 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
508 // getIndexTyDie - Get an anonymous type for index type.
509 DIE *getIndexTyDie() { return IndexTyDie; }
511 // setIndexTyDie - Set D as anonymous type for index which can be reused
513 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
515 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
516 /// information entry.
517 DIEEntry *createDIEEntry(DIE &Entry);
519 /// resolve - Look in the DwarfDebug map for the MDNode that
520 /// corresponds to the reference.
521 template <typename T> T resolve(DIRef<T> Ref) const {
522 return DD->resolve(Ref);
525 /// If this is a named finished type then include it in the list of types for
526 /// the accelerator tables.
527 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
530 class DwarfCompileUnit : public DwarfUnit {
531 /// The attribute index of DW_AT_stmt_list in the compile unit DIE, avoiding
532 /// the need to search for it in applyStmtList.
533 unsigned stmtListIndex;
536 DwarfCompileUnit(unsigned UID, DIE *D, DICompileUnit Node, AsmPrinter *A,
537 DwarfDebug *DW, DwarfFile *DWU);
539 void initStmtList(MCSymbol *DwarfLineSectionSym);
541 /// Apply the DW_AT_stmt_list from this compile unit to the specified DIE.
542 void applyStmtList(DIE &D);
544 /// createGlobalVariableDIE - create global variable DIE.
545 void createGlobalVariableDIE(DIGlobalVariable GV);
547 /// addLabelAddress - Add a dwarf label attribute data and value using
548 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
549 void addLabelAddress(DIE &Die, dwarf::Attribute Attribute,
550 const MCSymbol *Label);
552 /// addLocalLabelAddress - Add a dwarf label attribute data and value using
553 /// DW_FORM_addr only.
554 void addLocalLabelAddress(DIE &Die, dwarf::Attribute Attribute,
555 const MCSymbol *Label);
557 DwarfCompileUnit &getCU() override { return *this; }
559 unsigned getOrCreateSourceID(StringRef FileName, StringRef DirName) override;
562 class DwarfTypeUnit : public DwarfUnit {
564 uint64_t TypeSignature;
566 DwarfCompileUnit &CU;
567 MCDwarfDwoLineTable *SplitLineTable;
570 DwarfTypeUnit(unsigned UID, DIE *D, DwarfCompileUnit &CU, AsmPrinter *A,
571 DwarfDebug *DW, DwarfFile *DWU,
572 MCDwarfDwoLineTable *SplitLineTable = nullptr);
574 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
575 uint64_t getTypeSignature() const { return TypeSignature; }
576 void setType(const DIE *Ty) { this->Ty = Ty; }
578 /// Emit the header for this unit, not including the initial length field.
579 void emitHeader(const MCSymbol *ASectionSym) const override;
580 unsigned getHeaderSize() const override {
581 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
582 sizeof(uint32_t); // Type DIE Offset
584 void initSection(const MCSection *Section);
585 DwarfCompileUnit &getCU() override { return CU; }
588 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
590 } // end llvm namespace