lib/DebugInfo/DWARFDebugLine.h

   1 //===-- DWARFDebugLine.h ----------------------------------------*- C++ -*-===//
   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 #ifndef LLVM_DEBUGINFO_DWARFDEBUGLINE_H
  11 #define LLVM_DEBUGINFO_DWARFDEBUGLINE_H
  12
  13 #include "llvm/Support/DataExtractor.h"
  14 #include <map>
  15 #include <string>
  16 #include <vector>
  17
  18 namespace llvm {
  19
  20 class raw_ostream;
  21
  22 class DWARFDebugLine {
  23 public:
  24   struct FileNameEntry {
  25     FileNameEntry() : DirIdx(0), ModTime(0), Length(0) {}
  26
  27     std::string Name;
  28     uint64_t DirIdx;
  29     uint64_t ModTime;
  30     uint64_t Length;
  31   };
  32
  33   struct Prologue {
  34     Prologue()
  35       : TotalLength(0), Version(0), PrologueLength(0), MinInstLength(0),
  36         DefaultIsStmt(0), LineBase(0), LineRange(0), OpcodeBase(0) {}
  37
  38     // The size in bytes of the statement information for this compilation unit
  39     // (not including the total_length field itself).
  40     uint32_t TotalLength;
  41     // Version identifier for the statement information format.
  42     uint16_t Version;
  43     // The number of bytes following the prologue_length field to the beginning
  44     // of the first byte of the statement program itself.
  45     uint32_t PrologueLength;
  46     // The size in bytes of the smallest target machine instruction. Statement
  47     // program opcodes that alter the address register first multiply their
  48     // operands by this value.
  49     uint8_t MinInstLength;
  50     // The initial value of theis_stmtregister.
  51     uint8_t DefaultIsStmt;
  52     // This parameter affects the meaning of the special opcodes. See below.
  53     int8_t LineBase;
  54     // This parameter affects the meaning of the special opcodes. See below.
  55     uint8_t LineRange;
  56     // The number assigned to the first special opcode.
  57     uint8_t OpcodeBase;
  58     std::vector<uint8_t> StandardOpcodeLengths;
  59     std::vector<std::string> IncludeDirectories;
  60     std::vector<FileNameEntry> FileNames;
  61
  62     // Length of the prologue in bytes.
  63     uint32_t getLength() const {
  64       return PrologueLength + sizeof(TotalLength) + sizeof(Version) +
  65              sizeof(PrologueLength);
  66     }
  67     // Length of the line table data in bytes (not including the prologue).
  68     uint32_t getStatementTableLength() const {
  69       return TotalLength + sizeof(TotalLength) - getLength();
  70     }
  71     int32_t getMaxLineIncrementForSpecialOpcode() const {
  72       return LineBase + (int8_t)LineRange - 1;
  73     }
  74     void dump(raw_ostream &OS) const;
  75     void clear() {
  76       TotalLength = Version = PrologueLength = 0;
  77       MinInstLength = LineBase = LineRange = OpcodeBase = 0;
  78       StandardOpcodeLengths.clear();
  79       IncludeDirectories.clear();
  80       FileNames.clear();
  81     }
  82     bool getFile(uint32_t file_idx, std::string& file, std::string& dir) const;
  83   };
  84
  85   // Standard .debug_line state machine structure.
  86   struct Row {
  87     Row(bool default_is_stmt = false) { reset(default_is_stmt); }
  88     /// Called after a row is appended to the matrix.
  89     void postAppend();
  90     void reset(bool default_is_stmt);
  91     void dump(raw_ostream &OS) const;
  92
  93     // The program-counter value corresponding to a machine instruction
  94     // generated by the compiler.
  95     uint64_t Address;
  96     // An unsigned integer indicating a source line number. Lines are numbered
  97     // beginning at 1. The compiler may emit the value 0 in cases where an
  98     // instruction cannot be attributed to any source line.
  99     uint32_t Line;
 100     // An unsigned integer indicating a column number within a source line.
 101     // Columns are numbered beginning at 1. The value 0 is reserved to indicate
 102     // that a statement begins at the 'left edge' of the line.
 103     uint16_t Column;
 104     // An unsigned integer indicating the identity of the source file
 105     // corresponding to a machine instruction.
 106     uint16_t File;
 107     // An unsigned integer whose value encodes the applicable instruction set
 108     // architecture for the current instruction.
 109     uint8_t Isa;
 110     // A boolean indicating that the current instruction is the beginning of a
 111     // statement.
 112     uint8_t IsStmt:1,
 113             // A boolean indicating that the current instruction is the
 114             // beginning of a basic block.
 115             BasicBlock:1,
 116             // A boolean indicating that the current address is that of the
 117             // first byte after the end of a sequence of target machine
 118             // instructions.
 119             EndSequence:1,
 120             // A boolean indicating that the current address is one (of possibly
 121             // many) where execution should be suspended for an entry breakpoint
 122             // of a function.
 123             PrologueEnd:1,
 124             // A boolean indicating that the current address is one (of possibly
 125             // many) where execution should be suspended for an exit breakpoint
 126             // of a function.
 127             EpilogueBegin:1;
 128   };
 129
 130   struct LineTable {
 131     void appendRow(const DWARFDebugLine::Row &state) { Rows.push_back(state); }
 132     void clear() {
 133       Prologue.clear();
 134       Rows.clear();
 135     }
 136
 137     uint32_t lookupAddress(uint64_t address, uint64_t cu_high_pc) const;
 138     void dump(raw_ostream &OS) const;
 139
 140     struct Prologue Prologue;
 141     std::vector<Row> Rows;
 142   };
 143
 144   struct State : public Row, public LineTable {
 145     // Special row codes.
 146     enum {
 147       StartParsingLineTable = 0,
 148       DoneParsingLineTable = -1
 149     };
 150
 151     State() : row(0) {}
 152
 153     virtual void appendRowToMatrix(uint32_t offset);
 154     virtual void finalize(uint32_t offset) { row = DoneParsingLineTable; }
 155     virtual void reset() { Row::reset(Prologue.DefaultIsStmt); }
 156
 157     // The row number that starts at zero for the prologue, and increases for
 158     // each row added to the matrix.
 159     unsigned row;
 160   };
 161
 162   struct DumpingState : public State {
 163     DumpingState(raw_ostream &OS) : OS(OS) {}
 164     virtual void finalize(uint32_t offset);
 165   private:
 166     raw_ostream &OS;
 167   };
 168
 169   static bool parsePrologue(DataExtractor debug_line_data, uint32_t *offset_ptr,
 170                             Prologue *prologue);
 171   /// Parse a single line table (prologue and all rows).
 172   static bool parseStatementTable(DataExtractor debug_line_data,
 173                                   uint32_t *offset_ptr, State &state);
 174
 175   /// Parse all information in the debug_line_data into an internal
 176   /// representation.
 177   void parse(DataExtractor debug_line_data);
 178   void parseIfNeeded(DataExtractor debug_line_data) {
 179     if (LineTableMap.empty())
 180       parse(debug_line_data);
 181   }
 182   static void dump(DataExtractor debug_line_data, raw_ostream &OS);
 183   const LineTable *getLineTable(uint32_t offset) const;
 184
 185 protected:
 186   typedef std::map<uint32_t, LineTable> LineTableMapTy;
 187   typedef LineTableMapTy::iterator LineTableIter;
 188   typedef LineTableMapTy::const_iterator LineTableConstIter;
 189
 190   LineTableMapTy LineTableMap;
 191 };
 192
 193 }
 194
 195 #endif