AbstractController.hh revision 11309:9be8a40026df
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 <exception> 33#include <iostream> 34#include <string> 35 36#include "base/callback.hh" 37#include "mem/protocol/AccessPermission.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/common/MachineID.hh" 43#include "mem/ruby/network/MessageBuffer.hh" 44#include "mem/ruby/network/Network.hh" 45#include "mem/ruby/system/CacheRecorder.hh" 46#include "mem/packet.hh" 47#include "mem/qport.hh" 48#include "params/RubyController.hh" 49#include "mem/mem_object.hh" 50 51class Network; 52class GPUCoalescer; 53 54// used to communicate that an in_port peeked the wrong message type 55class RejectException: public std::exception 56{ 57 virtual const char* what() const throw() 58 { return "Port rejected message based on type"; } 59}; 60 61class AbstractController : public MemObject, public Consumer 62{ 63 public: 64 typedef RubyControllerParams Params; 65 AbstractController(const Params *p); 66 void init(); 67 const Params *params() const { return (const Params *)_params; } 68 69 NodeID getVersion() const { return m_machineID.getNum(); } 70 MachineType getType() const { return m_machineID.getType(); } 71 72 void initNetworkPtr(Network* net_ptr) { m_net_ptr = net_ptr; } 73 74 // return instance name 75 void blockOnQueue(Addr, MessageBuffer*); 76 void unblock(Addr); 77 bool isBlocked(Addr); 78 79 virtual MessageBuffer* getMandatoryQueue() const = 0; 80 virtual MessageBuffer* getMemoryQueue() const = 0; 81 virtual AccessPermission getAccessPermission(const Addr &addr) = 0; 82 83 virtual void print(std::ostream & out) const = 0; 84 virtual void wakeup() = 0; 85 virtual void resetStats() = 0; 86 virtual void regStats(); 87 88 virtual void recordCacheTrace(int cntrl, CacheRecorder* tr) = 0; 89 virtual Sequencer* getCPUSequencer() const = 0; 90 virtual GPUCoalescer* getGPUCoalescer() const = 0; 91 92 //! These functions are used by ruby system to read/write the data blocks 93 //! that exist with in the controller. 94 virtual void functionalRead(const Addr &addr, PacketPtr) = 0; 95 void functionalMemoryRead(PacketPtr); 96 //! The return value indicates the number of messages written with the 97 //! data from the packet. 98 virtual int functionalWriteBuffers(PacketPtr&) = 0; 99 virtual int functionalWrite(const Addr &addr, PacketPtr) = 0; 100 int functionalMemoryWrite(PacketPtr); 101 102 //! Function for enqueuing a prefetch request 103 virtual void enqueuePrefetch(const Addr &, const RubyRequestType&) 104 { fatal("Prefetches not implemented!");} 105 106 //! Function for collating statistics from all the controllers of this 107 //! particular type. This function should only be called from the 108 //! version 0 of this controller type. 109 virtual void collateStats() 110 {fatal("collateStats() should be overridden!");} 111 112 //! Initialize the message buffers. 113 virtual void initNetQueues() = 0; 114 115 /** A function used to return the port associated with this bus object. */ 116 BaseMasterPort& getMasterPort(const std::string& if_name, 117 PortID idx = InvalidPortID); 118 119 void queueMemoryRead(const MachineID &id, Addr addr, Cycles latency); 120 void queueMemoryWrite(const MachineID &id, Addr addr, Cycles latency, 121 const DataBlock &block); 122 void queueMemoryWritePartial(const MachineID &id, Addr addr, Cycles latency, 123 const DataBlock &block, int size); 124 void recvTimingResp(PacketPtr pkt); 125 126 public: 127 MachineID getMachineID() const { return m_machineID; } 128 129 Stats::Histogram& getDelayHist() { return m_delayHistogram; } 130 Stats::Histogram& getDelayVCHist(uint32_t index) 131 { return *(m_delayVCHistogram[index]); } 132 133 protected: 134 //! Profiles original cache requests including PUTs 135 void profileRequest(const std::string &request); 136 //! Profiles the delay associated with messages. 137 void profileMsgDelay(uint32_t virtualNetwork, Cycles delay); 138 139 void stallBuffer(MessageBuffer* buf, Addr addr); 140 void wakeUpBuffers(Addr addr); 141 void wakeUpAllBuffers(Addr addr); 142 void wakeUpAllBuffers(); 143 144 protected: 145 const NodeID m_version; 146 MachineID m_machineID; 147 const NodeID m_clusterID; 148 149 // MasterID used by some components of gem5. 150 const MasterID m_masterId; 151 152 Network *m_net_ptr; 153 bool m_is_blocking; 154 std::map<Addr, MessageBuffer*> m_block_map; 155 156 typedef std::vector<MessageBuffer*> MsgVecType; 157 typedef std::set<MessageBuffer*> MsgBufType; 158 typedef std::map<Addr, MsgVecType* > WaitingBufType; 159 WaitingBufType m_waiting_buffers; 160 161 unsigned int m_in_ports; 162 unsigned int m_cur_in_port; 163 const int m_number_of_TBEs; 164 const int m_transitions_per_cycle; 165 const unsigned int m_buffer_size; 166 Cycles m_recycle_latency; 167 168 //! Counter for the number of cycles when the transitions carried out 169 //! were equal to the maximum allowed 170 Stats::Scalar m_fully_busy_cycles; 171 172 //! Histogram for profiling delay for the messages this controller 173 //! cares for 174 Stats::Histogram m_delayHistogram; 175 std::vector<Stats::Histogram *> m_delayVCHistogram; 176 177 //! Callback class used for collating statistics from all the 178 //! controller of this type. 179 class StatsCallback : public Callback 180 { 181 private: 182 AbstractController *ctr; 183 184 public: 185 virtual ~StatsCallback() {} 186 StatsCallback(AbstractController *_ctr) : ctr(_ctr) {} 187 void process() {ctr->collateStats();} 188 }; 189 190 /** 191 * Port that forwards requests and receives responses from the 192 * memory controller. It has a queue of packets not yet sent. 193 */ 194 class MemoryPort : public QueuedMasterPort 195 { 196 private: 197 // Packet queues used to store outgoing requests and snoop responses. 198 ReqPacketQueue reqQueue; 199 SnoopRespPacketQueue snoopRespQueue; 200 201 // Controller that operates this port. 202 AbstractController *controller; 203 204 public: 205 MemoryPort(const std::string &_name, AbstractController *_controller, 206 const std::string &_label); 207 208 // Function for receiving a timing response from the peer port. 209 // Currently the pkt is handed to the coherence controller 210 // associated with this port. 211 bool recvTimingResp(PacketPtr pkt); 212 }; 213 214 /* Master port to the memory controller. */ 215 MemoryPort memoryPort; 216 217 // State that is stored in packets sent to the memory controller. 218 struct SenderState : public Packet::SenderState 219 { 220 // Id of the machine from which the request originated. 221 MachineID id; 222 223 SenderState(MachineID _id) : id(_id) 224 {} 225 }; 226}; 227 228#endif // __MEM_RUBY_SLICC_INTERFACE_ABSTRACTCONTROLLER_HH__ 229