mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 04:02:41 +01:00
196f3e9316
This reverts commit r271949. It breaks the Windows build: http://lab.llvm.org:8011/builders/clang-x64-ninja-win7/builds/12796 llvm-svn: 271952
506 lines
19 KiB
C++
506 lines
19 KiB
C++
//===- llvm-profdata.cpp - LLVM profile data tool -------------------------===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// llvm-profdata merges .profdata files.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "llvm/ADT/SmallSet.h"
|
|
#include "llvm/ADT/SmallVector.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/IR/LLVMContext.h"
|
|
#include "llvm/ProfileData/InstrProfReader.h"
|
|
#include "llvm/ProfileData/InstrProfWriter.h"
|
|
#include "llvm/ProfileData/ProfileCommon.h"
|
|
#include "llvm/ProfileData/SampleProfReader.h"
|
|
#include "llvm/ProfileData/SampleProfWriter.h"
|
|
#include "llvm/Support/CommandLine.h"
|
|
#include "llvm/Support/Errc.h"
|
|
#include "llvm/Support/FileSystem.h"
|
|
#include "llvm/Support/Format.h"
|
|
#include "llvm/Support/ManagedStatic.h"
|
|
#include "llvm/Support/MemoryBuffer.h"
|
|
#include "llvm/Support/Path.h"
|
|
#include "llvm/Support/PrettyStackTrace.h"
|
|
#include "llvm/Support/Signals.h"
|
|
#include "llvm/Support/raw_ostream.h"
|
|
#include <algorithm>
|
|
|
|
using namespace llvm;
|
|
|
|
enum ProfileFormat { PF_None = 0, PF_Text, PF_Binary, PF_GCC };
|
|
|
|
static void exitWithError(const Twine &Message, StringRef Whence = "",
|
|
StringRef Hint = "") {
|
|
errs() << "error: ";
|
|
if (!Whence.empty())
|
|
errs() << Whence << ": ";
|
|
errs() << Message << "\n";
|
|
if (!Hint.empty())
|
|
errs() << Hint << "\n";
|
|
::exit(1);
|
|
}
|
|
|
|
static void exitWithError(Error E, StringRef Whence = "") {
|
|
if (E.isA<InstrProfError>()) {
|
|
handleAllErrors(std::move(E), [&](const InstrProfError &IPE) {
|
|
instrprof_error instrError = IPE.get();
|
|
StringRef Hint = "";
|
|
if (instrError == instrprof_error::unrecognized_format) {
|
|
// Hint for common error of forgetting -sample for sample profiles.
|
|
Hint = "Perhaps you forgot to use the -sample option?";
|
|
}
|
|
exitWithError(IPE.message(), Whence, Hint);
|
|
});
|
|
}
|
|
|
|
exitWithError(toString(std::move(E)), Whence);
|
|
}
|
|
|
|
static void exitWithErrorCode(std::error_code EC, StringRef Whence = "") {
|
|
exitWithError(EC.message(), Whence);
|
|
}
|
|
|
|
namespace {
|
|
enum ProfileKinds { instr, sample };
|
|
}
|
|
|
|
static void handleMergeWriterError(Error E, StringRef WhenceFile = "",
|
|
StringRef WhenceFunction = "",
|
|
bool ShowHint = true) {
|
|
if (!WhenceFile.empty())
|
|
errs() << WhenceFile << ": ";
|
|
if (!WhenceFunction.empty())
|
|
errs() << WhenceFunction << ": ";
|
|
|
|
auto IPE = instrprof_error::success;
|
|
E = handleErrors(std::move(E),
|
|
[&IPE](std::unique_ptr<InstrProfError> E) -> Error {
|
|
IPE = E->get();
|
|
return Error(std::move(E));
|
|
});
|
|
errs() << toString(std::move(E)) << "\n";
|
|
|
|
if (ShowHint) {
|
|
StringRef Hint = "";
|
|
if (IPE != instrprof_error::success) {
|
|
switch (IPE) {
|
|
case instrprof_error::hash_mismatch:
|
|
case instrprof_error::count_mismatch:
|
|
case instrprof_error::value_site_count_mismatch:
|
|
Hint = "Make sure that all profile data to be merged is generated "
|
|
"from the same binary.";
|
|
break;
|
|
default:
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!Hint.empty())
|
|
errs() << Hint << "\n";
|
|
}
|
|
}
|
|
|
|
struct WeightedFile {
|
|
StringRef Filename;
|
|
uint64_t Weight;
|
|
|
|
WeightedFile() {}
|
|
|
|
WeightedFile(StringRef F, uint64_t W) : Filename{F}, Weight{W} {}
|
|
};
|
|
typedef SmallVector<WeightedFile, 5> WeightedFileVector;
|
|
|
|
static void mergeInstrProfile(const WeightedFileVector &Inputs,
|
|
StringRef OutputFilename,
|
|
ProfileFormat OutputFormat, bool OutputSparse) {
|
|
if (OutputFilename.compare("-") == 0)
|
|
exitWithError("Cannot write indexed profdata format to stdout.");
|
|
|
|
if (OutputFormat != PF_Binary && OutputFormat != PF_Text)
|
|
exitWithError("Unknown format is specified.");
|
|
|
|
std::error_code EC;
|
|
raw_fd_ostream Output(OutputFilename.data(), EC, sys::fs::F_None);
|
|
if (EC)
|
|
exitWithErrorCode(EC, OutputFilename);
|
|
|
|
InstrProfWriter Writer(OutputSparse);
|
|
SmallSet<instrprof_error, 4> WriterErrorCodes;
|
|
for (const auto &Input : Inputs) {
|
|
auto ReaderOrErr = InstrProfReader::create(Input.Filename);
|
|
if (Error E = ReaderOrErr.takeError())
|
|
exitWithError(std::move(E), Input.Filename);
|
|
|
|
auto Reader = std::move(ReaderOrErr.get());
|
|
bool IsIRProfile = Reader->isIRLevelProfile();
|
|
if (Writer.setIsIRLevelProfile(IsIRProfile))
|
|
exitWithError("Merge IR generated profile with Clang generated profile.");
|
|
|
|
for (auto &I : *Reader) {
|
|
if (Error E = Writer.addRecord(std::move(I), Input.Weight)) {
|
|
// Only show hint the first time an error occurs.
|
|
instrprof_error IPE = InstrProfError::take(std::move(E));
|
|
bool firstTime = WriterErrorCodes.insert(IPE).second;
|
|
handleMergeWriterError(make_error<InstrProfError>(IPE), Input.Filename,
|
|
I.Name, firstTime);
|
|
}
|
|
}
|
|
if (Reader->hasError())
|
|
exitWithError(Reader->getError(), Input.Filename);
|
|
}
|
|
if (OutputFormat == PF_Text)
|
|
Writer.writeText(Output);
|
|
else
|
|
Writer.write(Output);
|
|
}
|
|
|
|
static sampleprof::SampleProfileFormat FormatMap[] = {
|
|
sampleprof::SPF_None, sampleprof::SPF_Text, sampleprof::SPF_Binary,
|
|
sampleprof::SPF_GCC};
|
|
|
|
static void mergeSampleProfile(const WeightedFileVector &Inputs,
|
|
StringRef OutputFilename,
|
|
ProfileFormat OutputFormat) {
|
|
using namespace sampleprof;
|
|
auto WriterOrErr =
|
|
SampleProfileWriter::create(OutputFilename, FormatMap[OutputFormat]);
|
|
if (std::error_code EC = WriterOrErr.getError())
|
|
exitWithErrorCode(EC, OutputFilename);
|
|
|
|
auto Writer = std::move(WriterOrErr.get());
|
|
StringMap<FunctionSamples> ProfileMap;
|
|
SmallVector<std::unique_ptr<sampleprof::SampleProfileReader>, 5> Readers;
|
|
LLVMContext Context;
|
|
for (const auto &Input : Inputs) {
|
|
auto ReaderOrErr = SampleProfileReader::create(Input.Filename, Context);
|
|
if (std::error_code EC = ReaderOrErr.getError())
|
|
exitWithErrorCode(EC, Input.Filename);
|
|
|
|
// We need to keep the readers around until after all the files are
|
|
// read so that we do not lose the function names stored in each
|
|
// reader's memory. The function names are needed to write out the
|
|
// merged profile map.
|
|
Readers.push_back(std::move(ReaderOrErr.get()));
|
|
const auto Reader = Readers.back().get();
|
|
if (std::error_code EC = Reader->read())
|
|
exitWithErrorCode(EC, Input.Filename);
|
|
|
|
StringMap<FunctionSamples> &Profiles = Reader->getProfiles();
|
|
for (StringMap<FunctionSamples>::iterator I = Profiles.begin(),
|
|
E = Profiles.end();
|
|
I != E; ++I) {
|
|
StringRef FName = I->first();
|
|
FunctionSamples &Samples = I->second;
|
|
sampleprof_error Result = ProfileMap[FName].merge(Samples, Input.Weight);
|
|
if (Result != sampleprof_error::success) {
|
|
std::error_code EC = make_error_code(Result);
|
|
handleMergeWriterError(errorCodeToError(EC), Input.Filename, FName);
|
|
}
|
|
}
|
|
}
|
|
Writer->write(ProfileMap);
|
|
}
|
|
|
|
static WeightedFile parseWeightedFile(const StringRef &WeightedFilename) {
|
|
StringRef WeightStr, FileName;
|
|
std::tie(WeightStr, FileName) = WeightedFilename.split(',');
|
|
|
|
uint64_t Weight;
|
|
if (WeightStr.getAsInteger(10, Weight) || Weight < 1)
|
|
exitWithError("Input weight must be a positive integer.");
|
|
|
|
if (!sys::fs::exists(FileName))
|
|
exitWithErrorCode(make_error_code(errc::no_such_file_or_directory),
|
|
FileName);
|
|
|
|
return WeightedFile(FileName, Weight);
|
|
}
|
|
|
|
static int merge_main(int argc, const char *argv[]) {
|
|
cl::list<std::string> InputFilenames(cl::Positional,
|
|
cl::desc("<filename...>"));
|
|
cl::list<std::string> WeightedInputFilenames("weighted-input",
|
|
cl::desc("<weight>,<filename>"));
|
|
cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
|
|
cl::init("-"), cl::Required,
|
|
cl::desc("Output file"));
|
|
cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
|
|
cl::aliasopt(OutputFilename));
|
|
cl::opt<ProfileKinds> ProfileKind(
|
|
cl::desc("Profile kind:"), cl::init(instr),
|
|
cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
|
|
clEnumVal(sample, "Sample profile"), clEnumValEnd));
|
|
cl::opt<ProfileFormat> OutputFormat(
|
|
cl::desc("Format of output profile"), cl::init(PF_Binary),
|
|
cl::values(clEnumValN(PF_Binary, "binary", "Binary encoding (default)"),
|
|
clEnumValN(PF_Text, "text", "Text encoding"),
|
|
clEnumValN(PF_GCC, "gcc",
|
|
"GCC encoding (only meaningful for -sample)"),
|
|
clEnumValEnd));
|
|
cl::opt<bool> OutputSparse("sparse", cl::init(false),
|
|
cl::desc("Generate a sparse profile (only meaningful for -instr)"));
|
|
|
|
cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
|
|
|
|
if (InputFilenames.empty() && WeightedInputFilenames.empty())
|
|
exitWithError("No input files specified. See " +
|
|
sys::path::filename(argv[0]) + " -help");
|
|
|
|
WeightedFileVector WeightedInputs;
|
|
for (StringRef Filename : InputFilenames)
|
|
WeightedInputs.push_back(WeightedFile(Filename, 1));
|
|
for (StringRef WeightedFilename : WeightedInputFilenames)
|
|
WeightedInputs.push_back(parseWeightedFile(WeightedFilename));
|
|
|
|
if (ProfileKind == instr)
|
|
mergeInstrProfile(WeightedInputs, OutputFilename, OutputFormat,
|
|
OutputSparse);
|
|
else
|
|
mergeSampleProfile(WeightedInputs, OutputFilename, OutputFormat);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int showInstrProfile(std::string Filename, bool ShowCounts,
|
|
bool ShowIndirectCallTargets,
|
|
bool ShowDetailedSummary,
|
|
std::vector<uint32_t> DetailedSummaryCutoffs,
|
|
bool ShowAllFunctions, std::string ShowFunction,
|
|
bool TextFormat, raw_fd_ostream &OS) {
|
|
auto ReaderOrErr = InstrProfReader::create(Filename);
|
|
std::vector<uint32_t> Cutoffs(DetailedSummaryCutoffs);
|
|
if (ShowDetailedSummary && DetailedSummaryCutoffs.empty()) {
|
|
Cutoffs = {800000, 900000, 950000, 990000, 999000, 999900, 999990};
|
|
}
|
|
InstrProfSummaryBuilder Builder(Cutoffs);
|
|
if (Error E = ReaderOrErr.takeError())
|
|
exitWithError(std::move(E), Filename);
|
|
|
|
auto Reader = std::move(ReaderOrErr.get());
|
|
bool IsIRInstr = Reader->isIRLevelProfile();
|
|
size_t ShownFunctions = 0;
|
|
uint64_t TotalNumValueSites = 0;
|
|
uint64_t TotalNumValueSitesWithValueProfile = 0;
|
|
uint64_t TotalNumValues = 0;
|
|
for (const auto &Func : *Reader) {
|
|
bool Show =
|
|
ShowAllFunctions || (!ShowFunction.empty() &&
|
|
Func.Name.find(ShowFunction) != Func.Name.npos);
|
|
|
|
bool doTextFormatDump = (Show && ShowCounts && TextFormat);
|
|
|
|
if (doTextFormatDump) {
|
|
InstrProfSymtab &Symtab = Reader->getSymtab();
|
|
InstrProfWriter::writeRecordInText(Func, Symtab, OS);
|
|
continue;
|
|
}
|
|
|
|
assert(Func.Counts.size() > 0 && "function missing entry counter");
|
|
Builder.addRecord(Func);
|
|
|
|
if (Show) {
|
|
|
|
if (!ShownFunctions)
|
|
OS << "Counters:\n";
|
|
|
|
++ShownFunctions;
|
|
|
|
OS << " " << Func.Name << ":\n"
|
|
<< " Hash: " << format("0x%016" PRIx64, Func.Hash) << "\n"
|
|
<< " Counters: " << Func.Counts.size() << "\n";
|
|
if (!IsIRInstr)
|
|
OS << " Function count: " << Func.Counts[0] << "\n";
|
|
|
|
if (ShowIndirectCallTargets)
|
|
OS << " Indirect Call Site Count: "
|
|
<< Func.getNumValueSites(IPVK_IndirectCallTarget) << "\n";
|
|
|
|
if (ShowCounts) {
|
|
OS << " Block counts: [";
|
|
size_t Start = (IsIRInstr ? 0 : 1);
|
|
for (size_t I = Start, E = Func.Counts.size(); I < E; ++I) {
|
|
OS << (I == Start ? "" : ", ") << Func.Counts[I];
|
|
}
|
|
OS << "]\n";
|
|
}
|
|
|
|
if (ShowIndirectCallTargets) {
|
|
InstrProfSymtab &Symtab = Reader->getSymtab();
|
|
uint32_t NS = Func.getNumValueSites(IPVK_IndirectCallTarget);
|
|
OS << " Indirect Target Results: \n";
|
|
TotalNumValueSites += NS;
|
|
for (size_t I = 0; I < NS; ++I) {
|
|
uint32_t NV = Func.getNumValueDataForSite(IPVK_IndirectCallTarget, I);
|
|
std::unique_ptr<InstrProfValueData[]> VD =
|
|
Func.getValueForSite(IPVK_IndirectCallTarget, I);
|
|
TotalNumValues += NV;
|
|
if (NV)
|
|
TotalNumValueSitesWithValueProfile++;
|
|
for (uint32_t V = 0; V < NV; V++) {
|
|
OS << "\t[ " << I << ", ";
|
|
OS << Symtab.getFuncName(VD[V].Value) << ", " << VD[V].Count
|
|
<< " ]\n";
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (Reader->hasError())
|
|
exitWithError(Reader->getError(), Filename);
|
|
|
|
if (ShowCounts && TextFormat)
|
|
return 0;
|
|
std::unique_ptr<ProfileSummary> PS(Builder.getSummary());
|
|
if (ShowAllFunctions || !ShowFunction.empty())
|
|
OS << "Functions shown: " << ShownFunctions << "\n";
|
|
OS << "Total functions: " << PS->getNumFunctions() << "\n";
|
|
OS << "Maximum function count: " << PS->getMaxFunctionCount() << "\n";
|
|
OS << "Maximum internal block count: " << PS->getMaxInternalCount() << "\n";
|
|
if (ShownFunctions && ShowIndirectCallTargets) {
|
|
OS << "Total Number of Indirect Call Sites : " << TotalNumValueSites
|
|
<< "\n";
|
|
OS << "Total Number of Sites With Values : "
|
|
<< TotalNumValueSitesWithValueProfile << "\n";
|
|
OS << "Total Number of Profiled Values : " << TotalNumValues << "\n";
|
|
}
|
|
|
|
if (ShowDetailedSummary) {
|
|
OS << "Detailed summary:\n";
|
|
OS << "Total number of blocks: " << PS->getNumCounts() << "\n";
|
|
OS << "Total count: " << PS->getTotalCount() << "\n";
|
|
for (auto Entry : PS->getDetailedSummary()) {
|
|
OS << Entry.NumCounts << " blocks with count >= " << Entry.MinCount
|
|
<< " account for "
|
|
<< format("%0.6g", (float)Entry.Cutoff / ProfileSummary::Scale * 100)
|
|
<< " percentage of the total counts.\n";
|
|
}
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
static int showSampleProfile(std::string Filename, bool ShowCounts,
|
|
bool ShowAllFunctions, std::string ShowFunction,
|
|
raw_fd_ostream &OS) {
|
|
using namespace sampleprof;
|
|
LLVMContext Context;
|
|
auto ReaderOrErr = SampleProfileReader::create(Filename, Context);
|
|
if (std::error_code EC = ReaderOrErr.getError())
|
|
exitWithErrorCode(EC, Filename);
|
|
|
|
auto Reader = std::move(ReaderOrErr.get());
|
|
if (std::error_code EC = Reader->read())
|
|
exitWithErrorCode(EC, Filename);
|
|
|
|
if (ShowAllFunctions || ShowFunction.empty())
|
|
Reader->dump(OS);
|
|
else
|
|
Reader->dumpFunctionProfile(ShowFunction, OS);
|
|
|
|
return 0;
|
|
}
|
|
|
|
static int show_main(int argc, const char *argv[]) {
|
|
cl::opt<std::string> Filename(cl::Positional, cl::Required,
|
|
cl::desc("<profdata-file>"));
|
|
|
|
cl::opt<bool> ShowCounts("counts", cl::init(false),
|
|
cl::desc("Show counter values for shown functions"));
|
|
cl::opt<bool> TextFormat(
|
|
"text", cl::init(false),
|
|
cl::desc("Show instr profile data in text dump format"));
|
|
cl::opt<bool> ShowIndirectCallTargets(
|
|
"ic-targets", cl::init(false),
|
|
cl::desc("Show indirect call site target values for shown functions"));
|
|
cl::opt<bool> ShowDetailedSummary("detailed-summary", cl::init(false),
|
|
cl::desc("Show detailed profile summary"));
|
|
cl::list<uint32_t> DetailedSummaryCutoffs(
|
|
cl::CommaSeparated, "detailed-summary-cutoffs",
|
|
cl::desc(
|
|
"Cutoff percentages (times 10000) for generating detailed summary"),
|
|
cl::value_desc("800000,901000,999999"));
|
|
cl::opt<bool> ShowAllFunctions("all-functions", cl::init(false),
|
|
cl::desc("Details for every function"));
|
|
cl::opt<std::string> ShowFunction("function",
|
|
cl::desc("Details for matching functions"));
|
|
|
|
cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
|
|
cl::init("-"), cl::desc("Output file"));
|
|
cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
|
|
cl::aliasopt(OutputFilename));
|
|
cl::opt<ProfileKinds> ProfileKind(
|
|
cl::desc("Profile kind:"), cl::init(instr),
|
|
cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
|
|
clEnumVal(sample, "Sample profile"), clEnumValEnd));
|
|
|
|
cl::ParseCommandLineOptions(argc, argv, "LLVM profile data summary\n");
|
|
|
|
if (OutputFilename.empty())
|
|
OutputFilename = "-";
|
|
|
|
std::error_code EC;
|
|
raw_fd_ostream OS(OutputFilename.data(), EC, sys::fs::F_Text);
|
|
if (EC)
|
|
exitWithErrorCode(EC, OutputFilename);
|
|
|
|
if (ShowAllFunctions && !ShowFunction.empty())
|
|
errs() << "warning: -function argument ignored: showing all functions\n";
|
|
|
|
std::vector<uint32_t> Cutoffs(DetailedSummaryCutoffs.begin(),
|
|
DetailedSummaryCutoffs.end());
|
|
if (ProfileKind == instr)
|
|
return showInstrProfile(Filename, ShowCounts, ShowIndirectCallTargets,
|
|
ShowDetailedSummary, DetailedSummaryCutoffs,
|
|
ShowAllFunctions, ShowFunction, TextFormat, OS);
|
|
else
|
|
return showSampleProfile(Filename, ShowCounts, ShowAllFunctions,
|
|
ShowFunction, OS);
|
|
}
|
|
|
|
int main(int argc, const char *argv[]) {
|
|
// Print a stack trace if we signal out.
|
|
sys::PrintStackTraceOnErrorSignal();
|
|
PrettyStackTraceProgram X(argc, argv);
|
|
llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
|
|
|
|
StringRef ProgName(sys::path::filename(argv[0]));
|
|
if (argc > 1) {
|
|
int (*func)(int, const char *[]) = nullptr;
|
|
|
|
if (strcmp(argv[1], "merge") == 0)
|
|
func = merge_main;
|
|
else if (strcmp(argv[1], "show") == 0)
|
|
func = show_main;
|
|
|
|
if (func) {
|
|
std::string Invocation(ProgName.str() + " " + argv[1]);
|
|
argv[1] = Invocation.c_str();
|
|
return func(argc - 1, argv + 1);
|
|
}
|
|
|
|
if (strcmp(argv[1], "-h") == 0 || strcmp(argv[1], "-help") == 0 ||
|
|
strcmp(argv[1], "--help") == 0) {
|
|
|
|
errs() << "OVERVIEW: LLVM profile data tools\n\n"
|
|
<< "USAGE: " << ProgName << " <command> [args...]\n"
|
|
<< "USAGE: " << ProgName << " <command> -help\n\n"
|
|
<< "Available commands: merge, show\n";
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
if (argc < 2)
|
|
errs() << ProgName << ": No command specified!\n";
|
|
else
|
|
errs() << ProgName << ": Unknown command!\n";
|
|
|
|
errs() << "USAGE: " << ProgName << " <merge|show> [args...]\n";
|
|
return 1;
|
|
}
|