lib/Support/Statistic.cpp

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