info.hh revision 6169
16129Snate@binkert.org/* 26129Snate@binkert.org * Copyright (c) 2003-2005 The Regents of The University of Michigan 36129Snate@binkert.org * All rights reserved. 46129Snate@binkert.org * 56129Snate@binkert.org * Redistribution and use in source and binary forms, with or without 66129Snate@binkert.org * modification, are permitted provided that the following conditions are 76129Snate@binkert.org * met: redistributions of source code must retain the above copyright 86129Snate@binkert.org * notice, this list of conditions and the following disclaimer; 96129Snate@binkert.org * redistributions in binary form must reproduce the above copyright 106129Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 116129Snate@binkert.org * documentation and/or other materials provided with the distribution; 126129Snate@binkert.org * neither the name of the copyright holders nor the names of its 136129Snate@binkert.org * contributors may be used to endorse or promote products derived from 146129Snate@binkert.org * this software without specific prior written permission. 156129Snate@binkert.org * 166129Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 176129Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 186129Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 196129Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 206129Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 216129Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 226129Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236129Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246129Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256129Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 266129Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276129Snate@binkert.org * 286129Snate@binkert.org * Authors: Nathan Binkert 296129Snate@binkert.org */ 306129Snate@binkert.org 316169Snate@binkert.org#ifndef __BASE_STATS_INFO_HH__ 326169Snate@binkert.org#define __BASE_STATS_INFO_HH__ 336169Snate@binkert.org 346130Snate@binkert.org#include "base/flags.hh" 356129Snate@binkert.org#include "base/stats/types.hh" 366129Snate@binkert.org 376129Snate@binkert.orgnamespace Stats { 386129Snate@binkert.org 396130Snate@binkert.orgtypedef uint16_t FlagsType; 406130Snate@binkert.orgtypedef ::Flags<FlagsType> Flags; 416130Snate@binkert.org 426130Snate@binkert.org/** Nothing extra to print. */ 436130Snate@binkert.orgconst FlagsType none = 0x0000; 446130Snate@binkert.org/** This Stat is Initialized */ 456130Snate@binkert.orgconst FlagsType init = 0x0001; 466130Snate@binkert.org/** Print this stat. */ 476130Snate@binkert.orgconst FlagsType print = 0x0002; 486130Snate@binkert.org/** Print the total. */ 496130Snate@binkert.orgconst FlagsType total = 0x0010; 506130Snate@binkert.org/** Print the percent of the total that this entry represents. */ 516130Snate@binkert.orgconst FlagsType pdf = 0x0020; 526130Snate@binkert.org/** Print the cumulative percentage of total upto this entry. */ 536130Snate@binkert.orgconst FlagsType cdf = 0x0040; 546130Snate@binkert.org/** Print the distribution. */ 556130Snate@binkert.orgconst FlagsType dist = 0x0080; 566130Snate@binkert.org/** Don't print if this is zero. */ 576130Snate@binkert.orgconst FlagsType nozero = 0x0100; 586130Snate@binkert.org/** Don't print if this is NAN */ 596130Snate@binkert.orgconst FlagsType nonan = 0x0200; 606130Snate@binkert.org/** Used for SS compatability. */ 616130Snate@binkert.orgconst FlagsType __substat = 0x8000; 626130Snate@binkert.org 636130Snate@binkert.org/** Mask of flags that can't be set directly */ 646130Snate@binkert.orgconst FlagsType __reserved = init | print | __substat; 656130Snate@binkert.org 666129Snate@binkert.orgstruct StorageParams 676129Snate@binkert.org{ 686129Snate@binkert.org virtual ~StorageParams(); 696129Snate@binkert.org}; 706129Snate@binkert.org 716129Snate@binkert.orgstruct Visit; 726129Snate@binkert.org 736129Snate@binkert.orgclass Info 746129Snate@binkert.org{ 756129Snate@binkert.org public: 766129Snate@binkert.org /** The name of the stat. */ 776129Snate@binkert.org std::string name; 786129Snate@binkert.org /** The description of the stat. */ 796129Snate@binkert.org std::string desc; 806129Snate@binkert.org /** The formatting flags. */ 816130Snate@binkert.org Flags flags; 826129Snate@binkert.org /** The display precision. */ 836129Snate@binkert.org int precision; 846129Snate@binkert.org /** A pointer to a prerequisite Stat. */ 856129Snate@binkert.org const Info *prereq; 866129Snate@binkert.org /** 876129Snate@binkert.org * A unique stat ID for each stat in the simulator. 886129Snate@binkert.org * Can be used externally for lookups as well as for debugging. 896129Snate@binkert.org */ 906129Snate@binkert.org static int id_count; 916129Snate@binkert.org int id; 926129Snate@binkert.org 936129Snate@binkert.org public: 946129Snate@binkert.org const StorageParams *storageParams; 956129Snate@binkert.org 966129Snate@binkert.org public: 976129Snate@binkert.org Info(); 986129Snate@binkert.org virtual ~Info(); 996129Snate@binkert.org 1006129Snate@binkert.org /** Set the name of this statistic */ 1016129Snate@binkert.org void setName(const std::string &name); 1026129Snate@binkert.org 1036129Snate@binkert.org /** 1046129Snate@binkert.org * Check that this stat has been set up properly and is ready for 1056129Snate@binkert.org * use 1066129Snate@binkert.org * @return true for success 1076129Snate@binkert.org */ 1086129Snate@binkert.org virtual bool check() const = 0; 1096129Snate@binkert.org bool baseCheck() const; 1106129Snate@binkert.org 1116129Snate@binkert.org /** 1126129Snate@binkert.org * Enable the stat for use 1136129Snate@binkert.org */ 1146129Snate@binkert.org virtual void enable(); 1156129Snate@binkert.org 1166129Snate@binkert.org /** 1176129Snate@binkert.org * Prepare the stat for dumping. 1186129Snate@binkert.org */ 1196129Snate@binkert.org virtual void prepare() = 0; 1206129Snate@binkert.org 1216129Snate@binkert.org /** 1226129Snate@binkert.org * Reset the stat to the default state. 1236129Snate@binkert.org */ 1246129Snate@binkert.org virtual void reset() = 0; 1256129Snate@binkert.org 1266129Snate@binkert.org /** 1276129Snate@binkert.org * @return true if this stat has a value and satisfies its 1286129Snate@binkert.org * requirement as a prereq 1296129Snate@binkert.org */ 1306129Snate@binkert.org virtual bool zero() const = 0; 1316129Snate@binkert.org 1326129Snate@binkert.org /** 1336129Snate@binkert.org * Visitor entry for outputing statistics data 1346129Snate@binkert.org */ 1356129Snate@binkert.org virtual void visit(Visit &visitor) = 0; 1366129Snate@binkert.org 1376129Snate@binkert.org /** 1386129Snate@binkert.org * Checks if the first stat's name is alphabetically less than the second. 1396129Snate@binkert.org * This function breaks names up at periods and considers each subname 1406129Snate@binkert.org * separately. 1416129Snate@binkert.org * @param stat1 The first stat. 1426129Snate@binkert.org * @param stat2 The second stat. 1436129Snate@binkert.org * @return stat1's name is alphabetically before stat2's 1446129Snate@binkert.org */ 1456129Snate@binkert.org static bool less(Info *stat1, Info *stat2); 1466129Snate@binkert.org}; 1476129Snate@binkert.org 1486129Snate@binkert.orgclass ScalarInfo : public Info 1496129Snate@binkert.org{ 1506129Snate@binkert.org public: 1516129Snate@binkert.org virtual Counter value() const = 0; 1526129Snate@binkert.org virtual Result result() const = 0; 1536129Snate@binkert.org virtual Result total() const = 0; 1546129Snate@binkert.org}; 1556129Snate@binkert.org 1566129Snate@binkert.orgclass VectorInfo : public Info 1576129Snate@binkert.org{ 1586129Snate@binkert.org public: 1596129Snate@binkert.org /** Names and descriptions of subfields. */ 1606129Snate@binkert.org std::vector<std::string> subnames; 1616129Snate@binkert.org std::vector<std::string> subdescs; 1626129Snate@binkert.org 1636129Snate@binkert.org public: 1646129Snate@binkert.org void enable(); 1656129Snate@binkert.org 1666129Snate@binkert.org public: 1676129Snate@binkert.org virtual size_type size() const = 0; 1686129Snate@binkert.org virtual const VCounter &value() const = 0; 1696129Snate@binkert.org virtual const VResult &result() const = 0; 1706129Snate@binkert.org virtual Result total() const = 0; 1716129Snate@binkert.org}; 1726129Snate@binkert.org 1736129Snate@binkert.orgstruct DistData 1746129Snate@binkert.org{ 1756129Snate@binkert.org Counter min_val; 1766129Snate@binkert.org Counter max_val; 1776129Snate@binkert.org Counter underflow; 1786129Snate@binkert.org Counter overflow; 1796129Snate@binkert.org VCounter cvec; 1806129Snate@binkert.org Counter sum; 1816129Snate@binkert.org Counter squares; 1826129Snate@binkert.org Counter samples; 1836129Snate@binkert.org}; 1846129Snate@binkert.org 1856129Snate@binkert.orgstruct DistParams : public StorageParams 1866129Snate@binkert.org{ 1876129Snate@binkert.org const bool fancy; 1886129Snate@binkert.org 1896129Snate@binkert.org /** The minimum value to track. */ 1906129Snate@binkert.org Counter min; 1916129Snate@binkert.org /** The maximum value to track. */ 1926129Snate@binkert.org Counter max; 1936129Snate@binkert.org /** The number of entries in each bucket. */ 1946129Snate@binkert.org Counter bucket_size; 1956129Snate@binkert.org /** The number of buckets. Equal to (max-min)/bucket_size. */ 1966129Snate@binkert.org size_type buckets; 1976129Snate@binkert.org 1986129Snate@binkert.org explicit DistParams(bool f) : fancy(f) {} 1996129Snate@binkert.org}; 2006129Snate@binkert.org 2016129Snate@binkert.orgclass DistInfo : public Info 2026129Snate@binkert.org{ 2036129Snate@binkert.org public: 2046129Snate@binkert.org /** Local storage for the entry values, used for printing. */ 2056129Snate@binkert.org DistData data; 2066129Snate@binkert.org}; 2076129Snate@binkert.org 2086129Snate@binkert.orgclass VectorDistInfo : public Info 2096129Snate@binkert.org{ 2106129Snate@binkert.org public: 2116129Snate@binkert.org std::vector<DistData> data; 2126129Snate@binkert.org 2136129Snate@binkert.org /** Names and descriptions of subfields. */ 2146129Snate@binkert.org std::vector<std::string> subnames; 2156129Snate@binkert.org std::vector<std::string> subdescs; 2166129Snate@binkert.org void enable(); 2176129Snate@binkert.org 2186129Snate@binkert.org protected: 2196129Snate@binkert.org /** Local storage for the entry values, used for printing. */ 2206129Snate@binkert.org mutable VResult rvec; 2216129Snate@binkert.org 2226129Snate@binkert.org public: 2236129Snate@binkert.org virtual size_type size() const = 0; 2246129Snate@binkert.org}; 2256129Snate@binkert.org 2266129Snate@binkert.orgclass Vector2dInfo : public Info 2276129Snate@binkert.org{ 2286129Snate@binkert.org public: 2296129Snate@binkert.org /** Names and descriptions of subfields. */ 2306129Snate@binkert.org std::vector<std::string> subnames; 2316129Snate@binkert.org std::vector<std::string> subdescs; 2326129Snate@binkert.org std::vector<std::string> y_subnames; 2336129Snate@binkert.org 2346129Snate@binkert.org size_type x; 2356129Snate@binkert.org size_type y; 2366129Snate@binkert.org 2376129Snate@binkert.org /** Local storage for the entry values, used for printing. */ 2386129Snate@binkert.org mutable VCounter cvec; 2396129Snate@binkert.org 2406129Snate@binkert.org void enable(); 2416129Snate@binkert.org}; 2426129Snate@binkert.org 2436129Snate@binkert.orgclass FormulaInfo : public VectorInfo 2446129Snate@binkert.org{ 2456129Snate@binkert.org public: 2466129Snate@binkert.org virtual std::string str() const = 0; 2476129Snate@binkert.org}; 2486129Snate@binkert.org 2496129Snate@binkert.org 2506129Snate@binkert.org/* namespace Stats */ } 2516169Snate@binkert.org 2526169Snate@binkert.org#endif // __BASE_STATS_INFO_HH__ 253