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 /// DIEBlocks - A list of all the DIEBlocks in use.
100 std::vector<DIEBlock *> DIEBlocks;
102 /// DIELocs - A list of all the DIELocs in use.
103 std::vector<DIELoc *> DIELocs;
105 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
106 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
107 /// corresponds to the MDNode mapped with the subprogram DIE.
108 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
110 // List of ranges for a given compile unit.
111 SmallVector<RangeSpan, 1> CURanges;
113 // List of range lists for a given compile unit, separate from the ranges for
115 SmallVector<RangeSpanList, 1> CURangeLists;
117 // DIEValueAllocator - All DIEValues are allocated through this allocator.
118 BumpPtrAllocator DIEValueAllocator;
120 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
121 DIEInteger *DIEIntegerOne;
123 /// The section this unit will be emitted in.
124 const MCSection *Section;
126 DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
127 DwarfDebug *DW, DwarfFile *DWU);
129 void initSection(const MCSection *Section);
131 /// Add a string attribute data and value.
132 void addLocalString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
134 void addIndexedString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
137 virtual ~DwarfUnit();
139 const MCSection *getSection() const {
145 unsigned getUniqueID() const { return UniqueID; }
146 uint16_t getLanguage() const { return CUNode.getLanguage(); }
147 DICompileUnit getCUNode() const { return CUNode; }
148 DIE &getUnitDie() { return UnitDie; }
150 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
151 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
153 /// hasContent - Return true if this compile unit has something to write out.
154 bool hasContent() const { return !UnitDie.getChildren().empty(); }
156 /// getRanges - Get the list of ranges for this unit.
157 const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
158 SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
160 /// addRangeList - Add an address range list to the list of range lists.
161 void addRangeList(RangeSpanList Ranges) {
162 CURangeLists.push_back(std::move(Ranges));
165 /// getRangeLists - Get the vector of range lists.
166 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
169 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
171 /// getParentContextString - Get a string containing the language specific
172 /// context for a global name.
173 std::string getParentContextString(DIScope Context) const;
175 /// Add a new global name to the compile unit.
176 virtual void addGlobalName(StringRef Name, DIE &Die, DIScope Context) {}
178 /// Add a new global type to the compile unit.
179 virtual void addGlobalType(DIType Ty, const DIE &Die, DIScope Context) {}
181 /// addAccelNamespace - Add a new name to the namespace accelerator table.
182 void addAccelNamespace(StringRef Name, const DIE &Die);
184 /// getDIE - Returns the debug information entry map slot for the
185 /// specified debug variable. We delegate the request to DwarfDebug
186 /// when the MDNode can be part of the type system, since DIEs for
187 /// the type system can be shared across CUs and the mappings are
188 /// kept in DwarfDebug.
189 DIE *getDIE(DIDescriptor D) const;
191 /// getDIELoc - Returns a fresh newly allocated DIELoc.
192 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
194 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
195 /// when the MDNode can be part of the type system, since DIEs for
196 /// the type system can be shared across CUs and the mappings are
197 /// kept in DwarfDebug.
198 void insertDIE(DIDescriptor Desc, DIE *D);
200 /// addFlag - Add a flag that is true to the DIE.
201 void addFlag(DIE &Die, dwarf::Attribute Attribute);
203 /// addUInt - Add an unsigned integer attribute data and value.
204 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
207 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
209 /// addSInt - Add an signed integer attribute data and value.
210 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
213 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
215 /// addString - Add a string attribute data and value.
216 void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
218 /// addLabel - Add a Dwarf label attribute data and value.
219 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
220 const MCSymbol *Label);
222 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
224 /// addSectionOffset - Add an offset into a section attribute data and value.
226 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
228 /// addOpAddress - Add a dwarf op address data and value using the
229 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
230 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
232 /// addLabelDelta - Add a label delta attribute data and value.
233 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
236 /// addDIEEntry - Add a DIE attribute data and value.
237 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
239 /// addDIEEntry - Add a DIE attribute data and value.
240 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
242 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
244 /// addBlock - Add block data.
245 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
247 /// addBlock - Add block data.
248 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
250 /// addSourceLine - Add location information to specified debug information
252 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
253 StringRef Directory);
254 void addSourceLine(DIE &Die, DIVariable V);
255 void addSourceLine(DIE &Die, DIGlobalVariable G);
256 void addSourceLine(DIE &Die, DISubprogram SP);
257 void addSourceLine(DIE &Die, DIType Ty);
258 void addSourceLine(DIE &Die, DINameSpace NS);
259 void addSourceLine(DIE &Die, DIObjCProperty Ty);
261 /// addConstantValue - Add constant value entry in variable DIE.
262 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
263 void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
264 void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
265 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
266 void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
268 /// addConstantFPValue - Add constant value entry in variable DIE.
269 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
270 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
272 /// addTemplateParams - Add template parameters in buffer.
273 void addTemplateParams(DIE &Buffer, DIArray TParams);
275 /// addRegisterOp - Add register operand.
276 void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
277 unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
279 /// addRegisterOffset - Add register offset.
280 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
282 // FIXME: Should be reformulated in terms of addComplexAddress.
283 /// addBlockByrefAddress - Start with the address based on the location
284 /// provided, and generate the DWARF information necessary to find the
285 /// actual Block variable (navigating the Block struct) based on the
286 /// starting location. Add the DWARF information to the die. Obsolete,
287 /// please use addComplexAddress instead.
288 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
289 dwarf::Attribute Attribute,
290 const MachineLocation &Location);
292 /// addType - Add a new type attribute to the specified entity. This takes
293 /// and attribute parameter because DW_AT_friend attributes are also
295 void addType(DIE &Entity, DIType Ty,
296 dwarf::Attribute Attribute = dwarf::DW_AT_type);
298 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
299 DIE *getOrCreateNameSpace(DINameSpace NS);
301 /// getOrCreateSubprogramDIE - Create new DIE using SP.
302 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
304 void applySubprogramAttributes(DISubprogram SP, DIE &SPDie,
305 bool Minimal = false);
307 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
309 DIE *getOrCreateTypeDIE(const MDNode *N);
311 /// getOrCreateContextDIE - Get context owner's DIE.
312 DIE *createTypeDIE(DICompositeType Ty);
314 /// getOrCreateContextDIE - Get context owner's DIE.
315 DIE *getOrCreateContextDIE(DIScope Context);
317 /// constructContainingTypeDIEs - Construct DIEs for types that contain
319 void constructContainingTypeDIEs();
321 /// constructSubprogramArguments - Construct function argument DIEs.
322 void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
324 /// Create a DIE with the given Tag, add the DIE to its parent, and
325 /// call insertDIE if MD is not null.
326 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
327 DIDescriptor N = DIDescriptor());
329 /// Compute the size of a header for this unit, not including the initial
331 virtual unsigned getHeaderSize() const {
332 return sizeof(int16_t) + // DWARF version number
333 sizeof(int32_t) + // Offset Into Abbrev. Section
334 sizeof(int8_t); // Pointer Size (in bytes)
337 /// Emit the header for this unit, not including the initial length field.
338 virtual void emitHeader(const MCSymbol *ASectionSym) const;
340 virtual DwarfCompileUnit &getCU() = 0;
342 /// constructTypeDIE - Construct type DIE from DICompositeType.
343 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
346 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
347 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
349 /// Look up the source ID with the given directory and source file names. If
350 /// none currently exists, create a new ID and insert it in the line table.
351 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
353 /// resolve - Look in the DwarfDebug map for the MDNode that
354 /// corresponds to the reference.
355 template <typename T> T resolve(DIRef<T> Ref) const {
356 return DD->resolve(Ref);
360 /// constructTypeDIE - Construct basic type die from DIBasicType.
361 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
363 /// constructTypeDIE - Construct derived type die from DIDerivedType.
364 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
366 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
367 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
369 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
370 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
372 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
373 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
375 /// constructMemberDIE - Construct member DIE from DIDerivedType.
376 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
378 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
379 /// DITemplateTypeParameter.
380 void constructTemplateTypeParameterDIE(DIE &Buffer,
381 DITemplateTypeParameter TP);
383 /// constructTemplateValueParameterDIE - Construct new DIE for the given
384 /// DITemplateValueParameter.
385 void constructTemplateValueParameterDIE(DIE &Buffer,
386 DITemplateValueParameter TVP);
388 /// getLowerBoundDefault - Return the default lower bound for an array. If the
389 /// DWARF version doesn't handle the language, return -1.
390 int64_t getDefaultLowerBound() const;
392 /// getDIEEntry - Returns the debug information entry for the specified
394 DIEEntry *getDIEEntry(const MDNode *N) const {
395 return MDNodeToDIEEntryMap.lookup(N);
398 /// insertDIEEntry - Insert debug information entry into the map.
399 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
400 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
403 // getIndexTyDie - Get an anonymous type for index type.
404 DIE *getIndexTyDie();
406 // setIndexTyDie - Set D as anonymous type for index which can be reused
408 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
410 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
411 /// information entry.
412 DIEEntry *createDIEEntry(DIE &Entry);
414 /// If this is a named finished type then include it in the list of types for
415 /// the accelerator tables.
416 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
418 virtual bool isDwoUnit() const = 0;
421 class DwarfTypeUnit : public DwarfUnit {
422 uint64_t TypeSignature;
424 DwarfCompileUnit &CU;
425 MCDwarfDwoLineTable *SplitLineTable;
427 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
428 bool isDwoUnit() const override;
431 DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
432 DwarfDebug *DW, DwarfFile *DWU,
433 MCDwarfDwoLineTable *SplitLineTable = nullptr);
435 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
436 uint64_t getTypeSignature() const { return TypeSignature; }
437 void setType(const DIE *Ty) { this->Ty = Ty; }
439 /// Emit the header for this unit, not including the initial length field.
440 void emitHeader(const MCSymbol *ASectionSym) const override;
441 unsigned getHeaderSize() const override {
442 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
443 sizeof(uint32_t); // Type DIE Offset
445 using DwarfUnit::initSection;
446 DwarfCompileUnit &getCU() override { return CU; }
448 } // end llvm namespace