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/ProfileData/InstrProfReader.h"
  16 #include "llvm/ProfileData/InstrProfWriter.h"
  17 #include "llvm/Support/CommandLine.h"
  18 #include "llvm/Support/Format.h"
  19 #include "llvm/Support/ManagedStatic.h"
  20 #include "llvm/Support/MemoryBuffer.h"
  21 #include "llvm/Support/PrettyStackTrace.h"
  22 #include "llvm/Support/Signals.h"
  23 #include "llvm/Support/raw_ostream.h"
  24
  25 using namespace llvm;
  26
  27 static void exitWithError(const Twine &Message, StringRef Whence = "") {
  28   errs() << "error: ";
  29   if (!Whence.empty())
  30     errs() << Whence << ": ";
  31   errs() << Message << "\n";
  32   ::exit(1);
  33 }
  34
  35 int merge_main(int argc, const char *argv[]) {
  36   cl::list<std::string> Inputs(cl::Positional, cl::Required, cl::OneOrMore,
  37                                cl::desc("<filenames...>"));
  38
  39   cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
  40                                       cl::init("-"),
  41                                       cl::desc("Output file"));
  42   cl::alias OutputFilenameA("o", cl::desc("Alias for --output"), cl::Required,
  43                             cl::aliasopt(OutputFilename));
  44
  45   cl::ParseCommandLineOptions(argc, argv, "LLVM profile data merger\n");
  46
  47   if (OutputFilename.compare("-") == 0)
  48     exitWithError("Cannot write indexed profdata format to stdout.");
  49
  50   std::string ErrorInfo;
  51   raw_fd_ostream Output(OutputFilename.data(), ErrorInfo, sys::fs::F_None);
  52   if (!ErrorInfo.empty())
  53     exitWithError(ErrorInfo, OutputFilename);
  54
  55   InstrProfWriter Writer;
  56   for (const auto &Filename : Inputs) {
  57     std::unique_ptr<InstrProfReader> Reader;
  58     if (error_code ec = InstrProfReader::create(Filename, Reader))
  59       exitWithError(ec.message(), Filename);
  60
  61     for (const auto &I : *Reader)
  62       if (error_code EC = Writer.addFunctionCounts(I.Name, I.Hash, I.Counts))
  63         errs() << Filename << ": " << I.Name << ": " << EC.message() << "\n";
  64     if (Reader->hasError())
  65       exitWithError(Reader->getError().message(), Filename);
  66   }
  67   Writer.write(Output);
  68
  69   return 0;
  70 }
  71
  72 int show_main(int argc, const char *argv[]) {
  73   cl::opt<std::string> Filename(cl::Positional, cl::Required,
  74                                 cl::desc("<profdata-file>"));
  75
  76   cl::opt<bool> ShowCounts("counts", cl::init(false),
  77                            cl::desc("Show counter values for shown functions"));
  78   cl::opt<bool> ShowAllFunctions("all-functions", cl::init(false),
  79                                  cl::desc("Details for every function"));
  80   cl::opt<std::string> ShowFunction("function",
  81                                     cl::desc("Details for matching functions"));
  82
  83   cl::opt<std::string> OutputFilename("output", cl::value_desc("output"),
  84                                       cl::init("-"),
  85                                       cl::desc("Output file"));
  86   cl::alias OutputFilenameA("o", cl::desc("Alias for --output"),
  87                             cl::aliasopt(OutputFilename));
  88
  89   cl::ParseCommandLineOptions(argc, argv, "LLVM profile data summary\n");
  90
  91   std::unique_ptr<InstrProfReader> Reader;
  92   if (error_code EC = InstrProfReader::create(Filename, Reader))
  93     exitWithError(EC.message(), Filename);
  94
  95   if (OutputFilename.empty())
  96     OutputFilename = "-";
  97
  98   std::string ErrorInfo;
  99   raw_fd_ostream OS(OutputFilename.data(), ErrorInfo, sys::fs::F_Text);
 100   if (!ErrorInfo.empty())
 101     exitWithError(ErrorInfo, OutputFilename);
 102
 103   if (ShowAllFunctions && !ShowFunction.empty())
 104     errs() << "warning: -function argument ignored: showing all functions\n";
 105
 106   uint64_t MaxFunctionCount = 0, MaxBlockCount = 0;
 107   size_t ShownFunctions = 0, TotalFunctions = 0;
 108   for (const auto &Func : *Reader) {
 109     bool Show = ShowAllFunctions ||
 110                 (!ShowFunction.empty() &&
 111                  Func.Name.find(ShowFunction) != Func.Name.npos);
 112
 113     ++TotalFunctions;
 114     if (Func.Counts[0] > MaxFunctionCount)
 115       MaxFunctionCount = Func.Counts[0];
 116
 117     if (Show) {
 118       if (!ShownFunctions)
 119         OS << "Counters:\n";
 120       ++ShownFunctions;
 121
 122       OS << "  " << Func.Name << ":\n"
 123          << "    Hash: " << format("0x%016" PRIx64, Func.Hash) << "\n"
 124          << "    Counters: " << Func.Counts.size() << "\n"
 125          << "    Function count: " << Func.Counts[0] << "\n";
 126     }
 127
 128     if (Show && ShowCounts)
 129       OS << "    Block counts: [";
 130     for (size_t I = 1, E = Func.Counts.size(); I < E; ++I) {
 131       if (Func.Counts[I] > MaxBlockCount)
 132         MaxBlockCount = Func.Counts[I];
 133       if (Show && ShowCounts)
 134         OS << (I == 1 ? "" : ", ") << Func.Counts[I];
 135     }
 136     if (Show && ShowCounts)
 137       OS << "]\n";
 138   }
 139   if (Reader->hasError())
 140     exitWithError(Reader->getError().message(), Filename);
 141
 142   if (ShowAllFunctions || !ShowFunction.empty())
 143     OS << "Functions shown: " << ShownFunctions << "\n";
 144   OS << "Total functions: " << TotalFunctions << "\n";
 145   OS << "Maximum function count: " << MaxFunctionCount << "\n";
 146   OS << "Maximum internal block count: " << MaxBlockCount << "\n";
 147   return 0;
 148 }
 149
 150 int main(int argc, const char *argv[]) {
 151   // Print a stack trace if we signal out.
 152   sys::PrintStackTraceOnErrorSignal();
 153   PrettyStackTraceProgram X(argc, argv);
 154   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
 155
 156   StringRef ProgName(sys::path::filename(argv[0]));
 157   if (argc > 1) {
 158     int (*func)(int, const char *[]) = 0;
 159
 160     if (strcmp(argv[1], "merge") == 0)
 161       func = merge_main;
 162     else if (strcmp(argv[1], "show") == 0)
 163       func = show_main;
 164
 165     if (func) {
 166       std::string Invocation(ProgName.str() + " " + argv[1]);
 167       argv[1] = Invocation.c_str();
 168       return func(argc - 1, argv + 1);
 169     }
 170
 171     if (strcmp(argv[1], "-h") == 0 ||
 172         strcmp(argv[1], "-help") == 0 ||
 173         strcmp(argv[1], "--help") == 0) {
 174
 175       errs() << "OVERVIEW: LLVM profile data tools\n\n"
 176              << "USAGE: " << ProgName << " <command> [args...]\n"
 177              << "USAGE: " << ProgName << " <command> -help\n\n"
 178              << "Available commands: merge, show\n";
 179       return 0;
 180     }
 181   }
 182
 183   if (argc < 2)
 184     errs() << ProgName << ": No command specified!\n";
 185   else
 186     errs() << ProgName << ": Unknown command!\n";
 187
 188   errs() << "USAGE: " << ProgName << " <merge|show> [args...]\n";
 189   return 1;
 190 }