5047a33cd8
Add a capability to produce multiple heatmaps with given bucket sizes. The default heatmap block size (64B) could be too fine-grained for large binaries. Extend the option `block-size` to accept a list of bucket sizes for additional heatmaps with coarser granularity. The heatmap is simply rescaled so provided sizes should be multiples of each other. Human-readable suffixes can be used, e.g. 4K, 16kb, 1MiB. New defaults: 64B (base bucket size), 4KB (default page size), 256KB (for large binaries). Test Plan: updated heatmap-preagg.test
134 lines
4.8 KiB
C++
134 lines
4.8 KiB
C++
//===- bolt/tools/heatmap/heatmap.cpp - Profile heatmap visualization tool ===//
|
|
//
|
|
// 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 "bolt/Rewrite/RewriteInstance.h"
|
|
#include "bolt/Utils/CommandLineOpts.h"
|
|
#include "llvm/MC/TargetRegistry.h"
|
|
#include "llvm/Object/Binary.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/Errc.h"
|
|
#include "llvm/Support/Error.h"
|
|
#include "llvm/Support/FileSystem.h"
|
|
#include "llvm/Support/Program.h"
|
|
#include "llvm/Support/TargetSelect.h"
|
|
|
|
using namespace llvm;
|
|
using namespace bolt;
|
|
|
|
namespace opts {
|
|
|
|
static cl::OptionCategory *HeatmapCategories[] = {&HeatmapCategory,
|
|
&BoltOutputCategory};
|
|
|
|
static cl::opt<std::string> InputFilename(cl::Positional,
|
|
cl::desc("<executable>"),
|
|
cl::Required,
|
|
cl::cat(HeatmapCategory));
|
|
|
|
} // namespace opts
|
|
|
|
static StringRef ToolName;
|
|
|
|
static void report_error(StringRef Message, std::error_code EC) {
|
|
assert(EC);
|
|
errs() << ToolName << ": '" << Message << "': " << EC.message() << ".\n";
|
|
exit(1);
|
|
}
|
|
|
|
static void report_error(StringRef Message, Error E) {
|
|
assert(E);
|
|
errs() << ToolName << ": '" << Message << "': " << toString(std::move(E))
|
|
<< ".\n";
|
|
exit(1);
|
|
}
|
|
|
|
static std::string GetExecutablePath(const char *Argv0) {
|
|
SmallString<256> ExecutablePath(Argv0);
|
|
// Do a PATH lookup if Argv0 isn't a valid path.
|
|
if (!llvm::sys::fs::exists(ExecutablePath))
|
|
if (llvm::ErrorOr<std::string> P =
|
|
llvm::sys::findProgramByName(ExecutablePath))
|
|
ExecutablePath = *P;
|
|
return std::string(ExecutablePath);
|
|
}
|
|
|
|
int main(int argc, char **argv) {
|
|
cl::HideUnrelatedOptions(ArrayRef(opts::HeatmapCategories));
|
|
cl::ParseCommandLineOptions(
|
|
argc, argv,
|
|
" BOLT Code Heatmap tool\n\n"
|
|
" Produces code heatmaps using sampled profile\n\n"
|
|
|
|
" Inputs:\n"
|
|
" - Binary (supports BOLT-optimized binaries),\n"
|
|
" - Sampled profile collected from the binary:\n"
|
|
" - perf data or pre-aggregated profile data (instrumentation profile "
|
|
"not supported)\n"
|
|
" - perf data can have basic (IP) or branch-stack (LBR) samples\n\n"
|
|
|
|
" Outputs:\n"
|
|
" - Heatmaps: colored ASCII (requires a color-capable terminal or a"
|
|
" conversion tool like `aha`)\n"
|
|
" Multiple heatmaps are produced by default with different "
|
|
"granularities (set by `block-size` option)\n"
|
|
" - Section hotness: per-section samples% and utilization%\n"
|
|
" - Cumulative distribution: working set size corresponding to a "
|
|
"given percentile of samples\n");
|
|
|
|
if (opts::PerfData.empty()) {
|
|
errs() << ToolName << ": expected -perfdata=<filename> option.\n";
|
|
exit(1);
|
|
}
|
|
|
|
opts::HeatmapMode = opts::HM_Exclusive;
|
|
opts::AggregateOnly = true;
|
|
if (!sys::fs::exists(opts::InputFilename))
|
|
report_error(opts::InputFilename, errc::no_such_file_or_directory);
|
|
|
|
// Output to stdout by default
|
|
if (opts::OutputFilename.empty())
|
|
opts::OutputFilename = "-";
|
|
opts::HeatmapOutput.assign(opts::OutputFilename);
|
|
|
|
// Initialize targets and assembly printers/parsers.
|
|
#define BOLT_TARGET(target) \
|
|
LLVMInitialize##target##TargetInfo(); \
|
|
LLVMInitialize##target##TargetMC(); \
|
|
LLVMInitialize##target##AsmParser(); \
|
|
LLVMInitialize##target##Disassembler(); \
|
|
LLVMInitialize##target##Target(); \
|
|
LLVMInitialize##target##AsmPrinter();
|
|
|
|
#include "bolt/Core/TargetConfig.def"
|
|
|
|
ToolName = argv[0];
|
|
std::string ToolPath = GetExecutablePath(argv[0]);
|
|
Expected<OwningBinary<Binary>> BinaryOrErr =
|
|
createBinary(opts::InputFilename);
|
|
if (Error E = BinaryOrErr.takeError())
|
|
report_error(opts::InputFilename, std::move(E));
|
|
Binary &Binary = *BinaryOrErr.get().getBinary();
|
|
|
|
if (auto *e = dyn_cast<ELFObjectFileBase>(&Binary)) {
|
|
auto RIOrErr = RewriteInstance::create(e, argc, argv, ToolPath);
|
|
if (Error E = RIOrErr.takeError())
|
|
report_error("RewriteInstance", std::move(E));
|
|
|
|
RewriteInstance &RI = *RIOrErr.get();
|
|
if (Error E = RI.setProfile(opts::PerfData))
|
|
report_error(opts::PerfData, std::move(E));
|
|
|
|
if (Error E = RI.run())
|
|
report_error(opts::InputFilename, std::move(E));
|
|
} else {
|
|
report_error(opts::InputFilename, object_error::invalid_file_type);
|
|
}
|
|
|
|
return EXIT_SUCCESS;
|
|
}
|