2 * Copyright (c) 2012-2014 ARM Limited
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.
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.
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.
38 #ifndef __MEM_MEM_CHECKER_MONITOR_HH__
39 #define __MEM_MEM_CHECKER_MONITOR_HH__
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"
48 * Implements a MemChecker monitor, to be inserted between two ports.
50 class MemCheckerMonitor : public SimObject
54 /** Parameters of memchecker monitor */
55 typedef MemCheckerMonitorParams Params;
56 const Params* params() const
57 { return reinterpret_cast<const Params*>(_params); }
60 * Constructor based on the Python params
62 * @param params Python parameters
64 MemCheckerMonitor(Params* params);
69 Port &getPort(const std::string &if_name,
70 PortID idx=InvalidPortID) override;
76 struct MemCheckerMonitorSenderState : public Packet::SenderState
78 MemCheckerMonitorSenderState(MemChecker::Serial _serial)
82 MemChecker::Serial serial;
86 * This is the request port of the communication monitor. All recv
87 * functions call a function in MemCheckerMonitor, where the
88 * send function of the response port is called. Besides this, these
89 * functions can also perform actions for capturing statistics.
91 class MonitorRequestPort : public RequestPort
96 MonitorRequestPort(const std::string& _name, MemCheckerMonitor& _mon)
97 : RequestPort(_name, &_mon), mon(_mon)
102 void recvFunctionalSnoop(PacketPtr pkt)
104 mon.recvFunctionalSnoop(pkt);
107 Tick recvAtomicSnoop(PacketPtr pkt)
109 return mon.recvAtomicSnoop(pkt);
112 bool recvTimingResp(PacketPtr pkt)
114 return mon.recvTimingResp(pkt);
117 void recvTimingSnoopReq(PacketPtr pkt)
119 mon.recvTimingSnoopReq(pkt);
122 void recvRangeChange()
124 mon.recvRangeChange();
127 bool isSnooping() const
129 return mon.isSnooping();
139 MemCheckerMonitor& mon;
143 /** Instance of request port, facing the memory side */
144 MonitorRequestPort memSidePort;
147 * This is the response port of the communication monitor. All recv
148 * functions call a function in MemCheckerMonitor, where the
149 * send function of the request port is called. Besides this, these
150 * functions can also perform actions for capturing statistics.
152 class MonitorResponsePort : public ResponsePort
157 MonitorResponsePort(const std::string& _name, MemCheckerMonitor& _mon)
158 : ResponsePort(_name, &_mon), mon(_mon)
163 void recvFunctional(PacketPtr pkt)
165 mon.recvFunctional(pkt);
168 Tick recvAtomic(PacketPtr pkt)
170 return mon.recvAtomic(pkt);
173 bool recvTimingReq(PacketPtr pkt)
175 return mon.recvTimingReq(pkt);
178 bool recvTimingSnoopResp(PacketPtr pkt)
180 return mon.recvTimingSnoopResp(pkt);
183 AddrRangeList getAddrRanges() const
185 return mon.getAddrRanges();
195 MemCheckerMonitor& mon;
199 /** Instance of response port, i.e. on the CPU side */
200 MonitorResponsePort cpuSidePort;
202 void recvFunctional(PacketPtr pkt);
204 void recvFunctionalSnoop(PacketPtr pkt);
206 Tick recvAtomic(PacketPtr pkt);
208 Tick recvAtomicSnoop(PacketPtr pkt);
210 bool recvTimingReq(PacketPtr pkt);
212 bool recvTimingResp(PacketPtr pkt);
214 void recvTimingSnoopReq(PacketPtr pkt);
216 bool recvTimingSnoopResp(PacketPtr pkt);
218 AddrRangeList getAddrRanges() const;
220 bool isSnooping() const;
224 void recvRespRetry();
226 void recvRangeChange();
230 MemChecker *memchecker;
233 #endif //__MEM_MEM_CHECKER_MONITOR_HH__