d054b7adb975041054969dda14cb37ed9e5939e1
[gem5.git] / src / base / stats / group.cc
1 /*
2 * Copyright (c) 2019 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 <cassert>
41
42 #include "base/stats/info.hh"
43 #include "base/trace.hh"
44 #include "debug/Stats.hh"
45 #include "sim/sim_object.hh"
46
47 namespace Stats {
48
49 Group::Group(Group *parent, const char *name)
50 : mergedParent(name ? nullptr : parent)
51 {
52 if (parent && name) {
53 parent->addStatGroup(name, this);
54 } else if (parent && !name) {
55 parent->mergeStatGroup(this);
56 }
57 }
58
59 Group::~Group()
60 {
61 }
62
63 void
64 Group::regStats()
65 {
66 for (auto &g : mergedStatGroups)
67 g->regStats();
68
69 for (auto &g : statGroups) {
70 if (DTRACE(Stats)) {
71 const SimObject M5_VAR_USED *so =
72 dynamic_cast<const SimObject *>(this);
73 DPRINTF(Stats, "%s: regStats in group %s\n",
74 so ? so->name() : "?",
75 g.first);
76 }
77 g.second->regStats();
78 }
79 }
80
81 void
82 Group::resetStats()
83 {
84 for (auto &s : stats)
85 s->reset();
86
87 for (auto &g : mergedStatGroups)
88 g->resetStats();
89
90 for (auto &g : statGroups)
91 g.second->resetStats();
92 }
93
94 void
95 Group::preDumpStats()
96 {
97 for (auto &g : mergedStatGroups)
98 g->preDumpStats();
99
100 for (auto &g : statGroups)
101 g.second->preDumpStats();
102 }
103
104 void
105 Group::addStat(Stats::Info *info)
106 {
107 stats.push_back(info);
108 if (mergedParent)
109 mergedParent->addStat(info);
110 }
111
112 void
113 Group::addStatGroup(const char *name, Group *block)
114 {
115 assert(statGroups.find(name) == statGroups.end());
116
117 statGroups[name] = block;
118 }
119
120 void
121 Group::mergeStatGroup(Group *block)
122 {
123 mergedStatGroups.push_back(block);
124 }
125
126 const std::map<std::string, Group *> &
127 Group::getStatGroups() const
128 {
129 return statGroups;
130 }
131
132 const std::vector<Info *> &
133 Group::getStats() const
134 {
135 return stats;
136 }
137
138 } // namespace Stats