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/MC/MCAsmInfo.h"
18 #include "llvm/MC/MCStreamer.h"
19 #include "llvm/MC/MCSymbol.h"
20 #include "llvm/Target/TargetData.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"
26 using namespace llvm;
27 
28 //===----------------------------------------------------------------------===//
29 // DIEAbbrevData Implementation
30 //===----------------------------------------------------------------------===//
31 
32 /// Profile - Used to gather unique data for the abbreviation folding set.
33 ///
34 void 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 ///
45 void 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 ///
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));
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
86 void 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 }
103 void DIEAbbrev::dump() { print(dbgs()); }
104 #endif
105 
106 //===----------------------------------------------------------------------===//
107 // DIE Implementation
108 //===----------------------------------------------------------------------===//
109 
110 DIE::~DIE() {
111   for (unsigned i = 0, N = Children.size(); i < N; ++i)
112     delete Children[i];
113 }
114 
115 /// addSiblingOffset - Add a sibling offset field to the front of the DIE.
116 ///
117 DIEValue *DIE::addSiblingOffset(BumpPtrAllocator &A) {
118   DIEInteger *DI = new (A) DIEInteger(0);
119   Values.insert(Values.begin(), DI);
120   Abbrev.AddFirstAttribute(dwarf::DW_AT_sibling, dwarf::DW_FORM_ref4);
121   return DI;
122 }
123 
124 #ifndef NDEBUG
125 void DIE::print(raw_ostream &O, unsigned IncIndent) {
126   IndentCount += IncIndent;
127   const std::string Indent(IndentCount, ' ');
128   bool isBlock = Abbrev.getTag() == 0;
129 
130   if (!isBlock) {
131     O << Indent
132       << "Die: "
133       << format("0x%lx", (long)(intptr_t)this)
134       << ", Offset: " << Offset
135       << ", Size: " << Size << "\n";
136 
137     O << Indent
138       << dwarf::TagString(Abbrev.getTag())
139       << " "
140       << dwarf::ChildrenString(Abbrev.getChildrenFlag()) << "\n";
141   } else {
142     O << "Size: " << Size << "\n";
143   }
144 
145   const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
146 
147   IndentCount += 2;
148   for (unsigned i = 0, N = Data.size(); i < N; ++i) {
149     O << Indent;
150 
151     if (!isBlock)
152       O << dwarf::AttributeString(Data[i].getAttribute());
153     else
154       O << "Blk[" << i << "]";
155 
156     O <<  "  "
157       << dwarf::FormEncodingString(Data[i].getForm())
158       << " ";
159     Values[i]->print(O);
160     O << "\n";
161   }
162   IndentCount -= 2;
163 
164   for (unsigned j = 0, M = Children.size(); j < M; ++j) {
165     Children[j]->print(O, 4);
166   }
167 
168   if (!isBlock) O << "\n";
169   IndentCount -= IncIndent;
170 }
171 
172 void DIE::dump() {
173   print(dbgs());
174 }
175 #endif
176 
177 
178 #ifndef NDEBUG
179 void DIEValue::dump() {
180   print(dbgs());
181 }
182 #endif
183 
184 //===----------------------------------------------------------------------===//
185 // DIEInteger Implementation
186 //===----------------------------------------------------------------------===//
187 
188 /// EmitValue - Emit integer of appropriate size.
189 ///
190 void DIEInteger::EmitValue(AsmPrinter *Asm, unsigned Form) const {
191   unsigned Size = ~0U;
192   switch (Form) {
193   case dwarf::DW_FORM_flag:  // Fall thru
194   case dwarf::DW_FORM_ref1:  // Fall thru
195   case dwarf::DW_FORM_data1: Size = 1; break;
196   case dwarf::DW_FORM_ref2:  // Fall thru
197   case dwarf::DW_FORM_data2: Size = 2; break;
198   case dwarf::DW_FORM_ref4:  // Fall thru
199   case dwarf::DW_FORM_data4: Size = 4; break;
200   case dwarf::DW_FORM_ref8:  // Fall thru
201   case dwarf::DW_FORM_data8: Size = 8; break;
202   case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
203   case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
204   default: llvm_unreachable("DIE Value form not supported yet");
205   }
206   Asm->OutStreamer.EmitIntValue(Integer, Size, 0/*addrspace*/);
207 }
208 
209 /// SizeOf - Determine size of integer value in bytes.
210 ///
211 unsigned DIEInteger::SizeOf(AsmPrinter *AP, unsigned Form) const {
212   switch (Form) {
213   case dwarf::DW_FORM_flag:  // Fall thru
214   case dwarf::DW_FORM_ref1:  // Fall thru
215   case dwarf::DW_FORM_data1: return sizeof(int8_t);
216   case dwarf::DW_FORM_ref2:  // Fall thru
217   case dwarf::DW_FORM_data2: return sizeof(int16_t);
218   case dwarf::DW_FORM_ref4:  // Fall thru
219   case dwarf::DW_FORM_data4: return sizeof(int32_t);
220   case dwarf::DW_FORM_ref8:  // Fall thru
221   case dwarf::DW_FORM_data8: return sizeof(int64_t);
222   case dwarf::DW_FORM_udata: return MCAsmInfo::getULEB128Size(Integer);
223   case dwarf::DW_FORM_sdata: return MCAsmInfo::getSLEB128Size(Integer);
224   default: llvm_unreachable("DIE Value form not supported yet"); break;
225   }
226   return 0;
227 }
228 
229 #ifndef NDEBUG
230 void DIEInteger::print(raw_ostream &O) {
231   O << "Int: " << (int64_t)Integer
232     << format("  0x%llx", (unsigned long long)Integer);
233 }
234 #endif
235 
236 //===----------------------------------------------------------------------===//
237 // DIEString Implementation
238 //===----------------------------------------------------------------------===//
239 
240 /// EmitValue - Emit string value.
241 ///
242 void DIEString::EmitValue(AsmPrinter *AP, unsigned Form) const {
243   AP->OutStreamer.EmitBytes(Str, /*addrspace*/0);
244   // Emit nul terminator.
245   AP->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0);
246 }
247 
248 #ifndef NDEBUG
249 void DIEString::print(raw_ostream &O) {
250   O << "Str: \"" << Str << "\"";
251 }
252 #endif
253 
254 //===----------------------------------------------------------------------===//
255 // DIELabel Implementation
256 //===----------------------------------------------------------------------===//
257 
258 /// EmitValue - Emit label value.
259 ///
260 void DIELabel::EmitValue(AsmPrinter *AP, unsigned Form) const {
261   AP->OutStreamer.EmitSymbolValue(Label, SizeOf(AP, Form), 0/*AddrSpace*/);
262 }
263 
264 /// SizeOf - Determine size of label value in bytes.
265 ///
266 unsigned DIELabel::SizeOf(AsmPrinter *AP, unsigned Form) const {
267   if (Form == dwarf::DW_FORM_data4) return 4;
268   return AP->getTargetData().getPointerSize();
269 }
270 
271 #ifndef NDEBUG
272 void DIELabel::print(raw_ostream &O) {
273   O << "Lbl: " << Label->getName();
274 }
275 #endif
276 
277 //===----------------------------------------------------------------------===//
278 // DIEDelta Implementation
279 //===----------------------------------------------------------------------===//
280 
281 /// EmitValue - Emit delta value.
282 ///
283 void DIEDelta::EmitValue(AsmPrinter *AP, unsigned Form) const {
284   AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
285 }
286 
287 /// SizeOf - Determine size of delta value in bytes.
288 ///
289 unsigned DIEDelta::SizeOf(AsmPrinter *AP, unsigned Form) const {
290   if (Form == dwarf::DW_FORM_data4) return 4;
291   return AP->getTargetData().getPointerSize();
292 }
293 
294 #ifndef NDEBUG
295 void DIEDelta::print(raw_ostream &O) {
296   O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
297 }
298 #endif
299 
300 //===----------------------------------------------------------------------===//
301 // DIEEntry Implementation
302 //===----------------------------------------------------------------------===//
303 
304 /// EmitValue - Emit debug information entry offset.
305 ///
306 void DIEEntry::EmitValue(AsmPrinter *AP, unsigned Form) const {
307   AP->EmitInt32(Entry->getOffset());
308 }
309 
310 #ifndef NDEBUG
311 void DIEEntry::print(raw_ostream &O) {
312   O << format("Die: 0x%lx", (long)(intptr_t)Entry);
313 }
314 #endif
315 
316 //===----------------------------------------------------------------------===//
317 // DIEBlock Implementation
318 //===----------------------------------------------------------------------===//
319 
320 /// ComputeSize - calculate the size of the block.
321 ///
322 unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
323   if (!Size) {
324     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
325     for (unsigned i = 0, N = Values.size(); i < N; ++i)
326       Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
327   }
328 
329   return Size;
330 }
331 
332 /// EmitValue - Emit block data.
333 ///
334 void DIEBlock::EmitValue(AsmPrinter *Asm, unsigned Form) const {
335   switch (Form) {
336   default: assert(0 && "Improper form for block");    break;
337   case dwarf::DW_FORM_block1: Asm->EmitInt8(Size);    break;
338   case dwarf::DW_FORM_block2: Asm->EmitInt16(Size);   break;
339   case dwarf::DW_FORM_block4: Asm->EmitInt32(Size);   break;
340   case dwarf::DW_FORM_block:  Asm->EmitULEB128(Size); break;
341   }
342 
343   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
344   for (unsigned i = 0, N = Values.size(); i < N; ++i)
345     Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
346 }
347 
348 /// SizeOf - Determine size of block data in bytes.
349 ///
350 unsigned DIEBlock::SizeOf(AsmPrinter *AP, unsigned Form) const {
351   switch (Form) {
352   case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
353   case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
354   case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
355   case dwarf::DW_FORM_block:  return Size + MCAsmInfo::getULEB128Size(Size);
356   default: llvm_unreachable("Improper form for block"); break;
357   }
358   return 0;
359 }
360 
361 #ifndef NDEBUG
362 void DIEBlock::print(raw_ostream &O) {
363   O << "Blk: ";
364   DIE::print(O, 5);
365 }
366 #endif
367