packet_queue.hh revision 12823
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. */ 9012083Sspwilson2@wisc.edu EventFunctionWrapper sendEvent; 912914SN/A 9211207SBrad.Beckmann@amd.com /* 9311207SBrad.Beckmann@amd.com * Optionally disable the sanity check 9411207SBrad.Beckmann@amd.com * on the size of the transmitList. The 9511207SBrad.Beckmann@amd.com * sanity check will be enabled by default. 9611207SBrad.Beckmann@amd.com */ 9711207SBrad.Beckmann@amd.com bool _disableSanityCheck; 9811207SBrad.Beckmann@amd.com 998914Sandreas.hansson@arm.com protected: 1008914Sandreas.hansson@arm.com 1018975Sandreas.hansson@arm.com /** Label to use for print request packets label stack. */ 1028975Sandreas.hansson@arm.com const std::string label; 1038914Sandreas.hansson@arm.com 10410713Sandreas.hansson@arm.com /** Remember whether we're awaiting a retry. */ 1054492SN/A bool waitingOnRetry; 1064492SN/A 1074492SN/A /** Check whether we have a packet ready to go on the transmit list. */ 10810322Sandreas.hansson@arm.com bool deferredPacketReady() const 1097823SN/A { return !transmitList.empty() && transmitList.front().tick <= curTick(); } 1104492SN/A 1118708SN/A /** 11210713Sandreas.hansson@arm.com * Attempt to send a packet. Note that a subclass of the 11310713Sandreas.hansson@arm.com * PacketQueue can override this method and thus change the 11410713Sandreas.hansson@arm.com * behaviour (as done by the cache for the request queue). The 11510713Sandreas.hansson@arm.com * default implementation sends the head of the transmit list. The 11610713Sandreas.hansson@arm.com * caller must guarantee that the list is non-empty and that the 11710713Sandreas.hansson@arm.com * head packet is scheduled for curTick() (or earlier). 1184492SN/A */ 1198856SN/A virtual void sendDeferredPacket(); 1208856SN/A 1218856SN/A /** 12210713Sandreas.hansson@arm.com * Send a packet using the appropriate method for the specific 12310713Sandreas.hansson@arm.com * subclass (reuest, response or snoop response). 1248856SN/A */ 12510713Sandreas.hansson@arm.com virtual bool sendTiming(PacketPtr pkt) = 0; 1263091SN/A 1278914Sandreas.hansson@arm.com /** 1288975Sandreas.hansson@arm.com * Create a packet queue, linked to an event manager, and a label 1298975Sandreas.hansson@arm.com * that will be used for functional print request packets. 1308914Sandreas.hansson@arm.com * 1318914Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 1328914Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 13311207SBrad.Beckmann@amd.com * @param disable_sanity_check Flag used to disable the sanity check 13411207SBrad.Beckmann@amd.com * on the size of the transmitList. The check is enabled by default. 1358914Sandreas.hansson@arm.com */ 13611207SBrad.Beckmann@amd.com PacketQueue(EventManager& _em, const std::string& _label, 13712083Sspwilson2@wisc.edu const std::string& _sendEventName, 13811207SBrad.Beckmann@amd.com bool disable_sanity_check = false); 1398914Sandreas.hansson@arm.com 1408914Sandreas.hansson@arm.com /** 1418914Sandreas.hansson@arm.com * Virtual desctructor since the class may be used as a base class. 1428914Sandreas.hansson@arm.com */ 1438914Sandreas.hansson@arm.com virtual ~PacketQueue(); 1448914Sandreas.hansson@arm.com 1458975Sandreas.hansson@arm.com public: 1468975Sandreas.hansson@arm.com 1478914Sandreas.hansson@arm.com /** 1488975Sandreas.hansson@arm.com * Provide a name to simplify debugging. 1498914Sandreas.hansson@arm.com * 1508914Sandreas.hansson@arm.com * @return A complete name, appended to module and port 1518914Sandreas.hansson@arm.com */ 1528975Sandreas.hansson@arm.com virtual const std::string name() const = 0; 1534490SN/A 15410713Sandreas.hansson@arm.com /** 15510713Sandreas.hansson@arm.com * Get the size of the queue. 15610713Sandreas.hansson@arm.com */ 15710713Sandreas.hansson@arm.com size_t size() const { return transmitList.size(); } 15810713Sandreas.hansson@arm.com 15910713Sandreas.hansson@arm.com /** 16010713Sandreas.hansson@arm.com * Get the next packet ready time. 16110713Sandreas.hansson@arm.com */ 16210713Sandreas.hansson@arm.com Tick deferredPacketReadyTime() const 16310713Sandreas.hansson@arm.com { return transmitList.empty() ? MaxTick : transmitList.front().tick; } 16410713Sandreas.hansson@arm.com 16510713Sandreas.hansson@arm.com /** 16610713Sandreas.hansson@arm.com * Check if a packets address exists in the queue. 16710713Sandreas.hansson@arm.com */ 16810713Sandreas.hansson@arm.com bool hasAddr(Addr addr) const; 16910713Sandreas.hansson@arm.com 1708856SN/A /** Check the list of buffered packets against the supplied 1718856SN/A * functional request. */ 17212823Srmk35@cl.cam.ac.uk bool trySatisfyFunctional(PacketPtr pkt); 1738856SN/A 1748914Sandreas.hansson@arm.com /** 17510713Sandreas.hansson@arm.com * Schedule a send event if we are not already waiting for a 17610713Sandreas.hansson@arm.com * retry. If the requested time is before an already scheduled 17710713Sandreas.hansson@arm.com * send event, the event will be rescheduled. If MaxTick is 17810713Sandreas.hansson@arm.com * passed, no event is scheduled. Instead, if we are idle and 17910713Sandreas.hansson@arm.com * asked to drain then check and signal drained. 1808914Sandreas.hansson@arm.com * 18110713Sandreas.hansson@arm.com * @param when time to schedule an event 1828914Sandreas.hansson@arm.com */ 1838914Sandreas.hansson@arm.com void schedSendEvent(Tick when); 1848914Sandreas.hansson@arm.com 1858914Sandreas.hansson@arm.com /** 18610713Sandreas.hansson@arm.com * Add a packet to the transmit list, and schedule a send event. 1878914Sandreas.hansson@arm.com * 1888914Sandreas.hansson@arm.com * @param pkt Packet to send 1898914Sandreas.hansson@arm.com * @param when Absolute time (in ticks) to send packet 19011195Sandreas.hansson@arm.com * @param force_order Force insertion order for packets with same address 1918914Sandreas.hansson@arm.com */ 19210722Sstephan.diestelhorst@arm.com void schedSendTiming(PacketPtr pkt, Tick when, bool force_order = false); 1938914Sandreas.hansson@arm.com 1948914Sandreas.hansson@arm.com /** 19510713Sandreas.hansson@arm.com * Retry sending a packet from the queue. Note that this is not 19610713Sandreas.hansson@arm.com * necessarily the same packet if something has been added with an 19710713Sandreas.hansson@arm.com * earlier time stamp. 1988914Sandreas.hansson@arm.com */ 1998914Sandreas.hansson@arm.com void retry(); 2008914Sandreas.hansson@arm.com 20111207SBrad.Beckmann@amd.com /** 20211207SBrad.Beckmann@amd.com * This allows a user to explicitly disable the sanity check 20311207SBrad.Beckmann@amd.com * on the size of the transmitList, which is enabled by default. 20411207SBrad.Beckmann@amd.com * Users must use this function to explicitly disable the sanity 20511207SBrad.Beckmann@amd.com * check. 20611207SBrad.Beckmann@amd.com */ 20711207SBrad.Beckmann@amd.com void disableSanityCheck() { _disableSanityCheck = true; } 20811207SBrad.Beckmann@amd.com 20911168Sandreas.hansson@arm.com DrainState drain() override; 2102914SN/A}; 2112914SN/A 21210713Sandreas.hansson@arm.comclass ReqPacketQueue : public PacketQueue 2138975Sandreas.hansson@arm.com{ 2148975Sandreas.hansson@arm.com 2158975Sandreas.hansson@arm.com protected: 2168975Sandreas.hansson@arm.com 2178975Sandreas.hansson@arm.com MasterPort& masterPort; 2188975Sandreas.hansson@arm.com 21912083Sspwilson2@wisc.edu // Static definition so it can be called when constructing the parent 22012083Sspwilson2@wisc.edu // without us being completely initialized. 22112083Sspwilson2@wisc.edu static const std::string name(const MasterPort& masterPort, 22212083Sspwilson2@wisc.edu const std::string& label) 22312083Sspwilson2@wisc.edu { return masterPort.name() + "-" + label; } 22412083Sspwilson2@wisc.edu 2258975Sandreas.hansson@arm.com public: 2268975Sandreas.hansson@arm.com 2278975Sandreas.hansson@arm.com /** 22810713Sandreas.hansson@arm.com * Create a request packet queue, linked to an event manager, a 2298975Sandreas.hansson@arm.com * master port, and a label that will be used for functional print 2308975Sandreas.hansson@arm.com * request packets. 2318975Sandreas.hansson@arm.com * 2328975Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 2338975Sandreas.hansson@arm.com * @param _masterPort Master port used to send the packets 2348975Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 2358975Sandreas.hansson@arm.com */ 23610713Sandreas.hansson@arm.com ReqPacketQueue(EventManager& _em, MasterPort& _masterPort, 23710713Sandreas.hansson@arm.com const std::string _label = "ReqPacketQueue"); 2388975Sandreas.hansson@arm.com 23910713Sandreas.hansson@arm.com virtual ~ReqPacketQueue() { } 2408975Sandreas.hansson@arm.com 2418975Sandreas.hansson@arm.com const std::string name() const 24212083Sspwilson2@wisc.edu { return name(masterPort, label); } 2438975Sandreas.hansson@arm.com 24410713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 24510713Sandreas.hansson@arm.com 2468975Sandreas.hansson@arm.com}; 2478975Sandreas.hansson@arm.com 24810713Sandreas.hansson@arm.comclass SnoopRespPacketQueue : public PacketQueue 24910713Sandreas.hansson@arm.com{ 25010713Sandreas.hansson@arm.com 25110713Sandreas.hansson@arm.com protected: 25210713Sandreas.hansson@arm.com 25310713Sandreas.hansson@arm.com MasterPort& masterPort; 25410713Sandreas.hansson@arm.com 25512083Sspwilson2@wisc.edu // Static definition so it can be called when constructing the parent 25612083Sspwilson2@wisc.edu // without us being completely initialized. 25712083Sspwilson2@wisc.edu static const std::string name(const MasterPort& masterPort, 25812083Sspwilson2@wisc.edu const std::string& label) 25912083Sspwilson2@wisc.edu { return masterPort.name() + "-" + label; } 26012083Sspwilson2@wisc.edu 26110713Sandreas.hansson@arm.com public: 26210713Sandreas.hansson@arm.com 26310713Sandreas.hansson@arm.com /** 26410713Sandreas.hansson@arm.com * Create a snoop response packet queue, linked to an event 26510713Sandreas.hansson@arm.com * manager, a master port, and a label that will be used for 26610713Sandreas.hansson@arm.com * functional print request packets. 26710713Sandreas.hansson@arm.com * 26810713Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 26910713Sandreas.hansson@arm.com * @param _masterPort Master port used to send the packets 27010713Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 27110713Sandreas.hansson@arm.com */ 27210713Sandreas.hansson@arm.com SnoopRespPacketQueue(EventManager& _em, MasterPort& _masterPort, 27310713Sandreas.hansson@arm.com const std::string _label = "SnoopRespPacketQueue"); 27410713Sandreas.hansson@arm.com 27510713Sandreas.hansson@arm.com virtual ~SnoopRespPacketQueue() { } 27610713Sandreas.hansson@arm.com 27710713Sandreas.hansson@arm.com const std::string name() const 27812083Sspwilson2@wisc.edu { return name(masterPort, label); } 27910713Sandreas.hansson@arm.com 28010713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 28110713Sandreas.hansson@arm.com 28210713Sandreas.hansson@arm.com}; 28310713Sandreas.hansson@arm.com 28410713Sandreas.hansson@arm.comclass RespPacketQueue : public PacketQueue 2858975Sandreas.hansson@arm.com{ 2868975Sandreas.hansson@arm.com 2878975Sandreas.hansson@arm.com protected: 2888975Sandreas.hansson@arm.com 2898975Sandreas.hansson@arm.com SlavePort& slavePort; 2908975Sandreas.hansson@arm.com 29112083Sspwilson2@wisc.edu // Static definition so it can be called when constructing the parent 29212083Sspwilson2@wisc.edu // without us being completely initialized. 29312083Sspwilson2@wisc.edu static const std::string name(const SlavePort& slavePort, 29412083Sspwilson2@wisc.edu const std::string& label) 29512083Sspwilson2@wisc.edu { return slavePort.name() + "-" + label; } 29612083Sspwilson2@wisc.edu 2978975Sandreas.hansson@arm.com public: 2988975Sandreas.hansson@arm.com 2998975Sandreas.hansson@arm.com /** 30010713Sandreas.hansson@arm.com * Create a response packet queue, linked to an event manager, a 3018975Sandreas.hansson@arm.com * slave port, and a label that will be used for functional print 3028975Sandreas.hansson@arm.com * request packets. 3038975Sandreas.hansson@arm.com * 3048975Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 3058975Sandreas.hansson@arm.com * @param _slavePort Slave port used to send the packets 3068975Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 3078975Sandreas.hansson@arm.com */ 30810713Sandreas.hansson@arm.com RespPacketQueue(EventManager& _em, SlavePort& _slavePort, 30910713Sandreas.hansson@arm.com const std::string _label = "RespPacketQueue"); 3108975Sandreas.hansson@arm.com 31110713Sandreas.hansson@arm.com virtual ~RespPacketQueue() { } 3128975Sandreas.hansson@arm.com 3138975Sandreas.hansson@arm.com const std::string name() const 31412083Sspwilson2@wisc.edu { return name(slavePort, label); } 3158975Sandreas.hansson@arm.com 31610713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 3178975Sandreas.hansson@arm.com 3188975Sandreas.hansson@arm.com}; 3198975Sandreas.hansson@arm.com 3208948Sandreas.hansson@arm.com#endif // __MEM_PACKET_QUEUE_HH__ 321