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/OwningPtr.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/DebugInfo.h"
24 #include "llvm/MC/MCExpr.h"
25 #include "llvm/MC/MCSection.h"
29 class MachineLocation;
35 // Data structure to hold a range for range lists.
38 RangeSpan(MCSymbol *S, MCSymbol *E) : Start(S), End(E) {}
39 const MCSymbol *getStart() const { return Start; }
40 const MCSymbol *getEnd() const { return End; }
43 const MCSymbol *Start, *End;
48 // Index for locating within the debug_range section this particular span.
51 SmallVector<RangeSpan, 2> Ranges;
54 RangeSpanList(MCSymbol *Sym) : RangeSym(Sym) {}
55 MCSymbol *getSym() const { return RangeSym; }
56 const SmallVectorImpl<RangeSpan> &getRanges() const { return Ranges; }
57 void addRange(RangeSpan Range) { Ranges.push_back(Range); }
60 //===----------------------------------------------------------------------===//
61 /// Unit - This dwarf writer support class manages information associated
62 /// with a source file.
65 /// UniqueID - a numeric ID unique among all CUs in the module
68 /// Node - MDNode for the compile unit.
71 /// Unit debug information entry.
72 const OwningPtr<DIE> UnitDie;
74 /// Offset of the UnitDie from beginning of debug info section.
75 unsigned DebugInfoOffset;
77 /// Asm - Target of Dwarf emission.
80 // Holders for some common dwarf information.
84 /// IndexTyDie - An anonymous type for index type. Owned by UnitDie.
87 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
88 /// variables to debug information entries.
89 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
91 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
92 /// descriptors to debug information entries using a DIEEntry proxy.
93 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
95 /// GlobalNames - A map of globally visible named entities for this unit.
96 StringMap<const DIE *> GlobalNames;
98 /// GlobalTypes - A map of globally visible types for this unit.
99 StringMap<const DIE *> GlobalTypes;
101 /// AccelNames - A map of names for the name accelerator table.
102 StringMap<std::vector<const DIE *> > AccelNames;
104 /// AccelObjC - A map of objc spec for the objc accelerator table.
105 StringMap<std::vector<const DIE *> > AccelObjC;
107 /// AccelNamespace - A map of names for the namespace accelerator table.
108 StringMap<std::vector<const DIE *> > AccelNamespace;
110 /// AccelTypes - A map of names for the type accelerator table.
111 StringMap<std::vector<std::pair<const DIE *, unsigned> > > AccelTypes;
113 /// DIEBlocks - A list of all the DIEBlocks in use.
114 std::vector<DIEBlock *> DIEBlocks;
116 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
117 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
118 /// corresponds to the MDNode mapped with the subprogram DIE.
119 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
121 // List of ranges for a given compile unit.
122 SmallVector<RangeSpan, 1> CURanges;
124 // List of range lists for a given compile unit, separate from the ranges for
126 SmallVector<RangeSpanList, 1> CURangeLists;
128 // DIEValueAllocator - All DIEValues are allocated through this allocator.
129 BumpPtrAllocator DIEValueAllocator;
131 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
132 DIEInteger *DIEIntegerOne;
134 /// The section this unit will be emitted in.
135 const MCSection *Section;
137 /// A label at the start of the non-dwo section related to this unit.
138 MCSymbol *SectionSym;
140 /// The start of the unit within its section.
141 MCSymbol *LabelBegin;
143 /// The end of the unit within its section.
146 /// The label for the start of the range sets for the elements of this unit.
147 MCSymbol *LabelRange;
149 /// Skeleton unit associated with this unit.
152 DwarfUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
153 DwarfDebug *DW, DwarfFile *DWU);
156 virtual ~DwarfUnit();
158 /// Set the skeleton unit associated with this unit.
159 void setSkeleton(DwarfUnit *Skel) { Skeleton = Skel; }
161 /// Get the skeleton unit associated with this unit.
162 DwarfUnit *getSkeleton() const { return Skeleton; }
164 /// Pass in the SectionSym even though we could recreate it in every compile
165 /// unit (type units will have actually distinct symbols once they're in
166 /// comdat sections).
167 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
168 assert(!this->Section);
169 this->Section = Section;
170 this->SectionSym = SectionSym;
172 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
174 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
175 this->LabelRange = Asm->GetTempSymbol("gnu_ranges", getUniqueID());
178 const MCSection *getSection() const {
183 /// If there's a skeleton then return the section symbol for the skeleton
184 /// unit, otherwise return the section symbol for this unit.
185 MCSymbol *getLocalSectionSym() const {
187 return Skeleton->getSectionSym();
188 return getSectionSym();
191 MCSymbol *getSectionSym() const {
196 /// If there's a skeleton then return the begin label for the skeleton unit,
197 /// otherwise return the local label for this unit.
198 MCSymbol *getLocalLabelBegin() const {
200 return Skeleton->getLabelBegin();
201 return getLabelBegin();
204 MCSymbol *getLabelBegin() const {
209 MCSymbol *getLabelEnd() const {
214 MCSymbol *getLabelRange() const {
220 unsigned getUniqueID() const { return UniqueID; }
221 uint16_t getLanguage() const { return CUNode.getLanguage(); }
222 DICompileUnit getCUNode() const { return CUNode; }
223 DIE *getUnitDie() const { return UnitDie.get(); }
224 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
225 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
227 const StringMap<std::vector<const DIE *> > &getAccelNames() const {
230 const StringMap<std::vector<const DIE *> > &getAccelObjC() const {
233 const StringMap<std::vector<const DIE *> > &getAccelNamespace() const {
234 return AccelNamespace;
236 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &
237 getAccelTypes() const {
241 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
242 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
244 /// hasContent - Return true if this compile unit has something to write out.
245 bool hasContent() const { return !UnitDie->getChildren().empty(); }
247 /// addRange - Add an address range to the list of ranges for this unit.
248 void addRange(RangeSpan Range) { CURanges.push_back(Range); }
250 /// getRanges - Get the list of ranges for this unit.
251 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
252 SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
254 /// addRangeList - Add an address range list to the list of range lists.
255 void addRangeList(RangeSpanList Ranges) { CURangeLists.push_back(Ranges); }
257 /// getRangeLists - Get the vector of range lists.
258 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
261 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
263 /// getParentContextString - Get a string containing the language specific
264 /// context for a global name.
265 std::string getParentContextString(DIScope Context) const;
267 /// addGlobalName - Add a new global entity to the compile unit.
269 void addGlobalName(StringRef Name, DIE *Die, DIScope Context);
271 /// addAccelName - Add a new name to the name accelerator table.
272 void addAccelName(StringRef Name, const DIE *Die);
274 /// addAccelObjC - Add a new name to the ObjC accelerator table.
275 void addAccelObjC(StringRef Name, const DIE *Die);
277 /// addAccelNamespace - Add a new name to the namespace accelerator table.
278 void addAccelNamespace(StringRef Name, const DIE *Die);
280 /// addAccelType - Add a new type to the type accelerator table.
281 void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> Die);
283 /// getDIE - Returns the debug information entry map slot for the
284 /// specified debug variable. We delegate the request to DwarfDebug
285 /// when the MDNode can be part of the type system, since DIEs for
286 /// the type system can be shared across CUs and the mappings are
287 /// kept in DwarfDebug.
288 DIE *getDIE(DIDescriptor D) const;
290 /// getDIEBlock - Returns a fresh newly allocated DIEBlock.
291 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
293 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
294 /// when the MDNode can be part of the type system, since DIEs for
295 /// the type system can be shared across CUs and the mappings are
296 /// kept in DwarfDebug.
297 void insertDIE(DIDescriptor Desc, DIE *D);
299 /// addDie - Adds or interns the DIE to the compile unit.
301 void addDie(DIE *Buffer) { UnitDie->addChild(Buffer); }
303 /// addFlag - Add a flag that is true to the DIE.
304 void addFlag(DIE *Die, dwarf::Attribute Attribute);
306 /// addUInt - Add an unsigned integer attribute data and value.
307 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
310 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
312 /// addSInt - Add an signed integer attribute data and value.
313 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
316 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
318 /// addString - Add a string attribute data and value.
319 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
321 /// addLocalString - Add a string attribute data and value.
322 void addLocalString(DIE *Die, dwarf::Attribute Attribute,
323 const StringRef Str);
325 /// addExpr - Add a Dwarf expression attribute data and value.
326 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
328 /// addLabel - Add a Dwarf label attribute data and value.
329 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
330 const MCSymbol *Label);
332 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
334 /// addSectionLabel - Add a Dwarf section label attribute data and value.
336 void addSectionLabel(DIE *Die, dwarf::Attribute Attribute,
337 const MCSymbol *Label);
339 /// addSectionOffset - Add an offset into a section attribute data and value.
341 void addSectionOffset(DIE *Die, dwarf::Attribute Attribute, uint64_t Integer);
343 /// addOpAddress - Add a dwarf op address data and value using the
344 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
345 void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
347 /// addSectionDelta - Add a label delta attribute data and value.
348 void addSectionDelta(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
351 /// addDIEEntry - Add a DIE attribute data and value.
352 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
354 /// addDIEEntry - Add a DIE attribute data and value.
355 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
357 void addDIETypeSignature(DIE *Die, const DwarfTypeUnit &Type);
359 /// addBlock - Add block data.
360 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block);
362 /// addSourceLine - Add location information to specified debug information
364 void addSourceLine(DIE *Die, DIVariable V);
365 void addSourceLine(DIE *Die, DIGlobalVariable G);
366 void addSourceLine(DIE *Die, DISubprogram SP);
367 void addSourceLine(DIE *Die, DIType Ty);
368 void addSourceLine(DIE *Die, DINameSpace NS);
369 void addSourceLine(DIE *Die, DIObjCProperty Ty);
371 /// addAddress - Add an address attribute to a die based on the location
373 void addAddress(DIE *Die, dwarf::Attribute Attribute,
374 const MachineLocation &Location, bool Indirect = false);
376 /// addConstantValue - Add constant value entry in variable DIE.
377 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
378 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
379 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
381 /// addConstantFPValue - Add constant value entry in variable DIE.
382 void addConstantFPValue(DIE *Die, const MachineOperand &MO);
383 void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
385 /// addTemplateParams - Add template parameters in buffer.
386 void addTemplateParams(DIE &Buffer, DIArray TParams);
388 /// addRegisterOp - Add register operand.
389 void addRegisterOp(DIEBlock *TheDie, unsigned Reg);
391 /// addRegisterOffset - Add register offset.
392 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
394 /// addComplexAddress - Start with the address based on the location provided,
395 /// and generate the DWARF information necessary to find the actual variable
396 /// (navigating the extra location information encoded in the type) based on
397 /// the starting location. Add the DWARF information to the die.
398 void addComplexAddress(const DbgVariable &DV, DIE *Die,
399 dwarf::Attribute Attribute,
400 const MachineLocation &Location);
402 // FIXME: Should be reformulated in terms of addComplexAddress.
403 /// addBlockByrefAddress - Start with the address based on the location
404 /// provided, and generate the DWARF information necessary to find the
405 /// actual Block variable (navigating the Block struct) based on the
406 /// starting location. Add the DWARF information to the die. Obsolete,
407 /// please use addComplexAddress instead.
408 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
409 dwarf::Attribute Attribute,
410 const MachineLocation &Location);
412 /// addVariableAddress - Add DW_AT_location attribute for a
413 /// DbgVariable based on provided MachineLocation.
414 void addVariableAddress(const DbgVariable &DV, DIE *Die,
415 MachineLocation Location);
417 /// addType - Add a new type attribute to the specified entity. This takes
418 /// and attribute parameter because DW_AT_friend attributes are also
420 void addType(DIE *Entity, DIType Ty,
421 dwarf::Attribute Attribute = dwarf::DW_AT_type);
423 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
424 DIE *getOrCreateNameSpace(DINameSpace NS);
426 /// getOrCreateSubprogramDIE - Create new DIE using SP.
427 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
429 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
431 DIE *getOrCreateTypeDIE(const MDNode *N);
433 /// getOrCreateContextDIE - Get context owner's DIE.
434 DIE *createTypeDIE(DICompositeType Ty);
436 /// getOrCreateContextDIE - Get context owner's DIE.
437 DIE *getOrCreateContextDIE(DIScope Context);
439 /// constructContainingTypeDIEs - Construct DIEs for types that contain
441 void constructContainingTypeDIEs();
443 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
444 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
446 /// Create a DIE with the given Tag, add the DIE to its parent, and
447 /// call insertDIE if MD is not null.
448 DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
449 DIDescriptor N = DIDescriptor());
451 /// Compute the size of a header for this unit, not including the initial
453 virtual unsigned getHeaderSize() const {
454 return sizeof(int16_t) + // DWARF version number
455 sizeof(int32_t) + // Offset Into Abbrev. Section
456 sizeof(int8_t); // Pointer Size (in bytes)
459 /// Emit the header for this unit, not including the initial length field.
460 virtual void emitHeader(const MCSection *ASection,
461 const MCSymbol *ASectionSym) const;
464 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
465 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
468 /// constructTypeDIE - Construct basic type die from DIBasicType.
469 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
471 /// constructTypeDIE - Construct derived type die from DIDerivedType.
472 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
474 /// constructTypeDIE - Construct type DIE from DICompositeType.
475 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
477 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
478 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
480 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
481 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
483 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
484 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
486 /// constructMemberDIE - Construct member DIE from DIDerivedType.
487 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
489 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
490 /// DITemplateTypeParameter.
491 void constructTemplateTypeParameterDIE(DIE &Buffer,
492 DITemplateTypeParameter TP);
494 /// constructTemplateValueParameterDIE - Construct new DIE for the given
495 /// DITemplateValueParameter.
496 void constructTemplateValueParameterDIE(DIE &Buffer,
497 DITemplateValueParameter TVP);
499 /// getLowerBoundDefault - Return the default lower bound for an array. If the
500 /// DWARF version doesn't handle the language, return -1.
501 int64_t getDefaultLowerBound() const;
503 /// getDIEEntry - Returns the debug information entry for the specified
505 DIEEntry *getDIEEntry(const MDNode *N) const {
506 return MDNodeToDIEEntryMap.lookup(N);
509 /// insertDIEEntry - Insert debug information entry into the map.
510 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
511 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
514 // getIndexTyDie - Get an anonymous type for index type.
515 DIE *getIndexTyDie() { return IndexTyDie; }
517 // setIndexTyDie - Set D as anonymous type for index which can be reused
519 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
521 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
522 /// information entry.
523 DIEEntry *createDIEEntry(DIE *Entry);
525 /// resolve - Look in the DwarfDebug map for the MDNode that
526 /// corresponds to the reference.
527 template <typename T> T resolve(DIRef<T> Ref) const {
528 return DD->resolve(Ref);
531 /// If this is a named finished type then include it in the list of types for
532 /// the accelerator tables.
533 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE *TyDIE);
536 class DwarfCompileUnit : public DwarfUnit {
538 DwarfCompileUnit(unsigned UID, DIE *D, DICompileUnit Node, AsmPrinter *A,
539 DwarfDebug *DW, DwarfFile *DWU);
540 virtual ~DwarfCompileUnit() LLVM_OVERRIDE;
542 /// createGlobalVariableDIE - create global variable DIE.
543 void createGlobalVariableDIE(DIGlobalVariable GV);
545 /// addLabelAddress - Add a dwarf label attribute data and value using
546 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
547 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
550 class DwarfTypeUnit : public DwarfUnit {
552 uint64_t TypeSignature;
556 DwarfTypeUnit(unsigned UID, DIE *D, DICompileUnit CUNode, AsmPrinter *A,
557 DwarfDebug *DW, DwarfFile *DWU);
558 virtual ~DwarfTypeUnit() LLVM_OVERRIDE;
560 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
561 uint64_t getTypeSignature() const { return TypeSignature; }
562 void setType(const DIE *Ty) { this->Ty = Ty; }
564 /// Emit the header for this unit, not including the initial length field.
565 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym) const
567 unsigned getHeaderSize() const LLVM_OVERRIDE {
568 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
569 sizeof(uint32_t); // Type DIE Offset
571 void initSection(const MCSection *Section);
573 } // end llvm namespace