gem5  v21.1.0.2
group.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2019, 2020 Arm Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __BASE_STATS_GROUP_HH__
39 #define __BASE_STATS_GROUP_HH__
40 
41 #include <map>
42 #include <string>
43 #include <vector>
44 
45 #include "base/compiler.hh"
46 #include "base/stats/units.hh"
47 
48 namespace gem5
49 {
50 
75 #define ADD_STAT(n, ...) n(this, #n, __VA_ARGS__)
76 
77 GEM5_DEPRECATED_NAMESPACE(Stats, statistics);
78 namespace statistics
79 {
80 
81 class Info;
82 
93 class Group
94 {
95  public:
100  Group() = delete;
101  Group(const Group &) = delete;
102  Group &operator=(const Group &) = delete; //end of api_stats
104 
125  Group(Group *parent, const char *name = nullptr);
126 
127  virtual ~Group();
128 
140  virtual void regStats();
141 
147  virtual void resetStats();
148 
156  virtual void preDumpStats();
157 
164  void addStat(statistics::Info *info);
165 
171  const std::map<std::string, Group *> &getStatGroups() const;
172 
178  const std::vector<Info *> &getStats() const;
179 
189  void addStatGroup(const char *name, Group *block);
190 
205  const Info * resolveStat(std::string name) const;
206 
213  void mergeStatGroup(Group *block);
214 
215  private:
218 
219  std::map<std::string, Group *> statGroups;
222 };
223 
224 } // namespace statistics
225 } // namespace gem5
226 
227 #endif // __BASE_STATS_GROUP_HH__
gem5::statistics::Group::mergedStatGroups
std::vector< Group * > mergedStatGroups
Definition: group.hh:220
gem5::statistics::Group::mergedParent
Group * mergedParent
Parent pointer if merged into parent.
Definition: group.hh:217
std::vector
STL vector class.
Definition: stl.hh:37
gem5::statistics::Group::resetStats
virtual void resetStats()
Callback to reset stats.
Definition: group.cc:86
gem5::statistics::Group::resolveStat
const Info * resolveStat(std::string name) const
Resolve a stat by its name within this group.
Definition: group.cc:128
gem5::statistics::Group::statGroups
std::map< std::string, Group * > statGroups
Definition: group.hh:219
gem5::statistics::Group::Group
Group()=delete
gem5::statistics::Group::operator=
Group & operator=(const Group &)=delete
gem5::statistics::Group::mergeStatGroup
void mergeStatGroup(Group *block)
Merge the contents (stats & children) of a block to this block.
Definition: group.cc:160
compiler.hh
gem5::statistics::Group::addStatGroup
void addStatGroup(const char *name, Group *block)
Add a stat block as a child of this block.
Definition: group.cc:117
gem5::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(GuestABI, guest_abi)
name
const std::string & name()
Definition: trace.cc:49
gem5::statistics::Group::regStats
virtual void regStats()
Callback to set stat parameters.
Definition: group.cc:69
units.hh
gem5::statistics::Group::getStats
const std::vector< Info * > & getStats() const
Get all stats associated with this object.
Definition: group.cc:187
gem5::statistics::Group
Statistics container.
Definition: group.hh:93
gem5::statistics::Group::addStat
void addStat(statistics::Info *info)
Register a stat with this group.
Definition: group.cc:109
gem5::statistics::Group::stats
std::vector< Info * > stats
Definition: group.hh:221
gem5::statistics::Group::~Group
virtual ~Group()
Definition: group.cc:64
gem5::statistics::Group::getStatGroups
const std::map< std::string, Group * > & getStatGroups() const
Get all child groups associated with this object.
Definition: group.cc:181
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::statistics::Group::preDumpStats
virtual void preDumpStats()
Callback before stats are dumped.
Definition: group.cc:99
gem5::statistics::Info
Definition: info.hh:80

Generated on Tue Sep 21 2021 12:24:58 for gem5 by doxygen 1.8.17