packet_queue.cc revision 10322
12914SN/A/* 28856SN/A * Copyright (c) 2012 ARM Limited 38856SN/A * All rights reserved. 48856SN/A * 58856SN/A * The license below extends only to copyright in the software and shall 68856SN/A * not be construed as granting a license to any other intellectual 78856SN/A * property including but not limited to intellectual property relating 88856SN/A * to a hardware implementation of the functionality of the software 98856SN/A * licensed hereunder. You may use the software subject to the license 108856SN/A * terms below provided that you ensure that this notice is replicated 118856SN/A * unmodified and in its entirety in all distributions of the software, 128856SN/A * modified or unmodified, in source code or in binary form. 138856SN/A * 142914SN/A * Copyright (c) 2006 The Regents of The University of Michigan 152914SN/A * All rights reserved. 162914SN/A * 172914SN/A * Redistribution and use in source and binary forms, with or without 182914SN/A * modification, are permitted provided that the following conditions are 192914SN/A * met: redistributions of source code must retain the above copyright 202914SN/A * notice, this list of conditions and the following disclaimer; 212914SN/A * redistributions in binary form must reproduce the above copyright 222914SN/A * notice, this list of conditions and the following disclaimer in the 232914SN/A * documentation and/or other materials provided with the distribution; 242914SN/A * neither the name of the copyright holders nor the names of its 252914SN/A * contributors may be used to endorse or promote products derived from 262914SN/A * this software without specific prior written permission. 272914SN/A * 282914SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292914SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302914SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312914SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322914SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332914SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342914SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352914SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362914SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372914SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382914SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392914SN/A * 402914SN/A * Authors: Ali Saidi 418856SN/A * Andreas Hansson 422914SN/A */ 432914SN/A 449356Snilay@cs.wisc.edu#include "base/trace.hh" 459152Satgutier@umich.edu#include "debug/Drain.hh" 468914Sandreas.hansson@arm.com#include "debug/PacketQueue.hh" 478914Sandreas.hansson@arm.com#include "mem/packet_queue.hh" 482914SN/A 495740SN/Ausing namespace std; 505740SN/A 518975Sandreas.hansson@arm.comPacketQueue::PacketQueue(EventManager& _em, const std::string& _label) 529342SAndreas.Sandberg@arm.com : em(_em), sendEvent(this), drainManager(NULL), label(_label), 535740SN/A waitingOnRetry(false) 545740SN/A{ 555740SN/A} 565740SN/A 578914Sandreas.hansson@arm.comPacketQueue::~PacketQueue() 585740SN/A{ 595740SN/A} 605740SN/A 618914Sandreas.hansson@arm.comvoid 628914Sandreas.hansson@arm.comPacketQueue::retry() 638914Sandreas.hansson@arm.com{ 648914Sandreas.hansson@arm.com DPRINTF(PacketQueue, "Queue %s received retry\n", name()); 658914Sandreas.hansson@arm.com assert(waitingOnRetry); 668914Sandreas.hansson@arm.com sendDeferredPacket(); 678914Sandreas.hansson@arm.com} 688914Sandreas.hansson@arm.com 694929SN/Abool 708914Sandreas.hansson@arm.comPacketQueue::checkFunctional(PacketPtr pkt) 713091SN/A{ 728856SN/A pkt->pushLabel(label); 738856SN/A 7410322Sandreas.hansson@arm.com auto i = transmitList.begin(); 758856SN/A bool found = false; 763296SN/A 7710322Sandreas.hansson@arm.com while (!found && i != transmitList.end()) { 788856SN/A // If the buffered packet contains data, and it overlaps the 798856SN/A // current packet, then update data 808856SN/A found = pkt->checkFunctional(i->pkt); 818856SN/A ++i; 823284SN/A } 834929SN/A 848856SN/A pkt->popLabel(); 858856SN/A 868856SN/A return found; 874490SN/A} 883342SN/A 894490SN/Avoid 908914Sandreas.hansson@arm.comPacketQueue::schedSendEvent(Tick when) 918708SN/A{ 928856SN/A // if we are waiting on a retry, do not schedule a send event, and 938856SN/A // instead rely on retry being called 948708SN/A if (waitingOnRetry) { 958856SN/A assert(!sendEvent.scheduled()); 968708SN/A return; 978708SN/A } 988708SN/A 998856SN/A if (!sendEvent.scheduled()) { 1008914Sandreas.hansson@arm.com em.schedule(&sendEvent, when); 1018856SN/A } else if (sendEvent.when() > when) { 1028914Sandreas.hansson@arm.com em.reschedule(&sendEvent, when); 1038708SN/A } 1048708SN/A} 1052914SN/A 1062914SN/Avoid 1078948Sandreas.hansson@arm.comPacketQueue::schedSendTiming(PacketPtr pkt, Tick when, bool send_as_snoop) 1083403SN/A{ 1099663Suri.wiener@arm.com DPRINTF(PacketQueue, "%s for %s address %x size %d\n", __func__, 1109663Suri.wiener@arm.com pkt->cmdString(), pkt->getAddr(), pkt->getSize()); 1119160Sandreas.hansson@arm.com // we can still send a packet before the end of this tick 1129160Sandreas.hansson@arm.com assert(when >= curTick()); 1134492SN/A 1149163Sandreas.hansson@arm.com // express snoops should never be queued 1159163Sandreas.hansson@arm.com assert(!pkt->isExpressSnoop()); 1169163Sandreas.hansson@arm.com 1179390Sandreas.hansson@arm.com // add a very basic sanity check on the port to ensure the 1189390Sandreas.hansson@arm.com // invisible buffer is not growing beyond reasonable limits 1199390Sandreas.hansson@arm.com if (transmitList.size() > 100) { 1209390Sandreas.hansson@arm.com panic("Packet queue %s has grown beyond 100 packets\n", 1219390Sandreas.hansson@arm.com name()); 1229390Sandreas.hansson@arm.com } 1239390Sandreas.hansson@arm.com 1248914Sandreas.hansson@arm.com // nothing on the list, or earlier than current front element, 1258914Sandreas.hansson@arm.com // schedule an event 1264666SN/A if (transmitList.empty() || when < transmitList.front().tick) { 1278914Sandreas.hansson@arm.com // note that currently we ignore a potentially outstanding retry 1288914Sandreas.hansson@arm.com // and could in theory put a new packet at the head of the 1298914Sandreas.hansson@arm.com // transmit list before retrying the existing packet 1308948Sandreas.hansson@arm.com transmitList.push_front(DeferredPacket(when, pkt, send_as_snoop)); 1314666SN/A schedSendEvent(when); 1324666SN/A return; 1334666SN/A } 1344666SN/A 1358914Sandreas.hansson@arm.com // list is non-empty and this belongs at the end 1364666SN/A if (when >= transmitList.back().tick) { 1378948Sandreas.hansson@arm.com transmitList.push_back(DeferredPacket(when, pkt, send_as_snoop)); 1383450SN/A return; 1393403SN/A } 1403450SN/A 1418914Sandreas.hansson@arm.com // this belongs in the middle somewhere, insertion sort 14210322Sandreas.hansson@arm.com auto i = transmitList.begin(); 1438914Sandreas.hansson@arm.com ++i; // already checked for insertion at front 1448914Sandreas.hansson@arm.com while (i != transmitList.end() && when >= i->tick) 1458914Sandreas.hansson@arm.com ++i; 1468948Sandreas.hansson@arm.com transmitList.insert(i, DeferredPacket(when, pkt, send_as_snoop)); 1473403SN/A} 1483403SN/A 1498914Sandreas.hansson@arm.comvoid PacketQueue::trySendTiming() 1508856SN/A{ 1518856SN/A assert(deferredPacketReady()); 1528914Sandreas.hansson@arm.com 1538856SN/A DeferredPacket dp = transmitList.front(); 1548856SN/A 1558975Sandreas.hansson@arm.com // use the appropriate implementation of sendTiming based on the 1568975Sandreas.hansson@arm.com // type of port associated with the queue, and whether the packet 1578975Sandreas.hansson@arm.com // is to be sent as a snoop or not 1588975Sandreas.hansson@arm.com waitingOnRetry = !sendTiming(dp.pkt, dp.sendAsSnoop); 1598856SN/A 16010322Sandreas.hansson@arm.com if (!waitingOnRetry) { 16110322Sandreas.hansson@arm.com // take the packet off the list 16210322Sandreas.hansson@arm.com transmitList.pop_front(); 1638856SN/A } 1648856SN/A} 1658856SN/A 1668856SN/Avoid 1678914Sandreas.hansson@arm.comPacketQueue::scheduleSend(Tick time) 1688856SN/A{ 1698856SN/A // the next ready time is either determined by the next deferred packet, 1708856SN/A // or in the cache through the MSHR ready time 1718856SN/A Tick nextReady = std::min(deferredPacketReadyTime(), time); 1728914Sandreas.hansson@arm.com 1738856SN/A if (nextReady != MaxTick) { 1748856SN/A // if the sendTiming caused someone else to call our 1758856SN/A // recvTiming we could already have an event scheduled, check 1768856SN/A if (!sendEvent.scheduled()) 1778914Sandreas.hansson@arm.com em.schedule(&sendEvent, std::max(nextReady, curTick() + 1)); 1788856SN/A } else { 1798856SN/A // no more to send, so if we're draining, we may be done 1809342SAndreas.Sandberg@arm.com if (drainManager && transmitList.empty() && !sendEvent.scheduled()) { 1819152Satgutier@umich.edu DPRINTF(Drain, "PacketQueue done draining," 1829152Satgutier@umich.edu "processing drain event\n"); 1839342SAndreas.Sandberg@arm.com drainManager->signalDrainDone(); 1849342SAndreas.Sandberg@arm.com drainManager = NULL; 1858856SN/A } 1868856SN/A } 1878856SN/A} 1884492SN/A 1893403SN/Avoid 1908914Sandreas.hansson@arm.comPacketQueue::sendDeferredPacket() 1912914SN/A{ 1928914Sandreas.hansson@arm.com // try to send what is on the list, this will set waitingOnRetry 1938914Sandreas.hansson@arm.com // accordingly 1948856SN/A trySendTiming(); 1954492SN/A 1968856SN/A // if we succeeded and are not waiting for a retry, schedule the 1978856SN/A // next send 1988856SN/A if (!waitingOnRetry) { 1998856SN/A scheduleSend(); 2004492SN/A } 2014492SN/A} 2024492SN/A 2034492SN/Avoid 2048914Sandreas.hansson@arm.comPacketQueue::processSendEvent() 2054492SN/A{ 2064492SN/A assert(!waitingOnRetry); 2074492SN/A sendDeferredPacket(); 2082914SN/A} 2092914SN/A 2102914SN/Aunsigned int 2119342SAndreas.Sandberg@arm.comPacketQueue::drain(DrainManager *dm) 2122914SN/A{ 21310322Sandreas.hansson@arm.com if (transmitList.empty()) 2142914SN/A return 0; 2159152Satgutier@umich.edu DPRINTF(Drain, "PacketQueue not drained\n"); 2169342SAndreas.Sandberg@arm.com drainManager = dm; 2172914SN/A return 1; 2182914SN/A} 2198975Sandreas.hansson@arm.com 2208975Sandreas.hansson@arm.comMasterPacketQueue::MasterPacketQueue(EventManager& _em, MasterPort& _masterPort, 2218975Sandreas.hansson@arm.com const std::string _label) 2228975Sandreas.hansson@arm.com : PacketQueue(_em, _label), masterPort(_masterPort) 2238975Sandreas.hansson@arm.com{ 2248975Sandreas.hansson@arm.com} 2258975Sandreas.hansson@arm.com 2268975Sandreas.hansson@arm.combool 2278975Sandreas.hansson@arm.comMasterPacketQueue::sendTiming(PacketPtr pkt, bool send_as_snoop) 2288975Sandreas.hansson@arm.com{ 2298975Sandreas.hansson@arm.com // attempt to send the packet and return according to the outcome 2308975Sandreas.hansson@arm.com if (!send_as_snoop) 2318975Sandreas.hansson@arm.com return masterPort.sendTimingReq(pkt); 2328975Sandreas.hansson@arm.com else 2338975Sandreas.hansson@arm.com return masterPort.sendTimingSnoopResp(pkt); 2348975Sandreas.hansson@arm.com} 2358975Sandreas.hansson@arm.com 2368975Sandreas.hansson@arm.comSlavePacketQueue::SlavePacketQueue(EventManager& _em, SlavePort& _slavePort, 2378975Sandreas.hansson@arm.com const std::string _label) 2388975Sandreas.hansson@arm.com : PacketQueue(_em, _label), slavePort(_slavePort) 2398975Sandreas.hansson@arm.com{ 2408975Sandreas.hansson@arm.com} 2418975Sandreas.hansson@arm.com 2428975Sandreas.hansson@arm.combool 2438975Sandreas.hansson@arm.comSlavePacketQueue::sendTiming(PacketPtr pkt, bool send_as_snoop) 2448975Sandreas.hansson@arm.com{ 2458975Sandreas.hansson@arm.com // we should never have queued snoop requests 2468975Sandreas.hansson@arm.com assert(!send_as_snoop); 2478975Sandreas.hansson@arm.com return slavePort.sendTimingResp(pkt); 2488975Sandreas.hansson@arm.com} 249