gem5  v21.1.0.2
mem_checker_monitor.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2014 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 #ifndef __MEM_MEM_CHECKER_MONITOR_HH__
39 #define __MEM_MEM_CHECKER_MONITOR_HH__
40 
41 #include "base/statistics.hh"
42 #include "mem/mem_checker.hh"
43 #include "params/MemCheckerMonitor.hh"
44 #include "sim/sim_object.hh"
45 #include "sim/system.hh"
46 
47 namespace gem5
48 {
49 
54 {
55  public:
56 
58  using Params = MemCheckerMonitorParams;
59 
66 
69 
70  Port &getPort(const std::string &if_name,
71  PortID idx=InvalidPortID) override;
72 
73  void init() override;
74 
75  private:
76 
78  {
80  : serial(_serial)
81  {}
82 
84  };
85 
93  {
94 
95  public:
96 
97  MonitorRequestPort(const std::string& _name, MemCheckerMonitor& _mon)
98  : RequestPort(_name, &_mon), mon(_mon)
99  { }
100 
101  protected:
102 
104  {
106  }
107 
109  {
110  return mon.recvAtomicSnoop(pkt);
111  }
112 
114  {
115  return mon.recvTimingResp(pkt);
116  }
117 
119  {
120  mon.recvTimingSnoopReq(pkt);
121  }
122 
124  {
126  }
127 
128  bool isSnooping() const
129  {
130  return mon.isSnooping();
131  }
132 
134  {
135  mon.recvReqRetry();
136  }
137 
138  private:
139 
141 
142  };
143 
146 
154  {
155 
156  public:
157 
158  MonitorResponsePort(const std::string& _name, MemCheckerMonitor& _mon)
159  : ResponsePort(_name, &_mon), mon(_mon)
160  { }
161 
162  protected:
163 
165  {
166  mon.recvFunctional(pkt);
167  }
168 
170  {
171  return mon.recvAtomic(pkt);
172  }
173 
175  {
176  return mon.recvTimingReq(pkt);
177  }
178 
180  {
181  return mon.recvTimingSnoopResp(pkt);
182  }
183 
185  {
186  return mon.getAddrRanges();
187  }
188 
190  {
191  mon.recvRespRetry();
192  }
193 
194  private:
195 
197 
198  };
199 
202 
203  void recvFunctional(PacketPtr pkt);
204 
205  void recvFunctionalSnoop(PacketPtr pkt);
206 
208 
210 
211  bool recvTimingReq(PacketPtr pkt);
212 
213  bool recvTimingResp(PacketPtr pkt);
214 
215  void recvTimingSnoopReq(PacketPtr pkt);
216 
217  bool recvTimingSnoopResp(PacketPtr pkt);
218 
220 
221  bool isSnooping() const;
222 
223  void recvReqRetry();
224 
225  void recvRespRetry();
226 
227  void recvRangeChange();
228 
229  bool warnOnly;
230 
232 };
233 
234 } // namespace gem5
235 
236 #endif //__MEM_MEM_CHECKER_MONITOR_HH__
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::MemCheckerMonitor::MemCheckerMonitorSenderState::serial
MemChecker::Serial serial
Definition: mem_checker_monitor.hh:83
gem5::MemCheckerMonitor::memSidePort
MonitorRequestPort memSidePort
Instance of request port, facing the memory side.
Definition: mem_checker_monitor.hh:145
gem5::MemCheckerMonitor::MonitorRequestPort::recvReqRetry
void recvReqRetry()
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
Definition: mem_checker_monitor.hh:133
gem5::MemCheckerMonitor::getAddrRanges
AddrRangeList getAddrRanges() const
Definition: mem_checker_monitor.cc:335
gem5::MemCheckerMonitor::MonitorRequestPort::MonitorRequestPort
MonitorRequestPort(const std::string &_name, MemCheckerMonitor &_mon)
Definition: mem_checker_monitor.hh:97
gem5::MemCheckerMonitor::MonitorResponsePort::getAddrRanges
AddrRangeList getAddrRanges() const
Get a list of the non-overlapping address ranges the owner is responsible for.
Definition: mem_checker_monitor.hh:184
gem5::MemCheckerMonitor::recvTimingSnoopResp
bool recvTimingSnoopResp(PacketPtr pkt)
Definition: mem_checker_monitor.cc:322
system.hh
gem5::MemCheckerMonitor::memchecker
MemChecker * memchecker
Definition: mem_checker_monitor.hh:231
gem5::MemCheckerMonitor::MonitorRequestPort::recvRangeChange
void recvRangeChange()
Called to receive an address range change from the peer response port.
Definition: mem_checker_monitor.hh:123
gem5::MemCheckerMonitor::isSnooping
bool isSnooping() const
Definition: mem_checker_monitor.cc:328
gem5::MemCheckerMonitor::MemCheckerMonitorSenderState
Definition: mem_checker_monitor.hh:77
gem5::MemCheckerMonitor
Implements a MemChecker monitor, to be inserted between two ports.
Definition: mem_checker_monitor.hh:53
gem5::MemCheckerMonitor::MonitorResponsePort::mon
MemCheckerMonitor & mon
Definition: mem_checker_monitor.hh:196
gem5::MemCheckerMonitor::MonitorResponsePort::recvFunctional
void recvFunctional(PacketPtr pkt)
Receive a functional request packet from the peer.
Definition: mem_checker_monitor.hh:164
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::MemCheckerMonitor::cpuSidePort
MonitorResponsePort cpuSidePort
Instance of response port, i.e.
Definition: mem_checker_monitor.hh:201
gem5::MemChecker
MemChecker.
Definition: mem_checker.hh:74
gem5::MemCheckerMonitor::MonitorRequestPort::recvTimingResp
bool recvTimingResp(PacketPtr pkt)
Receive a timing response from the peer.
Definition: mem_checker_monitor.hh:113
gem5::MemCheckerMonitor::warnOnly
bool warnOnly
Definition: mem_checker_monitor.hh:229
gem5::RequestPort
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:77
gem5::MemCheckerMonitor::MonitorRequestPort::recvFunctionalSnoop
void recvFunctionalSnoop(PacketPtr pkt)
Receive a functional snoop request packet from the peer.
Definition: mem_checker_monitor.hh:103
gem5::MemCheckerMonitor::recvFunctionalSnoop
void recvFunctionalSnoop(PacketPtr pkt)
Definition: mem_checker_monitor.cc:100
gem5::MemCheckerMonitor::Params
MemCheckerMonitorParams Params
Parameters of memchecker monitor.
Definition: mem_checker_monitor.hh:58
gem5::MemCheckerMonitor::MonitorResponsePort
This is the response port of the communication monitor.
Definition: mem_checker_monitor.hh:153
gem5::MemCheckerMonitor::recvTimingReq
bool recvTimingReq(PacketPtr pkt)
Definition: mem_checker_monitor.cc:128
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
gem5::MemCheckerMonitor::MonitorRequestPort::recvTimingSnoopReq
void recvTimingSnoopReq(PacketPtr pkt)
Receive a timing snoop request from the peer.
Definition: mem_checker_monitor.hh:118
sim_object.hh
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::MemCheckerMonitor::MonitorRequestPort::isSnooping
bool isSnooping() const
Determine if this request port is snooping or not.
Definition: mem_checker_monitor.hh:128
statistics.hh
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::MemCheckerMonitor::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: mem_checker_monitor.cc:62
gem5::MemCheckerMonitor::MonitorRequestPort::recvAtomicSnoop
Tick recvAtomicSnoop(PacketPtr pkt)
Receive an atomic snoop request packet from our peer.
Definition: mem_checker_monitor.hh:108
gem5::MemCheckerMonitor::MonitorResponsePort::recvRespRetry
void recvRespRetry()
Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called...
Definition: mem_checker_monitor.hh:189
mem_checker.hh
gem5::MemCheckerMonitor::recvAtomicSnoop
Tick recvAtomicSnoop(PacketPtr pkt)
Definition: mem_checker_monitor.cc:122
gem5::MemCheckerMonitor::MemCheckerMonitorSenderState::MemCheckerMonitorSenderState
MemCheckerMonitorSenderState(MemChecker::Serial _serial)
Definition: mem_checker_monitor.hh:79
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::MemCheckerMonitor::~MemCheckerMonitor
~MemCheckerMonitor()
Destructor.
Definition: mem_checker_monitor.cc:58
gem5::Packet::SenderState
A virtual base opaque structure used to hold state associated with the packet (e.g....
Definition: packet.hh:457
gem5::MemCheckerMonitor::recvTimingSnoopReq
void recvTimingSnoopReq(PacketPtr pkt)
Definition: mem_checker_monitor.cc:316
gem5::MemCheckerMonitor::MonitorResponsePort::MonitorResponsePort
MonitorResponsePort(const std::string &_name, MemCheckerMonitor &_mon)
Definition: mem_checker_monitor.hh:158
gem5::MemCheckerMonitor::recvFunctional
void recvFunctional(PacketPtr pkt)
Definition: mem_checker_monitor.cc:82
gem5::MemCheckerMonitor::MonitorResponsePort::recvTimingReq
bool recvTimingReq(PacketPtr pkt)
Receive a timing request from the peer.
Definition: mem_checker_monitor.hh:174
gem5::ResponsePort
A ResponsePort is a specialization of a port.
Definition: port.hh:268
gem5::MemCheckerMonitor::MemCheckerMonitor
MemCheckerMonitor(const Params &params)
Constructor based on the Python params.
Definition: mem_checker_monitor.cc:50
gem5::MemCheckerMonitor::MonitorRequestPort::mon
MemCheckerMonitor & mon
Definition: mem_checker_monitor.hh:140
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
gem5::MemCheckerMonitor::MonitorResponsePort::recvAtomic
Tick recvAtomic(PacketPtr pkt)
Receive an atomic request packet from the peer.
Definition: mem_checker_monitor.hh:169
gem5::MemCheckerMonitor::recvReqRetry
void recvReqRetry()
Definition: mem_checker_monitor.cc:342
gem5::MemCheckerMonitor::MonitorResponsePort::recvTimingSnoopResp
bool recvTimingSnoopResp(PacketPtr pkt)
Receive a timing snoop response from the peer.
Definition: mem_checker_monitor.hh:179
gem5::MemCheckerMonitor::MonitorRequestPort
This is the request port of the communication monitor.
Definition: mem_checker_monitor.hh:92
gem5::MemCheckerMonitor::getPort
Port & getPort(const std::string &if_name, PortID idx=InvalidPortID) override
Get a port with a given name and index.
Definition: mem_checker_monitor.cc:70
std::list< AddrRange >
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::MemCheckerMonitor::recvTimingResp
bool recvTimingResp(PacketPtr pkt)
Definition: mem_checker_monitor.cc:220
gem5::MemCheckerMonitor::recvAtomic
Tick recvAtomic(PacketPtr pkt)
Definition: mem_checker_monitor.cc:116
gem5::MemCheckerMonitor::recvRespRetry
void recvRespRetry()
Definition: mem_checker_monitor.cc:348
gem5::MemCheckerMonitor::recvRangeChange
void recvRangeChange()
Definition: mem_checker_monitor.cc:354
gem5::Named::_name
const std::string _name
Definition: named.hh:41
gem5::MemChecker::Serial
uint64_t Serial
The Serial type is used to be able to uniquely identify a transaction as it passes through the system...
Definition: mem_checker.hh:82

Generated on Tue Sep 21 2021 12:25:32 for gem5 by doxygen 1.8.17