src/mem/mem_checker_monitor.hh

   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 /**
  48  * Implements a MemChecker monitor, to be inserted between two ports.
  49  */
  50 class MemCheckerMonitor : public SimObject
  51 {
  52   public:
  53
  54     /** Parameters of memchecker monitor */
  55     typedef MemCheckerMonitorParams Params;
  56     const Params &
  57     params() const
  58     {
  59         return reinterpret_cast<const Params &>(_params);
  60     }
  61
  62     /**
  63      * Constructor based on the Python params
  64      *
  65      * @param params Python parameters
  66      */
  67     MemCheckerMonitor(const Params &params);
  68
  69     /** Destructor */
  70     ~MemCheckerMonitor();
  71
  72     Port &getPort(const std::string &if_name,
  73                   PortID idx=InvalidPortID) override;
  74
  75     void init() override;
  76
  77   private:
  78
  79     struct MemCheckerMonitorSenderState : public Packet::SenderState
  80     {
  81         MemCheckerMonitorSenderState(MemChecker::Serial _serial)
  82             : serial(_serial)
  83         {}
  84
  85         MemChecker::Serial serial;
  86     };
  87
  88     /**
  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.
  93      */
  94     class MonitorRequestPort : public RequestPort
  95     {
  96
  97       public:
  98
  99         MonitorRequestPort(const std::string& _name, MemCheckerMonitor& _mon)
 100             : RequestPort(_name, &_mon), mon(_mon)
 101         { }
 102
 103       protected:
 104
 105         void recvFunctionalSnoop(PacketPtr pkt)
 106         {
 107             mon.recvFunctionalSnoop(pkt);
 108         }
 109
 110         Tick recvAtomicSnoop(PacketPtr pkt)
 111         {
 112             return mon.recvAtomicSnoop(pkt);
 113         }
 114
 115         bool recvTimingResp(PacketPtr pkt)
 116         {
 117             return mon.recvTimingResp(pkt);
 118         }
 119
 120         void recvTimingSnoopReq(PacketPtr pkt)
 121         {
 122             mon.recvTimingSnoopReq(pkt);
 123         }
 124
 125         void recvRangeChange()
 126         {
 127             mon.recvRangeChange();
 128         }
 129
 130         bool isSnooping() const
 131         {
 132             return mon.isSnooping();
 133         }
 134
 135         void recvReqRetry()
 136         {
 137             mon.recvReqRetry();
 138         }
 139
 140       private:
 141
 142         MemCheckerMonitor& mon;
 143
 144     };
 145
 146     /** Instance of request port, facing the memory side */
 147     MonitorRequestPort memSidePort;
 148
 149     /**
 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.
 154      */
 155     class MonitorResponsePort : public ResponsePort
 156     {
 157
 158       public:
 159
 160         MonitorResponsePort(const std::string& _name, MemCheckerMonitor& _mon)
 161             : ResponsePort(_name, &_mon), mon(_mon)
 162         { }
 163
 164       protected:
 165
 166         void recvFunctional(PacketPtr pkt)
 167         {
 168             mon.recvFunctional(pkt);
 169         }
 170
 171         Tick recvAtomic(PacketPtr pkt)
 172         {
 173             return mon.recvAtomic(pkt);
 174         }
 175
 176         bool recvTimingReq(PacketPtr pkt)
 177         {
 178             return mon.recvTimingReq(pkt);
 179         }
 180
 181         bool recvTimingSnoopResp(PacketPtr pkt)
 182         {
 183             return mon.recvTimingSnoopResp(pkt);
 184         }
 185
 186         AddrRangeList getAddrRanges() const
 187         {
 188             return mon.getAddrRanges();
 189         }
 190
 191         void recvRespRetry()
 192         {
 193             mon.recvRespRetry();
 194         }
 195
 196       private:
 197
 198         MemCheckerMonitor& mon;
 199
 200     };
 201
 202     /** Instance of response port, i.e. on the CPU side */
 203     MonitorResponsePort cpuSidePort;
 204
 205     void recvFunctional(PacketPtr pkt);
 206
 207     void recvFunctionalSnoop(PacketPtr pkt);
 208
 209     Tick recvAtomic(PacketPtr pkt);
 210
 211     Tick recvAtomicSnoop(PacketPtr pkt);
 212
 213     bool recvTimingReq(PacketPtr pkt);
 214
 215     bool recvTimingResp(PacketPtr pkt);
 216
 217     void recvTimingSnoopReq(PacketPtr pkt);
 218
 219     bool recvTimingSnoopResp(PacketPtr pkt);
 220
 221     AddrRangeList getAddrRanges() const;
 222
 223     bool isSnooping() const;
 224
 225     void recvReqRetry();
 226
 227     void recvRespRetry();
 228
 229     void recvRangeChange();
 230
 231     bool warnOnly;
 232
 233     MemChecker *memchecker;
 234 };
 235
 236 #endif //__MEM_MEM_CHECKER_MONITOR_HH__