1 //===-- Statistic.cpp - Easy way to expose stats information --------------===//
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.
8 // This is useful for reporting information like the number of instructions
9 // simplified, optimized or removed by various transformations, like this:
11 // static Statistic<> NumInstEliminated("GCSE - Number of instructions killed");
13 // Later, in the code: ++NumInstEliminated;
15 //===----------------------------------------------------------------------===//
17 #include "Support/Statistic.h"
18 #include "Support/CommandLine.h"
22 bool DebugFlag; // DebugFlag - Exported boolean set by the -debug option
24 unsigned StatisticBase::NumStats = 0;
26 // -stats - Command line option to cause transformations to emit stats about
30 Enabled("stats", cl::desc("Enable statistics output from program"));
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));
39 const char *Name, *Desc;
41 StatRecord(const std::string V, const char *N, const char *D)
42 : Value(V), Name(N), Desc(D) {}
44 bool operator<(const StatRecord &SR) const {
45 return std::strcmp(Name, SR.Name) < 0;
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";
56 static std::vector<StatRecord> *AccumStats = 0;
58 // Print information when destroyed, iff command line option is specified
59 void StatisticBase::destroy() const {
60 if (Enabled && hasSomeData()) {
62 AccumStats = new std::vector<StatRecord>();
64 std::ostringstream Out;
66 AccumStats->push_back(StatRecord(Out.str(), Name, Desc));
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));
78 std::stable_sort(AccumStats->begin(), AccumStats->end());
80 // Print out the statistics header...
81 std::cerr << "===" << std::string(73, '-') << "===\n"
82 << " ... Statistics Collected ...\n"
83 << "===" << std::string(73, '-') << "===\n\n";
85 // Print all of the statistics accumulated...
86 for (unsigned i = 0, e = AccumStats->size(); i != e; ++i)
87 (*AccumStats)[i].print(MaxValLen, MaxNameLen);
89 std::cerr << std::endl; // Flush the output stream...
91 // Free all accumulated statistics...