info.hh revision 6129
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 316129Snate@binkert.org#include "base/stats/flags.hh" 326129Snate@binkert.org#include "base/stats/types.hh" 336129Snate@binkert.org 346129Snate@binkert.orgnamespace Stats { 356129Snate@binkert.org 366129Snate@binkert.orgstruct StorageParams 376129Snate@binkert.org{ 386129Snate@binkert.org virtual ~StorageParams(); 396129Snate@binkert.org}; 406129Snate@binkert.org 416129Snate@binkert.orgstruct Visit; 426129Snate@binkert.org 436129Snate@binkert.orgclass Info 446129Snate@binkert.org{ 456129Snate@binkert.org public: 466129Snate@binkert.org /** The name of the stat. */ 476129Snate@binkert.org std::string name; 486129Snate@binkert.org /** The description of the stat. */ 496129Snate@binkert.org std::string desc; 506129Snate@binkert.org /** The formatting flags. */ 516129Snate@binkert.org StatFlags flags; 526129Snate@binkert.org /** The display precision. */ 536129Snate@binkert.org int precision; 546129Snate@binkert.org /** A pointer to a prerequisite Stat. */ 556129Snate@binkert.org const Info *prereq; 566129Snate@binkert.org /** 576129Snate@binkert.org * A unique stat ID for each stat in the simulator. 586129Snate@binkert.org * Can be used externally for lookups as well as for debugging. 596129Snate@binkert.org */ 606129Snate@binkert.org static int id_count; 616129Snate@binkert.org int id; 626129Snate@binkert.org 636129Snate@binkert.org public: 646129Snate@binkert.org const StorageParams *storageParams; 656129Snate@binkert.org 666129Snate@binkert.org public: 676129Snate@binkert.org Info(); 686129Snate@binkert.org virtual ~Info(); 696129Snate@binkert.org 706129Snate@binkert.org /** Set the name of this statistic */ 716129Snate@binkert.org void setName(const std::string &name); 726129Snate@binkert.org 736129Snate@binkert.org /** 746129Snate@binkert.org * Check that this stat has been set up properly and is ready for 756129Snate@binkert.org * use 766129Snate@binkert.org * @return true for success 776129Snate@binkert.org */ 786129Snate@binkert.org virtual bool check() const = 0; 796129Snate@binkert.org bool baseCheck() const; 806129Snate@binkert.org 816129Snate@binkert.org /** 826129Snate@binkert.org * Enable the stat for use 836129Snate@binkert.org */ 846129Snate@binkert.org virtual void enable(); 856129Snate@binkert.org 866129Snate@binkert.org /** 876129Snate@binkert.org * Prepare the stat for dumping. 886129Snate@binkert.org */ 896129Snate@binkert.org virtual void prepare() = 0; 906129Snate@binkert.org 916129Snate@binkert.org /** 926129Snate@binkert.org * Reset the stat to the default state. 936129Snate@binkert.org */ 946129Snate@binkert.org virtual void reset() = 0; 956129Snate@binkert.org 966129Snate@binkert.org /** 976129Snate@binkert.org * @return true if this stat has a value and satisfies its 986129Snate@binkert.org * requirement as a prereq 996129Snate@binkert.org */ 1006129Snate@binkert.org virtual bool zero() const = 0; 1016129Snate@binkert.org 1026129Snate@binkert.org /** 1036129Snate@binkert.org * Visitor entry for outputing statistics data 1046129Snate@binkert.org */ 1056129Snate@binkert.org virtual void visit(Visit &visitor) = 0; 1066129Snate@binkert.org 1076129Snate@binkert.org /** 1086129Snate@binkert.org * Checks if the first stat's name is alphabetically less than the second. 1096129Snate@binkert.org * This function breaks names up at periods and considers each subname 1106129Snate@binkert.org * separately. 1116129Snate@binkert.org * @param stat1 The first stat. 1126129Snate@binkert.org * @param stat2 The second stat. 1136129Snate@binkert.org * @return stat1's name is alphabetically before stat2's 1146129Snate@binkert.org */ 1156129Snate@binkert.org static bool less(Info *stat1, Info *stat2); 1166129Snate@binkert.org}; 1176129Snate@binkert.org 1186129Snate@binkert.orgclass ScalarInfo : public Info 1196129Snate@binkert.org{ 1206129Snate@binkert.org public: 1216129Snate@binkert.org virtual Counter value() const = 0; 1226129Snate@binkert.org virtual Result result() const = 0; 1236129Snate@binkert.org virtual Result total() const = 0; 1246129Snate@binkert.org}; 1256129Snate@binkert.org 1266129Snate@binkert.orgclass VectorInfo : public Info 1276129Snate@binkert.org{ 1286129Snate@binkert.org public: 1296129Snate@binkert.org /** Names and descriptions of subfields. */ 1306129Snate@binkert.org std::vector<std::string> subnames; 1316129Snate@binkert.org std::vector<std::string> subdescs; 1326129Snate@binkert.org 1336129Snate@binkert.org public: 1346129Snate@binkert.org void enable(); 1356129Snate@binkert.org 1366129Snate@binkert.org public: 1376129Snate@binkert.org virtual size_type size() const = 0; 1386129Snate@binkert.org virtual const VCounter &value() const = 0; 1396129Snate@binkert.org virtual const VResult &result() const = 0; 1406129Snate@binkert.org virtual Result total() const = 0; 1416129Snate@binkert.org}; 1426129Snate@binkert.org 1436129Snate@binkert.orgstruct DistData 1446129Snate@binkert.org{ 1456129Snate@binkert.org Counter min_val; 1466129Snate@binkert.org Counter max_val; 1476129Snate@binkert.org Counter underflow; 1486129Snate@binkert.org Counter overflow; 1496129Snate@binkert.org VCounter cvec; 1506129Snate@binkert.org Counter sum; 1516129Snate@binkert.org Counter squares; 1526129Snate@binkert.org Counter samples; 1536129Snate@binkert.org}; 1546129Snate@binkert.org 1556129Snate@binkert.orgstruct DistParams : public StorageParams 1566129Snate@binkert.org{ 1576129Snate@binkert.org const bool fancy; 1586129Snate@binkert.org 1596129Snate@binkert.org /** The minimum value to track. */ 1606129Snate@binkert.org Counter min; 1616129Snate@binkert.org /** The maximum value to track. */ 1626129Snate@binkert.org Counter max; 1636129Snate@binkert.org /** The number of entries in each bucket. */ 1646129Snate@binkert.org Counter bucket_size; 1656129Snate@binkert.org /** The number of buckets. Equal to (max-min)/bucket_size. */ 1666129Snate@binkert.org size_type buckets; 1676129Snate@binkert.org 1686129Snate@binkert.org explicit DistParams(bool f) : fancy(f) {} 1696129Snate@binkert.org}; 1706129Snate@binkert.org 1716129Snate@binkert.orgclass DistInfo : public Info 1726129Snate@binkert.org{ 1736129Snate@binkert.org public: 1746129Snate@binkert.org /** Local storage for the entry values, used for printing. */ 1756129Snate@binkert.org DistData data; 1766129Snate@binkert.org}; 1776129Snate@binkert.org 1786129Snate@binkert.orgclass VectorDistInfo : public Info 1796129Snate@binkert.org{ 1806129Snate@binkert.org public: 1816129Snate@binkert.org std::vector<DistData> data; 1826129Snate@binkert.org 1836129Snate@binkert.org /** Names and descriptions of subfields. */ 1846129Snate@binkert.org std::vector<std::string> subnames; 1856129Snate@binkert.org std::vector<std::string> subdescs; 1866129Snate@binkert.org void enable(); 1876129Snate@binkert.org 1886129Snate@binkert.org protected: 1896129Snate@binkert.org /** Local storage for the entry values, used for printing. */ 1906129Snate@binkert.org mutable VResult rvec; 1916129Snate@binkert.org 1926129Snate@binkert.org public: 1936129Snate@binkert.org virtual size_type size() const = 0; 1946129Snate@binkert.org}; 1956129Snate@binkert.org 1966129Snate@binkert.orgclass Vector2dInfo : public Info 1976129Snate@binkert.org{ 1986129Snate@binkert.org public: 1996129Snate@binkert.org /** Names and descriptions of subfields. */ 2006129Snate@binkert.org std::vector<std::string> subnames; 2016129Snate@binkert.org std::vector<std::string> subdescs; 2026129Snate@binkert.org std::vector<std::string> y_subnames; 2036129Snate@binkert.org 2046129Snate@binkert.org size_type x; 2056129Snate@binkert.org size_type y; 2066129Snate@binkert.org 2076129Snate@binkert.org /** Local storage for the entry values, used for printing. */ 2086129Snate@binkert.org mutable VCounter cvec; 2096129Snate@binkert.org 2106129Snate@binkert.org void enable(); 2116129Snate@binkert.org}; 2126129Snate@binkert.org 2136129Snate@binkert.orgclass FormulaInfo : public VectorInfo 2146129Snate@binkert.org{ 2156129Snate@binkert.org public: 2166129Snate@binkert.org virtual std::string str() const = 0; 2176129Snate@binkert.org}; 2186129Snate@binkert.org 2196129Snate@binkert.org 2206129Snate@binkert.org/* namespace Stats */ } 221