AbstractController.hh revision 10304:a2f88c6d9e54
15222Sksewell@umich.edu/* 25268Sksewell@umich.edu * Copyright (c) 2009 Mark D. Hill and David A. Wood 35254Sksewell@umich.edu * All rights reserved. 45254Sksewell@umich.edu * 55222Sksewell@umich.edu * Redistribution and use in source and binary forms, with or without 65254Sksewell@umich.edu * modification, are permitted provided that the following conditions are 75254Sksewell@umich.edu * met: redistributions of source code must retain the above copyright 85254Sksewell@umich.edu * notice, this list of conditions and the following disclaimer; 95254Sksewell@umich.edu * redistributions in binary form must reproduce the above copyright 105254Sksewell@umich.edu * notice, this list of conditions and the following disclaimer in the 115254Sksewell@umich.edu * documentation and/or other materials provided with the distribution; 125254Sksewell@umich.edu * neither the name of the copyright holders nor the names of its 135254Sksewell@umich.edu * contributors may be used to endorse or promote products derived from 145254Sksewell@umich.edu * this software without specific prior written permission. 155254Sksewell@umich.edu * 165222Sksewell@umich.edu * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 175254Sksewell@umich.edu * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 185254Sksewell@umich.edu * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 195254Sksewell@umich.edu * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 205254Sksewell@umich.edu * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 215254Sksewell@umich.edu * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 225254Sksewell@umich.edu * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 235254Sksewell@umich.edu * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 245254Sksewell@umich.edu * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 255254Sksewell@umich.edu * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 265254Sksewell@umich.edu * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 275254Sksewell@umich.edu */ 285222Sksewell@umich.edu 295254Sksewell@umich.edu#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 305254Sksewell@umich.edu#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 315222Sksewell@umich.edu 325222Sksewell@umich.edu#include <iostream> 335222Sksewell@umich.edu#include <string> 345222Sksewell@umich.edu 3511793Sbrandon.potter@amd.com#include "base/callback.hh" 365222Sksewell@umich.edu#include "mem/protocol/AccessPermission.hh" 378229Snate@binkert.org#include "mem/ruby/common/Address.hh" 385222Sksewell@umich.edu#include "mem/ruby/common/Consumer.hh" 395222Sksewell@umich.edu#include "mem/ruby/common/DataBlock.hh" 405222Sksewell@umich.edu#include "mem/ruby/common/Histogram.hh" 415222Sksewell@umich.edu#include "mem/ruby/common/MachineID.hh" 425222Sksewell@umich.edu#include "mem/ruby/network/MessageBuffer.hh" 435222Sksewell@umich.edu#include "mem/ruby/network/Network.hh" 445222Sksewell@umich.edu#include "mem/ruby/system/CacheRecorder.hh" 455222Sksewell@umich.edu#include "mem/packet.hh" 465222Sksewell@umich.edu#include "params/RubyController.hh" 476378Sgblack@eecs.umich.edu#include "sim/clocked_object.hh" 485222Sksewell@umich.edu 495222Sksewell@umich.educlass Network; 505222Sksewell@umich.edu 515222Sksewell@umich.educlass AbstractController : public ClockedObject, public Consumer 525222Sksewell@umich.edu{ 535222Sksewell@umich.edu public: 546378Sgblack@eecs.umich.edu typedef RubyControllerParams Params; 555222Sksewell@umich.edu AbstractController(const Params *p); 565222Sksewell@umich.edu void init(); 575222Sksewell@umich.edu const Params *params() const { return (const Params *)_params; } 586378Sgblack@eecs.umich.edu 595222Sksewell@umich.edu const NodeID getVersion() const { return m_machineID.getNum(); } 605222Sksewell@umich.edu const MachineType getType() const { return m_machineID.getType(); } 615222Sksewell@umich.edu 625222Sksewell@umich.edu void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 636378Sgblack@eecs.umich.edu 645222Sksewell@umich.edu // return instance name 655222Sksewell@umich.edu void blockOnQueue(Address, MessageBuffer*); 665222Sksewell@umich.edu void unblock(Address); 675222Sksewell@umich.edu 686378Sgblack@eecs.umich.edu virtual MessageBuffer* getMandatoryQueue() const = 0; 695222Sksewell@umich.edu virtual AccessPermission getAccessPermission(const Address& addr) = 0; 705222Sksewell@umich.edu virtual DataBlock& getDataBlock(const Address& addr) = 0; 715222Sksewell@umich.edu 725222Sksewell@umich.edu virtual void print(std::ostream & out) const = 0; 735222Sksewell@umich.edu virtual void wakeup() = 0; 745222Sksewell@umich.edu virtual void resetStats() = 0; 755222Sksewell@umich.edu virtual void regStats(); 765222Sksewell@umich.edu 77 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 78 virtual Sequencer* getSequencer() const = 0; 79 80 //! These functions are used by ruby system to read/write the message 81 //! queues that exist with in the controller. 82 //! The boolean return value indicates if the read was performed 83 //! successfully. 84 virtual bool functionalReadBuffers(PacketPtr&) = 0; 85 //! The return value indicates the number of messages written with the 86 //! data from the packet. 87 virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0; 88 89 //! Function for enqueuing a prefetch request 90 virtual void enqueuePrefetch(const Address&, const RubyRequestType&) 91 { fatal("Prefetches not implemented!");} 92 93 //! Function for collating statistics from all the controllers of this 94 //! particular type. This function should only be called from the 95 //! version 0 of this controller type. 96 virtual void collateStats() 97 {fatal("collateStats() should be overridden!");} 98 99 public: 100 MachineID getMachineID() const { return m_machineID; } 101 102 Stats::Histogram& getDelayHist() { return m_delayHistogram; } 103 Stats::Histogram& getDelayVCHist(uint32_t index) 104 { return *(m_delayVCHistogram[index]); } 105 106 MessageBuffer *getPeerQueue(uint32_t pid) 107 { 108 std::map<uint32_t, MessageBuffer *>::iterator it = 109 peerQueueMap.find(pid); 110 assert(it != peerQueueMap.end()); 111 return (*it).second; 112 } 113 114 protected: 115 //! Profiles original cache requests including PUTs 116 void profileRequest(const std::string &request); 117 //! Profiles the delay associated with messages. 118 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 119 120 //! Function for connecting peer controllers 121 void connectWithPeer(AbstractController *); 122 virtual void getQueuesFromPeer(AbstractController *) 123 { fatal("getQueuesFromPeer() should be called only if implemented!"); } 124 125 void stallBuffer(MessageBuffer* buf, Address addr); 126 void wakeUpBuffers(Address addr); 127 void wakeUpAllBuffers(Address addr); 128 void wakeUpAllBuffers(); 129 130 protected: 131 NodeID m_version; 132 MachineID m_machineID; 133 NodeID m_clusterID; 134 135 Network* m_net_ptr; 136 bool m_is_blocking; 137 std::map<Address, MessageBuffer*> m_block_map; 138 139 typedef std::vector<MessageBuffer*> MsgVecType; 140 typedef std::map< Address, MsgVecType* > WaitingBufType; 141 WaitingBufType m_waiting_buffers; 142 143 unsigned int m_in_ports; 144 unsigned int m_cur_in_port; 145 int m_number_of_TBEs; 146 int m_transitions_per_cycle; 147 unsigned int m_buffer_size; 148 Cycles m_recycle_latency; 149 150 //! Map from physical network number to the Message Buffer. 151 std::map<uint32_t, MessageBuffer*> peerQueueMap; 152 153 //! Counter for the number of cycles when the transitions carried out 154 //! were equal to the maximum allowed 155 Stats::Scalar m_fully_busy_cycles; 156 157 //! Histogram for profiling delay for the messages this controller 158 //! cares for 159 Stats::Histogram m_delayHistogram; 160 std::vector<Stats::Histogram *> m_delayVCHistogram; 161 162 //! Callback class used for collating statistics from all the 163 //! controller of this type. 164 class StatsCallback : public Callback 165 { 166 private: 167 AbstractController *ctr; 168 169 public: 170 virtual ~StatsCallback() {} 171 StatsCallback(AbstractController *_ctr) : ctr(_ctr) {} 172 void process() {ctr->collateStats();} 173 }; 174}; 175 176#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 177