packet_queue.hh revision 11195
12914SN/A/* 210713Sandreas.hansson@arm.com * Copyright (c) 2012,2015 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 448914Sandreas.hansson@arm.com#ifndef __MEM_PACKET_QUEUE_HH__ 458914Sandreas.hansson@arm.com#define __MEM_PACKET_QUEUE_HH__ 463091SN/A 472914SN/A/** 482914SN/A * @file 498914Sandreas.hansson@arm.com * Declaration of a simple PacketQueue that is associated with 508914Sandreas.hansson@arm.com * a port on which it attempts to send packets according to the time 518914Sandreas.hansson@arm.com * stamp given to them at insertion. The packet queue is responsible 5210713Sandreas.hansson@arm.com * for the flow control of the port. 532914SN/A */ 542914SN/A 558229SN/A#include <list> 568229SN/A 572914SN/A#include "mem/port.hh" 589342SAndreas.Sandberg@arm.com#include "sim/drain.hh" 599356Snilay@cs.wisc.edu#include "sim/eventq_impl.hh" 602914SN/A 613091SN/A/** 628914Sandreas.hansson@arm.com * A packet queue is a class that holds deferred packets and later 638914Sandreas.hansson@arm.com * sends them using the associated slave port or master port. 643091SN/A */ 659342SAndreas.Sandberg@arm.comclass PacketQueue : public Drainable 662914SN/A{ 678914Sandreas.hansson@arm.com private: 684490SN/A /** A deferred packet, buffered to transmit later. */ 694490SN/A class DeferredPacket { 704490SN/A public: 714490SN/A Tick tick; ///< The tick when the packet is ready to transmit 724490SN/A PacketPtr pkt; ///< Pointer to the packet to transmit 7310713Sandreas.hansson@arm.com DeferredPacket(Tick t, PacketPtr p) 7410713Sandreas.hansson@arm.com : tick(t), pkt(p) 754490SN/A {} 764490SN/A }; 774490SN/A 784490SN/A typedef std::list<DeferredPacket> DeferredPacketList; 794490SN/A 8010713Sandreas.hansson@arm.com /** A list of outgoing packets. */ 814490SN/A DeferredPacketList transmitList; 824490SN/A 838914Sandreas.hansson@arm.com /** The manager which is used for the event queue */ 848914Sandreas.hansson@arm.com EventManager& em; 858914Sandreas.hansson@arm.com 8610713Sandreas.hansson@arm.com /** Used to schedule sending of deferred packets. */ 874490SN/A void processSendEvent(); 883091SN/A 8910713Sandreas.hansson@arm.com /** Event used to call processSendEvent. */ 908914Sandreas.hansson@arm.com EventWrapper<PacketQueue, &PacketQueue::processSendEvent> sendEvent; 912914SN/A 928914Sandreas.hansson@arm.com protected: 938914Sandreas.hansson@arm.com 948975Sandreas.hansson@arm.com /** Label to use for print request packets label stack. */ 958975Sandreas.hansson@arm.com const std::string label; 968914Sandreas.hansson@arm.com 9710713Sandreas.hansson@arm.com /** Remember whether we're awaiting a retry. */ 984492SN/A bool waitingOnRetry; 994492SN/A 1004492SN/A /** Check whether we have a packet ready to go on the transmit list. */ 10110322Sandreas.hansson@arm.com bool deferredPacketReady() const 1027823SN/A { return !transmitList.empty() && transmitList.front().tick <= curTick(); } 1034492SN/A 1048708SN/A /** 10510713Sandreas.hansson@arm.com * Attempt to send a packet. Note that a subclass of the 10610713Sandreas.hansson@arm.com * PacketQueue can override this method and thus change the 10710713Sandreas.hansson@arm.com * behaviour (as done by the cache for the request queue). The 10810713Sandreas.hansson@arm.com * default implementation sends the head of the transmit list. The 10910713Sandreas.hansson@arm.com * caller must guarantee that the list is non-empty and that the 11010713Sandreas.hansson@arm.com * head packet is scheduled for curTick() (or earlier). 1114492SN/A */ 1128856SN/A virtual void sendDeferredPacket(); 1138856SN/A 1148856SN/A /** 11510713Sandreas.hansson@arm.com * Send a packet using the appropriate method for the specific 11610713Sandreas.hansson@arm.com * subclass (reuest, response or snoop response). 1178856SN/A */ 11810713Sandreas.hansson@arm.com virtual bool sendTiming(PacketPtr pkt) = 0; 1193091SN/A 1208914Sandreas.hansson@arm.com /** 1218975Sandreas.hansson@arm.com * Create a packet queue, linked to an event manager, and a label 1228975Sandreas.hansson@arm.com * that will be used for functional print request packets. 1238914Sandreas.hansson@arm.com * 1248914Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 1258914Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 1268914Sandreas.hansson@arm.com */ 1278975Sandreas.hansson@arm.com PacketQueue(EventManager& _em, const std::string& _label); 1288914Sandreas.hansson@arm.com 1298914Sandreas.hansson@arm.com /** 1308914Sandreas.hansson@arm.com * Virtual desctructor since the class may be used as a base class. 1318914Sandreas.hansson@arm.com */ 1328914Sandreas.hansson@arm.com virtual ~PacketQueue(); 1338914Sandreas.hansson@arm.com 1348975Sandreas.hansson@arm.com public: 1358975Sandreas.hansson@arm.com 1368914Sandreas.hansson@arm.com /** 1378975Sandreas.hansson@arm.com * Provide a name to simplify debugging. 1388914Sandreas.hansson@arm.com * 1398914Sandreas.hansson@arm.com * @return A complete name, appended to module and port 1408914Sandreas.hansson@arm.com */ 1418975Sandreas.hansson@arm.com virtual const std::string name() const = 0; 1424490SN/A 14310713Sandreas.hansson@arm.com /** 14410713Sandreas.hansson@arm.com * Get the size of the queue. 14510713Sandreas.hansson@arm.com */ 14610713Sandreas.hansson@arm.com size_t size() const { return transmitList.size(); } 14710713Sandreas.hansson@arm.com 14810713Sandreas.hansson@arm.com /** 14910713Sandreas.hansson@arm.com * Get the next packet ready time. 15010713Sandreas.hansson@arm.com */ 15110713Sandreas.hansson@arm.com Tick deferredPacketReadyTime() const 15210713Sandreas.hansson@arm.com { return transmitList.empty() ? MaxTick : transmitList.front().tick; } 15310713Sandreas.hansson@arm.com 15410713Sandreas.hansson@arm.com /** 15510713Sandreas.hansson@arm.com * Check if a packets address exists in the queue. 15610713Sandreas.hansson@arm.com */ 15710713Sandreas.hansson@arm.com bool hasAddr(Addr addr) const; 15810713Sandreas.hansson@arm.com 1598856SN/A /** Check the list of buffered packets against the supplied 1608856SN/A * functional request. */ 1618856SN/A bool checkFunctional(PacketPtr pkt); 1628856SN/A 1638914Sandreas.hansson@arm.com /** 16410713Sandreas.hansson@arm.com * Schedule a send event if we are not already waiting for a 16510713Sandreas.hansson@arm.com * retry. If the requested time is before an already scheduled 16610713Sandreas.hansson@arm.com * send event, the event will be rescheduled. If MaxTick is 16710713Sandreas.hansson@arm.com * passed, no event is scheduled. Instead, if we are idle and 16810713Sandreas.hansson@arm.com * asked to drain then check and signal drained. 1698914Sandreas.hansson@arm.com * 17010713Sandreas.hansson@arm.com * @param when time to schedule an event 1718914Sandreas.hansson@arm.com */ 1728914Sandreas.hansson@arm.com void schedSendEvent(Tick when); 1738914Sandreas.hansson@arm.com 1748914Sandreas.hansson@arm.com /** 17510713Sandreas.hansson@arm.com * Add a packet to the transmit list, and schedule a send event. 1768914Sandreas.hansson@arm.com * 1778914Sandreas.hansson@arm.com * @param pkt Packet to send 1788914Sandreas.hansson@arm.com * @param when Absolute time (in ticks) to send packet 17911195Sandreas.hansson@arm.com * @param force_order Force insertion order for packets with same address 1808914Sandreas.hansson@arm.com */ 18110722Sstephan.diestelhorst@arm.com void schedSendTiming(PacketPtr pkt, Tick when, bool force_order = false); 1828914Sandreas.hansson@arm.com 1838914Sandreas.hansson@arm.com /** 18410713Sandreas.hansson@arm.com * Retry sending a packet from the queue. Note that this is not 18510713Sandreas.hansson@arm.com * necessarily the same packet if something has been added with an 18610713Sandreas.hansson@arm.com * earlier time stamp. 1878914Sandreas.hansson@arm.com */ 1888914Sandreas.hansson@arm.com void retry(); 1898914Sandreas.hansson@arm.com 19011168Sandreas.hansson@arm.com DrainState drain() override; 1912914SN/A}; 1922914SN/A 19310713Sandreas.hansson@arm.comclass ReqPacketQueue : public PacketQueue 1948975Sandreas.hansson@arm.com{ 1958975Sandreas.hansson@arm.com 1968975Sandreas.hansson@arm.com protected: 1978975Sandreas.hansson@arm.com 1988975Sandreas.hansson@arm.com MasterPort& masterPort; 1998975Sandreas.hansson@arm.com 2008975Sandreas.hansson@arm.com public: 2018975Sandreas.hansson@arm.com 2028975Sandreas.hansson@arm.com /** 20310713Sandreas.hansson@arm.com * Create a request packet queue, linked to an event manager, a 2048975Sandreas.hansson@arm.com * master port, and a label that will be used for functional print 2058975Sandreas.hansson@arm.com * request packets. 2068975Sandreas.hansson@arm.com * 2078975Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 2088975Sandreas.hansson@arm.com * @param _masterPort Master port used to send the packets 2098975Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 2108975Sandreas.hansson@arm.com */ 21110713Sandreas.hansson@arm.com ReqPacketQueue(EventManager& _em, MasterPort& _masterPort, 21210713Sandreas.hansson@arm.com const std::string _label = "ReqPacketQueue"); 2138975Sandreas.hansson@arm.com 21410713Sandreas.hansson@arm.com virtual ~ReqPacketQueue() { } 2158975Sandreas.hansson@arm.com 2168975Sandreas.hansson@arm.com const std::string name() const 2178975Sandreas.hansson@arm.com { return masterPort.name() + "-" + label; } 2188975Sandreas.hansson@arm.com 21910713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 22010713Sandreas.hansson@arm.com 2218975Sandreas.hansson@arm.com}; 2228975Sandreas.hansson@arm.com 22310713Sandreas.hansson@arm.comclass SnoopRespPacketQueue : public PacketQueue 22410713Sandreas.hansson@arm.com{ 22510713Sandreas.hansson@arm.com 22610713Sandreas.hansson@arm.com protected: 22710713Sandreas.hansson@arm.com 22810713Sandreas.hansson@arm.com MasterPort& masterPort; 22910713Sandreas.hansson@arm.com 23010713Sandreas.hansson@arm.com public: 23110713Sandreas.hansson@arm.com 23210713Sandreas.hansson@arm.com /** 23310713Sandreas.hansson@arm.com * Create a snoop response packet queue, linked to an event 23410713Sandreas.hansson@arm.com * manager, a master port, and a label that will be used for 23510713Sandreas.hansson@arm.com * functional print request packets. 23610713Sandreas.hansson@arm.com * 23710713Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 23810713Sandreas.hansson@arm.com * @param _masterPort Master port used to send the packets 23910713Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 24010713Sandreas.hansson@arm.com */ 24110713Sandreas.hansson@arm.com SnoopRespPacketQueue(EventManager& _em, MasterPort& _masterPort, 24210713Sandreas.hansson@arm.com const std::string _label = "SnoopRespPacketQueue"); 24310713Sandreas.hansson@arm.com 24410713Sandreas.hansson@arm.com virtual ~SnoopRespPacketQueue() { } 24510713Sandreas.hansson@arm.com 24610713Sandreas.hansson@arm.com const std::string name() const 24710713Sandreas.hansson@arm.com { return masterPort.name() + "-" + label; } 24810713Sandreas.hansson@arm.com 24910713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 25010713Sandreas.hansson@arm.com 25110713Sandreas.hansson@arm.com}; 25210713Sandreas.hansson@arm.com 25310713Sandreas.hansson@arm.comclass RespPacketQueue : public PacketQueue 2548975Sandreas.hansson@arm.com{ 2558975Sandreas.hansson@arm.com 2568975Sandreas.hansson@arm.com protected: 2578975Sandreas.hansson@arm.com 2588975Sandreas.hansson@arm.com SlavePort& slavePort; 2598975Sandreas.hansson@arm.com 2608975Sandreas.hansson@arm.com public: 2618975Sandreas.hansson@arm.com 2628975Sandreas.hansson@arm.com /** 26310713Sandreas.hansson@arm.com * Create a response packet queue, linked to an event manager, a 2648975Sandreas.hansson@arm.com * slave port, and a label that will be used for functional print 2658975Sandreas.hansson@arm.com * request packets. 2668975Sandreas.hansson@arm.com * 2678975Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 2688975Sandreas.hansson@arm.com * @param _slavePort Slave port used to send the packets 2698975Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 2708975Sandreas.hansson@arm.com */ 27110713Sandreas.hansson@arm.com RespPacketQueue(EventManager& _em, SlavePort& _slavePort, 27210713Sandreas.hansson@arm.com const std::string _label = "RespPacketQueue"); 2738975Sandreas.hansson@arm.com 27410713Sandreas.hansson@arm.com virtual ~RespPacketQueue() { } 2758975Sandreas.hansson@arm.com 2768975Sandreas.hansson@arm.com const std::string name() const 2778975Sandreas.hansson@arm.com { return slavePort.name() + "-" + label; } 2788975Sandreas.hansson@arm.com 27910713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 2808975Sandreas.hansson@arm.com 2818975Sandreas.hansson@arm.com}; 2828975Sandreas.hansson@arm.com 2838948Sandreas.hansson@arm.com#endif // __MEM_PACKET_QUEUE_HH__ 284