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 "llvm/ADT/Twine.h"
16 #include "llvm/CodeGen/AsmPrinter.h"
17 #include "llvm/IR/DataLayout.h"
18 #include "llvm/MC/MCAsmInfo.h"
19 #include "llvm/MC/MCStreamer.h"
20 #include "llvm/MC/MCSymbol.h"
21 #include "llvm/Support/Allocator.h"
22 #include "llvm/Support/Debug.h"
23 #include "llvm/Support/ErrorHandling.h"
24 #include "llvm/Support/Format.h"
25 #include "llvm/Support/FormattedStream.h"
28 //===----------------------------------------------------------------------===//
29 // DIEAbbrevData Implementation
30 //===----------------------------------------------------------------------===//
32 /// Profile - Used to gather unique data for the abbreviation folding set.
34 void DIEAbbrevData::Profile(FoldingSetNodeID &ID) const {
35 ID.AddInteger(Attribute);
39 //===----------------------------------------------------------------------===//
40 // DIEAbbrev Implementation
41 //===----------------------------------------------------------------------===//
43 /// Profile - Used to gather unique data for the abbreviation folding set.
45 void DIEAbbrev::Profile(FoldingSetNodeID &ID) const {
47 ID.AddInteger(ChildrenFlag);
49 // For each attribute description.
50 for (unsigned i = 0, N = Data.size(); i < N; ++i)
54 /// Emit - Print the abbreviation using the specified asm printer.
56 void DIEAbbrev::Emit(AsmPrinter *AP) const {
57 // Emit its Dwarf tag type.
58 // FIXME: Doing work even in non-asm-verbose runs.
59 AP->EmitULEB128(Tag, dwarf::TagString(Tag));
61 // Emit whether it has children DIEs.
62 // FIXME: Doing work even in non-asm-verbose runs.
63 AP->EmitULEB128(ChildrenFlag, dwarf::ChildrenString(ChildrenFlag));
65 // For each attribute description.
66 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
67 const DIEAbbrevData &AttrData = Data[i];
69 // Emit attribute type.
70 // FIXME: Doing work even in non-asm-verbose runs.
71 AP->EmitULEB128(AttrData.getAttribute(),
72 dwarf::AttributeString(AttrData.getAttribute()));
75 // FIXME: Doing work even in non-asm-verbose runs.
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 DIE *DIE::getCompileUnit() {
120 if (p->getTag() == dwarf::DW_TAG_compile_unit)
124 llvm_unreachable("We should not have orphaned DIEs.");
128 void DIE::print(raw_ostream &O, unsigned IndentCount) const {
129 const std::string Indent(IndentCount, ' ');
130 bool isBlock = Abbrev.getTag() == 0;
135 << format("0x%lx", (long)(intptr_t)this)
136 << ", Offset: " << Offset
137 << ", Size: " << Size << "\n";
140 << dwarf::TagString(Abbrev.getTag())
142 << dwarf::ChildrenString(Abbrev.getChildrenFlag()) << "\n";
144 O << "Size: " << Size << "\n";
147 const SmallVectorImpl<DIEAbbrevData> &Data = Abbrev.getData();
150 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
154 O << dwarf::AttributeString(Data[i].getAttribute());
156 O << "Blk[" << i << "]";
159 << dwarf::FormEncodingString(Data[i].getForm())
166 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
167 Children[j]->print(O, IndentCount+4);
170 if (!isBlock) O << "\n";
178 void DIEValue::anchor() { }
181 void DIEValue::dump() {
186 //===----------------------------------------------------------------------===//
187 // DIEInteger Implementation
188 //===----------------------------------------------------------------------===//
190 /// EmitValue - Emit integer of appropriate size.
192 void DIEInteger::EmitValue(AsmPrinter *Asm, unsigned Form) const {
195 case dwarf::DW_FORM_flag_present:
196 // Emit something to keep the lines and comments in sync.
197 // FIXME: Is there a better way to do this?
198 if (Asm->OutStreamer.hasRawTextSupport())
199 Asm->OutStreamer.EmitRawText(StringRef(""));
201 case dwarf::DW_FORM_flag: // Fall thru
202 case dwarf::DW_FORM_ref1: // Fall thru
203 case dwarf::DW_FORM_data1: Size = 1; break;
204 case dwarf::DW_FORM_ref2: // Fall thru
205 case dwarf::DW_FORM_data2: Size = 2; break;
206 case dwarf::DW_FORM_sec_offset: // Fall thru
207 case dwarf::DW_FORM_ref4: // Fall thru
208 case dwarf::DW_FORM_data4: Size = 4; break;
209 case dwarf::DW_FORM_ref8: // Fall thru
210 case dwarf::DW_FORM_data8: Size = 8; break;
211 case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
212 case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
213 case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
214 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
215 case dwarf::DW_FORM_addr:
216 Size = Asm->getDataLayout().getPointerSize(); break;
217 default: llvm_unreachable("DIE Value form not supported yet");
219 Asm->OutStreamer.EmitIntValue(Integer, Size);
222 /// SizeOf - Determine size of integer value in bytes.
224 unsigned DIEInteger::SizeOf(AsmPrinter *AP, unsigned Form) const {
226 case dwarf::DW_FORM_flag_present: return 0;
227 case dwarf::DW_FORM_flag: // Fall thru
228 case dwarf::DW_FORM_ref1: // Fall thru
229 case dwarf::DW_FORM_data1: return sizeof(int8_t);
230 case dwarf::DW_FORM_ref2: // Fall thru
231 case dwarf::DW_FORM_data2: return sizeof(int16_t);
232 case dwarf::DW_FORM_sec_offset: // Fall thru
233 case dwarf::DW_FORM_ref4: // Fall thru
234 case dwarf::DW_FORM_data4: return sizeof(int32_t);
235 case dwarf::DW_FORM_ref8: // Fall thru
236 case dwarf::DW_FORM_data8: return sizeof(int64_t);
237 case dwarf::DW_FORM_GNU_str_index: return MCAsmInfo::getULEB128Size(Integer);
238 case dwarf::DW_FORM_GNU_addr_index: return MCAsmInfo::getULEB128Size(Integer);
239 case dwarf::DW_FORM_udata: return MCAsmInfo::getULEB128Size(Integer);
240 case dwarf::DW_FORM_sdata: return MCAsmInfo::getSLEB128Size(Integer);
241 case dwarf::DW_FORM_addr: return AP->getDataLayout().getPointerSize();
242 default: llvm_unreachable("DIE Value form not supported yet");
247 void DIEInteger::print(raw_ostream &O) {
248 O << "Int: " << (int64_t)Integer << " 0x";
249 O.write_hex(Integer);
253 //===----------------------------------------------------------------------===//
254 // DIELabel Implementation
255 //===----------------------------------------------------------------------===//
257 /// EmitValue - Emit label value.
259 void DIELabel::EmitValue(AsmPrinter *AP, unsigned Form) const {
260 AP->OutStreamer.EmitSymbolValue(Label, SizeOf(AP, Form));
263 /// SizeOf - Determine size of label value in bytes.
265 unsigned DIELabel::SizeOf(AsmPrinter *AP, unsigned Form) const {
266 if (Form == dwarf::DW_FORM_data4) return 4;
267 if (Form == dwarf::DW_FORM_sec_offset) return 4;
268 if (Form == dwarf::DW_FORM_strp) return 4;
269 return AP->getDataLayout().getPointerSize();
273 void DIELabel::print(raw_ostream &O) {
274 O << "Lbl: " << Label->getName();
278 //===----------------------------------------------------------------------===//
279 // DIEDelta Implementation
280 //===----------------------------------------------------------------------===//
282 /// EmitValue - Emit delta value.
284 void DIEDelta::EmitValue(AsmPrinter *AP, unsigned Form) const {
285 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
288 /// SizeOf - Determine size of delta value in bytes.
290 unsigned DIEDelta::SizeOf(AsmPrinter *AP, unsigned Form) const {
291 if (Form == dwarf::DW_FORM_data4) return 4;
292 if (Form == dwarf::DW_FORM_strp) return 4;
293 return AP->getDataLayout().getPointerSize();
297 void DIEDelta::print(raw_ostream &O) {
298 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
302 //===----------------------------------------------------------------------===//
303 // DIEEntry Implementation
304 //===----------------------------------------------------------------------===//
306 /// EmitValue - Emit debug information entry offset.
308 void DIEEntry::EmitValue(AsmPrinter *AP, unsigned Form) const {
309 AP->EmitInt32(Entry->getOffset());
313 void DIEEntry::print(raw_ostream &O) {
314 O << format("Die: 0x%lx", (long)(intptr_t)Entry);
318 //===----------------------------------------------------------------------===//
319 // DIEBlock Implementation
320 //===----------------------------------------------------------------------===//
322 /// ComputeSize - calculate the size of the block.
324 unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
326 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
327 for (unsigned i = 0, N = Values.size(); i < N; ++i)
328 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
334 /// EmitValue - Emit block data.
336 void DIEBlock::EmitValue(AsmPrinter *Asm, unsigned Form) const {
338 default: llvm_unreachable("Improper form for block");
339 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
340 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
341 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
342 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
345 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
346 for (unsigned i = 0, N = Values.size(); i < N; ++i)
347 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
350 /// SizeOf - Determine size of block data in bytes.
352 unsigned DIEBlock::SizeOf(AsmPrinter *AP, unsigned Form) const {
354 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
355 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
356 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
357 case dwarf::DW_FORM_block: return Size + MCAsmInfo::getULEB128Size(Size);
358 default: llvm_unreachable("Improper form for block");
363 void DIEBlock::print(raw_ostream &O) {