DIE.cpp revision ca1dd05c3c12e857614ae6837f90894396225dd6 
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#ifndef NDEBUG
116void DIE::print(raw_ostream &O, unsigned IncIndent) {
117  IndentCount += IncIndent;
118  const std::string Indent(IndentCount, ' ');
119  bool isBlock = Abbrev.getTag() == 0;
120
121  if (!isBlock) {
122    O << Indent
123      << "Die: "
124      << format("0x%lx", (long)(intptr_t)this)
125      << ", Offset: " << Offset
126      << ", Size: " << Size << "\n";
127
128    O << Indent
129      << dwarf::TagString(Abbrev.getTag())
130      << " "
131      << dwarf::ChildrenString(Abbrev.getChildrenFlag()) << "\n";
132  } else {
133    O << "Size: " << Size << "\n";
134  }
135
136  const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
137
138  IndentCount += 2;
139  for (unsigned i = 0, N = Data.size(); i < N; ++i) {
140    O << Indent;
141
142    if (!isBlock)
143      O << dwarf::AttributeString(Data[i].getAttribute());
144    else
145      O << "Blk[" << i << "]";
146
147    O <<  "  "
148      << dwarf::FormEncodingString(Data[i].getForm())
149      << " ";
150    Values[i]->print(O);
151    O << "\n";
152  }
153  IndentCount -= 2;
154
155  for (unsigned j = 0, M = Children.size(); j < M; ++j) {
156    Children[j]->print(O, 4);
157  }
158
159  if (!isBlock) O << "\n";
160  IndentCount -= IncIndent;
161}
162
163void DIE::dump() {
164  print(dbgs());
165}
166#endif
167
168void DIEValue::anchor() { }
169
170#ifndef NDEBUG
171void DIEValue::dump() {
172  print(dbgs());
173}
174#endif
175
176//===----------------------------------------------------------------------===//
177// DIEInteger Implementation
178//===----------------------------------------------------------------------===//
179
180/// EmitValue - Emit integer of appropriate size.
181///
182void DIEInteger::EmitValue(AsmPrinter *Asm, unsigned Form) const {
183  unsigned Size = ~0U;
184  switch (Form) {
185  case dwarf::DW_FORM_flag_present:
186    // Emit something to keep the lines and comments in sync.
187    // FIXME: Is there a better way to do this?
188    if (Asm->OutStreamer.hasRawTextSupport())
189      Asm->OutStreamer.EmitRawText(StringRef(""));
190    return;
191  case dwarf::DW_FORM_flag:  // Fall thru
192  case dwarf::DW_FORM_ref1:  // Fall thru
193  case dwarf::DW_FORM_data1: Size = 1; break;
194  case dwarf::DW_FORM_ref2:  // Fall thru
195  case dwarf::DW_FORM_data2: Size = 2; break;
196  case dwarf::DW_FORM_ref4:  // Fall thru
197  case dwarf::DW_FORM_data4: Size = 4; break;
198  case dwarf::DW_FORM_ref8:  // Fall thru
199  case dwarf::DW_FORM_data8: Size = 8; break;
200  case dwarf::DW_FORM_GNU_str_index: Asm->EmitULEB128(Integer); return;
201  case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
202  case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
203  case dwarf::DW_FORM_addr:
204    Size = Asm->getDataLayout().getPointerSize(); break;
205  default: llvm_unreachable("DIE Value form not supported yet");
206  }
207  Asm->OutStreamer.EmitIntValue(Integer, Size);
208}
209
210/// SizeOf - Determine size of integer value in bytes.
211///
212unsigned DIEInteger::SizeOf(AsmPrinter *AP, unsigned Form) const {
213  switch (Form) {
214  case dwarf::DW_FORM_flag_present: return 0;
215  case dwarf::DW_FORM_flag:  // Fall thru
216  case dwarf::DW_FORM_ref1:  // Fall thru
217  case dwarf::DW_FORM_data1: return sizeof(int8_t);
218  case dwarf::DW_FORM_ref2:  // Fall thru
219  case dwarf::DW_FORM_data2: return sizeof(int16_t);
220  case dwarf::DW_FORM_ref4:  // Fall thru
221  case dwarf::DW_FORM_data4: return sizeof(int32_t);
222  case dwarf::DW_FORM_ref8:  // Fall thru
223  case dwarf::DW_FORM_data8: return sizeof(int64_t);
224  case dwarf::DW_FORM_GNU_str_index: return MCAsmInfo::getULEB128Size(Integer);
225  case dwarf::DW_FORM_udata: return MCAsmInfo::getULEB128Size(Integer);
226  case dwarf::DW_FORM_sdata: return MCAsmInfo::getSLEB128Size(Integer);
227  case dwarf::DW_FORM_addr:  return AP->getDataLayout().getPointerSize();
228  default: llvm_unreachable("DIE Value form not supported yet");
229  }
230}
231
232#ifndef NDEBUG
233void DIEInteger::print(raw_ostream &O) {
234  O << "Int: " << (int64_t)Integer << "  0x";
235  O.write_hex(Integer);
236}
237#endif
238
239//===----------------------------------------------------------------------===//
240// DIELabel Implementation
241//===----------------------------------------------------------------------===//
242
243/// EmitValue - Emit label value.
244///
245void DIELabel::EmitValue(AsmPrinter *AP, unsigned Form) const {
246  AP->OutStreamer.EmitSymbolValue(Label, SizeOf(AP, Form));
247}
248
249/// SizeOf - Determine size of label value in bytes.
250///
251unsigned DIELabel::SizeOf(AsmPrinter *AP, unsigned Form) const {
252  if (Form == dwarf::DW_FORM_data4) return 4;
253  if (Form == dwarf::DW_FORM_strp) return 4;
254  return AP->getDataLayout().getPointerSize();
255}
256
257#ifndef NDEBUG
258void DIELabel::print(raw_ostream &O) {
259  O << "Lbl: " << Label->getName();
260}
261#endif
262
263//===----------------------------------------------------------------------===//
264// DIEDelta Implementation
265//===----------------------------------------------------------------------===//
266
267/// EmitValue - Emit delta value.
268///
269void DIEDelta::EmitValue(AsmPrinter *AP, unsigned Form) const {
270  AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
271}
272
273/// SizeOf - Determine size of delta value in bytes.
274///
275unsigned DIEDelta::SizeOf(AsmPrinter *AP, unsigned Form) const {
276  if (Form == dwarf::DW_FORM_data4) return 4;
277  if (Form == dwarf::DW_FORM_strp) return 4;
278  return AP->getDataLayout().getPointerSize();
279}
280
281#ifndef NDEBUG
282void DIEDelta::print(raw_ostream &O) {
283  O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
284}
285#endif
286
287//===----------------------------------------------------------------------===//
288// DIEEntry Implementation
289//===----------------------------------------------------------------------===//
290
291/// EmitValue - Emit debug information entry offset.
292///
293void DIEEntry::EmitValue(AsmPrinter *AP, unsigned Form) const {
294  AP->EmitInt32(Entry->getOffset());
295}
296
297#ifndef NDEBUG
298void DIEEntry::print(raw_ostream &O) {
299  O << format("Die: 0x%lx", (long)(intptr_t)Entry);
300}
301#endif
302
303//===----------------------------------------------------------------------===//
304// DIEBlock Implementation
305//===----------------------------------------------------------------------===//
306
307/// ComputeSize - calculate the size of the block.
308///
309unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
310  if (!Size) {
311    const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
312    for (unsigned i = 0, N = Values.size(); i < N; ++i)
313      Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
314  }
315
316  return Size;
317}
318
319/// EmitValue - Emit block data.
320///
321void DIEBlock::EmitValue(AsmPrinter *Asm, unsigned Form) const {
322  switch (Form) {
323  default: llvm_unreachable("Improper form for block");
324  case dwarf::DW_FORM_block1: Asm->EmitInt8(Size);    break;
325  case dwarf::DW_FORM_block2: Asm->EmitInt16(Size);   break;
326  case dwarf::DW_FORM_block4: Asm->EmitInt32(Size);   break;
327  case dwarf::DW_FORM_block:  Asm->EmitULEB128(Size); break;
328  }
329
330  const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
331  for (unsigned i = 0, N = Values.size(); i < N; ++i)
332    Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
333}
334
335/// SizeOf - Determine size of block data in bytes.
336///
337unsigned DIEBlock::SizeOf(AsmPrinter *AP, unsigned Form) const {
338  switch (Form) {
339  case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
340  case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
341  case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
342  case dwarf::DW_FORM_block:  return Size + MCAsmInfo::getULEB128Size(Size);
343  default: llvm_unreachable("Improper form for block");
344  }
345}
346
347#ifndef NDEBUG
348void DIEBlock::print(raw_ostream &O) {
349  O << "Blk: ";
350  DIE::print(O, 5);
351}
352#endif
353