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
|
/*
* Copyright (C) 2016 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#include <inttypes.h>
#include <memory>
#include "command.h"
#include "record_file.h"
#include "thread_tree.h"
#include "utils.h"
namespace {
class ReportSampleCommand : public Command {
public:
ReportSampleCommand()
: Command(
"report-sample", "report raw sample information in perf.data",
// clang-format off
"Usage: simpleperf report-sample [options]\n"
"-i <file> Specify path of record file, default is perf.data.\n"
"-o report_file_name Set report file name, default is stdout.\n"
"--show-callchain Print callchain samples.\n"
// clang-format on
),
record_filename_("perf.data"),
show_callchain_(false),
sample_count_(0) {}
bool Run(const std::vector<std::string>& args) override;
private:
bool ParseOptions(const std::vector<std::string>& args);
bool ProcessRecord(std::unique_ptr<Record> record);
bool PrintSampleRecordInProtobuf(const SampleRecord& record);
bool PrintSampleRecord(const SampleRecord& record);
std::string record_filename_;
std::unique_ptr<RecordFileReader> record_file_reader_;
bool show_callchain_;
ThreadTree thread_tree_;
std::string report_filename_;
FILE* report_fp_;
size_t sample_count_;
};
bool ReportSampleCommand::Run(const std::vector<std::string>& args) {
// 1. Parse options.
if (!ParseOptions(args)) {
return false;
}
// 2. Open record file.
record_file_reader_ = RecordFileReader::CreateInstance(record_filename_);
if (record_file_reader_ == nullptr) {
return false;
}
// 3. Prepare report output stream.
report_fp_ = stdout;
std::unique_ptr<FILE, decltype(&fclose)> fp(nullptr, fclose);
if (!report_filename_.empty()) {
fp.reset(fopen(report_filename_.c_str(), "w"));
if (fp == nullptr) {
PLOG(ERROR) << "failed to open " << report_filename_;
return false;
}
report_fp_ = fp.get();
}
// 4. Read record file, and print samples online.
if (!record_file_reader_->ReadDataSection(
[this](std::unique_ptr<Record> record) {
return ProcessRecord(std::move(record));
})) {
return false;
}
LOG(INFO) << "report " << sample_count_ << " samples in all.";
fflush(report_fp_);
if (ferror(report_fp_) != 0) {
PLOG(ERROR) << "print report failed";
return false;
}
return true;
}
bool ReportSampleCommand::ParseOptions(const std::vector<std::string>& args) {
for (size_t i = 0; i < args.size(); ++i) {
if (args[i] == "-i") {
if (!NextArgumentOrError(args, &i)) {
return false;
}
record_filename_ = args[i];
} else if (args[i] == "-o") {
if (!NextArgumentOrError(args, &i)) {
return false;
}
report_filename_ = args[i];
} else if (args[i] == "--show-callchain") {
show_callchain_ = true;
} else {
ReportUnknownOption(args, i);
return false;
}
}
return true;
}
bool ReportSampleCommand::ProcessRecord(std::unique_ptr<Record> record) {
thread_tree_.Update(*record);
if (record->type() == PERF_RECORD_SAMPLE) {
sample_count_++;
return PrintSampleRecord(*static_cast<const SampleRecord*>(record.get()));
}
return true;
}
bool ReportSampleCommand::PrintSampleRecord(const SampleRecord& r) {
bool in_kernel = r.InKernel();
const ThreadEntry* thread =
thread_tree_.FindThreadOrNew(r.tid_data.pid, r.tid_data.tid);
const MapEntry* map = thread_tree_.FindMap(thread, r.ip_data.ip, in_kernel);
const Symbol* symbol = thread_tree_.FindSymbol(map, r.ip_data.ip);
FprintIndented(report_fp_, 0, "sample:\n");
FprintIndented(report_fp_, 1, "time: %" PRIu64 "\n", r.time_data.time);
FprintIndented(report_fp_, 1, "ip: %" PRIx64 "\n", r.ip_data.ip);
FprintIndented(report_fp_, 1, "dso: %s\n", map->dso->Path().c_str());
FprintIndented(report_fp_, 1, "symbol: %s\n", symbol->DemangledName());
if (show_callchain_) {
FprintIndented(report_fp_, 1, "callchain:\n");
const std::vector<uint64_t>& ips = r.callchain_data.ips;
bool first_ip = true;
for (auto& ip : ips) {
if (ip >= PERF_CONTEXT_MAX) {
switch (ip) {
case PERF_CONTEXT_KERNEL:
in_kernel = true;
break;
case PERF_CONTEXT_USER:
in_kernel = false;
break;
default:
LOG(DEBUG) << "Unexpected perf_context in callchain: " << std::hex
<< ip;
}
} else {
if (first_ip) {
first_ip = false;
// Remove duplication with sample ip.
if (ip == r.ip_data.ip) {
continue;
}
}
const MapEntry* map = thread_tree_.FindMap(thread, ip, in_kernel);
const Symbol* symbol = thread_tree_.FindSymbol(map, ip);
FprintIndented(report_fp_, 2, "ip: %" PRIx64 "\n", ip);
FprintIndented(report_fp_, 2, "dso: %s\n", map->dso->Path().c_str());
FprintIndented(report_fp_, 2, "symbol: %s\n", symbol->DemangledName());
}
}
}
return true;
}
} // namespace
void RegisterReportSampleCommand() {
RegisterCommand("report-sample", [] {
return std::unique_ptr<Command>(new ReportSampleCommand());
});
}
|
