gem5  v21.1.0.2
group.cc
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 #include "base/stats/group.hh"
39 
40 #include "base/compiler.hh"
41 #include "base/logging.hh"
42 #include "base/named.hh"
43 #include "base/stats/info.hh"
44 #include "base/trace.hh"
45 #include "debug/Stats.hh"
46 
47 namespace gem5
48 {
49 
50 GEM5_DEPRECATED_NAMESPACE(Stats, statistics);
51 namespace statistics
52 {
53 
54 Group::Group(Group *parent, const char *name)
55  : mergedParent(nullptr)
56 {
57  if (parent && name) {
58  parent->addStatGroup(name, this);
59  } else if (parent && !name) {
60  parent->mergeStatGroup(this);
61  }
62 }
63 
65 {
66 }
67 
68 void
70 {
71  for (auto &g : mergedStatGroups)
72  g->regStats();
73 
74  for (auto &g : statGroups) {
75  if (debug::Stats) {
76  M5_VAR_USED const Named *named = dynamic_cast<const Named *>(this);
77  DPRINTF(Stats, "%s: regStats in group %s\n",
78  named ? named->name() : "?",
79  g.first);
80  }
81  g.second->regStats();
82  }
83 }
84 
85 void
87 {
88  for (auto &s : stats)
89  s->reset();
90 
91  for (auto &g : mergedStatGroups)
92  g->resetStats();
93 
94  for (auto &g : statGroups)
95  g.second->resetStats();
96 }
97 
98 void
100 {
101  for (auto &g : mergedStatGroups)
102  g->preDumpStats();
103 
104  for (auto &g : statGroups)
105  g.second->preDumpStats();
106 }
107 
108 void
110 {
111  stats.push_back(info);
112  if (mergedParent)
113  mergedParent->addStat(info);
114 }
115 
116 void
117 Group::addStatGroup(const char *name, Group *block)
118 {
119  panic_if(!block, "Can't add null stat group %s", name);
120  panic_if(block == this, "Stat group can't be added to itself");
121  panic_if(statGroups.find(name) != statGroups.end(),
122  "Stats of the same group share the same name `%s`.\n", name);
123 
124  statGroups[name] = block;
125 }
126 
127 const Info *
128 Group::resolveStat(std::string name) const
129 {
130  auto pos = name.find(".");
131  if (pos == std::string::npos) {
132  // look for the stat in this group
133  for (auto &info : stats) {
134  if (info->name == name) {
135  return info;
136  }
137  }
138  } else {
139  // look for the stat in subgroups
140  const std::string gname = name.substr(0, pos);
141  for (auto &g : statGroups) {
142  if (g.first == gname) {
143  return g.second->resolveStat(name.substr(pos + 1));
144  }
145  }
146  }
147 
148  // finally look for the stat in groups that have been merged
149  for (auto &g : mergedStatGroups) {
150  auto info = g->resolveStat(name);
151  if (info) {
152  return info;
153  }
154  }
155 
156  return nullptr;
157 }
158 
159 void
161 {
162  panic_if(!block, "No stat block provided");
163  panic_if(block->mergedParent,
164  "Stat group already merged into another group");
165  panic_if(block == this, "Stat group can't merge with itself");
166 
167  // Track the new stat group
168  mergedStatGroups.push_back(block);
169 
170  // We might not have seen stats that were associated with the
171  // child group before it was merged, so add them here.
172  for (auto &s : block->stats)
173  addStat(s);
174 
175  // Setup the parent pointer so the child know that it needs to
176  // register new stats with the parent.
177  block->mergedParent = this;
178 }
179 
180 const std::map<std::string, Group *> &
182 {
183  return statGroups;
184 }
185 
186 const std::vector<Info *> &
188 {
189  return stats;
190 }
191 
192 } // namespace statistics
193 } // namespace gem5
gem5::statistics::Group::mergedStatGroups
std::vector< Group * > mergedStatGroups
Definition: group.hh:220
group.hh
named.hh
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::Named
Interface for things with names.
Definition: named.hh:38
info.hh
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::ArmISA::s
Bitfield< 4 > s
Definition: misc_types.hh:561
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::MipsISA::g
Bitfield< 4 > g
Definition: dt_constants.hh:86
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
panic_if
#define panic_if(cond,...)
Conditional panic macro that checks the supplied condition and only panics if the condition is true a...
Definition: logging.hh:203
M5_VAR_USED
#define M5_VAR_USED
Definition: compiler.hh:193
gem5::statistics::Group::getStats
const std::vector< Info * > & getStats() const
Get all stats associated with this object.
Definition: group.cc:187
logging.hh
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
trace.hh
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