contrib/llvm/tools/llvm-xray/xray-account.cc

   1 //===- xray-account.h - XRay Function Call Accounting ---------------------===//
   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 // This file implements basic function call accounting from an XRay trace.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include <algorithm>
  15 #include <cassert>
  16 #include <numeric>
  17 #include <system_error>
  18 #include <utility>
  19
  20 #include "xray-account.h"
  21 #include "xray-registry.h"
  22 #include "llvm/Support/ErrorHandling.h"
  23 #include "llvm/Support/FormatVariadic.h"
  24 #include "llvm/XRay/InstrumentationMap.h"
  25 #include "llvm/XRay/Trace.h"
  26
  27 using namespace llvm;
  28 using namespace llvm::xray;
  29
  30 static cl::SubCommand Account("account", "Function call accounting");
  31 static cl::opt<std::string> AccountInput(cl::Positional,
  32                                          cl::desc("<xray log file>"),
  33                                          cl::Required, cl::sub(Account));
  34 static cl::opt<bool>
  35     AccountKeepGoing("keep-going", cl::desc("Keep going on errors encountered"),
  36                      cl::sub(Account), cl::init(false));
  37 static cl::alias AccountKeepGoing2("k", cl::aliasopt(AccountKeepGoing),
  38                                    cl::desc("Alias for -keep_going"),
  39                                    cl::sub(Account));
  40 static cl::opt<bool> AccountDeduceSiblingCalls(
  41     "deduce-sibling-calls",
  42     cl::desc("Deduce sibling calls when unrolling function call stacks"),
  43     cl::sub(Account), cl::init(false));
  44 static cl::alias
  45     AccountDeduceSiblingCalls2("d", cl::aliasopt(AccountDeduceSiblingCalls),
  46                                cl::desc("Alias for -deduce_sibling_calls"),
  47                                cl::sub(Account));
  48 static cl::opt<std::string>
  49     AccountOutput("output", cl::value_desc("output file"), cl::init("-"),
  50                   cl::desc("output file; use '-' for stdout"),
  51                   cl::sub(Account));
  52 static cl::alias AccountOutput2("o", cl::aliasopt(AccountOutput),
  53                                 cl::desc("Alias for -output"),
  54                                 cl::sub(Account));
  55 enum class AccountOutputFormats { TEXT, CSV };
  56 static cl::opt<AccountOutputFormats>
  57     AccountOutputFormat("format", cl::desc("output format"),
  58                         cl::values(clEnumValN(AccountOutputFormats::TEXT,
  59                                               "text", "report stats in text"),
  60                                    clEnumValN(AccountOutputFormats::CSV, "csv",
  61                                               "report stats in csv")),
  62                         cl::sub(Account));
  63 static cl::alias AccountOutputFormat2("f", cl::desc("Alias of -format"),
  64                                       cl::aliasopt(AccountOutputFormat),
  65                                       cl::sub(Account));
  66
  67 enum class SortField {
  68   FUNCID,
  69   COUNT,
  70   MIN,
  71   MED,
  72   PCT90,
  73   PCT99,
  74   MAX,
  75   SUM,
  76   FUNC,
  77 };
  78
  79 static cl::opt<SortField> AccountSortOutput(
  80     "sort", cl::desc("sort output by this field"), cl::value_desc("field"),
  81     cl::sub(Account), cl::init(SortField::FUNCID),
  82     cl::values(clEnumValN(SortField::FUNCID, "funcid", "function id"),
  83                clEnumValN(SortField::COUNT, "count", "funciton call counts"),
  84                clEnumValN(SortField::MIN, "min", "minimum function durations"),
  85                clEnumValN(SortField::MED, "med", "median function durations"),
  86                clEnumValN(SortField::PCT90, "90p", "90th percentile durations"),
  87                clEnumValN(SortField::PCT99, "99p", "99th percentile durations"),
  88                clEnumValN(SortField::MAX, "max", "maximum function durations"),
  89                clEnumValN(SortField::SUM, "sum", "sum of call durations"),
  90                clEnumValN(SortField::FUNC, "func", "function names")));
  91 static cl::alias AccountSortOutput2("s", cl::aliasopt(AccountSortOutput),
  92                                     cl::desc("Alias for -sort"),
  93                                     cl::sub(Account));
  94
  95 enum class SortDirection {
  96   ASCENDING,
  97   DESCENDING,
  98 };
  99 static cl::opt<SortDirection> AccountSortOrder(
 100     "sortorder", cl::desc("sort ordering"), cl::init(SortDirection::ASCENDING),
 101     cl::values(clEnumValN(SortDirection::ASCENDING, "asc", "ascending"),
 102                clEnumValN(SortDirection::DESCENDING, "dsc", "descending")),
 103     cl::sub(Account));
 104 static cl::alias AccountSortOrder2("r", cl::aliasopt(AccountSortOrder),
 105                                    cl::desc("Alias for -sortorder"),
 106                                    cl::sub(Account));
 107
 108 static cl::opt<int> AccountTop("top", cl::desc("only show the top N results"),
 109                                cl::value_desc("N"), cl::sub(Account),
 110                                cl::init(-1));
 111 static cl::alias AccountTop2("p", cl::desc("Alias for -top"),
 112                              cl::aliasopt(AccountTop), cl::sub(Account));
 113
 114 static cl::opt<std::string>
 115     AccountInstrMap("instr_map",
 116                     cl::desc("binary with the instrumentation map, or "
 117                              "a separate instrumentation map"),
 118                     cl::value_desc("binary with xray_instr_map"),
 119                     cl::sub(Account), cl::init(""));
 120 static cl::alias AccountInstrMap2("m", cl::aliasopt(AccountInstrMap),
 121                                   cl::desc("Alias for -instr_map"),
 122                                   cl::sub(Account));
 123
 124 namespace {
 125
 126 template <class T, class U> void setMinMax(std::pair<T, T> &MM, U &&V) {
 127   if (MM.first == 0 || MM.second == 0)
 128     MM = std::make_pair(std::forward<U>(V), std::forward<U>(V));
 129   else
 130     MM = std::make_pair(std::min(MM.first, V), std::max(MM.second, V));
 131 }
 132
 133 template <class T> T diff(T L, T R) { return std::max(L, R) - std::min(L, R); }
 134
 135 } // namespace
 136
 137 bool LatencyAccountant::accountRecord(const XRayRecord &Record) {
 138   setMinMax(PerThreadMinMaxTSC[Record.TId], Record.TSC);
 139   setMinMax(PerCPUMinMaxTSC[Record.CPU], Record.TSC);
 140
 141   if (CurrentMaxTSC == 0)
 142     CurrentMaxTSC = Record.TSC;
 143
 144   if (Record.TSC < CurrentMaxTSC)
 145     return false;
 146
 147   auto &ThreadStack = PerThreadFunctionStack[Record.TId];
 148   switch (Record.Type) {
 149   case RecordTypes::ENTER:
 150   case RecordTypes::ENTER_ARG: {
 151     ThreadStack.emplace_back(Record.FuncId, Record.TSC);
 152     break;
 153   }
 154   case RecordTypes::EXIT:
 155   case RecordTypes::TAIL_EXIT: {
 156     if (ThreadStack.empty())
 157       return false;
 158
 159     if (ThreadStack.back().first == Record.FuncId) {
 160       const auto &Top = ThreadStack.back();
 161       recordLatency(Top.first, diff(Top.second, Record.TSC));
 162       ThreadStack.pop_back();
 163       break;
 164     }
 165
 166     if (!DeduceSiblingCalls)
 167       return false;
 168
 169     // Look for the parent up the stack.
 170     auto Parent =
 171         std::find_if(ThreadStack.rbegin(), ThreadStack.rend(),
 172                      [&](const std::pair<const int32_t, uint64_t> &E) {
 173                        return E.first == Record.FuncId;
 174                      });
 175     if (Parent == ThreadStack.rend())
 176       return false;
 177
 178     // Account time for this apparently sibling call exit up the stack.
 179     // Considering the following case:
 180     //
 181     //   f()
 182     //    g()
 183     //      h()
 184     //
 185     // We might only ever see the following entries:
 186     //
 187     //   -> f()
 188     //   -> g()
 189     //   -> h()
 190     //   <- h()
 191     //   <- f()
 192     //
 193     // Now we don't see the exit to g() because some older version of the XRay
 194     // runtime wasn't instrumenting tail exits. If we don't deduce tail calls,
 195     // we may potentially never account time for g() -- and this code would have
 196     // already bailed out, because `<- f()` doesn't match the current "top" of
 197     // stack where we're waiting for the exit to `g()` instead. This is not
 198     // ideal and brittle -- so instead we provide a potentially inaccurate
 199     // accounting of g() instead, computing it from the exit of f().
 200     //
 201     // While it might be better that we account the time between `-> g()` and
 202     // `-> h()` as the proper accounting of time for g() here, this introduces
 203     // complexity to do correctly (need to backtrack, etc.).
 204     //
 205     // FIXME: Potentially implement the more complex deduction algorithm?
 206     auto I = std::next(Parent).base();
 207     for (auto &E : make_range(I, ThreadStack.end())) {
 208       recordLatency(E.first, diff(E.second, Record.TSC));
 209     }
 210     ThreadStack.erase(I, ThreadStack.end());
 211     break;
 212   }
 213   }
 214
 215   return true;
 216 }
 217
 218 namespace {
 219
 220 // We consolidate the data into a struct which we can output in various forms.
 221 struct ResultRow {
 222   uint64_t Count;
 223   double Min;
 224   double Median;
 225   double Pct90;
 226   double Pct99;
 227   double Max;
 228   double Sum;
 229   std::string DebugInfo;
 230   std::string Function;
 231 };
 232
 233 ResultRow getStats(std::vector<uint64_t> &Timings) {
 234   assert(!Timings.empty());
 235   ResultRow R;
 236   R.Sum = std::accumulate(Timings.begin(), Timings.end(), 0.0);
 237   auto MinMax = std::minmax_element(Timings.begin(), Timings.end());
 238   R.Min = *MinMax.first;
 239   R.Max = *MinMax.second;
 240   auto MedianOff = Timings.size() / 2;
 241   std::nth_element(Timings.begin(), Timings.begin() + MedianOff, Timings.end());
 242   R.Median = Timings[MedianOff];
 243   auto Pct90Off = std::floor(Timings.size() * 0.9);
 244   std::nth_element(Timings.begin(), Timings.begin() + Pct90Off, Timings.end());
 245   R.Pct90 = Timings[Pct90Off];
 246   auto Pct99Off = std::floor(Timings.size() * 0.99);
 247   std::nth_element(Timings.begin(), Timings.begin() + Pct90Off, Timings.end());
 248   R.Pct99 = Timings[Pct99Off];
 249   R.Count = Timings.size();
 250   return R;
 251 }
 252
 253 } // namespace
 254
 255 template <class F>
 256 void LatencyAccountant::exportStats(const XRayFileHeader &Header, F Fn) const {
 257   using TupleType = std::tuple<int32_t, uint64_t, ResultRow>;
 258   std::vector<TupleType> Results;
 259   Results.reserve(FunctionLatencies.size());
 260   for (auto FT : FunctionLatencies) {
 261     const auto &FuncId = FT.first;
 262     auto &Timings = FT.second;
 263     Results.emplace_back(FuncId, Timings.size(), getStats(Timings));
 264     auto &Row = std::get<2>(Results.back());
 265     if (Header.CycleFrequency) {
 266       double CycleFrequency = Header.CycleFrequency;
 267       Row.Min /= CycleFrequency;
 268       Row.Median /= CycleFrequency;
 269       Row.Pct90 /= CycleFrequency;
 270       Row.Pct99 /= CycleFrequency;
 271       Row.Max /= CycleFrequency;
 272       Row.Sum /= CycleFrequency;
 273     }
 274
 275     Row.Function = FuncIdHelper.SymbolOrNumber(FuncId);
 276     Row.DebugInfo = FuncIdHelper.FileLineAndColumn(FuncId);
 277   }
 278
 279   // Sort the data according to user-provided flags.
 280   switch (AccountSortOutput) {
 281   case SortField::FUNCID:
 282     std::sort(Results.begin(), Results.end(),
 283               [](const TupleType &L, const TupleType &R) {
 284                 if (AccountSortOrder == SortDirection::ASCENDING)
 285                   return std::get<0>(L) < std::get<0>(R);
 286                 if (AccountSortOrder == SortDirection::DESCENDING)
 287                   return std::get<0>(L) > std::get<0>(R);
 288                 llvm_unreachable("Unknown sort direction");
 289               });
 290     break;
 291   case SortField::COUNT:
 292     std::sort(Results.begin(), Results.end(),
 293               [](const TupleType &L, const TupleType &R) {
 294                 if (AccountSortOrder == SortDirection::ASCENDING)
 295                   return std::get<1>(L) < std::get<1>(R);
 296                 if (AccountSortOrder == SortDirection::DESCENDING)
 297                   return std::get<1>(L) > std::get<1>(R);
 298                 llvm_unreachable("Unknown sort direction");
 299               });
 300     break;
 301   default:
 302     // Here we need to look into the ResultRow for the rest of the data that
 303     // we want to sort by.
 304     std::sort(Results.begin(), Results.end(),
 305               [&](const TupleType &L, const TupleType &R) {
 306                 auto &LR = std::get<2>(L);
 307                 auto &RR = std::get<2>(R);
 308                 switch (AccountSortOutput) {
 309                 case SortField::COUNT:
 310                   if (AccountSortOrder == SortDirection::ASCENDING)
 311                     return LR.Count < RR.Count;
 312                   if (AccountSortOrder == SortDirection::DESCENDING)
 313                     return LR.Count > RR.Count;
 314                   llvm_unreachable("Unknown sort direction");
 315                 case SortField::MIN:
 316                   if (AccountSortOrder == SortDirection::ASCENDING)
 317                     return LR.Min < RR.Min;
 318                   if (AccountSortOrder == SortDirection::DESCENDING)
 319                     return LR.Min > RR.Min;
 320                   llvm_unreachable("Unknown sort direction");
 321                 case SortField::MED:
 322                   if (AccountSortOrder == SortDirection::ASCENDING)
 323                     return LR.Median < RR.Median;
 324                   if (AccountSortOrder == SortDirection::DESCENDING)
 325                     return LR.Median > RR.Median;
 326                   llvm_unreachable("Unknown sort direction");
 327                 case SortField::PCT90:
 328                   if (AccountSortOrder == SortDirection::ASCENDING)
 329                     return LR.Pct90 < RR.Pct90;
 330                   if (AccountSortOrder == SortDirection::DESCENDING)
 331                     return LR.Pct90 > RR.Pct90;
 332                   llvm_unreachable("Unknown sort direction");
 333                 case SortField::PCT99:
 334                   if (AccountSortOrder == SortDirection::ASCENDING)
 335                     return LR.Pct99 < RR.Pct99;
 336                   if (AccountSortOrder == SortDirection::DESCENDING)
 337                     return LR.Pct99 > RR.Pct99;
 338                   llvm_unreachable("Unknown sort direction");
 339                 case SortField::MAX:
 340                   if (AccountSortOrder == SortDirection::ASCENDING)
 341                     return LR.Max < RR.Max;
 342                   if (AccountSortOrder == SortDirection::DESCENDING)
 343                     return LR.Max > RR.Max;
 344                   llvm_unreachable("Unknown sort direction");
 345                 case SortField::SUM:
 346                   if (AccountSortOrder == SortDirection::ASCENDING)
 347                     return LR.Sum < RR.Sum;
 348                   if (AccountSortOrder == SortDirection::DESCENDING)
 349                     return LR.Sum > RR.Sum;
 350                   llvm_unreachable("Unknown sort direction");
 351                 default:
 352                   llvm_unreachable("Unsupported sort order");
 353                 }
 354               });
 355     break;
 356   }
 357
 358   if (AccountTop > 0)
 359     Results.erase(Results.begin() + AccountTop.getValue(), Results.end());
 360
 361   for (const auto &R : Results)
 362     Fn(std::get<0>(R), std::get<1>(R), std::get<2>(R));
 363 }
 364
 365 void LatencyAccountant::exportStatsAsText(raw_ostream &OS,
 366                                           const XRayFileHeader &Header) const {
 367   OS << "Functions with latencies: " << FunctionLatencies.size() << "\n";
 368
 369   // We spend some effort to make the text output more readable, so we do the
 370   // following formatting decisions for each of the fields:
 371   //
 372   //   - funcid: 32-bit, but we can determine the largest number and be
 373   //   between
 374   //     a minimum of 5 characters, up to 9 characters, right aligned.
 375   //   - count:  64-bit, but we can determine the largest number and be
 376   //   between
 377   //     a minimum of 5 characters, up to 9 characters, right aligned.
 378   //   - min, median, 90pct, 99pct, max: double precision, but we want to keep
 379   //     the values in seconds, with microsecond precision (0.000'001), so we
 380   //     have at most 6 significant digits, with the whole number part to be
 381   //     at
 382   //     least 1 character. For readability we'll right-align, with full 9
 383   //     characters each.
 384   //   - debug info, function name: we format this as a concatenation of the
 385   //     debug info and the function name.
 386   //
 387   static constexpr char StatsHeaderFormat[] =
 388       "{0,+9} {1,+10} [{2,+9}, {3,+9}, {4,+9}, {5,+9}, {6,+9}] {7,+9}";
 389   static constexpr char StatsFormat[] =
 390       R"({0,+9} {1,+10} [{2,+9:f6}, {3,+9:f6}, {4,+9:f6}, {5,+9:f6}, {6,+9:f6}] {7,+9:f6})";
 391   OS << llvm::formatv(StatsHeaderFormat, "funcid", "count", "min", "med", "90p",
 392                       "99p", "max", "sum")
 393      << llvm::formatv("  {0,-12}\n", "function");
 394   exportStats(Header, [&](int32_t FuncId, size_t Count, const ResultRow &Row) {
 395     OS << llvm::formatv(StatsFormat, FuncId, Count, Row.Min, Row.Median,
 396                         Row.Pct90, Row.Pct99, Row.Max, Row.Sum)
 397        << "  " << Row.DebugInfo << ": " << Row.Function << "\n";
 398   });
 399 }
 400
 401 void LatencyAccountant::exportStatsAsCSV(raw_ostream &OS,
 402                                          const XRayFileHeader &Header) const {
 403   OS << "funcid,count,min,median,90%ile,99%ile,max,sum,debug,function\n";
 404   exportStats(Header, [&](int32_t FuncId, size_t Count, const ResultRow &Row) {
 405     OS << FuncId << ',' << Count << ',' << Row.Min << ',' << Row.Median << ','
 406        << Row.Pct90 << ',' << Row.Pct99 << ',' << Row.Max << "," << Row.Sum
 407        << ",\"" << Row.DebugInfo << "\",\"" << Row.Function << "\"\n";
 408   });
 409 }
 410
 411 using namespace llvm::xray;
 412
 413 namespace llvm {
 414 template <> struct format_provider<llvm::xray::RecordTypes> {
 415   static void format(const llvm::xray::RecordTypes &T, raw_ostream &Stream,
 416                      StringRef Style) {
 417     switch(T) {
 418       case RecordTypes::ENTER:
 419         Stream << "enter";
 420         break;
 421       case RecordTypes::ENTER_ARG:
 422         Stream << "enter-arg";
 423         break;
 424       case RecordTypes::EXIT:
 425         Stream << "exit";
 426         break;
 427       case RecordTypes::TAIL_EXIT:
 428         Stream << "tail-exit";
 429         break;
 430     }
 431   }
 432 };
 433 } // namespace llvm
 434
 435 static CommandRegistration Unused(&Account, []() -> Error {
 436   InstrumentationMap Map;
 437   if (!AccountInstrMap.empty()) {
 438     auto InstrumentationMapOrError = loadInstrumentationMap(AccountInstrMap);
 439     if (!InstrumentationMapOrError)
 440       return joinErrors(make_error<StringError>(
 441                             Twine("Cannot open instrumentation map '") +
 442                                 AccountInstrMap + "'",
 443                             std::make_error_code(std::errc::invalid_argument)),
 444                         InstrumentationMapOrError.takeError());
 445     Map = std::move(*InstrumentationMapOrError);
 446   }
 447
 448   std::error_code EC;
 449   raw_fd_ostream OS(AccountOutput, EC, sys::fs::OpenFlags::F_Text);
 450   if (EC)
 451     return make_error<StringError>(
 452         Twine("Cannot open file '") + AccountOutput + "' for writing.", EC);
 453
 454   const auto &FunctionAddresses = Map.getFunctionAddresses();
 455   symbolize::LLVMSymbolizer::Options Opts(
 456       symbolize::FunctionNameKind::LinkageName, true, true, false, "");
 457   symbolize::LLVMSymbolizer Symbolizer(Opts);
 458   llvm::xray::FuncIdConversionHelper FuncIdHelper(AccountInstrMap, Symbolizer,
 459                                                   FunctionAddresses);
 460   xray::LatencyAccountant FCA(FuncIdHelper, AccountDeduceSiblingCalls);
 461   auto TraceOrErr = loadTraceFile(AccountInput);
 462   if (!TraceOrErr)
 463     return joinErrors(
 464         make_error<StringError>(
 465             Twine("Failed loading input file '") + AccountInput + "'",
 466             std::make_error_code(std::errc::executable_format_error)),
 467         TraceOrErr.takeError());
 468
 469   auto &T = *TraceOrErr;
 470   for (const auto &Record : T) {
 471     if (FCA.accountRecord(Record))
 472       continue;
 473     errs()
 474         << "Error processing record: "
 475         << llvm::formatv(
 476                R"({{type: {0}; cpu: {1}; record-type: {2}; function-id: {3}; tsc: {4}; thread-id: {5}}})",
 477                Record.RecordType, Record.CPU, Record.Type, Record.FuncId,
 478                Record.TId)
 479         << '\n';
 480     for (const auto &ThreadStack : FCA.getPerThreadFunctionStack()) {
 481       errs() << "Thread ID: " << ThreadStack.first << "\n";
 482       if (ThreadStack.second.empty()) {
 483         errs() << "  (empty stack)\n";
 484         continue;
 485       }
 486       auto Level = ThreadStack.second.size();
 487       for (const auto &Entry : llvm::reverse(ThreadStack.second))
 488         errs() << "  #" << Level-- << "\t"
 489                << FuncIdHelper.SymbolOrNumber(Entry.first) << '\n';
 490     }
 491     if (!AccountKeepGoing)
 492       return make_error<StringError>(
 493           Twine("Failed accounting function calls in file '") + AccountInput +
 494               "'.",
 495           std::make_error_code(std::errc::executable_format_error));
 496   }
 497   switch (AccountOutputFormat) {
 498   case AccountOutputFormats::TEXT:
 499     FCA.exportStatsAsText(OS, T.getFileHeader());
 500     break;
 501   case AccountOutputFormats::CSV:
 502     FCA.exportStatsAsCSV(OS, T.getFileHeader());
 503     break;
 504   }
 505
 506   return Error::success();
 507 });