-//===-- Support/StatisticReporter.h - Easy way to expose stats ---*- C++ -*-==//
+//===-- Support/Statistic.h - Easy way to expose stats ----------*- C++ -*-===//
+//
+// The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
//
// This file defines the 'Statistic' class, which is designed to be an easy way
// to expose various success metrics from passes. These statistics are printed
// This is useful for reporting information like the number of instructions
// simplified, optimized or removed by various transformations, like this:
//
-// static Statistic<> NumInstEliminated("GCSE - Number of instructions killed");
+// static Statistic<> NumInstsKilled("gcse", "Number of instructions killed");
//
-// Later, in the code: ++NumInstEliminated;
+// Later, in the code: ++NumInstsKilled;
//
//===----------------------------------------------------------------------===//
-#ifndef SUPPORT_STATISTIC_REPORTER_H
-#define SUPPORT_STATISTIC_REPORTER_H
+#ifndef SUPPORT_STATISTIC_H
+#define SUPPORT_STATISTIC_H
#include <iosfwd>
+namespace llvm {
+
// StatisticBase - Nontemplated base class for Statistic<> class...
class StatisticBase {
const char *Name;
+ const char *Desc;
+ static unsigned NumStats;
protected:
- StatisticBase(const char *name) : Name(name) {}
+ StatisticBase(const char *name, const char *desc) : Name(name), Desc(desc) {
+ ++NumStats; // Keep track of how many stats are created...
+ }
virtual ~StatisticBase() {}
// destroy - Called by subclass dtor so that we can still invoke virtual
void destroy() const;
// printValue - Overridden by template class to print out the value type...
- virtual void printValue(ostream &o) const = 0;
+ virtual void printValue(std::ostream &o) const = 0;
// hasSomeData - Return true if some data has been aquired. Avoid printing
// lots of zero counts.
class Statistic : private StatisticBase {
DataType Value;
- virtual void printValue(ostream &o) const { o << Value; }
+ virtual void printValue(std::ostream &o) const { o << Value; }
virtual bool hasSomeData() const { return Value != DataType(); }
public:
// Normal constructor, default initialize data item...
- Statistic(const char *name) : StatisticBase(name), Value(DataType()) {}
+ Statistic(const char *name, const char *desc)
+ : StatisticBase(name, desc), Value(DataType()) {}
// Constructor to provide an initial value...
- Statistic(const DataType &Val, const char *name)
- : StatisticBase(name), Value(Val) {}
+ Statistic(const DataType &Val, const char *name, const char *desc)
+ : StatisticBase(name, desc), Value(Val) {}
// Print information when destroyed, iff command line option is specified
~Statistic() { destroy(); }
// Allow use of this class as the value itself...
- inline operator DataType() const { return Value; }
- inline const DataType &operator=(DataType Val) { Value = Val; return Value; }
- inline const DataType &operator++() { return ++Value; }
- inline DataType operator++(int) { return Value++; }
- inline const DataType &operator+=(const DataType &V) { return Value += V; }
- inline const DataType &operator-=(const DataType &V) { return Value -= V; }
+ operator DataType() const { return Value; }
+ const Statistic &operator=(DataType Val) { Value = Val; return *this; }
+ const Statistic &operator++() { ++Value; return *this; }
+ DataType operator++(int) { return Value++; }
+ const Statistic &operator--() { --Value; return *this; }
+ DataType operator--(int) { return Value--; }
+ const Statistic &operator+=(const DataType &V) { Value += V; return *this; }
+ const Statistic &operator-=(const DataType &V) { Value -= V; return *this; }
};
+} // End llvm namespace
+
#endif