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 virtual MessageBuffer* getMandatoryQueue() const = 0; 60 virtual const int & getVersion() const = 0; 61 virtual const std::string toString() const = 0; // returns text version of 62 // controller type 63 virtual const std::string getName() const = 0; // return instance name 64 virtual void blockOnQueue(Address, MessageBuffer*) = 0; 65 virtual void unblock(Address) = 0; 66 virtual void initNetworkPtr(Network* net_ptr) = 0; 67 virtual AccessPermission getAccessPermission(const Address& addr) = 0; 68 virtual DataBlock& getDataBlock(const Address& addr) = 0; 69 70 virtual void print(std::ostream & out) const = 0; 71 virtual void printStats(std::ostream & out) const = 0; 72 virtual void wakeup() = 0;
|
71 // virtual void dumpStats(std::ostream & out) = 0;
|
73 virtual void clearStats() = 0;
|
74 virtual void regStats() = 0; 75 |
76 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 77 virtual Sequencer* getSequencer() const = 0; 78 79 //! These functions are used by ruby system to read/write the message 80 //! queues that exist with in the controller. 81 //! The boolean return value indicates if the read was performed 82 //! successfully. 83 virtual bool functionalReadBuffers(PacketPtr&) = 0; 84 //! The return value indicates the number of messages written with the 85 //! data from the packet. 86 virtual uint32_t functionalWriteBuffers(PacketPtr&) = 0; 87 88 //! Function for enqueuing a prefetch request 89 virtual void enqueuePrefetch(const Address&, const RubyRequestType&) 90 { fatal("Prefetches not implemented!");} 91
|
92 //! Function for collating statistics from all the controllers of this 93 //! particular type. This function should only be called from the 94 //! version 0 of this controller type. 95 virtual void collateStats() 96 {fatal("collateStats() should be overridden!");} 97 |
98 public: 99 MachineID getMachineID() const { return m_machineID; } 100 uint64_t getFullyBusyCycles() const { return m_fully_busy_cycles; } 101 uint64_t getRequestCount() const { return m_request_count; } 102 const std::map<std::string, uint64_t>& getRequestProfileMap() const 103 { return m_requestProfileMap; } 104 105 Histogram& getDelayHist() { return m_delayHistogram; } 106 Histogram& getDelayVCHist(uint32_t index) 107 { return m_delayVCHistogram[index]; } 108 109 MessageBuffer *getPeerQueue(uint32_t pid) 110 { 111 std::map<uint32_t, MessageBuffer *>::iterator it = 112 peerQueueMap.find(pid); 113 assert(it != peerQueueMap.end()); 114 return (*it).second; 115 } 116 117 protected: 118 //! Profiles original cache requests including PUTs 119 void profileRequest(const std::string &request); 120 //! Profiles the delay associated with messages. 121 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 122 123 //! Function for connecting peer controllers 124 void connectWithPeer(AbstractController *); 125 virtual void getQueuesFromPeer(AbstractController *) 126 { fatal("getQueuesFromPeer() should be called only if implemented!"); } 127 128 void stallBuffer(MessageBuffer* buf, Address addr); 129 void wakeUpBuffers(Address addr); 130 void wakeUpAllBuffers(Address addr); 131 void wakeUpAllBuffers(); 132 133 protected: 134 int m_transitions_per_cycle; 135 int m_buffer_size; 136 Cycles m_recycle_latency; 137 std::string m_name; 138 NodeID m_version; 139 Network* m_net_ptr; 140 MachineID m_machineID; 141 bool m_is_blocking; 142 std::map<Address, MessageBuffer*> m_block_map; 143 typedef std::vector<MessageBuffer*> MsgVecType; 144 typedef std::map< Address, MsgVecType* > WaitingBufType; 145 WaitingBufType m_waiting_buffers; 146 int m_max_in_port_rank; 147 int m_cur_in_port_rank; 148 int m_number_of_TBEs; 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 uint64_t m_fully_busy_cycles; 156 157 //! Map for couting requests of different types. The controller should 158 //! call requisite function for updating the count. 159 std::map<std::string, uint64_t> m_requestProfileMap; 160 uint64_t m_request_count; 161 162 //! Histogram for profiling delay for the messages this controller 163 //! cares for 164 Histogram m_delayHistogram; 165 std::vector<Histogram> m_delayVCHistogram;
|
166 167 //! Callback class used for collating statistics from all the 168 //! controller of this type. 169 class StatsCallback : public Callback 170 { 171 private: 172 AbstractController *ctr; 173 174 public: 175 virtual ~StatsCallback() {} 176 177 StatsCallback(AbstractController *_ctr) 178 : ctr(_ctr) 179 { 180 } 181 182 void process() {ctr->collateStats();} 183 }; |
184}; 185 186#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__
|