MessageBuffer.hh revision 10097
1/* 2 * Copyright (c) 1999-2008 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/* 30 * Unordered buffer of messages that can be inserted such 31 * that they can be dequeued after a given delta time has expired. 32 */ 33 34#ifndef __MEM_RUBY_BUFFERS_MESSAGEBUFFER_HH__ 35#define __MEM_RUBY_BUFFERS_MESSAGEBUFFER_HH__ 36 37#include <algorithm> 38#include <cassert> 39#include <functional> 40#include <iostream> 41#include <string> 42#include <vector> 43 44#include "mem/packet.hh" 45#include "mem/ruby/buffers/MessageBufferNode.hh" 46#include "mem/ruby/common/Address.hh" 47#include "mem/ruby/common/Consumer.hh" 48#include "mem/ruby/slicc_interface/Message.hh" 49 50class MessageBuffer 51{ 52 public: 53 MessageBuffer(const std::string &name = ""); 54 55 std::string name() const { return m_name; } 56 57 void setRecycleLatency(Cycles recycle_latency) 58 { m_recycle_latency = recycle_latency; } 59 60 void reanalyzeMessages(const Address& addr); 61 void reanalyzeAllMessages(); 62 void stallMessage(const Address& addr); 63 64 // TRUE if head of queue timestamp <= SystemTime 65 bool isReady() const; 66 67 void 68 delayHead() 69 { 70 MessageBufferNode node = m_prio_heap.front(); 71 std::pop_heap(m_prio_heap.begin(), m_prio_heap.end(), 72 std::greater<MessageBufferNode>()); 73 m_prio_heap.pop_back(); 74 enqueue(node.m_msgptr, Cycles(1)); 75 } 76 77 bool areNSlotsAvailable(unsigned int n); 78 int getPriority() { return m_priority_rank; } 79 void setPriority(int rank) { m_priority_rank = rank; } 80 void setConsumer(Consumer* consumer) 81 { 82 if (m_consumer != NULL) { 83 fatal("Trying to connect %s to MessageBuffer %s. \ 84 \n%s already connected. Check the cntrl_id's.\n", 85 *consumer, *this, *m_consumer); 86 } 87 m_consumer = consumer; 88 } 89 90 void setSender(ClockedObject* obj) 91 { 92 assert(m_sender == NULL || m_sender == obj); 93 m_sender = obj; 94 } 95 96 void setReceiver(ClockedObject* obj) 97 { 98 assert(m_receiver == NULL || m_receiver == obj); 99 m_receiver = obj; 100 } 101 102 void setDescription(const std::string& name) { m_name = name; } 103 std::string getDescription() { return m_name;} 104 105 Consumer* getConsumer() { return m_consumer; } 106 107 //! Function for extracting the message at the head of the 108 //! message queue. The function assumes that the queue is nonempty. 109 const Message* peek() const; 110 111 const MsgPtr& 112 peekMsgPtr() const 113 { 114 assert(isReady()); 115 return m_prio_heap.front().m_msgptr; 116 } 117 118 void enqueue(MsgPtr message) { enqueue(message, Cycles(1)); } 119 void enqueue(MsgPtr message, Cycles delta); 120 121 //! Updates the delay cycles of the message at the of the queue, 122 //! removes it from the queue and returns its total delay. 123 Cycles dequeue_getDelayCycles(); 124 125 void dequeue(); 126 127 void recycle(); 128 bool isEmpty() const { return m_prio_heap.size() == 0; } 129 130 void 131 setOrdering(bool order) 132 { 133 m_strict_fifo = order; 134 m_ordering_set = true; 135 } 136 137 void resize(unsigned int size) { m_max_size = size; } 138 unsigned int getSize(); 139 void setRandomization(bool random_flag) { m_randomization = random_flag; } 140 141 void clear(); 142 void print(std::ostream& out) const; 143 void clearStats() { m_not_avail_count = 0; m_msg_counter = 0; } 144 145 void setIncomingLink(int link_id) { m_input_link_id = link_id; } 146 void setVnet(int net) { m_vnet_id = net; } 147 148 // Function for figuring out if any of the messages in the buffer can 149 // satisfy the read request for the address in the packet. 150 // Return value, if true, indicates that the request was fulfilled. 151 bool functionalRead(Packet *pkt); 152 153 // Function for figuring out if any of the messages in the buffer need 154 // to be updated with the data from the packet. 155 // Return value indicates the number of messages that were updated. 156 // This required for debugging the code. 157 uint32_t functionalWrite(Packet *pkt); 158 159 private: 160 void reanalyzeList(std::list<MsgPtr> &, Tick); 161 162 private: 163 //added by SS 164 Cycles m_recycle_latency; 165 166 // Data Members (m_ prefix) 167 //! The two ends of the buffer. 168 ClockedObject* m_sender; 169 ClockedObject* m_receiver; 170 171 //! Consumer to signal a wakeup(), can be NULL 172 Consumer* m_consumer; 173 std::vector<MessageBufferNode> m_prio_heap; 174 175 // use a std::map for the stalled messages as this container is 176 // sorted and ensures a well-defined iteration order 177 typedef std::map< Address, std::list<MsgPtr> > StallMsgMapType; 178 179 StallMsgMapType m_stall_msg_map; 180 std::string m_name; 181 182 unsigned int m_max_size; 183 Cycles m_time_last_time_size_checked; 184 unsigned int m_size_last_time_size_checked; 185 186 // variables used so enqueues appear to happen imediately, while 187 // pop happen the next cycle 188 Cycles m_time_last_time_enqueue; 189 Tick m_time_last_time_pop; 190 Tick m_last_arrival_time; 191 192 unsigned int m_size_at_cycle_start; 193 unsigned int m_msgs_this_cycle; 194 195 int m_not_avail_count; // count the # of times I didn't have N 196 // slots available 197 uint64 m_msg_counter; 198 int m_priority_rank; 199 bool m_strict_fifo; 200 bool m_ordering_set; 201 bool m_randomization; 202 203 int m_input_link_id; 204 int m_vnet_id; 205}; 206 207Cycles random_time(); 208 209inline std::ostream& 210operator<<(std::ostream& out, const MessageBuffer& obj) 211{ 212 obj.print(out); 213 out << std::flush; 214 return out; 215} 216 217#endif // __MEM_RUBY_BUFFERS_MESSAGEBUFFER_HH__ 218