lib/DebugInfo/DWARFCompileUnit.cpp

   1 //===-- DWARFCompileUnit.cpp ----------------------------------------------===//
   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 #include "DWARFCompileUnit.h"
  11 #include "DWARFContext.h"
  12 #include "DWARFFormValue.h"
  13 #include "llvm/Support/Dwarf.h"
  14 #include "llvm/Support/Format.h"
  15 #include "llvm/Support/raw_ostream.h"
  16 using namespace llvm;
  17 using namespace dwarf;
  18
  19 DataExtractor DWARFCompileUnit::getDebugInfoExtractor() const {
  20   return DataExtractor(Context.getInfoSection(),
  21                        Context.isLittleEndian(), getAddressByteSize());
  22 }
  23
  24 bool DWARFCompileUnit::extract(DataExtractor debug_info, uint32_t *offset_ptr) {
  25   clear();
  26
  27   Offset = *offset_ptr;
  28
  29   if (debug_info.isValidOffset(*offset_ptr)) {
  30     uint64_t abbrOffset;
  31     const DWARFDebugAbbrev *abbr = Context.getDebugAbbrev();
  32     Length = debug_info.getU32(offset_ptr);
  33     Version = debug_info.getU16(offset_ptr);
  34     abbrOffset = debug_info.getU32(offset_ptr);
  35     AddrSize = debug_info.getU8(offset_ptr);
  36
  37     bool lengthOK = debug_info.isValidOffset(getNextCompileUnitOffset()-1);
  38     bool versionOK = DWARFContext::isSupportedVersion(Version);
  39     bool abbrOffsetOK = Context.getAbbrevSection().size() > abbrOffset;
  40     bool addrSizeOK = AddrSize == 4 || AddrSize == 8;
  41
  42     if (lengthOK && versionOK && addrSizeOK && abbrOffsetOK && abbr != NULL) {
  43       Abbrevs = abbr->getAbbreviationDeclarationSet(abbrOffset);
  44       return true;
  45     }
  46
  47     // reset the offset to where we tried to parse from if anything went wrong
  48     *offset_ptr = Offset;
  49   }
  50
  51   return false;
  52 }
  53
  54 uint32_t
  55 DWARFCompileUnit::extract(uint32_t offset, DataExtractor debug_info_data,
  56                           const DWARFAbbreviationDeclarationSet *abbrevs) {
  57   clear();
  58
  59   Offset = offset;
  60
  61   if (debug_info_data.isValidOffset(offset)) {
  62     Length = debug_info_data.getU32(&offset);
  63     Version = debug_info_data.getU16(&offset);
  64     bool abbrevsOK = debug_info_data.getU32(&offset) == abbrevs->getOffset();
  65     Abbrevs = abbrevs;
  66     AddrSize = debug_info_data.getU8 (&offset);
  67
  68     bool versionOK = DWARFContext::isSupportedVersion(Version);
  69     bool addrSizeOK = AddrSize == 4 || AddrSize == 8;
  70
  71     if (versionOK && addrSizeOK && abbrevsOK &&
  72         debug_info_data.isValidOffset(offset))
  73       return offset;
  74   }
  75   return 0;
  76 }
  77
  78 void DWARFCompileUnit::clear() {
  79   Offset = 0;
  80   Length = 0;
  81   Version = 0;
  82   Abbrevs = 0;
  83   AddrSize = 0;
  84   BaseAddr = 0;
  85   clearDIEs(false);
  86 }
  87
  88 void DWARFCompileUnit::dump(raw_ostream &OS) {
  89   OS << format("0x%08x", Offset) << ": Compile Unit:"
  90      << " length = " << format("0x%08x", Length)
  91      << " version = " << format("0x%04x", Version)
  92      << " abbr_offset = " << format("0x%04x", Abbrevs->getOffset())
  93      << " addr_size = " << format("0x%02x", AddrSize)
  94      << " (next CU at " << format("0x%08x", getNextCompileUnitOffset())
  95      << ")\n";
  96
  97   const DWARFDebugInfoEntryMinimal *CU = getCompileUnitDIE(false);
  98   assert(CU && "Null Compile Unit?");
  99   CU->dump(OS, this, -1U);
 100 }
 101
 102 const char *DWARFCompileUnit::getCompilationDir() {
 103   extractDIEsIfNeeded(true);
 104   if (DieArray.empty())
 105     return 0;
 106   return DieArray[0].getAttributeValueAsString(this, DW_AT_comp_dir, 0);
 107 }
 108
 109 void DWARFCompileUnit::setDIERelations() {
 110   if (DieArray.empty())
 111     return;
 112   DWARFDebugInfoEntryMinimal *die_array_begin = &DieArray.front();
 113   DWARFDebugInfoEntryMinimal *die_array_end = &DieArray.back();
 114   DWARFDebugInfoEntryMinimal *curr_die;
 115   // We purposely are skipping the last element in the array in the loop below
 116   // so that we can always have a valid next item
 117   for (curr_die = die_array_begin; curr_die < die_array_end; ++curr_die) {
 118     // Since our loop doesn't include the last element, we can always
 119     // safely access the next die in the array.
 120     DWARFDebugInfoEntryMinimal *next_die = curr_die + 1;
 121
 122     const DWARFAbbreviationDeclaration *curr_die_abbrev =
 123       curr_die->getAbbreviationDeclarationPtr();
 124
 125     if (curr_die_abbrev) {
 126       // Normal DIE
 127       if (curr_die_abbrev->hasChildren())
 128         next_die->setParent(curr_die);
 129       else
 130         curr_die->setSibling(next_die);
 131     } else {
 132       // NULL DIE that terminates a sibling chain
 133       DWARFDebugInfoEntryMinimal *parent = curr_die->getParent();
 134       if (parent)
 135         parent->setSibling(next_die);
 136     }
 137   }
 138
 139   // Since we skipped the last element, we need to fix it up!
 140   if (die_array_begin < die_array_end)
 141     curr_die->setParent(die_array_begin);
 142 }
 143
 144 size_t DWARFCompileUnit::extractDIEsIfNeeded(bool cu_die_only) {
 145   const size_t initial_die_array_size = DieArray.size();
 146   if ((cu_die_only && initial_die_array_size > 0) ||
 147       initial_die_array_size > 1)
 148     return 0; // Already parsed
 149
 150   // Set the offset to that of the first DIE and calculate the start of the
 151   // next compilation unit header.
 152   uint32_t offset = getFirstDIEOffset();
 153   uint32_t next_cu_offset = getNextCompileUnitOffset();
 154
 155   DWARFDebugInfoEntryMinimal die;
 156   // Keep a flat array of the DIE for binary lookup by DIE offset
 157   uint32_t depth = 0;
 158   // We are in our compile unit, parse starting at the offset
 159   // we were told to parse
 160
 161   const uint8_t *fixed_form_sizes =
 162     DWARFFormValue::getFixedFormSizesForAddressSize(getAddressByteSize());
 163
 164   while (offset < next_cu_offset &&
 165          die.extractFast(this, fixed_form_sizes, &offset)) {
 166
 167     if (depth == 0) {
 168       uint64_t base_addr =
 169         die.getAttributeValueAsUnsigned(this, DW_AT_low_pc, -1U);
 170       if (base_addr == -1U)
 171         base_addr = die.getAttributeValueAsUnsigned(this, DW_AT_entry_pc, 0);
 172       setBaseAddress(base_addr);
 173     }
 174
 175     if (cu_die_only) {
 176       addDIE(die);
 177       return 1;
 178     }
 179     else if (depth == 0 && initial_die_array_size == 1) {
 180       // Don't append the CU die as we already did that
 181     } else {
 182       addDIE (die);
 183     }
 184
 185     const DWARFAbbreviationDeclaration *abbrDecl =
 186       die.getAbbreviationDeclarationPtr();
 187     if (abbrDecl) {
 188       // Normal DIE
 189       if (abbrDecl->hasChildren())
 190         ++depth;
 191     } else {
 192       // NULL DIE.
 193       if (depth > 0)
 194         --depth;
 195       if (depth == 0)
 196         break;  // We are done with this compile unit!
 197     }
 198
 199   }
 200
 201   // Give a little bit of info if we encounter corrupt DWARF (our offset
 202   // should always terminate at or before the start of the next compilation
 203   // unit header).
 204   if (offset > next_cu_offset)
 205     fprintf (stderr, "warning: DWARF compile unit extends beyond its"
 206                      "bounds cu 0x%8.8x at 0x%8.8x'\n", getOffset(), offset);
 207
 208   setDIERelations();
 209   return DieArray.size();
 210 }
 211
 212 void DWARFCompileUnit::clearDIEs(bool keep_compile_unit_die) {
 213   if (DieArray.size() > (unsigned)keep_compile_unit_die) {
 214     // std::vectors never get any smaller when resized to a smaller size,
 215     // or when clear() or erase() are called, the size will report that it
 216     // is smaller, but the memory allocated remains intact (call capacity()
 217     // to see this). So we need to create a temporary vector and swap the
 218     // contents which will cause just the internal pointers to be swapped
 219     // so that when "tmp_array" goes out of scope, it will destroy the
 220     // contents.
 221
 222     // Save at least the compile unit DIE
 223     std::vector<DWARFDebugInfoEntryMinimal> tmpArray;
 224     DieArray.swap(tmpArray);
 225     if (keep_compile_unit_die)
 226       DieArray.push_back(tmpArray.front());
 227   }
 228 }
 229
 230 void
 231 DWARFCompileUnit::buildAddressRangeTable(DWARFDebugAranges *debug_aranges,
 232                                          bool clear_dies_if_already_not_parsed){
 233   // This function is usually called if there in no .debug_aranges section
 234   // in order to produce a compile unit level set of address ranges that
 235   // is accurate. If the DIEs weren't parsed, then we don't want all dies for
 236   // all compile units to stay loaded when they weren't needed. So we can end
 237   // up parsing the DWARF and then throwing them all away to keep memory usage
 238   // down.
 239   const bool clear_dies = extractDIEsIfNeeded(false) > 1 &&
 240                           clear_dies_if_already_not_parsed;
 241   DieArray[0].buildAddressRangeTable(this, debug_aranges);
 242
 243   // Keep memory down by clearing DIEs if this generate function
 244   // caused them to be parsed.
 245   if (clear_dies)
 246     clearDIEs(true);
 247 }
 248
 249 const DWARFDebugInfoEntryMinimal*
 250 DWARFCompileUnit::getFunctionDIEForAddress(int64_t address) {
 251   extractDIEsIfNeeded(false);
 252   for (size_t i = 0, n = DieArray.size(); i != n; i++) {
 253     if (DieArray[i].addressRangeContainsAddress(this, address))
 254       return &DieArray[i];
 255   }
 256   return 0;
 257 }