2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
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.
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.
28 * Authors: Nathan Binkert
31 #ifndef __BASE_STATS_INFO_HH__
32 #define __BASE_STATS_INFO_HH__
34 #include "base/flags.hh"
35 #include "base/stats/types.hh"
39 typedef uint16_t FlagsType;
40 typedef ::Flags<FlagsType> Flags;
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 display = 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;
61 /** Mask of flags that can't be set directly */
62 const FlagsType __reserved = init | display;
70 /** The name of the stat. */
72 /** The description of the stat. */
74 /** The formatting flags. */
76 /** The display precision. */
78 /** A pointer to a prerequisite Stat. */
81 * A unique stat ID for each stat in the simulator.
82 * Can be used externally for lookups as well as for debugging.
88 const StorageParams *storageParams;
94 /** Set the name of this statistic */
95 void setName(const std::string &name);
98 * Check that this stat has been set up properly and is ready for
100 * @return true for success
102 virtual bool check() const = 0;
103 bool baseCheck() const;
106 * Enable the stat for use
108 virtual void enable();
111 * Prepare the stat for dumping.
113 virtual void prepare() = 0;
116 * Reset the stat to the default state.
118 virtual void reset() = 0;
121 * @return true if this stat has a value and satisfies its
122 * requirement as a prereq
124 virtual bool zero() const = 0;
127 * Visitor entry for outputing statistics data
129 virtual void visit(Visit &visitor) = 0;
132 * Checks if the first stat's name is alphabetically less than the second.
133 * This function breaks names up at periods and considers each subname
135 * @param stat1 The first stat.
136 * @param stat2 The second stat.
137 * @return stat1's name is alphabetically before stat2's
139 static bool less(Info *stat1, Info *stat2);
142 class ScalarInfo : public Info
145 virtual Counter value() const = 0;
146 virtual Result result() const = 0;
147 virtual Result total() const = 0;
150 class VectorInfo : public Info
153 /** Names and descriptions of subfields. */
154 std::vector<std::string> subnames;
155 std::vector<std::string> subdescs;
161 virtual size_type size() const = 0;
162 virtual const VCounter &value() const = 0;
163 virtual const VResult &result() const = 0;
164 virtual Result total() const = 0;
167 enum DistType { Deviation, Dist };
186 class DistInfo : public Info
189 /** Local storage for the entry values, used for printing. */
193 class VectorDistInfo : public Info
196 std::vector<DistData> data;
198 /** Names and descriptions of subfields. */
199 std::vector<std::string> subnames;
200 std::vector<std::string> subdescs;
204 /** Local storage for the entry values, used for printing. */
205 mutable VResult rvec;
208 virtual size_type size() const = 0;
211 class Vector2dInfo : public Info
214 /** Names and descriptions of subfields. */
215 std::vector<std::string> subnames;
216 std::vector<std::string> subdescs;
217 std::vector<std::string> y_subnames;
222 /** Local storage for the entry values, used for printing. */
223 mutable VCounter cvec;
228 class FormulaInfo : public VectorInfo
231 virtual std::string str() const = 0;
237 #endif // __BASE_STATS_INFO_HH__