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