comm_monitor.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2013, 2015, 2018-2019 ARM Limited
 * Copyright (c) 2016 Google Inc.
 * Copyright (c) 2017, Centre National de la Recherche Scientifique
 * All rights reserved.
 *
 * The license below extends only to copyright in the software and shall
 * not be construed as granting a license to any other intellectual
 * property including but not limited to intellectual property relating
 * to a hardware implementation of the functionality of the software
 * licensed hereunder.  You may use the software subject to the license
 * terms below provided that you ensure that this notice is replicated
 * unmodified and in its entirety in all distributions of the software,
 * modified or unmodified, in source code or in binary form.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __MEM_COMM_MONITOR_HH__
#define __MEM_COMM_MONITOR_HH__
 
#include "base/statistics.hh"
#include "mem/port.hh"
#include "params/CommMonitor.hh"
#include "sim/probe/mem.hh"
#include "sim/sim_object.hh"
 
namespace gem5
{
 
class CommMonitor : public SimObject
{
 
  public: // Construction & SimObject interfaces
 
    using Params = CommMonitorParams;
 
    CommMonitor(const Params &params);
 
    void init() override;
    void startup() override;
    void regProbePoints() override;
 
  public: // SimObject interfaces
    Port &getPort(const std::string &if_name,
                  PortID idx=InvalidPortID) override;
 
  private:
 
    class CommMonitorSenderState : public Packet::SenderState
    {
 
      public:
 
        CommMonitorSenderState(Tick _transmitTime)
            : transmitTime(_transmitTime)
        { }
 
        ~CommMonitorSenderState() { }
 
        Tick transmitTime;
 
    };
 
    class MonitorRequestPort : public RequestPort
    {
 
      public:
 
        MonitorRequestPort(const std::string& _name, CommMonitor& _mon)
            : RequestPort(_name, &_mon), mon(_mon)
        { }
 
      protected:
 
        void recvFunctionalSnoop(PacketPtr pkt)
        {
            mon.recvFunctionalSnoop(pkt);
        }
 
        Tick recvAtomicSnoop(PacketPtr pkt)
        {
            return mon.recvAtomicSnoop(pkt);
        }
 
        bool recvTimingResp(PacketPtr pkt)
        {
            return mon.recvTimingResp(pkt);
        }
 
        void recvTimingSnoopReq(PacketPtr pkt)
        {
            mon.recvTimingSnoopReq(pkt);
        }
 
        void recvRangeChange()
        {
            mon.recvRangeChange();
        }
 
        bool isSnooping() const
        {
            return mon.isSnooping();
        }
 
        void recvReqRetry()
        {
            mon.recvReqRetry();
        }
 
        void recvRetrySnoopResp()
        {
            mon.recvRetrySnoopResp();
        }
 
      private:
 
        CommMonitor& mon;
 
    };
 
    MonitorRequestPort memSidePort;
 
    class MonitorResponsePort : public ResponsePort
    {
 
      public:
 
        MonitorResponsePort(const std::string& _name, CommMonitor& _mon)
            : ResponsePort(_name, &_mon), mon(_mon)
        { }
 
      protected:
 
        void recvFunctional(PacketPtr pkt)
        {
            mon.recvFunctional(pkt);
        }
 
        Tick recvAtomic(PacketPtr pkt)
        {
            return mon.recvAtomic(pkt);
        }
 
        bool recvTimingReq(PacketPtr pkt)
        {
            return mon.recvTimingReq(pkt);
        }
 
        bool recvTimingSnoopResp(PacketPtr pkt)
        {
            return mon.recvTimingSnoopResp(pkt);
        }
 
        AddrRangeList getAddrRanges() const
        {
            return mon.getAddrRanges();
        }
 
        void recvRespRetry()
        {
            mon.recvRespRetry();
        }
 
        bool tryTiming(PacketPtr pkt)
        {
            return mon.tryTiming(pkt);
        }
 
      private:
 
        CommMonitor& mon;
 
    };
 
    MonitorResponsePort cpuSidePort;
 
    void recvFunctional(PacketPtr pkt);
 
    void recvFunctionalSnoop(PacketPtr pkt);
 
    Tick recvAtomic(PacketPtr pkt);
 
    Tick recvAtomicSnoop(PacketPtr pkt);
 
    bool recvTimingReq(PacketPtr pkt);
 
    bool recvTimingResp(PacketPtr pkt);
 
    void recvTimingSnoopReq(PacketPtr pkt);
 
    bool recvTimingSnoopResp(PacketPtr pkt);
 
    void recvRetrySnoopResp();
 
    AddrRangeList getAddrRanges() const;
 
    bool isSnooping() const;
 
    void recvReqRetry();
 
    void recvRespRetry();
 
    void recvRangeChange();
 
    bool tryTiming(PacketPtr pkt);
 
    struct MonitorStats : public statistics::Group
    {
        bool disableBurstLengthHists;
 
        statistics::Histogram readBurstLengthHist;
 
        statistics::Histogram writeBurstLengthHist;
 
        bool disableBandwidthHists;
 
        unsigned int readBytes;
        statistics::Histogram readBandwidthHist;
        statistics::Scalar totalReadBytes;
        statistics::Formula averageReadBandwidth;
 
        unsigned int writtenBytes;
        statistics::Histogram writeBandwidthHist;
        statistics::Scalar totalWrittenBytes;
        statistics::Formula averageWriteBandwidth;
 
        bool disableLatencyHists;
 
        statistics::Histogram readLatencyHist;
 
        statistics::Histogram writeLatencyHist;
 
        bool disableITTDists;
 
        statistics::Distribution ittReadRead;
        statistics::Distribution ittWriteWrite;
        statistics::Distribution ittReqReq;
        Tick timeOfLastRead;
        Tick timeOfLastWrite;
        Tick timeOfLastReq;
 
        bool disableOutstandingHists;
 
        statistics::Histogram outstandingReadsHist;
        unsigned int outstandingReadReqs;
 
        statistics::Histogram outstandingWritesHist;
        unsigned int outstandingWriteReqs;
 
        bool disableTransactionHists;
 
        statistics::Histogram readTransHist;
        unsigned int readTrans;
 
        statistics::Histogram writeTransHist;
        unsigned int writeTrans;
 
        bool disableAddrDists;
 
        const Addr readAddrMask;
 
        const Addr writeAddrMask;
 
        statistics::SparseHistogram readAddrDist;
 
        statistics::SparseHistogram writeAddrDist;
 
        MonitorStats(statistics::Group *parent,
            const CommMonitorParams &params);
 
        void updateReqStats(const probing::PacketInfo& pkt, bool is_atomic,
                            bool expects_response);
        void updateRespStats(const probing::PacketInfo& pkt, Tick latency,
                             bool is_atomic);
    };
 
    void samplePeriodic();
 
    EventFunctionWrapper samplePeriodicEvent;
 
    const Tick samplePeriodTicks;
    const double samplePeriod;
 
    MonitorStats stats;
 
  protected: // Probe points
    probing::PacketUPtr ppPktReq;
 
    probing::PacketUPtr ppPktResp;
 
};
 
} // namespace gem5
 
#endif //__MEM_COMM_MONITOR_HH__