blob: 5a7599ae1ca4c619cfcd506c9ee993b6713415d3 [file] [log] [blame]
/*
* 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 "system/extras/simpleperf/report_sample.pb.h"
#include <google/protobuf/io/coded_stream.h>
#include <google/protobuf/io/zero_copy_stream_impl_lite.h>
#include "command.h"
#include "record_file.h"
#include "thread_tree.h"
#include "utils.h"
namespace proto = simpleperf_report_proto;
namespace {
class ProtobufFileWriter : public google::protobuf::io::CopyingOutputStream {
public:
explicit ProtobufFileWriter(FILE* out_fp) : out_fp_(out_fp) {}
bool Write(const void* buffer, int size) override {
return fwrite(buffer, size, 1, out_fp_) == 1;
}
private:
FILE* out_fp_;
};
class ProtobufFileReader : public google::protobuf::io::CopyingInputStream {
public:
explicit ProtobufFileReader(FILE* in_fp) : in_fp_(in_fp) {}
int Read(void* buffer, int size) override {
return fread(buffer, 1, size, in_fp_);
}
private:
FILE* in_fp_;
};
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"
"--dump-protobuf-report <file>\n"
" Dump report file generated by\n"
" `simpleperf report-sample --protobuf -o <file>`.\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"
"--protobuf Use protobuf format in report_sample.proto to output samples.\n"
" Need to set a report_file_name when using this option.\n"
"--show-callchain Print callchain samples.\n"
// clang-format on
),
record_filename_("perf.data"),
show_callchain_(false),
use_protobuf_(false),
report_fp_(nullptr),
coded_os_(nullptr),
sample_count_(0),
lost_count_(0) {
thread_tree_.ShowMarkForUnknownSymbol();
thread_tree_.ShowIpForUnknownSymbol();
}
bool Run(const std::vector<std::string>& args) override;
private:
bool ParseOptions(const std::vector<std::string>& args);
bool DumpProtobufReport(const std::string& filename);
bool ProcessRecord(std::unique_ptr<Record> record);
bool PrintSampleRecordInProtobuf(const SampleRecord& record);
bool PrintLostSituationInProtobuf();
bool PrintSampleRecord(const SampleRecord& record);
void PrintLostSituation();
std::string record_filename_;
std::unique_ptr<RecordFileReader> record_file_reader_;
std::string dump_protobuf_report_file_;
bool show_callchain_;
bool use_protobuf_;
ThreadTree thread_tree_;
std::string report_filename_;
FILE* report_fp_;
google::protobuf::io::CodedOutputStream* coded_os_;
size_t sample_count_;
size_t lost_count_;
};
bool ReportSampleCommand::Run(const std::vector<std::string>& args) {
// 1. Parse options.
if (!ParseOptions(args)) {
return false;
}
if (!dump_protobuf_report_file_.empty()) {
return DumpProtobufReport(dump_protobuf_report_file_);
}
if (use_protobuf_) {
GOOGLE_PROTOBUF_VERIFY_VERSION;
}
// 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);
std::unique_ptr<ProtobufFileWriter> protobuf_writer;
std::unique_ptr<google::protobuf::io::CopyingOutputStreamAdaptor> protobuf_os;
std::unique_ptr<google::protobuf::io::CodedOutputStream> protobuf_coded_os;
if (!report_filename_.empty()) {
fp.reset(fopen(report_filename_.c_str(), use_protobuf_ ? "wb" : "w"));
if (fp == nullptr) {
PLOG(ERROR) << "failed to open " << report_filename_;
return false;
}
report_fp_ = fp.get();
}
if (use_protobuf_) {
protobuf_writer.reset(new ProtobufFileWriter(report_fp_));
protobuf_os.reset(new google::protobuf::io::CopyingOutputStreamAdaptor(
protobuf_writer.get()));
protobuf_coded_os.reset(
new google::protobuf::io::CodedOutputStream(protobuf_os.get()));
coded_os_ = protobuf_coded_os.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;
}
if (use_protobuf_) {
if (!PrintLostSituationInProtobuf()) {
return false;
}
coded_os_->WriteLittleEndian32(0);
if (coded_os_->HadError()) {
LOG(ERROR) << "print protobuf report failed";
return false;
}
protobuf_coded_os.reset(nullptr);
google::protobuf::ShutdownProtobufLibrary();
} else {
PrintLostSituation();
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] == "--dump-protobuf-report") {
if (!NextArgumentOrError(args, &i)) {
return false;
}
dump_protobuf_report_file_ = args[i];
} else 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] == "--protobuf") {
use_protobuf_ = true;
} else if (args[i] == "--show-callchain") {
show_callchain_ = true;
} else {
ReportUnknownOption(args, i);
return false;
}
}
if (use_protobuf_ && report_filename_.empty()) {
LOG(ERROR) << "please specify a report filename to write protobuf data";
return false;
}
return true;
}
bool ReportSampleCommand::DumpProtobufReport(const std::string& filename) {
GOOGLE_PROTOBUF_VERIFY_VERSION;
std::unique_ptr<FILE, decltype(&fclose)> fp(fopen(filename.c_str(), "rb"),
fclose);
if (fp == nullptr) {
PLOG(ERROR) << "failed to open " << filename;
return false;
}
ProtobufFileReader protobuf_reader(fp.get());
google::protobuf::io::CopyingInputStreamAdaptor adaptor(&protobuf_reader);
google::protobuf::io::CodedInputStream coded_is(&adaptor);
while (true) {
uint32_t size;
if (!coded_is.ReadLittleEndian32(&size)) {
PLOG(ERROR) << "failed to read " << filename;
return false;
}
if (size == 0) {
break;
}
auto limit = coded_is.PushLimit(size);
proto::Record proto_record;
if (!proto_record.ParseFromCodedStream(&coded_is)) {
PLOG(ERROR) << "failed to read " << filename;
return false;
}
coded_is.PopLimit(limit);
if (proto_record.type() == proto::Record_Type_SAMPLE) {
auto& sample = proto_record.sample();
static size_t sample_count = 0;
PrintIndented(0, "sample %zu:\n", ++sample_count);
PrintIndented(1, "time: %" PRIu64 "\n", sample.time());
PrintIndented(1, "thread_id: %d\n", sample.thread_id());
PrintIndented(1, "callchain:\n");
for (int j = 0; j < sample.callchain_size(); ++j) {
const proto::Sample_CallChainEntry& callchain = sample.callchain(j);
PrintIndented(2, "ip: %" PRIx64 "\n", callchain.ip());
PrintIndented(2, "dso: %s\n", callchain.file().c_str());
PrintIndented(2, "symbol: %s\n", callchain.symbol().c_str());
}
} else if (proto_record.type() == proto::Record_Type_LOST_SITUATION) {
auto& lost = proto_record.lost();
PrintIndented(0, "lost_situation:\n");
PrintIndented(1, "sample_count: %" PRIu64 "\n", lost.sample_count());
PrintIndented(1, "lost_count: %" PRIu64 "\n", lost.lost_count());
} else {
LOG(ERROR) << "unexpected record type " << proto_record.type();
return false;
}
}
google::protobuf::ShutdownProtobufLibrary();
return true;
}
bool ReportSampleCommand::ProcessRecord(std::unique_ptr<Record> record) {
thread_tree_.Update(*record);
if (record->type() == PERF_RECORD_SAMPLE) {
sample_count_++;
auto& r = *static_cast<const SampleRecord*>(record.get());
if (use_protobuf_) {
return PrintSampleRecordInProtobuf(r);
} else {
return PrintSampleRecord(r);
}
} else if (record->type() == PERF_RECORD_LOST) {
lost_count_ += static_cast<const LostRecord*>(record.get())->lost;
}
return true;
}
bool ReportSampleCommand::PrintSampleRecordInProtobuf(const SampleRecord& r) {
proto::Record proto_record;
proto_record.set_type(proto::Record_Type_SAMPLE);
proto::Sample* sample = proto_record.mutable_sample();
sample->set_time(r.time_data.time);
sample->set_thread_id(r.tid_data.tid);
proto::Sample_CallChainEntry* callchain = sample->add_callchain();
callchain->set_ip(r.ip_data.ip);
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, nullptr);
callchain->set_symbol(symbol->DemangledName());
callchain->set_file(map->dso->Path());
if (show_callchain_) {
bool first_ip = true;
for (uint64_t i = 0; i < r.callchain_data.ip_nr; ++i) {
uint64_t ip = r.callchain_data.ips[i];
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 << std::dec;
}
} 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, nullptr);
callchain = sample->add_callchain();
callchain->set_ip(ip);
callchain->set_symbol(symbol->DemangledName());
callchain->set_file(map->dso->Path());
}
}
}
coded_os_->WriteLittleEndian32(proto_record.ByteSize());
if (!proto_record.SerializeToCodedStream(coded_os_)) {
LOG(ERROR) << "failed to write sample to protobuf";
return false;
}
return true;
}
bool ReportSampleCommand::PrintLostSituationInProtobuf() {
proto::Record proto_record;
proto_record.set_type(proto::Record_Type_LOST_SITUATION);
proto::LostSituation* lost = proto_record.mutable_lost();
lost->set_sample_count(sample_count_);
lost->set_lost_count(lost_count_);
coded_os_->WriteLittleEndian32(proto_record.ByteSize());
if (!proto_record.SerializeToCodedStream(coded_os_)) {
LOG(ERROR) << "failed to write lost situation to protobuf";
return false;
}
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, nullptr);
FprintIndented(report_fp_, 0, "sample:\n");
FprintIndented(report_fp_, 1, "time: %" PRIu64 "\n", r.time_data.time);
FprintIndented(report_fp_, 1, "thread_id: %d\n", r.tid_data.tid);
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");
bool first_ip = true;
for (uint64_t i = 0; i < r.callchain_data.ip_nr; ++i) {
uint64_t ip = r.callchain_data.ips[i];
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, nullptr);
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;
}
void ReportSampleCommand::PrintLostSituation() {
FprintIndented(report_fp_, 0, "lost_situation:\n");
FprintIndented(report_fp_, 1, "sample_count: %" PRIu64 "\n", sample_count_);
FprintIndented(report_fp_, 1, "lost_count: %" PRIu64 "\n", sample_count_);
}
} // namespace
void RegisterReportSampleCommand() {
RegisterCommand("report-sample", [] {
return std::unique_ptr<Command>(new ReportSampleCommand());
});
}