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