MessageBuffer.hh revision 11797:f61fbb7ceb88
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 "debug/RubyQueue.hh" 45#include "mem/ruby/common/Address.hh" 46#include "mem/ruby/common/Consumer.hh" 47#include "mem/ruby/slicc_interface/Message.hh" 48#include "mem/packet.hh" 49#include "params/MessageBuffer.hh" 50#include "sim/sim_object.hh" 51 52class MessageBuffer : public SimObject 53{ 54 public: 55 typedef MessageBufferParams Params; 56 MessageBuffer(const Params *p); 57 58 void reanalyzeMessages(Addr addr, Tick current_time); 59 void reanalyzeAllMessages(Tick current_time); 60 void stallMessage(Addr addr, Tick current_time); 61 62 // TRUE if head of queue timestamp <= SystemTime 63 bool isReady(Tick current_time) const; 64 65 void 66 delayHead(Tick current_time, Tick delta) 67 { 68 MsgPtr m = m_prio_heap.front(); 69 std::pop_heap(m_prio_heap.begin(), m_prio_heap.end(), 70 std::greater<MsgPtr>()); 71 m_prio_heap.pop_back(); 72 enqueue(m, current_time, delta); 73 } 74 75 bool areNSlotsAvailable(unsigned int n, Tick curTime); 76 int getPriority() { return m_priority_rank; } 77 void setPriority(int rank) { m_priority_rank = rank; } 78 void setConsumer(Consumer* consumer) 79 { 80 DPRINTF(RubyQueue, "Setting consumer: %s\n", *consumer); 81 if (m_consumer != NULL) { 82 fatal("Trying to connect %s to MessageBuffer %s. \ 83 \n%s already connected. Check the cntrl_id's.\n", 84 *consumer, *this, *m_consumer); 85 } 86 m_consumer = consumer; 87 } 88 89 Consumer* getConsumer() { return m_consumer; } 90 91 bool getOrdered() { return m_strict_fifo; } 92 93 //! Function for extracting the message at the head of the 94 //! message queue. The function assumes that the queue is nonempty. 95 const Message* peek() const; 96 97 const MsgPtr &peekMsgPtr() const { return m_prio_heap.front(); } 98 99 void enqueue(MsgPtr message, Tick curTime, Tick delta); 100 101 //! Updates the delay cycles of the message at the head of the queue, 102 //! removes it from the queue and returns its total delay. 103 Tick dequeue(Tick current_time, bool decrement_messages = true); 104 105 void registerDequeueCallback(std::function<void()> callback); 106 void unregisterDequeueCallback(); 107 108 void recycle(Tick current_time, Tick recycle_latency); 109 bool isEmpty() const { return m_prio_heap.size() == 0; } 110 bool isStallMapEmpty() { return m_stall_msg_map.size() == 0; } 111 unsigned int getStallMapSize() { return m_stall_msg_map.size(); } 112 113 unsigned int getSize(Tick curTime); 114 115 void clear(); 116 void print(std::ostream& out) const; 117 void clearStats() { m_not_avail_count = 0; m_msg_counter = 0; } 118 119 void setIncomingLink(int link_id) { m_input_link_id = link_id; } 120 void setVnet(int net) { m_vnet_id = net; } 121 122 void regStats(); 123 124 // Function for figuring out if any of the messages in the buffer need 125 // to be updated with the data from the packet. 126 // Return value indicates the number of messages that were updated. 127 // This required for debugging the code. 128 uint32_t functionalWrite(Packet *pkt); 129 130 private: 131 void reanalyzeList(std::list<MsgPtr> &, Tick); 132 133 private: 134 // Data Members (m_ prefix) 135 //! Consumer to signal a wakeup(), can be NULL 136 Consumer* m_consumer; 137 std::vector<MsgPtr> m_prio_heap; 138 139 std::function<void()> m_dequeue_callback; 140 141 // use a std::map for the stalled messages as this container is 142 // sorted and ensures a well-defined iteration order 143 typedef std::map<Addr, std::list<MsgPtr> > StallMsgMapType; 144 145 /** 146 * A map from line addresses to lists of stalled messages for that line. 147 * If this buffer allows the receiver to stall messages, on a stall 148 * request, the stalled message is removed from the m_prio_heap and placed 149 * in the m_stall_msg_map. Messages are held there until the receiver 150 * requests they be reanalyzed, at which point they are moved back to 151 * m_prio_heap. 152 * 153 * NOTE: The stall map holds messages in the order in which they were 154 * initially received, and when a line is unblocked, the messages are 155 * moved back to the m_prio_heap in the same order. This prevents starving 156 * older requests with younger ones. 157 */ 158 StallMsgMapType m_stall_msg_map; 159 160 /** 161 * Current size of the stall map. 162 * Track the number of messages held in stall map lists. This is used to 163 * ensure that if the buffer is finite-sized, it blocks further requests 164 * when the m_prio_heap and m_stall_msg_map contain m_max_size messages. 165 */ 166 int m_stall_map_size; 167 168 /** 169 * The maximum capacity. For finite-sized buffers, m_max_size stores a 170 * number greater than 0 to indicate the maximum allowed number of messages 171 * in the buffer at any time. To get infinitely-sized buffers, set buffer 172 * size: m_max_size = 0 173 */ 174 const unsigned int m_max_size; 175 176 Tick m_time_last_time_size_checked; 177 unsigned int m_size_last_time_size_checked; 178 179 // variables used so enqueues appear to happen immediately, while 180 // pop happen the next cycle 181 Tick m_time_last_time_enqueue; 182 Tick m_time_last_time_pop; 183 Tick m_last_arrival_time; 184 185 unsigned int m_size_at_cycle_start; 186 unsigned int m_msgs_this_cycle; 187 188 Stats::Scalar m_not_avail_count; // count the # of times I didn't have N 189 // slots available 190 uint64_t m_msg_counter; 191 int m_priority_rank; 192 const bool m_strict_fifo; 193 const bool m_randomization; 194 195 int m_input_link_id; 196 int m_vnet_id; 197 198 Stats::Average m_buf_msgs; 199 Stats::Average m_stall_time; 200 Stats::Scalar m_stall_count; 201 Stats::Formula m_occupancy; 202}; 203 204Tick random_time(); 205 206inline std::ostream& 207operator<<(std::ostream& out, const MessageBuffer& obj) 208{ 209 obj.print(out); 210 out << std::flush; 211 return out; 212} 213 214#endif // __MEM_RUBY_BUFFERS_MESSAGEBUFFER_HH__ 215