1 //===--- lib/CodeGen/DIE.cpp - DWARF Info Entries -------------------------===//
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 // Data structures for DWARF info entries.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/DIE.h"
15 #include "DwarfCompileUnit.h"
16 #include "DwarfDebug.h"
17 #include "DwarfUnit.h"
18 #include "llvm/ADT/Twine.h"
19 #include "llvm/CodeGen/AsmPrinter.h"
20 #include "llvm/IR/DataLayout.h"
21 #include "llvm/MC/MCAsmInfo.h"
22 #include "llvm/MC/MCContext.h"
23 #include "llvm/MC/MCStreamer.h"
24 #include "llvm/MC/MCSymbol.h"
25 #include "llvm/Support/Debug.h"
26 #include "llvm/Support/ErrorHandling.h"
27 #include "llvm/Support/Format.h"
28 #include "llvm/Support/FormattedStream.h"
29 #include "llvm/Support/LEB128.h"
30 #include "llvm/Support/MD5.h"
31 #include "llvm/Support/raw_ostream.h"
34 //===----------------------------------------------------------------------===//
35 // DIEAbbrevData Implementation
36 //===----------------------------------------------------------------------===//
38 /// Profile - Used to gather unique data for the abbreviation folding set.
40 void DIEAbbrevData::Profile(FoldingSetNodeID &ID) const {
41 // Explicitly cast to an integer type for which FoldingSetNodeID has
42 // overloads. Otherwise MSVC 2010 thinks this call is ambiguous.
43 ID.AddInteger(unsigned(Attribute));
44 ID.AddInteger(unsigned(Form));
47 //===----------------------------------------------------------------------===//
48 // DIEAbbrev Implementation
49 //===----------------------------------------------------------------------===//
51 /// Profile - Used to gather unique data for the abbreviation folding set.
53 void DIEAbbrev::Profile(FoldingSetNodeID &ID) const {
54 ID.AddInteger(unsigned(Tag));
55 ID.AddInteger(unsigned(Children));
57 // For each attribute description.
58 for (unsigned i = 0, N = Data.size(); i < N; ++i)
62 /// Emit - Print the abbreviation using the specified asm printer.
64 void DIEAbbrev::Emit(const AsmPrinter *AP) const {
65 // Emit its Dwarf tag type.
66 AP->EmitULEB128(Tag, dwarf::TagString(Tag));
68 // Emit whether it has children DIEs.
69 AP->EmitULEB128((unsigned)Children, dwarf::ChildrenString(Children));
71 // For each attribute description.
72 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
73 const DIEAbbrevData &AttrData = Data[i];
75 // Emit attribute type.
76 AP->EmitULEB128(AttrData.getAttribute(),
77 dwarf::AttributeString(AttrData.getAttribute()));
80 AP->EmitULEB128(AttrData.getForm(),
81 dwarf::FormEncodingString(AttrData.getForm()));
84 // Mark end of abbreviation.
85 AP->EmitULEB128(0, "EOM(1)");
86 AP->EmitULEB128(0, "EOM(2)");
90 void DIEAbbrev::print(raw_ostream &O) {
92 << format("0x%lx", (long)(intptr_t)this)
94 << dwarf::TagString(Tag)
96 << dwarf::ChildrenString(Children)
99 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
101 << dwarf::AttributeString(Data[i].getAttribute())
103 << dwarf::FormEncodingString(Data[i].getForm())
109 void DIEAbbrev::dump() { print(dbgs()); }
111 DIEAbbrev DIE::generateAbbrev() const {
112 DIEAbbrev Abbrev(Tag, hasChildren());
113 for (const DIEValue &V : values())
114 Abbrev.AddAttribute(V.getAttribute(), V.getForm());
118 /// Climb up the parent chain to get the unit DIE to which this DIE
120 const DIE *DIE::getUnit() const {
121 const DIE *Cu = getUnitOrNull();
122 assert(Cu && "We should not have orphaned DIEs.");
126 /// Climb up the parent chain to get the unit DIE this DIE belongs
127 /// to. Return NULL if DIE is not added to an owner yet.
128 const DIE *DIE::getUnitOrNull() const {
131 if (p->getTag() == dwarf::DW_TAG_compile_unit ||
132 p->getTag() == dwarf::DW_TAG_type_unit)
139 DIEValue DIE::findAttribute(dwarf::Attribute Attribute) const {
140 // Iterate through all the attributes until we find the one we're
141 // looking for, if we can't find it return NULL.
142 for (const auto &V : values())
143 if (V.getAttribute() == Attribute)
149 static void printValues(raw_ostream &O, const DIEValueList &Values,
150 StringRef Type, unsigned Size, unsigned IndentCount) {
151 O << Type << ": Size: " << Size << "\n";
154 const std::string Indent(IndentCount, ' ');
155 for (const auto &V : Values.values()) {
157 O << "Blk[" << I++ << "]";
158 O << " " << dwarf::FormEncodingString(V.getForm()) << " ";
165 void DIE::print(raw_ostream &O, unsigned IndentCount) const {
166 const std::string Indent(IndentCount, ' ');
167 O << Indent << "Die: " << format("0x%lx", (long)(intptr_t) this)
168 << ", Offset: " << Offset << ", Size: " << Size << "\n";
170 O << Indent << dwarf::TagString(getTag()) << " "
171 << dwarf::ChildrenString(hasChildren()) << "\n";
174 for (const auto &V : values()) {
176 O << dwarf::AttributeString(V.getAttribute());
177 O << " " << dwarf::FormEncodingString(V.getForm()) << " ";
183 for (const auto &Child : children())
184 Child.print(O, IndentCount + 4);
194 void DIEValue::EmitValue(const AsmPrinter *AP) const {
197 llvm_unreachable("Expected valid DIEValue");
198 #define HANDLE_DIEVALUE(T) \
200 getDIE##T().EmitValue(AP, Form); \
202 #include "llvm/CodeGen/DIEValue.def"
206 unsigned DIEValue::SizeOf(const AsmPrinter *AP) const {
209 llvm_unreachable("Expected valid DIEValue");
210 #define HANDLE_DIEVALUE(T) \
212 return getDIE##T().SizeOf(AP, Form);
213 #include "llvm/CodeGen/DIEValue.def"
215 llvm_unreachable("Unknown DIE kind");
219 void DIEValue::print(raw_ostream &O) const {
222 llvm_unreachable("Expected valid DIEValue");
223 #define HANDLE_DIEVALUE(T) \
225 getDIE##T().print(O); \
227 #include "llvm/CodeGen/DIEValue.def"
232 void DIEValue::dump() const {
236 //===----------------------------------------------------------------------===//
237 // DIEInteger Implementation
238 //===----------------------------------------------------------------------===//
240 /// EmitValue - Emit integer of appropriate size.
242 void DIEInteger::EmitValue(const AsmPrinter *Asm, dwarf::Form Form) const {
245 case dwarf::DW_FORM_flag_present:
246 // Emit something to keep the lines and comments in sync.
247 // FIXME: Is there a better way to do this?
248 Asm->OutStreamer->AddBlankLine();
250 case dwarf::DW_FORM_flag: // Fall thru
251 case dwarf::DW_FORM_ref1: // Fall thru
252 case dwarf::DW_FORM_data1: Size = 1; break;
253 case dwarf::DW_FORM_ref2: // Fall thru
254 case dwarf::DW_FORM_data2: Size = 2; break;
255 case dwarf::DW_FORM_sec_offset: // Fall thru
256 case dwarf::DW_FORM_strp: // Fall thru
257 case dwarf::DW_FORM_ref4: // Fall thru
258 case dwarf::DW_FORM_data4: Size = 4; break;
259 case dwarf::DW_FORM_ref8: // Fall thru
260 case dwarf::DW_FORM_ref_sig8: // Fall thru
261 case dwarf::DW_FORM_data8: Size = 8; break;
262 case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
263 case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
264 case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
265 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
266 case dwarf::DW_FORM_addr:
267 Size = Asm->getPointerSize();
269 case dwarf::DW_FORM_ref_addr:
270 Size = SizeOf(Asm, dwarf::DW_FORM_ref_addr);
272 default: llvm_unreachable("DIE Value form not supported yet");
274 Asm->OutStreamer->EmitIntValue(Integer, Size);
277 /// SizeOf - Determine size of integer value in bytes.
279 unsigned DIEInteger::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
281 case dwarf::DW_FORM_flag_present: return 0;
282 case dwarf::DW_FORM_flag: // Fall thru
283 case dwarf::DW_FORM_ref1: // Fall thru
284 case dwarf::DW_FORM_data1: return sizeof(int8_t);
285 case dwarf::DW_FORM_ref2: // Fall thru
286 case dwarf::DW_FORM_data2: return sizeof(int16_t);
287 case dwarf::DW_FORM_sec_offset: // Fall thru
288 case dwarf::DW_FORM_strp: // Fall thru
289 case dwarf::DW_FORM_ref4: // Fall thru
290 case dwarf::DW_FORM_data4: return sizeof(int32_t);
291 case dwarf::DW_FORM_ref8: // Fall thru
292 case dwarf::DW_FORM_ref_sig8: // Fall thru
293 case dwarf::DW_FORM_data8: return sizeof(int64_t);
294 case dwarf::DW_FORM_GNU_str_index: return getULEB128Size(Integer);
295 case dwarf::DW_FORM_GNU_addr_index: return getULEB128Size(Integer);
296 case dwarf::DW_FORM_udata: return getULEB128Size(Integer);
297 case dwarf::DW_FORM_sdata: return getSLEB128Size(Integer);
298 case dwarf::DW_FORM_addr:
299 return AP->getPointerSize();
300 case dwarf::DW_FORM_ref_addr:
301 if (AP->OutStreamer->getContext().getDwarfVersion() == 2)
302 return AP->getPointerSize();
303 return sizeof(int32_t);
304 default: llvm_unreachable("DIE Value form not supported yet");
309 void DIEInteger::print(raw_ostream &O) const {
310 O << "Int: " << (int64_t)Integer << " 0x";
311 O.write_hex(Integer);
314 //===----------------------------------------------------------------------===//
315 // DIEExpr Implementation
316 //===----------------------------------------------------------------------===//
318 /// EmitValue - Emit expression value.
320 void DIEExpr::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
321 AP->OutStreamer->EmitValue(Expr, SizeOf(AP, Form));
324 /// SizeOf - Determine size of expression value in bytes.
326 unsigned DIEExpr::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
327 if (Form == dwarf::DW_FORM_data4) return 4;
328 if (Form == dwarf::DW_FORM_sec_offset) return 4;
329 if (Form == dwarf::DW_FORM_strp) return 4;
330 return AP->getPointerSize();
334 void DIEExpr::print(raw_ostream &O) const { O << "Expr: " << *Expr; }
336 //===----------------------------------------------------------------------===//
337 // DIELabel Implementation
338 //===----------------------------------------------------------------------===//
340 /// EmitValue - Emit label value.
342 void DIELabel::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
343 AP->EmitLabelReference(Label, SizeOf(AP, Form),
344 Form == dwarf::DW_FORM_strp ||
345 Form == dwarf::DW_FORM_sec_offset ||
346 Form == dwarf::DW_FORM_ref_addr);
349 /// SizeOf - Determine size of label value in bytes.
351 unsigned DIELabel::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
352 if (Form == dwarf::DW_FORM_data4) return 4;
353 if (Form == dwarf::DW_FORM_sec_offset) return 4;
354 if (Form == dwarf::DW_FORM_strp) return 4;
355 return AP->getPointerSize();
359 void DIELabel::print(raw_ostream &O) const { O << "Lbl: " << Label->getName(); }
361 //===----------------------------------------------------------------------===//
362 // DIEDelta Implementation
363 //===----------------------------------------------------------------------===//
365 /// EmitValue - Emit delta value.
367 void DIEDelta::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
368 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
371 /// SizeOf - Determine size of delta value in bytes.
373 unsigned DIEDelta::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
374 if (Form == dwarf::DW_FORM_data4) return 4;
375 if (Form == dwarf::DW_FORM_sec_offset) return 4;
376 if (Form == dwarf::DW_FORM_strp) return 4;
377 return AP->getPointerSize();
381 void DIEDelta::print(raw_ostream &O) const {
382 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
385 //===----------------------------------------------------------------------===//
386 // DIEString Implementation
387 //===----------------------------------------------------------------------===//
389 /// EmitValue - Emit string value.
391 void DIEString::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
393 (Form == dwarf::DW_FORM_strp || Form == dwarf::DW_FORM_GNU_str_index) &&
394 "Expected valid string form");
396 // Index of string in symbol table.
397 if (Form == dwarf::DW_FORM_GNU_str_index) {
398 DIEInteger(S.getIndex()).EmitValue(AP, Form);
402 // Relocatable symbol.
403 assert(Form == dwarf::DW_FORM_strp);
404 if (AP->MAI->doesDwarfUseRelocationsAcrossSections()) {
405 DIELabel(S.getSymbol()).EmitValue(AP, Form);
409 // Offset into symbol table.
410 DIEInteger(S.getOffset()).EmitValue(AP, Form);
413 /// SizeOf - Determine size of delta value in bytes.
415 unsigned DIEString::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
417 (Form == dwarf::DW_FORM_strp || Form == dwarf::DW_FORM_GNU_str_index) &&
418 "Expected valid string form");
420 // Index of string in symbol table.
421 if (Form == dwarf::DW_FORM_GNU_str_index)
422 return DIEInteger(S.getIndex()).SizeOf(AP, Form);
424 // Relocatable symbol.
425 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
426 return DIELabel(S.getSymbol()).SizeOf(AP, Form);
428 // Offset into symbol table.
429 return DIEInteger(S.getOffset()).SizeOf(AP, Form);
433 void DIEString::print(raw_ostream &O) const {
434 O << "String: " << S.getString();
437 //===----------------------------------------------------------------------===//
438 // DIEEntry Implementation
439 //===----------------------------------------------------------------------===//
441 /// EmitValue - Emit debug information entry offset.
443 void DIEEntry::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
445 if (Form == dwarf::DW_FORM_ref_addr) {
446 const DwarfDebug *DD = AP->getDwarfDebug();
447 unsigned Addr = Entry->getOffset();
448 assert(!DD->useSplitDwarf() && "TODO: dwo files can't have relocations.");
449 // For DW_FORM_ref_addr, output the offset from beginning of debug info
450 // section. Entry->getOffset() returns the offset from start of the
452 DwarfCompileUnit *CU = DD->lookupUnit(Entry->getUnit());
453 assert(CU && "CUDie should belong to a CU.");
454 Addr += CU->getDebugInfoOffset();
455 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
456 AP->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
457 DIEEntry::getRefAddrSize(AP));
459 AP->OutStreamer->EmitIntValue(Addr, DIEEntry::getRefAddrSize(AP));
461 AP->EmitInt32(Entry->getOffset());
464 unsigned DIEEntry::getRefAddrSize(const AsmPrinter *AP) {
465 // DWARF4: References that use the attribute form DW_FORM_ref_addr are
466 // specified to be four bytes in the DWARF 32-bit format and eight bytes
467 // in the DWARF 64-bit format, while DWARF Version 2 specifies that such
468 // references have the same size as an address on the target system.
469 const DwarfDebug *DD = AP->getDwarfDebug();
470 assert(DD && "Expected Dwarf Debug info to be available");
471 if (DD->getDwarfVersion() == 2)
472 return AP->getPointerSize();
473 return sizeof(int32_t);
477 void DIEEntry::print(raw_ostream &O) const {
478 O << format("Die: 0x%lx", (long)(intptr_t)&Entry);
481 //===----------------------------------------------------------------------===//
482 // DIELoc Implementation
483 //===----------------------------------------------------------------------===//
485 /// ComputeSize - calculate the size of the location expression.
487 unsigned DIELoc::ComputeSize(const AsmPrinter *AP) const {
489 for (const auto &V : values())
490 Size += V.SizeOf(AP);
496 /// EmitValue - Emit location data.
498 void DIELoc::EmitValue(const AsmPrinter *Asm, dwarf::Form Form) const {
500 default: llvm_unreachable("Improper form for block");
501 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
502 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
503 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
504 case dwarf::DW_FORM_block:
505 case dwarf::DW_FORM_exprloc:
506 Asm->EmitULEB128(Size); break;
509 for (const auto &V : values())
513 /// SizeOf - Determine size of location data in bytes.
515 unsigned DIELoc::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
517 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
518 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
519 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
520 case dwarf::DW_FORM_block:
521 case dwarf::DW_FORM_exprloc:
522 return Size + getULEB128Size(Size);
523 default: llvm_unreachable("Improper form for block");
528 void DIELoc::print(raw_ostream &O) const {
529 printValues(O, *this, "ExprLoc", Size, 5);
532 //===----------------------------------------------------------------------===//
533 // DIEBlock Implementation
534 //===----------------------------------------------------------------------===//
536 /// ComputeSize - calculate the size of the block.
538 unsigned DIEBlock::ComputeSize(const AsmPrinter *AP) const {
540 for (const auto &V : values())
541 Size += V.SizeOf(AP);
547 /// EmitValue - Emit block data.
549 void DIEBlock::EmitValue(const AsmPrinter *Asm, dwarf::Form Form) const {
551 default: llvm_unreachable("Improper form for block");
552 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
553 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
554 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
555 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
558 for (const auto &V : values())
562 /// SizeOf - Determine size of block data in bytes.
564 unsigned DIEBlock::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
566 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
567 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
568 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
569 case dwarf::DW_FORM_block: return Size + getULEB128Size(Size);
570 default: llvm_unreachable("Improper form for block");
575 void DIEBlock::print(raw_ostream &O) const {
576 printValues(O, *this, "Blk", Size, 5);
579 //===----------------------------------------------------------------------===//
580 // DIELocList Implementation
581 //===----------------------------------------------------------------------===//
583 unsigned DIELocList::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
584 if (Form == dwarf::DW_FORM_data4)
586 if (Form == dwarf::DW_FORM_sec_offset)
588 return AP->getPointerSize();
591 /// EmitValue - Emit label value.
593 void DIELocList::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
594 DwarfDebug *DD = AP->getDwarfDebug();
595 MCSymbol *Label = DD->getDebugLocs().getList(Index).Label;
596 AP->emitDwarfSymbolReference(Label, /*ForceOffset*/ DD->useSplitDwarf());
600 void DIELocList::print(raw_ostream &O) const { O << "LocList: " << Index; }