1 //===-- DWARFDebugLine.h ----------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_DEBUGINFO_DWARFDEBUGLINE_H
11 #define LLVM_DEBUGINFO_DWARFDEBUGLINE_H
13 #include "DWARFRelocMap.h"
14 #include "llvm/Support/DataExtractor.h"
23 class DWARFDebugLine {
25 DWARFDebugLine(const RelocAddrMap* LineInfoRelocMap) : RelocMap(LineInfoRelocMap) {}
26 struct FileNameEntry {
27 FileNameEntry() : Name(nullptr), DirIdx(0), ModTime(0), Length(0) {}
38 // The size in bytes of the statement information for this compilation unit
39 // (not including the total_length field itself).
41 // Version identifier for the statement information format.
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 maximum number of individual operations that may be encoded in an
52 uint8_t MaxOpsPerInst;
53 // The initial value of theis_stmtregister.
54 uint8_t DefaultIsStmt;
55 // This parameter affects the meaning of the special opcodes. See below.
57 // This parameter affects the meaning of the special opcodes. See below.
59 // The number assigned to the first special opcode.
61 std::vector<uint8_t> StandardOpcodeLengths;
62 std::vector<const char*> IncludeDirectories;
63 std::vector<FileNameEntry> FileNames;
65 // Length of the prologue in bytes.
66 uint32_t getLength() const {
67 return PrologueLength + sizeof(TotalLength) + sizeof(Version) +
68 sizeof(PrologueLength);
70 // Length of the line table data in bytes (not including the prologue).
71 uint32_t getStatementTableLength() const {
72 return TotalLength + sizeof(TotalLength) - getLength();
74 int32_t getMaxLineIncrementForSpecialOpcode() const {
75 return LineBase + (int8_t)LineRange - 1;
79 void dump(raw_ostream &OS) const;
80 bool parse(DataExtractor debug_line_data, uint32_t *offset_ptr);
83 // Standard .debug_line state machine structure.
85 explicit Row(bool default_is_stmt = false);
87 /// Called after a row is appended to the matrix.
89 void reset(bool default_is_stmt);
90 void dump(raw_ostream &OS) const;
92 static bool orderByAddress(const Row& LHS, const Row& RHS) {
93 return LHS.Address < RHS.Address;
96 // The program-counter value corresponding to a machine instruction
97 // generated by the compiler.
99 // An unsigned integer indicating a source line number. Lines are numbered
100 // beginning at 1. The compiler may emit the value 0 in cases where an
101 // instruction cannot be attributed to any source line.
103 // An unsigned integer indicating a column number within a source line.
104 // Columns are numbered beginning at 1. The value 0 is reserved to indicate
105 // that a statement begins at the 'left edge' of the line.
107 // An unsigned integer indicating the identity of the source file
108 // corresponding to a machine instruction.
110 // An unsigned integer whose value encodes the applicable instruction set
111 // architecture for the current instruction.
113 // An unsigned integer representing the DWARF path discriminator value
114 // for this location.
115 uint32_t Discriminator;
116 // A boolean indicating that the current instruction is the beginning of a
119 // A boolean indicating that the current instruction is the
120 // beginning of a basic block.
122 // A boolean indicating that the current address is that of the
123 // first byte after the end of a sequence of target machine
126 // A boolean indicating that the current address is one (of possibly
127 // many) where execution should be suspended for an entry breakpoint
130 // A boolean indicating that the current address is one (of possibly
131 // many) where execution should be suspended for an exit breakpoint
136 // Represents a series of contiguous machine instructions. Line table for each
137 // compilation unit may consist of multiple sequences, which are not
138 // guaranteed to be in the order of ascending instruction address.
140 // Sequence describes instructions at address range [LowPC, HighPC)
141 // and is described by line table rows [FirstRowIndex, LastRowIndex).
144 unsigned FirstRowIndex;
145 unsigned LastRowIndex;
151 static bool orderByLowPC(const Sequence& LHS, const Sequence& RHS) {
152 return LHS.LowPC < RHS.LowPC;
154 bool isValid() const {
155 return !Empty && (LowPC < HighPC) && (FirstRowIndex < LastRowIndex);
157 bool containsPC(uint64_t pc) const {
158 return (LowPC <= pc && pc < HighPC);
165 void appendRow(const DWARFDebugLine::Row &R) {
168 void appendSequence(const DWARFDebugLine::Sequence &S) {
169 Sequences.push_back(S);
172 // Returns the index of the row with file/line info for a given address,
173 // or -1 if there is no such row.
174 uint32_t lookupAddress(uint64_t address) const;
176 bool lookupAddressRange(uint64_t address, uint64_t size,
177 std::vector<uint32_t> &result) const;
179 // Extracts filename by its index in filename table in prologue.
180 // Returns true on success.
181 bool getFileNameByIndex(uint64_t FileIndex,
182 bool NeedsAbsoluteFilePath,
183 std::string &Result) const;
185 void dump(raw_ostream &OS) const;
188 /// Parse prologue and all rows.
189 bool parse(DataExtractor debug_line_data, const RelocAddrMap *RMap,
190 uint32_t *offset_ptr);
192 struct Prologue Prologue;
193 typedef std::vector<Row> RowVector;
194 typedef RowVector::const_iterator RowIter;
195 typedef std::vector<Sequence> SequenceVector;
196 typedef SequenceVector::const_iterator SequenceIter;
198 SequenceVector Sequences;
201 const LineTable *getLineTable(uint32_t offset) const;
202 const LineTable *getOrParseLineTable(DataExtractor debug_line_data,
206 struct ParsingState {
207 ParsingState(struct LineTable *LT);
209 void resetRowAndSequence();
210 void appendRowToMatrix(uint32_t offset);
212 // Line table we're currently parsing.
213 struct LineTable *LineTable;
214 // The row number that starts at zero for the prologue, and increases for
215 // each row added to the matrix.
218 struct Sequence Sequence;
221 typedef std::map<uint32_t, LineTable> LineTableMapTy;
222 typedef LineTableMapTy::iterator LineTableIter;
223 typedef LineTableMapTy::const_iterator LineTableConstIter;
225 const RelocAddrMap *RelocMap;
226 LineTableMapTy LineTableMap;