AbstractController.hh revision 10311
17008Snate@binkert.org/* 27008Snate@binkert.org * Copyright (c) 2009 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 327055Snate@binkert.org#include <iostream> 337055Snate@binkert.org#include <string> 346876Ssteve.reinhardt@amd.com 359745Snilay@cs.wisc.edu#include "base/callback.hh" 368341Snilay@cs.wisc.edu#include "mem/protocol/AccessPermission.hh" 376506Spdudnik@gmail.com#include "mem/ruby/common/Address.hh" 387055Snate@binkert.org#include "mem/ruby/common/Consumer.hh" 398436SBrad.Beckmann@amd.com#include "mem/ruby/common/DataBlock.hh" 409497Snilay@cs.wisc.edu#include "mem/ruby/common/Histogram.hh" 4110301Snilay@cs.wisc.edu#include "mem/ruby/common/MachineID.hh" 4210301Snilay@cs.wisc.edu#include "mem/ruby/network/MessageBuffer.hh" 436881SBrad.Beckmann@amd.com#include "mem/ruby/network/Network.hh" 4410301Snilay@cs.wisc.edu#include "mem/ruby/system/CacheRecorder.hh" 459364Snilay@cs.wisc.edu#include "mem/packet.hh" 467055Snate@binkert.org#include "params/RubyController.hh" 479465Snilay@cs.wisc.edu#include "sim/clocked_object.hh" 486285Snate@binkert.org 496285Snate@binkert.orgclass Network; 506285Snate@binkert.org 519465Snilay@cs.wisc.educlass AbstractController : public ClockedObject, public Consumer 527039Snate@binkert.org{ 537039Snate@binkert.org public: 546876Ssteve.reinhardt@amd.com typedef RubyControllerParams Params; 558436SBrad.Beckmann@amd.com AbstractController(const Params *p); 569496Snilay@cs.wisc.edu void init(); 578257SBrad.Beckmann@amd.com const Params *params() const { return (const Params *)_params; } 589745Snilay@cs.wisc.edu 5910078Snilay@cs.wisc.edu const NodeID getVersion() const { return m_machineID.getNum(); } 6010078Snilay@cs.wisc.edu const MachineType getType() const { return m_machineID.getType(); } 6110078Snilay@cs.wisc.edu 629819Snilay@cs.wisc.edu void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 639819Snilay@cs.wisc.edu 649819Snilay@cs.wisc.edu // return instance name 659819Snilay@cs.wisc.edu void blockOnQueue(Address, MessageBuffer*); 669819Snilay@cs.wisc.edu void unblock(Address); 679819Snilay@cs.wisc.edu 687039Snate@binkert.org virtual MessageBuffer* getMandatoryQueue() const = 0; 698531Snilay@cs.wisc.edu virtual AccessPermission getAccessPermission(const Address& addr) = 0; 708531Snilay@cs.wisc.edu virtual DataBlock& getDataBlock(const Address& addr) = 0; 716285Snate@binkert.org 727055Snate@binkert.org virtual void print(std::ostream & out) const = 0; 737039Snate@binkert.org virtual void wakeup() = 0; 7410012Snilay@cs.wisc.edu virtual void resetStats() = 0; 7510012Snilay@cs.wisc.edu virtual void regStats(); 769745Snilay@cs.wisc.edu 778683Snilay@cs.wisc.edu virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 788683Snilay@cs.wisc.edu virtual Sequencer* getSequencer() const = 0; 799302Snilay@cs.wisc.edu 809302Snilay@cs.wisc.edu //! These functions are used by ruby system to read/write the message 819302Snilay@cs.wisc.edu //! queues that exist with in the controller. 829302Snilay@cs.wisc.edu //! The boolean return value indicates if the read was performed 839302Snilay@cs.wisc.edu //! successfully. 849302Snilay@cs.wisc.edu virtual bool functionalReadBuffers(PacketPtr&) = 0; 859302Snilay@cs.wisc.edu //! The return value indicates the number of messages written with the 869302Snilay@cs.wisc.edu //! data from the packet. 879302Snilay@cs.wisc.edu virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0; 889363Snilay@cs.wisc.edu 899363Snilay@cs.wisc.edu //! Function for enqueuing a prefetch request 909363Snilay@cs.wisc.edu virtual void enqueuePrefetch(const Address&, const RubyRequestType&) 919363Snilay@cs.wisc.edu { fatal("Prefetches not implemented!");} 929364Snilay@cs.wisc.edu 939745Snilay@cs.wisc.edu //! Function for collating statistics from all the controllers of this 949745Snilay@cs.wisc.edu //! particular type. This function should only be called from the 959745Snilay@cs.wisc.edu //! version 0 of this controller type. 969745Snilay@cs.wisc.edu virtual void collateStats() 979745Snilay@cs.wisc.edu {fatal("collateStats() should be overridden!");} 989745Snilay@cs.wisc.edu 9910311Snilay@cs.wisc.edu //! Set the message buffer with given name. 10010311Snilay@cs.wisc.edu virtual void setNetQueue(const std::string& name, MessageBuffer *b) = 0; 10110311Snilay@cs.wisc.edu 1029496Snilay@cs.wisc.edu public: 1039496Snilay@cs.wisc.edu MachineID getMachineID() const { return m_machineID; } 1049496Snilay@cs.wisc.edu 10510012Snilay@cs.wisc.edu Stats::Histogram& getDelayHist() { return m_delayHistogram; } 10610012Snilay@cs.wisc.edu Stats::Histogram& getDelayVCHist(uint32_t index) 10710012Snilay@cs.wisc.edu { return *(m_delayVCHistogram[index]); } 1089497Snilay@cs.wisc.edu 1099496Snilay@cs.wisc.edu protected: 1109496Snilay@cs.wisc.edu //! Profiles original cache requests including PUTs 1119496Snilay@cs.wisc.edu void profileRequest(const std::string &request); 1129497Snilay@cs.wisc.edu //! Profiles the delay associated with messages. 1139507Snilay@cs.wisc.edu void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 1149496Snilay@cs.wisc.edu 1159596Snilay@cs.wisc.edu void stallBuffer(MessageBuffer* buf, Address addr); 1169596Snilay@cs.wisc.edu void wakeUpBuffers(Address addr); 1179596Snilay@cs.wisc.edu void wakeUpAllBuffers(Address addr); 1189596Snilay@cs.wisc.edu void wakeUpAllBuffers(); 1199596Snilay@cs.wisc.edu 1209364Snilay@cs.wisc.edu protected: 1219364Snilay@cs.wisc.edu NodeID m_version; 12210005Snilay@cs.wisc.edu MachineID m_machineID; 12310005Snilay@cs.wisc.edu NodeID m_clusterID; 12410005Snilay@cs.wisc.edu 1259364Snilay@cs.wisc.edu Network* m_net_ptr; 1269364Snilay@cs.wisc.edu bool m_is_blocking; 1279364Snilay@cs.wisc.edu std::map<Address, MessageBuffer*> m_block_map; 12810087Snilay@cs.wisc.edu 1299364Snilay@cs.wisc.edu typedef std::vector<MessageBuffer*> MsgVecType; 1309364Snilay@cs.wisc.edu typedef std::map< Address, MsgVecType* > WaitingBufType; 1319364Snilay@cs.wisc.edu WaitingBufType m_waiting_buffers; 13210087Snilay@cs.wisc.edu 1339996Snilay@cs.wisc.edu unsigned int m_in_ports; 1349996Snilay@cs.wisc.edu unsigned int m_cur_in_port; 1359364Snilay@cs.wisc.edu int m_number_of_TBEs; 13610005Snilay@cs.wisc.edu int m_transitions_per_cycle; 13710096Snilay@cs.wisc.edu unsigned int m_buffer_size; 13810005Snilay@cs.wisc.edu Cycles m_recycle_latency; 1399496Snilay@cs.wisc.edu 1409496Snilay@cs.wisc.edu //! Counter for the number of cycles when the transitions carried out 1419496Snilay@cs.wisc.edu //! were equal to the maximum allowed 14210012Snilay@cs.wisc.edu Stats::Scalar m_fully_busy_cycles; 1439497Snilay@cs.wisc.edu 1449497Snilay@cs.wisc.edu //! Histogram for profiling delay for the messages this controller 1459497Snilay@cs.wisc.edu //! cares for 14610012Snilay@cs.wisc.edu Stats::Histogram m_delayHistogram; 14710012Snilay@cs.wisc.edu std::vector<Stats::Histogram *> m_delayVCHistogram; 1489745Snilay@cs.wisc.edu 1499745Snilay@cs.wisc.edu //! Callback class used for collating statistics from all the 1509745Snilay@cs.wisc.edu //! controller of this type. 1519745Snilay@cs.wisc.edu class StatsCallback : public Callback 1529745Snilay@cs.wisc.edu { 1539745Snilay@cs.wisc.edu private: 1549745Snilay@cs.wisc.edu AbstractController *ctr; 1559745Snilay@cs.wisc.edu 1569745Snilay@cs.wisc.edu public: 1579745Snilay@cs.wisc.edu virtual ~StatsCallback() {} 15810012Snilay@cs.wisc.edu StatsCallback(AbstractController *_ctr) : ctr(_ctr) {} 1599745Snilay@cs.wisc.edu void process() {ctr->collateStats();} 1609745Snilay@cs.wisc.edu }; 1616285Snate@binkert.org}; 1626285Snate@binkert.org 1637039Snate@binkert.org#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 164