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 /// The start of the unit within its section.
133 MCSymbol *LabelBegin;
135 /// The end of the unit within its section.
138 DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
139 DwarfDebug *DW, DwarfFile *DWU);
141 void initSection(const MCSection *Section);
143 virtual ~DwarfUnit();
145 const MCSection *getSection() const {
150 MCSymbol *getLabelBegin() const {
155 MCSymbol *getLabelEnd() const {
161 unsigned getUniqueID() const { return UniqueID; }
162 uint16_t getLanguage() const { return CUNode.getLanguage(); }
163 DICompileUnit getCUNode() const { return CUNode; }
164 DIE &getUnitDie() { return UnitDie; }
165 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
166 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
168 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
169 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
171 /// hasContent - Return true if this compile unit has something to write out.
172 bool hasContent() const { return !UnitDie.getChildren().empty(); }
174 /// getRanges - Get the list of ranges for this unit.
175 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
176 SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
178 /// addRangeList - Add an address range list to the list of range lists.
179 void addRangeList(RangeSpanList Ranges) {
180 CURangeLists.push_back(std::move(Ranges));
183 /// getRangeLists - Get the vector of range lists.
184 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
187 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
189 /// getParentContextString - Get a string containing the language specific
190 /// context for a global name.
191 std::string getParentContextString(DIScope Context) const;
193 /// addGlobalName - Add a new global entity to the compile unit.
195 void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
197 /// addAccelNamespace - Add a new name to the namespace accelerator table.
198 void addAccelNamespace(StringRef Name, const DIE &Die);
200 /// getDIE - Returns the debug information entry map slot for the
201 /// specified debug variable. We delegate the request to DwarfDebug
202 /// when the MDNode can be part of the type system, since DIEs for
203 /// the type system can be shared across CUs and the mappings are
204 /// kept in DwarfDebug.
205 DIE *getDIE(DIDescriptor D) const;
207 /// getDIELoc - Returns a fresh newly allocated DIELoc.
208 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
210 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
211 /// when the MDNode can be part of the type system, since DIEs for
212 /// the type system can be shared across CUs and the mappings are
213 /// kept in DwarfDebug.
214 void insertDIE(DIDescriptor Desc, DIE *D);
216 /// addFlag - Add a flag that is true to the DIE.
217 void addFlag(DIE &Die, dwarf::Attribute Attribute);
219 /// addUInt - Add an unsigned integer attribute data and value.
220 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
223 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
225 /// addSInt - Add an signed integer attribute data and value.
226 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
229 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
231 /// addString - Add a string attribute data and value.
232 void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
234 /// addLocalString - Add a string attribute data and value.
235 void addLocalString(DIE &Die, dwarf::Attribute Attribute,
238 /// addExpr - Add a Dwarf expression attribute data and value.
239 void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
241 /// addLabel - Add a Dwarf label attribute data and value.
242 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
243 const MCSymbol *Label);
245 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
247 /// addLocationList - Add a Dwarf loclistptr attribute data and value.
248 void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
250 /// addSectionOffset - Add an offset into a section attribute data and value.
252 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
254 /// addOpAddress - Add a dwarf op address data and value using the
255 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
256 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
258 /// addLabelDelta - Add a label delta attribute data and value.
259 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
262 /// addDIEEntry - Add a DIE attribute data and value.
263 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
265 /// addDIEEntry - Add a DIE attribute data and value.
266 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
268 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
270 /// addBlock - Add block data.
271 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
273 /// addBlock - Add block data.
274 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
276 /// addSourceLine - Add location information to specified debug information
278 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
279 StringRef Directory);
280 void addSourceLine(DIE &Die, DIVariable V);
281 void addSourceLine(DIE &Die, DIGlobalVariable G);
282 void addSourceLine(DIE &Die, DISubprogram SP);
283 void addSourceLine(DIE &Die, DIType Ty);
284 void addSourceLine(DIE &Die, DINameSpace NS);
285 void addSourceLine(DIE &Die, DIObjCProperty Ty);
287 /// addAddress - Add an address attribute to a die based on the location
289 void addAddress(DIE &Die, dwarf::Attribute Attribute,
290 const MachineLocation &Location, bool Indirect = false);
292 /// addConstantValue - Add constant value entry in variable DIE.
293 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
294 void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
295 void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
296 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
297 void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
299 /// addConstantFPValue - Add constant value entry in variable DIE.
300 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
301 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
303 /// addTemplateParams - Add template parameters in buffer.
304 void addTemplateParams(DIE &Buffer, DIArray TParams);
306 /// addRegisterOp - Add register operand.
307 void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
308 unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
310 /// addRegisterOffset - Add register offset.
311 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
313 /// addComplexAddress - Start with the address based on the location provided,
314 /// and generate the DWARF information necessary to find the actual variable
315 /// (navigating the extra location information encoded in the type) based on
316 /// the starting location. Add the DWARF information to the die.
317 void addComplexAddress(const DbgVariable &DV, DIE &Die,
318 dwarf::Attribute Attribute,
319 const MachineLocation &Location);
321 // FIXME: Should be reformulated in terms of addComplexAddress.
322 /// addBlockByrefAddress - Start with the address based on the location
323 /// provided, and generate the DWARF information necessary to find the
324 /// actual Block variable (navigating the Block struct) based on the
325 /// starting location. Add the DWARF information to the die. Obsolete,
326 /// please use addComplexAddress instead.
327 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
328 dwarf::Attribute Attribute,
329 const MachineLocation &Location);
331 /// addVariableAddress - Add DW_AT_location attribute for a
332 /// DbgVariable based on provided MachineLocation.
333 void addVariableAddress(const DbgVariable &DV, DIE &Die,
334 MachineLocation Location);
336 /// addType - Add a new type attribute to the specified entity. This takes
337 /// and attribute parameter because DW_AT_friend attributes are also
339 void addType(DIE &Entity, DIType Ty,
340 dwarf::Attribute Attribute = dwarf::DW_AT_type);
342 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
343 DIE *getOrCreateNameSpace(DINameSpace NS);
345 /// getOrCreateSubprogramDIE - Create new DIE using SP.
346 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
348 void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
349 void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
350 void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
352 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
354 DIE *getOrCreateTypeDIE(const MDNode *N);
356 /// getOrCreateContextDIE - Get context owner's DIE.
357 DIE *createTypeDIE(DICompositeType Ty);
359 /// getOrCreateContextDIE - Get context owner's DIE.
360 DIE *getOrCreateContextDIE(DIScope Context);
362 /// constructContainingTypeDIEs - Construct DIEs for types that contain
364 void constructContainingTypeDIEs();
366 /// constructSubprogramArguments - Construct function argument DIEs.
367 void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
369 /// Create a DIE with the given Tag, add the DIE to its parent, and
370 /// call insertDIE if MD is not null.
371 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
372 DIDescriptor N = DIDescriptor());
374 /// Compute the size of a header for this unit, not including the initial
376 virtual unsigned getHeaderSize() const {
377 return sizeof(int16_t) + // DWARF version number
378 sizeof(int32_t) + // Offset Into Abbrev. Section
379 sizeof(int8_t); // Pointer Size (in bytes)
382 /// Emit the header for this unit, not including the initial length field.
383 virtual void emitHeader(const MCSymbol *ASectionSym) const;
385 virtual DwarfCompileUnit &getCU() = 0;
387 /// constructTypeDIE - Construct type DIE from DICompositeType.
388 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
391 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
392 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
394 /// Look up the source ID with the given directory and source file names. If
395 /// none currently exists, create a new ID and insert it in the line table.
396 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
398 /// resolve - Look in the DwarfDebug map for the MDNode that
399 /// corresponds to the reference.
400 template <typename T> T resolve(DIRef<T> Ref) const {
401 return DD->resolve(Ref);
405 /// constructTypeDIE - Construct basic type die from DIBasicType.
406 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
408 /// constructTypeDIE - Construct derived type die from DIDerivedType.
409 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
411 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
412 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
414 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
415 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
417 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
418 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
420 /// constructMemberDIE - Construct member DIE from DIDerivedType.
421 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
423 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
424 /// DITemplateTypeParameter.
425 void constructTemplateTypeParameterDIE(DIE &Buffer,
426 DITemplateTypeParameter TP);
428 /// constructTemplateValueParameterDIE - Construct new DIE for the given
429 /// DITemplateValueParameter.
430 void constructTemplateValueParameterDIE(DIE &Buffer,
431 DITemplateValueParameter TVP);
433 /// getLowerBoundDefault - Return the default lower bound for an array. If the
434 /// DWARF version doesn't handle the language, return -1.
435 int64_t getDefaultLowerBound() const;
437 /// getDIEEntry - Returns the debug information entry for the specified
439 DIEEntry *getDIEEntry(const MDNode *N) const {
440 return MDNodeToDIEEntryMap.lookup(N);
443 /// insertDIEEntry - Insert debug information entry into the map.
444 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
445 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
448 // getIndexTyDie - Get an anonymous type for index type.
449 DIE *getIndexTyDie() { return IndexTyDie; }
451 // setIndexTyDie - Set D as anonymous type for index which can be reused
453 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
455 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
456 /// information entry.
457 DIEEntry *createDIEEntry(DIE &Entry);
459 /// If this is a named finished type then include it in the list of types for
460 /// the accelerator tables.
461 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
464 class DwarfTypeUnit : public DwarfUnit {
466 uint64_t TypeSignature;
468 DwarfCompileUnit &CU;
469 MCDwarfDwoLineTable *SplitLineTable;
472 DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
473 DwarfDebug *DW, DwarfFile *DWU,
474 MCDwarfDwoLineTable *SplitLineTable = nullptr);
476 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
477 uint64_t getTypeSignature() const { return TypeSignature; }
478 void setType(const DIE *Ty) { this->Ty = Ty; }
480 /// Emit the header for this unit, not including the initial length field.
481 void emitHeader(const MCSymbol *ASectionSym) const override;
482 unsigned getHeaderSize() const override {
483 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
484 sizeof(uint32_t); // Type DIE Offset
486 using DwarfUnit::initSection;
487 DwarfCompileUnit &getCU() override { return CU; }
490 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
492 } // end llvm namespace