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 //===----------------------------------------------------------------------===//
15 #include "DwarfDebug.h"
16 #include "DwarfUnit.h"
17 #include "llvm/ADT/Twine.h"
18 #include "llvm/CodeGen/AsmPrinter.h"
19 #include "llvm/IR/DataLayout.h"
20 #include "llvm/MC/MCAsmInfo.h"
21 #include "llvm/MC/MCStreamer.h"
22 #include "llvm/MC/MCSymbol.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/ErrorHandling.h"
25 #include "llvm/Support/Format.h"
26 #include "llvm/Support/FormattedStream.h"
27 #include "llvm/Support/LEB128.h"
28 #include "llvm/Support/MD5.h"
31 //===----------------------------------------------------------------------===//
32 // DIEAbbrevData Implementation
33 //===----------------------------------------------------------------------===//
35 /// Profile - Used to gather unique data for the abbreviation folding set.
37 void DIEAbbrevData::Profile(FoldingSetNodeID &ID) const {
38 // Explicitly cast to an integer type for which FoldingSetNodeID has
39 // overloads. Otherwise MSVC 2010 thinks this call is ambiguous.
40 ID.AddInteger(unsigned(Attribute));
41 ID.AddInteger(unsigned(Form));
44 //===----------------------------------------------------------------------===//
45 // DIEAbbrev Implementation
46 //===----------------------------------------------------------------------===//
48 /// Profile - Used to gather unique data for the abbreviation folding set.
50 void DIEAbbrev::Profile(FoldingSetNodeID &ID) const {
51 ID.AddInteger(unsigned(Tag));
52 ID.AddInteger(unsigned(Children));
54 // For each attribute description.
55 for (unsigned i = 0, N = Data.size(); i < N; ++i)
59 /// Emit - Print the abbreviation using the specified asm printer.
61 void DIEAbbrev::Emit(AsmPrinter *AP) const {
62 // Emit its Dwarf tag type.
63 AP->EmitULEB128(Tag, dwarf::TagString(Tag));
65 // Emit whether it has children DIEs.
66 AP->EmitULEB128((unsigned)Children, dwarf::ChildrenString(Children));
68 // For each attribute description.
69 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
70 const DIEAbbrevData &AttrData = Data[i];
72 // Emit attribute type.
73 AP->EmitULEB128(AttrData.getAttribute(),
74 dwarf::AttributeString(AttrData.getAttribute()));
77 AP->EmitULEB128(AttrData.getForm(),
78 dwarf::FormEncodingString(AttrData.getForm()));
81 // Mark end of abbreviation.
82 AP->EmitULEB128(0, "EOM(1)");
83 AP->EmitULEB128(0, "EOM(2)");
87 void DIEAbbrev::print(raw_ostream &O) {
89 << format("0x%lx", (long)(intptr_t)this)
91 << dwarf::TagString(Tag)
93 << dwarf::ChildrenString(Children)
96 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
98 << dwarf::AttributeString(Data[i].getAttribute())
100 << dwarf::FormEncodingString(Data[i].getForm())
104 void DIEAbbrev::dump() { print(dbgs()); }
107 //===----------------------------------------------------------------------===//
108 // DIE Implementation
109 //===----------------------------------------------------------------------===//
112 for (unsigned i = 0, N = Children.size(); i < N; ++i)
116 /// Climb up the parent chain to get the unit DIE to which this DIE
118 const DIE *DIE::getUnit() const {
119 const DIE *Cu = getUnitOrNull();
120 assert(Cu && "We should not have orphaned DIEs.");
124 /// Climb up the parent chain to get the unit DIE this DIE belongs
125 /// to. Return NULL if DIE is not added to an owner yet.
126 const DIE *DIE::getUnitOrNull() const {
129 if (p->getTag() == dwarf::DW_TAG_compile_unit ||
130 p->getTag() == dwarf::DW_TAG_type_unit)
137 DIEValue *DIE::findAttribute(dwarf::Attribute Attribute) const {
138 const SmallVectorImpl<DIEValue *> &Values = getValues();
139 const DIEAbbrev &Abbrevs = getAbbrev();
141 // Iterate through all the attributes until we find the one we're
142 // looking for, if we can't find it return NULL.
143 for (size_t i = 0; i < Values.size(); ++i)
144 if (Abbrevs.getData()[i].getAttribute() == Attribute)
150 void DIE::print(raw_ostream &O, unsigned IndentCount) const {
151 const std::string Indent(IndentCount, ' ');
152 bool isBlock = Abbrev.getTag() == 0;
157 << format("0x%lx", (long)(intptr_t)this)
158 << ", Offset: " << Offset
159 << ", Size: " << Size << "\n";
162 << dwarf::TagString(Abbrev.getTag())
164 << dwarf::ChildrenString(Abbrev.hasChildren()) << "\n";
166 O << "Size: " << Size << "\n";
169 const SmallVectorImpl<DIEAbbrevData> &Data = Abbrev.getData();
172 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
176 O << dwarf::AttributeString(Data[i].getAttribute());
178 O << "Blk[" << i << "]";
181 << dwarf::FormEncodingString(Data[i].getForm())
188 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
189 Children[j]->print(O, IndentCount+4);
192 if (!isBlock) O << "\n";
200 void DIEValue::anchor() { }
203 void DIEValue::dump() const {
208 //===----------------------------------------------------------------------===//
209 // DIEInteger Implementation
210 //===----------------------------------------------------------------------===//
212 /// EmitValue - Emit integer of appropriate size.
214 void DIEInteger::EmitValue(AsmPrinter *Asm, dwarf::Form Form) const {
217 case dwarf::DW_FORM_flag_present:
218 // Emit something to keep the lines and comments in sync.
219 // FIXME: Is there a better way to do this?
220 Asm->OutStreamer.AddBlankLine();
222 case dwarf::DW_FORM_flag: // Fall thru
223 case dwarf::DW_FORM_ref1: // Fall thru
224 case dwarf::DW_FORM_data1: Size = 1; break;
225 case dwarf::DW_FORM_ref2: // Fall thru
226 case dwarf::DW_FORM_data2: Size = 2; break;
227 case dwarf::DW_FORM_sec_offset: // Fall thru
228 case dwarf::DW_FORM_ref4: // Fall thru
229 case dwarf::DW_FORM_data4: Size = 4; break;
230 case dwarf::DW_FORM_ref8: // Fall thru
231 case dwarf::DW_FORM_ref_sig8: // Fall thru
232 case dwarf::DW_FORM_data8: Size = 8; break;
233 case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
234 case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
235 case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
236 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
237 case dwarf::DW_FORM_addr:
238 Size = Asm->getDataLayout().getPointerSize(); break;
239 default: llvm_unreachable("DIE Value form not supported yet");
241 Asm->OutStreamer.EmitIntValue(Integer, Size);
244 /// SizeOf - Determine size of integer value in bytes.
246 unsigned DIEInteger::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
248 case dwarf::DW_FORM_flag_present: return 0;
249 case dwarf::DW_FORM_flag: // Fall thru
250 case dwarf::DW_FORM_ref1: // Fall thru
251 case dwarf::DW_FORM_data1: return sizeof(int8_t);
252 case dwarf::DW_FORM_ref2: // Fall thru
253 case dwarf::DW_FORM_data2: return sizeof(int16_t);
254 case dwarf::DW_FORM_sec_offset: // Fall thru
255 case dwarf::DW_FORM_ref4: // Fall thru
256 case dwarf::DW_FORM_data4: return sizeof(int32_t);
257 case dwarf::DW_FORM_ref8: // Fall thru
258 case dwarf::DW_FORM_ref_sig8: // Fall thru
259 case dwarf::DW_FORM_data8: return sizeof(int64_t);
260 case dwarf::DW_FORM_GNU_str_index: return getULEB128Size(Integer);
261 case dwarf::DW_FORM_GNU_addr_index: return getULEB128Size(Integer);
262 case dwarf::DW_FORM_udata: return getULEB128Size(Integer);
263 case dwarf::DW_FORM_sdata: return getSLEB128Size(Integer);
264 case dwarf::DW_FORM_addr: return AP->getDataLayout().getPointerSize();
265 default: llvm_unreachable("DIE Value form not supported yet");
270 void DIEInteger::print(raw_ostream &O) const {
271 O << "Int: " << (int64_t)Integer << " 0x";
272 O.write_hex(Integer);
276 //===----------------------------------------------------------------------===//
277 // DIEExpr Implementation
278 //===----------------------------------------------------------------------===//
280 /// EmitValue - Emit expression value.
282 void DIEExpr::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
283 AP->OutStreamer.EmitValue(Expr, SizeOf(AP, Form));
286 /// SizeOf - Determine size of expression value in bytes.
288 unsigned DIEExpr::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
289 if (Form == dwarf::DW_FORM_data4) return 4;
290 if (Form == dwarf::DW_FORM_sec_offset) return 4;
291 if (Form == dwarf::DW_FORM_strp) return 4;
292 return AP->getDataLayout().getPointerSize();
296 void DIEExpr::print(raw_ostream &O) const {
302 //===----------------------------------------------------------------------===//
303 // DIELabel Implementation
304 //===----------------------------------------------------------------------===//
306 /// EmitValue - Emit label value.
308 void DIELabel::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
309 AP->EmitLabelReference(Label, SizeOf(AP, Form),
310 Form == dwarf::DW_FORM_strp ||
311 Form == dwarf::DW_FORM_sec_offset ||
312 Form == dwarf::DW_FORM_ref_addr);
315 /// SizeOf - Determine size of label value in bytes.
317 unsigned DIELabel::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
318 if (Form == dwarf::DW_FORM_data4) return 4;
319 if (Form == dwarf::DW_FORM_sec_offset) return 4;
320 if (Form == dwarf::DW_FORM_strp) return 4;
321 return AP->getDataLayout().getPointerSize();
325 void DIELabel::print(raw_ostream &O) const {
326 O << "Lbl: " << Label->getName();
330 //===----------------------------------------------------------------------===//
331 // DIEDelta Implementation
332 //===----------------------------------------------------------------------===//
334 /// EmitValue - Emit delta value.
336 void DIEDelta::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
337 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
340 /// SizeOf - Determine size of delta value in bytes.
342 unsigned DIEDelta::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
343 if (Form == dwarf::DW_FORM_data4) return 4;
344 if (Form == dwarf::DW_FORM_sec_offset) return 4;
345 if (Form == dwarf::DW_FORM_strp) return 4;
346 return AP->getDataLayout().getPointerSize();
350 void DIEDelta::print(raw_ostream &O) const {
351 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
355 //===----------------------------------------------------------------------===//
356 // DIEString Implementation
357 //===----------------------------------------------------------------------===//
359 /// EmitValue - Emit string value.
361 void DIEString::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
362 Access->EmitValue(AP, Form);
365 /// SizeOf - Determine size of delta value in bytes.
367 unsigned DIEString::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
368 return Access->SizeOf(AP, Form);
372 void DIEString::print(raw_ostream &O) const {
373 O << "String: " << Str << "\tSymbol: ";
378 //===----------------------------------------------------------------------===//
379 // DIEEntry Implementation
380 //===----------------------------------------------------------------------===//
382 /// EmitValue - Emit debug information entry offset.
384 void DIEEntry::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
386 if (Form == dwarf::DW_FORM_ref_addr) {
387 const DwarfDebug *DD = AP->getDwarfDebug();
388 unsigned Addr = Entry->getOffset();
389 assert(!DD->useSplitDwarf() && "TODO: dwo files can't have relocations.");
390 // For DW_FORM_ref_addr, output the offset from beginning of debug info
391 // section. Entry->getOffset() returns the offset from start of the
393 DwarfCompileUnit *CU = DD->lookupUnit(Entry->getUnit());
394 assert(CU && "CUDie should belong to a CU.");
395 Addr += CU->getDebugInfoOffset();
396 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
397 AP->EmitLabelPlusOffset(CU->getSectionSym(), Addr,
398 DIEEntry::getRefAddrSize(AP));
400 AP->EmitLabelOffsetDifference(CU->getSectionSym(), Addr,
402 DIEEntry::getRefAddrSize(AP));
404 AP->EmitInt32(Entry->getOffset());
407 unsigned DIEEntry::getRefAddrSize(AsmPrinter *AP) {
408 // DWARF4: References that use the attribute form DW_FORM_ref_addr are
409 // specified to be four bytes in the DWARF 32-bit format and eight bytes
410 // in the DWARF 64-bit format, while DWARF Version 2 specifies that such
411 // references have the same size as an address on the target system.
412 const DwarfDebug *DD = AP->getDwarfDebug();
413 assert(DD && "Expected Dwarf Debug info to be available");
414 if (DD->getDwarfVersion() == 2)
415 return AP->getDataLayout().getPointerSize();
416 return sizeof(int32_t);
420 void DIEEntry::print(raw_ostream &O) const {
421 O << format("Die: 0x%lx", (long)(intptr_t)Entry);
425 //===----------------------------------------------------------------------===//
426 // DIETypeSignature Implementation
427 //===----------------------------------------------------------------------===//
428 void DIETypeSignature::EmitValue(AsmPrinter *Asm, dwarf::Form Form) const {
429 assert(Form == dwarf::DW_FORM_ref_sig8);
430 Asm->OutStreamer.EmitIntValue(Unit.getTypeSignature(), 8);
434 void DIETypeSignature::print(raw_ostream &O) const {
435 O << format("Type Unit: 0x%lx", Unit.getTypeSignature());
438 void DIETypeSignature::dump() const { print(dbgs()); }
441 //===----------------------------------------------------------------------===//
442 // DIELoc Implementation
443 //===----------------------------------------------------------------------===//
445 /// ComputeSize - calculate the size of the location expression.
447 unsigned DIELoc::ComputeSize(AsmPrinter *AP) const {
449 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
450 for (unsigned i = 0, N = Values.size(); i < N; ++i)
451 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
457 /// EmitValue - Emit location data.
459 void DIELoc::EmitValue(AsmPrinter *Asm, dwarf::Form Form) const {
461 default: llvm_unreachable("Improper form for block");
462 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
463 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
464 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
465 case dwarf::DW_FORM_block:
466 case dwarf::DW_FORM_exprloc:
467 Asm->EmitULEB128(Size); break;
470 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
471 for (unsigned i = 0, N = Values.size(); i < N; ++i)
472 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
475 /// SizeOf - Determine size of location data in bytes.
477 unsigned DIELoc::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
479 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
480 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
481 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
482 case dwarf::DW_FORM_block:
483 case dwarf::DW_FORM_exprloc:
484 return Size + getULEB128Size(Size);
485 default: llvm_unreachable("Improper form for block");
490 void DIELoc::print(raw_ostream &O) const {
496 //===----------------------------------------------------------------------===//
497 // DIEBlock Implementation
498 //===----------------------------------------------------------------------===//
500 /// ComputeSize - calculate the size of the block.
502 unsigned DIEBlock::ComputeSize(AsmPrinter *AP) const {
504 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
505 for (unsigned i = 0, N = Values.size(); i < N; ++i)
506 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
512 /// EmitValue - Emit block data.
514 void DIEBlock::EmitValue(AsmPrinter *Asm, dwarf::Form Form) const {
516 default: llvm_unreachable("Improper form for block");
517 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
518 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
519 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
520 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
523 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
524 for (unsigned i = 0, N = Values.size(); i < N; ++i)
525 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
528 /// SizeOf - Determine size of block data in bytes.
530 unsigned DIEBlock::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
532 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
533 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
534 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
535 case dwarf::DW_FORM_block: return Size + getULEB128Size(Size);
536 default: llvm_unreachable("Improper form for block");
541 void DIEBlock::print(raw_ostream &O) const {
547 //===----------------------------------------------------------------------===//
548 // DIELocList Implementation
549 //===----------------------------------------------------------------------===//
551 unsigned DIELocList::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
552 if (Form == dwarf::DW_FORM_data4)
554 if (Form == dwarf::DW_FORM_sec_offset)
556 return AP->getDataLayout().getPointerSize();
559 /// EmitValue - Emit label value.
561 void DIELocList::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
562 MCSymbol *Label = AP->GetTempSymbol("debug_loc", Index);
563 MCSymbol *DwarfDebugLocSectionSym = AP->getDwarfDebug()->getDebugLocSym();
565 if (AP->MAI->doesDwarfUseRelocationsAcrossSections())
566 AP->EmitSectionOffset(Label, DwarfDebugLocSectionSym);
568 AP->EmitLabelDifference(Label, DwarfDebugLocSectionSym, 4);
572 void DIELocList::print(raw_ostream &O) const {
573 O << "LocList: " << Index;