llvm.org GIT mirror llvm / release_22 include / llvm / ADT / Statistic.h
release_22

Tree @release_22 (Download .tar.gz)

Statistic.h @release_22

551ccae
9769ab2
b2109ce
 
7ed47a1
 
9769ab2
b2109ce
fa10fdf
 
ac0b6ae
 
 
fa10fdf
 
 
 
ac0b6ae
fa10fdf
a0031cc
fa10fdf
ac0b6ae
 
fa10fdf
 
551ccae
 
fa10fdf
d0fde30
 
0a36152
ecb2768
fa10fdf
96ef1b9
975f058
 
fa10fdf
975f058
 
 
0a36152
 
 
 
 
 
 
975f058
ac0b6ae
0a36152
 
975f058
0a36152
975f058
0a36152
 
 
 
975f058
3d3a429
0a36152
975f058
 
 
 
fa10fdf
ecb2768
 
 
 
0a36152
fa10fdf
d0fde30
 
fa10fdf
//===-- llvm/ADT/Statistic.h - Easy way to expose stats ---------*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file 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 metrics from passes.  These statistics are printed at the
// end of a run (from llvm_shutdown), when the -stats command line option is
// passed on the command line.
//
// This is useful for reporting information like the number of instructions
// simplified, optimized or removed by various transformations, like this:
//
// static Statistic NumInstsKilled("gcse", "Number of instructions killed");
//
// Later, in the code: ++NumInstsKilled;
//
// NOTE: Statistics *must* be declared as global variables.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_ADT_STATISTIC_H
#define LLVM_ADT_STATISTIC_H

namespace llvm {

class Statistic {
public:
  const char *Name;
  const char *Desc;
  unsigned Value : 31;
  bool Initialized : 1;

  unsigned getValue() const { return Value; }
  const char *getName() const { return Name; }
  const char *getDesc() const { return Desc; }

  /// construct - This should only be called for non-global statistics.
  void construct(const char *name, const char *desc) {
    Name = name; Desc = desc;
    Value = 0; Initialized = 0;
  }

  // Allow use of this class as the value itself.
  operator unsigned() const { return Value; }
  const Statistic &operator=(unsigned Val) { Value = Val; return init(); }
  const Statistic &operator++() { ++Value; return init(); }
  unsigned operator++(int) { init(); return Value++; }
  const Statistic &operator--() { --Value; return init(); }
  unsigned operator--(int) { init(); return Value--; }
  const Statistic &operator+=(const unsigned &V) { Value += V; return init(); }
  const Statistic &operator-=(const unsigned &V) { Value -= V; return init(); }
  const Statistic &operator*=(const unsigned &V) { Value *= V; return init(); }
  const Statistic &operator/=(const unsigned &V) { Value /= V; return init(); }
  
protected:
  Statistic &init() {
    if (!Initialized) RegisterStatistic();
    return *this;
  }
  void RegisterStatistic();
};
  
// STATISTIC - A macro to make definition of statistics really simple.  This
// automatically passes the DEBUG_TYPE of the file into the statistic.
#define STATISTIC(VARNAME, DESC) \
  static Statistic VARNAME = { DEBUG_TYPE, DESC, 0, 0 }

} // End llvm namespace

#endif