Home | History | Annotate | Download | only in AsmPrinter
      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 #ifndef NDEBUG
    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 
    163 void DIE::dump() {
    164   print(dbgs());
    165 }
    166 #endif
    167 
    168 void DIEValue::anchor() { }
    169 
    170 #ifndef NDEBUG
    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 ///
    182 void DIEInteger::EmitValue(AsmPrinter *Asm, unsigned Form) const {
    183   unsigned Size = ~0U;
    184   switch (Form) {
    185   case dwarf::DW_FORM_flag:  // Fall thru
    186   case dwarf::DW_FORM_ref1:  // Fall thru
    187   case dwarf::DW_FORM_data1: Size = 1; break;
    188   case dwarf::DW_FORM_ref2:  // Fall thru
    189   case dwarf::DW_FORM_data2: Size = 2; break;
    190   case dwarf::DW_FORM_ref4:  // Fall thru
    191   case dwarf::DW_FORM_data4: Size = 4; break;
    192   case dwarf::DW_FORM_ref8:  // Fall thru
    193   case dwarf::DW_FORM_data8: Size = 8; break;
    194   case dwarf::DW_FORM_udata: Asm->EmitULEB128(Integer); return;
    195   case dwarf::DW_FORM_sdata: Asm->EmitSLEB128(Integer); return;
    196   case dwarf::DW_FORM_addr:  Size = Asm->getTargetData().getPointerSize(); break;
    197   default: llvm_unreachable("DIE Value form not supported yet");
    198   }
    199   Asm->OutStreamer.EmitIntValue(Integer, Size, 0/*addrspace*/);
    200 }
    201 
    202 /// SizeOf - Determine size of integer value in bytes.
    203 ///
    204 unsigned DIEInteger::SizeOf(AsmPrinter *AP, unsigned Form) const {
    205   switch (Form) {
    206   case dwarf::DW_FORM_flag:  // Fall thru
    207   case dwarf::DW_FORM_ref1:  // Fall thru
    208   case dwarf::DW_FORM_data1: return sizeof(int8_t);
    209   case dwarf::DW_FORM_ref2:  // Fall thru
    210   case dwarf::DW_FORM_data2: return sizeof(int16_t);
    211   case dwarf::DW_FORM_ref4:  // Fall thru
    212   case dwarf::DW_FORM_data4: return sizeof(int32_t);
    213   case dwarf::DW_FORM_ref8:  // Fall thru
    214   case dwarf::DW_FORM_data8: return sizeof(int64_t);
    215   case dwarf::DW_FORM_udata: return MCAsmInfo::getULEB128Size(Integer);
    216   case dwarf::DW_FORM_sdata: return MCAsmInfo::getSLEB128Size(Integer);
    217   case dwarf::DW_FORM_addr:  return AP->getTargetData().getPointerSize();
    218   default: llvm_unreachable("DIE Value form not supported yet");
    219   }
    220 }
    221 
    222 #ifndef NDEBUG
    223 void DIEInteger::print(raw_ostream &O) {
    224   O << "Int: " << (int64_t)Integer << "  0x";
    225   O.write_hex(Integer);
    226 }
    227 #endif
    228 
    229 //===----------------------------------------------------------------------===//
    230 // DIELabel Implementation
    231 //===----------------------------------------------------------------------===//
    232 
    233 /// EmitValue - Emit label value.
    234 ///
    235 void DIELabel::EmitValue(AsmPrinter *AP, unsigned Form) const {
    236   AP->OutStreamer.EmitSymbolValue(Label, SizeOf(AP, Form), 0/*AddrSpace*/);
    237 }
    238 
    239 /// SizeOf - Determine size of label value in bytes.
    240 ///
    241 unsigned DIELabel::SizeOf(AsmPrinter *AP, unsigned Form) const {
    242   if (Form == dwarf::DW_FORM_data4) return 4;
    243   if (Form == dwarf::DW_FORM_strp) return 4;
    244   return AP->getTargetData().getPointerSize();
    245 }
    246 
    247 #ifndef NDEBUG
    248 void DIELabel::print(raw_ostream &O) {
    249   O << "Lbl: " << Label->getName();
    250 }
    251 #endif
    252 
    253 //===----------------------------------------------------------------------===//
    254 // DIEDelta Implementation
    255 //===----------------------------------------------------------------------===//
    256 
    257 /// EmitValue - Emit delta value.
    258 ///
    259 void DIEDelta::EmitValue(AsmPrinter *AP, unsigned Form) const {
    260   AP->EmitLabelDifference(LabelHi, LabelLo, SizeOf(AP, Form));
    261 }
    262 
    263 /// SizeOf - Determine size of delta value in bytes.
    264 ///
    265 unsigned DIEDelta::SizeOf(AsmPrinter *AP, unsigned Form) const {
    266   if (Form == dwarf::DW_FORM_data4) return 4;
    267   if (Form == dwarf::DW_FORM_strp) return 4;
    268   return AP->getTargetData().getPointerSize();
    269 }
    270 
    271 #ifndef NDEBUG
    272 void DIEDelta::print(raw_ostream &O) {
    273   O << "Del: " << LabelHi->getName() << "-" << LabelLo->getName();
    274 }
    275 #endif
    276 
    277 //===----------------------------------------------------------------------===//
    278 // DIEEntry Implementation
    279 //===----------------------------------------------------------------------===//
    280 
    281 /// EmitValue - Emit debug information entry offset.
    282 ///
    283 void DIEEntry::EmitValue(AsmPrinter *AP, unsigned Form) const {
    284   AP->EmitInt32(Entry->getOffset());
    285 }
    286 
    287 #ifndef NDEBUG
    288 void DIEEntry::print(raw_ostream &O) {
    289   O << format("Die: 0x%lx", (long)(intptr_t)Entry);
    290 }
    291 #endif
    292 
    293 //===----------------------------------------------------------------------===//
    294 // DIEBlock Implementation
    295 //===----------------------------------------------------------------------===//
    296 
    297 /// ComputeSize - calculate the size of the block.
    298 ///
    299 unsigned DIEBlock::ComputeSize(AsmPrinter *AP) {
    300   if (!Size) {
    301     const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
    302     for (unsigned i = 0, N = Values.size(); i < N; ++i)
    303       Size += Values[i]->SizeOf(AP, AbbrevData[i].getForm());
    304   }
    305 
    306   return Size;
    307 }
    308 
    309 /// EmitValue - Emit block data.
    310 ///
    311 void DIEBlock::EmitValue(AsmPrinter *Asm, unsigned Form) const {
    312   switch (Form) {
    313   default: llvm_unreachable("Improper form for block");
    314   case dwarf::DW_FORM_block1: Asm->EmitInt8(Size);    break;
    315   case dwarf::DW_FORM_block2: Asm->EmitInt16(Size);   break;
    316   case dwarf::DW_FORM_block4: Asm->EmitInt32(Size);   break;
    317   case dwarf::DW_FORM_block:  Asm->EmitULEB128(Size); break;
    318   }
    319 
    320   const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev.getData();
    321   for (unsigned i = 0, N = Values.size(); i < N; ++i)
    322     Values[i]->EmitValue(Asm, AbbrevData[i].getForm());
    323 }
    324 
    325 /// SizeOf - Determine size of block data in bytes.
    326 ///
    327 unsigned DIEBlock::SizeOf(AsmPrinter *AP, unsigned Form) const {
    328   switch (Form) {
    329   case dwarf::DW_FORM_block1: return Size + sizeof(int8_t);
    330   case dwarf::DW_FORM_block2: return Size + sizeof(int16_t);
    331   case dwarf::DW_FORM_block4: return Size + sizeof(int32_t);
    332   case dwarf::DW_FORM_block:  return Size + MCAsmInfo::getULEB128Size(Size);
    333   default: llvm_unreachable("Improper form for block");
    334   }
    335 }
    336 
    337 #ifndef NDEBUG
    338 void DIEBlock::print(raw_ostream &O) {
    339   O << "Blk: ";
    340   DIE::print(O, 5);
    341 }
    342 #endif
    343