1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/*
* Copyright (c) 2020, Itamar S. <itamar8910@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/DeprecatedFlyString.h>
#include <AK/NonnullOwnPtr.h>
#include <AK/Vector.h>
#include <LibDebug/Dwarf/DwarfTypes.h>
namespace Debug::Dwarf {
class DwarfInfo;
struct [[gnu::packed]] LineProgramUnitHeader32Common {
u32 length;
u16 version;
};
struct [[gnu::packed]] LineProgramUnitHeader32V4Ext {
u32 header_length;
u8 min_instruction_length;
u8 max_instruction_length;
u8 default_is_stmt;
i8 line_base;
u8 line_range;
u8 opcode_base;
};
struct [[gnu::packed]] LineProgramUnitHeader32V5Ext {
u8 address_size;
u8 segment_selector_size;
u32 header_length;
u8 min_instruction_length;
u8 max_instruction_length;
u8 default_is_stmt;
i8 line_base;
u8 line_range;
u8 opcode_base;
};
struct [[gnu::packed]] LineProgramUnitHeader32 {
LineProgramUnitHeader32Common common;
union {
LineProgramUnitHeader32V4Ext v4;
LineProgramUnitHeader32V5Ext v5;
};
u8 std_opcode_lengths[13];
size_t header_size() const
{
return sizeof(common) + ((common.version <= 4) ? sizeof(v4) : sizeof(v5)) + (opcode_base() - 1) * sizeof(std_opcode_lengths[0]);
}
u32 length() const { return common.length; }
u16 version() const { return common.version; }
u32 header_length() const { return (common.version <= 4) ? v4.header_length : v5.header_length; }
u8 min_instruction_length() const { return (common.version <= 4) ? v4.min_instruction_length : v5.min_instruction_length; }
u8 default_is_stmt() const { return (common.version <= 4) ? v4.default_is_stmt : v5.default_is_stmt; }
i8 line_base() const { return (common.version <= 4) ? v4.line_base : v5.line_base; }
u8 line_range() const { return (common.version <= 4) ? v4.line_range : v5.line_range; }
u8 opcode_base() const { return (common.version <= 4) ? v4.opcode_base : v5.opcode_base; }
static ErrorOr<LineProgramUnitHeader32> read_from_stream(Stream& stream)
{
LineProgramUnitHeader32 header;
TRY(stream.read_until_filled(Bytes { &header.common, sizeof(header.common) }));
if (header.common.version <= 4)
TRY(stream.read_until_filled(Bytes { &header.v4, sizeof(header.v4) }));
else
TRY(stream.read_until_filled(Bytes { &header.v5, sizeof(header.v5) }));
TRY(stream.read_until_filled(Bytes { &header.std_opcode_lengths, min(sizeof(header.std_opcode_lengths), (header.opcode_base() - 1) * sizeof(header.std_opcode_lengths[0])) }));
return header;
}
};
enum class ContentType {
Path = 1,
DirectoryIndex = 2,
Timestamp = 3,
Size = 4,
MD5 = 5,
LoUser = 0x2000,
HiUser = 0x3fff,
};
struct PathEntryFormat {
ContentType type;
AttributeDataForm form;
};
struct PathEntry {
DeprecatedString path;
size_t directory_index { 0 };
};
enum class PathListType {
Directories,
Filenames,
};
class LineProgram {
AK_MAKE_NONCOPYABLE(LineProgram);
AK_MAKE_NONMOVABLE(LineProgram);
public:
static ErrorOr<NonnullOwnPtr<LineProgram>> create(DwarfInfo& dwarf_info, SeekableStream& stream);
struct LineInfo {
FlatPtr address { 0 };
DeprecatedFlyString file;
size_t line { 0 };
};
Vector<LineInfo> const& lines() const { return m_lines; }
struct DirectoryAndFile {
DeprecatedFlyString directory;
DeprecatedFlyString filename;
};
DirectoryAndFile get_directory_and_file(size_t file_index) const;
struct FileEntry {
DeprecatedFlyString name;
size_t directory_index { 0 };
};
Vector<FileEntry> const& source_files() const { return m_source_files; }
bool looks_like_embedded_resource() const;
private:
LineProgram(DwarfInfo& dwarf_info, SeekableStream& stream, size_t unit_offset);
ErrorOr<void> parse_unit_header();
ErrorOr<void> parse_source_directories();
ErrorOr<void> parse_source_files();
ErrorOr<void> run_program();
void append_to_line_info();
void reset_registers();
ErrorOr<void> handle_extended_opcode();
ErrorOr<void> handle_standard_opcode(u8 opcode);
void handle_special_opcode(u8 opcode);
ErrorOr<void> parse_path_entries(Function<void(PathEntry& entry)> callback, PathListType list_type);
enum StandardOpcodes {
Copy = 1,
AdvancePc,
AdvanceLine,
SetFile,
SetColumn,
NegateStatement,
SetBasicBlock,
ConstAddPc,
FixAdvancePc,
SetPrologueEnd,
SetEpilogueBegin,
SetIsa
};
enum ExtendedOpcodes {
EndSequence = 1,
SetAddress,
DefineFile,
SetDiscriminator,
};
static constexpr u16 MIN_DWARF_VERSION = 3;
static constexpr u16 MAX_DWARF_VERSION = 5;
DwarfInfo& m_dwarf_info;
SeekableStream& m_stream;
size_t m_unit_offset { 0 };
LineProgramUnitHeader32 m_unit_header {};
Vector<DeprecatedString> m_source_directories;
Vector<FileEntry> m_source_files;
// The registers of the "line program" virtual machine
FlatPtr m_address { 0 };
size_t m_line { 0 };
size_t m_file_index { 0 };
bool m_is_statement { false };
bool m_basic_block { false };
bool m_prologue_end { false };
Vector<LineInfo> m_lines;
};
}
|
