lib/Support/Statistic.cpp

   1 //===-- Statistic.cpp - Easy way to expose stats information --------------===//
   2 //
   3 // This file implements the 'Statistic' class, which is designed to be an easy
   4 // way to expose various success metrics from passes.  These statistics are
   5 // printed at the end of a run, when the -stats command line option is enabled
   6 // on the command line.
   7 //
   8 // This is useful for reporting information like the number of instructions
   9 // simplified, optimized or removed by various transformations, like this:
  10 //
  11 // static Statistic<> NumInstEliminated("GCSE - Number of instructions killed");
  12 //
  13 // Later, in the code: ++NumInstEliminated;
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #include "Support/Statistic.h"
  18 #include "Support/CommandLine.h"
  19 #include <iostream>
  20 #include <sstream>
  21
  22 bool DebugFlag;  // DebugFlag - Exported boolean set by the -debug option
  23
  24 unsigned StatisticBase::NumStats = 0;
  25
  26 // -stats - Command line option to cause transformations to emit stats about
  27 // what they did.
  28 //
  29 static cl::opt<bool>
  30 Enabled("stats", cl::desc("Enable statistics output from program"));
  31
  32 // -debug - Command line option to enable the DEBUG statements in the passes.
  33 static cl::opt<bool, true>
  34 Debug("debug", cl::desc("Enable debug output"), cl::Hidden,
  35       cl::location(DebugFlag));
  36
  37 struct StatRecord {
  38   std::string Value;
  39   const char *Name, *Desc;
  40
  41   StatRecord(const std::string V, const char *N, const char *D)
  42     : Value(V), Name(N), Desc(D) {}
  43
  44   bool operator<(const StatRecord &SR) const {
  45     return std::strcmp(Name, SR.Name) < 0;
  46   }
  47
  48   void print(unsigned ValFieldSize, unsigned NameFieldSize) {
  49     std::cerr << std::string(ValFieldSize-Value.length(), ' ')
  50               << Value << " " << Name
  51               << std::string(NameFieldSize-std::strlen(Name), ' ')
  52               << " - " << Desc << "\n";
  53   }
  54 };
  55
  56 static std::vector<StatRecord> *AccumStats = 0;
  57
  58 // Print information when destroyed, iff command line option is specified
  59 void StatisticBase::destroy() const {
  60   if (Enabled && hasSomeData()) {
  61     if (AccumStats == 0)
  62       AccumStats = new std::vector<StatRecord>();
  63
  64     std::ostringstream Out;
  65     printValue(Out);
  66     AccumStats->push_back(StatRecord(Out.str(), Name, Desc));
  67   }
  68
  69   if (--NumStats == 0 && AccumStats) {
  70     // Figure out how long the biggest Value and Name fields are...
  71     unsigned MaxNameLen = 0, MaxValLen = 0;
  72     for (unsigned i = 0, e = AccumStats->size(); i != e; ++i) {
  73       MaxValLen = std::max(MaxValLen, (*AccumStats)[i].Value.length());
  74       MaxNameLen = std::max(MaxNameLen, std::strlen((*AccumStats)[i].Name));
  75     }
  76
  77     // Sort the fields...
  78     std::stable_sort(AccumStats->begin(), AccumStats->end());
  79
  80     // Print out the statistics header...
  81     std::cerr << "===" << std::string(73, '-') << "===\n"
  82               << "                          ... Statistics Collected ...\n"
  83               << "===" << std::string(73, '-') << "===\n\n";
  84
  85     // Print all of the statistics accumulated...
  86     for (unsigned i = 0, e = AccumStats->size(); i != e; ++i)
  87       (*AccumStats)[i].print(MaxValLen, MaxNameLen);
  88
  89     std::cerr << std::endl;  // Flush the output stream...
  90
  91     // Free all accumulated statistics...
  92     delete AccumStats;
  93     AccumStats = 0;
  94   }
  95 }