Sink and coalesce DwarfDebug.cpp::addSectionLabel and DwarfUnit::addSectionLabel...
[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   /// addSectionDelta - Add a label delta attribute data and value.
304   void addSectionDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
305                        const MCSymbol *Lo);
306
307   /// addLabelDelta - Add a label delta attribute data and value.
308   void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
309                      const MCSymbol *Lo);
310
311   /// addDIEEntry - Add a DIE attribute data and value.
312   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
313
314   /// addDIEEntry - Add a DIE attribute data and value.
315   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
316
317   void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
318
319   /// addBlock - Add block data.
320   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
321
322   /// addBlock - Add block data.
323   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
324
325   /// addSourceLine - Add location information to specified debug information
326   /// entry.
327   void addSourceLine(DIE &Die, unsigned Line, StringRef File,
328                      StringRef Directory);
329   void addSourceLine(DIE &Die, DIVariable V);
330   void addSourceLine(DIE &Die, DIGlobalVariable G);
331   void addSourceLine(DIE &Die, DISubprogram SP);
332   void addSourceLine(DIE &Die, DIType Ty);
333   void addSourceLine(DIE &Die, DINameSpace NS);
334   void addSourceLine(DIE &Die, DIObjCProperty Ty);
335
336   /// addAddress - Add an address attribute to a die based on the location
337   /// provided.
338   void addAddress(DIE &Die, dwarf::Attribute Attribute,
339                   const MachineLocation &Location, bool Indirect = false);
340
341   /// addConstantValue - Add constant value entry in variable DIE.
342   void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
343   void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
344   void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
345   void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
346   void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
347
348   /// addConstantFPValue - Add constant value entry in variable DIE.
349   void addConstantFPValue(DIE &Die, const MachineOperand &MO);
350   void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
351
352   /// addTemplateParams - Add template parameters in buffer.
353   void addTemplateParams(DIE &Buffer, DIArray TParams);
354
355   /// addRegisterOp - Add register operand.
356   void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
357                           unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
358
359   /// addRegisterOffset - Add register offset.
360   void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
361
362   /// addComplexAddress - Start with the address based on the location provided,
363   /// and generate the DWARF information necessary to find the actual variable
364   /// (navigating the extra location information encoded in the type) based on
365   /// the starting location.  Add the DWARF information to the die.
366   void addComplexAddress(const DbgVariable &DV, DIE &Die,
367                          dwarf::Attribute Attribute,
368                          const MachineLocation &Location);
369
370   // FIXME: Should be reformulated in terms of addComplexAddress.
371   /// addBlockByrefAddress - Start with the address based on the location
372   /// provided, and generate the DWARF information necessary to find the
373   /// actual Block variable (navigating the Block struct) based on the
374   /// starting location.  Add the DWARF information to the die.  Obsolete,
375   /// please use addComplexAddress instead.
376   void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
377                             dwarf::Attribute Attribute,
378                             const MachineLocation &Location);
379
380   /// addVariableAddress - Add DW_AT_location attribute for a
381   /// DbgVariable based on provided MachineLocation.
382   void addVariableAddress(const DbgVariable &DV, DIE &Die,
383                           MachineLocation Location);
384
385   /// addType - Add a new type attribute to the specified entity. This takes
386   /// and attribute parameter because DW_AT_friend attributes are also
387   /// type references.
388   void addType(DIE &Entity, DIType Ty,
389                dwarf::Attribute Attribute = dwarf::DW_AT_type);
390
391   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
392   DIE *getOrCreateNameSpace(DINameSpace NS);
393
394   /// getOrCreateSubprogramDIE - Create new DIE using SP.
395   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
396
397   void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
398   void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
399   void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
400
401   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
402   /// given DIType.
403   DIE *getOrCreateTypeDIE(const MDNode *N);
404
405   /// getOrCreateContextDIE - Get context owner's DIE.
406   DIE *createTypeDIE(DICompositeType Ty);
407
408   /// getOrCreateContextDIE - Get context owner's DIE.
409   DIE *getOrCreateContextDIE(DIScope Context);
410
411   /// constructContainingTypeDIEs - Construct DIEs for types that contain
412   /// vtables.
413   void constructContainingTypeDIEs();
414
415   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
416   std::unique_ptr<DIE> constructVariableDIE(DbgVariable &DV,
417                                             bool Abstract = false);
418
419   /// constructSubprogramArguments - Construct function argument DIEs.
420   void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
421
422   /// \brief Construct import_module DIE.
423   std::unique_ptr<DIE>
424   constructImportedEntityDIE(const DIImportedEntity &Module);
425
426   /// Create a DIE with the given Tag, add the DIE to its parent, and
427   /// call insertDIE if MD is not null.
428   DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
429                        DIDescriptor N = DIDescriptor());
430
431   /// Compute the size of a header for this unit, not including the initial
432   /// length field.
433   virtual unsigned getHeaderSize() const {
434     return sizeof(int16_t) + // DWARF version number
435            sizeof(int32_t) + // Offset Into Abbrev. Section
436            sizeof(int8_t);   // Pointer Size (in bytes)
437   }
438
439   /// Emit the header for this unit, not including the initial length field.
440   virtual void emitHeader(const MCSymbol *ASectionSym) const;
441
442   virtual DwarfCompileUnit &getCU() = 0;
443
444   /// constructTypeDIE - Construct type DIE from DICompositeType.
445   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
446
447 protected:
448   /// getOrCreateStaticMemberDIE - Create new static data member DIE.
449   DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
450
451   /// Look up the source ID with the given directory and source file names. If
452   /// none currently exists, create a new ID and insert it in the line table.
453   virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
454
455 private:
456   /// \brief Construct a DIE for the given DbgVariable without initializing the
457   /// DbgVariable's DIE reference.
458   std::unique_ptr<DIE> constructVariableDIEImpl(const DbgVariable &DV,
459                                                 bool Abstract);
460
461   /// constructTypeDIE - Construct basic type die from DIBasicType.
462   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
463
464   /// constructTypeDIE - Construct derived type die from DIDerivedType.
465   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
466
467   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
468   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
469
470   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
471   void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
472
473   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
474   void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
475
476   /// constructMemberDIE - Construct member DIE from DIDerivedType.
477   void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
478
479   /// constructTemplateTypeParameterDIE - Construct new DIE for the given
480   /// DITemplateTypeParameter.
481   void constructTemplateTypeParameterDIE(DIE &Buffer,
482                                          DITemplateTypeParameter TP);
483
484   /// constructTemplateValueParameterDIE - Construct new DIE for the given
485   /// DITemplateValueParameter.
486   void constructTemplateValueParameterDIE(DIE &Buffer,
487                                           DITemplateValueParameter TVP);
488
489   /// getLowerBoundDefault - Return the default lower bound for an array. If the
490   /// DWARF version doesn't handle the language, return -1.
491   int64_t getDefaultLowerBound() const;
492
493   /// getDIEEntry - Returns the debug information entry for the specified
494   /// debug variable.
495   DIEEntry *getDIEEntry(const MDNode *N) const {
496     return MDNodeToDIEEntryMap.lookup(N);
497   }
498
499   /// insertDIEEntry - Insert debug information entry into the map.
500   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
501     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
502   }
503
504   // getIndexTyDie - Get an anonymous type for index type.
505   DIE *getIndexTyDie() { return IndexTyDie; }
506
507   // setIndexTyDie - Set D as anonymous type for index which can be reused
508   // later.
509   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
510
511   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
512   /// information entry.
513   DIEEntry *createDIEEntry(DIE &Entry);
514
515   /// resolve - Look in the DwarfDebug map for the MDNode that
516   /// corresponds to the reference.
517   template <typename T> T resolve(DIRef<T> Ref) const {
518     return DD->resolve(Ref);
519   }
520
521   /// If this is a named finished type then include it in the list of types for
522   /// the accelerator tables.
523   void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
524 };
525
526 class DwarfTypeUnit : public DwarfUnit {
527 private:
528   uint64_t TypeSignature;
529   const DIE *Ty;
530   DwarfCompileUnit &CU;
531   MCDwarfDwoLineTable *SplitLineTable;
532
533 public:
534   DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
535                 DwarfDebug *DW, DwarfFile *DWU,
536                 MCDwarfDwoLineTable *SplitLineTable = nullptr);
537
538   void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
539   uint64_t getTypeSignature() const { return TypeSignature; }
540   void setType(const DIE *Ty) { this->Ty = Ty; }
541
542   /// Emit the header for this unit, not including the initial length field.
543   void emitHeader(const MCSymbol *ASectionSym) const override;
544   unsigned getHeaderSize() const override {
545     return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
546            sizeof(uint32_t);                               // Type DIE Offset
547   }
548   void initSection(const MCSection *Section);
549   // Bring in the base function (taking two args, including the section symbol)
550   // for use when building DWO type units (they don't go in unique comdat
551   // sections)
552   using DwarfUnit::initSection;
553   DwarfCompileUnit &getCU() override { return CU; }
554
555 protected:
556   unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
557 };
558 } // end llvm namespace
559 #endif