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, 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 /// Unit - This dwarf writer support class manages information associated
67 /// with a source file.
70 /// UniqueID - a numeric ID unique among all CUs in the module
73 /// Node - MDNode for the compile unit.
76 /// Unit debug information entry.
79 /// Offset of the UnitDie from beginning of debug info section.
80 unsigned DebugInfoOffset;
82 /// Asm - Target of Dwarf emission.
85 // Holders for some common dwarf information.
89 /// IndexTyDie - An anonymous type for index type. Owned by UnitDie.
92 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
93 /// variables to debug information entries.
94 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
96 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
97 /// descriptors to debug information entries using a DIEEntry proxy.
98 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
100 /// DIEBlocks - A list of all the DIEBlocks in use.
101 std::vector<DIEBlock *> DIEBlocks;
103 /// DIELocs - A list of all the DIELocs in use.
104 std::vector<DIELoc *> DIELocs;
106 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
107 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
108 /// corresponds to the MDNode mapped with the subprogram DIE.
109 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
111 // DIEValueAllocator - All DIEValues are allocated through this allocator.
112 BumpPtrAllocator DIEValueAllocator;
114 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
115 DIEInteger *DIEIntegerOne;
117 /// The section this unit will be emitted in.
118 const MCSection *Section;
120 DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
121 DwarfDebug *DW, DwarfFile *DWU);
123 void initSection(const MCSection *Section);
125 /// Add a string attribute data and value.
126 void addLocalString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
128 void addIndexedString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
131 virtual ~DwarfUnit();
133 const MCSection *getSection() const {
139 unsigned getUniqueID() const { return UniqueID; }
140 uint16_t getLanguage() const { return CUNode.getLanguage(); }
141 DICompileUnit getCUNode() const { return CUNode; }
142 DIE &getUnitDie() { return UnitDie; }
144 unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
145 void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
147 /// hasContent - Return true if this compile unit has something to write out.
148 bool hasContent() const { return !UnitDie.getChildren().empty(); }
150 /// getParentContextString - Get a string containing the language specific
151 /// context for a global name.
152 std::string getParentContextString(DIScope Context) const;
154 /// Add a new global name to the compile unit.
155 virtual void addGlobalName(StringRef Name, DIE &Die, DIScope Context) {}
157 /// Add a new global type to the compile unit.
158 virtual void addGlobalType(DIType Ty, const DIE &Die, DIScope Context) {}
160 /// addAccelNamespace - Add a new name to the namespace accelerator table.
161 void addAccelNamespace(StringRef Name, const DIE &Die);
163 /// getDIE - Returns the debug information entry map slot for the
164 /// specified debug variable. We delegate the request to DwarfDebug
165 /// when the MDNode can be part of the type system, since DIEs for
166 /// the type system can be shared across CUs and the mappings are
167 /// kept in DwarfDebug.
168 DIE *getDIE(DIDescriptor D) const;
170 /// getDIELoc - Returns a fresh newly allocated DIELoc.
171 DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
173 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
174 /// when the MDNode can be part of the type system, since DIEs for
175 /// the type system can be shared across CUs and the mappings are
176 /// kept in DwarfDebug.
177 void insertDIE(DIDescriptor Desc, DIE *D);
179 /// addFlag - Add a flag that is true to the DIE.
180 void addFlag(DIE &Die, dwarf::Attribute Attribute);
182 /// addUInt - Add an unsigned integer attribute data and value.
183 void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
186 void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
188 /// addSInt - Add an signed integer attribute data and value.
189 void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
192 void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
194 /// addString - Add a string attribute data and value.
195 void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
197 /// addLabel - Add a Dwarf label attribute data and value.
198 void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
199 const MCSymbol *Label);
201 void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
203 /// addSectionOffset - Add an offset into a section attribute data and value.
205 void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
207 /// addOpAddress - Add a dwarf op address data and value using the
208 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
209 void addOpAddress(DIELoc &Die, const MCSymbol *Label);
211 /// addLabelDelta - Add a label delta attribute data and value.
212 void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
215 /// addDIEEntry - Add a DIE attribute data and value.
216 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
218 /// addDIEEntry - Add a DIE attribute data and value.
219 void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
221 void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
223 /// addBlock - Add block data.
224 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
226 /// addBlock - Add block data.
227 void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
229 /// addSourceLine - Add location information to specified debug information
231 void addSourceLine(DIE &Die, unsigned Line, StringRef File,
232 StringRef Directory);
233 void addSourceLine(DIE &Die, DIVariable V);
234 void addSourceLine(DIE &Die, DIGlobalVariable G);
235 void addSourceLine(DIE &Die, DISubprogram SP);
236 void addSourceLine(DIE &Die, DIType Ty);
237 void addSourceLine(DIE &Die, DINameSpace NS);
238 void addSourceLine(DIE &Die, DIObjCProperty Ty);
240 /// addConstantValue - Add constant value entry in variable DIE.
241 void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
242 void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
243 void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
244 void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
245 void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
247 /// addConstantFPValue - Add constant value entry in variable DIE.
248 void addConstantFPValue(DIE &Die, const MachineOperand &MO);
249 void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
251 /// addTemplateParams - Add template parameters in buffer.
252 void addTemplateParams(DIE &Buffer, DIArray TParams);
254 /// addRegisterOp - Add register operand.
255 void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
256 unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
258 /// addRegisterOffset - Add register offset.
259 void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
261 // FIXME: Should be reformulated in terms of addComplexAddress.
262 /// addBlockByrefAddress - Start with the address based on the location
263 /// provided, and generate the DWARF information necessary to find the
264 /// actual Block variable (navigating the Block struct) based on the
265 /// starting location. Add the DWARF information to the die. Obsolete,
266 /// please use addComplexAddress instead.
267 void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
268 dwarf::Attribute Attribute,
269 const MachineLocation &Location);
271 /// addType - Add a new type attribute to the specified entity. This takes
272 /// and attribute parameter because DW_AT_friend attributes are also
274 void addType(DIE &Entity, DIType Ty,
275 dwarf::Attribute Attribute = dwarf::DW_AT_type);
277 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
278 DIE *getOrCreateNameSpace(DINameSpace NS);
280 /// getOrCreateSubprogramDIE - Create new DIE using SP.
281 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
283 void applySubprogramAttributes(DISubprogram SP, DIE &SPDie,
284 bool Minimal = false);
286 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
288 DIE *getOrCreateTypeDIE(const MDNode *N);
290 /// getOrCreateContextDIE - Get context owner's DIE.
291 DIE *createTypeDIE(DICompositeType Ty);
293 /// getOrCreateContextDIE - Get context owner's DIE.
294 DIE *getOrCreateContextDIE(DIScope Context);
296 /// constructContainingTypeDIEs - Construct DIEs for types that contain
298 void constructContainingTypeDIEs();
300 /// constructSubprogramArguments - Construct function argument DIEs.
301 void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
303 /// Create a DIE with the given Tag, add the DIE to its parent, and
304 /// call insertDIE if MD is not null.
305 DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
306 DIDescriptor N = DIDescriptor());
308 /// Compute the size of a header for this unit, not including the initial
310 virtual unsigned getHeaderSize() const {
311 return sizeof(int16_t) + // DWARF version number
312 sizeof(int32_t) + // Offset Into Abbrev. Section
313 sizeof(int8_t); // Pointer Size (in bytes)
316 /// Emit the header for this unit, not including the initial length field.
317 virtual void emitHeader(const MCSymbol *ASectionSym) const;
319 virtual DwarfCompileUnit &getCU() = 0;
321 /// constructTypeDIE - Construct type DIE from DICompositeType.
322 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
325 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
326 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
328 /// Look up the source ID with the given directory and source file names. If
329 /// none currently exists, create a new ID and insert it in the line table.
330 virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
332 /// resolve - Look in the DwarfDebug map for the MDNode that
333 /// corresponds to the reference.
334 template <typename T> T resolve(DIRef<T> Ref) const {
335 return DD->resolve(Ref);
339 /// constructTypeDIE - Construct basic type die from DIBasicType.
340 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
342 /// constructTypeDIE - Construct derived type die from DIDerivedType.
343 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
345 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
346 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
348 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
349 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
351 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
352 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
354 /// constructMemberDIE - Construct member DIE from DIDerivedType.
355 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
357 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
358 /// DITemplateTypeParameter.
359 void constructTemplateTypeParameterDIE(DIE &Buffer,
360 DITemplateTypeParameter TP);
362 /// constructTemplateValueParameterDIE - Construct new DIE for the given
363 /// DITemplateValueParameter.
364 void constructTemplateValueParameterDIE(DIE &Buffer,
365 DITemplateValueParameter TVP);
367 /// getLowerBoundDefault - Return the default lower bound for an array. If the
368 /// DWARF version doesn't handle the language, return -1.
369 int64_t getDefaultLowerBound() const;
371 /// getDIEEntry - Returns the debug information entry for the specified
373 DIEEntry *getDIEEntry(const MDNode *N) const {
374 return MDNodeToDIEEntryMap.lookup(N);
377 /// insertDIEEntry - Insert debug information entry into the map.
378 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
379 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
382 // getIndexTyDie - Get an anonymous type for index type.
383 DIE *getIndexTyDie();
385 // setIndexTyDie - Set D as anonymous type for index which can be reused
387 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
389 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
390 /// information entry.
391 DIEEntry *createDIEEntry(DIE &Entry);
393 /// If this is a named finished type then include it in the list of types for
394 /// the accelerator tables.
395 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
397 virtual bool isDwoUnit() const = 0;
400 class DwarfTypeUnit : public DwarfUnit {
401 uint64_t TypeSignature;
403 DwarfCompileUnit &CU;
404 MCDwarfDwoLineTable *SplitLineTable;
406 unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
407 bool isDwoUnit() const override;
410 DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
411 DwarfDebug *DW, DwarfFile *DWU,
412 MCDwarfDwoLineTable *SplitLineTable = nullptr);
414 void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
415 uint64_t getTypeSignature() const { return TypeSignature; }
416 void setType(const DIE *Ty) { this->Ty = Ty; }
418 /// Emit the header for this unit, not including the initial length field.
419 void emitHeader(const MCSymbol *ASectionSym) const override;
420 unsigned getHeaderSize() const override {
421 return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
422 sizeof(uint32_t); // Type DIE Offset
424 using DwarfUnit::initSection;
425 DwarfCompileUnit &getCU() override { return CU; }
427 } // end llvm namespace