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