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;
59 return reinterpret_cast<const Params &>(_params);
63 * Constructor based on the Python params
65 * @param params Python parameters
67 MemCheckerMonitor(const Params ¶ms);
72 Port &getPort(const std::string &if_name,
73 PortID idx=InvalidPortID) override;
79 struct MemCheckerMonitorSenderState : public Packet::SenderState
81 MemCheckerMonitorSenderState(MemChecker::Serial _serial)
85 MemChecker::Serial serial;
89 * This is the request port of the communication monitor. All recv
90 * functions call a function in MemCheckerMonitor, where the
91 * send function of the response port is called. Besides this, these
92 * functions can also perform actions for capturing statistics.
94 class MonitorRequestPort : public RequestPort
99 MonitorRequestPort(const std::string& _name, MemCheckerMonitor& _mon)
100 : RequestPort(_name, &_mon), mon(_mon)
105 void recvFunctionalSnoop(PacketPtr pkt)
107 mon.recvFunctionalSnoop(pkt);
110 Tick recvAtomicSnoop(PacketPtr pkt)
112 return mon.recvAtomicSnoop(pkt);
115 bool recvTimingResp(PacketPtr pkt)
117 return mon.recvTimingResp(pkt);
120 void recvTimingSnoopReq(PacketPtr pkt)
122 mon.recvTimingSnoopReq(pkt);
125 void recvRangeChange()
127 mon.recvRangeChange();
130 bool isSnooping() const
132 return mon.isSnooping();
142 MemCheckerMonitor& mon;
146 /** Instance of request port, facing the memory side */
147 MonitorRequestPort memSidePort;
150 * This is the response port of the communication monitor. All recv
151 * functions call a function in MemCheckerMonitor, where the
152 * send function of the request port is called. Besides this, these
153 * functions can also perform actions for capturing statistics.
155 class MonitorResponsePort : public ResponsePort
160 MonitorResponsePort(const std::string& _name, MemCheckerMonitor& _mon)
161 : ResponsePort(_name, &_mon), mon(_mon)
166 void recvFunctional(PacketPtr pkt)
168 mon.recvFunctional(pkt);
171 Tick recvAtomic(PacketPtr pkt)
173 return mon.recvAtomic(pkt);
176 bool recvTimingReq(PacketPtr pkt)
178 return mon.recvTimingReq(pkt);
181 bool recvTimingSnoopResp(PacketPtr pkt)
183 return mon.recvTimingSnoopResp(pkt);
186 AddrRangeList getAddrRanges() const
188 return mon.getAddrRanges();
198 MemCheckerMonitor& mon;
202 /** Instance of response port, i.e. on the CPU side */
203 MonitorResponsePort cpuSidePort;
205 void recvFunctional(PacketPtr pkt);
207 void recvFunctionalSnoop(PacketPtr pkt);
209 Tick recvAtomic(PacketPtr pkt);
211 Tick recvAtomicSnoop(PacketPtr pkt);
213 bool recvTimingReq(PacketPtr pkt);
215 bool recvTimingResp(PacketPtr pkt);
217 void recvTimingSnoopReq(PacketPtr pkt);
219 bool recvTimingSnoopResp(PacketPtr pkt);
221 AddrRangeList getAddrRanges() const;
223 bool isSnooping() const;
227 void recvRespRetry();
229 void recvRangeChange();
233 MemChecker *memchecker;
236 #endif //__MEM_MEM_CHECKER_MONITOR_HH__