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 void addDIETypeSignature(DIE *Die, const DwarfTypeUnit &Type);
324 /// addBlock - Add block data.
325 void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block);
327 /// addSourceLine - Add location information to specified debug information
329 void addSourceLine(DIE *Die, DIVariable V);
330 void addSourceLine(DIE *Die, DIGlobalVariable G);
331 void addSourceLine(DIE *Die, DISubprogram SP);
332 void addSourceLine(DIE *Die, DIType Ty);
333 void addSourceLine(DIE *Die, DINameSpace NS);
334 void addSourceLine(DIE *Die, DIObjCProperty Ty);
336 /// addAddress - Add an address attribute to a die based on the location
338 void addAddress(DIE *Die, dwarf::Attribute Attribute,
339 const MachineLocation &Location, bool Indirect = false);
341 /// addConstantValue - Add constant value entry in variable DIE.
342 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
343 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
344 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
346 /// addConstantFPValue - Add constant value entry in variable DIE.
347 void addConstantFPValue(DIE *Die, const MachineOperand &MO);
348 void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
350 /// addTemplateParams - Add template parameters in buffer.
351 void addTemplateParams(DIE &Buffer, DIArray TParams);
353 /// addRegisterOp - Add register operand.
354 void addRegisterOp(DIEBlock *TheDie, unsigned Reg);
356 /// addRegisterOffset - Add register offset.
357 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
359 /// addComplexAddress - Start with the address based on the location provided,
360 /// and generate the DWARF information necessary to find the actual variable
361 /// (navigating the extra location information encoded in the type) based on
362 /// the starting location. Add the DWARF information to the die.
363 void addComplexAddress(const DbgVariable &DV, DIE *Die,
364 dwarf::Attribute Attribute,
365 const MachineLocation &Location);
367 // FIXME: Should be reformulated in terms of addComplexAddress.
368 /// addBlockByrefAddress - Start with the address based on the location
369 /// provided, and generate the DWARF information necessary to find the
370 /// actual Block variable (navigating the Block struct) based on the
371 /// starting location. Add the DWARF information to the die. Obsolete,
372 /// please use addComplexAddress instead.
373 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
374 dwarf::Attribute Attribute,
375 const MachineLocation &Location);
377 /// addVariableAddress - Add DW_AT_location attribute for a
378 /// DbgVariable based on provided MachineLocation.
379 void addVariableAddress(const DbgVariable &DV, DIE *Die,
380 MachineLocation Location);
382 /// addType - Add a new type attribute to the specified entity. This takes
383 /// and attribute parameter because DW_AT_friend attributes are also
385 void addType(DIE *Entity, DIType Ty,
386 dwarf::Attribute Attribute = dwarf::DW_AT_type);
388 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
389 DIE *getOrCreateNameSpace(DINameSpace NS);
391 /// getOrCreateSubprogramDIE - Create new DIE using SP.
392 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
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 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
409 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
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 MCSection *ASection,
426 const MCSymbol *ASectionSym) const;
429 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
430 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
433 /// constructTypeDIE - Construct basic type die from DIBasicType.
434 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
436 /// constructTypeDIE - Construct derived type die from DIDerivedType.
437 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
439 /// constructTypeDIE - Construct type DIE from DICompositeType.
440 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
442 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
443 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
445 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
446 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
448 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
449 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
451 /// constructMemberDIE - Construct member DIE from DIDerivedType.
452 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
454 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
455 /// DITemplateTypeParameter.
456 void constructTemplateTypeParameterDIE(DIE &Buffer,
457 DITemplateTypeParameter TP);
459 /// constructTemplateValueParameterDIE - Construct new DIE for the given
460 /// DITemplateValueParameter.
461 void constructTemplateValueParameterDIE(DIE &Buffer,
462 DITemplateValueParameter TVP);
464 /// getLowerBoundDefault - Return the default lower bound for an array. If the
465 /// DWARF version doesn't handle the language, return -1.
466 int64_t getDefaultLowerBound() const;
468 /// getDIEEntry - Returns the debug information entry for the specified
470 DIEEntry *getDIEEntry(const MDNode *N) const {
471 return MDNodeToDIEEntryMap.lookup(N);
474 /// insertDIEEntry - Insert debug information entry into the map.
475 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
476 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
479 // getIndexTyDie - Get an anonymous type for index type.
480 DIE *getIndexTyDie() { return IndexTyDie; }
482 // setIndexTyDie - Set D as anonymous type for index which can be reused
484 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
486 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
487 /// information entry.
488 DIEEntry *createDIEEntry(DIE *Entry);
490 /// resolve - Look in the DwarfDebug map for the MDNode that
491 /// corresponds to the reference.
492 template <typename T> T resolve(DIRef<T> Ref) const {
493 return DD->resolve(Ref);
496 /// If this is a named finished type then include it in the list of types for
497 /// the accelerator tables.
498 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE *TyDIE);
501 class DwarfCompileUnit : public DwarfUnit {
503 DwarfCompileUnit(unsigned UID, DIE *D, DICompileUnit Node, AsmPrinter *A,
504 DwarfDebug *DW, DwarfFile *DWU);
505 virtual ~DwarfCompileUnit() LLVM_OVERRIDE;
507 /// createGlobalVariableDIE - create global variable DIE.
508 void createGlobalVariableDIE(DIGlobalVariable GV);
510 /// addLabelAddress - Add a dwarf label attribute data and value using
511 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
512 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
514 uint16_t getLanguage() const LLVM_OVERRIDE { return getNode().getLanguage(); }
517 class DwarfTypeUnit : public DwarfUnit {
520 uint64_t TypeSignature;
524 DwarfTypeUnit(unsigned UID, DIE *D, uint16_t Language, AsmPrinter *A,
525 DwarfDebug *DW, DwarfFile *DWU);
526 virtual ~DwarfTypeUnit() LLVM_OVERRIDE;
528 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
529 uint64_t getTypeSignature() const { return TypeSignature; }
530 void setType(const DIE *Ty) { this->Ty = Ty; }
532 uint16_t getLanguage() const LLVM_OVERRIDE { return Language; }
533 /// Emit the header for this unit, not including the initial length field.
534 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym) const
536 unsigned getHeaderSize() const LLVM_OVERRIDE {
537 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
538 sizeof(uint32_t); // Type DIE Offset
540 void initSection(const MCSection *Section);
542 } // end llvm namespace