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 "DwarfPrinter.h"
16 #include "llvm/ADT/Twine.h"
17 #include "llvm/CodeGen/AsmPrinter.h"
18 #include "llvm/MC/MCAsmInfo.h"
19 #include "llvm/MC/MCStreamer.h"
20 #include "llvm/MC/MCSymbol.h"
21 #include "llvm/Target/TargetData.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(const DwarfPrinter *DP) const {
57 // Emit its Dwarf tag type.
58 // FIXME: Doing work even in non-asm-verbose runs.
59 DP->EmitULEB128(Tag, dwarf::TagString(Tag));
61 // Emit whether it has children DIEs.
62 // FIXME: Doing work even in non-asm-verbose runs.
63 DP->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 DP->EmitULEB128(AttrData.getAttribute(),
72 dwarf::AttributeString(AttrData.getAttribute()));
75 // FIXME: Doing work even in non-asm-verbose runs.
76 DP->EmitULEB128(AttrData.getForm(),
77 dwarf::FormEncodingString(AttrData.getForm()));
80 // Mark end of abbreviation.
81 DP->EmitULEB128(0, "EOM(1)");
82 DP->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 /// addSiblingOffset - Add a sibling offset field to the front of the DIE.
117 void DIE::addSiblingOffset() {
118 DIEInteger *DI = new DIEInteger(0);
119 Values.insert(Values.begin(), DI);
120 Abbrev.AddFirstAttribute(dwarf::DW_AT_sibling, dwarf::DW_FORM_ref4);
124 void DIE::print(raw_ostream &O, unsigned IncIndent) {
125 IndentCount += IncIndent;
126 const std::string Indent(IndentCount, ' ');
127 bool isBlock = Abbrev.getTag() == 0;
132 << format("0x%lx", (long)(intptr_t)this)
133 << ", Offset: " << Offset
134 << ", Size: " << Size << "\n";
137 << dwarf::TagString(Abbrev.getTag())
139 << dwarf::ChildrenString(Abbrev.getChildrenFlag()) << "\n";
141 O << "Size: " << Size << "\n";
144 const SmallVector<DIEAbbrevData, 8> &Data = Abbrev.getData();
147 for (unsigned i = 0, N = Data.size(); i < N; ++i) {
151 O << dwarf::AttributeString(Data[i].getAttribute());
153 O << "Blk[" << i << "]";
156 << dwarf::FormEncodingString(Data[i].getForm())
163 for (unsigned j = 0, M = Children.size(); j < M; ++j) {
164 Children[j]->print(O, 4);
167 if (!isBlock) O << "\n";
168 IndentCount -= IncIndent;
178 void DIEValue::dump() {
183 //===----------------------------------------------------------------------===//
184 // DIEInteger Implementation
185 //===----------------------------------------------------------------------===//
187 /// EmitValue - Emit integer of appropriate size.
189 void DIEInteger::EmitValue(DwarfPrinter *D, unsigned Form) const {
190 const AsmPrinter *Asm = D->getAsm();
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: D->EmitULEB128(Integer); return;
203 case dwarf::DW_FORM_sdata: D->EmitSLEB128(Integer, ""); return;
204 default: llvm_unreachable("DIE Value form not supported yet");
206 Asm->OutStreamer.EmitIntValue(Integer, Size, 0/*addrspace*/);
209 /// SizeOf - Determine size of integer value in bytes.
211 unsigned DIEInteger::SizeOf(const TargetData *TD, unsigned Form) const {
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;
230 void DIEInteger::print(raw_ostream &O) {
231 O << "Int: " << (int64_t)Integer
232 << format(" 0x%llx", (unsigned long long)Integer);
236 //===----------------------------------------------------------------------===//
237 // DIEString Implementation
238 //===----------------------------------------------------------------------===//
240 /// EmitValue - Emit string value.
242 void DIEString::EmitValue(DwarfPrinter *D, unsigned Form) const {
243 D->getAsm()->OutStreamer.EmitBytes(Str, /*addrspace*/0);
244 // Emit nul terminator.
245 D->getAsm()->OutStreamer.EmitIntValue(0, 1, /*addrspace*/0);
249 void DIEString::print(raw_ostream &O) {
250 O << "Str: \"" << Str << "\"";
254 //===----------------------------------------------------------------------===//
255 // DIELabel Implementation
256 //===----------------------------------------------------------------------===//
258 /// EmitValue - Emit label value.
260 void DIELabel::EmitValue(DwarfPrinter *D, unsigned Form) const {
261 bool IsSmall = Form == dwarf::DW_FORM_data4;
262 unsigned Size = IsSmall ? 4 : D->getTargetData()->getPointerSize();
263 D->getAsm()->OutStreamer.EmitSymbolValue(Label, Size, 0/*AddrSpace*/);
266 /// SizeOf - Determine size of label value in bytes.
268 unsigned DIELabel::SizeOf(const TargetData *TD, unsigned Form) const {
269 if (Form == dwarf::DW_FORM_data4) return 4;
270 return TD->getPointerSize();
274 void DIELabel::print(raw_ostream &O) {
275 O << "Lbl: " << Label->getName();
279 //===----------------------------------------------------------------------===//
280 // DIESectionOffset Implementation
281 //===----------------------------------------------------------------------===//
283 /// EmitValue - Emit delta value.
285 void DIESectionOffset::EmitValue(DwarfPrinter *D, unsigned Form) const {
286 bool IsSmall = Form == dwarf::DW_FORM_data4;
287 D->EmitSectionOffset(Label, Section, IsSmall, IsEH);
290 /// SizeOf - Determine size of delta value in bytes.
292 unsigned DIESectionOffset::SizeOf(const TargetData *TD, unsigned Form) const {
293 if (Form == dwarf::DW_FORM_data4) return 4;
294 return TD->getPointerSize();
298 void DIESectionOffset::print(raw_ostream &O) {
299 O << "Off: " << Label->getName() << "-" << Section->getName()
304 //===----------------------------------------------------------------------===//
305 // DIEDelta Implementation
306 //===----------------------------------------------------------------------===//
308 /// EmitValue - Emit delta value.
310 void DIEDelta::EmitValue(DwarfPrinter *D, unsigned Form) const {
311 bool IsSmall = Form == dwarf::DW_FORM_data4;
312 D->EmitDifference(LabelHi, LabelLo, IsSmall);
315 /// SizeOf - Determine size of delta value in bytes.
317 unsigned DIEDelta::SizeOf(const TargetData *TD, unsigned Form) const {
318 if (Form == dwarf::DW_FORM_data4) return 4;
319 return TD->getPointerSize();
323 void DIEDelta::print(raw_ostream &O) {
324 O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
328 //===----------------------------------------------------------------------===//
329 // DIEEntry Implementation
330 //===----------------------------------------------------------------------===//
332 /// EmitValue - Emit debug information entry offset.
334 void DIEEntry::EmitValue(DwarfPrinter *D, unsigned Form) const {
335 D->getAsm()->EmitInt32(Entry->getOffset());
339 void DIEEntry::print(raw_ostream &O) {
340 O << format("Die: 0x%lx", (long)(intptr_t)Entry);
344 //===----------------------------------------------------------------------===//
345 // DIEBlock Implementation
346 //===----------------------------------------------------------------------===//
348 /// ComputeSize - calculate the size of the block.
350 unsigned DIEBlock::ComputeSize(const TargetData *TD) {
352 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
353 for (unsigned i = 0, N = Values.size(); i < N; ++i)
354 Size += Values[i]->SizeOf(TD, AbbrevData[i].getForm());
360 /// EmitValue - Emit block data.
362 void DIEBlock::EmitValue(DwarfPrinter *D, unsigned Form) const {
363 const AsmPrinter *Asm = D->getAsm();
365 case dwarf::DW_FORM_block1: Asm->EmitInt8(Size); break;
366 case dwarf::DW_FORM_block2: Asm->EmitInt16(Size); break;
367 case dwarf::DW_FORM_block4: Asm->EmitInt32(Size); break;
368 case dwarf::DW_FORM_block: D->EmitULEB128(Size); break;
369 default: llvm_unreachable("Improper form for block"); break;
372 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
373 for (unsigned i = 0, N = Values.size(); i < N; ++i)
374 Values[i]->EmitValue(D, AbbrevData[i].getForm());
377 /// SizeOf - Determine size of block data in bytes.
379 unsigned DIEBlock::SizeOf(const TargetData *TD, unsigned Form) const {
381 case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
382 case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
383 case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
384 case dwarf::DW_FORM_block: return Size + MCAsmInfo::getULEB128Size(Size);
385 default: llvm_unreachable("Improper form for block"); break;
391 void DIEBlock::print(raw_ostream &O) {