contrib/llvm/lib/Support/Statistic.cpp

   1 //===-- Statistic.cpp - Easy way to expose stats information --------------===//
   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 the 'Statistic' class, which is designed to be an easy
  11 // way to expose various success metrics from passes.  These statistics are
  12 // printed at the end of a run, when the -stats command line option is enabled
  13 // on the command line.
  14 //
  15 // This is useful for reporting information like the number of instructions
  16 // simplified, optimized or removed by various transformations, like this:
  17 //
  18 // static Statistic NumInstEliminated("GCSE", "Number of instructions killed");
  19 //
  20 // Later, in the code: ++NumInstEliminated;
  21 //
  22 //===----------------------------------------------------------------------===//
  23
  24 #include "llvm/ADT/Statistic.h"
  25 #include "llvm/ADT/StringExtras.h"
  26 #include "llvm/Support/CommandLine.h"
  27 #include "llvm/Support/Compiler.h"
  28 #include "llvm/Support/Debug.h"
  29 #include "llvm/Support/Format.h"
  30 #include "llvm/Support/ManagedStatic.h"
  31 #include "llvm/Support/Mutex.h"
  32 #include "llvm/Support/Timer.h"
  33 #include "llvm/Support/YAMLTraits.h"
  34 #include "llvm/Support/raw_ostream.h"
  35 #include <algorithm>
  36 #include <cstring>
  37 using namespace llvm;
  38
  39 /// -stats - Command line option to cause transformations to emit stats about
  40 /// what they did.
  41 ///
  42 static cl::opt<bool> Stats(
  43     "stats",
  44     cl::desc("Enable statistics output from program (available with Asserts)"),
  45     cl::Hidden);
  46
  47 static cl::opt<bool> StatsAsJSON("stats-json",
  48                                  cl::desc("Display statistics as json data"),
  49                                  cl::Hidden);
  50
  51 static bool Enabled;
  52 static bool PrintOnExit;
  53
  54 namespace {
  55 /// StatisticInfo - This class is used in a ManagedStatic so that it is created
  56 /// on demand (when the first statistic is bumped) and destroyed only when
  57 /// llvm_shutdown is called.  We print statistics from the destructor.
  58 class StatisticInfo {
  59   std::vector<const Statistic*> Stats;
  60   friend void llvm::PrintStatistics();
  61   friend void llvm::PrintStatistics(raw_ostream &OS);
  62   friend void llvm::PrintStatisticsJSON(raw_ostream &OS);
  63
  64   /// Sort statistics by debugtype,name,description.
  65   void sort();
  66 public:
  67   StatisticInfo();
  68   ~StatisticInfo();
  69
  70   void addStatistic(const Statistic *S) {
  71     Stats.push_back(S);
  72   }
  73 };
  74 }
  75
  76 static ManagedStatic<StatisticInfo> StatInfo;
  77 static ManagedStatic<sys::SmartMutex<true> > StatLock;
  78
  79 /// RegisterStatistic - The first time a statistic is bumped, this method is
  80 /// called.
  81 void Statistic::RegisterStatistic() {
  82   // If stats are enabled, inform StatInfo that this statistic should be
  83   // printed.
  84   sys::SmartScopedLock<true> Writer(*StatLock);
  85   if (!Initialized) {
  86     if (Stats || Enabled)
  87       StatInfo->addStatistic(this);
  88
  89     TsanHappensBefore(this);
  90     sys::MemoryFence();
  91     // Remember we have been registered.
  92     TsanIgnoreWritesBegin();
  93     Initialized = true;
  94     TsanIgnoreWritesEnd();
  95   }
  96 }
  97
  98 StatisticInfo::StatisticInfo() {
  99   // Ensure timergroup lists are created first so they are destructed after us.
 100   TimerGroup::ConstructTimerLists();
 101 }
 102
 103 // Print information when destroyed, iff command line option is specified.
 104 StatisticInfo::~StatisticInfo() {
 105   if (::Stats || PrintOnExit)
 106     llvm::PrintStatistics();
 107 }
 108
 109 void llvm::EnableStatistics(bool PrintOnExit) {
 110   Enabled = true;
 111   ::PrintOnExit = PrintOnExit;
 112 }
 113
 114 bool llvm::AreStatisticsEnabled() {
 115   return Enabled || Stats;
 116 }
 117
 118 void StatisticInfo::sort() {
 119   std::stable_sort(Stats.begin(), Stats.end(),
 120                    [](const Statistic *LHS, const Statistic *RHS) {
 121     if (int Cmp = std::strcmp(LHS->getDebugType(), RHS->getDebugType()))
 122       return Cmp < 0;
 123
 124     if (int Cmp = std::strcmp(LHS->getName(), RHS->getName()))
 125       return Cmp < 0;
 126
 127     return std::strcmp(LHS->getDesc(), RHS->getDesc()) < 0;
 128   });
 129 }
 130
 131 void llvm::PrintStatistics(raw_ostream &OS) {
 132   StatisticInfo &Stats = *StatInfo;
 133
 134   // Figure out how long the biggest Value and Name fields are.
 135   unsigned MaxDebugTypeLen = 0, MaxValLen = 0;
 136   for (size_t i = 0, e = Stats.Stats.size(); i != e; ++i) {
 137     MaxValLen = std::max(MaxValLen,
 138                          (unsigned)utostr(Stats.Stats[i]->getValue()).size());
 139     MaxDebugTypeLen = std::max(MaxDebugTypeLen,
 140                          (unsigned)std::strlen(Stats.Stats[i]->getDebugType()));
 141   }
 142
 143   Stats.sort();
 144
 145   // Print out the statistics header...
 146   OS << "===" << std::string(73, '-') << "===\n"
 147      << "                          ... Statistics Collected ...\n"
 148      << "===" << std::string(73, '-') << "===\n\n";
 149
 150   // Print all of the statistics.
 151   for (size_t i = 0, e = Stats.Stats.size(); i != e; ++i)
 152     OS << format("%*u %-*s - %s\n",
 153                  MaxValLen, Stats.Stats[i]->getValue(),
 154                  MaxDebugTypeLen, Stats.Stats[i]->getDebugType(),
 155                  Stats.Stats[i]->getDesc());
 156
 157   OS << '\n';  // Flush the output stream.
 158   OS.flush();
 159 }
 160
 161 void llvm::PrintStatisticsJSON(raw_ostream &OS) {
 162   StatisticInfo &Stats = *StatInfo;
 163
 164   Stats.sort();
 165
 166   // Print all of the statistics.
 167   OS << "{\n";
 168   const char *delim = "";
 169   for (const Statistic *Stat : Stats.Stats) {
 170     OS << delim;
 171     assert(yaml::needsQuotes(Stat->getDebugType()) == yaml::QuotingType::None &&
 172            "Statistic group/type name is simple.");
 173     assert(yaml::needsQuotes(Stat->getName()) == yaml::QuotingType::None &&
 174            "Statistic name is simple");
 175     OS << "\t\"" << Stat->getDebugType() << '.' << Stat->getName() << "\": "
 176        << Stat->getValue();
 177     delim = ",\n";
 178   }
 179   // Print timers.
 180   TimerGroup::printAllJSONValues(OS, delim);
 181
 182   OS << "\n}\n";
 183   OS.flush();
 184 }
 185
 186 void llvm::PrintStatistics() {
 187 #if !defined(NDEBUG) || defined(LLVM_ENABLE_STATS)
 188   StatisticInfo &Stats = *StatInfo;
 189
 190   // Statistics not enabled?
 191   if (Stats.Stats.empty()) return;
 192
 193   // Get the stream to write to.
 194   std::unique_ptr<raw_ostream> OutStream = CreateInfoOutputFile();
 195   if (StatsAsJSON)
 196     PrintStatisticsJSON(*OutStream);
 197   else
 198     PrintStatistics(*OutStream);
 199
 200 #else
 201   // Check if the -stats option is set instead of checking
 202   // !Stats.Stats.empty().  In release builds, Statistics operators
 203   // do nothing, so stats are never Registered.
 204   if (Stats) {
 205     // Get the stream to write to.
 206     std::unique_ptr<raw_ostream> OutStream = CreateInfoOutputFile();
 207     (*OutStream) << "Statistics are disabled.  "
 208                  << "Build with asserts or with -DLLVM_ENABLE_STATS\n";
 209   }
 210 #endif
 211 }