MessageBuffer.hh revision 9465 
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
58    setRecycleLatency(int recycle_latency)
59    {
60        m_recycle_latency = recycle_latency;
61    }
62
63    void reanalyzeMessages(const Address& addr);
64    void reanalyzeAllMessages();
65    void stallMessage(const Address& addr);
66
67    // TRUE if head of queue timestamp <= SystemTime
68    bool isReady() const;
69
70    void
71    delayHead()
72    {
73        MessageBufferNode node = m_prio_heap.front();
74        std::pop_heap(m_prio_heap.begin(), m_prio_heap.end(),
75                      std::greater<MessageBufferNode>());
76        m_prio_heap.pop_back();
77        enqueue(node.m_msgptr, 1);
78    }
79
80    bool areNSlotsAvailable(int n);
81    int getPriority() { return m_priority_rank; }
82    void setPriority(int rank) { m_priority_rank = rank; }
83    void setConsumer(Consumer* consumer_ptr)
84    {
85        assert(m_consumer_ptr == NULL);
86        m_consumer_ptr = consumer_ptr;
87    }
88
89    void setClockObj(ClockedObject* obj)
90    {
91        assert(m_clockobj_ptr == NULL);
92        m_clockobj_ptr = obj;
93    }
94
95    void setDescription(const std::string& name) { m_name = name; }
96    std::string getDescription() { return m_name;}
97
98    Consumer* getConsumer() { return m_consumer_ptr; }
99
100    const Message* peekAtHeadOfQueue() const;
101    const Message* peek() const { return peekAtHeadOfQueue(); }
102    const MsgPtr getMsgPtrCopy() const;
103
104    const MsgPtr&
105    peekMsgPtr() const
106    {
107        assert(isReady());
108        return m_prio_heap.front().m_msgptr;
109    }
110
111    const MsgPtr&
112    peekMsgPtrEvenIfNotReady() const
113    {
114        return m_prio_heap.front().m_msgptr;
115    }
116
117    void enqueue(MsgPtr message) { enqueue(message, 1); }
118    void enqueue(MsgPtr message, Time delta);
119
120    //!  returns delay ticks of the message.
121    Time dequeue_getDelayCycles(MsgPtr& message);
122    void dequeue(MsgPtr& message);
123
124    //! returns delay cycles of the message
125    Time dequeue_getDelayCycles();
126    void dequeue() { pop(); }
127    void pop();
128    void recycle();
129    bool isEmpty() const { return m_prio_heap.size() == 0; }
130
131    void
132    setOrdering(bool order)
133    {
134        m_strict_fifo = order;
135        m_ordering_set = true;
136    }
137    void resize(int size) { m_max_size = size; }
138    int getSize();
139    void setRandomization(bool random_flag) { m_randomization = random_flag; }
140
141    void clear();
142
143    void print(std::ostream& out) const;
144    void printStats(std::ostream& out);
145    void clearStats() { m_not_avail_count = 0; m_msg_counter = 0; }
146
147    void setIncomingLink(int link_id) { m_input_link_id = link_id; }
148    void setVnet(int net) { m_vnet_id = net; }
149
150    // Function for figuring out if any of the messages in the buffer can
151    // satisfy the read request for the address in the packet.
152    // Return value, if true, indicates that the request was fulfilled.
153    bool functionalRead(Packet *pkt);
154
155    // Function for figuring out if any of the messages in the buffer need
156    // to be updated with the data from the packet.
157    // Return value indicates the number of messages that were updated.
158    // This required for debugging the code.
159    uint32_t functionalWrite(Packet *pkt);
160
161  private:
162    //added by SS
163    int m_recycle_latency;
164
165    // Private Methods
166    Time setAndReturnDelayCycles(MsgPtr message);
167
168    // Private copy constructor and assignment operator
169    MessageBuffer(const MessageBuffer& obj);
170    MessageBuffer& operator=(const MessageBuffer& obj);
171
172    // Data Members (m_ prefix)
173    //! Object used for querying time.
174    ClockedObject* m_clockobj_ptr;
175    //! Consumer to signal a wakeup(), can be NULL
176    Consumer* m_consumer_ptr;
177    std::vector<MessageBufferNode> m_prio_heap;
178
179    // use a std::map for the stalled messages as this container is
180    // sorted and ensures a well-defined iteration order
181    typedef std::map< Address, std::list<MsgPtr> > StallMsgMapType;
182    typedef std::vector<MsgPtr>::iterator MsgListIter;
183
184    StallMsgMapType m_stall_msg_map;
185    std::string m_name;
186
187    int m_max_size;
188    int m_size;
189
190    Time m_time_last_time_size_checked;
191    int m_size_last_time_size_checked;
192
193    // variables used so enqueues appear to happen imediately, while
194    // pop happen the next cycle
195    Time m_time_last_time_enqueue;
196    Time m_time_last_time_pop;
197    int m_size_at_cycle_start;
198    int m_msgs_this_cycle;
199
200    int m_not_avail_count;  // count the # of times I didn't have N
201                            // slots available
202    uint64 m_msg_counter;
203    int m_priority_rank;
204    bool m_strict_fifo;
205    bool m_ordering_set;
206    bool m_randomization;
207    Time m_last_arrival_time;
208
209    int m_input_link_id;
210    int m_vnet_id;
211};
212
213inline std::ostream&
214operator<<(std::ostream& out, const MessageBuffer& obj)
215{
216    obj.print(out);
217    out << std::flush;
218    return out;
219}
220
221#endif // __MEM_RUBY_BUFFERS_MESSAGEBUFFER_HH__
222