12914SN/A/* 213564Snikos.nikoleris@arm.com * Copyright (c) 2012,2015,2018 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 4411793Sbrandon.potter@amd.com#include "mem/packet_queue.hh" 4511793Sbrandon.potter@amd.com 469356Snilay@cs.wisc.edu#include "base/trace.hh" 479152Satgutier@umich.edu#include "debug/Drain.hh" 488914Sandreas.hansson@arm.com#include "debug/PacketQueue.hh" 492914SN/A 5011207SBrad.Beckmann@amd.comPacketQueue::PacketQueue(EventManager& _em, const std::string& _label, 5112083Sspwilson2@wisc.edu const std::string& _sendEventName, 5213564Snikos.nikoleris@arm.com bool force_order, 5311207SBrad.Beckmann@amd.com bool disable_sanity_check) 5412083Sspwilson2@wisc.edu : em(_em), sendEvent([this]{ processSendEvent(); }, _sendEventName), 5512083Sspwilson2@wisc.edu _disableSanityCheck(disable_sanity_check), 5613564Snikos.nikoleris@arm.com forceOrder(force_order), 5711207SBrad.Beckmann@amd.com label(_label), waitingOnRetry(false) 585740SN/A{ 595740SN/A} 605740SN/A 618914Sandreas.hansson@arm.comPacketQueue::~PacketQueue() 625740SN/A{ 635740SN/A} 645740SN/A 658914Sandreas.hansson@arm.comvoid 668914Sandreas.hansson@arm.comPacketQueue::retry() 678914Sandreas.hansson@arm.com{ 688914Sandreas.hansson@arm.com DPRINTF(PacketQueue, "Queue %s received retry\n", name()); 698914Sandreas.hansson@arm.com assert(waitingOnRetry); 7010713Sandreas.hansson@arm.com waitingOnRetry = false; 718914Sandreas.hansson@arm.com sendDeferredPacket(); 728914Sandreas.hansson@arm.com} 738914Sandreas.hansson@arm.com 744929SN/Abool 7513860Sodanrc@yahoo.com.brPacketQueue::checkConflict(const PacketPtr pkt, const int blk_size) const 7610713Sandreas.hansson@arm.com{ 7710713Sandreas.hansson@arm.com // caller is responsible for ensuring that all packets have the 7810713Sandreas.hansson@arm.com // same alignment 7910713Sandreas.hansson@arm.com for (const auto& p : transmitList) { 8013860Sodanrc@yahoo.com.br if (p.pkt->matchBlockAddr(pkt, blk_size)) 8110713Sandreas.hansson@arm.com return true; 8210713Sandreas.hansson@arm.com } 8310713Sandreas.hansson@arm.com return false; 8410713Sandreas.hansson@arm.com} 8510713Sandreas.hansson@arm.com 8610713Sandreas.hansson@arm.combool 8712823Srmk35@cl.cam.ac.ukPacketQueue::trySatisfyFunctional(PacketPtr pkt) 883091SN/A{ 898856SN/A pkt->pushLabel(label); 908856SN/A 9110322Sandreas.hansson@arm.com auto i = transmitList.begin(); 928856SN/A bool found = false; 933296SN/A 9410322Sandreas.hansson@arm.com while (!found && i != transmitList.end()) { 958856SN/A // If the buffered packet contains data, and it overlaps the 968856SN/A // current packet, then update data 9712823Srmk35@cl.cam.ac.uk found = pkt->trySatisfyFunctional(i->pkt); 988856SN/A ++i; 993284SN/A } 1004929SN/A 1018856SN/A pkt->popLabel(); 1028856SN/A 1038856SN/A return found; 1044490SN/A} 1053342SN/A 1064490SN/Avoid 10713564Snikos.nikoleris@arm.comPacketQueue::schedSendTiming(PacketPtr pkt, Tick when) 1083403SN/A{ 10910722Sstephan.diestelhorst@arm.com DPRINTF(PacketQueue, "%s for %s address %x size %d when %lu ord: %i\n", 11010722Sstephan.diestelhorst@arm.com __func__, pkt->cmdString(), pkt->getAddr(), pkt->getSize(), when, 11113564Snikos.nikoleris@arm.com forceOrder); 11210713Sandreas.hansson@arm.com 1139160Sandreas.hansson@arm.com // we can still send a packet before the end of this tick 1149160Sandreas.hansson@arm.com assert(when >= curTick()); 1154492SN/A 1169163Sandreas.hansson@arm.com // express snoops should never be queued 1179163Sandreas.hansson@arm.com assert(!pkt->isExpressSnoop()); 1189163Sandreas.hansson@arm.com 1199390Sandreas.hansson@arm.com // add a very basic sanity check on the port to ensure the 1209390Sandreas.hansson@arm.com // invisible buffer is not growing beyond reasonable limits 12111207SBrad.Beckmann@amd.com if (!_disableSanityCheck && transmitList.size() > 100) { 1229390Sandreas.hansson@arm.com panic("Packet queue %s has grown beyond 100 packets\n", 1239390Sandreas.hansson@arm.com name()); 1249390Sandreas.hansson@arm.com } 1259390Sandreas.hansson@arm.com 12610713Sandreas.hansson@arm.com // we should either have an outstanding retry, or a send event 12710713Sandreas.hansson@arm.com // scheduled, but there is an unfortunate corner case where the 12810713Sandreas.hansson@arm.com // x86 page-table walker and timing CPU send out a new request as 12910713Sandreas.hansson@arm.com // part of the receiving of a response (called by 13010713Sandreas.hansson@arm.com // PacketQueue::sendDeferredPacket), in which we end up calling 13110713Sandreas.hansson@arm.com // ourselves again before we had a chance to update waitingOnRetry 13210713Sandreas.hansson@arm.com // assert(waitingOnRetry || sendEvent.scheduled()); 13310713Sandreas.hansson@arm.com 13411195Sandreas.hansson@arm.com // this belongs in the middle somewhere, so search from the end to 13513564Snikos.nikoleris@arm.com // order by tick; however, if forceOrder is set, also make sure 13611195Sandreas.hansson@arm.com // not to re-order in front of some existing packet with the same 13711195Sandreas.hansson@arm.com // address 13813565Snikos.nikoleris@arm.com auto it = transmitList.end(); 13913565Snikos.nikoleris@arm.com while (it != transmitList.begin()) { 14013565Snikos.nikoleris@arm.com --it; 14113860Sodanrc@yahoo.com.br if ((forceOrder && it->pkt->matchAddr(pkt)) || it->tick <= when) { 14213565Snikos.nikoleris@arm.com // emplace inserts the element before the position pointed to by 14313565Snikos.nikoleris@arm.com // the iterator, so advance it one step 14413565Snikos.nikoleris@arm.com transmitList.emplace(++it, when, pkt); 14513565Snikos.nikoleris@arm.com return; 14613565Snikos.nikoleris@arm.com } 14713565Snikos.nikoleris@arm.com } 14813565Snikos.nikoleris@arm.com // either the packet list is empty or this has to be inserted 14913565Snikos.nikoleris@arm.com // before every other packet 15013565Snikos.nikoleris@arm.com transmitList.emplace_front(when, pkt); 15113565Snikos.nikoleris@arm.com schedSendEvent(when); 1528856SN/A} 1538856SN/A 1548856SN/Avoid 15510713Sandreas.hansson@arm.comPacketQueue::schedSendEvent(Tick when) 1568856SN/A{ 15710713Sandreas.hansson@arm.com // if we are waiting on a retry just hold off 15810713Sandreas.hansson@arm.com if (waitingOnRetry) { 15910713Sandreas.hansson@arm.com DPRINTF(PacketQueue, "Not scheduling send as waiting for retry\n"); 16010713Sandreas.hansson@arm.com assert(!sendEvent.scheduled()); 16110713Sandreas.hansson@arm.com return; 16210713Sandreas.hansson@arm.com } 1638914Sandreas.hansson@arm.com 16410713Sandreas.hansson@arm.com if (when != MaxTick) { 16510713Sandreas.hansson@arm.com // we cannot go back in time, and to be consistent we stick to 16610713Sandreas.hansson@arm.com // one tick in the future 16710713Sandreas.hansson@arm.com when = std::max(when, curTick() + 1); 16810713Sandreas.hansson@arm.com // @todo Revisit the +1 16910713Sandreas.hansson@arm.com 17010423Sandreas.hansson@arm.com if (!sendEvent.scheduled()) { 17110713Sandreas.hansson@arm.com em.schedule(&sendEvent, when); 17210713Sandreas.hansson@arm.com } else if (when < sendEvent.when()) { 17310423Sandreas.hansson@arm.com // if the new time is earlier than when the event 17410423Sandreas.hansson@arm.com // currently is scheduled, move it forward 17510713Sandreas.hansson@arm.com em.reschedule(&sendEvent, when); 17610423Sandreas.hansson@arm.com } 1778856SN/A } else { 17810713Sandreas.hansson@arm.com // we get a MaxTick when there is no more to send, so if we're 17910713Sandreas.hansson@arm.com // draining, we may be done at this point 18010913Sandreas.sandberg@arm.com if (drainState() == DrainState::Draining && 18110913Sandreas.sandberg@arm.com transmitList.empty() && !sendEvent.scheduled()) { 18210913Sandreas.sandberg@arm.com 1839152Satgutier@umich.edu DPRINTF(Drain, "PacketQueue done draining," 1849152Satgutier@umich.edu "processing drain event\n"); 18510913Sandreas.sandberg@arm.com signalDrainDone(); 1868856SN/A } 1878856SN/A } 1888856SN/A} 1894492SN/A 1903403SN/Avoid 1918914Sandreas.hansson@arm.comPacketQueue::sendDeferredPacket() 1922914SN/A{ 19310713Sandreas.hansson@arm.com // sanity checks 19410713Sandreas.hansson@arm.com assert(!waitingOnRetry); 19510713Sandreas.hansson@arm.com assert(deferredPacketReady()); 19610713Sandreas.hansson@arm.com 19710713Sandreas.hansson@arm.com DeferredPacket dp = transmitList.front(); 19810713Sandreas.hansson@arm.com 19910713Sandreas.hansson@arm.com // take the packet of the list before sending it, as sending of 20010713Sandreas.hansson@arm.com // the packet in some cases causes a new packet to be enqueued 20110713Sandreas.hansson@arm.com // (most notaly when responding to the timing CPU, leading to a 20210713Sandreas.hansson@arm.com // new request hitting in the L1 icache, leading to a new 20310713Sandreas.hansson@arm.com // response) 20410713Sandreas.hansson@arm.com transmitList.pop_front(); 20510713Sandreas.hansson@arm.com 20610713Sandreas.hansson@arm.com // use the appropriate implementation of sendTiming based on the 20710713Sandreas.hansson@arm.com // type of queue 20810713Sandreas.hansson@arm.com waitingOnRetry = !sendTiming(dp.pkt); 2094492SN/A 2108856SN/A // if we succeeded and are not waiting for a retry, schedule the 2118856SN/A // next send 2128856SN/A if (!waitingOnRetry) { 21310713Sandreas.hansson@arm.com schedSendEvent(deferredPacketReadyTime()); 21410713Sandreas.hansson@arm.com } else { 21510713Sandreas.hansson@arm.com // put the packet back at the front of the list 21610745Sandreas.hansson@arm.com transmitList.emplace_front(dp); 2174492SN/A } 2184492SN/A} 2194492SN/A 2204492SN/Avoid 2218914Sandreas.hansson@arm.comPacketQueue::processSendEvent() 2224492SN/A{ 2234492SN/A assert(!waitingOnRetry); 2244492SN/A sendDeferredPacket(); 2252914SN/A} 2262914SN/A 22710913Sandreas.sandberg@arm.comDrainState 22810913Sandreas.sandberg@arm.comPacketQueue::drain() 2292914SN/A{ 23010913Sandreas.sandberg@arm.com if (transmitList.empty()) { 23110913Sandreas.sandberg@arm.com return DrainState::Drained; 23210913Sandreas.sandberg@arm.com } else { 23310913Sandreas.sandberg@arm.com DPRINTF(Drain, "PacketQueue not drained\n"); 23410913Sandreas.sandberg@arm.com return DrainState::Draining; 23510913Sandreas.sandberg@arm.com } 2362914SN/A} 2378975Sandreas.hansson@arm.com 23810713Sandreas.hansson@arm.comReqPacketQueue::ReqPacketQueue(EventManager& _em, MasterPort& _masterPort, 23910713Sandreas.hansson@arm.com const std::string _label) 24012083Sspwilson2@wisc.edu : PacketQueue(_em, _label, name(_masterPort, _label)), 24112083Sspwilson2@wisc.edu masterPort(_masterPort) 2428975Sandreas.hansson@arm.com{ 2438975Sandreas.hansson@arm.com} 2448975Sandreas.hansson@arm.com 2458975Sandreas.hansson@arm.combool 24610713Sandreas.hansson@arm.comReqPacketQueue::sendTiming(PacketPtr pkt) 2478975Sandreas.hansson@arm.com{ 24810713Sandreas.hansson@arm.com return masterPort.sendTimingReq(pkt); 2498975Sandreas.hansson@arm.com} 2508975Sandreas.hansson@arm.com 25110713Sandreas.hansson@arm.comSnoopRespPacketQueue::SnoopRespPacketQueue(EventManager& _em, 25210713Sandreas.hansson@arm.com MasterPort& _masterPort, 25313564Snikos.nikoleris@arm.com bool force_order, 25410713Sandreas.hansson@arm.com const std::string _label) 25513564Snikos.nikoleris@arm.com : PacketQueue(_em, _label, name(_masterPort, _label), force_order), 25612083Sspwilson2@wisc.edu masterPort(_masterPort) 25710713Sandreas.hansson@arm.com{ 25810713Sandreas.hansson@arm.com} 25910713Sandreas.hansson@arm.com 26010713Sandreas.hansson@arm.combool 26110713Sandreas.hansson@arm.comSnoopRespPacketQueue::sendTiming(PacketPtr pkt) 26210713Sandreas.hansson@arm.com{ 26310713Sandreas.hansson@arm.com return masterPort.sendTimingSnoopResp(pkt); 26410713Sandreas.hansson@arm.com} 26510713Sandreas.hansson@arm.com 26610713Sandreas.hansson@arm.comRespPacketQueue::RespPacketQueue(EventManager& _em, SlavePort& _slavePort, 26713564Snikos.nikoleris@arm.com bool force_order, 26810713Sandreas.hansson@arm.com const std::string _label) 26913564Snikos.nikoleris@arm.com : PacketQueue(_em, _label, name(_slavePort, _label), force_order), 27012083Sspwilson2@wisc.edu slavePort(_slavePort) 2718975Sandreas.hansson@arm.com{ 2728975Sandreas.hansson@arm.com} 2738975Sandreas.hansson@arm.com 2748975Sandreas.hansson@arm.combool 27510713Sandreas.hansson@arm.comRespPacketQueue::sendTiming(PacketPtr pkt) 2768975Sandreas.hansson@arm.com{ 2778975Sandreas.hansson@arm.com return slavePort.sendTimingResp(pkt); 2788975Sandreas.hansson@arm.com} 279