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 "llvm/ADT/Twine.h"
17 #include "llvm/CodeGen/AsmPrinter.h"
18 #include "llvm/IR/DataLayout.h"
19 #include "llvm/MC/MCAsmInfo.h"
20 #include "llvm/MC/MCStreamer.h"
21 #include "llvm/MC/MCSymbol.h"
22 #include "llvm/Support/Allocator.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/MD5.h"
30 //===----------------------------------------------------------------------===//
31 // DIEAbbrevData Implementation
32 //===----------------------------------------------------------------------===//
34 /// Profile - Used to gather unique data for the abbreviation folding set.
36 void DIEAbbrevData::Profile(FoldingSetNodeID &ID) const {
37 // Explicitly cast to an integer type for which FoldingSetNodeID has
38 // overloads. Otherwise MSVC 2010 thinks this call is ambiguous.
39 ID.AddInteger(unsigned(Attribute));
40 ID.AddInteger(unsigned(Form));
43 //===----------------------------------------------------------------------===//
44 // DIEAbbrev Implementation
45 //===----------------------------------------------------------------------===//
47 /// Profile - Used to gather unique data for the abbreviation folding set.
49 void DIEAbbrev::Profile(FoldingSetNodeID &ID) const {
50 ID.AddInteger(unsigned(Tag));
51 ID.AddInteger(ChildrenFlag);
53 // For each attribute description.
54 for (unsigned i = 0, N = Data.size(); i < N; ++i)
58 /// Emit - Print the abbreviation using the specified asm printer.
60 void DIEAbbrev::Emit(AsmPrinter *AP) const {
61 // Emit its Dwarf tag type.
62 AP->EmitULEB128(Tag, dwarf::TagString(Tag));
64 // Emit whether it has children DIEs.
65 AP->EmitULEB128(ChildrenFlag, dwarf::ChildrenString(ChildrenFlag));
67 // For each attribute description.
68 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
69 const DIEAbbrevData &AttrData = Data[i];
71 // Emit attribute type.
72 AP->EmitULEB128(AttrData.getAttribute(),
73 dwarf::AttributeString(AttrData.getAttribute()));
76 AP->EmitULEB128(AttrData.getForm(),
77 dwarf::FormEncodingString(AttrData.getForm()));
80 // Mark end of abbreviation.
81 AP->EmitULEB128(0, "EOM(1)");
82 AP->EmitULEB128(0, "EOM(2)");
86 void DIEAbbrev::print(raw_ostream &O) {
88 << format("0x%lx", (long)(intptr_t)this)
90 << dwarf::TagString(Tag)
92 << dwarf::ChildrenString(ChildrenFlag)
95 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
97 << dwarf::AttributeString(Data[i].getAttribute())
99 << dwarf::FormEncodingString(Data[i].getForm())
103 void DIEAbbrev::dump() { print(dbgs()); }
106 //===----------------------------------------------------------------------===//
107 // DIE Implementation
108 //===----------------------------------------------------------------------===//
111 for (unsigned i = 0, N = Children.size(); i < N; ++i)
115 /// Climb up the parent chain to get the compile unit DIE to which this DIE
117 const DIE *DIE::getCompileUnit() const {
120 if (p->getTag() == dwarf::DW_TAG_compile_unit)
124 llvm_unreachable("We should not have orphaned DIEs.");
127 DIEValue *DIE::findAttribute(uint16_t Attribute) {
128 const SmallVectorImpl<DIEValue *> &Values = getValues();
129 const DIEAbbrev &Abbrevs = getAbbrev();
131 // Iterate through all the attributes until we find the one we're
132 // looking for, if we can't find it return NULL.
133 for (size_t i = 0; i < Values.size(); ++i)
134 if (Abbrevs.getData()[i].getAttribute() == Attribute)
140 void DIE::print(raw_ostream &O, unsigned IndentCount) const {
141 const std::string Indent(IndentCount, ' ');
142 bool isBlock = Abbrev.getTag() == 0;
147 << format("0x%lx", (long)(intptr_t)this)
148 << ", Offset: " << Offset
149 << ", Size: " << Size << "\n";
152 << dwarf::TagString(Abbrev.getTag())
154 << dwarf::ChildrenString(Abbrev.getChildrenFlag()) << "\n";
156 O << "Size: " << Size << "\n";
159 const SmallVectorImpl<DIEAbbrevData> &Data = Abbrev.getData();
162 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
166 O << dwarf::AttributeString(Data[i].getAttribute());
168 O << "Blk[" << i << "]";
171 << dwarf::FormEncodingString(Data[i].getForm())
178 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
179 Children[j]->print(O, IndentCount+4);
182 if (!isBlock) O << "\n";
190 void DIEValue::anchor() { }
193 void DIEValue::dump() const {
198 //===----------------------------------------------------------------------===//
199 // DIEInteger Implementation
200 //===----------------------------------------------------------------------===//
202 /// EmitValue - Emit integer of appropriate size.
204 void DIEInteger::EmitValue(AsmPrinter *Asm, dwarf::Form Form) const {
207 case dwarf::DW_FORM_flag_present:
208 // Emit something to keep the lines and comments in sync.
209 // FIXME: Is there a better way to do this?
210 if (Asm->OutStreamer.hasRawTextSupport())
211 Asm->OutStreamer.EmitRawText("");
213 case dwarf::DW_FORM_flag: // Fall thru
214 case dwarf::DW_FORM_ref1: // Fall thru
215 case dwarf::DW_FORM_data1: Size = 1; break;
216 case dwarf::DW_FORM_ref2: // Fall thru
217 case dwarf::DW_FORM_data2: Size = 2; break;
218 case dwarf::DW_FORM_sec_offset: // Fall thru
219 case dwarf::DW_FORM_ref4: // Fall thru
220 case dwarf::DW_FORM_data4: Size = 4; break;
221 case dwarf::DW_FORM_ref8: // Fall thru
222 case dwarf::DW_FORM_data8: Size = 8; break;
223 case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
224 case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
225 case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
226 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
227 case dwarf::DW_FORM_addr:
228 Size = Asm->getDataLayout().getPointerSize(); break;
229 default: llvm_unreachable("DIE Value form not supported yet");
231 Asm->OutStreamer.EmitIntValue(Integer, Size);
234 /// SizeOf - Determine size of integer value in bytes.
236 unsigned DIEInteger::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
238 case dwarf::DW_FORM_flag_present: return 0;
239 case dwarf::DW_FORM_flag: // Fall thru
240 case dwarf::DW_FORM_ref1: // Fall thru
241 case dwarf::DW_FORM_data1: return sizeof(int8_t);
242 case dwarf::DW_FORM_ref2: // Fall thru
243 case dwarf::DW_FORM_data2: return sizeof(int16_t);
244 case dwarf::DW_FORM_sec_offset: // Fall thru
245 case dwarf::DW_FORM_ref4: // Fall thru
246 case dwarf::DW_FORM_data4: return sizeof(int32_t);
247 case dwarf::DW_FORM_ref8: // Fall thru
248 case dwarf::DW_FORM_data8: return sizeof(int64_t);
249 case dwarf::DW_FORM_GNU_str_index: return MCAsmInfo::getULEB128Size(Integer);
250 case dwarf::DW_FORM_GNU_addr_index: return MCAsmInfo::getULEB128Size(Integer);
251 case dwarf::DW_FORM_udata: return MCAsmInfo::getULEB128Size(Integer);
252 case dwarf::DW_FORM_sdata: return MCAsmInfo::getSLEB128Size(Integer);
253 case dwarf::DW_FORM_addr: return AP->getDataLayout().getPointerSize();
254 default: llvm_unreachable("DIE Value form not supported yet");
259 void DIEInteger::print(raw_ostream &O) const {
260 O << "Int: " << (int64_t)Integer << " 0x";
261 O.write_hex(Integer);
265 //===----------------------------------------------------------------------===//
266 // DIEExpr Implementation
267 //===----------------------------------------------------------------------===//
269 /// EmitValue - Emit expression value.
271 void DIEExpr::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
272 AP->OutStreamer.EmitValue(Expr, SizeOf(AP, Form));
275 /// SizeOf - Determine size of expression value in bytes.
277 unsigned DIEExpr::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
278 if (Form == dwarf::DW_FORM_data4) return 4;
279 if (Form == dwarf::DW_FORM_sec_offset) return 4;
280 if (Form == dwarf::DW_FORM_strp) return 4;
281 return AP->getDataLayout().getPointerSize();
285 void DIEExpr::print(raw_ostream &O) const {
291 //===----------------------------------------------------------------------===//
292 // DIELabel Implementation
293 //===----------------------------------------------------------------------===//
295 /// EmitValue - Emit label value.
297 void DIELabel::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
298 AP->EmitLabelReference(Label, SizeOf(AP, Form),
299 Form == dwarf::DW_FORM_strp ||
300 Form == dwarf::DW_FORM_sec_offset ||
301 Form == dwarf::DW_FORM_ref_addr);
304 /// SizeOf - Determine size of label value in bytes.
306 unsigned DIELabel::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
307 if (Form == dwarf::DW_FORM_data4) return 4;
308 if (Form == dwarf::DW_FORM_sec_offset) return 4;
309 if (Form == dwarf::DW_FORM_strp) return 4;
310 return AP->getDataLayout().getPointerSize();
314 void DIELabel::print(raw_ostream &O) const {
315 O << "Lbl: " << Label->getName();
319 //===----------------------------------------------------------------------===//
320 // DIEDelta Implementation
321 //===----------------------------------------------------------------------===//
323 /// EmitValue - Emit delta value.
325 void DIEDelta::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
326 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
329 /// SizeOf - Determine size of delta value in bytes.
331 unsigned DIEDelta::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
332 if (Form == dwarf::DW_FORM_data4) return 4;
333 if (Form == dwarf::DW_FORM_strp) return 4;
334 return AP->getDataLayout().getPointerSize();
338 void DIEDelta::print(raw_ostream &O) const {
339 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
343 //===----------------------------------------------------------------------===//
344 // DIEString Implementation
345 //===----------------------------------------------------------------------===//
347 /// EmitValue - Emit string value.
349 void DIEString::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
350 Access->EmitValue(AP, Form);
353 /// SizeOf - Determine size of delta value in bytes.
355 unsigned DIEString::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
356 return Access->SizeOf(AP, Form);
360 void DIEString::print(raw_ostream &O) const {
361 O << "String: " << Str << "\tSymbol: ";
366 //===----------------------------------------------------------------------===//
367 // DIEEntry Implementation
368 //===----------------------------------------------------------------------===//
370 /// EmitValue - Emit debug information entry offset.
372 void DIEEntry::EmitValue(AsmPrinter *AP, dwarf::Form Form) const {
373 AP->EmitInt32(Entry->getOffset());
376 unsigned DIEEntry::getRefAddrSize(AsmPrinter *AP) {
377 // DWARF4: References that use the attribute form DW_FORM_ref_addr are
378 // specified to be four bytes in the DWARF 32-bit format and eight bytes
379 // in the DWARF 64-bit format, while DWARF Version 2 specifies that such
380 // references have the same size as an address on the target system.
381 if (AP->getDwarfDebug()->getDwarfVersion() == 2)
382 return AP->getDataLayout().getPointerSize();
383 return sizeof(int32_t);
387 void DIEEntry::print(raw_ostream &O) const {
388 O << format("Die: 0x%lx", (long)(intptr_t)Entry);
392 //===----------------------------------------------------------------------===//
393 // DIEBlock Implementation
394 //===----------------------------------------------------------------------===//
396 /// ComputeSize - calculate the size of the block.
398 unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
400 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
401 for (unsigned i = 0, N = Values.size(); i < N; ++i)
402 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
408 /// EmitValue - Emit block data.
410 void DIEBlock::EmitValue(AsmPrinter *Asm, dwarf::Form Form) const {
412 default: llvm_unreachable("Improper form for block");
413 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
414 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
415 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
416 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
419 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
420 for (unsigned i = 0, N = Values.size(); i < N; ++i)
421 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
424 /// SizeOf - Determine size of block data in bytes.
426 unsigned DIEBlock::SizeOf(AsmPrinter *AP, dwarf::Form Form) const {
428 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
429 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
430 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
431 case dwarf::DW_FORM_block: return Size + MCAsmInfo::getULEB128Size(Size);
432 default: llvm_unreachable("Improper form for block");
437 void DIEBlock::print(raw_ostream &O) const {