gem5  v20.1.0.0
probe.cc
Go to the documentation of this file.
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(const ProbeListenerObjectParams *params)
52  : SimObject(params),
53  manager(params->manager->getProbeManager())
54 {
55 }
56 
58 {
59  for (auto l = listeners.begin(); l != listeners.end(); ++l) {
60  delete (*l);
61  }
62  listeners.clear();
63 }
64 
65 ProbeListener::ProbeListener(ProbeManager *_manager, const std::string &_name)
66  : manager(_manager), name(_name)
67 {
68  manager->addListener(name, *this);
69 }
70 
72 {
73  manager->removeListener(name, *this);
74 }
75 
77 ProbeListenerObjectParams::create()
78 {
79  return new ProbeListenerObject(this);
80 }
81 
82 bool
83 ProbeManager::addListener(std::string pointName, ProbeListener &listener)
84 {
85  DPRINTFR(ProbeVerbose, "Probes: Call to addListener to \"%s\" on %s.\n", pointName, object->name());
86  bool added = false;
87  for (auto p = points.begin(); p != points.end(); ++p) {
88  if ((*p)->getName() == pointName) {
89  (*p)->addListener(&listener);
90  added = true;
91  }
92  }
93  if (!added) {
94  DPRINTFR(ProbeVerbose, "Probes: Call to addListener to \"%s\" on %s failed, no such point.\n", pointName, object->name());
95  }
96  return added;
97 }
98 
99 bool
100 ProbeManager::removeListener(std::string pointName, ProbeListener &listener)
101 {
102  DPRINTFR(ProbeVerbose, "Probes: Call to removeListener from \"%s\" on %s.\n", pointName, object->name());
103  bool removed = false;
104  for (auto p = points.begin(); p != points.end(); ++p) {
105  if ((*p)->getName() == pointName) {
106  (*p)->removeListener(&listener);
107  removed = true;
108  }
109  }
110  if (!removed) {
111  DPRINTFR(ProbeVerbose, "Probes: Call to removeListener from \"%s\" on %s failed, no such point.\n", pointName, object->name());
112  }
113  return removed;
114 }
115 
116 void
118 {
119  DPRINTFR(ProbeVerbose, "Probes: Call to addPoint \"%s\" to %s.\n", point.getName(), object->name());
120 
121  for (auto p = points.begin(); p != points.end(); ++p) {
122  if ((*p)->getName() == point.getName()) {
123  DPRINTFR(ProbeVerbose, "Probes: Call to addPoint \"%s\" to %s failed, already added.\n", point.getName(), object->name());
124  return;
125  }
126  }
127  points.push_back(&point);
128 }
ProbeManager::addPoint
void addPoint(ProbePoint &point)
Add a ProbePoint to this SimObject ProbeManager.
Definition: probe.cc:117
ProbePoint::getName
std::string getName() const
Definition: probe.hh:143
ProbeListener::ProbeListener
ProbeListener(ProbeManager *manager, const std::string &name)
Definition: probe.cc:65
ProbeManager::object
const M5_CLASS_VAR_USED SimObject * object
Required for sensible debug messages.
Definition: probe.hh:154
ProbeManager::removeListener
bool removeListener(std::string pointName, ProbeListener &listener)
Remove a ProbeListener from the ProbePoint named by pointName.
Definition: probe.cc:100
ProbeListenerObject::listeners
std::vector< ProbeListener * > listeners
Definition: probe.hh:102
ProbeListener::manager
ProbeManager *const manager
Definition: probe.hh:124
ProbeListener::~ProbeListener
virtual ~ProbeListener()
Definition: probe.cc:71
ProbeListener
ProbeListener base class; here to simplify things like containers containing multiple types of ProbeL...
Definition: probe.hh:117
ProbeListener::name
const std::string name
Definition: probe.hh:125
ProbeListenerObject::~ProbeListenerObject
virtual ~ProbeListenerObject()
Definition: probe.cc:57
DPRINTFR
#define DPRINTFR(...)
Definition: trace.hh:236
ProbePoint
ProbeListener base class; again used to simplify use of ProbePoints in containers and used as to defi...
Definition: probe.hh:133
ProbeListenerObject
This class is a minimal wrapper around SimObject.
Definition: probe.hh:98
ProbeManager::addListener
bool addListener(std::string pointName, ProbeListener &listener)
Add a ProbeListener to the ProbePoint named by pointName.
Definition: probe.cc:83
name
const std::string & name()
Definition: trace.cc:50
SimObject::name
virtual const std::string name() const
Definition: sim_object.hh:133
ProbeManager
ProbeManager is a conduit class that lives on each SimObject, and is used to match up probe listeners...
Definition: probe.hh:150
ProbePoint::ProbePoint
ProbePoint(ProbeManager *manager, const std::string &name)
Definition: probe.cc:43
ProbeListenerObject::ProbeListenerObject
ProbeListenerObject(const ProbeListenerObjectParams *params)
Definition: probe.cc:51
ProbeManager::points
std::vector< ProbePoint * > points
Vector for name look-up.
Definition: probe.hh:156
MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:323
probe.hh
MipsISA::l
Bitfield< 5 > l
Definition: pra_constants.hh:320
SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:92

Generated on Wed Sep 30 2020 14:02:14 for gem5 by doxygen 1.8.17