/* * Copyright (C) 2015 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 #include #include #include #include #include #include #include #include #include #include #include #include #include "command.h" #include "dwarf_unwind.h" #include "environment.h" #include "event_attr.h" #include "event_type.h" #include "perf_regs.h" #include "record.h" #include "record_file.h" #include "sample_tree.h" #include "thread_tree.h" #include "utils.h" class Displayable { public: Displayable(const std::string& name) : name_(name), width_(name.size()) { } virtual ~Displayable() { } const std::string& Name() const { return name_; } size_t Width() const { return width_; } virtual std::string Show(const SampleEntry& sample) const = 0; void AdjustWidth(const SampleEntry& sample) { size_t size = Show(sample).size(); width_ = std::max(width_, size); } private: const std::string name_; size_t width_; }; class AccumulatedOverheadItem : public Displayable { public: AccumulatedOverheadItem(const SampleTree& sample_tree) : Displayable("Children"), sample_tree_(sample_tree) { } std::string Show(const SampleEntry& sample) const override { uint64_t period = sample.period + sample.accumulated_period; uint64_t total_period = sample_tree_.TotalPeriod(); double percentage = (total_period != 0) ? 100.0 * period / total_period : 0.0; return android::base::StringPrintf("%.2lf%%", percentage); } private: const SampleTree& sample_tree_; }; class SelfOverheadItem : public Displayable { public: SelfOverheadItem(const SampleTree& sample_tree, const std::string& name = "Self") : Displayable(name), sample_tree_(sample_tree) { } std::string Show(const SampleEntry& sample) const override { uint64_t period = sample.period; uint64_t total_period = sample_tree_.TotalPeriod(); double percentage = (total_period != 0) ? 100.0 * period / total_period : 0.0; return android::base::StringPrintf("%.2lf%%", percentage); } private: const SampleTree& sample_tree_; }; class SampleCountItem : public Displayable { public: SampleCountItem() : Displayable("Sample") { } std::string Show(const SampleEntry& sample) const override { return android::base::StringPrintf("%" PRId64, sample.sample_count); } }; class Comparable { public: virtual ~Comparable() { } virtual int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const = 0; }; class PidItem : public Displayable, public Comparable { public: PidItem() : Displayable("Pid") { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return sample1.thread->pid - sample2.thread->pid; } std::string Show(const SampleEntry& sample) const override { return android::base::StringPrintf("%d", sample.thread->pid); } }; class TidItem : public Displayable, public Comparable { public: TidItem() : Displayable("Tid") { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return sample1.thread->tid - sample2.thread->tid; } std::string Show(const SampleEntry& sample) const override { return android::base::StringPrintf("%d", sample.thread->tid); } }; class CommItem : public Displayable, public Comparable { public: CommItem() : Displayable("Command") { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return strcmp(sample1.thread_comm, sample2.thread_comm); } std::string Show(const SampleEntry& sample) const override { return sample.thread_comm; } }; class DsoItem : public Displayable, public Comparable { public: DsoItem(const std::string& name = "Shared Object") : Displayable(name) { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return strcmp(sample1.map->dso->Path().c_str(), sample2.map->dso->Path().c_str()); } std::string Show(const SampleEntry& sample) const override { return sample.map->dso->Path(); } }; class SymbolItem : public Displayable, public Comparable { public: SymbolItem(const std::string& name = "Symbol") : Displayable(name) { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return strcmp(sample1.symbol->DemangledName(), sample2.symbol->DemangledName()); } std::string Show(const SampleEntry& sample) const override { return sample.symbol->DemangledName(); } }; class DsoFromItem : public Displayable, public Comparable { public: DsoFromItem() : Displayable("Source Shared Object") { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return strcmp(sample1.branch_from.map->dso->Path().c_str(), sample2.branch_from.map->dso->Path().c_str()); } std::string Show(const SampleEntry& sample) const override { return sample.branch_from.map->dso->Path(); } }; class DsoToItem : public DsoItem { public: DsoToItem() : DsoItem("Target Shared Object") { } }; class SymbolFromItem : public Displayable, public Comparable { public: SymbolFromItem() : Displayable("Source Symbol") { } int Compare(const SampleEntry& sample1, const SampleEntry& sample2) const override { return strcmp(sample1.branch_from.symbol->DemangledName(), sample2.branch_from.symbol->DemangledName()); } std::string Show(const SampleEntry& sample) const override { return sample.branch_from.symbol->DemangledName(); } }; class SymbolToItem : public SymbolItem { public: SymbolToItem() : SymbolItem("Target Symbol") { } }; static std::set branch_sort_keys = { "dso_from", "dso_to", "symbol_from", "symbol_to", }; class ReportCommand : public Command { public: ReportCommand() : Command( "report", "report sampling information in perf.data", "Usage: simpleperf report [options]\n" " -b Use the branch-to addresses in sampled take branches instead of\n" " the instruction addresses. Only valid for perf.data recorded with\n" " -b/-j option.\n" " --children Print the overhead accumulated by appearing in the callchain.\n" " --comms comm1,comm2,...\n" " Report only for selected comms.\n" " --dsos dso1,dso2,...\n" " Report only for selected dsos.\n" " -g [callee|caller]\n" " Print call graph. If callee mode is used, the graph shows how\n" " functions are called from others. Otherwise, the graph shows how\n" " functions call others. Default is callee mode.\n" " -i Specify path of record file, default is perf.data.\n" " -n Print the sample count for each item.\n" " --no-demangle Don't demangle symbol names.\n" " -o report_file_name Set report file name, default is stdout.\n" " --pid pid1,pid2,...\n" " Report only for selected pids.\n" " --sort key1,key2,...\n" " Select the keys to sort and print the report. Possible keys\n" " include pid, tid, comm, dso, symbol, dso_from, dso_to, symbol_from\n" " symbol_to. dso_from, dso_to, symbol_from, symbol_to can only be\n" " used with -b option. Default keys are \"comm,pid,tid,dso,symbol\"\n" " --symfs Look for files with symbols relative to this directory.\n" " --tids tid1,tid2,...\n" " Report only for selected tids.\n" " --vmlinux \n" " Parse kernel symbols from .\n"), record_filename_("perf.data"), record_file_arch_(GetBuildArch()), use_branch_address_(false), accumulate_callchain_(false), print_callgraph_(false), callgraph_show_callee_(true), report_fp_(nullptr) { compare_sample_func_t compare_sample_callback = std::bind( &ReportCommand::CompareSampleEntry, this, std::placeholders::_1, std::placeholders::_2); sample_tree_ = std::unique_ptr(new SampleTree(&thread_tree_, compare_sample_callback)); } bool Run(const std::vector& args); private: bool ParseOptions(const std::vector& args); bool ReadEventAttrFromRecordFile(); void ReadSampleTreeFromRecordFile(); void ProcessRecord(std::unique_ptr record); void ProcessSampleRecord(const SampleRecord& r); bool ReadFeaturesFromRecordFile(); int CompareSampleEntry(const SampleEntry& sample1, const SampleEntry& sample2); bool PrintReport(); void PrintReportContext(); void CollectReportWidth(); void CollectReportEntryWidth(const SampleEntry& sample); void PrintReportHeader(); void PrintReportEntry(const SampleEntry& sample); void PrintCallGraph(const SampleEntry& sample); void PrintCallGraphEntry(size_t depth, std::string prefix, const std::unique_ptr& node, uint64_t parent_period, bool last); std::string record_filename_; ArchType record_file_arch_; std::unique_ptr record_file_reader_; perf_event_attr event_attr_; std::vector> displayable_items_; std::vector comparable_items_; ThreadTree thread_tree_; std::unique_ptr sample_tree_; bool use_branch_address_; std::string record_cmdline_; bool accumulate_callchain_; bool print_callgraph_; bool callgraph_show_callee_; std::string report_filename_; FILE* report_fp_; }; bool ReportCommand::Run(const std::vector& args) { // 1. Parse options. if (!ParseOptions(args)) { return false; } // 2. Read record file and build SampleTree. record_file_reader_ = RecordFileReader::CreateInstance(record_filename_); if (record_file_reader_ == nullptr) { return false; } if (!ReadEventAttrFromRecordFile()) { return false; } // Read features first to prepare build ids used when building SampleTree. if (!ReadFeaturesFromRecordFile()) { return false; } ScopedCurrentArch scoped_arch(record_file_arch_); ReadSampleTreeFromRecordFile(); // 3. Show collected information. if (!PrintReport()) { return false; } return true; } bool ReportCommand::ParseOptions(const std::vector& args) { bool demangle = true; std::string symfs_dir; std::string vmlinux; bool print_sample_count = false; std::vector sort_keys = {"comm", "pid", "tid", "dso", "symbol"}; std::unordered_set comm_filter; std::unordered_set dso_filter; std::unordered_set pid_filter; std::unordered_set tid_filter; for (size_t i = 0; i < args.size(); ++i) { if (args[i] == "-b") { use_branch_address_ = true; } else if (args[i] == "--children") { accumulate_callchain_ = true; } else if (args[i] == "--comms" || args[i] == "--dsos") { std::unordered_set& filter = (args[i] == "--comms" ? comm_filter : dso_filter); if (!NextArgumentOrError(args, &i)) { return false; } std::vector strs = android::base::Split(args[i], ","); filter.insert(strs.begin(), strs.end()); } else if (args[i] == "-g") { print_callgraph_ = true; accumulate_callchain_ = true; if (i + 1 < args.size() && args[i + 1][0] != '-') { ++i; if (args[i] == "callee") { callgraph_show_callee_ = true; } else if (args[i] == "caller") { callgraph_show_callee_ = false; } else { LOG(ERROR) << "Unknown argument with -g option: " << args[i]; return false; } } } else if (args[i] == "-i") { if (!NextArgumentOrError(args, &i)) { return false; } record_filename_ = args[i]; } else if (args[i] == "-n") { print_sample_count = true; } else if (args[i] == "--no-demangle") { demangle = false; } else if (args[i] == "-o") { if (!NextArgumentOrError(args, &i)) { return false; } report_filename_ = args[i]; } else if (args[i] == "--pids" || args[i] == "--tids") { if (!NextArgumentOrError(args, &i)) { return false; } std::vector strs = android::base::Split(args[i], ","); std::vector ids; for (const auto& s : strs) { int id; if (!android::base::ParseInt(s.c_str(), &id, 0)) { LOG(ERROR) << "invalid id in " << args[i] << " option: " << s; return false; } ids.push_back(id); } std::unordered_set& filter = (args[i] == "--pids" ? pid_filter : tid_filter); filter.insert(ids.begin(), ids.end()); } else if (args[i] == "--sort") { if (!NextArgumentOrError(args, &i)) { return false; } sort_keys = android::base::Split(args[i], ","); } else if (args[i] == "--symfs") { if (!NextArgumentOrError(args, &i)) { return false; } symfs_dir = args[i]; } else if (args[i] == "--vmlinux") { if (!NextArgumentOrError(args, &i)) { return false; } vmlinux = args[i]; } else { ReportUnknownOption(args, i); return false; } } Dso::SetDemangle(demangle); if (!Dso::SetSymFsDir(symfs_dir)) { return false; } if (!vmlinux.empty()) { Dso::SetVmlinux(vmlinux); } if (!accumulate_callchain_) { displayable_items_.push_back( std::unique_ptr(new SelfOverheadItem(*sample_tree_, "Overhead"))); } else { displayable_items_.push_back( std::unique_ptr(new AccumulatedOverheadItem(*sample_tree_))); displayable_items_.push_back(std::unique_ptr(new SelfOverheadItem(*sample_tree_))); } if (print_sample_count) { displayable_items_.push_back(std::unique_ptr(new SampleCountItem)); } for (auto& key : sort_keys) { if (!use_branch_address_ && branch_sort_keys.find(key) != branch_sort_keys.end()) { LOG(ERROR) << "sort key '" << key << "' can only be used with -b option."; return false; } if (key == "pid") { PidItem* item = new PidItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "tid") { TidItem* item = new TidItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "comm") { CommItem* item = new CommItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "dso") { DsoItem* item = new DsoItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "symbol") { SymbolItem* item = new SymbolItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "dso_from") { DsoFromItem* item = new DsoFromItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "dso_to") { DsoToItem* item = new DsoToItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "symbol_from") { SymbolFromItem* item = new SymbolFromItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else if (key == "symbol_to") { SymbolToItem* item = new SymbolToItem; displayable_items_.push_back(std::unique_ptr(item)); comparable_items_.push_back(item); } else { LOG(ERROR) << "Unknown sort key: " << key; return false; } } sample_tree_->SetFilters(pid_filter, tid_filter, comm_filter, dso_filter); return true; } bool ReportCommand::ReadEventAttrFromRecordFile() { const std::vector& attrs = record_file_reader_->AttrSection(); if (attrs.size() != 1) { LOG(ERROR) << "record file contains " << attrs.size() << " attrs"; return false; } event_attr_ = attrs[0].attr; if (use_branch_address_ && (event_attr_.sample_type & PERF_SAMPLE_BRANCH_STACK) == 0) { LOG(ERROR) << record_filename_ << " is not recorded with branch stack sampling option."; return false; } return true; } void ReportCommand::ReadSampleTreeFromRecordFile() { thread_tree_.AddThread(0, 0, "swapper"); record_file_reader_->ReadDataSection([this](std::unique_ptr record) { ProcessRecord(std::move(record)); return true; }); } void ReportCommand::ProcessRecord(std::unique_ptr record) { BuildThreadTree(*record, &thread_tree_); if (record->header.type == PERF_RECORD_SAMPLE) { ProcessSampleRecord(*static_cast(record.get())); } } void ReportCommand::ProcessSampleRecord(const SampleRecord& r) { if (use_branch_address_ && (r.sample_type & PERF_SAMPLE_BRANCH_STACK)) { for (auto& item : r.branch_stack_data.stack) { if (item.from != 0 && item.to != 0) { sample_tree_->AddBranchSample(r.tid_data.pid, r.tid_data.tid, item.from, item.to, item.flags, r.time_data.time, r.period_data.period); } } } else { bool in_kernel = (r.header.misc & PERF_RECORD_MISC_CPUMODE_MASK) == PERF_RECORD_MISC_KERNEL; SampleEntry* sample = sample_tree_->AddSample(r.tid_data.pid, r.tid_data.tid, r.ip_data.ip, r.time_data.time, r.period_data.period, in_kernel); if (sample == nullptr) { return; } if (accumulate_callchain_) { std::vector ips; if (r.sample_type & PERF_SAMPLE_CALLCHAIN) { ips.insert(ips.end(), r.callchain_data.ips.begin(), r.callchain_data.ips.end()); } // Use stack_user_data.data.size() instead of stack_user_data.dyn_size, to make up for // the missing kernel patch in N9. See b/22612370. if ((r.sample_type & PERF_SAMPLE_REGS_USER) && (r.regs_user_data.reg_mask != 0) && (r.sample_type & PERF_SAMPLE_STACK_USER) && (!r.stack_user_data.data.empty())) { RegSet regs = CreateRegSet(r.regs_user_data.reg_mask, r.regs_user_data.regs); std::vector stack(r.stack_user_data.data.begin(), r.stack_user_data.data.begin() + r.stack_user_data.data.size()); std::vector unwind_ips = UnwindCallChain(ScopedCurrentArch::GetCurrentArch(), *sample->thread, regs, stack); if (!unwind_ips.empty()) { ips.push_back(PERF_CONTEXT_USER); ips.insert(ips.end(), unwind_ips.begin(), unwind_ips.end()); } } std::vector callchain; callchain.push_back(sample); 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(ERROR) << "Unexpected perf_context in callchain: " << ip; } } else { if (first_ip) { first_ip = false; // Remove duplication with sampled ip. if (ip == r.ip_data.ip) { continue; } } SampleEntry* sample = sample_tree_->AddCallChainSample(r.tid_data.pid, r.tid_data.tid, ip, r.time_data.time, r.period_data.period, in_kernel, callchain); callchain.push_back(sample); } } if (print_callgraph_) { std::set added_set; if (!callgraph_show_callee_) { std::reverse(callchain.begin(), callchain.end()); } while (callchain.size() >= 2) { SampleEntry* sample = callchain[0]; callchain.erase(callchain.begin()); // Add only once for recursive calls on callchain. if (added_set.find(sample) != added_set.end()) { continue; } added_set.insert(sample); sample_tree_->InsertCallChainForSample(sample, callchain, r.period_data.period); } } } } } bool ReportCommand::ReadFeaturesFromRecordFile() { std::vector records = record_file_reader_->ReadBuildIdFeature(); std::vector> build_ids; for (auto& r : records) { build_ids.push_back(std::make_pair(r.filename, r.build_id)); } Dso::SetBuildIds(build_ids); std::string arch = record_file_reader_->ReadFeatureString(PerfFileFormat::FEAT_ARCH); if (!arch.empty()) { record_file_arch_ = GetArchType(arch); if (record_file_arch_ == ARCH_UNSUPPORTED) { return false; } } std::vector cmdline = record_file_reader_->ReadCmdlineFeature(); if (!cmdline.empty()) { record_cmdline_ = android::base::Join(cmdline, ' '); } return true; } int ReportCommand::CompareSampleEntry(const SampleEntry& sample1, const SampleEntry& sample2) { for (auto& item : comparable_items_) { int result = item->Compare(sample1, sample2); if (result != 0) { return result; } } return 0; } bool ReportCommand::PrintReport() { std::unique_ptr file_handler(nullptr, fclose); if (report_filename_.empty()) { report_fp_ = stdout; } else { report_fp_ = fopen(report_filename_.c_str(), "w"); if (report_fp_ == nullptr) { PLOG(ERROR) << "failed to open file " << report_filename_; return false; } file_handler.reset(report_fp_); } PrintReportContext(); CollectReportWidth(); PrintReportHeader(); sample_tree_->VisitAllSamples( std::bind(&ReportCommand::PrintReportEntry, this, std::placeholders::_1)); fflush(report_fp_); if (ferror(report_fp_) != 0) { PLOG(ERROR) << "print report failed"; return false; } return true; } void ReportCommand::PrintReportContext() { const EventType* event_type = FindEventTypeByConfig(event_attr_.type, event_attr_.config); std::string event_type_name; if (event_type != nullptr) { event_type_name = event_type->name; } else { event_type_name = android::base::StringPrintf("(type %u, config %llu)", event_attr_.type, event_attr_.config); } if (!record_cmdline_.empty()) { fprintf(report_fp_, "Cmdline: %s\n", record_cmdline_.c_str()); } fprintf(report_fp_, "Samples: %" PRIu64 " of event '%s'\n", sample_tree_->TotalSamples(), event_type_name.c_str()); fprintf(report_fp_, "Event count: %" PRIu64 "\n\n", sample_tree_->TotalPeriod()); } void ReportCommand::CollectReportWidth() { sample_tree_->VisitAllSamples( std::bind(&ReportCommand::CollectReportEntryWidth, this, std::placeholders::_1)); } void ReportCommand::CollectReportEntryWidth(const SampleEntry& sample) { for (auto& item : displayable_items_) { item->AdjustWidth(sample); } } void ReportCommand::PrintReportHeader() { for (size_t i = 0; i < displayable_items_.size(); ++i) { auto& item = displayable_items_[i]; if (i != displayable_items_.size() - 1) { fprintf(report_fp_, "%-*s ", static_cast(item->Width()), item->Name().c_str()); } else { fprintf(report_fp_, "%s\n", item->Name().c_str()); } } } void ReportCommand::PrintReportEntry(const SampleEntry& sample) { for (size_t i = 0; i < displayable_items_.size(); ++i) { auto& item = displayable_items_[i]; if (i != displayable_items_.size() - 1) { fprintf(report_fp_, "%-*s ", static_cast(item->Width()), item->Show(sample).c_str()); } else { fprintf(report_fp_, "%s\n", item->Show(sample).c_str()); } } if (print_callgraph_) { PrintCallGraph(sample); } } void ReportCommand::PrintCallGraph(const SampleEntry& sample) { std::string prefix = " "; fprintf(report_fp_, "%s|\n", prefix.c_str()); fprintf(report_fp_, "%s-- %s\n", prefix.c_str(), sample.symbol->DemangledName()); prefix.append(3, ' '); for (size_t i = 0; i < sample.callchain.children.size(); ++i) { PrintCallGraphEntry(1, prefix, sample.callchain.children[i], sample.callchain.children_period, (i + 1 == sample.callchain.children.size())); } } void ReportCommand::PrintCallGraphEntry(size_t depth, std::string prefix, const std::unique_ptr& node, uint64_t parent_period, bool last) { if (depth > 20) { LOG(WARNING) << "truncated callgraph at depth " << depth; return; } prefix += "|"; fprintf(report_fp_, "%s\n", prefix.c_str()); if (last) { prefix.back() = ' '; } std::string percentage_s = "-- "; if (node->period + node->children_period != parent_period) { double percentage = 100.0 * (node->period + node->children_period) / parent_period; percentage_s = android::base::StringPrintf("--%.2lf%%-- ", percentage); } fprintf(report_fp_, "%s%s%s\n", prefix.c_str(), percentage_s.c_str(), node->chain[0]->symbol->DemangledName()); prefix.append(percentage_s.size(), ' '); for (size_t i = 1; i < node->chain.size(); ++i) { fprintf(report_fp_, "%s%s\n", prefix.c_str(), node->chain[i]->symbol->DemangledName()); } for (size_t i = 0; i < node->children.size(); ++i) { PrintCallGraphEntry(depth + 1, prefix, node->children[i], node->children_period, (i + 1 == node->children.size())); } } void RegisterReportCommand() { RegisterCommand("report", [] { return std::unique_ptr(new ReportCommand()); }); }