27067adabb0ab9e56b5fc2a519d664611dcce73c
[gem5.git] / src / sim / probe / probe.cc
1 /*
2 * Copyright (c) 2013 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 "sim/probe/probe.hh"
39
40 #include "debug/ProbeVerbose.hh"
41 #include "params/ProbeListenerObject.hh"
42
43 ProbePoint::ProbePoint(ProbeManager *manager, const std::string& _name)
44 : name(_name)
45 {
46 if (manager) {
47 manager->addPoint(*this);
48 }
49 }
50
51 ProbeListenerObject::ProbeListenerObject(
52 const ProbeListenerObjectParams &params)
53 : SimObject(params),
54 manager(params.manager->getProbeManager())
55 {
56 }
57
58 ProbeListenerObject::~ProbeListenerObject()
59 {
60 for (auto l = listeners.begin(); l != listeners.end(); ++l) {
61 delete (*l);
62 }
63 listeners.clear();
64 }
65
66 ProbeListener::ProbeListener(ProbeManager *_manager, const std::string &_name)
67 : manager(_manager), name(_name)
68 {
69 manager->addListener(name, *this);
70 }
71
72 ProbeListener::~ProbeListener()
73 {
74 manager->removeListener(name, *this);
75 }
76
77 ProbeListenerObject*
78 ProbeListenerObjectParams::create() const
79 {
80 return new ProbeListenerObject(*this);
81 }
82
83 bool
84 ProbeManager::addListener(std::string pointName, ProbeListener &listener)
85 {
86 DPRINTFR(ProbeVerbose, "Probes: Call to addListener to \"%s\" on %s.\n", pointName, object->name());
87 bool added = false;
88 for (auto p = points.begin(); p != points.end(); ++p) {
89 if ((*p)->getName() == pointName) {
90 (*p)->addListener(&listener);
91 added = true;
92 }
93 }
94 if (!added) {
95 DPRINTFR(ProbeVerbose, "Probes: Call to addListener to \"%s\" on %s failed, no such point.\n", pointName, object->name());
96 }
97 return added;
98 }
99
100 bool
101 ProbeManager::removeListener(std::string pointName, ProbeListener &listener)
102 {
103 DPRINTFR(ProbeVerbose, "Probes: Call to removeListener from \"%s\" on %s.\n", pointName, object->name());
104 bool removed = false;
105 for (auto p = points.begin(); p != points.end(); ++p) {
106 if ((*p)->getName() == pointName) {
107 (*p)->removeListener(&listener);
108 removed = true;
109 }
110 }
111 if (!removed) {
112 DPRINTFR(ProbeVerbose, "Probes: Call to removeListener from \"%s\" on %s failed, no such point.\n", pointName, object->name());
113 }
114 return removed;
115 }
116
117 void
118 ProbeManager::addPoint(ProbePoint &point)
119 {
120 DPRINTFR(ProbeVerbose, "Probes: Call to addPoint \"%s\" to %s.\n", point.getName(), object->name());
121
122 for (auto p = points.begin(); p != points.end(); ++p) {
123 if ((*p)->getName() == point.getName()) {
124 DPRINTFR(ProbeVerbose, "Probes: Call to addPoint \"%s\" to %s failed, already added.\n", point.getName(), object->name());
125 return;
126 }
127 }
128 points.push_back(&point);
129 }