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 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 /// The label for the start of the range sets for the elements of this unit.
144 MCSymbol *LabelRange;
146 DwarfUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
147 DwarfDebug *DW, DwarfFile *DWU);
150 virtual ~DwarfUnit();
152 /// Pass in the SectionSym even though we could recreate it in every compile
153 /// unit (type units will have actually distinct symbols once they're in
154 /// comdat sections).
155 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
156 assert(!this->Section);
157 this->Section = Section;
158 this->SectionSym = SectionSym;
160 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
162 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
163 this->LabelRange = Asm->GetTempSymbol("gnu_ranges", getUniqueID());
166 const MCSection *getSection() const {
171 MCSymbol *getSectionSym() const {
176 MCSymbol *getLabelBegin() const {
181 MCSymbol *getLabelEnd() const {
186 MCSymbol *getLabelRange() const {
192 unsigned getUniqueID() const { return UniqueID; }
193 virtual uint16_t getLanguage() const = 0;
194 DICompileUnit getNode() const { return Node; }
195 DIE *getUnitDie() const { return UnitDie.get(); }
196 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
197 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
199 const StringMap<std::vector<const DIE *> > &getAccelNames() const {
202 const StringMap<std::vector<const DIE *> > &getAccelObjC() const {
205 const StringMap<std::vector<const DIE *> > &getAccelNamespace() const {
206 return AccelNamespace;
208 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &
209 getAccelTypes() const {
213 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
214 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
216 /// hasContent - Return true if this compile unit has something to write out.
217 bool hasContent() const { return !UnitDie->getChildren().empty(); }
219 /// addRangeList - Add an address range list to the list of range lists.
220 void addRangeList(RangeSpanList Ranges) { CURangeLists.push_back(Ranges); }
222 /// getRangeLists - Get the vector of range lists.
223 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
226 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
228 /// getParentContextString - Get a string containing the language specific
229 /// context for a global name.
230 std::string getParentContextString(DIScope Context) const;
232 /// addGlobalName - Add a new global entity to the compile unit.
234 void addGlobalName(StringRef Name, DIE *Die, DIScope Context);
236 /// addAccelName - Add a new name to the name accelerator table.
237 void addAccelName(StringRef Name, const DIE *Die);
239 /// addAccelObjC - Add a new name to the ObjC accelerator table.
240 void addAccelObjC(StringRef Name, const DIE *Die);
242 /// addAccelNamespace - Add a new name to the namespace accelerator table.
243 void addAccelNamespace(StringRef Name, const DIE *Die);
245 /// addAccelType - Add a new type to the type accelerator table.
246 void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> 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 /// getDIEBlock - Returns a fresh newly allocated DIEBlock.
256 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
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 /// addDie - Adds or interns the DIE to the compile unit.
266 void addDie(DIE *Buffer) { UnitDie->addChild(Buffer); }
268 /// addFlag - Add a flag that is true to the DIE.
269 void addFlag(DIE *Die, dwarf::Attribute Attribute);
271 /// addUInt - Add an unsigned integer attribute data and value.
272 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
275 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
277 /// addSInt - Add an signed integer attribute data and value.
278 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
281 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
283 /// addString - Add a string attribute data and value.
284 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
286 /// addLocalString - Add a string attribute data and value.
287 void addLocalString(DIE *Die, dwarf::Attribute Attribute,
288 const StringRef Str);
290 /// addExpr - Add a Dwarf expression attribute data and value.
291 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
293 /// addLabel - Add a Dwarf label attribute data and value.
294 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
295 const MCSymbol *Label);
297 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
299 /// addSectionLabel - Add a Dwarf section label attribute data and value.
301 void addSectionLabel(DIE *Die, dwarf::Attribute Attribute,
302 const MCSymbol *Label);
304 /// addSectionOffset - Add an offset into a section attribute data and value.
306 void addSectionOffset(DIE *Die, dwarf::Attribute Attribute, uint64_t Integer);
308 /// addOpAddress - Add a dwarf op address data and value using the
309 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
310 void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
312 /// addSectionDelta - Add a label delta attribute data and value.
313 void addSectionDelta(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
316 /// addDIEEntry - Add a DIE attribute data and value.
317 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
319 /// addDIEEntry - Add a DIE attribute data and value.
320 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
322 /// addBlock - Add block data.
323 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block);
325 /// addSourceLine - Add location information to specified debug information
327 void addSourceLine(DIE *Die, DIVariable V);
328 void addSourceLine(DIE *Die, DIGlobalVariable G);
329 void addSourceLine(DIE *Die, DISubprogram SP);
330 void addSourceLine(DIE *Die, DIType Ty);
331 void addSourceLine(DIE *Die, DINameSpace NS);
332 void addSourceLine(DIE *Die, DIObjCProperty Ty);
334 /// addAddress - Add an address attribute to a die based on the location
336 void addAddress(DIE *Die, dwarf::Attribute Attribute,
337 const MachineLocation &Location, bool Indirect = false);
339 /// addConstantValue - Add constant value entry in variable DIE.
340 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
341 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
342 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
344 /// addConstantFPValue - Add constant value entry in variable DIE.
345 void addConstantFPValue(DIE *Die, const MachineOperand &MO);
346 void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
348 /// addTemplateParams - Add template parameters in buffer.
349 void addTemplateParams(DIE &Buffer, DIArray TParams);
351 /// addRegisterOp - Add register operand.
352 void addRegisterOp(DIEBlock *TheDie, unsigned Reg);
354 /// addRegisterOffset - Add register offset.
355 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
357 /// addComplexAddress - Start with the address based on the location provided,
358 /// and generate the DWARF information necessary to find the actual variable
359 /// (navigating the extra location information encoded in the type) based on
360 /// the starting location. Add the DWARF information to the die.
361 void addComplexAddress(const DbgVariable &DV, DIE *Die,
362 dwarf::Attribute Attribute,
363 const MachineLocation &Location);
365 // FIXME: Should be reformulated in terms of addComplexAddress.
366 /// addBlockByrefAddress - Start with the address based on the location
367 /// provided, and generate the DWARF information necessary to find the
368 /// actual Block variable (navigating the Block struct) based on the
369 /// starting location. Add the DWARF information to the die. Obsolete,
370 /// please use addComplexAddress instead.
371 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
372 dwarf::Attribute Attribute,
373 const MachineLocation &Location);
375 /// addVariableAddress - Add DW_AT_location attribute for a
376 /// DbgVariable based on provided MachineLocation.
377 void addVariableAddress(const DbgVariable &DV, DIE *Die,
378 MachineLocation Location);
380 /// addType - Add a new type attribute to the specified entity. This takes
381 /// and attribute parameter because DW_AT_friend attributes are also
383 void addType(DIE *Entity, DIType Ty,
384 dwarf::Attribute Attribute = dwarf::DW_AT_type);
386 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
387 DIE *getOrCreateNameSpace(DINameSpace NS);
389 /// getOrCreateSubprogramDIE - Create new DIE using SP.
390 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
392 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
394 DIE *getOrCreateTypeDIE(const MDNode *N);
396 /// getOrCreateContextDIE - Get context owner's DIE.
397 DIE *createTypeDIE(DICompositeType Ty);
399 /// getOrCreateContextDIE - Get context owner's DIE.
400 DIE *getOrCreateContextDIE(DIScope Context);
402 /// constructContainingTypeDIEs - Construct DIEs for types that contain
404 void constructContainingTypeDIEs();
406 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
407 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
409 /// Create a DIE with the given Tag, add the DIE to its parent, and
410 /// call insertDIE if MD is not null.
411 DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
412 DIDescriptor N = DIDescriptor());
414 /// Compute the size of a header for this unit, not including the initial
416 unsigned getHeaderSize() const {
417 return sizeof(int16_t) + // DWARF version number
418 sizeof(int32_t) + // Offset Into Abbrev. Section
419 sizeof(int8_t); // Pointer Size (in bytes)
422 /// Emit the header for this unit, not including the initial length field.
423 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym) const;
426 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
427 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
430 /// constructTypeDIE - Construct basic type die from DIBasicType.
431 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
433 /// constructTypeDIE - Construct derived type die from DIDerivedType.
434 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
436 /// constructTypeDIE - Construct type DIE from DICompositeType.
437 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
439 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
440 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
442 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
443 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
445 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
446 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
448 /// constructMemberDIE - Construct member DIE from DIDerivedType.
449 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
451 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
452 /// DITemplateTypeParameter.
453 void constructTemplateTypeParameterDIE(DIE &Buffer,
454 DITemplateTypeParameter TP);
456 /// constructTemplateValueParameterDIE - Construct new DIE for the given
457 /// DITemplateValueParameter.
458 void constructTemplateValueParameterDIE(DIE &Buffer,
459 DITemplateValueParameter TVP);
461 /// getLowerBoundDefault - Return the default lower bound for an array. If the
462 /// DWARF version doesn't handle the language, return -1.
463 int64_t getDefaultLowerBound() const;
465 /// getDIEEntry - Returns the debug information entry for the specified
467 DIEEntry *getDIEEntry(const MDNode *N) const {
468 return MDNodeToDIEEntryMap.lookup(N);
471 /// insertDIEEntry - Insert debug information entry into the map.
472 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
473 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
476 // getIndexTyDie - Get an anonymous type for index type.
477 DIE *getIndexTyDie() { return IndexTyDie; }
479 // setIndexTyDie - Set D as anonymous type for index which can be reused
481 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
483 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
484 /// information entry.
485 DIEEntry *createDIEEntry(DIE *Entry);
487 /// resolve - Look in the DwarfDebug map for the MDNode that
488 /// corresponds to the reference.
489 template <typename T> T resolve(DIRef<T> Ref) const {
490 return DD->resolve(Ref);
493 /// If this is a named finished type then include it in the list of types for
494 /// the accelerator tables.
495 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE *TyDIE);
498 class DwarfCompileUnit : public DwarfUnit {
500 DwarfCompileUnit(unsigned UID, DIE *D, DICompileUnit Node, AsmPrinter *A,
501 DwarfDebug *DW, DwarfFile *DWU);
503 /// createGlobalVariableDIE - create global variable DIE.
504 void createGlobalVariableDIE(DIGlobalVariable GV);
506 /// addLabelAddress - Add a dwarf label attribute data and value using
507 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
508 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
510 uint16_t getLanguage() const LLVM_OVERRIDE { return getNode().getLanguage(); }
513 class DwarfTypeUnit : public DwarfUnit {
518 DwarfTypeUnit(unsigned UID, DIE *D, uint16_t Language, AsmPrinter *A,
519 DwarfDebug *DW, DwarfFile *DWU);
521 uint16_t getLanguage() const LLVM_OVERRIDE { return Language; }
523 } // end llvm namespace