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
17 #include "DwarfDebug.h"
18 #include "llvm/ADT/DenseMap.h"
19 #include "llvm/ADT/Optional.h"
20 #include "llvm/ADT/StringMap.h"
21 #include "llvm/CodeGen/AsmPrinter.h"
22 #include "llvm/CodeGen/DIE.h"
23 #include "llvm/IR/DIBuilder.h"
24 #include "llvm/IR/DebugInfo.h"
25 #include "llvm/MC/MCDwarf.h"
26 #include "llvm/MC/MCExpr.h"
27 #include "llvm/MC/MCSection.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, SmallVector<RangeSpan, 2> Ranges)
59 : RangeSym(Sym), Ranges(std::move(Ranges)) {}
60 MCSymbol *getSym() const { return RangeSym; }
61 const SmallVectorImpl<RangeSpan> &getRanges() const { return Ranges; }
62 void addRange(RangeSpan Range) { Ranges.push_back(Range); }
65 //===----------------------------------------------------------------------===//
66 /// This dwarf writer support class manages information associated with a
68 class DwarfUnit : public DIEUnit {
70 /// MDNode for the compile unit.
71 const DICompileUnit *CUNode;
73 // All DIEValues are allocated through this allocator.
74 BumpPtrAllocator DIEValueAllocator;
76 /// Target of Dwarf emission.
79 // Holders for some common dwarf information.
83 /// An anonymous type for index type. Owned by DIEUnit.
86 /// Tracks the mapping of unit level debug information variables to debug
87 /// information entries.
88 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
90 /// A list of all the DIEBlocks in use.
91 std::vector<DIEBlock *> DIEBlocks;
93 /// A list of all the DIELocs in use.
94 std::vector<DIELoc *> DIELocs;
96 /// This map is used to keep track of subprogram DIEs that need
97 /// DW_AT_containing_type attribute. This attribute points to a DIE that
98 /// corresponds to the MDNode mapped with the subprogram DIE.
99 DenseMap<DIE *, const DINode *> ContainingTypeMap;
101 DwarfUnit(dwarf::Tag, const DICompileUnit *CU, AsmPrinter *A, DwarfDebug *DW,
104 bool applySubprogramDefinitionAttributes(const DISubprogram *SP, DIE &SPDie);
107 virtual ~DwarfUnit();
110 AsmPrinter* getAsmPrinter() const { return Asm; }
111 uint16_t getLanguage() const { return CUNode->getSourceLanguage(); }
112 const DICompileUnit *getCUNode() const { return CUNode; }
114 /// Return true if this compile unit has something to write out.
115 bool hasContent() const { return getUnitDie().hasChildren(); }
117 /// Get string containing language specific context for a global name.
119 /// Walks the metadata parent chain in a language specific manner (using the
120 /// compile unit language) and returns it as a string. This is done at the
121 /// metadata level because DIEs may not currently have been added to the
122 /// parent context and walking the DIEs looking for names is more expensive
123 /// than walking the metadata.
124 std::string getParentContextString(const DIScope *Context) const;
126 /// Add a new global name to the compile unit.
127 virtual void addGlobalName(StringRef Name, const DIE &Die,
128 const DIScope *Context) = 0;
130 /// Add a new global type to the compile unit.
131 virtual void addGlobalType(const DIType *Ty, const DIE &Die,
132 const DIScope *Context) = 0;
134 /// Returns the DIE map slot for the specified debug variable.
136 /// We delegate the request to DwarfDebug when the MDNode can be part of the
137 /// type system, since DIEs for the type system can be shared across CUs and
138 /// the mappings are kept in DwarfDebug.
139 DIE *getDIE(const DINode *D) const;
141 /// Returns a fresh newly allocated DIELoc.
142 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc; }
144 /// Insert DIE into the map.
146 /// We delegate the request to DwarfDebug when the MDNode can be part of the
147 /// type system, since DIEs for the type system can be shared across CUs and
148 /// the mappings are kept in DwarfDebug.
149 void insertDIE(const DINode *Desc, DIE *D);
151 /// Add a flag that is true to the DIE.
152 void addFlag(DIE &Die, dwarf::Attribute Attribute);
154 /// Add an unsigned integer attribute data and value.
155 void addUInt(DIEValueList &Die, dwarf::Attribute Attribute,
156 Optional<dwarf::Form> Form, uint64_t Integer);
158 void addUInt(DIEValueList &Block, dwarf::Form Form, uint64_t Integer);
160 /// Add an signed integer attribute data and value.
161 void addSInt(DIEValueList &Die, dwarf::Attribute Attribute,
162 Optional<dwarf::Form> Form, int64_t Integer);
164 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
166 /// Add a string attribute data and value.
168 /// We always emit a reference to the string pool instead of immediate
169 /// strings so that DIEs have more predictable sizes. In the case of split
170 /// dwarf we emit an index into another table which gets us the static offset
171 /// into the string table.
172 void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
174 /// Add a Dwarf label attribute data and value.
175 DIEValueList::value_iterator addLabel(DIEValueList &Die,
176 dwarf::Attribute Attribute,
178 const MCSymbol *Label);
180 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
182 /// Add an offset into a section attribute data and value.
183 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
185 /// Add a dwarf op address data and value using the form given and an
186 /// op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
187 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
189 /// Add a label delta attribute data and value.
190 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
193 /// Add a DIE attribute data and value.
194 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
196 /// Add a DIE attribute data and value.
197 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry Entry);
199 /// Add a type's DW_AT_signature and set the declaration flag.
200 void addDIETypeSignature(DIE &Die, uint64_t Signature);
203 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
206 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
208 /// Add location information to specified debug information entry.
209 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
210 StringRef Directory);
211 void addSourceLine(DIE &Die, const DILocalVariable *V);
212 void addSourceLine(DIE &Die, const DIGlobalVariable *G);
213 void addSourceLine(DIE &Die, const DISubprogram *SP);
214 void addSourceLine(DIE &Die, const DIType *Ty);
215 void addSourceLine(DIE &Die, const DINamespace *NS);
216 void addSourceLine(DIE &Die, const DIObjCProperty *Ty);
218 /// Add constant value entry in variable DIE.
219 void addConstantValue(DIE &Die, const MachineOperand &MO, const DIType *Ty);
220 void addConstantValue(DIE &Die, const ConstantInt *CI, const DIType *Ty);
221 void addConstantValue(DIE &Die, const APInt &Val, const DIType *Ty);
222 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
223 void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
225 /// Add constant value entry in variable DIE.
226 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
227 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
229 /// Add a linkage name, if it isn't empty.
230 void addLinkageName(DIE &Die, StringRef LinkageName);
232 /// Add template parameters in buffer.
233 void addTemplateParams(DIE &Buffer, DINodeArray TParams);
235 // FIXME: Should be reformulated in terms of addComplexAddress.
236 /// Start with the address based on the location provided, and generate the
237 /// DWARF information necessary to find the actual Block variable (navigating
238 /// the Block struct) based on the starting location. Add the DWARF
239 /// information to the die. Obsolete, please use addComplexAddress instead.
240 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
241 dwarf::Attribute Attribute,
242 const MachineLocation &Location);
244 /// Add a new type attribute to the specified entity.
246 /// This takes and attribute parameter because DW_AT_friend attributes are
247 /// also type references.
248 void addType(DIE &Entity, const DIType *Ty,
249 dwarf::Attribute Attribute = dwarf::DW_AT_type);
251 DIE *getOrCreateNameSpace(const DINamespace *NS);
252 DIE *getOrCreateModule(const DIModule *M);
253 DIE *getOrCreateSubprogramDIE(const DISubprogram *SP, bool Minimal = false);
255 void applySubprogramAttributes(const DISubprogram *SP, DIE &SPDie,
256 bool SkipSPAttributes = false);
258 /// Find existing DIE or create new DIE for the given type.
259 DIE *getOrCreateTypeDIE(const MDNode *N);
261 /// Get context owner's DIE.
262 DIE *getOrCreateContextDIE(const DIScope *Context);
264 /// Construct DIEs for types that contain vtables.
265 void constructContainingTypeDIEs();
267 /// Construct function argument DIEs.
268 void constructSubprogramArguments(DIE &Buffer, DITypeRefArray Args);
270 /// Create a DIE with the given Tag, add the DIE to its parent, and
271 /// call insertDIE if MD is not null.
272 DIE &createAndAddDIE(unsigned Tag, DIE &Parent, const DINode *N = nullptr);
274 /// Compute the size of a header for this unit, not including the initial
276 virtual unsigned getHeaderSize() const {
277 return sizeof(int16_t) + // DWARF version number
278 sizeof(int32_t) + // Offset Into Abbrev. Section
279 sizeof(int8_t) + // Pointer Size (in bytes)
280 (DD->getDwarfVersion() >= 5 ? sizeof(int8_t)
281 : 0); // DWARF v5 unit type
284 /// Emit the header for this unit, not including the initial length field.
285 virtual void emitHeader(bool UseOffsets) = 0;
287 virtual DwarfCompileUnit &getCU() = 0;
289 void constructTypeDIE(DIE &Buffer, const DICompositeType *CTy);
292 /// Create new static data member DIE.
293 DIE *getOrCreateStaticMemberDIE(const DIDerivedType *DT);
295 /// Look up the source ID with the given directory and source file names. If
296 /// none currently exists, create a new ID and insert it in the line table.
297 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
299 /// Look in the DwarfDebug map for the MDNode that corresponds to the
301 template <typename T> T *resolve(TypedDINodeRef<T> Ref) const {
302 return Ref.resolve();
305 /// If this is a named finished type then include it in the list of types for
306 /// the accelerator tables.
307 void updateAcceleratorTables(const DIScope *Context, const DIType *Ty,
310 /// Emit the common part of the header for this unit.
311 void emitCommonHeader(bool UseOffsets, dwarf::UnitType UT);
314 void constructTypeDIE(DIE &Buffer, const DIBasicType *BTy);
315 void constructTypeDIE(DIE &Buffer, const DIDerivedType *DTy);
316 void constructTypeDIE(DIE &Buffer, const DISubroutineType *DTy);
317 void constructSubrangeDIE(DIE &Buffer, const DISubrange *SR, DIE *IndexTy);
318 void constructArrayTypeDIE(DIE &Buffer, const DICompositeType *CTy);
319 void constructEnumTypeDIE(DIE &Buffer, const DICompositeType *CTy);
320 void constructMemberDIE(DIE &Buffer, const DIDerivedType *DT);
321 void constructTemplateTypeParameterDIE(DIE &Buffer,
322 const DITemplateTypeParameter *TP);
323 void constructTemplateValueParameterDIE(DIE &Buffer,
324 const DITemplateValueParameter *TVP);
326 /// Return the default lower bound for an array.
328 /// If the DWARF version doesn't handle the language, return -1.
329 int64_t getDefaultLowerBound() const;
331 /// Get an anonymous type for index type.
332 DIE *getIndexTyDie();
334 /// Set D as anonymous type for index which can be reused later.
335 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
337 virtual bool isDwoUnit() const = 0;
340 class DwarfTypeUnit : public DwarfUnit {
341 uint64_t TypeSignature;
343 DwarfCompileUnit &CU;
344 MCDwarfDwoLineTable *SplitLineTable;
346 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
347 bool isDwoUnit() const override;
350 DwarfTypeUnit(DwarfCompileUnit &CU, AsmPrinter *A, DwarfDebug *DW,
351 DwarfFile *DWU, MCDwarfDwoLineTable *SplitLineTable = nullptr);
353 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
354 void setType(const DIE *Ty) { this->Ty = Ty; }
356 /// Get context owner's DIE.
357 DIE *createTypeDIE(const DICompositeType *Ty);
359 /// Emit the header for this unit, not including the initial length field.
360 void emitHeader(bool UseOffsets) override;
361 unsigned getHeaderSize() const override {
362 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
363 sizeof(uint32_t); // Type DIE Offset
365 void addGlobalName(StringRef Name, const DIE &Die,
366 const DIScope *Context) override;
367 void addGlobalType(const DIType *Ty, const DIE &Die,
368 const DIScope *Context) override;
369 DwarfCompileUnit &getCU() override { return CU; }
371 } // end llvm namespace