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())
107 void DIEAbbrev::dump() { print(dbgs()); }
110 /// Climb up the parent chain to get the unit DIE to which this DIE
112 const DIE *DIE::getUnit() const {
113 const DIE *Cu = getUnitOrNull();
114 assert(Cu && "We should not have orphaned DIEs.");
118 /// Climb up the parent chain to get the unit DIE this DIE belongs
119 /// to. Return NULL if DIE is not added to an owner yet.
120 const DIE *DIE::getUnitOrNull() const {
123 if (p->getTag() == dwarf::DW_TAG_compile_unit ||
124 p->getTag() == dwarf::DW_TAG_type_unit)
131 DIEValue *DIE::findAttribute(dwarf::Attribute Attribute) const {
132 const SmallVectorImpl<DIEValue *> &Values = getValues();
133 const DIEAbbrev &Abbrevs = getAbbrev();
135 // Iterate through all the attributes until we find the one we're
136 // looking for, if we can't find it return NULL.
137 for (size_t i = 0; i < Values.size(); ++i)
138 if (Abbrevs.getData()[i].getAttribute() == Attribute)
144 void DIE::print(raw_ostream &O, unsigned IndentCount) const {
145 const std::string Indent(IndentCount, ' ');
146 bool isBlock = Abbrev.getTag() == 0;
151 << format("0x%lx", (long)(intptr_t)this)
152 << ", Offset: " << Offset
153 << ", Size: " << Size << "\n";
156 << dwarf::TagString(Abbrev.getTag())
158 << dwarf::ChildrenString(Abbrev.hasChildren()) << "\n";
160 O << "Size: " << Size << "\n";
163 const SmallVectorImpl<DIEAbbrevData> &Data = Abbrev.getData();
166 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
170 O << dwarf::AttributeString(Data[i].getAttribute());
172 O << "Blk[" << i << "]";
175 << dwarf::FormEncodingString(Data[i].getForm())
182 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
183 Children[j]->print(O, IndentCount+4);
186 if (!isBlock) O << "\n";
194 void DIEValue::EmitValue(const AsmPrinter *AP, dwarf::Form Form) const {
196 #define EMIT_VALUE_IMPL(Kind) \
198 cast<DIE##Kind>(this)->EmitValueImpl(AP, Form); \
200 EMIT_VALUE_IMPL(Integer)
201 EMIT_VALUE_IMPL(String)
202 EMIT_VALUE_IMPL(Expr)
203 EMIT_VALUE_IMPL(Label)
204 EMIT_VALUE_IMPL(Delta)
205 EMIT_VALUE_IMPL(Entry)
206 EMIT_VALUE_IMPL(TypeSignature)
207 EMIT_VALUE_IMPL(Block)
209 EMIT_VALUE_IMPL(LocList)
210 #undef EMIT_VALUE_IMPL
214 unsigned DIEValue::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
216 #define SIZE_OF_IMPL(Kind) \
218 return cast<DIE##Kind>(this)->SizeOfImpl(AP, Form);
219 SIZE_OF_IMPL(Integer)
225 SIZE_OF_IMPL(TypeSignature)
228 SIZE_OF_IMPL(LocList)
234 void DIEValue::print(raw_ostream &O) const {
236 #define PRINT_IMPL(Kind) \
238 cast<DIE##Kind>(this)->printImpl(O); \
246 PRINT_IMPL(TypeSignature)
254 void DIEValue::dump() const {
259 //===----------------------------------------------------------------------===//
260 // DIEInteger Implementation
261 //===----------------------------------------------------------------------===//
263 /// EmitValue - Emit integer of appropriate size.
265 void DIEInteger::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
268 case dwarf::DW_FORM_flag_present:
269 // Emit something to keep the lines and comments in sync.
270 // FIXME: Is there a better way to do this?
271 Asm->OutStreamer->AddBlankLine();
273 case dwarf::DW_FORM_flag: // Fall thru
274 case dwarf::DW_FORM_ref1: // Fall thru
275 case dwarf::DW_FORM_data1: Size = 1; break;
276 case dwarf::DW_FORM_ref2: // Fall thru
277 case dwarf::DW_FORM_data2: Size = 2; break;
278 case dwarf::DW_FORM_sec_offset: // Fall thru
279 case dwarf::DW_FORM_strp: // Fall thru
280 case dwarf::DW_FORM_ref4: // Fall thru
281 case dwarf::DW_FORM_data4: Size = 4; break;
282 case dwarf::DW_FORM_ref8: // Fall thru
283 case dwarf::DW_FORM_ref_sig8: // Fall thru
284 case dwarf::DW_FORM_data8: Size = 8; break;
285 case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
286 case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
287 case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
288 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
289 case dwarf::DW_FORM_addr:
290 Size = Asm->getDataLayout().getPointerSize(); break;
291 case dwarf::DW_FORM_ref_addr:
292 Size = SizeOf(Asm, dwarf::DW_FORM_ref_addr);
294 default: llvm_unreachable("DIE Value form not supported yet");
296 Asm->OutStreamer->EmitIntValue(Integer, Size);
299 /// SizeOf - Determine size of integer value in bytes.
301 unsigned DIEInteger::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
303 case dwarf::DW_FORM_flag_present: return 0;
304 case dwarf::DW_FORM_flag: // Fall thru
305 case dwarf::DW_FORM_ref1: // Fall thru
306 case dwarf::DW_FORM_data1: return sizeof(int8_t);
307 case dwarf::DW_FORM_ref2: // Fall thru
308 case dwarf::DW_FORM_data2: return sizeof(int16_t);
309 case dwarf::DW_FORM_sec_offset: // Fall thru
310 case dwarf::DW_FORM_strp: // Fall thru
311 case dwarf::DW_FORM_ref4: // Fall thru
312 case dwarf::DW_FORM_data4: return sizeof(int32_t);
313 case dwarf::DW_FORM_ref8: // Fall thru
314 case dwarf::DW_FORM_ref_sig8: // Fall thru
315 case dwarf::DW_FORM_data8: return sizeof(int64_t);
316 case dwarf::DW_FORM_GNU_str_index: return getULEB128Size(Integer);
317 case dwarf::DW_FORM_GNU_addr_index: return getULEB128Size(Integer);
318 case dwarf::DW_FORM_udata: return getULEB128Size(Integer);
319 case dwarf::DW_FORM_sdata: return getSLEB128Size(Integer);
320 case dwarf::DW_FORM_addr: return AP->getDataLayout().getPointerSize();
321 case dwarf::DW_FORM_ref_addr:
322 if (AP->OutStreamer->getContext().getDwarfVersion() == 2)
323 return AP->getDataLayout().getPointerSize();
324 return sizeof(int32_t);
325 default: llvm_unreachable("DIE Value form not supported yet");
330 void DIEInteger::printImpl(raw_ostream &O) const {
331 O << "Int: " << (int64_t)Integer << " 0x";
332 O.write_hex(Integer);
336 //===----------------------------------------------------------------------===//
337 // DIEExpr Implementation
338 //===----------------------------------------------------------------------===//
340 /// EmitValue - Emit expression value.
342 void DIEExpr::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
343 AP->OutStreamer->EmitValue(Expr, SizeOf(AP, Form));
346 /// SizeOf - Determine size of expression value in bytes.
348 unsigned DIEExpr::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
349 if (Form == dwarf::DW_FORM_data4) return 4;
350 if (Form == dwarf::DW_FORM_sec_offset) return 4;
351 if (Form == dwarf::DW_FORM_strp) return 4;
352 return AP->getDataLayout().getPointerSize();
356 void DIEExpr::printImpl(raw_ostream &O) const {
362 //===----------------------------------------------------------------------===//
363 // DIELabel Implementation
364 //===----------------------------------------------------------------------===//
366 /// EmitValue - Emit label value.
368 void DIELabel::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
369 AP->EmitLabelReference(Label, SizeOf(AP, Form),
370 Form == dwarf::DW_FORM_strp ||
371 Form == dwarf::DW_FORM_sec_offset ||
372 Form == dwarf::DW_FORM_ref_addr);
375 /// SizeOf - Determine size of label value in bytes.
377 unsigned DIELabel::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
378 if (Form == dwarf::DW_FORM_data4) return 4;
379 if (Form == dwarf::DW_FORM_sec_offset) return 4;
380 if (Form == dwarf::DW_FORM_strp) return 4;
381 return AP->getDataLayout().getPointerSize();
385 void DIELabel::printImpl(raw_ostream &O) const {
386 O << "Lbl: " << Label->getName();
390 //===----------------------------------------------------------------------===//
391 // DIEDelta Implementation
392 //===----------------------------------------------------------------------===//
394 /// EmitValue - Emit delta value.
396 void DIEDelta::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
397 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
400 /// SizeOf - Determine size of delta value in bytes.
402 unsigned DIEDelta::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
403 if (Form == dwarf::DW_FORM_data4) return 4;
404 if (Form == dwarf::DW_FORM_sec_offset) return 4;
405 if (Form == dwarf::DW_FORM_strp) return 4;
406 return AP->getDataLayout().getPointerSize();
410 void DIEDelta::printImpl(raw_ostream &O) const {
411 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
415 //===----------------------------------------------------------------------===//
416 // DIEString Implementation
417 //===----------------------------------------------------------------------===//
419 /// EmitValue - Emit string value.
421 void DIEString::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
422 Access->EmitValue(AP, Form);
425 /// SizeOf - Determine size of delta value in bytes.
427 unsigned DIEString::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
428 return Access->SizeOf(AP, Form);
432 void DIEString::printImpl(raw_ostream &O) const {
433 O << "String: " << Str << "\tSymbol: ";
438 //===----------------------------------------------------------------------===//
439 // DIEEntry Implementation
440 //===----------------------------------------------------------------------===//
442 /// EmitValue - Emit debug information entry offset.
444 void DIEEntry::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
446 if (Form == dwarf::DW_FORM_ref_addr) {
447 const DwarfDebug *DD = AP->getDwarfDebug();
448 unsigned Addr = Entry.getOffset();
449 assert(!DD->useSplitDwarf() && "TODO: dwo files can't have relocations.");
450 // For DW_FORM_ref_addr, output the offset from beginning of debug info
451 // section. Entry->getOffset() returns the offset from start of the
453 DwarfCompileUnit *CU = DD->lookupUnit(Entry.getUnit());
454 assert(CU && "CUDie should belong to a CU.");
455 Addr += CU->getDebugInfoOffset();
456 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
457 AP->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
458 DIEEntry::getRefAddrSize(AP));
460 AP->OutStreamer->EmitIntValue(Addr, DIEEntry::getRefAddrSize(AP));
462 AP->EmitInt32(Entry.getOffset());
465 unsigned DIEEntry::getRefAddrSize(const AsmPrinter *AP) {
466 // DWARF4: References that use the attribute form DW_FORM_ref_addr are
467 // specified to be four bytes in the DWARF 32-bit format and eight bytes
468 // in the DWARF 64-bit format, while DWARF Version 2 specifies that such
469 // references have the same size as an address on the target system.
470 const DwarfDebug *DD = AP->getDwarfDebug();
471 assert(DD && "Expected Dwarf Debug info to be available");
472 if (DD->getDwarfVersion() == 2)
473 return AP->getDataLayout().getPointerSize();
474 return sizeof(int32_t);
478 void DIEEntry::printImpl(raw_ostream &O) const {
479 O << format("Die: 0x%lx", (long)(intptr_t)&Entry);
483 //===----------------------------------------------------------------------===//
484 // DIETypeSignature Implementation
485 //===----------------------------------------------------------------------===//
486 void DIETypeSignature::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
487 assert(Form == dwarf::DW_FORM_ref_sig8);
488 Asm->OutStreamer->EmitIntValue(Unit.getTypeSignature(), 8);
492 void DIETypeSignature::printImpl(raw_ostream &O) const {
493 O << format("Type Unit: 0x%lx", Unit.getTypeSignature());
497 //===----------------------------------------------------------------------===//
498 // DIELoc Implementation
499 //===----------------------------------------------------------------------===//
501 /// ComputeSize - calculate the size of the location expression.
503 unsigned DIELoc::ComputeSize(const AsmPrinter *AP) const {
505 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
506 for (unsigned i = 0, N = Values.size(); i < N; ++i)
507 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
513 /// EmitValue - Emit location data.
515 void DIELoc::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
517 default: llvm_unreachable("Improper form for block");
518 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
519 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
520 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
521 case dwarf::DW_FORM_block:
522 case dwarf::DW_FORM_exprloc:
523 Asm->EmitULEB128(Size); break;
526 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
527 for (unsigned i = 0, N = Values.size(); i < N; ++i)
528 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
531 /// SizeOf - Determine size of location data in bytes.
533 unsigned DIELoc::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
535 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
536 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
537 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
538 case dwarf::DW_FORM_block:
539 case dwarf::DW_FORM_exprloc:
540 return Size + getULEB128Size(Size);
541 default: llvm_unreachable("Improper form for block");
546 void DIELoc::printImpl(raw_ostream &O) const {
552 //===----------------------------------------------------------------------===//
553 // DIEBlock Implementation
554 //===----------------------------------------------------------------------===//
556 /// ComputeSize - calculate the size of the block.
558 unsigned DIEBlock::ComputeSize(const AsmPrinter *AP) const {
560 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
561 for (unsigned i = 0, N = Values.size(); i < N; ++i)
562 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
568 /// EmitValue - Emit block data.
570 void DIEBlock::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
572 default: llvm_unreachable("Improper form for block");
573 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
574 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
575 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
576 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
579 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
580 for (unsigned i = 0, N = Values.size(); i < N; ++i)
581 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
584 /// SizeOf - Determine size of block data in bytes.
586 unsigned DIEBlock::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
588 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
589 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
590 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
591 case dwarf::DW_FORM_block: return Size + getULEB128Size(Size);
592 default: llvm_unreachable("Improper form for block");
597 void DIEBlock::printImpl(raw_ostream &O) const {
603 //===----------------------------------------------------------------------===//
604 // DIELocList Implementation
605 //===----------------------------------------------------------------------===//
607 unsigned DIELocList::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
608 if (Form == dwarf::DW_FORM_data4)
610 if (Form == dwarf::DW_FORM_sec_offset)
612 return AP->getDataLayout().getPointerSize();
615 /// EmitValue - Emit label value.
617 void DIELocList::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
618 DwarfDebug *DD = AP->getDwarfDebug();
619 MCSymbol *Label = DD->getDebugLocs().getList(Index).Label;
621 if (AP->MAI->doesDwarfUseRelocationsAcrossSections() && !DD->useSplitDwarf())
622 AP->emitSectionOffset(Label);
624 AP->EmitLabelDifference(Label, Label->getSection().getBeginSymbol(), 4);
628 void DIELocList::printImpl(raw_ostream &O) const {
629 O << "LocList: " << Index;