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 "DWARFRelocMap.h"
  14 #include "llvm/Support/DataExtractor.h"
  15 #include <map>
  16 #include <string>
  17 #include <vector>
  18
  19 namespace llvm {
  20
  21 class raw_ostream;
  22
  23 class DWARFDebugLine {
  24 public:
  25   DWARFDebugLine(const RelocAddrMap* LineInfoRelocMap) : RelocMap(LineInfoRelocMap) {}
  26   struct FileNameEntry {
  27     FileNameEntry() : Name(0), DirIdx(0), ModTime(0), Length(0) {}
  28
  29     const char *Name;
  30     uint64_t DirIdx;
  31     uint64_t ModTime;
  32     uint64_t Length;
  33   };
  34
  35   struct Prologue {
  36     Prologue()
  37       : TotalLength(0), Version(0), PrologueLength(0), MinInstLength(0),
  38         DefaultIsStmt(0), LineBase(0), LineRange(0), OpcodeBase(0) {}
  39
  40     // The size in bytes of the statement information for this compilation unit
  41     // (not including the total_length field itself).
  42     uint32_t TotalLength;
  43     // Version identifier for the statement information format.
  44     uint16_t Version;
  45     // The number of bytes following the prologue_length field to the beginning
  46     // of the first byte of the statement program itself.
  47     uint32_t PrologueLength;
  48     // The size in bytes of the smallest target machine instruction. Statement
  49     // program opcodes that alter the address register first multiply their
  50     // operands by this value.
  51     uint8_t MinInstLength;
  52     // The initial value of theis_stmtregister.
  53     uint8_t DefaultIsStmt;
  54     // This parameter affects the meaning of the special opcodes. See below.
  55     int8_t LineBase;
  56     // This parameter affects the meaning of the special opcodes. See below.
  57     uint8_t LineRange;
  58     // The number assigned to the first special opcode.
  59     uint8_t OpcodeBase;
  60     std::vector<uint8_t> StandardOpcodeLengths;
  61     std::vector<const char*> IncludeDirectories;
  62     std::vector<FileNameEntry> FileNames;
  63
  64     // Length of the prologue in bytes.
  65     uint32_t getLength() const {
  66       return PrologueLength + sizeof(TotalLength) + sizeof(Version) +
  67              sizeof(PrologueLength);
  68     }
  69     // Length of the line table data in bytes (not including the prologue).
  70     uint32_t getStatementTableLength() const {
  71       return TotalLength + sizeof(TotalLength) - getLength();
  72     }
  73     int32_t getMaxLineIncrementForSpecialOpcode() const {
  74       return LineBase + (int8_t)LineRange - 1;
  75     }
  76     void dump(raw_ostream &OS) const;
  77     void clear() {
  78       TotalLength = Version = PrologueLength = 0;
  79       MinInstLength = LineBase = LineRange = OpcodeBase = 0;
  80       StandardOpcodeLengths.clear();
  81       IncludeDirectories.clear();
  82       FileNames.clear();
  83     }
  84   };
  85
  86   // Standard .debug_line state machine structure.
  87   struct Row {
  88     Row(bool default_is_stmt = false) { reset(default_is_stmt); }
  89     /// Called after a row is appended to the matrix.
  90     void postAppend();
  91     void reset(bool default_is_stmt);
  92     void dump(raw_ostream &OS) const;
  93
  94     static bool orderByAddress(const Row& LHS, const Row& RHS) {
  95       return LHS.Address < RHS.Address;
  96     }
  97
  98     // The program-counter value corresponding to a machine instruction
  99     // generated by the compiler.
 100     uint64_t Address;
 101     // An unsigned integer indicating a source line number. Lines are numbered
 102     // beginning at 1. The compiler may emit the value 0 in cases where an
 103     // instruction cannot be attributed to any source line.
 104     uint32_t Line;
 105     // An unsigned integer indicating a column number within a source line.
 106     // Columns are numbered beginning at 1. The value 0 is reserved to indicate
 107     // that a statement begins at the 'left edge' of the line.
 108     uint16_t Column;
 109     // An unsigned integer indicating the identity of the source file
 110     // corresponding to a machine instruction.
 111     uint16_t File;
 112     // An unsigned integer whose value encodes the applicable instruction set
 113     // architecture for the current instruction.
 114     uint8_t Isa;
 115     // An unsigned integer representing the DWARF path discriminator value
 116     // for this location.
 117     uint32_t Discriminator;
 118     // A boolean indicating that the current instruction is the beginning of a
 119     // statement.
 120     uint8_t IsStmt:1,
 121             // A boolean indicating that the current instruction is the
 122             // beginning of a basic block.
 123             BasicBlock:1,
 124             // A boolean indicating that the current address is that of the
 125             // first byte after the end of a sequence of target machine
 126             // instructions.
 127             EndSequence:1,
 128             // A boolean indicating that the current address is one (of possibly
 129             // many) where execution should be suspended for an entry breakpoint
 130             // of a function.
 131             PrologueEnd:1,
 132             // A boolean indicating that the current address is one (of possibly
 133             // many) where execution should be suspended for an exit breakpoint
 134             // of a function.
 135             EpilogueBegin:1;
 136   };
 137
 138   // Represents a series of contiguous machine instructions. Line table for each
 139   // compilation unit may consist of multiple sequences, which are not
 140   // guaranteed to be in the order of ascending instruction address.
 141   struct Sequence {
 142     // Sequence describes instructions at address range [LowPC, HighPC)
 143     // and is described by line table rows [FirstRowIndex, LastRowIndex).
 144     uint64_t LowPC;
 145     uint64_t HighPC;
 146     unsigned FirstRowIndex;
 147     unsigned LastRowIndex;
 148     bool Empty;
 149
 150     Sequence() { reset(); }
 151     void reset() {
 152       LowPC = 0;
 153       HighPC = 0;
 154       FirstRowIndex = 0;
 155       LastRowIndex = 0;
 156       Empty = true;
 157     }
 158     static bool orderByLowPC(const Sequence& LHS, const Sequence& RHS) {
 159       return LHS.LowPC < RHS.LowPC;
 160     }
 161     bool isValid() const {
 162       return !Empty && (LowPC < HighPC) && (FirstRowIndex < LastRowIndex);
 163     }
 164     bool containsPC(uint64_t pc) const {
 165       return (LowPC <= pc && pc < HighPC);
 166     }
 167   };
 168
 169   struct LineTable {
 170     void appendRow(const DWARFDebugLine::Row &state) { Rows.push_back(state); }
 171     void appendSequence(const DWARFDebugLine::Sequence &sequence) {
 172       Sequences.push_back(sequence);
 173     }
 174     void clear() {
 175       Prologue.clear();
 176       Rows.clear();
 177       Sequences.clear();
 178     }
 179
 180     // Returns the index of the row with file/line info for a given address,
 181     // or -1 if there is no such row.
 182     uint32_t lookupAddress(uint64_t address) const;
 183
 184     bool lookupAddressRange(uint64_t address,
 185                             uint64_t size,
 186                             std::vector<uint32_t>& result) const;
 187
 188     // Extracts filename by its index in filename table in prologue.
 189     // Returns true on success.
 190     bool getFileNameByIndex(uint64_t FileIndex,
 191                             bool NeedsAbsoluteFilePath,
 192                             std::string &Result) const;
 193
 194     void dump(raw_ostream &OS) const;
 195
 196     struct Prologue Prologue;
 197     typedef std::vector<Row> RowVector;
 198     typedef RowVector::const_iterator RowIter;
 199     typedef std::vector<Sequence> SequenceVector;
 200     typedef SequenceVector::const_iterator SequenceIter;
 201     RowVector Rows;
 202     SequenceVector Sequences;
 203   };
 204
 205   struct State : public Row, public Sequence, public LineTable {
 206     // Special row codes.
 207     enum {
 208       StartParsingLineTable = 0,
 209       DoneParsingLineTable = -1
 210     };
 211
 212     State() : row(StartParsingLineTable) {}
 213     virtual ~State();
 214
 215     virtual void appendRowToMatrix(uint32_t offset);
 216     virtual void finalize();
 217     virtual void reset() {
 218       Row::reset(Prologue.DefaultIsStmt);
 219       Sequence::reset();
 220     }
 221
 222     // The row number that starts at zero for the prologue, and increases for
 223     // each row added to the matrix.
 224     unsigned row;
 225   };
 226
 227   struct DumpingState : public State {
 228     DumpingState(raw_ostream &OS) : OS(OS) {}
 229     virtual ~DumpingState();
 230     virtual void finalize();
 231   private:
 232     raw_ostream &OS;
 233   };
 234
 235   static bool parsePrologue(DataExtractor debug_line_data, uint32_t *offset_ptr,
 236                             Prologue *prologue);
 237   /// Parse a single line table (prologue and all rows).
 238   static bool parseStatementTable(DataExtractor debug_line_data,
 239                                   const RelocAddrMap *RMap,
 240                                   uint32_t *offset_ptr, State &state);
 241
 242   const LineTable *getLineTable(uint32_t offset) const;
 243   const LineTable *getOrParseLineTable(DataExtractor debug_line_data,
 244                                        uint32_t offset);
 245
 246 private:
 247   typedef std::map<uint32_t, LineTable> LineTableMapTy;
 248   typedef LineTableMapTy::iterator LineTableIter;
 249   typedef LineTableMapTy::const_iterator LineTableConstIter;
 250
 251   const RelocAddrMap *RelocMap;
 252   LineTableMapTy LineTableMap;
 253 };
 254
 255 }
 256
 257 #endif