comparison lib/CodeGen/AsmPrinter/DwarfUnit.h @ 33:e4204d083e25

LLVM 3.5
author Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
date Thu, 12 Dec 2013 14:32:10 +0900
parents
children 54457678186b
comparison
equal deleted inserted replaced
1:f783a2dd24b1 33:e4204d083e25
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 CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
15 #define CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_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/OwningPtr.h"
22 #include "llvm/ADT/StringMap.h"
23 #include "llvm/DebugInfo.h"
24 #include "llvm/MC/MCExpr.h"
25 #include "llvm/MC/MCSection.h"
26
27 namespace llvm {
28
29 class MachineLocation;
30 class MachineOperand;
31 class ConstantInt;
32 class ConstantFP;
33 class DbgVariable;
34
35 // Data structure to hold a range for range lists.
36 class RangeSpan {
37 public:
38 RangeSpan(MCSymbol *S, MCSymbol *E) : Start(S), End(E) {}
39 const MCSymbol *getStart() const { return Start; }
40 const MCSymbol *getEnd() const { return End; }
41
42 private:
43 const MCSymbol *Start, *End;
44 };
45
46 class RangeSpanList {
47 private:
48 // Index for locating within the debug_range section this particular span.
49 MCSymbol *RangeSym;
50 // List of ranges.
51 SmallVector<RangeSpan, 2> Ranges;
52
53 public:
54 RangeSpanList(MCSymbol *Sym) : RangeSym(Sym) {}
55 MCSymbol *getSym() const { return RangeSym; }
56 const SmallVectorImpl<RangeSpan> &getRanges() const { return Ranges; }
57 void addRange(RangeSpan Range) { Ranges.push_back(Range); }
58 };
59
60 //===----------------------------------------------------------------------===//
61 /// Unit - This dwarf writer support class manages information associated
62 /// with a source file.
63 class DwarfUnit {
64 protected:
65 /// UniqueID - a numeric ID unique among all CUs in the module
66 unsigned UniqueID;
67
68 /// Node - MDNode for the compile unit.
69 DICompileUnit Node;
70
71 /// Unit debug information entry.
72 const OwningPtr<DIE> UnitDie;
73
74 /// Offset of the UnitDie from beginning of debug info section.
75 unsigned DebugInfoOffset;
76
77 /// Asm - Target of Dwarf emission.
78 AsmPrinter *Asm;
79
80 // Holders for some common dwarf information.
81 DwarfDebug *DD;
82 DwarfFile *DU;
83
84 /// IndexTyDie - An anonymous type for index type. Owned by UnitDie.
85 DIE *IndexTyDie;
86
87 /// MDNodeToDieMap - Tracks the mapping of unit level debug information
88 /// variables to debug information entries.
89 DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
90
91 /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
92 /// descriptors to debug information entries using a DIEEntry proxy.
93 DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
94
95 /// GlobalNames - A map of globally visible named entities for this unit.
96 StringMap<const DIE *> GlobalNames;
97
98 /// GlobalTypes - A map of globally visible types for this unit.
99 StringMap<const DIE *> GlobalTypes;
100
101 /// AccelNames - A map of names for the name accelerator table.
102 StringMap<std::vector<const DIE *> > AccelNames;
103
104 /// AccelObjC - A map of objc spec for the objc accelerator table.
105 StringMap<std::vector<const DIE *> > AccelObjC;
106
107 /// AccelNamespace - A map of names for the namespace accelerator table.
108 StringMap<std::vector<const DIE *> > AccelNamespace;
109
110 /// AccelTypes - A map of names for the type accelerator table.
111 StringMap<std::vector<std::pair<const DIE *, unsigned> > > AccelTypes;
112
113 /// DIEBlocks - A list of all the DIEBlocks in use.
114 std::vector<DIEBlock *> DIEBlocks;
115
116 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
117 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
118 /// corresponds to the MDNode mapped with the subprogram DIE.
119 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
120
121 // List of range lists for a given compile unit, separate from the ranges for
122 // the CU itself.
123 SmallVector<RangeSpanList, 1> CURangeLists;
124
125 // DIEValueAllocator - All DIEValues are allocated through this allocator.
126 BumpPtrAllocator DIEValueAllocator;
127
128 // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
129 DIEInteger *DIEIntegerOne;
130
131 /// The section this unit will be emitted in.
132 const MCSection *Section;
133
134 /// A label at the start of the non-dwo section related to this unit.
135 MCSymbol *SectionSym;
136
137 /// The start of the unit within its section.
138 MCSymbol *LabelBegin;
139
140 /// The end of the unit within its section.
141 MCSymbol *LabelEnd;
142
143 /// The label for the start of the range sets for the elements of this unit.
144 MCSymbol *LabelRange;
145
146 DwarfUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
147 DwarfDebug *DW, DwarfFile *DWU);
148
149 public:
150 virtual ~DwarfUnit();
151
152 /// Pass in the SectionSym even though we could recreate it in every compile
153 /// unit (type units will have actually distinct symbols once they're in
154 /// comdat sections).
155 void initSection(const MCSection *Section, MCSymbol *SectionSym) {
156 assert(!this->Section);
157 this->Section = Section;
158 this->SectionSym = SectionSym;
159 this->LabelBegin =
160 Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
161 this->LabelEnd =
162 Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
163 this->LabelRange = Asm->GetTempSymbol("gnu_ranges", getUniqueID());
164 }
165
166 const MCSection *getSection() const {
167 assert(Section);
168 return Section;
169 }
170
171 MCSymbol *getSectionSym() const {
172 assert(Section);
173 return SectionSym;
174 }
175
176 MCSymbol *getLabelBegin() const {
177 assert(Section);
178 return LabelBegin;
179 }
180
181 MCSymbol *getLabelEnd() const {
182 assert(Section);
183 return LabelEnd;
184 }
185
186 MCSymbol *getLabelRange() const {
187 assert(Section);
188 return LabelRange;
189 }
190
191 // Accessors.
192 unsigned getUniqueID() const { return UniqueID; }
193 virtual uint16_t getLanguage() const = 0;
194 DICompileUnit getNode() const { return Node; }
195 DIE *getUnitDie() const { return UnitDie.get(); }
196 const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
197 const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
198
199 const StringMap<std::vector<const DIE *> > &getAccelNames() const {
200 return AccelNames;
201 }
202 const StringMap<std::vector<const DIE *> > &getAccelObjC() const {
203 return AccelObjC;
204 }
205 const StringMap<std::vector<const DIE *> > &getAccelNamespace() const {
206 return AccelNamespace;
207 }
208 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &
209 getAccelTypes() const {
210 return AccelTypes;
211 }
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 /// addRangeList - Add an address range list to the list of range lists.
220 void addRangeList(RangeSpanList Ranges) { CURangeLists.push_back(Ranges); }
221
222 /// getRangeLists - Get the vector of range lists.
223 const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
224 return CURangeLists;
225 }
226 SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
227
228 /// getParentContextString - Get a string containing the language specific
229 /// context for a global name.
230 std::string getParentContextString(DIScope Context) const;
231
232 /// addGlobalName - Add a new global entity to the compile unit.
233 ///
234 void addGlobalName(StringRef Name, DIE *Die, DIScope Context);
235
236 /// addAccelName - Add a new name to the name accelerator table.
237 void addAccelName(StringRef Name, const DIE *Die);
238
239 /// addAccelObjC - Add a new name to the ObjC accelerator table.
240 void addAccelObjC(StringRef Name, const DIE *Die);
241
242 /// addAccelNamespace - Add a new name to the namespace accelerator table.
243 void addAccelNamespace(StringRef Name, const DIE *Die);
244
245 /// addAccelType - Add a new type to the type accelerator table.
246 void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> Die);
247
248 /// getDIE - Returns the debug information entry map slot for the
249 /// specified debug variable. We delegate the request to DwarfDebug
250 /// when the MDNode can be part of the type system, since DIEs for
251 /// the type system can be shared across CUs and the mappings are
252 /// kept in DwarfDebug.
253 DIE *getDIE(DIDescriptor D) const;
254
255 /// getDIEBlock - Returns a fresh newly allocated DIEBlock.
256 DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
257
258 /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
259 /// when the MDNode can be part of the type system, since DIEs for
260 /// the type system can be shared across CUs and the mappings are
261 /// kept in DwarfDebug.
262 void insertDIE(DIDescriptor Desc, DIE *D);
263
264 /// addDie - Adds or interns the DIE to the compile unit.
265 ///
266 void addDie(DIE *Buffer) { UnitDie->addChild(Buffer); }
267
268 /// addFlag - Add a flag that is true to the DIE.
269 void addFlag(DIE *Die, dwarf::Attribute Attribute);
270
271 /// addUInt - Add an unsigned integer attribute data and value.
272 void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
273 uint64_t Integer);
274
275 void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
276
277 /// addSInt - Add an signed integer attribute data and value.
278 void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
279 int64_t Integer);
280
281 void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
282
283 /// addString - Add a string attribute data and value.
284 void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
285
286 /// addLocalString - Add a string attribute data and value.
287 void addLocalString(DIE *Die, dwarf::Attribute Attribute,
288 const StringRef Str);
289
290 /// addExpr - Add a Dwarf expression attribute data and value.
291 void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
292
293 /// addLabel - Add a Dwarf label attribute data and value.
294 void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
295 const MCSymbol *Label);
296
297 void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
298
299 /// addSectionLabel - Add a Dwarf section label attribute data and value.
300 ///
301 void addSectionLabel(DIE *Die, dwarf::Attribute Attribute,
302 const MCSymbol *Label);
303
304 /// addSectionOffset - Add an offset into a section attribute data and value.
305 ///
306 void addSectionOffset(DIE *Die, dwarf::Attribute Attribute, uint64_t Integer);
307
308 /// addOpAddress - Add a dwarf op address data and value using the
309 /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
310 void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
311
312 /// addSectionDelta - Add a label delta attribute data and value.
313 void addSectionDelta(DIE *Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
314 const MCSymbol *Lo);
315
316 /// addDIEEntry - Add a DIE attribute data and value.
317 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
318
319 /// addDIEEntry - Add a DIE attribute data and value.
320 void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
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, DIVariable V);
328 void addSourceLine(DIE *Die, DIGlobalVariable G);
329 void addSourceLine(DIE *Die, DISubprogram SP);
330 void addSourceLine(DIE *Die, DIType Ty);
331 void addSourceLine(DIE *Die, DINameSpace NS);
332 void addSourceLine(DIE *Die, DIObjCProperty Ty);
333
334 /// addAddress - Add an address attribute to a die based on the location
335 /// provided.
336 void addAddress(DIE *Die, dwarf::Attribute Attribute,
337 const MachineLocation &Location, bool Indirect = false);
338
339 /// addConstantValue - Add constant value entry in variable DIE.
340 void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
341 void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
342 void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
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 addRegisterOp(DIEBlock *TheDie, unsigned Reg);
353
354 /// addRegisterOffset - Add register offset.
355 void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
356
357 /// addComplexAddress - Start with the address based on the location provided,
358 /// and generate the DWARF information necessary to find the actual variable
359 /// (navigating the extra location information encoded in the type) based on
360 /// the starting location. Add the DWARF information to the die.
361 void addComplexAddress(const DbgVariable &DV, DIE *Die,
362 dwarf::Attribute Attribute,
363 const MachineLocation &Location);
364
365 // FIXME: Should be reformulated in terms of addComplexAddress.
366 /// addBlockByrefAddress - Start with the address based on the location
367 /// provided, and generate the DWARF information necessary to find the
368 /// actual Block variable (navigating the Block struct) based on the
369 /// starting location. Add the DWARF information to the die. Obsolete,
370 /// please use addComplexAddress instead.
371 void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
372 dwarf::Attribute Attribute,
373 const MachineLocation &Location);
374
375 /// addVariableAddress - Add DW_AT_location attribute for a
376 /// DbgVariable based on provided MachineLocation.
377 void addVariableAddress(const DbgVariable &DV, DIE *Die,
378 MachineLocation Location);
379
380 /// addType - Add a new type attribute to the specified entity. This takes
381 /// and attribute parameter because DW_AT_friend attributes are also
382 /// type references.
383 void addType(DIE *Entity, DIType Ty,
384 dwarf::Attribute Attribute = dwarf::DW_AT_type);
385
386 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
387 DIE *getOrCreateNameSpace(DINameSpace NS);
388
389 /// getOrCreateSubprogramDIE - Create new DIE using SP.
390 DIE *getOrCreateSubprogramDIE(DISubprogram SP);
391
392 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
393 /// given DIType.
394 DIE *getOrCreateTypeDIE(const MDNode *N);
395
396 /// getOrCreateContextDIE - Get context owner's DIE.
397 DIE *createTypeDIE(DICompositeType Ty);
398
399 /// getOrCreateContextDIE - Get context owner's DIE.
400 DIE *getOrCreateContextDIE(DIScope Context);
401
402 /// constructContainingTypeDIEs - Construct DIEs for types that contain
403 /// vtables.
404 void constructContainingTypeDIEs();
405
406 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
407 DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
408
409 /// Create a DIE with the given Tag, add the DIE to its parent, and
410 /// call insertDIE if MD is not null.
411 DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
412 DIDescriptor N = DIDescriptor());
413
414 /// Compute the size of a header for this unit, not including the initial
415 /// length field.
416 unsigned getHeaderSize() const {
417 return sizeof(int16_t) + // DWARF version number
418 sizeof(int32_t) + // Offset Into Abbrev. Section
419 sizeof(int8_t); // Pointer Size (in bytes)
420 }
421
422 /// Emit the header for this unit, not including the initial length field.
423 void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym) const;
424
425 protected:
426 /// getOrCreateStaticMemberDIE - Create new static data member DIE.
427 DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
428
429 private:
430 /// constructTypeDIE - Construct basic type die from DIBasicType.
431 void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
432
433 /// constructTypeDIE - Construct derived type die from DIDerivedType.
434 void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
435
436 /// constructTypeDIE - Construct type DIE from DICompositeType.
437 void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
438
439 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
440 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
441
442 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
443 void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
444
445 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
446 void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
447
448 /// constructMemberDIE - Construct member DIE from DIDerivedType.
449 void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
450
451 /// constructTemplateTypeParameterDIE - Construct new DIE for the given
452 /// DITemplateTypeParameter.
453 void constructTemplateTypeParameterDIE(DIE &Buffer,
454 DITemplateTypeParameter TP);
455
456 /// constructTemplateValueParameterDIE - Construct new DIE for the given
457 /// DITemplateValueParameter.
458 void constructTemplateValueParameterDIE(DIE &Buffer,
459 DITemplateValueParameter TVP);
460
461 /// getLowerBoundDefault - Return the default lower bound for an array. If the
462 /// DWARF version doesn't handle the language, return -1.
463 int64_t getDefaultLowerBound() const;
464
465 /// getDIEEntry - Returns the debug information entry for the specified
466 /// debug variable.
467 DIEEntry *getDIEEntry(const MDNode *N) const {
468 return MDNodeToDIEEntryMap.lookup(N);
469 }
470
471 /// insertDIEEntry - Insert debug information entry into the map.
472 void insertDIEEntry(const MDNode *N, DIEEntry *E) {
473 MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
474 }
475
476 // getIndexTyDie - Get an anonymous type for index type.
477 DIE *getIndexTyDie() { return IndexTyDie; }
478
479 // setIndexTyDie - Set D as anonymous type for index which can be reused
480 // later.
481 void setIndexTyDie(DIE *D) { IndexTyDie = D; }
482
483 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
484 /// information entry.
485 DIEEntry *createDIEEntry(DIE *Entry);
486
487 /// resolve - Look in the DwarfDebug map for the MDNode that
488 /// corresponds to the reference.
489 template <typename T> T resolve(DIRef<T> Ref) const {
490 return DD->resolve(Ref);
491 }
492
493 /// If this is a named finished type then include it in the list of types for
494 /// the accelerator tables.
495 void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE *TyDIE);
496 };
497
498 class DwarfCompileUnit : public DwarfUnit {
499 public:
500 DwarfCompileUnit(unsigned UID, DIE *D, DICompileUnit Node, AsmPrinter *A,
501 DwarfDebug *DW, DwarfFile *DWU);
502
503 /// createGlobalVariableDIE - create global variable DIE.
504 void createGlobalVariableDIE(DIGlobalVariable GV);
505
506 /// addLabelAddress - Add a dwarf label attribute data and value using
507 /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
508 void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
509
510 uint16_t getLanguage() const LLVM_OVERRIDE { return getNode().getLanguage(); }
511 };
512
513 class DwarfTypeUnit : public DwarfUnit {
514 private:
515 uint16_t Language;
516
517 public:
518 DwarfTypeUnit(unsigned UID, DIE *D, uint16_t Language, AsmPrinter *A,
519 DwarfDebug *DW, DwarfFile *DWU);
520
521 uint16_t getLanguage() const LLVM_OVERRIDE { return Language; }
522 };
523 } // end llvm namespace
524 #endif