mem_sink.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2020 ARM Limited
 * 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_QOS_MEM_SINK_HH__
#define __MEM_QOS_MEM_SINK_HH__
 
#include <cstdint>
#include <deque>
#include <vector>
 
#include "base/compiler.hh"
#include "base/types.hh"
#include "mem/abstract_mem.hh"
#include "mem/qos/mem_ctrl.hh"
#include "mem/qport.hh"
#include "params/QoSMemSinkCtrl.hh"
#include "sim/eventq.hh"
 
namespace gem5
{
 
struct QoSMemSinkInterfaceParams;
 
namespace memory
{
 
namespace qos
{
 
class MemSinkInterface;

class MemSinkCtrl : public MemCtrl
{
  protected:
    using PacketQueue = std::deque<PacketPtr>;
 
  private:
    class MemoryPort : public QueuedResponsePort
    {
      private:
        MemSinkCtrl& mem;

        RespPacketQueue queue;
 
      public:
        MemoryPort(const std::string&, MemSinkCtrl&);
 
      protected:
        Tick recvAtomic(PacketPtr pkt);

        void recvFunctional(PacketPtr pkt);

        bool recvTimingReq(PacketPtr pkt);

        AddrRangeList getAddrRanges() const;
 
    };
 
  public:
    MemSinkCtrl(const QoSMemSinkCtrlParams &);
 
    virtual ~MemSinkCtrl();

    DrainState drain() override;

    Port &getPort(const std::string &if_name, PortID=InvalidPortID) override;

    void init() override;
 
  protected:
    const Tick requestLatency;

    const Tick responseLatency;

    const uint64_t memoryPacketSize;

    const uint64_t readBufferSize;

    const uint64_t writeBufferSize;

    MemoryPort port;

    MemSinkInterface* const interface;

    bool retryRdReq;

    bool retryWrReq;

    Tick nextRequest;
 
    struct MemSinkCtrlStats : public statistics::Group
    {
        MemSinkCtrlStats(statistics::Group *parent);

        statistics::Scalar numReadRetries;

        statistics::Scalar numWriteRetries;
    };

    std::vector<PacketQueue> readQueue;

    std::vector<PacketQueue> writeQueue;

    void processNextReqEvent();

    MemberEventWrapper<&MemSinkCtrl::processNextReqEvent> nextReqEvent;

    inline bool readQueueFull(const uint64_t packets) const;

    inline bool writeQueueFull(const uint64_t packets) const;

    Tick recvAtomic(PacketPtr pkt);

    void recvFunctional(PacketPtr pkt);

    bool recvTimingReq(PacketPtr pkt);
 
    MemSinkCtrlStats stats;
};
 
class MemSinkInterface : public AbstractMemory
{
  public:
    void setMemCtrl(MemSinkCtrl* _ctrl) { ctrl = _ctrl; };

    MemSinkCtrl* ctrl;
 
    MemSinkInterface(const QoSMemSinkInterfaceParams &_p);
};
 
} // namespace qos
} // namespace memory
} // namespace gem5
 
#endif // __MEM_QOS_MEM_SINK_HH__