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 // DIEValueAllocator - All DIEValues are allocated through this allocator.
111 BumpPtrAllocator DIEValueAllocator;
113 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
114 DIEInteger *DIEIntegerOne;
116 /// The section this unit will be emitted in.
117 const MCSection *Section;
119 DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
120 DwarfDebug *DW, DwarfFile *DWU);
122 void initSection(const MCSection *Section);
124 /// Add a string attribute data and value.
125 void addLocalString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
127 void addIndexedString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
130 virtual ~DwarfUnit();
132 const MCSection *getSection() const {
138 unsigned getUniqueID() const { return UniqueID; }
139 uint16_t getLanguage() const { return CUNode.getLanguage(); }
140 DICompileUnit getCUNode() const { return CUNode; }
141 DIE &getUnitDie() { return UnitDie; }
143 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
144 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
146 /// hasContent - Return true if this compile unit has something to write out.
147 bool hasContent() const { return !UnitDie.getChildren().empty(); }
149 /// getParentContextString - Get a string containing the language specific
150 /// context for a global name.
151 std::string getParentContextString(DIScope Context) const;
153 /// Add a new global name to the compile unit.
154 virtual void addGlobalName(StringRef Name, DIE &Die, DIScope Context) {}
156 /// Add a new global type to the compile unit.
157 virtual void addGlobalType(DIType Ty, const DIE &Die, DIScope Context) {}
159 /// addAccelNamespace - Add a new name to the namespace accelerator table.
160 void addAccelNamespace(StringRef Name, const DIE &Die);
162 /// getDIE - Returns the debug information entry map slot for the
163 /// specified debug variable. We delegate the request to DwarfDebug
164 /// when the MDNode can be part of the type system, since DIEs for
165 /// the type system can be shared across CUs and the mappings are
166 /// kept in DwarfDebug.
167 DIE *getDIE(DIDescriptor D) const;
169 /// getDIELoc - Returns a fresh newly allocated DIELoc.
170 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
172 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
173 /// when the MDNode can be part of the type system, since DIEs for
174 /// the type system can be shared across CUs and the mappings are
175 /// kept in DwarfDebug.
176 void insertDIE(DIDescriptor Desc, DIE *D);
178 /// addFlag - Add a flag that is true to the DIE.
179 void addFlag(DIE &Die, dwarf::Attribute Attribute);
181 /// addUInt - Add an unsigned integer attribute data and value.
182 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
185 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
187 /// addSInt - Add an signed integer attribute data and value.
188 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
191 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
193 /// addString - Add a string attribute data and value.
194 void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
196 /// addLabel - Add a Dwarf label attribute data and value.
197 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
198 const MCSymbol *Label);
200 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
202 /// addSectionOffset - Add an offset into a section attribute data and value.
204 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
206 /// addOpAddress - Add a dwarf op address data and value using the
207 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
208 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
210 /// addLabelDelta - Add a label delta attribute data and value.
211 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
214 /// addDIEEntry - Add a DIE attribute data and value.
215 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
217 /// addDIEEntry - Add a DIE attribute data and value.
218 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
220 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
222 /// addBlock - Add block data.
223 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
225 /// addBlock - Add block data.
226 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
228 /// addSourceLine - Add location information to specified debug information
230 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
231 StringRef Directory);
232 void addSourceLine(DIE &Die, DIVariable V);
233 void addSourceLine(DIE &Die, DIGlobalVariable G);
234 void addSourceLine(DIE &Die, DISubprogram SP);
235 void addSourceLine(DIE &Die, DIType Ty);
236 void addSourceLine(DIE &Die, DINameSpace NS);
237 void addSourceLine(DIE &Die, DIObjCProperty Ty);
239 /// addConstantValue - Add constant value entry in variable DIE.
240 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
241 void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
242 void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
243 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
244 void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
246 /// addConstantFPValue - Add constant value entry in variable DIE.
247 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
248 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
250 /// addTemplateParams - Add template parameters in buffer.
251 void addTemplateParams(DIE &Buffer, DIArray TParams);
253 /// addRegisterOp - Add register operand.
254 void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
255 unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
257 /// addRegisterOffset - Add register offset.
258 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
260 // FIXME: Should be reformulated in terms of addComplexAddress.
261 /// addBlockByrefAddress - Start with the address based on the location
262 /// provided, and generate the DWARF information necessary to find the
263 /// actual Block variable (navigating the Block struct) based on the
264 /// starting location. Add the DWARF information to the die. Obsolete,
265 /// please use addComplexAddress instead.
266 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
267 dwarf::Attribute Attribute,
268 const MachineLocation &Location);
270 /// addType - Add a new type attribute to the specified entity. This takes
271 /// and attribute parameter because DW_AT_friend attributes are also
273 void addType(DIE &Entity, DIType Ty,
274 dwarf::Attribute Attribute = dwarf::DW_AT_type);
276 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
277 DIE *getOrCreateNameSpace(DINameSpace NS);
279 /// getOrCreateSubprogramDIE - Create new DIE using SP.
280 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
282 void applySubprogramAttributes(DISubprogram SP, DIE &SPDie,
283 bool Minimal = false);
285 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
287 DIE *getOrCreateTypeDIE(const MDNode *N);
289 /// getOrCreateContextDIE - Get context owner's DIE.
290 DIE *createTypeDIE(DICompositeType Ty);
292 /// getOrCreateContextDIE - Get context owner's DIE.
293 DIE *getOrCreateContextDIE(DIScope Context);
295 /// constructContainingTypeDIEs - Construct DIEs for types that contain
297 void constructContainingTypeDIEs();
299 /// constructSubprogramArguments - Construct function argument DIEs.
300 void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
302 /// Create a DIE with the given Tag, add the DIE to its parent, and
303 /// call insertDIE if MD is not null.
304 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
305 DIDescriptor N = DIDescriptor());
307 /// Compute the size of a header for this unit, not including the initial
309 virtual unsigned getHeaderSize() const {
310 return sizeof(int16_t) + // DWARF version number
311 sizeof(int32_t) + // Offset Into Abbrev. Section
312 sizeof(int8_t); // Pointer Size (in bytes)
315 /// Emit the header for this unit, not including the initial length field.
316 virtual void emitHeader(const MCSymbol *ASectionSym) const;
318 virtual DwarfCompileUnit &getCU() = 0;
320 /// constructTypeDIE - Construct type DIE from DICompositeType.
321 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
324 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
325 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
327 /// Look up the source ID with the given directory and source file names. If
328 /// none currently exists, create a new ID and insert it in the line table.
329 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
331 /// resolve - Look in the DwarfDebug map for the MDNode that
332 /// corresponds to the reference.
333 template <typename T> T resolve(DIRef<T> Ref) const {
334 return DD->resolve(Ref);
338 /// constructTypeDIE - Construct basic type die from DIBasicType.
339 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
341 /// constructTypeDIE - Construct derived type die from DIDerivedType.
342 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
344 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
345 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
347 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
348 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
350 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
351 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
353 /// constructMemberDIE - Construct member DIE from DIDerivedType.
354 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
356 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
357 /// DITemplateTypeParameter.
358 void constructTemplateTypeParameterDIE(DIE &Buffer,
359 DITemplateTypeParameter TP);
361 /// constructTemplateValueParameterDIE - Construct new DIE for the given
362 /// DITemplateValueParameter.
363 void constructTemplateValueParameterDIE(DIE &Buffer,
364 DITemplateValueParameter TVP);
366 /// getLowerBoundDefault - Return the default lower bound for an array. If the
367 /// DWARF version doesn't handle the language, return -1.
368 int64_t getDefaultLowerBound() const;
370 /// getDIEEntry - Returns the debug information entry for the specified
372 DIEEntry *getDIEEntry(const MDNode *N) const {
373 return MDNodeToDIEEntryMap.lookup(N);
376 /// insertDIEEntry - Insert debug information entry into the map.
377 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
378 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
381 // getIndexTyDie - Get an anonymous type for index type.
382 DIE *getIndexTyDie();
384 // setIndexTyDie - Set D as anonymous type for index which can be reused
386 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
388 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
389 /// information entry.
390 DIEEntry *createDIEEntry(DIE &Entry);
392 /// If this is a named finished type then include it in the list of types for
393 /// the accelerator tables.
394 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
396 virtual bool isDwoUnit() const = 0;
399 class DwarfTypeUnit : public DwarfUnit {
400 uint64_t TypeSignature;
402 DwarfCompileUnit &CU;
403 MCDwarfDwoLineTable *SplitLineTable;
405 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
406 bool isDwoUnit() const override;
409 DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
410 DwarfDebug *DW, DwarfFile *DWU,
411 MCDwarfDwoLineTable *SplitLineTable = nullptr);
413 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
414 uint64_t getTypeSignature() const { return TypeSignature; }
415 void setType(const DIE *Ty) { this->Ty = Ty; }
417 /// Emit the header for this unit, not including the initial length field.
418 void emitHeader(const MCSymbol *ASectionSym) const override;
419 unsigned getHeaderSize() const override {
420 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
421 sizeof(uint32_t); // Type DIE Offset
423 using DwarfUnit::initSection;
424 DwarfCompileUnit &getCU() override { return CU; }
426 } // end llvm namespace