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 "llvm/Support/DataExtractor.h"
22 class DWARFDebugLine {
24 struct FileNameEntry {
25 FileNameEntry() : DirIdx(0), ModTime(0), Length(0) {}
35 : TotalLength(0), Version(0), PrologueLength(0), MinInstLength(0),
36 DefaultIsStmt(0), LineBase(0), LineRange(0), OpcodeBase(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 initial value of theis_stmtregister.
51 uint8_t DefaultIsStmt;
52 // This parameter affects the meaning of the special opcodes. See below.
54 // This parameter affects the meaning of the special opcodes. See below.
56 // The number assigned to the first special opcode.
58 std::vector<uint8_t> StandardOpcodeLengths;
59 std::vector<std::string> IncludeDirectories;
60 std::vector<FileNameEntry> FileNames;
62 // Length of the prologue in bytes.
63 uint32_t getLength() const {
64 return PrologueLength + sizeof(TotalLength) + sizeof(Version) +
65 sizeof(PrologueLength);
67 // Length of the line table data in bytes (not including the prologue).
68 uint32_t getStatementTableLength() const {
69 return TotalLength + sizeof(TotalLength) - getLength();
71 int32_t getMaxLineIncrementForSpecialOpcode() const {
72 return LineBase + (int8_t)LineRange - 1;
74 void dump(raw_ostream &OS) const;
76 TotalLength = Version = PrologueLength = 0;
77 MinInstLength = LineBase = LineRange = OpcodeBase = 0;
78 StandardOpcodeLengths.clear();
79 IncludeDirectories.clear();
84 // Standard .debug_line state machine structure.
86 Row(bool default_is_stmt = false) { reset(default_is_stmt); }
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 // The program-counter value corresponding to a machine instruction
93 // generated by the compiler.
95 // An unsigned integer indicating a source line number. Lines are numbered
96 // beginning at 1. The compiler may emit the value 0 in cases where an
97 // instruction cannot be attributed to any source line.
99 // An unsigned integer indicating a column number within a source line.
100 // Columns are numbered beginning at 1. The value 0 is reserved to indicate
101 // that a statement begins at the 'left edge' of the line.
103 // An unsigned integer indicating the identity of the source file
104 // corresponding to a machine instruction.
106 // An unsigned integer whose value encodes the applicable instruction set
107 // architecture for the current instruction.
109 // A boolean indicating that the current instruction is the beginning of a
112 // A boolean indicating that the current instruction is the
113 // beginning of a basic block.
115 // A boolean indicating that the current address is that of the
116 // first byte after the end of a sequence of target machine
119 // A boolean indicating that the current address is one (of possibly
120 // many) where execution should be suspended for an entry breakpoint
123 // A boolean indicating that the current address is one (of possibly
124 // many) where execution should be suspended for an exit breakpoint
130 void appendRow(const DWARFDebugLine::Row &state) { Rows.push_back(state); }
136 uint32_t lookupAddress(uint64_t address, uint64_t cu_high_pc) const;
137 void dump(raw_ostream &OS) const;
139 struct Prologue Prologue;
140 std::vector<Row> Rows;
143 struct State : public Row, public LineTable {
144 // Special row codes.
146 StartParsingLineTable = 0,
147 DoneParsingLineTable = -1
150 State() : row(StartParsingLineTable) {}
153 virtual void appendRowToMatrix(uint32_t offset);
154 virtual void finalize(uint32_t offset) { row = DoneParsingLineTable; }
155 virtual void reset() { Row::reset(Prologue.DefaultIsStmt); }
157 // The row number that starts at zero for the prologue, and increases for
158 // each row added to the matrix.
162 struct DumpingState : public State {
163 DumpingState(raw_ostream &OS) : OS(OS) {}
164 virtual ~DumpingState();
165 virtual void finalize(uint32_t offset);
170 static bool parsePrologue(DataExtractor debug_line_data, uint32_t *offset_ptr,
172 /// Parse a single line table (prologue and all rows).
173 static bool parseStatementTable(DataExtractor debug_line_data,
174 uint32_t *offset_ptr, State &state);
176 const LineTable *getLineTable(uint32_t offset) const;
177 const LineTable *getOrParseLineTable(DataExtractor debug_line_data,
181 typedef std::map<uint32_t, LineTable> LineTableMapTy;
182 typedef LineTableMapTy::iterator LineTableIter;
183 typedef LineTableMapTy::const_iterator LineTableConstIter;
185 LineTableMapTy LineTableMap;