AbstractController.hh revision 9996:150338b8ba12
1/* 2 * Copyright (c) 2009 Mark D. Hill and David A. Wood 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer; 9 * redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution; 12 * neither the name of the copyright holders nor the names of its 13 * contributors may be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 */ 28 29#ifndef __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 30#define __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 31 32#include <iostream> 33#include <string> 34 35#include "base/callback.hh" 36#include "mem/protocol/AccessPermission.hh" 37#include "mem/ruby/buffers/MessageBuffer.hh" 38#include "mem/ruby/common/Address.hh" 39#include "mem/ruby/common/Consumer.hh" 40#include "mem/ruby/common/DataBlock.hh" 41#include "mem/ruby/common/Histogram.hh" 42#include "mem/ruby/network/Network.hh" 43#include "mem/ruby/recorder/CacheRecorder.hh" 44#include "mem/ruby/system/MachineID.hh" 45#include "mem/packet.hh" 46#include "params/RubyController.hh" 47#include "sim/clocked_object.hh" 48 49class Network; 50 51class AbstractController : public ClockedObject, public Consumer 52{ 53 public: 54 typedef RubyControllerParams Params; 55 AbstractController(const Params *p); 56 void init(); 57 const Params *params() const { return (const Params *)_params; } 58 59 const int & getVersion() const { return m_version; } 60 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 61 62 // return instance name 63 const std::string getName() const { return m_name; } 64 void blockOnQueue(Address, MessageBuffer*); 65 void unblock(Address); 66 67 virtual MessageBuffer* getMandatoryQueue() const = 0; 68 virtual const std::string toString() const = 0; // returns text version of 69 // controller type 70 virtual AccessPermission getAccessPermission(const Address& addr) = 0; 71 virtual DataBlock& getDataBlock(const Address& addr) = 0; 72 73 virtual void print(std::ostream & out) const = 0; 74 virtual void wakeup() = 0; 75 virtual void clearStats() = 0; 76 virtual void regStats() = 0; 77 78 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 79 virtual Sequencer* getSequencer() const = 0; 80 81 //! These functions are used by ruby system to read/write the message 82 //! queues that exist with in the controller. 83 //! The boolean return value indicates if the read was performed 84 //! successfully. 85 virtual bool functionalReadBuffers(PacketPtr&) = 0; 86 //! The return value indicates the number of messages written with the 87 //! data from the packet. 88 virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0; 89 90 //! Function for enqueuing a prefetch request 91 virtual void enqueuePrefetch(const Address&, const RubyRequestType&) 92 { fatal("Prefetches not implemented!");} 93 94 //! Function for collating statistics from all the controllers of this 95 //! particular type. This function should only be called from the 96 //! version 0 of this controller type. 97 virtual void collateStats() 98 {fatal("collateStats() should be overridden!");} 99 100 public: 101 MachineID getMachineID() const { return m_machineID; } 102 uint64_t getFullyBusyCycles() const { return m_fully_busy_cycles; } 103 uint64_t getRequestCount() const { return m_request_count; } 104 const std::map<std::string, uint64_t>& getRequestProfileMap() const 105 { return m_requestProfileMap; } 106 107 Histogram& getDelayHist() { return m_delayHistogram; } 108 Histogram& getDelayVCHist(uint32_t index) 109 { return m_delayVCHistogram[index]; } 110 111 MessageBuffer *getPeerQueue(uint32_t pid) 112 { 113 std::map<uint32_t, MessageBuffer *>::iterator it = 114 peerQueueMap.find(pid); 115 assert(it != peerQueueMap.end()); 116 return (*it).second; 117 } 118 119 protected: 120 //! Profiles original cache requests including PUTs 121 void profileRequest(const std::string &request); 122 //! Profiles the delay associated with messages. 123 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 124 125 //! Function for connecting peer controllers 126 void connectWithPeer(AbstractController *); 127 virtual void getQueuesFromPeer(AbstractController *) 128 { fatal("getQueuesFromPeer() should be called only if implemented!"); } 129 130 void stallBuffer(MessageBuffer* buf, Address addr); 131 void wakeUpBuffers(Address addr); 132 void wakeUpAllBuffers(Address addr); 133 void wakeUpAllBuffers(); 134 135 protected: 136 int m_transitions_per_cycle; 137 int m_buffer_size; 138 Cycles m_recycle_latency; 139 std::string m_name; 140 NodeID m_version; 141 Network* m_net_ptr; 142 MachineID m_machineID; 143 bool m_is_blocking; 144 std::map<Address, MessageBuffer*> m_block_map; 145 typedef std::vector<MessageBuffer*> MsgVecType; 146 typedef std::map< Address, MsgVecType* > WaitingBufType; 147 WaitingBufType m_waiting_buffers; 148 unsigned int m_in_ports; 149 unsigned int m_cur_in_port; 150 int m_number_of_TBEs; 151 152 //! Map from physical network number to the Message Buffer. 153 std::map<uint32_t, MessageBuffer*> peerQueueMap; 154 155 //! Counter for the number of cycles when the transitions carried out 156 //! were equal to the maximum allowed 157 uint64_t m_fully_busy_cycles; 158 159 //! Map for couting requests of different types. The controller should 160 //! call requisite function for updating the count. 161 std::map<std::string, uint64_t> m_requestProfileMap; 162 uint64_t m_request_count; 163 164 //! Histogram for profiling delay for the messages this controller 165 //! cares for 166 Histogram m_delayHistogram; 167 std::vector<Histogram> m_delayVCHistogram; 168 169 //! Callback class used for collating statistics from all the 170 //! controller of this type. 171 class StatsCallback : public Callback 172 { 173 private: 174 AbstractController *ctr; 175 176 public: 177 virtual ~StatsCallback() {} 178 179 StatsCallback(AbstractController *_ctr) 180 : ctr(_ctr) 181 { 182 } 183 184 void process() {ctr->collateStats();} 185 }; 186}; 187 188#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 189