AbstractController.hh revision 10078:9400a90ec5d1
17139Sgblack@eecs.umich.edu/* 27139Sgblack@eecs.umich.edu * Copyright (c) 2009 Mark D. Hill and David A. Wood 37139Sgblack@eecs.umich.edu * All rights reserved. 47139Sgblack@eecs.umich.edu * 57139Sgblack@eecs.umich.edu * Redistribution and use in source and binary forms, with or without 67139Sgblack@eecs.umich.edu * modification, are permitted provided that the following conditions are 77139Sgblack@eecs.umich.edu * met: redistributions of source code must retain the above copyright 87139Sgblack@eecs.umich.edu * notice, this list of conditions and the following disclaimer; 97139Sgblack@eecs.umich.edu * redistributions in binary form must reproduce the above copyright 107139Sgblack@eecs.umich.edu * notice, this list of conditions and the following disclaimer in the 117139Sgblack@eecs.umich.edu * documentation and/or other materials provided with the distribution; 127139Sgblack@eecs.umich.edu * neither the name of the copyright holders nor the names of its 137139Sgblack@eecs.umich.edu * contributors may be used to endorse or promote products derived from 147139Sgblack@eecs.umich.edu * this software without specific prior written permission. 157139Sgblack@eecs.umich.edu * 167139Sgblack@eecs.umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 177139Sgblack@eecs.umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 187139Sgblack@eecs.umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 197139Sgblack@eecs.umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 207139Sgblack@eecs.umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 217139Sgblack@eecs.umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 227139Sgblack@eecs.umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 237139Sgblack@eecs.umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 247139Sgblack@eecs.umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 257139Sgblack@eecs.umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 267139Sgblack@eecs.umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 277139Sgblack@eecs.umich.edu */ 287139Sgblack@eecs.umich.edu 297139Sgblack@eecs.umich.edu#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 307139Sgblack@eecs.umich.edu#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 317139Sgblack@eecs.umich.edu 327139Sgblack@eecs.umich.edu#include <iostream> 337139Sgblack@eecs.umich.edu#include <string> 347139Sgblack@eecs.umich.edu 357139Sgblack@eecs.umich.edu#include "base/callback.hh" 367139Sgblack@eecs.umich.edu#include "mem/protocol/AccessPermission.hh" 377139Sgblack@eecs.umich.edu#include "mem/ruby/buffers/MessageBuffer.hh" 387139Sgblack@eecs.umich.edu#include "mem/ruby/common/Address.hh" 397188Sgblack@eecs.umich.edu#include "mem/ruby/common/Consumer.hh" 407188Sgblack@eecs.umich.edu#include "mem/ruby/common/DataBlock.hh" 417188Sgblack@eecs.umich.edu#include "mem/ruby/common/Histogram.hh" 427188Sgblack@eecs.umich.edu#include "mem/ruby/network/Network.hh" 437188Sgblack@eecs.umich.edu#include "mem/ruby/recorder/CacheRecorder.hh" 447139Sgblack@eecs.umich.edu#include "mem/ruby/system/MachineID.hh" 457139Sgblack@eecs.umich.edu#include "mem/packet.hh" 467139Sgblack@eecs.umich.edu#include "params/RubyController.hh" 477139Sgblack@eecs.umich.edu#include "sim/clocked_object.hh" 487188Sgblack@eecs.umich.edu 497188Sgblack@eecs.umich.educlass Network; 507188Sgblack@eecs.umich.edu 517188Sgblack@eecs.umich.educlass AbstractController : public ClockedObject, public Consumer 527188Sgblack@eecs.umich.edu{ 537188Sgblack@eecs.umich.edu public: 547139Sgblack@eecs.umich.edu typedef RubyControllerParams Params; 557146Sgblack@eecs.umich.edu AbstractController(const Params *p); 567141Sgblack@eecs.umich.edu void init(); 577139Sgblack@eecs.umich.edu const Params *params() const { return (const Params *)_params; } 587139Sgblack@eecs.umich.edu 597139Sgblack@eecs.umich.edu const NodeID getVersion() const { return m_machineID.getNum(); } 607146Sgblack@eecs.umich.edu const MachineType getType() const { return m_machineID.getType(); } 617141Sgblack@eecs.umich.edu 627139Sgblack@eecs.umich.edu void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 637146Sgblack@eecs.umich.edu 647141Sgblack@eecs.umich.edu // return instance name 657139Sgblack@eecs.umich.edu void blockOnQueue(Address, MessageBuffer*); 667139Sgblack@eecs.umich.edu void unblock(Address); 677139Sgblack@eecs.umich.edu 687139Sgblack@eecs.umich.edu virtual MessageBuffer* getMandatoryQueue() const = 0; 697139Sgblack@eecs.umich.edu virtual const std::string toString() const = 0; // returns text version of 707188Sgblack@eecs.umich.edu // controller type 717188Sgblack@eecs.umich.edu virtual AccessPermission getAccessPermission(const Address& addr) = 0; 727188Sgblack@eecs.umich.edu virtual DataBlock& getDataBlock(const Address& addr) = 0; 737188Sgblack@eecs.umich.edu 747188Sgblack@eecs.umich.edu virtual void print(std::ostream & out) const = 0; 757188Sgblack@eecs.umich.edu virtual void wakeup() = 0; 767188Sgblack@eecs.umich.edu virtual void resetStats() = 0; 777188Sgblack@eecs.umich.edu virtual void regStats(); 787188Sgblack@eecs.umich.edu 797188Sgblack@eecs.umich.edu virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 807188Sgblack@eecs.umich.edu virtual Sequencer* getSequencer() const = 0; 817188Sgblack@eecs.umich.edu 827188Sgblack@eecs.umich.edu //! These functions are used by ruby system to read/write the message 837188Sgblack@eecs.umich.edu //! queues that exist with in the controller. 847188Sgblack@eecs.umich.edu //! The boolean return value indicates if the read was performed 857188Sgblack@eecs.umich.edu //! successfully. 867188Sgblack@eecs.umich.edu virtual bool functionalReadBuffers(PacketPtr&) = 0; 877188Sgblack@eecs.umich.edu //! The return value indicates the number of messages written with the 887188Sgblack@eecs.umich.edu //! data from the packet. 897188Sgblack@eecs.umich.edu virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0; 907139Sgblack@eecs.umich.edu 917139Sgblack@eecs.umich.edu //! Function for enqueuing a prefetch request 927139Sgblack@eecs.umich.edu virtual void enqueuePrefetch(const Address&, const RubyRequestType&) 937139Sgblack@eecs.umich.edu { fatal("Prefetches not implemented!");} 947139Sgblack@eecs.umich.edu 957139Sgblack@eecs.umich.edu //! Function for collating statistics from all the controllers of this 967139Sgblack@eecs.umich.edu //! particular type. This function should only be called from the 977139Sgblack@eecs.umich.edu //! version 0 of this controller type. 987139Sgblack@eecs.umich.edu virtual void collateStats() 997139Sgblack@eecs.umich.edu {fatal("collateStats() should be overridden!");} 1007139Sgblack@eecs.umich.edu 1017139Sgblack@eecs.umich.edu public: 1027139Sgblack@eecs.umich.edu MachineID getMachineID() const { return m_machineID; } 1037139Sgblack@eecs.umich.edu 1047139Sgblack@eecs.umich.edu Stats::Histogram& getDelayHist() { return m_delayHistogram; } 1057139Sgblack@eecs.umich.edu Stats::Histogram& getDelayVCHist(uint32_t index) 1067139Sgblack@eecs.umich.edu { return *(m_delayVCHistogram[index]); } 1077139Sgblack@eecs.umich.edu 1087139Sgblack@eecs.umich.edu MessageBuffer *getPeerQueue(uint32_t pid) 1097139Sgblack@eecs.umich.edu { 1107139Sgblack@eecs.umich.edu std::map<uint32_t, MessageBuffer *>::iterator it = 1117188Sgblack@eecs.umich.edu peerQueueMap.find(pid); 1127188Sgblack@eecs.umich.edu assert(it != peerQueueMap.end()); 1137188Sgblack@eecs.umich.edu return (*it).second; 1147188Sgblack@eecs.umich.edu } 1157139Sgblack@eecs.umich.edu 1167188Sgblack@eecs.umich.edu protected: 1177139Sgblack@eecs.umich.edu //! Profiles original cache requests including PUTs 1187188Sgblack@eecs.umich.edu void profileRequest(const std::string &request); 1197139Sgblack@eecs.umich.edu //! Profiles the delay associated with messages. 1207139Sgblack@eecs.umich.edu void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 1217139Sgblack@eecs.umich.edu 1227139Sgblack@eecs.umich.edu //! Function for connecting peer controllers 1237139Sgblack@eecs.umich.edu void connectWithPeer(AbstractController *); 1247139Sgblack@eecs.umich.edu virtual void getQueuesFromPeer(AbstractController *) 1257139Sgblack@eecs.umich.edu { fatal("getQueuesFromPeer() should be called only if implemented!"); } 1267139Sgblack@eecs.umich.edu 1277194Sgblack@eecs.umich.edu void stallBuffer(MessageBuffer* buf, Address addr); 1287194Sgblack@eecs.umich.edu void wakeUpBuffers(Address addr); 1297194Sgblack@eecs.umich.edu void wakeUpAllBuffers(Address addr); 1307194Sgblack@eecs.umich.edu void wakeUpAllBuffers(); 1317194Sgblack@eecs.umich.edu 1327194Sgblack@eecs.umich.edu protected: 1337194Sgblack@eecs.umich.edu NodeID m_version; 1347194Sgblack@eecs.umich.edu MachineID m_machineID; 1357194Sgblack@eecs.umich.edu NodeID m_clusterID; 1367194Sgblack@eecs.umich.edu 1377194Sgblack@eecs.umich.edu Network* m_net_ptr; 1387194Sgblack@eecs.umich.edu bool m_is_blocking; 1397194Sgblack@eecs.umich.edu std::map<Address, MessageBuffer*> m_block_map; 1407194Sgblack@eecs.umich.edu typedef std::vector<MessageBuffer*> MsgVecType; 1417194Sgblack@eecs.umich.edu typedef std::map< Address, MsgVecType* > WaitingBufType; 1427194Sgblack@eecs.umich.edu WaitingBufType m_waiting_buffers; 1437194Sgblack@eecs.umich.edu unsigned int m_in_ports; 1447194Sgblack@eecs.umich.edu unsigned int m_cur_in_port; 1457194Sgblack@eecs.umich.edu int m_number_of_TBEs; 1467194Sgblack@eecs.umich.edu int m_transitions_per_cycle; 1477194Sgblack@eecs.umich.edu int m_buffer_size; 1487194Sgblack@eecs.umich.edu Cycles m_recycle_latency; 1497194Sgblack@eecs.umich.edu 1507194Sgblack@eecs.umich.edu //! Map from physical network number to the Message Buffer. 1517194Sgblack@eecs.umich.edu std::map<uint32_t, MessageBuffer*> peerQueueMap; 1527194Sgblack@eecs.umich.edu 1537194Sgblack@eecs.umich.edu //! Counter for the number of cycles when the transitions carried out 1547194Sgblack@eecs.umich.edu //! were equal to the maximum allowed 1557194Sgblack@eecs.umich.edu Stats::Scalar m_fully_busy_cycles; 1567194Sgblack@eecs.umich.edu 1577194Sgblack@eecs.umich.edu //! Histogram for profiling delay for the messages this controller 1587194Sgblack@eecs.umich.edu //! cares for 1597194Sgblack@eecs.umich.edu Stats::Histogram m_delayHistogram; 1607194Sgblack@eecs.umich.edu std::vector<Stats::Histogram *> m_delayVCHistogram; 1617194Sgblack@eecs.umich.edu 1627194Sgblack@eecs.umich.edu //! Callback class used for collating statistics from all the 1637194Sgblack@eecs.umich.edu //! controller of this type. 1647194Sgblack@eecs.umich.edu class StatsCallback : public Callback 1657194Sgblack@eecs.umich.edu { 1667194Sgblack@eecs.umich.edu private: 1677194Sgblack@eecs.umich.edu AbstractController *ctr; 1687194Sgblack@eecs.umich.edu 1697194Sgblack@eecs.umich.edu public: 1707194Sgblack@eecs.umich.edu virtual ~StatsCallback() {} 1717194Sgblack@eecs.umich.edu StatsCallback(AbstractController *_ctr) : ctr(_ctr) {} 1727194Sgblack@eecs.umich.edu void process() {ctr->collateStats();} 1737194Sgblack@eecs.umich.edu }; 1747194Sgblack@eecs.umich.edu}; 1757194Sgblack@eecs.umich.edu 1767194Sgblack@eecs.umich.edu#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 1777194Sgblack@eecs.umich.edu