AbstractController.hh revision 10977
17008Snate@binkert.org/* 210524Snilay@cs.wisc.edu * Copyright (c) 2009-2014 Mark D. Hill and David A. Wood 37008Snate@binkert.org * All rights reserved. 47008Snate@binkert.org * 57008Snate@binkert.org * Redistribution and use in source and binary forms, with or without 67008Snate@binkert.org * modification, are permitted provided that the following conditions are 77008Snate@binkert.org * met: redistributions of source code must retain the above copyright 87008Snate@binkert.org * notice, this list of conditions and the following disclaimer; 97008Snate@binkert.org * redistributions in binary form must reproduce the above copyright 107008Snate@binkert.org * notice, this list of conditions and the following disclaimer in the 117008Snate@binkert.org * documentation and/or other materials provided with the distribution; 127008Snate@binkert.org * neither the name of the copyright holders nor the names of its 137008Snate@binkert.org * contributors may be used to endorse or promote products derived from 147008Snate@binkert.org * this software without specific prior written permission. 157008Snate@binkert.org * 167008Snate@binkert.org * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 177008Snate@binkert.org * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 187008Snate@binkert.org * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 197008Snate@binkert.org * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 207008Snate@binkert.org * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 217008Snate@binkert.org * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 227008Snate@binkert.org * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 237008Snate@binkert.org * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 247008Snate@binkert.org * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 257008Snate@binkert.org * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 267008Snate@binkert.org * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 277008Snate@binkert.org */ 286285Snate@binkert.org 297039Snate@binkert.org#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 307039Snate@binkert.org#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 316285Snate@binkert.org 3210963Sdavid.hashe@amd.com#include <exception> 337055Snate@binkert.org#include <iostream> 347055Snate@binkert.org#include <string> 356876Ssteve.reinhardt@amd.com 369745Snilay@cs.wisc.edu#include "base/callback.hh" 378341Snilay@cs.wisc.edu#include "mem/protocol/AccessPermission.hh" 386506Spdudnik@gmail.com#include "mem/ruby/common/Address.hh" 397055Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 408436SBrad.Beckmann@amd.com#include "mem/ruby/common/DataBlock.hh" 419497Snilay@cs.wisc.edu#include "mem/ruby/common/Histogram.hh" 4210301Snilay@cs.wisc.edu#include "mem/ruby/common/MachineID.hh" 4310301Snilay@cs.wisc.edu#include "mem/ruby/network/MessageBuffer.hh" 446881SBrad.Beckmann@amd.com#include "mem/ruby/network/Network.hh" 4510301Snilay@cs.wisc.edu#include "mem/ruby/system/CacheRecorder.hh" 469364Snilay@cs.wisc.edu#include "mem/packet.hh" 4710524Snilay@cs.wisc.edu#include "mem/qport.hh" 487055Snate@binkert.org#include "params/RubyController.hh" 4910524Snilay@cs.wisc.edu#include "mem/mem_object.hh" 506285Snate@binkert.org 516285Snate@binkert.orgclass Network; 526285Snate@binkert.org 5310963Sdavid.hashe@amd.com// used to communicate that an in_port peeked the wrong message type 5410963Sdavid.hashe@amd.comclass RejectException: public std::exception 5510963Sdavid.hashe@amd.com{ 5610963Sdavid.hashe@amd.com virtual const char* what() const throw() 5710963Sdavid.hashe@amd.com { return "Port rejected message based on type"; } 5810963Sdavid.hashe@amd.com}; 5910963Sdavid.hashe@amd.com 6010524Snilay@cs.wisc.educlass AbstractController : public MemObject, public Consumer 617039Snate@binkert.org{ 627039Snate@binkert.org public: 636876Ssteve.reinhardt@amd.com typedef RubyControllerParams Params; 648436SBrad.Beckmann@amd.com AbstractController(const Params *p); 659496Snilay@cs.wisc.edu void init(); 668257SBrad.Beckmann@amd.com const Params *params() const { return (const Params *)_params; } 679745Snilay@cs.wisc.edu 6810078Snilay@cs.wisc.edu const NodeID getVersion() const { return m_machineID.getNum(); } 6910078Snilay@cs.wisc.edu const MachineType getType() const { return m_machineID.getType(); } 7010078Snilay@cs.wisc.edu 719819Snilay@cs.wisc.edu void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 729819Snilay@cs.wisc.edu 739819Snilay@cs.wisc.edu // return instance name 749819Snilay@cs.wisc.edu void blockOnQueue(Address, MessageBuffer*); 759819Snilay@cs.wisc.edu void unblock(Address); 769819Snilay@cs.wisc.edu 777039Snate@binkert.org virtual MessageBuffer* getMandatoryQueue() const = 0; 788531Snilay@cs.wisc.edu virtual AccessPermission getAccessPermission(const Address& addr) = 0; 796285Snate@binkert.org 807055Snate@binkert.org virtual void print(std::ostream & out) const = 0; 817039Snate@binkert.org virtual void wakeup() = 0; 8210012Snilay@cs.wisc.edu virtual void resetStats() = 0; 8310012Snilay@cs.wisc.edu virtual void regStats(); 849745Snilay@cs.wisc.edu 858683Snilay@cs.wisc.edu virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 868683Snilay@cs.wisc.edu virtual Sequencer* getSequencer() const = 0; 879302Snilay@cs.wisc.edu 8810523Snilay@cs.wisc.edu //! These functions are used by ruby system to read/write the data blocks 8910523Snilay@cs.wisc.edu //! that exist with in the controller. 9010522Snilay@cs.wisc.edu virtual void functionalRead(const Address &addr, PacketPtr) = 0; 9110524Snilay@cs.wisc.edu void functionalMemoryRead(PacketPtr); 929302Snilay@cs.wisc.edu //! The return value indicates the number of messages written with the 939302Snilay@cs.wisc.edu //! data from the packet. 9410524Snilay@cs.wisc.edu virtual int functionalWriteBuffers(PacketPtr&) = 0; 9510522Snilay@cs.wisc.edu virtual int functionalWrite(const Address &addr, PacketPtr) = 0; 9610524Snilay@cs.wisc.edu int functionalMemoryWrite(PacketPtr); 979363Snilay@cs.wisc.edu 989363Snilay@cs.wisc.edu //! Function for enqueuing a prefetch request 999363Snilay@cs.wisc.edu virtual void enqueuePrefetch(const Address&, const RubyRequestType&) 1009363Snilay@cs.wisc.edu { fatal("Prefetches not implemented!");} 1019364Snilay@cs.wisc.edu 1029745Snilay@cs.wisc.edu //! Function for collating statistics from all the controllers of this 1039745Snilay@cs.wisc.edu //! particular type. This function should only be called from the 1049745Snilay@cs.wisc.edu //! version 0 of this controller type. 1059745Snilay@cs.wisc.edu virtual void collateStats() 1069745Snilay@cs.wisc.edu {fatal("collateStats() should be overridden!");} 1079745Snilay@cs.wisc.edu 10810311Snilay@cs.wisc.edu //! Set the message buffer with given name. 10910311Snilay@cs.wisc.edu virtual void setNetQueue(const std::string& name, MessageBuffer *b) = 0; 11010311Snilay@cs.wisc.edu 11110524Snilay@cs.wisc.edu /** A function used to return the port associated with this bus object. */ 11210524Snilay@cs.wisc.edu BaseMasterPort& getMasterPort(const std::string& if_name, 11310524Snilay@cs.wisc.edu PortID idx = InvalidPortID); 11410524Snilay@cs.wisc.edu 11510524Snilay@cs.wisc.edu void queueMemoryRead(const MachineID &id, Address addr, Cycles latency); 11610524Snilay@cs.wisc.edu void queueMemoryWrite(const MachineID &id, Address addr, Cycles latency, 11710524Snilay@cs.wisc.edu const DataBlock &block); 11810524Snilay@cs.wisc.edu void queueMemoryWritePartial(const MachineID &id, Address addr, Cycles latency, 11910524Snilay@cs.wisc.edu const DataBlock &block, int size); 12010524Snilay@cs.wisc.edu void recvTimingResp(PacketPtr pkt); 12110524Snilay@cs.wisc.edu 1229496Snilay@cs.wisc.edu public: 1239496Snilay@cs.wisc.edu MachineID getMachineID() const { return m_machineID; } 1249496Snilay@cs.wisc.edu 12510012Snilay@cs.wisc.edu Stats::Histogram& getDelayHist() { return m_delayHistogram; } 12610012Snilay@cs.wisc.edu Stats::Histogram& getDelayVCHist(uint32_t index) 12710012Snilay@cs.wisc.edu { return *(m_delayVCHistogram[index]); } 1289497Snilay@cs.wisc.edu 1299496Snilay@cs.wisc.edu protected: 1309496Snilay@cs.wisc.edu //! Profiles original cache requests including PUTs 1319496Snilay@cs.wisc.edu void profileRequest(const std::string &request); 1329497Snilay@cs.wisc.edu //! Profiles the delay associated with messages. 1339507Snilay@cs.wisc.edu void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 1349496Snilay@cs.wisc.edu 1359596Snilay@cs.wisc.edu void stallBuffer(MessageBuffer* buf, Address addr); 1369596Snilay@cs.wisc.edu void wakeUpBuffers(Address addr); 1379596Snilay@cs.wisc.edu void wakeUpAllBuffers(Address addr); 1389596Snilay@cs.wisc.edu void wakeUpAllBuffers(); 1399596Snilay@cs.wisc.edu 1409364Snilay@cs.wisc.edu protected: 1419364Snilay@cs.wisc.edu NodeID m_version; 14210005Snilay@cs.wisc.edu MachineID m_machineID; 14310005Snilay@cs.wisc.edu NodeID m_clusterID; 14410005Snilay@cs.wisc.edu 14510524Snilay@cs.wisc.edu // MasterID used by some components of gem5. 14610524Snilay@cs.wisc.edu MasterID m_masterId; 14710524Snilay@cs.wisc.edu 1489364Snilay@cs.wisc.edu Network* m_net_ptr; 1499364Snilay@cs.wisc.edu bool m_is_blocking; 1509364Snilay@cs.wisc.edu std::map<Address, MessageBuffer*> m_block_map; 15110087Snilay@cs.wisc.edu 1529364Snilay@cs.wisc.edu typedef std::vector<MessageBuffer*> MsgVecType; 15310977Sdavid.hashe@amd.com typedef std::set<MessageBuffer*> MsgBufType; 1549364Snilay@cs.wisc.edu typedef std::map< Address, MsgVecType* > WaitingBufType; 1559364Snilay@cs.wisc.edu WaitingBufType m_waiting_buffers; 15610087Snilay@cs.wisc.edu 1579996Snilay@cs.wisc.edu unsigned int m_in_ports; 1589996Snilay@cs.wisc.edu unsigned int m_cur_in_port; 1599364Snilay@cs.wisc.edu int m_number_of_TBEs; 16010005Snilay@cs.wisc.edu int m_transitions_per_cycle; 16110096Snilay@cs.wisc.edu unsigned int m_buffer_size; 16210005Snilay@cs.wisc.edu Cycles m_recycle_latency; 1639496Snilay@cs.wisc.edu 1649496Snilay@cs.wisc.edu //! Counter for the number of cycles when the transitions carried out 1659496Snilay@cs.wisc.edu //! were equal to the maximum allowed 16610012Snilay@cs.wisc.edu Stats::Scalar m_fully_busy_cycles; 1679497Snilay@cs.wisc.edu 1689497Snilay@cs.wisc.edu //! Histogram for profiling delay for the messages this controller 1699497Snilay@cs.wisc.edu //! cares for 17010012Snilay@cs.wisc.edu Stats::Histogram m_delayHistogram; 17110012Snilay@cs.wisc.edu std::vector<Stats::Histogram *> m_delayVCHistogram; 1729745Snilay@cs.wisc.edu 1739745Snilay@cs.wisc.edu //! Callback class used for collating statistics from all the 1749745Snilay@cs.wisc.edu //! controller of this type. 1759745Snilay@cs.wisc.edu class StatsCallback : public Callback 1769745Snilay@cs.wisc.edu { 1779745Snilay@cs.wisc.edu private: 1789745Snilay@cs.wisc.edu AbstractController *ctr; 1799745Snilay@cs.wisc.edu 1809745Snilay@cs.wisc.edu public: 1819745Snilay@cs.wisc.edu virtual ~StatsCallback() {} 18210012Snilay@cs.wisc.edu StatsCallback(AbstractController *_ctr) : ctr(_ctr) {} 1839745Snilay@cs.wisc.edu void process() {ctr->collateStats();} 1849745Snilay@cs.wisc.edu }; 18510524Snilay@cs.wisc.edu 18610524Snilay@cs.wisc.edu /** 18710524Snilay@cs.wisc.edu * Port that forwards requests and receives responses from the 18810524Snilay@cs.wisc.edu * memory controller. It has a queue of packets not yet sent. 18910524Snilay@cs.wisc.edu */ 19010524Snilay@cs.wisc.edu class MemoryPort : public QueuedMasterPort 19110524Snilay@cs.wisc.edu { 19210524Snilay@cs.wisc.edu private: 19310713Sandreas.hansson@arm.com // Packet queues used to store outgoing requests and snoop responses. 19410713Sandreas.hansson@arm.com ReqPacketQueue reqQueue; 19510713Sandreas.hansson@arm.com SnoopRespPacketQueue snoopRespQueue; 19610524Snilay@cs.wisc.edu 19710524Snilay@cs.wisc.edu // Controller that operates this port. 19810524Snilay@cs.wisc.edu AbstractController *controller; 19910524Snilay@cs.wisc.edu 20010524Snilay@cs.wisc.edu public: 20110524Snilay@cs.wisc.edu MemoryPort(const std::string &_name, AbstractController *_controller, 20210524Snilay@cs.wisc.edu const std::string &_label); 20310524Snilay@cs.wisc.edu 20410524Snilay@cs.wisc.edu // Function for receiving a timing response from the peer port. 20510524Snilay@cs.wisc.edu // Currently the pkt is handed to the coherence controller 20610524Snilay@cs.wisc.edu // associated with this port. 20710524Snilay@cs.wisc.edu bool recvTimingResp(PacketPtr pkt); 20810524Snilay@cs.wisc.edu }; 20910524Snilay@cs.wisc.edu 21010524Snilay@cs.wisc.edu /* Master port to the memory controller. */ 21110524Snilay@cs.wisc.edu MemoryPort memoryPort; 21210524Snilay@cs.wisc.edu 21310524Snilay@cs.wisc.edu // Message Buffer for storing the response received from the 21410524Snilay@cs.wisc.edu // memory controller. 21510524Snilay@cs.wisc.edu MessageBuffer *m_responseFromMemory_ptr; 21610524Snilay@cs.wisc.edu 21710524Snilay@cs.wisc.edu // State that is stored in packets sent to the memory controller. 21810524Snilay@cs.wisc.edu struct SenderState : public Packet::SenderState 21910524Snilay@cs.wisc.edu { 22010524Snilay@cs.wisc.edu // Id of the machine from which the request originated. 22110524Snilay@cs.wisc.edu MachineID id; 22210524Snilay@cs.wisc.edu 22310524Snilay@cs.wisc.edu SenderState(MachineID _id) : id(_id) 22410524Snilay@cs.wisc.edu {} 22510524Snilay@cs.wisc.edu }; 2266285Snate@binkert.org}; 2276285Snate@binkert.org 2287039Snate@binkert.org#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 229