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"
23 bool DebugFlag; // DebugFlag - Exported boolean set by the -debug option
25 unsigned StatisticBase::NumStats = 0;
27 // -stats - Command line option to cause transformations to emit stats about
31 Enabled("stats", cl::desc("Enable statistics output from program"));
34 // -debug - Command line option to enable the DEBUG statements in the passes.
35 // This flag may only be enabled in debug builds.
36 static cl::opt<bool, true>
37 Debug("debug", cl::desc("Enable debug output"), cl::Hidden,
38 cl::location(DebugFlag));
43 const char *Name, *Desc;
45 StatRecord(const std::string V, const char *N, const char *D)
46 : Value(V), Name(N), Desc(D) {}
48 bool operator<(const StatRecord &SR) const {
49 return std::strcmp(Name, SR.Name) < 0;
52 void print(unsigned ValFieldSize, unsigned NameFieldSize) {
53 std::cerr << std::string(ValFieldSize-Value.length(), ' ')
54 << Value << " " << Name
55 << std::string(NameFieldSize-std::strlen(Name), ' ')
56 << " - " << Desc << "\n";
60 static std::vector<StatRecord> *AccumStats = 0;
62 // Print information when destroyed, iff command line option is specified
63 void StatisticBase::destroy() const {
64 if (Enabled && hasSomeData()) {
66 AccumStats = new std::vector<StatRecord>();
68 std::ostringstream Out;
70 AccumStats->push_back(StatRecord(Out.str(), Name, Desc));
73 if (--NumStats == 0 && AccumStats) {
74 // Figure out how long the biggest Value and Name fields are...
75 unsigned MaxNameLen = 0, MaxValLen = 0;
76 for (unsigned i = 0, e = AccumStats->size(); i != e; ++i) {
77 MaxValLen = std::max(MaxValLen,
78 (unsigned)(*AccumStats)[i].Value.length());
79 MaxNameLen = std::max(MaxNameLen,
80 (unsigned)std::strlen((*AccumStats)[i].Name));
84 std::stable_sort(AccumStats->begin(), AccumStats->end());
86 // Print out the statistics header...
87 std::cerr << "===" << std::string(73, '-') << "===\n"
88 << " ... Statistics Collected ...\n"
89 << "===" << std::string(73, '-') << "===\n\n";
91 // Print all of the statistics accumulated...
92 for (unsigned i = 0, e = AccumStats->size(); i != e; ++i)
93 (*AccumStats)[i].print(MaxValLen, MaxNameLen);
95 std::cerr << std::endl; // Flush the output stream...
97 // Free all accumulated statistics...