//===----------------------------------------------------------------------===//
#include "llvm/ADT/StringRef.h"
+#include "llvm/IR/LLVMContext.h"
+#include "llvm/ProfileData/InstrProfReader.h"
+#include "llvm/ProfileData/InstrProfWriter.h"
+#include "llvm/ProfileData/SampleProfReader.h"
+#include "llvm/ProfileData/SampleProfWriter.h"
#include "llvm/Support/CommandLine.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 <set>
+
using namespace llvm;
-static cl::opt<std::string> Filename1(cl::Positional, cl::Required,
- cl::desc("file1"));
-static cl::opt<std::string> Filename2(cl::Positional, cl::Required,
- cl::desc("file2"));
-
-static cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
- cl::init("-"),
- cl::desc("Output file"));
-static cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
- cl::aliasopt(OutputFilename));
-
-static bool readLine(const char *&Start, const char *End, StringRef &S) {
- if (Start == End)
- return false;
-
- for (const char *I = Start; I != End; ++I) {
- assert(*I && "unexpected binary data");
- if (*I == '\n') {
- S = StringRef(Start, I - Start);
- Start = I + 1;
- return true;
+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 exitWithErrorCode(const std::error_code &Error,
+ StringRef Whence = "") {
+ if (Error.category() == instrprof_category()) {
+ instrprof_error instrError = static_cast<instrprof_error>(Error.value());
+ if (instrError == instrprof_error::unrecognized_format) {
+ // Hint for common error of forgetting -sample for sample profiles.
+ exitWithError(Error.message(), Whence,
+ "Perhaps you forgot to use the -sample option?");
}
}
+ exitWithError(Error.message(), Whence);
+}
- S = StringRef(Start, End - Start);
- Start = End;
- return true;
+namespace {
+ enum ProfileKinds { instr, sample };
}
-static StringRef getWord(const char *&Start, const char *End) {
- for (const char *I = Start; I != End; ++I)
- if (*I == ' ') {
- StringRef S(Start, I - Start);
- Start = I + 1;
- return S;
+static void handleMergeWriterError(std::error_code &Error,
+ StringRef WhenceFile = "",
+ StringRef WhenceFunction = "",
+ bool ShowHint = true)
+{
+ if (!WhenceFile.empty())
+ errs() << WhenceFile << ": ";
+ if (!WhenceFunction.empty())
+ errs() << WhenceFunction << ": ";
+ errs() << Error.message() << "\n";
+
+ if (ShowHint) {
+ StringRef Hint = "";
+ if (Error.category() == instrprof_category()) {
+ instrprof_error instrError = static_cast<instrprof_error>(Error.value());
+ switch (instrError) {
+ 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;
+ }
}
- StringRef S(Start, End - Start);
- Start = End;
- return S;
-}
-static size_t splitWords(const StringRef &Line, std::vector<StringRef> &Words) {
- const char *Start = Line.data();
- const char *End = Line.data() + Line.size();
- Words.clear();
- while (Start != End)
- Words.push_back(getWord(Start, End));
- return Words.size();
+ if (!Hint.empty())
+ errs() << Hint << "\n";
+ }
}
-static bool getNumber(const StringRef &S, uint64_t &N) {
- N = 0;
- for (StringRef::iterator I = S.begin(), E = S.end(); I != E; ++I)
- if (*I >= '0' && *I <= '9')
- N = N * 10 + (*I - '0');
- else
- return false;
+static void mergeInstrProfile(const cl::list<std::string> &Inputs,
+ StringRef OutputFilename) {
+ if (OutputFilename.compare("-") == 0)
+ exitWithError("Cannot write indexed profdata format to stdout.");
- return true;
+ std::error_code EC;
+ raw_fd_ostream Output(OutputFilename.data(), EC, sys::fs::F_None);
+ if (EC)
+ exitWithErrorCode(EC, OutputFilename);
+
+ InstrProfWriter Writer;
+ std::set<std::error_code> WriterErrorCodes;
+ for (const auto &Filename : Inputs) {
+ auto ReaderOrErr = InstrProfReader::create(Filename);
+ if (std::error_code ec = ReaderOrErr.getError())
+ exitWithErrorCode(ec, Filename);
+
+ auto Reader = std::move(ReaderOrErr.get());
+ for (auto &I : *Reader) {
+ if (std::error_code EC = Writer.addRecord(std::move(I))) {
+ // Only show hint the first time an error occurs.
+ bool firstTime = WriterErrorCodes.insert(EC).second;
+ handleMergeWriterError(EC, Filename, I.Name, firstTime);
+ }
+ }
+ if (Reader->hasError())
+ exitWithErrorCode(Reader->getError(), Filename);
+ }
+ Writer.write(Output);
}
-static void exitWithError(const std::string &Message,
- const std::string &Filename, int64_t Line = -1) {
- errs() << "error: " << Filename;
- if (Line >= 0)
- errs() << ":" << Line;
- errs() << ": " << Message << "\n";
- ::exit(1);
+static void mergeSampleProfile(const cl::list<std::string> &Inputs,
+ StringRef OutputFilename,
+ sampleprof::SampleProfileFormat OutputFormat) {
+ using namespace sampleprof;
+ auto WriterOrErr = SampleProfileWriter::create(OutputFilename, 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;
+ for (const auto &Filename : Inputs) {
+ auto ReaderOrErr =
+ SampleProfileReader::create(Filename, getGlobalContext());
+ if (std::error_code EC = ReaderOrErr.getError())
+ exitWithErrorCode(EC, 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, 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;
+ ProfileMap[FName].merge(Samples);
+ }
+ }
+ Writer->write(ProfileMap);
}
-//===----------------------------------------------------------------------===//
-int main(int argc, 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.
+static int merge_main(int argc, const char *argv[]) {
+ cl::list<std::string> Inputs(cl::Positional, cl::Required, cl::OneOrMore,
+ cl::desc("<filenames...>"));
+
+ 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<sampleprof::SampleProfileFormat> OutputFormat(
+ cl::desc("Format of output profile (only meaningful with --sample)"),
+ cl::init(sampleprof::SPF_Binary),
+ cl::values(clEnumValN(sampleprof::SPF_Binary, "binary",
+ "Binary encoding (default)"),
+ clEnumValN(sampleprof::SPF_Text, "text", "Text encoding"),
+ clEnumValN(sampleprof::SPF_GCC, "gcc", "GCC encoding"),
+ clEnumValEnd));
cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
- std::unique_ptr<MemoryBuffer> File1;
- std::unique_ptr<MemoryBuffer> File2;
- if (error_code ec = MemoryBuffer::getFile(Filename1, File1))
- exitWithError(ec.message(), Filename1);
- if (error_code ec = MemoryBuffer::getFile(Filename2, File2))
- exitWithError(ec.message(), Filename2);
+ if (ProfileKind == instr)
+ mergeInstrProfile(Inputs, OutputFilename);
+ else
+ mergeSampleProfile(Inputs, OutputFilename, OutputFormat);
+
+ return 0;
+}
+
+static int showInstrProfile(std::string Filename, bool ShowCounts,
+ bool ShowIndirectCallTargets, bool ShowAllFunctions,
+ std::string ShowFunction, raw_fd_ostream &OS) {
+ auto ReaderOrErr = InstrProfReader::create(Filename);
+ if (std::error_code EC = ReaderOrErr.getError())
+ exitWithErrorCode(EC, Filename);
+
+ auto Reader = std::move(ReaderOrErr.get());
+ uint64_t MaxFunctionCount = 0, MaxBlockCount = 0;
+ size_t ShownFunctions = 0, TotalFunctions = 0;
+ for (const auto &Func : *Reader) {
+ bool Show =
+ ShowAllFunctions || (!ShowFunction.empty() &&
+ Func.Name.find(ShowFunction) != Func.Name.npos);
+
+ ++TotalFunctions;
+ assert(Func.Counts.size() > 0 && "function missing entry counter");
+ if (Func.Counts[0] > MaxFunctionCount)
+ MaxFunctionCount = Func.Counts[0];
+
+ 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"
+ << " Function count: " << Func.Counts[0] << "\n";
+ if (ShowIndirectCallTargets)
+ OS << " Indirect Call Site Count: "
+ << Func.getNumValueSites(IPVK_IndirectCallTarget) << "\n";
+ }
+
+ if (Show && ShowCounts)
+ OS << " Block counts: [";
+ for (size_t I = 1, E = Func.Counts.size(); I < E; ++I) {
+ if (Func.Counts[I] > MaxBlockCount)
+ MaxBlockCount = Func.Counts[I];
+ if (Show && ShowCounts)
+ OS << (I == 1 ? "" : ", ") << Func.Counts[I];
+ }
+ if (Show && ShowCounts)
+ OS << "]\n";
+
+ if (Show && ShowIndirectCallTargets) {
+ uint32_t NS = Func.getNumValueSites(IPVK_IndirectCallTarget);
+ OS << " Indirect Target Results: \n";
+ 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);
+ for (uint32_t V = 0; V < NV; V++) {
+ OS << "\t[ " << I << ", ";
+ OS << (const char *)VD[V].Value << ", " << VD[V].Count << " ]\n";
+ }
+ }
+ }
+ }
+ if (Reader->hasError())
+ exitWithErrorCode(Reader->getError(), Filename);
+
+ if (ShowAllFunctions || !ShowFunction.empty())
+ OS << "Functions shown: " << ShownFunctions << "\n";
+ OS << "Total functions: " << TotalFunctions << "\n";
+ OS << "Maximum function count: " << MaxFunctionCount << "\n";
+ OS << "Maximum internal block count: " << MaxBlockCount << "\n";
+ return 0;
+}
+
+static int showSampleProfile(std::string Filename, bool ShowCounts,
+ bool ShowAllFunctions, std::string ShowFunction,
+ raw_fd_ostream &OS) {
+ using namespace sampleprof;
+ auto ReaderOrErr = SampleProfileReader::create(Filename, getGlobalContext());
+ 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> ShowIndirectCallTargets(
+ "ic-targets", cl::init(false),
+ cl::desc("Show indirect call site target values for shown functions"));
+ 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::string ErrorInfo;
- raw_fd_ostream Output(OutputFilename.data(), ErrorInfo, sys::fs::F_Text);
- if (!ErrorInfo.empty())
- exitWithError(ErrorInfo, OutputFilename);
-
- const char *Start1 = File1->getBufferStart();
- const char *Start2 = File2->getBufferStart();
- const char *End1 = File1->getBufferEnd();
- const char *End2 = File2->getBufferEnd();
- const char *P1 = Start1;
- const char *P2 = Start2;
-
- StringRef Line1, Line2;
- int64_t Num = 0;
- while (readLine(P1, End1, Line1)) {
- ++Num;
- if (!readLine(P2, End2, Line2))
- exitWithError("truncated file", Filename2, Num);
-
- std::vector<StringRef> Words1, Words2;
- if (splitWords(Line1, Words1) != splitWords(Line2, Words2))
- exitWithError("data mismatch", Filename2, Num);
-
- if (Words1.size() > 2)
- exitWithError("invalid data", Filename1, Num);
-
- if (Words1.empty()) {
- Output << "\n";
- continue;
- }
+ 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";
+
+ if (ProfileKind == instr)
+ return showInstrProfile(Filename, ShowCounts, ShowIndirectCallTargets,
+ ShowAllFunctions, ShowFunction, OS);
+ else
+ return showSampleProfile(Filename, ShowCounts, ShowAllFunctions,
+ ShowFunction, OS);
+}
- if (Words1.size() == 2) {
- if (Words1[0] != Words2[0])
- exitWithError("function name mismatch", Filename2, Num);
+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.
- uint64_t N1, N2;
- if (!getNumber(Words1[1], N1))
- exitWithError("bad function count", Filename1, Num);
- if (!getNumber(Words2[1], N2))
- exitWithError("bad function count", Filename2, Num);
+ StringRef ProgName(sys::path::filename(argv[0]));
+ if (argc > 1) {
+ int (*func)(int, const char *[]) = nullptr;
- if (N1 != N2)
- exitWithError("function count mismatch", Filename2, Num);
+ if (strcmp(argv[1], "merge") == 0)
+ func = merge_main;
+ else if (strcmp(argv[1], "show") == 0)
+ func = show_main;
- Output << Line1 << "\n";
- continue;
+ if (func) {
+ std::string Invocation(ProgName.str() + " " + argv[1]);
+ argv[1] = Invocation.c_str();
+ return func(argc - 1, argv + 1);
}
- uint64_t N1, N2;
- if (!getNumber(Words1[0], N1))
- exitWithError("invalid counter", Filename1, Num);
- if (!getNumber(Words2[0], N2))
- exitWithError("invalid counter", Filename2, Num);
+ if (strcmp(argv[1], "-h") == 0 ||
+ strcmp(argv[1], "-help") == 0 ||
+ strcmp(argv[1], "--help") == 0) {
- uint64_t Sum = N1 + N2;
- if (Sum < N1)
- exitWithError("counter overflow", Filename2, Num);
-
- Output << N1 + N2 << "\n";
+ 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 (readLine(P2, End2, Line2))
- exitWithError("truncated file", Filename1, Num + 1);
- 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;
}