Update test to use llvm-readobj. NFC.
[oota-llvm.git] / lib / CodeGen / AsmPrinter / DwarfUnit.h
1 //===-- llvm/CodeGen/DwarfUnit.h - Dwarf Compile Unit ---*- C++ -*--===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file contains support for writing dwarf compile unit.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFUNIT_H
15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFUNIT_H
16
17 #include "DIE.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"
28
29 namespace llvm {
30
31 class MachineLocation;
32 class MachineOperand;
33 class ConstantInt;
34 class ConstantFP;
35 class DbgVariable;
36 class DwarfCompileUnit;
37
38 // Data structure to hold a range for range lists.
39 class RangeSpan {
40 public:
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; }
45
46 private:
47   const MCSymbol *Start, *End;
48 };
49
50 class RangeSpanList {
51 private:
52   // Index for locating within the debug_range section this particular span.
53   MCSymbol *RangeSym;
54   // List of ranges.
55   SmallVector<RangeSpan, 2> Ranges;
56
57 public:
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); }
62 };
63
64 //===----------------------------------------------------------------------===//
65 /// Unit - This dwarf writer support class manages information associated
66 /// with a source file.
67 class DwarfUnit {
68 protected:
69   /// UniqueID - a numeric ID unique among all CUs in the module
70   unsigned UniqueID;
71
72   /// Node - MDNode for the compile unit.
73   DICompileUnit CUNode;
74
75   /// Unit debug information entry.
76   DIE UnitDie;
77
78   /// Offset of the UnitDie from beginning of debug info section.
79   unsigned DebugInfoOffset;
80
81   /// Asm - Target of Dwarf emission.
82   AsmPrinter *Asm;
83
84   // Holders for some common dwarf information.
85   DwarfDebug *DD;
86   DwarfFile *DU;
87
88   /// IndexTyDie - An anonymous type for index type.  Owned by UnitDie.
89   DIE *IndexTyDie;
90
91   /// MDNodeToDieMap - Tracks the mapping of unit level debug information
92   /// variables to debug information entries.
93   DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
94
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;
98
99   /// GlobalNames - A map of globally visible named entities for this unit.
100   StringMap<const DIE *> GlobalNames;
101
102   /// GlobalTypes - A map of globally visible types for this unit.
103   StringMap<const DIE *> GlobalTypes;
104
105   /// DIEBlocks - A list of all the DIEBlocks in use.
106   std::vector<DIEBlock *> DIEBlocks;
107   
108   /// DIELocs - A list of all the DIELocs in use.
109   std::vector<DIELoc *> DIELocs;
110
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;
115
116   // List of ranges for a given compile unit.
117   SmallVector<RangeSpan, 1> CURanges;
118
119   // List of range lists for a given compile unit, separate from the ranges for
120   // the CU itself.
121   SmallVector<RangeSpanList, 1> CURangeLists;
122
123   // DIEValueAllocator - All DIEValues are allocated through this allocator.
124   BumpPtrAllocator DIEValueAllocator;
125
126   // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
127   DIEInteger *DIEIntegerOne;
128
129   /// The section this unit will be emitted in.
130   const MCSection *Section;
131
132   /// The start of the unit within its section.
133   MCSymbol *LabelBegin;
134
135   DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
136             DwarfDebug *DW, DwarfFile *DWU);
137
138   void initSection(const MCSection *Section);
139 public:
140   virtual ~DwarfUnit();
141
142   const MCSection *getSection() const {
143     assert(Section);
144     return Section;
145   }
146
147   MCSymbol *getLabelBegin() const {
148     assert(Section);
149     return LabelBegin;
150   }
151
152   // Accessors.
153   unsigned getUniqueID() const { return UniqueID; }
154   uint16_t getLanguage() const { return CUNode.getLanguage(); }
155   DICompileUnit getCUNode() const { return CUNode; }
156   DIE &getUnitDie() { return UnitDie; }
157   const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
158   const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
159
160   unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
161   void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
162
163   /// hasContent - Return true if this compile unit has something to write out.
164   bool hasContent() const { return !UnitDie.getChildren().empty(); }
165
166   /// getRanges - Get the list of ranges for this unit.
167   const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
168   SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
169
170   /// addRangeList - Add an address range list to the list of range lists.
171   void addRangeList(RangeSpanList Ranges) {
172     CURangeLists.push_back(std::move(Ranges));
173   }
174
175   /// getRangeLists - Get the vector of range lists.
176   const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
177     return CURangeLists;
178   }
179   SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
180
181   /// getParentContextString - Get a string containing the language specific
182   /// context for a global name.
183   std::string getParentContextString(DIScope Context) const;
184
185   /// addGlobalName - Add a new global entity to the compile unit.
186   ///
187   void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
188
189   /// addAccelNamespace - Add a new name to the namespace accelerator table.
190   void addAccelNamespace(StringRef Name, const DIE &Die);
191
192   /// getDIE - Returns the debug information entry map slot for the
193   /// specified debug variable. We delegate the request to DwarfDebug
194   /// when the MDNode can be part of the type system, since DIEs for
195   /// the type system can be shared across CUs and the mappings are
196   /// kept in DwarfDebug.
197   DIE *getDIE(DIDescriptor D) const;
198
199   /// getDIELoc - Returns a fresh newly allocated DIELoc.
200   DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
201
202   /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
203   /// when the MDNode can be part of the type system, since DIEs for
204   /// the type system can be shared across CUs and the mappings are
205   /// kept in DwarfDebug.
206   void insertDIE(DIDescriptor Desc, DIE *D);
207
208   /// addFlag - Add a flag that is true to the DIE.
209   void addFlag(DIE &Die, dwarf::Attribute Attribute);
210
211   /// addUInt - Add an unsigned integer attribute data and value.
212   void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
213                uint64_t Integer);
214
215   void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
216
217   /// addSInt - Add an signed integer attribute data and value.
218   void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
219                int64_t Integer);
220
221   void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
222
223   /// addString - Add a string attribute data and value.
224   void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
225
226   /// addLocalString - Add a string attribute data and value.
227   void addLocalString(DIE &Die, dwarf::Attribute Attribute,
228                       StringRef Str);
229
230   /// addExpr - Add a Dwarf expression attribute data and value.
231   void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
232
233   /// addLabel - Add a Dwarf label attribute data and value.
234   void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
235                 const MCSymbol *Label);
236
237   void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
238
239   /// addLocationList - Add a Dwarf loclistptr attribute data and value.
240   void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
241
242   /// addSectionOffset - Add an offset into a section attribute data and value.
243   ///
244   void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
245
246   /// addOpAddress - Add a dwarf op address data and value using the
247   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
248   void addOpAddress(DIELoc &Die, const MCSymbol *Label);
249
250   /// addLabelDelta - Add a label delta attribute data and value.
251   void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
252                      const MCSymbol *Lo);
253
254   /// addDIEEntry - Add a DIE attribute data and value.
255   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
256
257   /// addDIEEntry - Add a DIE attribute data and value.
258   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
259
260   void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
261
262   /// addBlock - Add block data.
263   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
264
265   /// addBlock - Add block data.
266   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
267
268   /// addSourceLine - Add location information to specified debug information
269   /// entry.
270   void addSourceLine(DIE &Die, unsigned Line, StringRef File,
271                      StringRef Directory);
272   void addSourceLine(DIE &Die, DIVariable V);
273   void addSourceLine(DIE &Die, DIGlobalVariable G);
274   void addSourceLine(DIE &Die, DISubprogram SP);
275   void addSourceLine(DIE &Die, DIType Ty);
276   void addSourceLine(DIE &Die, DINameSpace NS);
277   void addSourceLine(DIE &Die, DIObjCProperty Ty);
278
279   /// addAddress - Add an address attribute to a die based on the location
280   /// provided.
281   void addAddress(DIE &Die, dwarf::Attribute Attribute,
282                   const MachineLocation &Location, bool Indirect = false);
283
284   /// addConstantValue - Add constant value entry in variable DIE.
285   void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
286   void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
287   void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
288   void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
289   void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
290
291   /// addConstantFPValue - Add constant value entry in variable DIE.
292   void addConstantFPValue(DIE &Die, const MachineOperand &MO);
293   void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
294
295   /// addTemplateParams - Add template parameters in buffer.
296   void addTemplateParams(DIE &Buffer, DIArray TParams);
297
298   /// addRegisterOp - Add register operand.
299   void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
300                           unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
301
302   /// addRegisterOffset - Add register offset.
303   void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
304
305   /// addComplexAddress - Start with the address based on the location provided,
306   /// and generate the DWARF information necessary to find the actual variable
307   /// (navigating the extra location information encoded in the type) based on
308   /// the starting location.  Add the DWARF information to the die.
309   void addComplexAddress(const DbgVariable &DV, DIE &Die,
310                          dwarf::Attribute Attribute,
311                          const MachineLocation &Location);
312
313   // FIXME: Should be reformulated in terms of addComplexAddress.
314   /// addBlockByrefAddress - Start with the address based on the location
315   /// provided, and generate the DWARF information necessary to find the
316   /// actual Block variable (navigating the Block struct) based on the
317   /// starting location.  Add the DWARF information to the die.  Obsolete,
318   /// please use addComplexAddress instead.
319   void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
320                             dwarf::Attribute Attribute,
321                             const MachineLocation &Location);
322
323   /// addVariableAddress - Add DW_AT_location attribute for a
324   /// DbgVariable based on provided MachineLocation.
325   void addVariableAddress(const DbgVariable &DV, DIE &Die,
326                           MachineLocation Location);
327
328   /// addType - Add a new type attribute to the specified entity. This takes
329   /// and attribute parameter because DW_AT_friend attributes are also
330   /// type references.
331   void addType(DIE &Entity, DIType Ty,
332                dwarf::Attribute Attribute = dwarf::DW_AT_type);
333
334   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
335   DIE *getOrCreateNameSpace(DINameSpace NS);
336
337   /// getOrCreateSubprogramDIE - Create new DIE using SP.
338   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
339
340   void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
341   void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
342   void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
343
344   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
345   /// given DIType.
346   DIE *getOrCreateTypeDIE(const MDNode *N);
347
348   /// getOrCreateContextDIE - Get context owner's DIE.
349   DIE *createTypeDIE(DICompositeType Ty);
350
351   /// getOrCreateContextDIE - Get context owner's DIE.
352   DIE *getOrCreateContextDIE(DIScope Context);
353
354   /// constructContainingTypeDIEs - Construct DIEs for types that contain
355   /// vtables.
356   void constructContainingTypeDIEs();
357
358   /// constructSubprogramArguments - Construct function argument DIEs.
359   void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
360
361   /// Create a DIE with the given Tag, add the DIE to its parent, and
362   /// call insertDIE if MD is not null.
363   DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
364                        DIDescriptor N = DIDescriptor());
365
366   /// Compute the size of a header for this unit, not including the initial
367   /// length field.
368   virtual unsigned getHeaderSize() const {
369     return sizeof(int16_t) + // DWARF version number
370            sizeof(int32_t) + // Offset Into Abbrev. Section
371            sizeof(int8_t);   // Pointer Size (in bytes)
372   }
373
374   /// Emit the header for this unit, not including the initial length field.
375   virtual void emitHeader(const MCSymbol *ASectionSym) const;
376
377   virtual DwarfCompileUnit &getCU() = 0;
378
379   /// constructTypeDIE - Construct type DIE from DICompositeType.
380   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
381
382 protected:
383   /// getOrCreateStaticMemberDIE - Create new static data member DIE.
384   DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
385
386   /// Look up the source ID with the given directory and source file names. If
387   /// none currently exists, create a new ID and insert it in the line table.
388   virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
389
390   /// resolve - Look in the DwarfDebug map for the MDNode that
391   /// corresponds to the reference.
392   template <typename T> T resolve(DIRef<T> Ref) const {
393     return DD->resolve(Ref);
394   }
395
396 private:
397   /// constructTypeDIE - Construct basic type die from DIBasicType.
398   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
399
400   /// constructTypeDIE - Construct derived type die from DIDerivedType.
401   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
402
403   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
404   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
405
406   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
407   void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
408
409   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
410   void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
411
412   /// constructMemberDIE - Construct member DIE from DIDerivedType.
413   void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
414
415   /// constructTemplateTypeParameterDIE - Construct new DIE for the given
416   /// DITemplateTypeParameter.
417   void constructTemplateTypeParameterDIE(DIE &Buffer,
418                                          DITemplateTypeParameter TP);
419
420   /// constructTemplateValueParameterDIE - Construct new DIE for the given
421   /// DITemplateValueParameter.
422   void constructTemplateValueParameterDIE(DIE &Buffer,
423                                           DITemplateValueParameter TVP);
424
425   /// getLowerBoundDefault - Return the default lower bound for an array. If the
426   /// DWARF version doesn't handle the language, return -1.
427   int64_t getDefaultLowerBound() const;
428
429   /// getDIEEntry - Returns the debug information entry for the specified
430   /// debug variable.
431   DIEEntry *getDIEEntry(const MDNode *N) const {
432     return MDNodeToDIEEntryMap.lookup(N);
433   }
434
435   /// insertDIEEntry - Insert debug information entry into the map.
436   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
437     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
438   }
439
440   // getIndexTyDie - Get an anonymous type for index type.
441   DIE *getIndexTyDie() { return IndexTyDie; }
442
443   // setIndexTyDie - Set D as anonymous type for index which can be reused
444   // later.
445   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
446
447   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
448   /// information entry.
449   DIEEntry *createDIEEntry(DIE &Entry);
450
451   /// If this is a named finished type then include it in the list of types for
452   /// the accelerator tables.
453   void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
454 };
455
456 class DwarfTypeUnit : public DwarfUnit {
457 private:
458   uint64_t TypeSignature;
459   const DIE *Ty;
460   DwarfCompileUnit &CU;
461   MCDwarfDwoLineTable *SplitLineTable;
462
463 public:
464   DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
465                 DwarfDebug *DW, DwarfFile *DWU,
466                 MCDwarfDwoLineTable *SplitLineTable = nullptr);
467
468   void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
469   uint64_t getTypeSignature() const { return TypeSignature; }
470   void setType(const DIE *Ty) { this->Ty = Ty; }
471
472   /// Emit the header for this unit, not including the initial length field.
473   void emitHeader(const MCSymbol *ASectionSym) const override;
474   unsigned getHeaderSize() const override {
475     return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
476            sizeof(uint32_t);                               // Type DIE Offset
477   }
478   using DwarfUnit::initSection;
479   DwarfCompileUnit &getCU() override { return CU; }
480
481 protected:
482   unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
483 };
484 } // end llvm namespace
485 #endif