Sink DwarfUnit::constructImportedEntityDIE into DwarfCompileUnit.
[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   /// A label at the start of the non-dwo section related to this unit.
133   MCSymbol *SectionSym;
134
135   /// The start of the unit within its section.
136   MCSymbol *LabelBegin;
137
138   /// The end of the unit within its section.
139   MCSymbol *LabelEnd;
140
141   /// Skeleton unit associated with this unit.
142   DwarfUnit *Skeleton;
143
144   DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
145             DwarfDebug *DW, DwarfFile *DWU);
146
147 public:
148   virtual ~DwarfUnit();
149
150   /// Set the skeleton unit associated with this unit.
151   void setSkeleton(DwarfUnit &Skel) { Skeleton = &Skel; }
152
153   /// Get the skeleton unit associated with this unit.
154   DwarfUnit *getSkeleton() const { return Skeleton; }
155
156   /// Pass in the SectionSym even though we could recreate it in every compile
157   /// unit (type units will have actually distinct symbols once they're in
158   /// comdat sections).
159   void initSection(const MCSection *Section, MCSymbol *SectionSym) {
160     assert(!this->Section);
161     this->Section = Section;
162     this->SectionSym = SectionSym;
163     this->LabelBegin =
164         Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
165     this->LabelEnd =
166         Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
167   }
168
169   const MCSection *getSection() const {
170     assert(Section);
171     return Section;
172   }
173
174   /// If there's a skeleton then return the section symbol for the skeleton
175   /// unit, otherwise return the section symbol for this unit.
176   MCSymbol *getLocalSectionSym() const {
177     if (Skeleton)
178       return Skeleton->getSectionSym();
179     return getSectionSym();
180   }
181
182   MCSymbol *getSectionSym() const {
183     assert(Section);
184     return SectionSym;
185   }
186
187   /// If there's a skeleton then return the begin label for the skeleton unit,
188   /// otherwise return the local label for this unit.
189   MCSymbol *getLocalLabelBegin() const {
190     if (Skeleton)
191       return Skeleton->getLabelBegin();
192     return getLabelBegin();
193   }
194
195   MCSymbol *getLabelBegin() const {
196     assert(Section);
197     return LabelBegin;
198   }
199
200   MCSymbol *getLabelEnd() const {
201     assert(Section);
202     return LabelEnd;
203   }
204
205   // Accessors.
206   unsigned getUniqueID() const { return UniqueID; }
207   uint16_t getLanguage() const { return CUNode.getLanguage(); }
208   DICompileUnit getCUNode() const { return CUNode; }
209   DIE &getUnitDie() { return UnitDie; }
210   const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
211   const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
212
213   unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
214   void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
215
216   /// hasContent - Return true if this compile unit has something to write out.
217   bool hasContent() const { return !UnitDie.getChildren().empty(); }
218
219   /// getRanges - Get the list of ranges for this unit.
220   const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
221   SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
222
223   /// addRangeList - Add an address range list to the list of range lists.
224   void addRangeList(RangeSpanList Ranges) {
225     CURangeLists.push_back(std::move(Ranges));
226   }
227
228   /// getRangeLists - Get the vector of range lists.
229   const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
230     return CURangeLists;
231   }
232   SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
233
234   /// getParentContextString - Get a string containing the language specific
235   /// context for a global name.
236   std::string getParentContextString(DIScope Context) const;
237
238   /// addGlobalName - Add a new global entity to the compile unit.
239   ///
240   void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
241
242   /// addAccelNamespace - Add a new name to the namespace accelerator table.
243   void addAccelNamespace(StringRef Name, const DIE &Die);
244
245   /// getDIE - Returns the debug information entry map slot for the
246   /// specified debug variable. We delegate the request to DwarfDebug
247   /// when the MDNode can be part of the type system, since DIEs for
248   /// the type system can be shared across CUs and the mappings are
249   /// kept in DwarfDebug.
250   DIE *getDIE(DIDescriptor D) const;
251
252   /// getDIELoc - Returns a fresh newly allocated DIELoc.
253   DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
254
255   /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
256   /// when the MDNode can be part of the type system, since DIEs for
257   /// the type system can be shared across CUs and the mappings are
258   /// kept in DwarfDebug.
259   void insertDIE(DIDescriptor Desc, DIE *D);
260
261   /// addFlag - Add a flag that is true to the DIE.
262   void addFlag(DIE &Die, dwarf::Attribute Attribute);
263
264   /// addUInt - Add an unsigned integer attribute data and value.
265   void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
266                uint64_t Integer);
267
268   void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
269
270   /// addSInt - Add an signed integer attribute data and value.
271   void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
272                int64_t Integer);
273
274   void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
275
276   /// addString - Add a string attribute data and value.
277   void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
278
279   /// addLocalString - Add a string attribute data and value.
280   void addLocalString(DIE &Die, dwarf::Attribute Attribute,
281                       StringRef Str);
282
283   /// addExpr - Add a Dwarf expression attribute data and value.
284   void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
285
286   /// addLabel - Add a Dwarf label attribute data and value.
287   void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
288                 const MCSymbol *Label);
289
290   void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
291
292   /// addLocationList - Add a Dwarf loclistptr attribute data and value.
293   void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
294
295   /// addSectionOffset - Add an offset into a section attribute data and value.
296   ///
297   void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
298
299   /// addOpAddress - Add a dwarf op address data and value using the
300   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
301   void addOpAddress(DIELoc &Die, const MCSymbol *Label);
302
303   /// addLabelDelta - Add a label delta attribute data and value.
304   void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
305                      const MCSymbol *Lo);
306
307   /// addDIEEntry - Add a DIE attribute data and value.
308   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
309
310   /// addDIEEntry - Add a DIE attribute data and value.
311   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
312
313   void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
314
315   /// addBlock - Add block data.
316   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
317
318   /// addBlock - Add block data.
319   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
320
321   /// addSourceLine - Add location information to specified debug information
322   /// entry.
323   void addSourceLine(DIE &Die, unsigned Line, StringRef File,
324                      StringRef Directory);
325   void addSourceLine(DIE &Die, DIVariable V);
326   void addSourceLine(DIE &Die, DIGlobalVariable G);
327   void addSourceLine(DIE &Die, DISubprogram SP);
328   void addSourceLine(DIE &Die, DIType Ty);
329   void addSourceLine(DIE &Die, DINameSpace NS);
330   void addSourceLine(DIE &Die, DIObjCProperty Ty);
331
332   /// addAddress - Add an address attribute to a die based on the location
333   /// provided.
334   void addAddress(DIE &Die, dwarf::Attribute Attribute,
335                   const MachineLocation &Location, bool Indirect = false);
336
337   /// addConstantValue - Add constant value entry in variable DIE.
338   void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
339   void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
340   void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
341   void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
342   void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
343
344   /// addConstantFPValue - Add constant value entry in variable DIE.
345   void addConstantFPValue(DIE &Die, const MachineOperand &MO);
346   void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
347
348   /// addTemplateParams - Add template parameters in buffer.
349   void addTemplateParams(DIE &Buffer, DIArray TParams);
350
351   /// addRegisterOp - Add register operand.
352   void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
353                           unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
354
355   /// addRegisterOffset - Add register offset.
356   void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
357
358   /// addComplexAddress - Start with the address based on the location provided,
359   /// and generate the DWARF information necessary to find the actual variable
360   /// (navigating the extra location information encoded in the type) based on
361   /// the starting location.  Add the DWARF information to the die.
362   void addComplexAddress(const DbgVariable &DV, DIE &Die,
363                          dwarf::Attribute Attribute,
364                          const MachineLocation &Location);
365
366   // FIXME: Should be reformulated in terms of addComplexAddress.
367   /// addBlockByrefAddress - Start with the address based on the location
368   /// provided, and generate the DWARF information necessary to find the
369   /// actual Block variable (navigating the Block struct) based on the
370   /// starting location.  Add the DWARF information to the die.  Obsolete,
371   /// please use addComplexAddress instead.
372   void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
373                             dwarf::Attribute Attribute,
374                             const MachineLocation &Location);
375
376   /// addVariableAddress - Add DW_AT_location attribute for a
377   /// DbgVariable based on provided MachineLocation.
378   void addVariableAddress(const DbgVariable &DV, DIE &Die,
379                           MachineLocation Location);
380
381   /// addType - Add a new type attribute to the specified entity. This takes
382   /// and attribute parameter because DW_AT_friend attributes are also
383   /// type references.
384   void addType(DIE &Entity, DIType Ty,
385                dwarf::Attribute Attribute = dwarf::DW_AT_type);
386
387   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
388   DIE *getOrCreateNameSpace(DINameSpace NS);
389
390   /// getOrCreateSubprogramDIE - Create new DIE using SP.
391   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
392
393   void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
394   void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
395   void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
396
397   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
398   /// given DIType.
399   DIE *getOrCreateTypeDIE(const MDNode *N);
400
401   /// getOrCreateContextDIE - Get context owner's DIE.
402   DIE *createTypeDIE(DICompositeType Ty);
403
404   /// getOrCreateContextDIE - Get context owner's DIE.
405   DIE *getOrCreateContextDIE(DIScope Context);
406
407   /// constructContainingTypeDIEs - Construct DIEs for types that contain
408   /// vtables.
409   void constructContainingTypeDIEs();
410
411   /// constructSubprogramArguments - Construct function argument DIEs.
412   void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
413
414   /// Create a DIE with the given Tag, add the DIE to its parent, and
415   /// call insertDIE if MD is not null.
416   DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
417                        DIDescriptor N = DIDescriptor());
418
419   /// Compute the size of a header for this unit, not including the initial
420   /// length field.
421   virtual unsigned getHeaderSize() const {
422     return sizeof(int16_t) + // DWARF version number
423            sizeof(int32_t) + // Offset Into Abbrev. Section
424            sizeof(int8_t);   // Pointer Size (in bytes)
425   }
426
427   /// Emit the header for this unit, not including the initial length field.
428   virtual void emitHeader(const MCSymbol *ASectionSym) const;
429
430   virtual DwarfCompileUnit &getCU() = 0;
431
432   /// constructTypeDIE - Construct type DIE from DICompositeType.
433   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
434
435 protected:
436   /// getOrCreateStaticMemberDIE - Create new static data member DIE.
437   DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
438
439   /// Look up the source ID with the given directory and source file names. If
440   /// none currently exists, create a new ID and insert it in the line table.
441   virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
442
443   /// resolve - Look in the DwarfDebug map for the MDNode that
444   /// corresponds to the reference.
445   template <typename T> T resolve(DIRef<T> Ref) const {
446     return DD->resolve(Ref);
447   }
448
449 private:
450   /// constructTypeDIE - Construct basic type die from DIBasicType.
451   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
452
453   /// constructTypeDIE - Construct derived type die from DIDerivedType.
454   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
455
456   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
457   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
458
459   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
460   void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
461
462   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
463   void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
464
465   /// constructMemberDIE - Construct member DIE from DIDerivedType.
466   void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
467
468   /// constructTemplateTypeParameterDIE - Construct new DIE for the given
469   /// DITemplateTypeParameter.
470   void constructTemplateTypeParameterDIE(DIE &Buffer,
471                                          DITemplateTypeParameter TP);
472
473   /// constructTemplateValueParameterDIE - Construct new DIE for the given
474   /// DITemplateValueParameter.
475   void constructTemplateValueParameterDIE(DIE &Buffer,
476                                           DITemplateValueParameter TVP);
477
478   /// getLowerBoundDefault - Return the default lower bound for an array. If the
479   /// DWARF version doesn't handle the language, return -1.
480   int64_t getDefaultLowerBound() const;
481
482   /// getDIEEntry - Returns the debug information entry for the specified
483   /// debug variable.
484   DIEEntry *getDIEEntry(const MDNode *N) const {
485     return MDNodeToDIEEntryMap.lookup(N);
486   }
487
488   /// insertDIEEntry - Insert debug information entry into the map.
489   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
490     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
491   }
492
493   // getIndexTyDie - Get an anonymous type for index type.
494   DIE *getIndexTyDie() { return IndexTyDie; }
495
496   // setIndexTyDie - Set D as anonymous type for index which can be reused
497   // later.
498   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
499
500   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
501   /// information entry.
502   DIEEntry *createDIEEntry(DIE &Entry);
503
504   /// If this is a named finished type then include it in the list of types for
505   /// the accelerator tables.
506   void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
507 };
508
509 class DwarfTypeUnit : public DwarfUnit {
510 private:
511   uint64_t TypeSignature;
512   const DIE *Ty;
513   DwarfCompileUnit &CU;
514   MCDwarfDwoLineTable *SplitLineTable;
515
516 public:
517   DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
518                 DwarfDebug *DW, DwarfFile *DWU,
519                 MCDwarfDwoLineTable *SplitLineTable = nullptr);
520
521   void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
522   uint64_t getTypeSignature() const { return TypeSignature; }
523   void setType(const DIE *Ty) { this->Ty = Ty; }
524
525   /// Emit the header for this unit, not including the initial length field.
526   void emitHeader(const MCSymbol *ASectionSym) const override;
527   unsigned getHeaderSize() const override {
528     return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
529            sizeof(uint32_t);                               // Type DIE Offset
530   }
531   void initSection(const MCSection *Section);
532   // Bring in the base function (taking two args, including the section symbol)
533   // for use when building DWO type units (they don't go in unique comdat
534   // sections)
535   using DwarfUnit::initSection;
536   DwarfCompileUnit &getCU() override { return CU; }
537
538 protected:
539   unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
540 };
541 } // end llvm namespace
542 #endif