RubyPort.hh revision 11266
16876Ssteve.reinhardt@amd.com/* 210089Sandreas.hansson@arm.com * Copyright (c) 2012-2013 ARM Limited 38922Swilliam.wang@arm.com * All rights reserved. 48922Swilliam.wang@arm.com * 58922Swilliam.wang@arm.com * The license below extends only to copyright in the software and shall 68922Swilliam.wang@arm.com * not be construed as granting a license to any other intellectual 78922Swilliam.wang@arm.com * property including but not limited to intellectual property relating 88922Swilliam.wang@arm.com * to a hardware implementation of the functionality of the software 98922Swilliam.wang@arm.com * licensed hereunder. You may use the software subject to the license 108922Swilliam.wang@arm.com * terms below provided that you ensure that this notice is replicated 118922Swilliam.wang@arm.com * unmodified and in its entirety in all distributions of the software, 128922Swilliam.wang@arm.com * modified or unmodified, in source code or in binary form. 138922Swilliam.wang@arm.com * 1411266SBrad.Beckmann@amd.com * Copyright (c) 2009-2013 Advanced Micro Devices, Inc. 158717Snilay@cs.wisc.edu * Copyright (c) 2011 Mark D. Hill and David A. Wood 166876Ssteve.reinhardt@amd.com * All rights reserved. 176876Ssteve.reinhardt@amd.com * 186876Ssteve.reinhardt@amd.com * Redistribution and use in source and binary forms, with or without 196876Ssteve.reinhardt@amd.com * modification, are permitted provided that the following conditions are 206876Ssteve.reinhardt@amd.com * met: redistributions of source code must retain the above copyright 216876Ssteve.reinhardt@amd.com * notice, this list of conditions and the following disclaimer; 226876Ssteve.reinhardt@amd.com * redistributions in binary form must reproduce the above copyright 236876Ssteve.reinhardt@amd.com * notice, this list of conditions and the following disclaimer in the 246876Ssteve.reinhardt@amd.com * documentation and/or other materials provided with the distribution; 256876Ssteve.reinhardt@amd.com * neither the name of the copyright holders nor the names of its 266876Ssteve.reinhardt@amd.com * contributors may be used to endorse or promote products derived from 276876Ssteve.reinhardt@amd.com * this software without specific prior written permission. 286876Ssteve.reinhardt@amd.com * 296876Ssteve.reinhardt@amd.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 306876Ssteve.reinhardt@amd.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 316876Ssteve.reinhardt@amd.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 326876Ssteve.reinhardt@amd.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 336876Ssteve.reinhardt@amd.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 346876Ssteve.reinhardt@amd.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 356876Ssteve.reinhardt@amd.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 366876Ssteve.reinhardt@amd.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 376876Ssteve.reinhardt@amd.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 386876Ssteve.reinhardt@amd.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 396876Ssteve.reinhardt@amd.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 406876Ssteve.reinhardt@amd.com */ 416876Ssteve.reinhardt@amd.com 427039Snate@binkert.org#ifndef __MEM_RUBY_SYSTEM_RUBYPORT_HH__ 437039Snate@binkert.org#define __MEM_RUBY_SYSTEM_RUBYPORT_HH__ 446285Snate@binkert.org 457039Snate@binkert.org#include <cassert> 466285Snate@binkert.org#include <string> 476285Snate@binkert.org 486922SBrad.Beckmann@amd.com#include "mem/protocol/RequestStatus.hh" 4910301Snilay@cs.wisc.edu#include "mem/ruby/network/MessageBuffer.hh" 5011108Sdavid.hashe@amd.com#include "mem/ruby/system/RubySystem.hh" 518229Snate@binkert.org#include "mem/mem_object.hh" 527039Snate@binkert.org#include "mem/tport.hh" 536876Ssteve.reinhardt@amd.com#include "params/RubyPort.hh" 546876Ssteve.reinhardt@amd.com 556876Ssteve.reinhardt@amd.comclass AbstractController; 566876Ssteve.reinhardt@amd.com 577039Snate@binkert.orgclass RubyPort : public MemObject 587039Snate@binkert.org{ 597039Snate@binkert.org public: 6010090Snilay@cs.wisc.edu class MemMasterPort : public QueuedMasterPort 6110090Snilay@cs.wisc.edu { 6210090Snilay@cs.wisc.edu private: 6310713Sandreas.hansson@arm.com ReqPacketQueue reqQueue; 6410713Sandreas.hansson@arm.com SnoopRespPacketQueue snoopRespQueue; 6510090Snilay@cs.wisc.edu 6610090Snilay@cs.wisc.edu public: 6710090Snilay@cs.wisc.edu MemMasterPort(const std::string &_name, RubyPort *_port); 6810090Snilay@cs.wisc.edu 6910090Snilay@cs.wisc.edu protected: 7010090Snilay@cs.wisc.edu bool recvTimingResp(PacketPtr pkt); 7110090Snilay@cs.wisc.edu void recvRangeChange() {} 7210090Snilay@cs.wisc.edu }; 7310090Snilay@cs.wisc.edu 7410090Snilay@cs.wisc.edu class MemSlavePort : public QueuedSlavePort 756882SBrad.Beckmann@amd.com { 767039Snate@binkert.org private: 7710713Sandreas.hansson@arm.com RespPacketQueue queue; 7810525Snilay@cs.wisc.edu bool access_backing_store; 7911266SBrad.Beckmann@amd.com bool no_retry_on_stall; 806882SBrad.Beckmann@amd.com 816882SBrad.Beckmann@amd.com public: 8210090Snilay@cs.wisc.edu MemSlavePort(const std::string &_name, RubyPort *_port, 8311266SBrad.Beckmann@amd.com bool _access_backing_store, 8411266SBrad.Beckmann@amd.com PortID id, bool _no_retry_on_stall); 856882SBrad.Beckmann@amd.com void hitCallback(PacketPtr pkt); 8611025Snilay@cs.wisc.edu void evictionCallback(Addr address); 876882SBrad.Beckmann@amd.com 886882SBrad.Beckmann@amd.com protected: 8910089Sandreas.hansson@arm.com bool recvTimingReq(PacketPtr pkt); 9010090Snilay@cs.wisc.edu 9110090Snilay@cs.wisc.edu Tick recvAtomic(PacketPtr pkt) 9210090Snilay@cs.wisc.edu { panic("RubyPort::MemSlavePort::recvAtomic() not implemented!\n"); } 9310090Snilay@cs.wisc.edu 9410089Sandreas.hansson@arm.com void recvFunctional(PacketPtr pkt); 9510090Snilay@cs.wisc.edu 9610090Snilay@cs.wisc.edu AddrRangeList getAddrRanges() const 9710090Snilay@cs.wisc.edu { AddrRangeList ranges; return ranges; } 986882SBrad.Beckmann@amd.com 9911266SBrad.Beckmann@amd.com void addToRetryList(); 10011266SBrad.Beckmann@amd.com 1016882SBrad.Beckmann@amd.com private: 10210089Sandreas.hansson@arm.com bool isPhysMemAddress(Addr addr) const; 1036882SBrad.Beckmann@amd.com }; 1046882SBrad.Beckmann@amd.com 10510090Snilay@cs.wisc.edu class PioMasterPort : public QueuedMasterPort 1066882SBrad.Beckmann@amd.com { 1077039Snate@binkert.org private: 10810713Sandreas.hansson@arm.com ReqPacketQueue reqQueue; 10910713Sandreas.hansson@arm.com SnoopRespPacketQueue snoopRespQueue; 1108914Sandreas.hansson@arm.com 1116882SBrad.Beckmann@amd.com public: 11210090Snilay@cs.wisc.edu PioMasterPort(const std::string &_name, RubyPort *_port); 1136882SBrad.Beckmann@amd.com 1146882SBrad.Beckmann@amd.com protected: 11510090Snilay@cs.wisc.edu bool recvTimingResp(PacketPtr pkt); 11610090Snilay@cs.wisc.edu void recvRangeChange(); 1176882SBrad.Beckmann@amd.com }; 1186882SBrad.Beckmann@amd.com 11910090Snilay@cs.wisc.edu class PioSlavePort : public QueuedSlavePort 12010090Snilay@cs.wisc.edu { 12110090Snilay@cs.wisc.edu private: 12210713Sandreas.hansson@arm.com RespPacketQueue queue; 12310090Snilay@cs.wisc.edu 12410090Snilay@cs.wisc.edu public: 12510090Snilay@cs.wisc.edu PioSlavePort(const std::string &_name, RubyPort *_port); 12610090Snilay@cs.wisc.edu 12710090Snilay@cs.wisc.edu protected: 12810090Snilay@cs.wisc.edu bool recvTimingReq(PacketPtr pkt); 12910090Snilay@cs.wisc.edu 13010090Snilay@cs.wisc.edu Tick recvAtomic(PacketPtr pkt) 13110090Snilay@cs.wisc.edu { panic("recvAtomic not supported with ruby!"); } 13210090Snilay@cs.wisc.edu 13310090Snilay@cs.wisc.edu void recvFunctional(PacketPtr pkt) 13410090Snilay@cs.wisc.edu { panic("recvFunctional should never be called on pio slave port!"); } 13510090Snilay@cs.wisc.edu 13610090Snilay@cs.wisc.edu AddrRangeList getAddrRanges() const; 13710090Snilay@cs.wisc.edu }; 13810090Snilay@cs.wisc.edu 13910090Snilay@cs.wisc.edu struct SenderState : public Packet::SenderState 14010090Snilay@cs.wisc.edu { 14110090Snilay@cs.wisc.edu MemSlavePort *port; 14210090Snilay@cs.wisc.edu SenderState(MemSlavePort * _port) : port(_port) 14310090Snilay@cs.wisc.edu {} 14410090Snilay@cs.wisc.edu }; 14510090Snilay@cs.wisc.edu 1466876Ssteve.reinhardt@amd.com typedef RubyPortParams Params; 1476876Ssteve.reinhardt@amd.com RubyPort(const Params *p); 1486882SBrad.Beckmann@amd.com virtual ~RubyPort() {} 1496882SBrad.Beckmann@amd.com 15011169Sandreas.hansson@arm.com void init() override; 1516285Snate@binkert.org 1529294Sandreas.hansson@arm.com BaseMasterPort &getMasterPort(const std::string &if_name, 15311169Sandreas.hansson@arm.com PortID idx = InvalidPortID) override; 1549294Sandreas.hansson@arm.com BaseSlavePort &getSlavePort(const std::string &if_name, 15511169Sandreas.hansson@arm.com PortID idx = InvalidPortID) override; 1566876Ssteve.reinhardt@amd.com 1578615Snilay@cs.wisc.edu virtual RequestStatus makeRequest(PacketPtr pkt) = 0; 1588688Snilay@cs.wisc.edu virtual int outstandingCount() const = 0; 1598688Snilay@cs.wisc.edu virtual bool isDeadlockEventScheduled() const = 0; 1608688Snilay@cs.wisc.edu virtual void descheduleDeadlockEvent() = 0; 1616882SBrad.Beckmann@amd.com 1626882SBrad.Beckmann@amd.com // 1636882SBrad.Beckmann@amd.com // Called by the controller to give the sequencer a pointer. 1646882SBrad.Beckmann@amd.com // A pointer to the controller is needed for atomic support. 1656882SBrad.Beckmann@amd.com // 1666882SBrad.Beckmann@amd.com void setController(AbstractController* _cntrl) { m_controller = _cntrl; } 16710012Snilay@cs.wisc.edu uint32_t getId() { return m_version; } 16811168Sandreas.hansson@arm.com DrainState drain() override; 1696285Snate@binkert.org 1707039Snate@binkert.org protected: 17111266SBrad.Beckmann@amd.com void trySendRetries(); 1727039Snate@binkert.org void ruby_hit_callback(PacketPtr pkt); 1738688Snilay@cs.wisc.edu void testDrainComplete(); 17411025Snilay@cs.wisc.edu void ruby_eviction_callback(Addr address); 1756285Snate@binkert.org 17610089Sandreas.hansson@arm.com /** 17710089Sandreas.hansson@arm.com * Called by the PIO port when receiving a timing response. 17810089Sandreas.hansson@arm.com * 17910089Sandreas.hansson@arm.com * @param pkt Response packet 18010089Sandreas.hansson@arm.com * @param master_port_id Port id of the PIO port 18110089Sandreas.hansson@arm.com * 18210089Sandreas.hansson@arm.com * @return Whether successfully sent 18310089Sandreas.hansson@arm.com */ 18410089Sandreas.hansson@arm.com bool recvTimingResp(PacketPtr pkt, PortID master_port_id); 18510089Sandreas.hansson@arm.com 18610919Sbrandon.potter@amd.com RubySystem *m_ruby_system; 18710012Snilay@cs.wisc.edu uint32_t m_version; 1887039Snate@binkert.org AbstractController* m_controller; 1897039Snate@binkert.org MessageBuffer* m_mandatory_q_ptr; 1907910SBrad.Beckmann@amd.com bool m_usingRubyTester; 19110467Sandreas.hansson@arm.com System* system; 1926876Ssteve.reinhardt@amd.com 1937039Snate@binkert.org private: 19411266SBrad.Beckmann@amd.com bool onRetryList(MemSlavePort * port) 19511266SBrad.Beckmann@amd.com { 19611266SBrad.Beckmann@amd.com return (std::find(retryList.begin(), retryList.end(), port) != 19711266SBrad.Beckmann@amd.com retryList.end()); 19811266SBrad.Beckmann@amd.com } 19910090Snilay@cs.wisc.edu void addToRetryList(MemSlavePort * port) 2007910SBrad.Beckmann@amd.com { 20111266SBrad.Beckmann@amd.com if (onRetryList(port)) return; 20210089Sandreas.hansson@arm.com retryList.push_back(port); 2037910SBrad.Beckmann@amd.com } 2047910SBrad.Beckmann@amd.com 20510090Snilay@cs.wisc.edu PioMasterPort pioMasterPort; 20610090Snilay@cs.wisc.edu PioSlavePort pioSlavePort; 20710090Snilay@cs.wisc.edu MemMasterPort memMasterPort; 20810090Snilay@cs.wisc.edu MemSlavePort memSlavePort; 20910090Snilay@cs.wisc.edu unsigned int gotAddrRanges; 21010090Snilay@cs.wisc.edu 2118922Swilliam.wang@arm.com /** Vector of M5 Ports attached to this Ruby port. */ 21210090Snilay@cs.wisc.edu typedef std::vector<MemSlavePort *>::iterator CpuPortIter; 21310090Snilay@cs.wisc.edu std::vector<MemSlavePort *> slave_ports; 21410090Snilay@cs.wisc.edu std::vector<PioMasterPort *> master_ports; 2158686Snilay@cs.wisc.edu 2167910SBrad.Beckmann@amd.com // 2177910SBrad.Beckmann@amd.com // Based on similar code in the M5 bus. Stores pointers to those ports 2187910SBrad.Beckmann@amd.com // that should be called when the Sequencer becomes available after a stall. 2197910SBrad.Beckmann@amd.com // 22010090Snilay@cs.wisc.edu std::vector<MemSlavePort *> retryList; 2216285Snate@binkert.org}; 2226285Snate@binkert.org 2237039Snate@binkert.org#endif // __MEM_RUBY_SYSTEM_RUBYPORT_HH__ 224