dramsim3.hh

Go to the documentation of this file.

/*
 * Copyright (c) 2013 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_DRAMSIM3_HH__
#define __MEM_DRAMSIM3_HH__
 
#include <functional>
#include <queue>
#include <unordered_map>
 
#include "mem/abstract_mem.hh"
#include "mem/dramsim3_wrapper.hh"
#include "mem/qport.hh"
#include "params/DRAMsim3.hh"
 
namespace gem5
{
 
namespace memory
{
 
class DRAMsim3 : public AbstractMemory
{
  private:
 
    class MemoryPort : public ResponsePort
    {
 
      private:
 
        DRAMsim3& mem;
 
      public:
 
        MemoryPort(const std::string& _name, DRAMsim3& _memory);
 
      protected:
 
        Tick recvAtomic(PacketPtr pkt);
 
        void recvFunctional(PacketPtr pkt);
 
        bool recvTimingReq(PacketPtr pkt);
 
        void recvRespRetry();
 
        AddrRangeList getAddrRanges() const;
 
    };
 
    MemoryPort port;
 
    std::function<void(uint64_t)> read_cb;
    std::function<void(uint64_t)> write_cb;
 
    DRAMsim3Wrapper wrapper;
 
    bool retryReq;
 
    bool retryResp;
 
    Tick startTick;
 
    std::unordered_map<Addr, std::queue<PacketPtr> > outstandingReads;
    std::unordered_map<Addr, std::queue<PacketPtr> > outstandingWrites;
 
    unsigned int nbrOutstandingReads;
    unsigned int nbrOutstandingWrites;
 
    std::deque<PacketPtr> responseQueue;
 
 
    unsigned int nbrOutstanding() const;
 
    void accessAndRespond(PacketPtr pkt);
 
    void sendResponse();
 
    EventFunctionWrapper sendResponseEvent;
 
    void tick();
 
    EventFunctionWrapper tickEvent;
 
    std::unique_ptr<Packet> pendingDelete;
 
  public:
 
    typedef DRAMsim3Params Params;
    DRAMsim3(const Params &p);
 
    void readComplete(unsigned id, uint64_t addr);
 
    void writeComplete(unsigned id, uint64_t addr);
 
    DrainState drain() override;
 
    virtual Port& getPort(const std::string& if_name,
                          PortID idx = InvalidPortID) override;
 
    void init() override;
    void startup() override;
 
    void resetStats() override;
 
  protected:
 
    Tick recvAtomic(PacketPtr pkt);
    void recvFunctional(PacketPtr pkt);
    bool recvTimingReq(PacketPtr pkt);
    void recvRespRetry();
 
};
 
} // namespace memory
} // namespace gem5
 
#endif // __MEM_DRAMSIM3_HH__