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 LLVM_LIB_CODEGEN_ASMPRINTER_DWARFUNIT_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFUNIT_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.
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 /// Skeleton unit associated with this unit.
144 DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
145 DwarfDebug *DW, DwarfFile *DWU);
148 virtual ~DwarfUnit();
150 /// Set the skeleton unit associated with this unit.
151 void setSkeleton(DwarfUnit &Skel) { Skeleton = &Skel; }
153 /// Pass in the SectionSym even though we could recreate it in every compile
154 /// unit (type units will have actually distinct symbols once they're in
155 /// comdat sections).
156 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
157 assert(!this->Section);
158 this->Section = Section;
159 this->SectionSym = SectionSym;
161 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
163 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
166 const MCSection *getSection() const {
171 /// If there's a skeleton then return the section symbol for the skeleton
172 /// unit, otherwise return the section symbol for this unit.
173 MCSymbol *getLocalSectionSym() const {
175 return Skeleton->getSectionSym();
176 return getSectionSym();
179 MCSymbol *getSectionSym() const {
184 /// If there's a skeleton then return the begin label for the skeleton unit,
185 /// otherwise return the local label for this unit.
186 MCSymbol *getLocalLabelBegin() const {
188 return Skeleton->getLabelBegin();
189 return getLabelBegin();
192 MCSymbol *getLabelBegin() const {
197 MCSymbol *getLabelEnd() const {
203 unsigned getUniqueID() const { return UniqueID; }
204 uint16_t getLanguage() const { return CUNode.getLanguage(); }
205 DICompileUnit getCUNode() const { return CUNode; }
206 DIE &getUnitDie() { return UnitDie; }
207 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
208 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
210 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
211 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
213 /// hasContent - Return true if this compile unit has something to write out.
214 bool hasContent() const { return !UnitDie.getChildren().empty(); }
216 /// getRanges - Get the list of ranges for this unit.
217 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
218 SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
220 /// addRangeList - Add an address range list to the list of range lists.
221 void addRangeList(RangeSpanList Ranges) {
222 CURangeLists.push_back(std::move(Ranges));
225 /// getRangeLists - Get the vector of range lists.
226 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
229 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
231 /// getParentContextString - Get a string containing the language specific
232 /// context for a global name.
233 std::string getParentContextString(DIScope Context) const;
235 /// addGlobalName - Add a new global entity to the compile unit.
237 void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
239 /// addAccelNamespace - Add a new name to the namespace accelerator table.
240 void addAccelNamespace(StringRef Name, const DIE &Die);
242 /// getDIE - Returns the debug information entry map slot for the
243 /// specified debug variable. We delegate the request to DwarfDebug
244 /// when the MDNode can be part of the type system, since DIEs for
245 /// the type system can be shared across CUs and the mappings are
246 /// kept in DwarfDebug.
247 DIE *getDIE(DIDescriptor D) const;
249 /// getDIELoc - Returns a fresh newly allocated DIELoc.
250 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
252 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
253 /// when the MDNode can be part of the type system, since DIEs for
254 /// the type system can be shared across CUs and the mappings are
255 /// kept in DwarfDebug.
256 void insertDIE(DIDescriptor Desc, DIE *D);
258 /// addFlag - Add a flag that is true to the DIE.
259 void addFlag(DIE &Die, dwarf::Attribute Attribute);
261 /// addUInt - Add an unsigned integer attribute data and value.
262 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
265 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
267 /// addSInt - Add an signed integer attribute data and value.
268 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
271 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
273 /// addString - Add a string attribute data and value.
274 void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
276 /// addLocalString - Add a string attribute data and value.
277 void addLocalString(DIE &Die, dwarf::Attribute Attribute,
280 /// addExpr - Add a Dwarf expression attribute data and value.
281 void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
283 /// addLabel - Add a Dwarf label attribute data and value.
284 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
285 const MCSymbol *Label);
287 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
289 /// addLocationList - Add a Dwarf loclistptr attribute data and value.
290 void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
292 /// addSectionOffset - Add an offset into a section attribute data and value.
294 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
296 /// addOpAddress - Add a dwarf op address data and value using the
297 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
298 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
300 /// addLabelDelta - Add a label delta attribute data and value.
301 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
304 /// addDIEEntry - Add a DIE attribute data and value.
305 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
307 /// addDIEEntry - Add a DIE attribute data and value.
308 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
310 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
312 /// addBlock - Add block data.
313 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
315 /// addBlock - Add block data.
316 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
318 /// addSourceLine - Add location information to specified debug information
320 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
321 StringRef Directory);
322 void addSourceLine(DIE &Die, DIVariable V);
323 void addSourceLine(DIE &Die, DIGlobalVariable G);
324 void addSourceLine(DIE &Die, DISubprogram SP);
325 void addSourceLine(DIE &Die, DIType Ty);
326 void addSourceLine(DIE &Die, DINameSpace NS);
327 void addSourceLine(DIE &Die, DIObjCProperty Ty);
329 /// addAddress - Add an address attribute to a die based on the location
331 void addAddress(DIE &Die, dwarf::Attribute Attribute,
332 const MachineLocation &Location, bool Indirect = false);
334 /// addConstantValue - Add constant value entry in variable DIE.
335 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
336 void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
337 void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
338 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
339 void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
341 /// addConstantFPValue - Add constant value entry in variable DIE.
342 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
343 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
345 /// addTemplateParams - Add template parameters in buffer.
346 void addTemplateParams(DIE &Buffer, DIArray TParams);
348 /// addRegisterOp - Add register operand.
349 void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
350 unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
352 /// addRegisterOffset - Add register offset.
353 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
355 /// addComplexAddress - Start with the address based on the location provided,
356 /// and generate the DWARF information necessary to find the actual variable
357 /// (navigating the extra location information encoded in the type) based on
358 /// the starting location. Add the DWARF information to the die.
359 void addComplexAddress(const DbgVariable &DV, DIE &Die,
360 dwarf::Attribute Attribute,
361 const MachineLocation &Location);
363 // FIXME: Should be reformulated in terms of addComplexAddress.
364 /// addBlockByrefAddress - Start with the address based on the location
365 /// provided, and generate the DWARF information necessary to find the
366 /// actual Block variable (navigating the Block struct) based on the
367 /// starting location. Add the DWARF information to the die. Obsolete,
368 /// please use addComplexAddress instead.
369 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
370 dwarf::Attribute Attribute,
371 const MachineLocation &Location);
373 /// addVariableAddress - Add DW_AT_location attribute for a
374 /// DbgVariable based on provided MachineLocation.
375 void addVariableAddress(const DbgVariable &DV, DIE &Die,
376 MachineLocation Location);
378 /// addType - Add a new type attribute to the specified entity. This takes
379 /// and attribute parameter because DW_AT_friend attributes are also
381 void addType(DIE &Entity, DIType Ty,
382 dwarf::Attribute Attribute = dwarf::DW_AT_type);
384 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
385 DIE *getOrCreateNameSpace(DINameSpace NS);
387 /// getOrCreateSubprogramDIE - Create new DIE using SP.
388 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
390 void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
391 void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
392 void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
394 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
396 DIE *getOrCreateTypeDIE(const MDNode *N);
398 /// getOrCreateContextDIE - Get context owner's DIE.
399 DIE *createTypeDIE(DICompositeType Ty);
401 /// getOrCreateContextDIE - Get context owner's DIE.
402 DIE *getOrCreateContextDIE(DIScope Context);
404 /// constructContainingTypeDIEs - Construct DIEs for types that contain
406 void constructContainingTypeDIEs();
408 /// constructSubprogramArguments - Construct function argument DIEs.
409 void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
411 /// Create a DIE with the given Tag, add the DIE to its parent, and
412 /// call insertDIE if MD is not null.
413 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
414 DIDescriptor N = DIDescriptor());
416 /// Compute the size of a header for this unit, not including the initial
418 virtual unsigned getHeaderSize() const {
419 return sizeof(int16_t) + // DWARF version number
420 sizeof(int32_t) + // Offset Into Abbrev. Section
421 sizeof(int8_t); // Pointer Size (in bytes)
424 /// Emit the header for this unit, not including the initial length field.
425 virtual void emitHeader(const MCSymbol *ASectionSym) const;
427 virtual DwarfCompileUnit &getCU() = 0;
429 /// constructTypeDIE - Construct type DIE from DICompositeType.
430 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
433 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
434 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
436 /// Look up the source ID with the given directory and source file names. If
437 /// none currently exists, create a new ID and insert it in the line table.
438 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
440 /// resolve - Look in the DwarfDebug map for the MDNode that
441 /// corresponds to the reference.
442 template <typename T> T resolve(DIRef<T> Ref) const {
443 return DD->resolve(Ref);
447 /// constructTypeDIE - Construct basic type die from DIBasicType.
448 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
450 /// constructTypeDIE - Construct derived type die from DIDerivedType.
451 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
453 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
454 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
456 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
457 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
459 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
460 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
462 /// constructMemberDIE - Construct member DIE from DIDerivedType.
463 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
465 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
466 /// DITemplateTypeParameter.
467 void constructTemplateTypeParameterDIE(DIE &Buffer,
468 DITemplateTypeParameter TP);
470 /// constructTemplateValueParameterDIE - Construct new DIE for the given
471 /// DITemplateValueParameter.
472 void constructTemplateValueParameterDIE(DIE &Buffer,
473 DITemplateValueParameter TVP);
475 /// getLowerBoundDefault - Return the default lower bound for an array. If the
476 /// DWARF version doesn't handle the language, return -1.
477 int64_t getDefaultLowerBound() const;
479 /// getDIEEntry - Returns the debug information entry for the specified
481 DIEEntry *getDIEEntry(const MDNode *N) const {
482 return MDNodeToDIEEntryMap.lookup(N);
485 /// insertDIEEntry - Insert debug information entry into the map.
486 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
487 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
490 // getIndexTyDie - Get an anonymous type for index type.
491 DIE *getIndexTyDie() { return IndexTyDie; }
493 // setIndexTyDie - Set D as anonymous type for index which can be reused
495 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
497 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
498 /// information entry.
499 DIEEntry *createDIEEntry(DIE &Entry);
501 /// If this is a named finished type then include it in the list of types for
502 /// the accelerator tables.
503 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
506 class DwarfTypeUnit : public DwarfUnit {
508 uint64_t TypeSignature;
510 DwarfCompileUnit &CU;
511 MCDwarfDwoLineTable *SplitLineTable;
514 DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
515 DwarfDebug *DW, DwarfFile *DWU,
516 MCDwarfDwoLineTable *SplitLineTable = nullptr);
518 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
519 uint64_t getTypeSignature() const { return TypeSignature; }
520 void setType(const DIE *Ty) { this->Ty = Ty; }
522 /// Emit the header for this unit, not including the initial length field.
523 void emitHeader(const MCSymbol *ASectionSym) const override;
524 unsigned getHeaderSize() const override {
525 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
526 sizeof(uint32_t); // Type DIE Offset
528 void initSection(const MCSection *Section);
529 // Bring in the base function (taking two args, including the section symbol)
530 // for use when building DWO type units (they don't go in unique comdat
532 using DwarfUnit::initSection;
533 DwarfCompileUnit &getCU() override { return CU; }
536 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
538 } // end llvm namespace