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 HANDLE_DIEVALUE(T) \
198 cast<DIE##T>(this)->EmitValueImpl(AP, Form); \
200 #include "llvm/CodeGen/DIEValue.def"
204 unsigned DIEValue::SizeOf(const AsmPrinter *AP, dwarf::Form Form) const {
206 #define HANDLE_DIEVALUE(T) \
208 return cast<DIE##T>(this)->SizeOfImpl(AP, Form);
209 #include "llvm/CodeGen/DIEValue.def"
211 llvm_unreachable("Unknown DIE kind");
215 void DIEValue::print(raw_ostream &O) const {
217 #define HANDLE_DIEVALUE(T) \
219 cast<DIE##T>(this)->printImpl(O); \
221 #include "llvm/CodeGen/DIEValue.def"
225 void DIEValue::dump() const {
230 //===----------------------------------------------------------------------===//
231 // DIEInteger Implementation
232 //===----------------------------------------------------------------------===//
234 /// EmitValue - Emit integer of appropriate size.
236 void DIEInteger::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
239 case dwarf::DW_FORM_flag_present:
240 // Emit something to keep the lines and comments in sync.
241 // FIXME: Is there a better way to do this?
242 Asm->OutStreamer->AddBlankLine();
244 case dwarf::DW_FORM_flag: // Fall thru
245 case dwarf::DW_FORM_ref1: // Fall thru
246 case dwarf::DW_FORM_data1: Size = 1; break;
247 case dwarf::DW_FORM_ref2: // Fall thru
248 case dwarf::DW_FORM_data2: Size = 2; break;
249 case dwarf::DW_FORM_sec_offset: // Fall thru
250 case dwarf::DW_FORM_strp: // Fall thru
251 case dwarf::DW_FORM_ref4: // Fall thru
252 case dwarf::DW_FORM_data4: Size = 4; break;
253 case dwarf::DW_FORM_ref8: // Fall thru
254 case dwarf::DW_FORM_ref_sig8: // Fall thru
255 case dwarf::DW_FORM_data8: Size = 8; break;
256 case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
257 case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
258 case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
259 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
260 case dwarf::DW_FORM_addr:
261 Size = Asm->getDataLayout().getPointerSize(); break;
262 case dwarf::DW_FORM_ref_addr:
263 Size = SizeOf(Asm, dwarf::DW_FORM_ref_addr);
265 default: llvm_unreachable("DIE Value form not supported yet");
267 Asm->OutStreamer->EmitIntValue(Integer, Size);
270 /// SizeOf - Determine size of integer value in bytes.
272 unsigned DIEInteger::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
274 case dwarf::DW_FORM_flag_present: return 0;
275 case dwarf::DW_FORM_flag: // Fall thru
276 case dwarf::DW_FORM_ref1: // Fall thru
277 case dwarf::DW_FORM_data1: return sizeof(int8_t);
278 case dwarf::DW_FORM_ref2: // Fall thru
279 case dwarf::DW_FORM_data2: return sizeof(int16_t);
280 case dwarf::DW_FORM_sec_offset: // Fall thru
281 case dwarf::DW_FORM_strp: // Fall thru
282 case dwarf::DW_FORM_ref4: // Fall thru
283 case dwarf::DW_FORM_data4: return sizeof(int32_t);
284 case dwarf::DW_FORM_ref8: // Fall thru
285 case dwarf::DW_FORM_ref_sig8: // Fall thru
286 case dwarf::DW_FORM_data8: return sizeof(int64_t);
287 case dwarf::DW_FORM_GNU_str_index: return getULEB128Size(Integer);
288 case dwarf::DW_FORM_GNU_addr_index: return getULEB128Size(Integer);
289 case dwarf::DW_FORM_udata: return getULEB128Size(Integer);
290 case dwarf::DW_FORM_sdata: return getSLEB128Size(Integer);
291 case dwarf::DW_FORM_addr: return AP->getDataLayout().getPointerSize();
292 case dwarf::DW_FORM_ref_addr:
293 if (AP->OutStreamer->getContext().getDwarfVersion() == 2)
294 return AP->getDataLayout().getPointerSize();
295 return sizeof(int32_t);
296 default: llvm_unreachable("DIE Value form not supported yet");
301 void DIEInteger::printImpl(raw_ostream &O) const {
302 O << "Int: " << (int64_t)Integer << " 0x";
303 O.write_hex(Integer);
307 //===----------------------------------------------------------------------===//
308 // DIEExpr Implementation
309 //===----------------------------------------------------------------------===//
311 /// EmitValue - Emit expression value.
313 void DIEExpr::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
314 AP->OutStreamer->EmitValue(Expr, SizeOf(AP, Form));
317 /// SizeOf - Determine size of expression value in bytes.
319 unsigned DIEExpr::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
320 if (Form == dwarf::DW_FORM_data4) return 4;
321 if (Form == dwarf::DW_FORM_sec_offset) return 4;
322 if (Form == dwarf::DW_FORM_strp) return 4;
323 return AP->getDataLayout().getPointerSize();
327 void DIEExpr::printImpl(raw_ostream &O) const { O << "Expr: " << *Expr; }
330 //===----------------------------------------------------------------------===//
331 // DIELabel Implementation
332 //===----------------------------------------------------------------------===//
334 /// EmitValue - Emit label value.
336 void DIELabel::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
337 AP->EmitLabelReference(Label, SizeOf(AP, Form),
338 Form == dwarf::DW_FORM_strp ||
339 Form == dwarf::DW_FORM_sec_offset ||
340 Form == dwarf::DW_FORM_ref_addr);
343 /// SizeOf - Determine size of label value in bytes.
345 unsigned DIELabel::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
346 if (Form == dwarf::DW_FORM_data4) return 4;
347 if (Form == dwarf::DW_FORM_sec_offset) return 4;
348 if (Form == dwarf::DW_FORM_strp) return 4;
349 return AP->getDataLayout().getPointerSize();
353 void DIELabel::printImpl(raw_ostream &O) const {
354 O << "Lbl: " << Label->getName();
358 //===----------------------------------------------------------------------===//
359 // DIEDelta Implementation
360 //===----------------------------------------------------------------------===//
362 /// EmitValue - Emit delta value.
364 void DIEDelta::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
365 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
368 /// SizeOf - Determine size of delta value in bytes.
370 unsigned DIEDelta::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
371 if (Form == dwarf::DW_FORM_data4) return 4;
372 if (Form == dwarf::DW_FORM_sec_offset) return 4;
373 if (Form == dwarf::DW_FORM_strp) return 4;
374 return AP->getDataLayout().getPointerSize();
378 void DIEDelta::printImpl(raw_ostream &O) const {
379 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
383 //===----------------------------------------------------------------------===//
384 // DIEString Implementation
385 //===----------------------------------------------------------------------===//
387 /// EmitValue - Emit string value.
389 void DIEString::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
391 (Form == dwarf::DW_FORM_strp || Form == dwarf::DW_FORM_GNU_str_index) &&
392 "Expected valid string form");
394 // Index of string in symbol table.
395 if (Form == dwarf::DW_FORM_GNU_str_index) {
396 DIEInteger(S.getIndex()).EmitValue(AP, Form);
400 // Relocatable symbol.
401 assert(Form == dwarf::DW_FORM_strp);
402 if (AP->MAI->doesDwarfUseRelocationsAcrossSections()) {
403 DIELabel(S.getSymbol()).EmitValue(AP, Form);
407 // Offset into symbol table.
408 DIEInteger(S.getOffset()).EmitValue(AP, Form);
411 /// SizeOf - Determine size of delta value in bytes.
413 unsigned DIEString::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
415 (Form == dwarf::DW_FORM_strp || Form == dwarf::DW_FORM_GNU_str_index) &&
416 "Expected valid string form");
418 // Index of string in symbol table.
419 if (Form == dwarf::DW_FORM_GNU_str_index)
420 return DIEInteger(S.getIndex()).SizeOf(AP, Form);
422 // Relocatable symbol.
423 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
424 return DIELabel(S.getSymbol()).SizeOf(AP, Form);
426 // Offset into symbol table.
427 return DIEInteger(S.getOffset()).SizeOf(AP, Form);
431 void DIEString::printImpl(raw_ostream &O) const {
432 O << "String: " << S.getString();
436 //===----------------------------------------------------------------------===//
437 // DIEEntry Implementation
438 //===----------------------------------------------------------------------===//
440 /// EmitValue - Emit debug information entry offset.
442 void DIEEntry::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
444 if (Form == dwarf::DW_FORM_ref_addr) {
445 const DwarfDebug *DD = AP->getDwarfDebug();
446 unsigned Addr = Entry.getOffset();
447 assert(!DD->useSplitDwarf() && "TODO: dwo files can't have relocations.");
448 // For DW_FORM_ref_addr, output the offset from beginning of debug info
449 // section. Entry->getOffset() returns the offset from start of the
451 DwarfCompileUnit *CU = DD->lookupUnit(Entry.getUnit());
452 assert(CU && "CUDie should belong to a CU.");
453 Addr += CU->getDebugInfoOffset();
454 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
455 AP->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
456 DIEEntry::getRefAddrSize(AP));
458 AP->OutStreamer->EmitIntValue(Addr, DIEEntry::getRefAddrSize(AP));
460 AP->EmitInt32(Entry.getOffset());
463 unsigned DIEEntry::getRefAddrSize(const AsmPrinter *AP) {
464 // DWARF4: References that use the attribute form DW_FORM_ref_addr are
465 // specified to be four bytes in the DWARF 32-bit format and eight bytes
466 // in the DWARF 64-bit format, while DWARF Version 2 specifies that such
467 // references have the same size as an address on the target system.
468 const DwarfDebug *DD = AP->getDwarfDebug();
469 assert(DD && "Expected Dwarf Debug info to be available");
470 if (DD->getDwarfVersion() == 2)
471 return AP->getDataLayout().getPointerSize();
472 return sizeof(int32_t);
476 void DIEEntry::printImpl(raw_ostream &O) const {
477 O << format("Die: 0x%lx", (long)(intptr_t)&Entry);
481 //===----------------------------------------------------------------------===//
482 // DIETypeSignature Implementation
483 //===----------------------------------------------------------------------===//
484 void DIETypeSignature::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
485 assert(Form == dwarf::DW_FORM_ref_sig8);
486 Asm->OutStreamer->EmitIntValue(Unit.getTypeSignature(), 8);
490 void DIETypeSignature::printImpl(raw_ostream &O) const {
491 O << format("Type Unit: 0x%lx", Unit.getTypeSignature());
495 //===----------------------------------------------------------------------===//
496 // DIELoc Implementation
497 //===----------------------------------------------------------------------===//
499 /// ComputeSize - calculate the size of the location expression.
501 unsigned DIELoc::ComputeSize(const AsmPrinter *AP) const {
503 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
504 for (unsigned i = 0, N = Values.size(); i < N; ++i)
505 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
511 /// EmitValue - Emit location data.
513 void DIELoc::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
515 default: llvm_unreachable("Improper form for block");
516 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
517 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
518 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
519 case dwarf::DW_FORM_block:
520 case dwarf::DW_FORM_exprloc:
521 Asm->EmitULEB128(Size); break;
524 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
525 for (unsigned i = 0, N = Values.size(); i < N; ++i)
526 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
529 /// SizeOf - Determine size of location data in bytes.
531 unsigned DIELoc::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
533 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
534 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
535 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
536 case dwarf::DW_FORM_block:
537 case dwarf::DW_FORM_exprloc:
538 return Size + getULEB128Size(Size);
539 default: llvm_unreachable("Improper form for block");
544 void DIELoc::printImpl(raw_ostream &O) const {
550 //===----------------------------------------------------------------------===//
551 // DIEBlock Implementation
552 //===----------------------------------------------------------------------===//
554 /// ComputeSize - calculate the size of the block.
556 unsigned DIEBlock::ComputeSize(const AsmPrinter *AP) const {
558 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
559 for (unsigned i = 0, N = Values.size(); i < N; ++i)
560 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
566 /// EmitValue - Emit block data.
568 void DIEBlock::EmitValueImpl(const AsmPrinter *Asm, dwarf::Form Form) const {
570 default: llvm_unreachable("Improper form for block");
571 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
572 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
573 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
574 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
577 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
578 for (unsigned i = 0, N = Values.size(); i < N; ++i)
579 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
582 /// SizeOf - Determine size of block data in bytes.
584 unsigned DIEBlock::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
586 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
587 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
588 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
589 case dwarf::DW_FORM_block: return Size + getULEB128Size(Size);
590 default: llvm_unreachable("Improper form for block");
595 void DIEBlock::printImpl(raw_ostream &O) const {
601 //===----------------------------------------------------------------------===//
602 // DIELocList Implementation
603 //===----------------------------------------------------------------------===//
605 unsigned DIELocList::SizeOfImpl(const AsmPrinter *AP, dwarf::Form Form) const {
606 if (Form == dwarf::DW_FORM_data4)
608 if (Form == dwarf::DW_FORM_sec_offset)
610 return AP->getDataLayout().getPointerSize();
613 /// EmitValue - Emit label value.
615 void DIELocList::EmitValueImpl(const AsmPrinter *AP, dwarf::Form Form) const {
616 DwarfDebug *DD = AP->getDwarfDebug();
617 MCSymbol *Label = DD->getDebugLocs().getList(Index).Label;
619 if (AP->MAI->doesDwarfUseRelocationsAcrossSections() && !DD->useSplitDwarf())
620 AP->emitSectionOffset(Label);
622 AP->EmitLabelDifference(Label, Label->getSection().getBeginSymbol(), 4);
626 void DIELocList::printImpl(raw_ostream &O) const {
627 O << "LocList: " << Index;