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);
104
105 void recycle(Tick current_time, Tick recycle_latency);
106 bool isEmpty() const { return m_prio_heap.size() == 0; }
107 bool isStallMapEmpty() { return m_stall_msg_map.size() == 0; }
108 unsigned int getStallMapSize() { return m_stall_msg_map.size(); }
109
110 unsigned int getSize(Tick curTime);
111
112 void clear();
113 void print(std::ostream& out) const;
114 void clearStats() { m_not_avail_count = 0; m_msg_counter = 0; }
115
116 void setIncomingLink(int link_id) { m_input_link_id = link_id; }
117 void setVnet(int net) { m_vnet_id = net; }
118
119 void regStats();
120
121 // Function for figuring out if any of the messages in the buffer need
122 // to be updated with the data from the packet.
123 // Return value indicates the number of messages that were updated.
124 // This required for debugging the code.
125 uint32_t functionalWrite(Packet *pkt);
126
127 private:
128 void reanalyzeList(std::list<MsgPtr> &, Tick);
129
130 private:
131 // Data Members (m_ prefix)
132 //! Consumer to signal a wakeup(), can be NULL
133 Consumer* m_consumer;
134 std::vector<MsgPtr> m_prio_heap;
135
136 // use a std::map for the stalled messages as this container is
137 // sorted and ensures a well-defined iteration order
138 typedef std::map<Addr, std::list<MsgPtr> > StallMsgMapType;
139
| 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);
104
105 void recycle(Tick current_time, Tick recycle_latency);
106 bool isEmpty() const { return m_prio_heap.size() == 0; }
107 bool isStallMapEmpty() { return m_stall_msg_map.size() == 0; }
108 unsigned int getStallMapSize() { return m_stall_msg_map.size(); }
109
110 unsigned int getSize(Tick curTime);
111
112 void clear();
113 void print(std::ostream& out) const;
114 void clearStats() { m_not_avail_count = 0; m_msg_counter = 0; }
115
116 void setIncomingLink(int link_id) { m_input_link_id = link_id; }
117 void setVnet(int net) { m_vnet_id = net; }
118
119 void regStats();
120
121 // Function for figuring out if any of the messages in the buffer need
122 // to be updated with the data from the packet.
123 // Return value indicates the number of messages that were updated.
124 // This required for debugging the code.
125 uint32_t functionalWrite(Packet *pkt);
126
127 private:
128 void reanalyzeList(std::list<MsgPtr> &, Tick);
129
130 private:
131 // Data Members (m_ prefix)
132 //! Consumer to signal a wakeup(), can be NULL
133 Consumer* m_consumer;
134 std::vector<MsgPtr> m_prio_heap;
135
136 // use a std::map for the stalled messages as this container is
137 // sorted and ensures a well-defined iteration order
138 typedef std::map<Addr, std::list<MsgPtr> > StallMsgMapType;
139
|