gem5/src/mem/ruby/buffers/MessageBuffer.cc

489 lines
15 KiB
C++
Raw Normal View History

/*
* Copyright (c) 1999-2008 Mark D. Hill and David A. Wood
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met: redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer;
* redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution;
* neither the name of the copyright holders nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include <cassert>
#include "base/cprintf.hh"
#include "base/misc.hh"
#include "base/stl_helpers.hh"
#include "debug/RubyQueue.hh"
#include "mem/ruby/buffers/MessageBuffer.hh"
#include "mem/ruby/system/System.hh"
using namespace std;
using m5::stl_helpers::operator<<;
MessageBuffer::MessageBuffer(const string &name)
: m_time_last_time_size_checked(0), m_time_last_time_enqueue(0),
m_time_last_time_pop(0), m_last_arrival_time(0)
{
2010-03-23 02:43:53 +01:00
m_msg_counter = 0;
m_consumer_ptr = NULL;
m_clockobj_ptr = NULL;
2010-03-23 02:43:53 +01:00
m_ordering_set = false;
m_strict_fifo = true;
m_size = 0;
m_max_size = -1;
m_randomization = true;
m_size_last_time_size_checked = 0;
m_size_at_cycle_start = 0;
m_msgs_this_cycle = 0;
m_not_avail_count = 0;
m_priority_rank = 0;
m_name = name;
m_stall_msg_map.clear();
m_input_link_id = 0;
m_vnet_id = 0;
}
2010-03-23 02:43:53 +01:00
int
MessageBuffer::getSize()
{
if (m_time_last_time_size_checked == m_clockobj_ptr->curCycle()) {
2010-03-23 02:43:53 +01:00
return m_size_last_time_size_checked;
} else {
m_time_last_time_size_checked = m_clockobj_ptr->curCycle();
2010-03-23 02:43:53 +01:00
m_size_last_time_size_checked = m_size;
return m_size;
}
}
2010-03-23 02:43:53 +01:00
bool
MessageBuffer::areNSlotsAvailable(int n)
{
2010-03-23 02:43:53 +01:00
// fast path when message buffers have infinite size
if (m_max_size == -1) {
return true;
}
// determine my correct size for the current cycle
// pop operations shouldn't effect the network's visible size
// until next cycle, but enqueue operations effect the visible
// size immediately
int current_size = max(m_size_at_cycle_start, m_size);
if (m_time_last_time_pop < m_clockobj_ptr->curCycle()) {
2010-03-23 02:43:53 +01:00
// no pops this cycle - m_size is correct
current_size = m_size;
} else {
if (m_time_last_time_enqueue < m_clockobj_ptr->curCycle()) {
2010-03-23 02:43:53 +01:00
// no enqueues this cycle - m_size_at_cycle_start is correct
current_size = m_size_at_cycle_start;
} else {
// both pops and enqueues occured this cycle - add new
// enqueued msgs to m_size_at_cycle_start
current_size = m_size_at_cycle_start+m_msgs_this_cycle;
}
}
// now compare the new size with our max size
if (current_size + n <= m_max_size) {
return true;
} else {
DPRINTF(RubyQueue, "n: %d, current_size: %d, m_size: %d, "
"m_max_size: %d\n",
n, current_size, m_size, m_max_size);
2010-03-23 02:43:53 +01:00
m_not_avail_count++;
return false;
}
}
2010-03-23 02:43:53 +01:00
const MsgPtr
MessageBuffer::getMsgPtrCopy() const
{
2010-03-23 02:43:53 +01:00
assert(isReady());
return m_prio_heap.front().m_msgptr->clone();
}
2010-03-23 02:43:53 +01:00
const Message*
MessageBuffer::peekAtHeadOfQueue() const
{
DPRINTF(RubyQueue, "Peeking at head of queue.\n");
2010-03-23 02:43:53 +01:00
assert(isReady());
const Message* msg_ptr = m_prio_heap.front().m_msgptr.get();
assert(msg_ptr);
DPRINTF(RubyQueue, "Message: %s\n", (*msg_ptr));
2010-03-23 02:43:53 +01:00
return msg_ptr;
}
// FIXME - move me somewhere else
Cycles
2010-03-23 02:43:53 +01:00
random_time()
{
Cycles time(1);
time += Cycles(random() & 0x3); // [0...3]
2010-03-23 02:43:53 +01:00
if ((random() & 0x7) == 0) { // 1 in 8 chance
time += Cycles(100 + (random() % 0xf)); // 100 + [1...15]
2010-03-23 02:43:53 +01:00
}
return time;
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::enqueue(MsgPtr message, Cycles delta)
{
2010-03-23 02:43:53 +01:00
m_msg_counter++;
m_size++;
// record current time incase we have a pop that also adjusts my size
if (m_time_last_time_enqueue < m_clockobj_ptr->curCycle()) {
2010-03-23 02:43:53 +01:00
m_msgs_this_cycle = 0; // first msg this cycle
m_time_last_time_enqueue = m_clockobj_ptr->curCycle();
}
2010-03-23 02:43:53 +01:00
m_msgs_this_cycle++;
if (!m_ordering_set) {
panic("Ordering property of %s has not been set", m_name);
2010-03-23 02:43:53 +01:00
}
2010-03-23 02:43:53 +01:00
// Calculate the arrival time of the message, that is, the first
// cycle the message can be dequeued.
assert(delta>0);
Cycles current_time(m_clockobj_ptr->curCycle());
Cycles arrival_time(0);
2010-03-23 02:43:53 +01:00
if (!RubySystem::getRandomization() || (m_randomization == false)) {
// No randomization
arrival_time = current_time + delta;
} else {
// Randomization - ignore delta
if (m_strict_fifo) {
if (m_last_arrival_time < current_time) {
m_last_arrival_time = current_time;
}
arrival_time = m_last_arrival_time + random_time();
} else {
arrival_time = current_time + random_time();
}
}
// Check the arrival time
assert(arrival_time > current_time);
if (m_strict_fifo) {
if (arrival_time < m_last_arrival_time) {
panic("FIFO ordering violated: %s name: %s current time: %d "
"delta: %d arrival_time: %d last arrival_time: %d\n",
*this, m_name, current_time * m_clockobj_ptr->clockPeriod(),
delta * m_clockobj_ptr->clockPeriod(),
arrival_time * m_clockobj_ptr->clockPeriod(),
m_last_arrival_time * m_clockobj_ptr->clockPeriod());
2010-03-23 02:43:53 +01:00
}
}
// If running a cache trace, don't worry about the last arrival checks
if (!g_system_ptr->m_warmup_enabled) {
m_last_arrival_time = arrival_time;
}
2010-03-23 02:43:53 +01:00
// compute the delay cycles and set enqueue time
Message* msg_ptr = message.get();
2010-03-23 02:43:53 +01:00
assert(msg_ptr != NULL);
assert(m_clockobj_ptr->curCycle() >= msg_ptr->getLastEnqueueTime() &&
2010-03-23 02:43:53 +01:00
"ensure we aren't dequeued early");
msg_ptr->setDelayedCycles(m_clockobj_ptr->curCycle() -
2010-03-23 02:43:53 +01:00
msg_ptr->getLastEnqueueTime() +
msg_ptr->getDelayedCycles());
msg_ptr->setLastEnqueueTime(arrival_time);
// Insert the message into the priority heap
MessageBufferNode thisNode(arrival_time, m_msg_counter, message);
m_prio_heap.push_back(thisNode);
push_heap(m_prio_heap.begin(), m_prio_heap.end(),
greater<MessageBufferNode>());
2010-03-23 02:43:53 +01:00
DPRINTF(RubyQueue, "Enqueue arrival_time: %lld, Message: %s\n",
arrival_time * m_clockobj_ptr->clockPeriod(), *(message.get()));
2010-03-23 02:43:53 +01:00
// Schedule the wakeup
if (m_consumer_ptr != NULL) {
m_consumer_ptr->scheduleEventAbsolute(arrival_time);
m_consumer_ptr->storeEventInfo(m_vnet_id);
} else {
panic("No consumer: %s name: %s\n", *this, m_name);
}
}
Cycles
2010-03-23 02:43:53 +01:00
MessageBuffer::dequeue_getDelayCycles(MsgPtr& message)
{
2010-03-23 02:43:53 +01:00
dequeue(message);
return setAndReturnDelayCycles(message);
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::dequeue(MsgPtr& message)
{
DPRINTF(RubyQueue, "Dequeueing\n");
message = m_prio_heap.front().m_msgptr;
2010-03-23 02:43:53 +01:00
pop();
DPRINTF(RubyQueue, "Enqueue message is %s\n", (*(message.get())));
}
Cycles
2010-03-23 02:43:53 +01:00
MessageBuffer::dequeue_getDelayCycles()
{
2010-03-23 02:43:53 +01:00
// get MsgPtr of the message about to be dequeued
MsgPtr message = m_prio_heap.front().m_msgptr;
2010-03-23 02:43:53 +01:00
// get the delay cycles
Cycles delayCycles = setAndReturnDelayCycles(message);
2010-03-23 02:43:53 +01:00
dequeue();
return delayCycles;
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::pop()
{
DPRINTF(RubyQueue, "Popping\n");
2010-03-23 02:43:53 +01:00
assert(isReady());
pop_heap(m_prio_heap.begin(), m_prio_heap.end(),
greater<MessageBufferNode>());
m_prio_heap.pop_back();
2010-03-23 02:43:53 +01:00
// record previous size and time so the current buffer size isn't
// adjusted until next cycle
if (m_time_last_time_pop < m_clockobj_ptr->curCycle()) {
2010-03-23 02:43:53 +01:00
m_size_at_cycle_start = m_size;
m_time_last_time_pop = m_clockobj_ptr->curCycle();
2010-03-23 02:43:53 +01:00
}
m_size--;
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::clear()
{
m_prio_heap.clear();
2010-03-23 02:43:53 +01:00
m_msg_counter = 0;
m_size = 0;
m_time_last_time_enqueue = Cycles(0);
m_time_last_time_pop = Cycles(0);
2010-03-23 02:43:53 +01:00
m_size_at_cycle_start = 0;
m_msgs_this_cycle = 0;
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::recycle()
{
DPRINTF(RubyQueue, "Recycling.\n");
2010-03-23 02:43:53 +01:00
assert(isReady());
MessageBufferNode node = m_prio_heap.front();
pop_heap(m_prio_heap.begin(), m_prio_heap.end(),
greater<MessageBufferNode>());
node.m_time = m_clockobj_ptr->curCycle() + m_recycle_latency;
m_prio_heap.back() = node;
push_heap(m_prio_heap.begin(), m_prio_heap.end(),
greater<MessageBufferNode>());
m_consumer_ptr->scheduleEventAbsolute(m_clockobj_ptr->curCycle() +
m_recycle_latency);
}
void
MessageBuffer::reanalyzeMessages(const Address& addr)
{
DPRINTF(RubyQueue, "ReanalyzeMessages\n");
assert(m_stall_msg_map.count(addr) > 0);
Cycles nextCycle = m_clockobj_ptr->curCycle() + Cycles(1);
//
// Put all stalled messages associated with this address back on the
// prio heap
//
while(!m_stall_msg_map[addr].empty()) {
m_msg_counter++;
MessageBufferNode msgNode(nextCycle, m_msg_counter,
m_stall_msg_map[addr].front());
m_prio_heap.push_back(msgNode);
push_heap(m_prio_heap.begin(), m_prio_heap.end(),
greater<MessageBufferNode>());
m_consumer_ptr->scheduleEventAbsolute(msgNode.m_time);
m_stall_msg_map[addr].pop_front();
}
m_stall_msg_map.erase(addr);
}
void
MessageBuffer::reanalyzeAllMessages()
{
DPRINTF(RubyQueue, "ReanalyzeAllMessages %s\n");
Cycles nextCycle = m_clockobj_ptr->curCycle() + Cycles(1);
//
// Put all stalled messages associated with this address back on the
// prio heap
//
for (StallMsgMapType::iterator map_iter = m_stall_msg_map.begin();
map_iter != m_stall_msg_map.end();
++map_iter) {
while(!(map_iter->second).empty()) {
m_msg_counter++;
MessageBufferNode msgNode(nextCycle, m_msg_counter,
(map_iter->second).front());
m_prio_heap.push_back(msgNode);
push_heap(m_prio_heap.begin(), m_prio_heap.end(),
greater<MessageBufferNode>());
m_consumer_ptr->scheduleEventAbsolute(msgNode.m_time);
(map_iter->second).pop_front();
}
}
m_stall_msg_map.clear();
}
void
MessageBuffer::stallMessage(const Address& addr)
{
DPRINTF(RubyQueue, "Stalling due to %s\n", addr);
assert(isReady());
assert(addr.getOffset() == 0);
MsgPtr message = m_prio_heap.front().m_msgptr;
pop();
//
// Note: no event is scheduled to analyze the map at a later time.
// Instead the controller is responsible to call reanalyzeMessages when
// these addresses change state.
//
(m_stall_msg_map[addr]).push_back(message);
}
Cycles
MessageBuffer::setAndReturnDelayCycles(MsgPtr msg_ptr)
{
2010-03-23 02:43:53 +01:00
// get the delay cycles of the message at the top of the queue
2010-03-23 02:43:53 +01:00
// this function should only be called on dequeue
// ensure the msg hasn't been enqueued
assert(msg_ptr->getLastEnqueueTime() <= m_clockobj_ptr->curCycle());
msg_ptr->setDelayedCycles(m_clockobj_ptr->curCycle() -
msg_ptr->getLastEnqueueTime() +
msg_ptr->getDelayedCycles());
return msg_ptr->getDelayedCycles();
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::print(ostream& out) const
{
ccprintf(out, "[MessageBuffer: ");
2010-03-23 02:43:53 +01:00
if (m_consumer_ptr != NULL) {
ccprintf(out, " consumer-yes ");
2010-03-23 02:43:53 +01:00
}
vector<MessageBufferNode> copy(m_prio_heap);
sort_heap(copy.begin(), copy.end(), greater<MessageBufferNode>());
ccprintf(out, "%s] %s", copy, m_name);
}
2010-03-23 02:43:53 +01:00
void
MessageBuffer::printStats(ostream& out)
{
2010-03-23 02:43:53 +01:00
out << "MessageBuffer: " << m_name << " stats - msgs:" << m_msg_counter
<< " full:" << m_not_avail_count << endl;
}
bool
MessageBuffer::isReady() const
{
return ((m_prio_heap.size() > 0) &&
(m_prio_heap.front().m_time <= m_clockobj_ptr->curCycle()));
}
bool
MessageBuffer::functionalRead(Packet *pkt)
{
// Check the priority heap and read any messages that may
// correspond to the address in the packet.
for (unsigned int i = 0; i < m_prio_heap.size(); ++i) {
Message *msg = m_prio_heap[i].m_msgptr.get();
if (msg->functionalRead(pkt)) return true;
}
// Read the messages in the stall queue that correspond
// to the address in the packet.
for (StallMsgMapType::iterator map_iter = m_stall_msg_map.begin();
map_iter != m_stall_msg_map.end();
++map_iter) {
for (std::list<MsgPtr>::iterator it = (map_iter->second).begin();
it != (map_iter->second).end(); ++it) {
Message *msg = (*it).get();
if (msg->functionalRead(pkt)) return true;
}
}
return false;
}
uint32_t
MessageBuffer::functionalWrite(Packet *pkt)
{
uint32_t num_functional_writes = 0;
// Check the priority heap and write any messages that may
// correspond to the address in the packet.
for (unsigned int i = 0; i < m_prio_heap.size(); ++i) {
Message *msg = m_prio_heap[i].m_msgptr.get();
if (msg->functionalWrite(pkt)) {
num_functional_writes++;
}
}
// Check the stall queue and write any messages that may
// correspond to the address in the packet.
for (StallMsgMapType::iterator map_iter = m_stall_msg_map.begin();
map_iter != m_stall_msg_map.end();
++map_iter) {
for (std::list<MsgPtr>::iterator it = (map_iter->second).begin();
it != (map_iter->second).end(); ++it) {
Message *msg = (*it).get();
if (msg->functionalWrite(pkt)) {
num_functional_writes++;
}
}
}
return num_functional_writes;
}