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 ///
Profile(FoldingSetNodeID & ID) const34 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 ///
Profile(FoldingSetNodeID & ID) const45 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 ///
Emit(AsmPrinter * AP) const56 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
print(raw_ostream & O)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 }
dump()103 void DIEAbbrev::dump() { print(dbgs()); }
104 #endif
105
106 //===----------------------------------------------------------------------===//
107 // DIE Implementation
108 //===----------------------------------------------------------------------===//
109
~DIE()110 DIE::~DIE() {
111 for (unsigned i = 0, N = Children.size(); i < N; ++i)
112 delete Children[i];
113 }
114
115 #ifndef NDEBUG
print(raw_ostream & O,unsigned IncIndent)116 void 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
dump()163 void DIE::dump() {
164 print(dbgs());
165 }
166 #endif
167
anchor()168 void DIEValue::anchor() { }
169
170 #ifndef NDEBUG
dump()171 void DIEValue::dump() {
172 print(dbgs());
173 }
174 #endif
175
176 //===----------------------------------------------------------------------===//
177 // DIEInteger Implementation
178 //===----------------------------------------------------------------------===//
179
180 /// EmitValue - Emit integer of appropriate size.
181 ///
EmitValue(AsmPrinter * Asm,unsigned Form) const182 void 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_udata: Asm->EmitULEB128(Integer); return;
201 case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
202 case dwarf::DW_FORM_addr: Size = Asm->getTargetData().getPointerSize(); break;
203 default: llvm_unreachable("DIE Value form not supported yet");
204 }
205 Asm->OutStreamer.EmitIntValue(Integer, Size, 0/*addrspace*/);
206 }
207
208 /// SizeOf - Determine size of integer value in bytes.
209 ///
SizeOf(AsmPrinter * AP,unsigned Form) const210 unsigned DIEInteger::SizeOf(AsmPrinter *AP, unsigned Form) const {
211 switch (Form) {
212 case dwarf::DW_FORM_flag_present: return 0;
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 case dwarf::DW_FORM_addr: return AP->getTargetData().getPointerSize();
225 default: llvm_unreachable("DIE Value form not supported yet");
226 }
227 }
228
229 #ifndef NDEBUG
print(raw_ostream & O)230 void DIEInteger::print(raw_ostream &O) {
231 O << "Int: " << (int64_t)Integer << " 0x";
232 O.write_hex(Integer);
233 }
234 #endif
235
236 //===----------------------------------------------------------------------===//
237 // DIELabel Implementation
238 //===----------------------------------------------------------------------===//
239
240 /// EmitValue - Emit label value.
241 ///
EmitValue(AsmPrinter * AP,unsigned Form) const242 void DIELabel::EmitValue(AsmPrinter *AP, unsigned Form) const {
243 AP->OutStreamer.EmitSymbolValue(Label, SizeOf(AP, Form), 0/*AddrSpace*/);
244 }
245
246 /// SizeOf - Determine size of label value in bytes.
247 ///
SizeOf(AsmPrinter * AP,unsigned Form) const248 unsigned DIELabel::SizeOf(AsmPrinter *AP, unsigned Form) const {
249 if (Form == dwarf::DW_FORM_data4) return 4;
250 if (Form == dwarf::DW_FORM_strp) return 4;
251 return AP->getTargetData().getPointerSize();
252 }
253
254 #ifndef NDEBUG
print(raw_ostream & O)255 void DIELabel::print(raw_ostream &O) {
256 O << "Lbl: " << Label->getName();
257 }
258 #endif
259
260 //===----------------------------------------------------------------------===//
261 // DIEDelta Implementation
262 //===----------------------------------------------------------------------===//
263
264 /// EmitValue - Emit delta value.
265 ///
EmitValue(AsmPrinter * AP,unsigned Form) const266 void DIEDelta::EmitValue(AsmPrinter *AP, unsigned Form) const {
267 AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
268 }
269
270 /// SizeOf - Determine size of delta value in bytes.
271 ///
SizeOf(AsmPrinter * AP,unsigned Form) const272 unsigned DIEDelta::SizeOf(AsmPrinter *AP, unsigned Form) const {
273 if (Form == dwarf::DW_FORM_data4) return 4;
274 if (Form == dwarf::DW_FORM_strp) return 4;
275 return AP->getTargetData().getPointerSize();
276 }
277
278 #ifndef NDEBUG
print(raw_ostream & O)279 void DIEDelta::print(raw_ostream &O) {
280 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
281 }
282 #endif
283
284 //===----------------------------------------------------------------------===//
285 // DIEEntry Implementation
286 //===----------------------------------------------------------------------===//
287
288 /// EmitValue - Emit debug information entry offset.
289 ///
EmitValue(AsmPrinter * AP,unsigned Form) const290 void DIEEntry::EmitValue(AsmPrinter *AP, unsigned Form) const {
291 AP->EmitInt32(Entry->getOffset());
292 }
293
294 #ifndef NDEBUG
print(raw_ostream & O)295 void DIEEntry::print(raw_ostream &O) {
296 O << format("Die: 0x%lx", (long)(intptr_t)Entry);
297 }
298 #endif
299
300 //===----------------------------------------------------------------------===//
301 // DIEBlock Implementation
302 //===----------------------------------------------------------------------===//
303
304 /// ComputeSize - calculate the size of the block.
305 ///
ComputeSize(AsmPrinter * AP)306 unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
307 if (!Size) {
308 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
309 for (unsigned i = 0, N = Values.size(); i < N; ++i)
310 Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
311 }
312
313 return Size;
314 }
315
316 /// EmitValue - Emit block data.
317 ///
EmitValue(AsmPrinter * Asm,unsigned Form) const318 void DIEBlock::EmitValue(AsmPrinter *Asm, unsigned Form) const {
319 switch (Form) {
320 default: llvm_unreachable("Improper form for block");
321 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
322 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
323 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
324 case dwarf::DW_FORM_block: Asm->EmitULEB128(Size); break;
325 }
326
327 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
328 for (unsigned i = 0, N = Values.size(); i < N; ++i)
329 Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
330 }
331
332 /// SizeOf - Determine size of block data in bytes.
333 ///
SizeOf(AsmPrinter * AP,unsigned Form) const334 unsigned DIEBlock::SizeOf(AsmPrinter *AP, unsigned Form) const {
335 switch (Form) {
336 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
337 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
338 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
339 case dwarf::DW_FORM_block: return Size + MCAsmInfo::getULEB128Size(Size);
340 default: llvm_unreachable("Improper form for block");
341 }
342 }
343
344 #ifndef NDEBUG
print(raw_ostream & O)345 void DIEBlock::print(raw_ostream &O) {
346 O << "Blk: ";
347 DIE::print(O, 5);
348 }
349 #endif
350