lib/DebugInfo/DWARFDebugLine.cpp

   1 //===-- DWARFDebugLine.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 "DWARFDebugLine.h"
  11 #include "llvm/Support/Dwarf.h"
  12 #include "llvm/Support/Format.h"
  13 #include "llvm/Support/raw_ostream.h"
  14 #include <algorithm>
  15 using namespace llvm;
  16 using namespace dwarf;
  17
  18 void DWARFDebugLine::Prologue::dump(raw_ostream &OS) const {
  19   OS << "Line table prologue:\n"
  20      << format("   total_length: 0x%8.8x\n", TotalLength)
  21      << format("        version: %u\n", Version)
  22      << format("prologue_length: 0x%8.8x\n", PrologueLength)
  23      << format("min_inst_length: %u\n", MinInstLength)
  24      << format("default_is_stmt: %u\n", DefaultIsStmt)
  25      << format("      line_base: %i\n", LineBase)
  26      << format("     line_range: %u\n", LineRange)
  27      << format("    opcode_base: %u\n", OpcodeBase);
  28
  29   for (uint32_t i = 0; i < StandardOpcodeLengths.size(); ++i)
  30     OS << format("standard_opcode_lengths[%s] = %u\n", LNStandardString(i+1),
  31                  StandardOpcodeLengths[i]);
  32
  33   if (!IncludeDirectories.empty())
  34     for (uint32_t i = 0; i < IncludeDirectories.size(); ++i)
  35       OS << format("include_directories[%3u] = '", i+1)
  36          << IncludeDirectories[i] << "'\n";
  37
  38   if (!FileNames.empty()) {
  39     OS << "                Dir  Mod Time   File Len   File Name\n"
  40        << "                ---- ---------- ---------- -----------"
  41           "----------------\n";
  42     for (uint32_t i = 0; i < FileNames.size(); ++i) {
  43       const FileNameEntry& fileEntry = FileNames[i];
  44       OS << format("file_names[%3u] %4u ", i+1, fileEntry.DirIdx)
  45          << format("0x%8.8x 0x%8.8x ", fileEntry.ModTime, fileEntry.Length)
  46          << fileEntry.Name << '\n';
  47     }
  48   }
  49 }
  50
  51 void DWARFDebugLine::Row::postAppend() {
  52   BasicBlock = false;
  53   PrologueEnd = false;
  54   EpilogueBegin = false;
  55 }
  56
  57 void DWARFDebugLine::Row::reset(bool default_is_stmt) {
  58   Address = 0;
  59   Line = 1;
  60   Column = 0;
  61   File = 1;
  62   Isa = 0;
  63   IsStmt = default_is_stmt;
  64   BasicBlock = false;
  65   EndSequence = false;
  66   PrologueEnd = false;
  67   EpilogueBegin = false;
  68 }
  69
  70 void DWARFDebugLine::Row::dump(raw_ostream &OS) const {
  71   OS << format("0x%16.16llx %6u %6u", Address, Line, Column)
  72      << format(" %6u %3u ", File, Isa)
  73      << (IsStmt ? " is_stmt" : "")
  74      << (BasicBlock ? " basic_block" : "")
  75      << (PrologueEnd ? " prologue_end" : "")
  76      << (EpilogueBegin ? " epilogue_begin" : "")
  77      << (EndSequence ? " end_sequence" : "")
  78      << '\n';
  79 }
  80
  81 void DWARFDebugLine::LineTable::dump(raw_ostream &OS) const {
  82   Prologue.dump(OS);
  83   OS << '\n';
  84
  85   if (!Rows.empty()) {
  86     OS << "Address            Line   Column File   ISA Flags\n"
  87        << "------------------ ------ ------ ------ --- -------------\n";
  88     for (std::vector<Row>::const_iterator pos = Rows.begin(),
  89          end = Rows.end(); pos != end; ++pos)
  90       pos->dump(OS);
  91   }
  92 }
  93
  94 DWARFDebugLine::State::~State() {}
  95
  96 void DWARFDebugLine::State::appendRowToMatrix(uint32_t offset) {
  97   ++row;  // Increase the row number.
  98   LineTable::appendRow(*this);
  99   Row::postAppend();
 100 }
 101
 102 DWARFDebugLine::DumpingState::~DumpingState() {}
 103
 104 void DWARFDebugLine::DumpingState::finalize(uint32_t offset) {
 105   LineTable::dump(OS);
 106 }
 107
 108 const DWARFDebugLine::LineTable *
 109 DWARFDebugLine::getLineTable(uint32_t offset) const {
 110   LineTableConstIter pos = LineTableMap.find(offset);
 111   if (pos != LineTableMap.end())
 112     return &pos->second;
 113   return 0;
 114 }
 115
 116 const DWARFDebugLine::LineTable *
 117 DWARFDebugLine::getOrParseLineTable(DataExtractor debug_line_data,
 118                                     uint32_t offset) {
 119   LineTableIter pos = LineTableMap.find(offset);
 120   if (pos == LineTableMap.end()) {
 121     // Parse and cache the line table for at this offset.
 122     State state;
 123     if (!parseStatementTable(debug_line_data, &offset, state))
 124       return 0;
 125     pos->second = state;
 126   }
 127   return &pos->second;
 128 }
 129
 130 bool
 131 DWARFDebugLine::parsePrologue(DataExtractor debug_line_data,
 132                               uint32_t *offset_ptr, Prologue *prologue) {
 133   const uint32_t prologue_offset = *offset_ptr;
 134
 135   prologue->clear();
 136   prologue->TotalLength = debug_line_data.getU32(offset_ptr);
 137   prologue->Version = debug_line_data.getU16(offset_ptr);
 138   if (prologue->Version != 2)
 139     return false;
 140
 141   prologue->PrologueLength = debug_line_data.getU32(offset_ptr);
 142   const uint32_t end_prologue_offset = prologue->PrologueLength + *offset_ptr;
 143   prologue->MinInstLength = debug_line_data.getU8(offset_ptr);
 144   prologue->DefaultIsStmt = debug_line_data.getU8(offset_ptr);
 145   prologue->LineBase = debug_line_data.getU8(offset_ptr);
 146   prologue->LineRange = debug_line_data.getU8(offset_ptr);
 147   prologue->OpcodeBase = debug_line_data.getU8(offset_ptr);
 148
 149   prologue->StandardOpcodeLengths.reserve(prologue->OpcodeBase-1);
 150   for (uint32_t i = 1; i < prologue->OpcodeBase; ++i) {
 151     uint8_t op_len = debug_line_data.getU8(offset_ptr);
 152     prologue->StandardOpcodeLengths.push_back(op_len);
 153   }
 154
 155   while (*offset_ptr < end_prologue_offset) {
 156     const char *s = debug_line_data.getCStr(offset_ptr);
 157     if (s && s[0])
 158       prologue->IncludeDirectories.push_back(s);
 159     else
 160       break;
 161   }
 162
 163   while (*offset_ptr < end_prologue_offset) {
 164     const char *name = debug_line_data.getCStr(offset_ptr);
 165     if (name && name[0]) {
 166       FileNameEntry fileEntry;
 167       fileEntry.Name = name;
 168       fileEntry.DirIdx = debug_line_data.getULEB128(offset_ptr);
 169       fileEntry.ModTime = debug_line_data.getULEB128(offset_ptr);
 170       fileEntry.Length = debug_line_data.getULEB128(offset_ptr);
 171       prologue->FileNames.push_back(fileEntry);
 172     } else {
 173       break;
 174     }
 175   }
 176
 177   if (*offset_ptr != end_prologue_offset) {
 178     fprintf(stderr, "warning: parsing line table prologue at 0x%8.8x should"
 179                     " have ended at 0x%8.8x but it ended ad 0x%8.8x\n",
 180             prologue_offset, end_prologue_offset, *offset_ptr);
 181   }
 182   return end_prologue_offset;
 183 }
 184
 185 bool
 186 DWARFDebugLine::parseStatementTable(DataExtractor debug_line_data,
 187                                     uint32_t *offset_ptr, State &state) {
 188   const uint32_t debug_line_offset = *offset_ptr;
 189
 190   Prologue *prologue = &state.Prologue;
 191
 192   if (!parsePrologue(debug_line_data, offset_ptr, prologue)) {
 193     // Restore our offset and return false to indicate failure!
 194     *offset_ptr = debug_line_offset;
 195     return false;
 196   }
 197
 198   const uint32_t end_offset = debug_line_offset + prologue->TotalLength +
 199                               sizeof(prologue->TotalLength);
 200
 201   while (*offset_ptr < end_offset) {
 202     uint8_t opcode = debug_line_data.getU8(offset_ptr);
 203
 204     if (opcode == 0) {
 205       // Extended Opcodes always start with a zero opcode followed by
 206       // a uleb128 length so you can skip ones you don't know about
 207       uint32_t ext_offset = *offset_ptr;
 208       uint64_t len = debug_line_data.getULEB128(offset_ptr);
 209       uint32_t arg_size = len - (*offset_ptr - ext_offset);
 210
 211       uint8_t sub_opcode = debug_line_data.getU8(offset_ptr);
 212       switch (sub_opcode) {
 213       case DW_LNE_end_sequence:
 214         // Set the end_sequence register of the state machine to true and
 215         // append a row to the matrix using the current values of the
 216         // state-machine registers. Then reset the registers to the initial
 217         // values specified above. Every statement program sequence must end
 218         // with a DW_LNE_end_sequence instruction which creates a row whose
 219         // address is that of the byte after the last target machine instruction
 220         // of the sequence.
 221         state.EndSequence = true;
 222         state.appendRowToMatrix(*offset_ptr);
 223         state.reset();
 224         break;
 225
 226       case DW_LNE_set_address:
 227         // Takes a single relocatable address as an operand. The size of the
 228         // operand is the size appropriate to hold an address on the target
 229         // machine. Set the address register to the value given by the
 230         // relocatable address. All of the other statement program opcodes
 231         // that affect the address register add a delta to it. This instruction
 232         // stores a relocatable value into it instead.
 233         state.Address = debug_line_data.getAddress(offset_ptr);
 234         break;
 235
 236       case DW_LNE_define_file:
 237         // Takes 4 arguments. The first is a null terminated string containing
 238         // a source file name. The second is an unsigned LEB128 number
 239         // representing the directory index of the directory in which the file
 240         // was found. The third is an unsigned LEB128 number representing the
 241         // time of last modification of the file. The fourth is an unsigned
 242         // LEB128 number representing the length in bytes of the file. The time
 243         // and length fields may contain LEB128(0) if the information is not
 244         // available.
 245         //
 246         // The directory index represents an entry in the include_directories
 247         // section of the statement program prologue. The index is LEB128(0)
 248         // if the file was found in the current directory of the compilation,
 249         // LEB128(1) if it was found in the first directory in the
 250         // include_directories section, and so on. The directory index is
 251         // ignored for file names that represent full path names.
 252         //
 253         // The files are numbered, starting at 1, in the order in which they
 254         // appear; the names in the prologue come before names defined by
 255         // the DW_LNE_define_file instruction. These numbers are used in the
 256         // the file register of the state machine.
 257         {
 258           FileNameEntry fileEntry;
 259           fileEntry.Name = debug_line_data.getCStr(offset_ptr);
 260           fileEntry.DirIdx = debug_line_data.getULEB128(offset_ptr);
 261           fileEntry.ModTime = debug_line_data.getULEB128(offset_ptr);
 262           fileEntry.Length = debug_line_data.getULEB128(offset_ptr);
 263           prologue->FileNames.push_back(fileEntry);
 264         }
 265         break;
 266
 267       default:
 268         // Length doesn't include the zero opcode byte or the length itself, but
 269         // it does include the sub_opcode, so we have to adjust for that below
 270         (*offset_ptr) += arg_size;
 271         break;
 272       }
 273     } else if (opcode < prologue->OpcodeBase) {
 274       switch (opcode) {
 275       // Standard Opcodes
 276       case DW_LNS_copy:
 277         // Takes no arguments. Append a row to the matrix using the
 278         // current values of the state-machine registers. Then set
 279         // the basic_block register to false.
 280         state.appendRowToMatrix(*offset_ptr);
 281         break;
 282
 283       case DW_LNS_advance_pc:
 284         // Takes a single unsigned LEB128 operand, multiplies it by the
 285         // min_inst_length field of the prologue, and adds the
 286         // result to the address register of the state machine.
 287         state.Address += debug_line_data.getULEB128(offset_ptr) *
 288                          prologue->MinInstLength;
 289         break;
 290
 291       case DW_LNS_advance_line:
 292         // Takes a single signed LEB128 operand and adds that value to
 293         // the line register of the state machine.
 294         state.Line += debug_line_data.getSLEB128(offset_ptr);
 295         break;
 296
 297       case DW_LNS_set_file:
 298         // Takes a single unsigned LEB128 operand and stores it in the file
 299         // register of the state machine.
 300         state.File = debug_line_data.getULEB128(offset_ptr);
 301         break;
 302
 303       case DW_LNS_set_column:
 304         // Takes a single unsigned LEB128 operand and stores it in the
 305         // column register of the state machine.
 306         state.Column = debug_line_data.getULEB128(offset_ptr);
 307         break;
 308
 309       case DW_LNS_negate_stmt:
 310         // Takes no arguments. Set the is_stmt register of the state
 311         // machine to the logical negation of its current value.
 312         state.IsStmt = !state.IsStmt;
 313         break;
 314
 315       case DW_LNS_set_basic_block:
 316         // Takes no arguments. Set the basic_block register of the
 317         // state machine to true
 318         state.BasicBlock = true;
 319         break;
 320
 321       case DW_LNS_const_add_pc:
 322         // Takes no arguments. Add to the address register of the state
 323         // machine the address increment value corresponding to special
 324         // opcode 255. The motivation for DW_LNS_const_add_pc is this:
 325         // when the statement program needs to advance the address by a
 326         // small amount, it can use a single special opcode, which occupies
 327         // a single byte. When it needs to advance the address by up to
 328         // twice the range of the last special opcode, it can use
 329         // DW_LNS_const_add_pc followed by a special opcode, for a total
 330         // of two bytes. Only if it needs to advance the address by more
 331         // than twice that range will it need to use both DW_LNS_advance_pc
 332         // and a special opcode, requiring three or more bytes.
 333         {
 334           uint8_t adjust_opcode = 255 - prologue->OpcodeBase;
 335           uint64_t addr_offset = (adjust_opcode / prologue->LineRange) *
 336                                  prologue->MinInstLength;
 337           state.Address += addr_offset;
 338         }
 339         break;
 340
 341       case DW_LNS_fixed_advance_pc:
 342         // Takes a single uhalf operand. Add to the address register of
 343         // the state machine the value of the (unencoded) operand. This
 344         // is the only extended opcode that takes an argument that is not
 345         // a variable length number. The motivation for DW_LNS_fixed_advance_pc
 346         // is this: existing assemblers cannot emit DW_LNS_advance_pc or
 347         // special opcodes because they cannot encode LEB128 numbers or
 348         // judge when the computation of a special opcode overflows and
 349         // requires the use of DW_LNS_advance_pc. Such assemblers, however,
 350         // can use DW_LNS_fixed_advance_pc instead, sacrificing compression.
 351         state.Address += debug_line_data.getU16(offset_ptr);
 352         break;
 353
 354       case DW_LNS_set_prologue_end:
 355         // Takes no arguments. Set the prologue_end register of the
 356         // state machine to true
 357         state.PrologueEnd = true;
 358         break;
 359
 360       case DW_LNS_set_epilogue_begin:
 361         // Takes no arguments. Set the basic_block register of the
 362         // state machine to true
 363         state.EpilogueBegin = true;
 364         break;
 365
 366       case DW_LNS_set_isa:
 367         // Takes a single unsigned LEB128 operand and stores it in the
 368         // column register of the state machine.
 369         state.Isa = debug_line_data.getULEB128(offset_ptr);
 370         break;
 371
 372       default:
 373         // Handle any unknown standard opcodes here. We know the lengths
 374         // of such opcodes because they are specified in the prologue
 375         // as a multiple of LEB128 operands for each opcode.
 376         {
 377           assert(opcode - 1U < prologue->StandardOpcodeLengths.size());
 378           uint8_t opcode_length = prologue->StandardOpcodeLengths[opcode - 1];
 379           for (uint8_t i=0; i<opcode_length; ++i)
 380             debug_line_data.getULEB128(offset_ptr);
 381         }
 382         break;
 383       }
 384     } else {
 385       // Special Opcodes
 386
 387       // A special opcode value is chosen based on the amount that needs
 388       // to be added to the line and address registers. The maximum line
 389       // increment for a special opcode is the value of the line_base
 390       // field in the header, plus the value of the line_range field,
 391       // minus 1 (line base + line range - 1). If the desired line
 392       // increment is greater than the maximum line increment, a standard
 393       // opcode must be used instead of a special opcode. The “address
 394       // advance” is calculated by dividing the desired address increment
 395       // by the minimum_instruction_length field from the header. The
 396       // special opcode is then calculated using the following formula:
 397       //
 398       //  opcode = (desired line increment - line_base) +
 399       //           (line_range * address advance) + opcode_base
 400       //
 401       // If the resulting opcode is greater than 255, a standard opcode
 402       // must be used instead.
 403       //
 404       // To decode a special opcode, subtract the opcode_base from the
 405       // opcode itself to give the adjusted opcode. The amount to
 406       // increment the address register is the result of the adjusted
 407       // opcode divided by the line_range multiplied by the
 408       // minimum_instruction_length field from the header. That is:
 409       //
 410       //  address increment = (adjusted opcode / line_range) *
 411       //                      minimum_instruction_length
 412       //
 413       // The amount to increment the line register is the line_base plus
 414       // the result of the adjusted opcode modulo the line_range. That is:
 415       //
 416       // line increment = line_base + (adjusted opcode % line_range)
 417
 418       uint8_t adjust_opcode = opcode - prologue->OpcodeBase;
 419       uint64_t addr_offset = (adjust_opcode / prologue->LineRange) *
 420                              prologue->MinInstLength;
 421       int32_t line_offset = prologue->LineBase +
 422                             (adjust_opcode % prologue->LineRange);
 423       state.Line += line_offset;
 424       state.Address += addr_offset;
 425       state.appendRowToMatrix(*offset_ptr);
 426     }
 427   }
 428
 429   state.finalize(*offset_ptr);
 430
 431   return end_offset;
 432 }
 433
 434 static bool findMatchingAddress(const DWARFDebugLine::Row& row1,
 435                                 const DWARFDebugLine::Row& row2) {
 436   return row1.Address < row2.Address;
 437 }
 438
 439 uint32_t
 440 DWARFDebugLine::LineTable::lookupAddress(uint64_t address,
 441                                          uint64_t cu_high_pc) const {
 442   uint32_t index = UINT32_MAX;
 443   if (!Rows.empty()) {
 444     // Use the lower_bound algorithm to perform a binary search since we know
 445     // that our line table data is ordered by address.
 446     DWARFDebugLine::Row row;
 447     row.Address = address;
 448     typedef std::vector<Row>::const_iterator iterator;
 449     iterator begin_pos = Rows.begin();
 450     iterator end_pos = Rows.end();
 451     iterator pos = std::lower_bound(begin_pos, end_pos, row,
 452                                     findMatchingAddress);
 453     if (pos == end_pos) {
 454       if (address < cu_high_pc)
 455         return Rows.size()-1;
 456     } else {
 457       // Rely on fact that we are using a std::vector and we can do
 458       // pointer arithmetic to find the row index (which will be one less
 459       // that what we found since it will find the first position after
 460       // the current address) since std::vector iterators are just
 461       // pointers to the container type.
 462       index = pos - begin_pos;
 463       if (pos->Address > address) {
 464         if (index > 0)
 465           --index;
 466         else
 467           index = UINT32_MAX;
 468       }
 469     }
 470   }
 471   return index; // Failed to find address.
 472 }