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 <sstream>
  20 #include <iostream>
  21
  22 // GetLibSupportInfoOutputFile - Return a file stream to print our output on...
  23 std::ostream *GetLibSupportInfoOutputFile();
  24
  25 unsigned StatisticBase::NumStats = 0;
  26
  27 // -stats - Command line option to cause transformations to emit stats about
  28 // what they did.
  29 //
  30 static cl::opt<bool>
  31 Enabled("stats", cl::desc("Enable statistics output from program"));
  32
  33 struct StatRecord {
  34   std::string Value;
  35   const char *Name, *Desc;
  36
  37   StatRecord(const std::string V, const char *N, const char *D)
  38     : Value(V), Name(N), Desc(D) {}
  39
  40   bool operator<(const StatRecord &SR) const {
  41     return std::strcmp(Name, SR.Name) < 0;
  42   }
  43
  44   void print(unsigned ValFieldSize, unsigned NameFieldSize,
  45              std::ostream &OS) {
  46     OS << std::string(ValFieldSize-Value.length(), ' ')
  47        << Value << " " << Name
  48        << std::string(NameFieldSize-std::strlen(Name), ' ')
  49        << " - " << Desc << "\n";
  50   }
  51 };
  52
  53 static std::vector<StatRecord> *AccumStats = 0;
  54
  55 // Print information when destroyed, iff command line option is specified
  56 void StatisticBase::destroy() const {
  57   if (Enabled && hasSomeData()) {
  58     if (AccumStats == 0)
  59       AccumStats = new std::vector<StatRecord>();
  60
  61     std::ostringstream Out;
  62     printValue(Out);
  63     AccumStats->push_back(StatRecord(Out.str(), Name, Desc));
  64   }
  65
  66   if (--NumStats == 0 && AccumStats) {
  67     std::ostream *OutStream = GetLibSupportInfoOutputFile();
  68
  69     // Figure out how long the biggest Value and Name fields are...
  70     unsigned MaxNameLen = 0, MaxValLen = 0;
  71     for (unsigned i = 0, e = AccumStats->size(); i != e; ++i) {
  72       MaxValLen = std::max(MaxValLen,
  73                            (unsigned)(*AccumStats)[i].Value.length());
  74       MaxNameLen = std::max(MaxNameLen,
  75                             (unsigned)std::strlen((*AccumStats)[i].Name));
  76     }
  77
  78     // Sort the fields...
  79     std::stable_sort(AccumStats->begin(), AccumStats->end());
  80
  81     // Print out the statistics header...
  82     *OutStream << "===" << std::string(73, '-') << "===\n"
  83                << "                          ... Statistics Collected ...\n"
  84                << "===" << std::string(73, '-') << "===\n\n";
  85
  86     // Print all of the statistics accumulated...
  87     for (unsigned i = 0, e = AccumStats->size(); i != e; ++i)
  88       (*AccumStats)[i].print(MaxValLen, MaxNameLen, *OutStream);
  89
  90     *OutStream << std::endl;  // Flush the output stream...
  91
  92     // Free all accumulated statistics...
  93     delete AccumStats;
  94     AccumStats = 0;
  95     if (OutStream != &std::cerr && OutStream != &std::cout)
  96       delete OutStream;   // Close the file...
  97   }
  98 }