AbstractController.hh revision 10524:fff17530cef6
1/* 2 * Copyright (c) 2009-2014 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/common/Address.hh" 38#include "mem/ruby/common/Consumer.hh" 39#include "mem/ruby/common/DataBlock.hh" 40#include "mem/ruby/common/Histogram.hh" 41#include "mem/ruby/common/MachineID.hh" 42#include "mem/ruby/network/MessageBuffer.hh" 43#include "mem/ruby/network/Network.hh" 44#include "mem/ruby/system/CacheRecorder.hh" 45#include "mem/packet.hh" 46#include "mem/qport.hh" 47#include "params/RubyController.hh" 48#include "mem/mem_object.hh" 49 50class Network; 51 52class AbstractController : public MemObject, public Consumer 53{ 54 public: 55 typedef RubyControllerParams Params; 56 AbstractController(const Params *p); 57 void init(); 58 const Params *params() const { return (const Params *)_params; } 59 60 const NodeID getVersion() const { return m_machineID.getNum(); } 61 const MachineType getType() const { return m_machineID.getType(); } 62 63 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 64 65 // return instance name 66 void blockOnQueue(Address, MessageBuffer*); 67 void unblock(Address); 68 69 virtual MessageBuffer* getMandatoryQueue() const = 0; 70 virtual AccessPermission getAccessPermission(const Address& addr) = 0; 71 72 virtual void print(std::ostream & out) const = 0; 73 virtual void wakeup() = 0; 74 virtual void resetStats() = 0; 75 virtual void regStats(); 76 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 data blocks 81 //! that exist with in the controller. 82 virtual void functionalRead(const Address &addr, PacketPtr) = 0; 83 void functionalMemoryRead(PacketPtr); 84 //! The return value indicates the number of messages written with the 85 //! data from the packet. 86 virtual int functionalWriteBuffers(PacketPtr&) = 0; 87 virtual int functionalWrite(const Address &addr, PacketPtr) = 0; 88 int functionalMemoryWrite(PacketPtr); 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 //! Set the message buffer with given name. 101 virtual void setNetQueue(const std::string& name, MessageBuffer *b) = 0; 102 103 /** A function used to return the port associated with this bus object. */ 104 BaseMasterPort& getMasterPort(const std::string& if_name, 105 PortID idx = InvalidPortID); 106 107 void queueMemoryRead(const MachineID &id, Address addr, Cycles latency); 108 void queueMemoryWrite(const MachineID &id, Address addr, Cycles latency, 109 const DataBlock &block); 110 void queueMemoryWritePartial(const MachineID &id, Address addr, Cycles latency, 111 const DataBlock &block, int size); 112 void recvTimingResp(PacketPtr pkt); 113 114 public: 115 MachineID getMachineID() const { return m_machineID; } 116 117 Stats::Histogram& getDelayHist() { return m_delayHistogram; } 118 Stats::Histogram& getDelayVCHist(uint32_t index) 119 { return *(m_delayVCHistogram[index]); } 120 121 protected: 122 //! Profiles original cache requests including PUTs 123 void profileRequest(const std::string &request); 124 //! Profiles the delay associated with messages. 125 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 126 127 void stallBuffer(MessageBuffer* buf, Address addr); 128 void wakeUpBuffers(Address addr); 129 void wakeUpAllBuffers(Address addr); 130 void wakeUpAllBuffers(); 131 132 protected: 133 NodeID m_version; 134 MachineID m_machineID; 135 NodeID m_clusterID; 136 137 // MasterID used by some components of gem5. 138 MasterID m_masterId; 139 140 Network* m_net_ptr; 141 bool m_is_blocking; 142 std::map<Address, MessageBuffer*> m_block_map; 143 144 typedef std::vector<MessageBuffer*> MsgVecType; 145 typedef std::map< Address, MsgVecType* > WaitingBufType; 146 WaitingBufType m_waiting_buffers; 147 148 unsigned int m_in_ports; 149 unsigned int m_cur_in_port; 150 int m_number_of_TBEs; 151 int m_transitions_per_cycle; 152 unsigned int m_buffer_size; 153 Cycles m_recycle_latency; 154 155 //! Counter for the number of cycles when the transitions carried out 156 //! were equal to the maximum allowed 157 Stats::Scalar m_fully_busy_cycles; 158 159 //! Histogram for profiling delay for the messages this controller 160 //! cares for 161 Stats::Histogram m_delayHistogram; 162 std::vector<Stats::Histogram *> m_delayVCHistogram; 163 164 //! Callback class used for collating statistics from all the 165 //! controller of this type. 166 class StatsCallback : public Callback 167 { 168 private: 169 AbstractController *ctr; 170 171 public: 172 virtual ~StatsCallback() {} 173 StatsCallback(AbstractController *_ctr) : ctr(_ctr) {} 174 void process() {ctr->collateStats();} 175 }; 176 177 /** 178 * Port that forwards requests and receives responses from the 179 * memory controller. It has a queue of packets not yet sent. 180 */ 181 class MemoryPort : public QueuedMasterPort 182 { 183 private: 184 // Packet queue used to store outgoing requests and responses. 185 MasterPacketQueue _queue; 186 187 // Controller that operates this port. 188 AbstractController *controller; 189 190 public: 191 MemoryPort(const std::string &_name, AbstractController *_controller, 192 const std::string &_label); 193 194 // Function for receiving a timing response from the peer port. 195 // Currently the pkt is handed to the coherence controller 196 // associated with this port. 197 bool recvTimingResp(PacketPtr pkt); 198 }; 199 200 /* Master port to the memory controller. */ 201 MemoryPort memoryPort; 202 203 // Message Buffer for storing the response received from the 204 // memory controller. 205 MessageBuffer *m_responseFromMemory_ptr; 206 207 // State that is stored in packets sent to the memory controller. 208 struct SenderState : public Packet::SenderState 209 { 210 // Id of the machine from which the request originated. 211 MachineID id; 212 213 SenderState(MachineID _id) : id(_id) 214 {} 215 }; 216}; 217 218#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 219