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
|
//===-- TraceDumper.h -------------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "lldb/Target/TraceCursor.h"
#include "lldb/Symbol/SymbolContext.h"
#ifndef LLDB_TARGET_TRACE_INSTRUCTION_DUMPER_H
#define LLDB_TARGET_TRACE_INSTRUCTION_DUMPER_H
namespace lldb_private {
/// Class that holds the configuration used by \a TraceDumper for
/// traversing and dumping instructions.
struct TraceDumperOptions {
/// If \b true, the cursor will be iterated forwards starting from the
/// oldest instruction. Otherwise, the iteration starts from the most
/// recent instruction.
bool forwards = false;
/// Dump only instruction addresses without disassembly nor symbol
/// information.
bool raw = false;
/// Dump in json format.
bool json = false;
/// When dumping in JSON format, pretty print the output.
bool pretty_print_json = false;
/// For each instruction, print the corresponding timestamp counter if
/// available.
bool show_tsc = false;
/// Dump the events that happened between instructions.
bool show_events = false;
/// For each instruction, print the instruction kind.
bool show_control_flow_kind = false;
/// Optional custom id to start traversing from.
llvm::Optional<uint64_t> id = llvm::None;
/// Optional number of instructions to skip from the starting position
/// of the cursor.
llvm::Optional<size_t> skip = llvm::None;
};
/// Class used to dump the instructions of a \a TraceCursor using its current
/// state and granularity.
class TraceDumper {
public:
/// Helper struct that holds symbol, disassembly and address information of an
/// instruction.
struct SymbolInfo {
SymbolContext sc;
Address address;
lldb::DisassemblerSP disassembler;
lldb::InstructionSP instruction;
lldb_private::ExecutionContext exe_ctx;
};
/// Helper struct that holds all the information we know about a trace item
struct TraceItem {
lldb::user_id_t id;
lldb::addr_t load_address;
llvm::Optional<uint64_t> tsc;
llvm::Optional<llvm::StringRef> error;
llvm::Optional<lldb::TraceEvent> event;
llvm::Optional<SymbolInfo> symbol_info;
llvm::Optional<SymbolInfo> prev_symbol_info;
llvm::Optional<lldb::cpu_id_t> cpu_id;
};
/// Interface used to abstract away the format in which the instruction
/// information will be dumped.
class OutputWriter {
public:
virtual ~OutputWriter() = default;
/// Notify this writer that the cursor ran out of data.
virtual void NoMoreData() {}
/// Dump a trace item (instruction, error or event).
virtual void TraceItem(const TraceItem &item) = 0;
};
/// Create a instruction dumper for the cursor.
///
/// \param[in] cursor
/// The cursor whose instructions will be dumped.
///
/// \param[in] s
/// The stream where to dump the instructions to.
///
/// \param[in] options
/// Additional options for configuring the dumping.
TraceDumper(lldb::TraceCursorUP &&cursor_up, Stream &s,
const TraceDumperOptions &options);
/// Dump \a count instructions of the thread trace starting at the current
/// cursor position.
///
/// This effectively moves the cursor to the next unvisited position, so that
/// a subsequent call to this method continues where it left off.
///
/// \param[in] count
/// The number of instructions to print.
///
/// \return
/// The instruction id of the last traversed instruction, or \b llvm::None
/// if no instructions were visited.
llvm::Optional<lldb::user_id_t> DumpInstructions(size_t count);
private:
/// Create a trace item for the current position without symbol information.
TraceItem CreatRawTraceItem();
lldb::TraceCursorUP m_cursor_up;
TraceDumperOptions m_options;
std::unique_ptr<OutputWriter> m_writer_up;
};
} // namespace lldb_private
#endif // LLDB_TARGET_TRACE_INSTRUCTION_DUMPER_H
|
