packet_queue.cc revision 10713
1/* 2 * Copyright (c) 2012,2015 ARM Limited 3 * All rights reserved. 4 * 5 * The license below extends only to copyright in the software and shall 6 * not be construed as granting a license to any other intellectual 7 * property including but not limited to intellectual property relating 8 * to a hardware implementation of the functionality of the software 9 * licensed hereunder. You may use the software subject to the license 10 * terms below provided that you ensure that this notice is replicated 11 * unmodified and in its entirety in all distributions of the software, 12 * modified or unmodified, in source code or in binary form. 13 * 14 * Copyright (c) 2006 The Regents of The University of Michigan 15 * All rights reserved. 16 * 17 * Redistribution and use in source and binary forms, with or without 18 * modification, are permitted provided that the following conditions are 19 * met: redistributions of source code must retain the above copyright 20 * notice, this list of conditions and the following disclaimer; 21 * redistributions in binary form must reproduce the above copyright 22 * notice, this list of conditions and the following disclaimer in the 23 * documentation and/or other materials provided with the distribution; 24 * neither the name of the copyright holders nor the names of its 25 * contributors may be used to endorse or promote products derived from 26 * this software without specific prior written permission. 27 * 28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 39 * 40 * Authors: Ali Saidi 41 * Andreas Hansson 42 */ 43 44#include "base/trace.hh" 45#include "debug/Drain.hh" 46#include "debug/PacketQueue.hh" 47#include "mem/packet_queue.hh" 48 49using namespace std; 50 51PacketQueue::PacketQueue(EventManager& _em, const std::string& _label) 52 : em(_em), sendEvent(this), drainManager(NULL), label(_label), 53 waitingOnRetry(false) 54{ 55} 56 57PacketQueue::~PacketQueue() 58{ 59} 60 61void 62PacketQueue::retry() 63{ 64 DPRINTF(PacketQueue, "Queue %s received retry\n", name()); 65 assert(waitingOnRetry); 66 waitingOnRetry = false; 67 sendDeferredPacket(); 68} 69 70bool 71PacketQueue::hasAddr(Addr addr) const 72{ 73 // caller is responsible for ensuring that all packets have the 74 // same alignment 75 for (const auto& p : transmitList) { 76 if (p.pkt->getAddr() == addr) 77 return true; 78 } 79 return false; 80} 81 82bool 83PacketQueue::checkFunctional(PacketPtr pkt) 84{ 85 pkt->pushLabel(label); 86 87 auto i = transmitList.begin(); 88 bool found = false; 89 90 while (!found && i != transmitList.end()) { 91 // If the buffered packet contains data, and it overlaps the 92 // current packet, then update data 93 found = pkt->checkFunctional(i->pkt); 94 ++i; 95 } 96 97 pkt->popLabel(); 98 99 return found; 100} 101 102void 103PacketQueue::schedSendTiming(PacketPtr pkt, Tick when) 104{ 105 DPRINTF(PacketQueue, "%s for %s address %x size %d\n", __func__, 106 pkt->cmdString(), pkt->getAddr(), pkt->getSize()); 107 108 // we can still send a packet before the end of this tick 109 assert(when >= curTick()); 110 111 // express snoops should never be queued 112 assert(!pkt->isExpressSnoop()); 113 114 // add a very basic sanity check on the port to ensure the 115 // invisible buffer is not growing beyond reasonable limits 116 if (transmitList.size() > 100) { 117 panic("Packet queue %s has grown beyond 100 packets\n", 118 name()); 119 } 120 121 // nothing on the list, or earlier than current front element, 122 // schedule an event 123 if (transmitList.empty() || when < transmitList.front().tick) { 124 // note that currently we ignore a potentially outstanding retry 125 // and could in theory put a new packet at the head of the 126 // transmit list before retrying the existing packet 127 transmitList.push_front(DeferredPacket(when, pkt)); 128 schedSendEvent(when); 129 return; 130 } 131 132 // we should either have an outstanding retry, or a send event 133 // scheduled, but there is an unfortunate corner case where the 134 // x86 page-table walker and timing CPU send out a new request as 135 // part of the receiving of a response (called by 136 // PacketQueue::sendDeferredPacket), in which we end up calling 137 // ourselves again before we had a chance to update waitingOnRetry 138 // assert(waitingOnRetry || sendEvent.scheduled()); 139 140 // list is non-empty and this belongs at the end 141 if (when >= transmitList.back().tick) { 142 transmitList.push_back(DeferredPacket(when, pkt)); 143 return; 144 } 145 146 // this belongs in the middle somewhere, insertion sort 147 auto i = transmitList.begin(); 148 ++i; // already checked for insertion at front 149 while (i != transmitList.end() && when >= i->tick) 150 ++i; 151 transmitList.insert(i, DeferredPacket(when, pkt)); 152} 153 154void 155PacketQueue::schedSendEvent(Tick when) 156{ 157 // if we are waiting on a retry just hold off 158 if (waitingOnRetry) { 159 DPRINTF(PacketQueue, "Not scheduling send as waiting for retry\n"); 160 assert(!sendEvent.scheduled()); 161 return; 162 } 163 164 if (when != MaxTick) { 165 // we cannot go back in time, and to be consistent we stick to 166 // one tick in the future 167 when = std::max(when, curTick() + 1); 168 // @todo Revisit the +1 169 170 if (!sendEvent.scheduled()) { 171 em.schedule(&sendEvent, when); 172 } else if (when < sendEvent.when()) { 173 // if the new time is earlier than when the event 174 // currently is scheduled, move it forward 175 em.reschedule(&sendEvent, when); 176 } 177 } else { 178 // we get a MaxTick when there is no more to send, so if we're 179 // draining, we may be done at this point 180 if (drainManager && transmitList.empty() && !sendEvent.scheduled()) { 181 DPRINTF(Drain, "PacketQueue done draining," 182 "processing drain event\n"); 183 drainManager->signalDrainDone(); 184 drainManager = NULL; 185 } 186 } 187} 188 189void 190PacketQueue::sendDeferredPacket() 191{ 192 // sanity checks 193 assert(!waitingOnRetry); 194 assert(deferredPacketReady()); 195 196 DeferredPacket dp = transmitList.front(); 197 198 // take the packet of the list before sending it, as sending of 199 // the packet in some cases causes a new packet to be enqueued 200 // (most notaly when responding to the timing CPU, leading to a 201 // new request hitting in the L1 icache, leading to a new 202 // response) 203 transmitList.pop_front(); 204 205 // use the appropriate implementation of sendTiming based on the 206 // type of queue 207 waitingOnRetry = !sendTiming(dp.pkt); 208 209 // if we succeeded and are not waiting for a retry, schedule the 210 // next send 211 if (!waitingOnRetry) { 212 schedSendEvent(deferredPacketReadyTime()); 213 } else { 214 // put the packet back at the front of the list 215 transmitList.push_front(dp); 216 } 217} 218 219void 220PacketQueue::processSendEvent() 221{ 222 assert(!waitingOnRetry); 223 sendDeferredPacket(); 224} 225 226unsigned int 227PacketQueue::drain(DrainManager *dm) 228{ 229 if (transmitList.empty()) 230 return 0; 231 DPRINTF(Drain, "PacketQueue not drained\n"); 232 drainManager = dm; 233 return 1; 234} 235 236ReqPacketQueue::ReqPacketQueue(EventManager& _em, MasterPort& _masterPort, 237 const std::string _label) 238 : PacketQueue(_em, _label), masterPort(_masterPort) 239{ 240} 241 242bool 243ReqPacketQueue::sendTiming(PacketPtr pkt) 244{ 245 return masterPort.sendTimingReq(pkt); 246} 247 248SnoopRespPacketQueue::SnoopRespPacketQueue(EventManager& _em, 249 MasterPort& _masterPort, 250 const std::string _label) 251 : PacketQueue(_em, _label), masterPort(_masterPort) 252{ 253} 254 255bool 256SnoopRespPacketQueue::sendTiming(PacketPtr pkt) 257{ 258 return masterPort.sendTimingSnoopResp(pkt); 259} 260 261RespPacketQueue::RespPacketQueue(EventManager& _em, SlavePort& _slavePort, 262 const std::string _label) 263 : PacketQueue(_em, _label), slavePort(_slavePort) 264{ 265} 266 267bool 268RespPacketQueue::sendTiming(PacketPtr pkt) 269{ 270 return slavePort.sendTimingResp(pkt); 271} 272