tools/llvm-profdata/llvm-profdata.cpp

   1 //===- llvm-profdata.cpp - LLVM profile data tool -------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // llvm-profdata merges .profdata files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/ADT/StringRef.h"
  15 #include "llvm/IR/LLVMContext.h"
  16 #include "llvm/ProfileData/InstrProfReader.h"
  17 #include "llvm/ProfileData/InstrProfWriter.h"
  18 #include "llvm/ProfileData/SampleProfReader.h"
  19 #include "llvm/ProfileData/SampleProfWriter.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Support/FileSystem.h"
  22 #include "llvm/Support/Format.h"
  23 #include "llvm/Support/ManagedStatic.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/Path.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/Support/Signals.h"
  28 #include "llvm/Support/raw_ostream.h"
  29
  30 #include <set>
  31
  32 using namespace llvm;
  33
  34 static void exitWithError(const Twine &Message,
  35                           StringRef Whence = "",
  36                           StringRef Hint = "") {
  37   errs() << "error: ";
  38   if (!Whence.empty())
  39     errs() << Whence << ": ";
  40   errs() << Message << "\n";
  41   if (!Hint.empty())
  42     errs() << Hint << "\n";
  43   ::exit(1);
  44 }
  45
  46 static void exitWithErrorCode(const std::error_code &Error,
  47                               StringRef Whence = "") {
  48   if (Error.category() == instrprof_category()) {
  49     instrprof_error instrError = static_cast<instrprof_error>(Error.value());
  50     if (instrError == instrprof_error::unrecognized_format) {
  51       // Hint for common error of forgetting -sample for sample profiles.
  52       exitWithError(Error.message(), Whence,
  53                     "Perhaps you forgot to use the -sample option?");
  54     }
  55   }
  56   exitWithError(Error.message(), Whence);
  57 }
  58
  59 namespace {
  60     enum ProfileKinds { instr, sample };
  61 }
  62
  63 static void handleMergeWriterError(std::error_code &Error,
  64                                    StringRef WhenceFile = "",
  65                                    StringRef WhenceFunction = "",
  66                                    bool ShowHint = true)
  67 {
  68   if (!WhenceFile.empty())
  69     errs() << WhenceFile << ": ";
  70   if (!WhenceFunction.empty())
  71     errs() << WhenceFunction << ": ";
  72   errs() << Error.message() << "\n";
  73
  74   if (ShowHint) {
  75     StringRef Hint = "";
  76     if (Error.category() == instrprof_category()) {
  77       instrprof_error instrError = static_cast<instrprof_error>(Error.value());
  78       if (instrError == instrprof_error::count_mismatch) {
  79         Hint = "Make sure that all profile data to be merged is generated " \
  80                "from the same binary.";
  81       }
  82     }
  83
  84     if (!Hint.empty())
  85       errs() << Hint << "\n";
  86   }
  87 }
  88
  89 static void mergeInstrProfile(const cl::list<std::string> &Inputs,
  90                               StringRef OutputFilename) {
  91   if (OutputFilename.compare("-") == 0)
  92     exitWithError("Cannot write indexed profdata format to stdout.");
  93
  94   std::error_code EC;
  95   raw_fd_ostream Output(OutputFilename.data(), EC, sys::fs::F_None);
  96   if (EC)
  97     exitWithErrorCode(EC, OutputFilename);
  98
  99   InstrProfWriter Writer;
 100   std::set<std::error_code> WriterErrorCodes;
 101   for (const auto &Filename : Inputs) {
 102     auto ReaderOrErr = InstrProfReader::create(Filename);
 103     if (std::error_code ec = ReaderOrErr.getError())
 104       exitWithErrorCode(ec, Filename);
 105
 106     auto Reader = std::move(ReaderOrErr.get());
 107     for (auto &I : *Reader) {
 108       if (std::error_code EC = Writer.addRecord(std::move(I))) {
 109         // Only show hint the first time an error occurs.
 110         bool firstTime = WriterErrorCodes.insert(EC).second;
 111         handleMergeWriterError(EC, Filename, I.Name, firstTime);
 112       }
 113     }
 114     if (Reader->hasError())
 115       exitWithErrorCode(Reader->getError(), Filename);
 116   }
 117   Writer.write(Output);
 118 }
 119
 120 static void mergeSampleProfile(const cl::list<std::string> &Inputs,
 121                                StringRef OutputFilename,
 122                                sampleprof::SampleProfileFormat OutputFormat) {
 123   using namespace sampleprof;
 124   auto WriterOrErr = SampleProfileWriter::create(OutputFilename, OutputFormat);
 125   if (std::error_code EC = WriterOrErr.getError())
 126     exitWithErrorCode(EC, OutputFilename);
 127
 128   auto Writer = std::move(WriterOrErr.get());
 129   StringMap<FunctionSamples> ProfileMap;
 130   SmallVector<std::unique_ptr<sampleprof::SampleProfileReader>, 5> Readers;
 131   for (const auto &Filename : Inputs) {
 132     auto ReaderOrErr =
 133         SampleProfileReader::create(Filename, getGlobalContext());
 134     if (std::error_code EC = ReaderOrErr.getError())
 135       exitWithErrorCode(EC, Filename);
 136
 137     // We need to keep the readers around until after all the files are
 138     // read so that we do not lose the function names stored in each
 139     // reader's memory. The function names are needed to write out the
 140     // merged profile map.
 141     Readers.push_back(std::move(ReaderOrErr.get()));
 142     const auto Reader = Readers.back().get();
 143     if (std::error_code EC = Reader->read())
 144       exitWithErrorCode(EC, Filename);
 145
 146     StringMap<FunctionSamples> &Profiles = Reader->getProfiles();
 147     for (StringMap<FunctionSamples>::iterator I = Profiles.begin(),
 148                                               E = Profiles.end();
 149          I != E; ++I) {
 150       StringRef FName = I->first();
 151       FunctionSamples &Samples = I->second;
 152       ProfileMap[FName].merge(Samples);
 153     }
 154   }
 155   Writer->write(ProfileMap);
 156 }
 157
 158 static int merge_main(int argc, const char *argv[]) {
 159   cl::list<std::string> Inputs(cl::Positional, cl::Required, cl::OneOrMore,
 160                                cl::desc("<filenames...>"));
 161
 162   cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
 163                                       cl::init("-"), cl::Required,
 164                                       cl::desc("Output file"));
 165   cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
 166                             cl::aliasopt(OutputFilename));
 167   cl::opt<ProfileKinds> ProfileKind(
 168       cl::desc("Profile kind:"), cl::init(instr),
 169       cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
 170                  clEnumVal(sample, "Sample profile"), clEnumValEnd));
 171
 172   cl::opt<sampleprof::SampleProfileFormat> OutputFormat(
 173       cl::desc("Format of output profile (only meaningful with --sample)"),
 174       cl::init(sampleprof::SPF_Binary),
 175       cl::values(clEnumValN(sampleprof::SPF_Binary, "binary",
 176                             "Binary encoding (default)"),
 177                  clEnumValN(sampleprof::SPF_Text, "text", "Text encoding"),
 178                  clEnumValN(sampleprof::SPF_GCC, "gcc", "GCC encoding"),
 179                  clEnumValEnd));
 180
 181   cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
 182
 183   if (ProfileKind == instr)
 184     mergeInstrProfile(Inputs, OutputFilename);
 185   else
 186     mergeSampleProfile(Inputs, OutputFilename, OutputFormat);
 187
 188   return 0;
 189 }
 190
 191 static int showInstrProfile(std::string Filename, bool ShowCounts,
 192                             bool ShowIndirectCallTargets, bool ShowAllFunctions,
 193                             std::string ShowFunction, raw_fd_ostream &OS) {
 194   auto ReaderOrErr = InstrProfReader::create(Filename);
 195   if (std::error_code EC = ReaderOrErr.getError())
 196     exitWithErrorCode(EC, Filename);
 197
 198   auto Reader = std::move(ReaderOrErr.get());
 199   uint64_t MaxFunctionCount = 0, MaxBlockCount = 0;
 200   size_t ShownFunctions = 0, TotalFunctions = 0;
 201   for (const auto &Func : *Reader) {
 202     bool Show =
 203         ShowAllFunctions || (!ShowFunction.empty() &&
 204                              Func.Name.find(ShowFunction) != Func.Name.npos);
 205
 206     ++TotalFunctions;
 207     assert(Func.Counts.size() > 0 && "function missing entry counter");
 208     if (Func.Counts[0] > MaxFunctionCount)
 209       MaxFunctionCount = Func.Counts[0];
 210
 211     if (Show) {
 212       if (!ShownFunctions)
 213         OS << "Counters:\n";
 214       ++ShownFunctions;
 215
 216       OS << "  " << Func.Name << ":\n"
 217          << "    Hash: " << format("0x%016" PRIx64, Func.Hash) << "\n"
 218          << "    Counters: " << Func.Counts.size() << "\n"
 219          << "    Function count: " << Func.Counts[0] << "\n";
 220       if (ShowIndirectCallTargets)
 221         OS << "    Indirect Call Site Count: "
 222            << Func.getNumValueSites(IPVK_IndirectCallTarget) << "\n";
 223     }
 224
 225     if (Show && ShowCounts)
 226       OS << "    Block counts: [";
 227     for (size_t I = 1, E = Func.Counts.size(); I < E; ++I) {
 228       if (Func.Counts[I] > MaxBlockCount)
 229         MaxBlockCount = Func.Counts[I];
 230       if (Show && ShowCounts)
 231         OS << (I == 1 ? "" : ", ") << Func.Counts[I];
 232     }
 233     if (Show && ShowCounts)
 234       OS << "]\n";
 235
 236     if (Show && ShowIndirectCallTargets) {
 237       uint32_t NS = Func.getNumValueSites(IPVK_IndirectCallTarget);
 238       OS << "    Indirect Target Results: \n";
 239       for (size_t I = 0; I < NS; ++I) {
 240         uint32_t NV = Func.getNumValueDataForSite(IPVK_IndirectCallTarget, I);
 241         std::unique_ptr<InstrProfValueData[]> VD =
 242             Func.getValueForSite(IPVK_IndirectCallTarget, I);
 243         for (uint32_t V = 0; V < NV; V++) {
 244           OS << "\t[ " << I << ", ";
 245           OS << (const char *)VD[V].Value << ", " << VD[V].Count << " ]\n";
 246         }
 247       }
 248     }
 249   }
 250   if (Reader->hasError())
 251     exitWithErrorCode(Reader->getError(), Filename);
 252
 253   if (ShowAllFunctions || !ShowFunction.empty())
 254     OS << "Functions shown: " << ShownFunctions << "\n";
 255   OS << "Total functions: " << TotalFunctions << "\n";
 256   OS << "Maximum function count: " << MaxFunctionCount << "\n";
 257   OS << "Maximum internal block count: " << MaxBlockCount << "\n";
 258   return 0;
 259 }
 260
 261 static int showSampleProfile(std::string Filename, bool ShowCounts,
 262                              bool ShowAllFunctions, std::string ShowFunction,
 263                              raw_fd_ostream &OS) {
 264   using namespace sampleprof;
 265   auto ReaderOrErr = SampleProfileReader::create(Filename, getGlobalContext());
 266   if (std::error_code EC = ReaderOrErr.getError())
 267     exitWithErrorCode(EC, Filename);
 268
 269   auto Reader = std::move(ReaderOrErr.get());
 270   if (std::error_code EC = Reader->read())
 271     exitWithErrorCode(EC, Filename);
 272
 273   if (ShowAllFunctions || ShowFunction.empty())
 274     Reader->dump(OS);
 275   else
 276     Reader->dumpFunctionProfile(ShowFunction, OS);
 277
 278   return 0;
 279 }
 280
 281 static int show_main(int argc, const char *argv[]) {
 282   cl::opt<std::string> Filename(cl::Positional, cl::Required,
 283                                 cl::desc("<profdata-file>"));
 284
 285   cl::opt<bool> ShowCounts("counts", cl::init(false),
 286                            cl::desc("Show counter values for shown functions"));
 287   cl::opt<bool> ShowIndirectCallTargets(
 288       "ic-targets", cl::init(false),
 289       cl::desc("Show indirect call site target values for shown functions"));
 290   cl::opt<bool> ShowAllFunctions("all-functions", cl::init(false),
 291                                  cl::desc("Details for every function"));
 292   cl::opt<std::string> ShowFunction("function",
 293                                     cl::desc("Details for matching functions"));
 294
 295   cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
 296                                       cl::init("-"), cl::desc("Output file"));
 297   cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
 298                             cl::aliasopt(OutputFilename));
 299   cl::opt<ProfileKinds> ProfileKind(
 300       cl::desc("Profile kind:"), cl::init(instr),
 301       cl::values(clEnumVal(instr, "Instrumentation profile (default)"),
 302                  clEnumVal(sample, "Sample profile"), clEnumValEnd));
 303
 304   cl::ParseCommandLineOptions(argc, argv, "LLVM profile data summary\n");
 305
 306   if (OutputFilename.empty())
 307     OutputFilename = "-";
 308
 309   std::error_code EC;
 310   raw_fd_ostream OS(OutputFilename.data(), EC, sys::fs::F_Text);
 311   if (EC)
 312       exitWithErrorCode(EC, OutputFilename);
 313
 314   if (ShowAllFunctions && !ShowFunction.empty())
 315     errs() << "warning: -function argument ignored: showing all functions\n";
 316
 317   if (ProfileKind == instr)
 318     return showInstrProfile(Filename, ShowCounts, ShowIndirectCallTargets,
 319                             ShowAllFunctions, ShowFunction, OS);
 320   else
 321     return showSampleProfile(Filename, ShowCounts, ShowAllFunctions,
 322                              ShowFunction, OS);
 323 }
 324
 325 int main(int argc, const char *argv[]) {
 326   // Print a stack trace if we signal out.
 327   sys::PrintStackTraceOnErrorSignal();
 328   PrettyStackTraceProgram X(argc, argv);
 329   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
 330
 331   StringRef ProgName(sys::path::filename(argv[0]));
 332   if (argc > 1) {
 333     int (*func)(int, const char *[]) = nullptr;
 334
 335     if (strcmp(argv[1], "merge") == 0)
 336       func = merge_main;
 337     else if (strcmp(argv[1], "show") == 0)
 338       func = show_main;
 339
 340     if (func) {
 341       std::string Invocation(ProgName.str() + " " + argv[1]);
 342       argv[1] = Invocation.c_str();
 343       return func(argc - 1, argv + 1);
 344     }
 345
 346     if (strcmp(argv[1], "-h") == 0 ||
 347         strcmp(argv[1], "-help") == 0 ||
 348         strcmp(argv[1], "--help") == 0) {
 349
 350       errs() << "OVERVIEW: LLVM profile data tools\n\n"
 351              << "USAGE: " << ProgName << " <command> [args...]\n"
 352              << "USAGE: " << ProgName << " <command> -help\n\n"
 353              << "Available commands: merge, show\n";
 354       return 0;
 355     }
 356   }
 357
 358   if (argc < 2)
 359     errs() << ProgName << ": No command specified!\n";
 360   else
 361     errs() << ProgName << ": Unknown command!\n";
 362
 363   errs() << "USAGE: " << ProgName << " <merge|show> [args...]\n";
 364   return 1;
 365 }