src/base/stats/info.hh

   1 /*
   2  * Copyright (c) 2003-2005 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Nathan Binkert
  29  */
  30
  31 #ifndef __BASE_STATS_INFO_HH__
  32 #define __BASE_STATS_INFO_HH__
  33
  34 #include "base/flags.hh"
  35 #include "base/stats/types.hh"
  36
  37 namespace Stats {
  38
  39 typedef uint16_t FlagsType;
  40 typedef ::Flags<FlagsType> Flags;
  41
  42 /** Nothing extra to print. */
  43 const FlagsType none =          0x0000;
  44 /** This Stat is Initialized */
  45 const FlagsType init =          0x0001;
  46 /** Print this stat. */
  47 const FlagsType print =         0x0002;
  48 /** Print the total. */
  49 const FlagsType total =         0x0010;
  50 /** Print the percent of the total that this entry represents. */
  51 const FlagsType pdf =           0x0020;
  52 /** Print the cumulative percentage of total upto this entry. */
  53 const FlagsType cdf =           0x0040;
  54 /** Print the distribution. */
  55 const FlagsType dist =          0x0080;
  56 /** Don't print if this is zero. */
  57 const FlagsType nozero =        0x0100;
  58 /** Don't print if this is NAN */
  59 const FlagsType nonan =         0x0200;
  60
  61 /** Mask of flags that can't be set directly */
  62 const FlagsType __reserved =    init | print;
  63
  64 struct StorageParams
  65 {
  66     virtual ~StorageParams();
  67 };
  68
  69 struct Visit;
  70
  71 class Info
  72 {
  73   public:
  74     /** The name of the stat. */
  75     std::string name;
  76     /** The description of the stat. */
  77     std::string desc;
  78     /** The formatting flags. */
  79     Flags flags;
  80     /** The display precision. */
  81     int precision;
  82     /** A pointer to a prerequisite Stat. */
  83     const Info *prereq;
  84     /**
  85      * A unique stat ID for each stat in the simulator.
  86      * Can be used externally for lookups as well as for debugging.
  87      */
  88     static int id_count;
  89     int id;
  90
  91   public:
  92     const StorageParams *storageParams;
  93
  94   public:
  95     Info();
  96     virtual ~Info();
  97
  98     /** Set the name of this statistic */
  99     void setName(const std::string &name);
 100
 101     /**
 102      * Check that this stat has been set up properly and is ready for
 103      * use
 104      * @return true for success
 105      */
 106     virtual bool check() const = 0;
 107     bool baseCheck() const;
 108
 109     /**
 110      * Enable the stat for use
 111      */
 112     virtual void enable();
 113
 114     /**
 115      * Prepare the stat for dumping.
 116      */
 117     virtual void prepare() = 0;
 118
 119     /**
 120      * Reset the stat to the default state.
 121      */
 122     virtual void reset() = 0;
 123
 124     /**
 125      * @return true if this stat has a value and satisfies its
 126      * requirement as a prereq
 127      */
 128     virtual bool zero() const = 0;
 129
 130     /**
 131      * Visitor entry for outputing statistics data
 132      */
 133     virtual void visit(Visit &visitor) = 0;
 134
 135     /**
 136      * Checks if the first stat's name is alphabetically less than the second.
 137      * This function breaks names up at periods and considers each subname
 138      * separately.
 139      * @param stat1 The first stat.
 140      * @param stat2 The second stat.
 141      * @return stat1's name is alphabetically before stat2's
 142      */
 143     static bool less(Info *stat1, Info *stat2);
 144 };
 145
 146 class ScalarInfo : public Info
 147 {
 148   public:
 149     virtual Counter value() const = 0;
 150     virtual Result result() const = 0;
 151     virtual Result total() const = 0;
 152 };
 153
 154 class VectorInfo : public Info
 155 {
 156   public:
 157     /** Names and descriptions of subfields. */
 158     std::vector<std::string> subnames;
 159     std::vector<std::string> subdescs;
 160
 161   public:
 162     void enable();
 163
 164   public:
 165     virtual size_type size() const = 0;
 166     virtual const VCounter &value() const = 0;
 167     virtual const VResult &result() const = 0;
 168     virtual Result total() const = 0;
 169 };
 170
 171 struct DistData
 172 {
 173     Counter min_val;
 174     Counter max_val;
 175     Counter underflow;
 176     Counter overflow;
 177     VCounter cvec;
 178     Counter sum;
 179     Counter squares;
 180     Counter samples;
 181 };
 182
 183 struct DistParams : public StorageParams
 184 {
 185     const bool fancy;
 186
 187     /** The minimum value to track. */
 188     Counter min;
 189     /** The maximum value to track. */
 190     Counter max;
 191     /** The number of entries in each bucket. */
 192     Counter bucket_size;
 193     /** The number of buckets. Equal to (max-min)/bucket_size. */
 194     size_type buckets;
 195
 196     explicit DistParams(bool f) : fancy(f) {}
 197 };
 198
 199 class DistInfo : public Info
 200 {
 201   public:
 202     /** Local storage for the entry values, used for printing. */
 203     DistData data;
 204 };
 205
 206 class VectorDistInfo : public Info
 207 {
 208   public:
 209     std::vector<DistData> data;
 210
 211     /** Names and descriptions of subfields. */
 212     std::vector<std::string> subnames;
 213     std::vector<std::string> subdescs;
 214     void enable();
 215
 216   protected:
 217     /** Local storage for the entry values, used for printing. */
 218     mutable VResult rvec;
 219
 220   public:
 221     virtual size_type size() const = 0;
 222 };
 223
 224 class Vector2dInfo : public Info
 225 {
 226   public:
 227     /** Names and descriptions of subfields. */
 228     std::vector<std::string> subnames;
 229     std::vector<std::string> subdescs;
 230     std::vector<std::string> y_subnames;
 231
 232     size_type x;
 233     size_type y;
 234
 235     /** Local storage for the entry values, used for printing. */
 236     mutable VCounter cvec;
 237
 238     void enable();
 239 };
 240
 241 class FormulaInfo : public VectorInfo
 242 {
 243   public:
 244     virtual std::string str() const = 0;
 245 };
 246
 247
 248 /* namespace Stats */ }
 249
 250 #endif // __BASE_STATS_INFO_HH__