DIE.cpp revision 3bf2bcd96ce03a83967d9f256d23455e0e2ccefd 
1//===--- lib/CodeGen/DIE.cpp - DWARF Info Entries -------------------------===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// Data structures for DWARF info entries.
11//
12//===----------------------------------------------------------------------===//
13
14#include "DIE.h"
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"
26using namespace llvm;
27
28//===----------------------------------------------------------------------===//
29// DIEAbbrevData Implementation
30//===----------------------------------------------------------------------===//
31
32/// Profile - Used to gather unique data for the abbreviation folding set.
33///
34void DIEAbbrevData::Profile(FoldingSetNodeID &ID) const {
35  ID.AddInteger(Attribute);
36  ID.AddInteger(Form);
37}
38
39//===----------------------------------------------------------------------===//
40// DIEAbbrev Implementation
41//===----------------------------------------------------------------------===//
42
43/// Profile - Used to gather unique data for the abbreviation folding set.
44///
45void DIEAbbrev::Profile(FoldingSetNodeID &ID) const {
46  ID.AddInteger(Tag);
47  ID.AddInteger(ChildrenFlag);
48
49  // For each attribute description.
50  for (unsigned i = 0, N = Data.size(); i < N; ++i)
51    Data[i].Profile(ID);
52}
53
54/// Emit - Print the abbreviation using the specified asm printer.
55///
56void 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));
60
61  // Emit whether it has children DIEs.
62  // FIXME: Doing work even in non-asm-verbose runs.
63  AP->EmitULEB128(ChildrenFlag, dwarf::ChildrenString(ChildrenFlag));
64
65  // For each attribute description.
66  for (unsigned i = 0, N = Data.size(); i < N; ++i) {
67    const DIEAbbrevData &AttrData = Data[i];
68
69    // Emit attribute type.
70    // FIXME: Doing work even in non-asm-verbose runs.
71    AP->EmitULEB128(AttrData.getAttribute(),
72                    dwarf::AttributeString(AttrData.getAttribute()));
73
74    // Emit form type.
75    // FIXME: Doing work even in non-asm-verbose runs.
76    AP->EmitULEB128(AttrData.getForm(),
77                    dwarf::FormEncodingString(AttrData.getForm()));
78  }
79
80  // Mark end of abbreviation.
81  AP->EmitULEB128(0, "EOM(1)");
82  AP->EmitULEB128(0, "EOM(2)");
83}
84
85#ifndef NDEBUG
86void DIEAbbrev::print(raw_ostream &O) {
87  O << "Abbreviation @"
88    << format("0x%lx", (long)(intptr_t)this)
89    << "  "
90    << dwarf::TagString(Tag)
91    << " "
92    << dwarf::ChildrenString(ChildrenFlag)
93    << '\n';
94
95  for (unsigned i = 0, N = Data.size(); i < N; ++i) {
96    O << "  "
97      << dwarf::AttributeString(Data[i].getAttribute())
98      << "  "
99      << dwarf::FormEncodingString(Data[i].getForm())
100      << '\n';
101  }
102}
103void DIEAbbrev::dump() { print(dbgs()); }
104#endif
105
106//===----------------------------------------------------------------------===//
107// DIE Implementation
108//===----------------------------------------------------------------------===//
109
110DIE::~DIE() {
111  for (unsigned i = 0, N = Children.size(); i < N; ++i)
112    delete Children[i];
113}
114
115/// Climb up the parent chain to get the compile unit DIE to which this DIE
116/// belongs.
117DIE *DIE::getCompileUnit() const{
118  DIE *p = getParent();
119  while (p) {
120    if (p->getTag() == dwarf::DW_TAG_compile_unit)
121      return p;
122    p = p->getParent();
123  }
124  llvm_unreachable("We should not have orphaned DIEs.");
125}
126
127#ifndef NDEBUG
128void DIE::print(raw_ostream &O, unsigned IncIndent) {
129  IndentCount += IncIndent;
130  const std::string Indent(IndentCount, ' ');
131  bool isBlock = Abbrev.getTag() == 0;
132
133  if (!isBlock) {
134    O << Indent
135      << "Die: "
136      << format("0x%lx", (long)(intptr_t)this)
137      << ", Offset: " << Offset
138      << ", Size: " << Size << "\n";
139
140    O << Indent
141      << dwarf::TagString(Abbrev.getTag())
142      << " "
143      << dwarf::ChildrenString(Abbrev.getChildrenFlag()) << "\n";
144  } else {
145    O << "Size: " << Size << "\n";
146  }
147
148  const SmallVectorImpl<DIEAbbrevData> &Data = Abbrev.getData();
149
150  IndentCount += 2;
151  for (unsigned i = 0, N = Data.size(); i < N; ++i) {
152    O << Indent;
153
154    if (!isBlock)
155      O << dwarf::AttributeString(Data[i].getAttribute());
156    else
157      O << "Blk[" << i << "]";
158
159    O <<  "  "
160      << dwarf::FormEncodingString(Data[i].getForm())
161      << " ";
162    Values[i]->print(O);
163    O << "\n";
164  }
165  IndentCount -= 2;
166
167  for (unsigned j = 0, M = Children.size(); j < M; ++j) {
168    Children[j]->print(O, 4);
169  }
170
171  if (!isBlock) O << "\n";
172  IndentCount -= IncIndent;
173}
174
175void DIE::dump() {
176  print(dbgs());
177}
178#endif
179
180void DIEValue::anchor() { }
181
182#ifndef NDEBUG
183void DIEValue::dump() {
184  print(dbgs());
185}
186#endif
187
188//===----------------------------------------------------------------------===//
189// DIEInteger Implementation
190//===----------------------------------------------------------------------===//
191
192/// EmitValue - Emit integer of appropriate size.
193///
194void DIEInteger::EmitValue(AsmPrinter *Asm, unsigned Form) const {
195  unsigned Size = ~0U;
196  switch (Form) {
197  case dwarf::DW_FORM_flag_present:
198    // Emit something to keep the lines and comments in sync.
199    // FIXME: Is there a better way to do this?
200    if (Asm->OutStreamer.hasRawTextSupport())
201      Asm->OutStreamer.EmitRawText(StringRef(""));
202    return;
203  case dwarf::DW_FORM_flag:  // Fall thru
204  case dwarf::DW_FORM_ref1:  // Fall thru
205  case dwarf::DW_FORM_data1: Size = 1; break;
206  case dwarf::DW_FORM_ref2:  // Fall thru
207  case dwarf::DW_FORM_data2: Size = 2; break;
208  case dwarf::DW_FORM_sec_offset: // Fall thru
209  case dwarf::DW_FORM_ref4:  // Fall thru
210  case dwarf::DW_FORM_data4: Size = 4; break;
211  case dwarf::DW_FORM_ref8:  // Fall thru
212  case dwarf::DW_FORM_data8: Size = 8; break;
213  case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
214  case dwarf::DW_FORM_GNU_addr_index: Asm->EmitULEB128(Integer); return;
215  case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
216  case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
217  case dwarf::DW_FORM_addr:
218    Size = Asm->getDataLayout().getPointerSize(); break;
219  default: llvm_unreachable("DIE Value form not supported yet");
220  }
221  Asm->OutStreamer.EmitIntValue(Integer, Size);
222}
223
224/// SizeOf - Determine size of integer value in bytes.
225///
226unsigned DIEInteger::SizeOf(AsmPrinter *AP, unsigned Form) const {
227  switch (Form) {
228  case dwarf::DW_FORM_flag_present: return 0;
229  case dwarf::DW_FORM_flag:  // Fall thru
230  case dwarf::DW_FORM_ref1:  // Fall thru
231  case dwarf::DW_FORM_data1: return sizeof(int8_t);
232  case dwarf::DW_FORM_ref2:  // Fall thru
233  case dwarf::DW_FORM_data2: return sizeof(int16_t);
234  case dwarf::DW_FORM_sec_offset: // Fall thru
235  case dwarf::DW_FORM_ref4:  // Fall thru
236  case dwarf::DW_FORM_data4: return sizeof(int32_t);
237  case dwarf::DW_FORM_ref8:  // Fall thru
238  case dwarf::DW_FORM_data8: return sizeof(int64_t);
239  case dwarf::DW_FORM_GNU_str_index: return MCAsmInfo::getULEB128Size(Integer);
240  case dwarf::DW_FORM_GNU_addr_index: return MCAsmInfo::getULEB128Size(Integer);
241  case dwarf::DW_FORM_udata: return MCAsmInfo::getULEB128Size(Integer);
242  case dwarf::DW_FORM_sdata: return MCAsmInfo::getSLEB128Size(Integer);
243  case dwarf::DW_FORM_addr:  return AP->getDataLayout().getPointerSize();
244  default: llvm_unreachable("DIE Value form not supported yet");
245  }
246}
247
248#ifndef NDEBUG
249void DIEInteger::print(raw_ostream &O) {
250  O << "Int: " << (int64_t)Integer << "  0x";
251  O.write_hex(Integer);
252}
253#endif
254
255//===----------------------------------------------------------------------===//
256// DIELabel Implementation
257//===----------------------------------------------------------------------===//
258
259/// EmitValue - Emit label value.
260///
261void DIELabel::EmitValue(AsmPrinter *AP, unsigned Form) const {
262  AP->OutStreamer.EmitSymbolValue(Label, SizeOf(AP, Form));
263}
264
265/// SizeOf - Determine size of label value in bytes.
266///
267unsigned DIELabel::SizeOf(AsmPrinter *AP, unsigned Form) const {
268  if (Form == dwarf::DW_FORM_data4) return 4;
269  if (Form == dwarf::DW_FORM_sec_offset) return 4;
270  if (Form == dwarf::DW_FORM_strp) return 4;
271  return AP->getDataLayout().getPointerSize();
272}
273
274#ifndef NDEBUG
275void DIELabel::print(raw_ostream &O) {
276  O << "Lbl: " << Label->getName();
277}
278#endif
279
280//===----------------------------------------------------------------------===//
281// DIEDelta Implementation
282//===----------------------------------------------------------------------===//
283
284/// EmitValue - Emit delta value.
285///
286void DIEDelta::EmitValue(AsmPrinter *AP, unsigned Form) const {
287  AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
288}
289
290/// SizeOf - Determine size of delta value in bytes.
291///
292unsigned DIEDelta::SizeOf(AsmPrinter *AP, unsigned Form) const {
293  if (Form == dwarf::DW_FORM_data4) return 4;
294  if (Form == dwarf::DW_FORM_strp) return 4;
295  return AP->getDataLayout().getPointerSize();
296}
297
298#ifndef NDEBUG
299void DIEDelta::print(raw_ostream &O) {
300  O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
301}
302#endif
303
304//===----------------------------------------------------------------------===//
305// DIEEntry Implementation
306//===----------------------------------------------------------------------===//
307
308/// EmitValue - Emit debug information entry offset.
309///
310void DIEEntry::EmitValue(AsmPrinter *AP, unsigned Form) const {
311  AP->EmitInt32(Entry->getOffset());
312}
313
314#ifndef NDEBUG
315void DIEEntry::print(raw_ostream &O) {
316  O << format("Die: 0x%lx", (long)(intptr_t)Entry);
317}
318#endif
319
320//===----------------------------------------------------------------------===//
321// DIEBlock Implementation
322//===----------------------------------------------------------------------===//
323
324/// ComputeSize - calculate the size of the block.
325///
326unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
327  if (!Size) {
328    const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
329    for (unsigned i = 0, N = Values.size(); i < N; ++i)
330      Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
331  }
332
333  return Size;
334}
335
336/// EmitValue - Emit block data.
337///
338void DIEBlock::EmitValue(AsmPrinter *Asm, unsigned Form) const {
339  switch (Form) {
340  default: llvm_unreachable("Improper form for block");
341  case dwarf::DW_FORM_block1: Asm->EmitInt8(Size);    break;
342  case dwarf::DW_FORM_block2: Asm->EmitInt16(Size);   break;
343  case dwarf::DW_FORM_block4: Asm->EmitInt32(Size);   break;
344  case dwarf::DW_FORM_block:  Asm->EmitULEB128(Size); break;
345  }
346
347  const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
348  for (unsigned i = 0, N = Values.size(); i < N; ++i)
349    Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
350}
351
352/// SizeOf - Determine size of block data in bytes.
353///
354unsigned DIEBlock::SizeOf(AsmPrinter *AP, unsigned Form) const {
355  switch (Form) {
356  case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
357  case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
358  case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
359  case dwarf::DW_FORM_block:  return Size + MCAsmInfo::getULEB128Size(Size);
360  default: llvm_unreachable("Improper form for block");
361  }
362}
363
364#ifndef NDEBUG
365void DIEBlock::print(raw_ostream &O) {
366  O << "Blk: ";
367  DIE::print(O, 5);
368}
369#endif
370