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 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 9913564Snikos.nikoleris@arm.com /** 10013564Snikos.nikoleris@arm.com * if true, inserted packets have to be unconditionally scheduled 10113564Snikos.nikoleris@arm.com * after the last packet in the queue that references the same 10213564Snikos.nikoleris@arm.com * address 10313564Snikos.nikoleris@arm.com */ 10413564Snikos.nikoleris@arm.com bool forceOrder; 10513564Snikos.nikoleris@arm.com 1068914Sandreas.hansson@arm.com protected: 1078914Sandreas.hansson@arm.com 1088975Sandreas.hansson@arm.com /** Label to use for print request packets label stack. */ 1098975Sandreas.hansson@arm.com const std::string label; 1108914Sandreas.hansson@arm.com 11110713Sandreas.hansson@arm.com /** Remember whether we're awaiting a retry. */ 1124492SN/A bool waitingOnRetry; 1134492SN/A 1144492SN/A /** Check whether we have a packet ready to go on the transmit list. */ 11510322Sandreas.hansson@arm.com bool deferredPacketReady() const 1167823SN/A { return !transmitList.empty() && transmitList.front().tick <= curTick(); } 1174492SN/A 1188708SN/A /** 11910713Sandreas.hansson@arm.com * Attempt to send a packet. Note that a subclass of the 12010713Sandreas.hansson@arm.com * PacketQueue can override this method and thus change the 12110713Sandreas.hansson@arm.com * behaviour (as done by the cache for the request queue). The 12210713Sandreas.hansson@arm.com * default implementation sends the head of the transmit list. The 12310713Sandreas.hansson@arm.com * caller must guarantee that the list is non-empty and that the 12410713Sandreas.hansson@arm.com * head packet is scheduled for curTick() (or earlier). 1254492SN/A */ 1268856SN/A virtual void sendDeferredPacket(); 1278856SN/A 1288856SN/A /** 12910713Sandreas.hansson@arm.com * Send a packet using the appropriate method for the specific 13010713Sandreas.hansson@arm.com * subclass (reuest, response or snoop response). 1318856SN/A */ 13210713Sandreas.hansson@arm.com virtual bool sendTiming(PacketPtr pkt) = 0; 1333091SN/A 1348914Sandreas.hansson@arm.com /** 1358975Sandreas.hansson@arm.com * Create a packet queue, linked to an event manager, and a label 1368975Sandreas.hansson@arm.com * that will be used for functional print request packets. 1378914Sandreas.hansson@arm.com * 1388914Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 1398914Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 14013564Snikos.nikoleris@arm.com * @param force_order Force insertion order for packets with same address 14111207SBrad.Beckmann@amd.com * @param disable_sanity_check Flag used to disable the sanity check 14211207SBrad.Beckmann@amd.com * on the size of the transmitList. The check is enabled by default. 1438914Sandreas.hansson@arm.com */ 14411207SBrad.Beckmann@amd.com PacketQueue(EventManager& _em, const std::string& _label, 14512083Sspwilson2@wisc.edu const std::string& _sendEventName, 14613564Snikos.nikoleris@arm.com bool force_order = false, 14711207SBrad.Beckmann@amd.com bool disable_sanity_check = false); 1488914Sandreas.hansson@arm.com 1498914Sandreas.hansson@arm.com /** 1508914Sandreas.hansson@arm.com * Virtual desctructor since the class may be used as a base class. 1518914Sandreas.hansson@arm.com */ 1528914Sandreas.hansson@arm.com virtual ~PacketQueue(); 1538914Sandreas.hansson@arm.com 1548975Sandreas.hansson@arm.com public: 1558975Sandreas.hansson@arm.com 1568914Sandreas.hansson@arm.com /** 1578975Sandreas.hansson@arm.com * Provide a name to simplify debugging. 1588914Sandreas.hansson@arm.com * 1598914Sandreas.hansson@arm.com * @return A complete name, appended to module and port 1608914Sandreas.hansson@arm.com */ 1618975Sandreas.hansson@arm.com virtual const std::string name() const = 0; 1624490SN/A 16310713Sandreas.hansson@arm.com /** 16410713Sandreas.hansson@arm.com * Get the size of the queue. 16510713Sandreas.hansson@arm.com */ 16610713Sandreas.hansson@arm.com size_t size() const { return transmitList.size(); } 16710713Sandreas.hansson@arm.com 16810713Sandreas.hansson@arm.com /** 16910713Sandreas.hansson@arm.com * Get the next packet ready time. 17010713Sandreas.hansson@arm.com */ 17110713Sandreas.hansson@arm.com Tick deferredPacketReadyTime() const 17210713Sandreas.hansson@arm.com { return transmitList.empty() ? MaxTick : transmitList.front().tick; } 17310713Sandreas.hansson@arm.com 17410713Sandreas.hansson@arm.com /** 17513860Sodanrc@yahoo.com.br * Check if a packet corresponding to the same address exists in the 17613860Sodanrc@yahoo.com.br * queue. 17713860Sodanrc@yahoo.com.br * 17813860Sodanrc@yahoo.com.br * @param pkt The packet to compare against. 17913860Sodanrc@yahoo.com.br * @param blk_size Block size in bytes. 18013860Sodanrc@yahoo.com.br * @return Whether a corresponding packet is found. 18110713Sandreas.hansson@arm.com */ 18213860Sodanrc@yahoo.com.br bool checkConflict(const PacketPtr pkt, const int blk_size) const; 18310713Sandreas.hansson@arm.com 1848856SN/A /** Check the list of buffered packets against the supplied 1858856SN/A * functional request. */ 18612823Srmk35@cl.cam.ac.uk bool trySatisfyFunctional(PacketPtr pkt); 1878856SN/A 1888914Sandreas.hansson@arm.com /** 18910713Sandreas.hansson@arm.com * Schedule a send event if we are not already waiting for a 19010713Sandreas.hansson@arm.com * retry. If the requested time is before an already scheduled 19110713Sandreas.hansson@arm.com * send event, the event will be rescheduled. If MaxTick is 19210713Sandreas.hansson@arm.com * passed, no event is scheduled. Instead, if we are idle and 19310713Sandreas.hansson@arm.com * asked to drain then check and signal drained. 1948914Sandreas.hansson@arm.com * 19510713Sandreas.hansson@arm.com * @param when time to schedule an event 1968914Sandreas.hansson@arm.com */ 1978914Sandreas.hansson@arm.com void schedSendEvent(Tick when); 1988914Sandreas.hansson@arm.com 1998914Sandreas.hansson@arm.com /** 20010713Sandreas.hansson@arm.com * Add a packet to the transmit list, and schedule a send event. 2018914Sandreas.hansson@arm.com * 2028914Sandreas.hansson@arm.com * @param pkt Packet to send 2038914Sandreas.hansson@arm.com * @param when Absolute time (in ticks) to send packet 2048914Sandreas.hansson@arm.com */ 20513564Snikos.nikoleris@arm.com void schedSendTiming(PacketPtr pkt, Tick when); 2068914Sandreas.hansson@arm.com 2078914Sandreas.hansson@arm.com /** 20810713Sandreas.hansson@arm.com * Retry sending a packet from the queue. Note that this is not 20910713Sandreas.hansson@arm.com * necessarily the same packet if something has been added with an 21010713Sandreas.hansson@arm.com * earlier time stamp. 2118914Sandreas.hansson@arm.com */ 2128914Sandreas.hansson@arm.com void retry(); 2138914Sandreas.hansson@arm.com 21411207SBrad.Beckmann@amd.com /** 21511207SBrad.Beckmann@amd.com * This allows a user to explicitly disable the sanity check 21611207SBrad.Beckmann@amd.com * on the size of the transmitList, which is enabled by default. 21711207SBrad.Beckmann@amd.com * Users must use this function to explicitly disable the sanity 21811207SBrad.Beckmann@amd.com * check. 21911207SBrad.Beckmann@amd.com */ 22011207SBrad.Beckmann@amd.com void disableSanityCheck() { _disableSanityCheck = true; } 22111207SBrad.Beckmann@amd.com 22211168Sandreas.hansson@arm.com DrainState drain() override; 2232914SN/A}; 2242914SN/A 22510713Sandreas.hansson@arm.comclass ReqPacketQueue : public PacketQueue 2268975Sandreas.hansson@arm.com{ 2278975Sandreas.hansson@arm.com 2288975Sandreas.hansson@arm.com protected: 2298975Sandreas.hansson@arm.com 2308975Sandreas.hansson@arm.com MasterPort& masterPort; 2318975Sandreas.hansson@arm.com 23212083Sspwilson2@wisc.edu // Static definition so it can be called when constructing the parent 23312083Sspwilson2@wisc.edu // without us being completely initialized. 23412083Sspwilson2@wisc.edu static const std::string name(const MasterPort& masterPort, 23512083Sspwilson2@wisc.edu const std::string& label) 23612083Sspwilson2@wisc.edu { return masterPort.name() + "-" + label; } 23712083Sspwilson2@wisc.edu 2388975Sandreas.hansson@arm.com public: 2398975Sandreas.hansson@arm.com 2408975Sandreas.hansson@arm.com /** 24110713Sandreas.hansson@arm.com * Create a request packet queue, linked to an event manager, a 2428975Sandreas.hansson@arm.com * master port, and a label that will be used for functional print 2438975Sandreas.hansson@arm.com * request packets. 2448975Sandreas.hansson@arm.com * 2458975Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 2468975Sandreas.hansson@arm.com * @param _masterPort Master port used to send the packets 2478975Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 2488975Sandreas.hansson@arm.com */ 24910713Sandreas.hansson@arm.com ReqPacketQueue(EventManager& _em, MasterPort& _masterPort, 25010713Sandreas.hansson@arm.com const std::string _label = "ReqPacketQueue"); 2518975Sandreas.hansson@arm.com 25210713Sandreas.hansson@arm.com virtual ~ReqPacketQueue() { } 2538975Sandreas.hansson@arm.com 2548975Sandreas.hansson@arm.com const std::string name() const 25512083Sspwilson2@wisc.edu { return name(masterPort, label); } 2568975Sandreas.hansson@arm.com 25710713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 25810713Sandreas.hansson@arm.com 2598975Sandreas.hansson@arm.com}; 2608975Sandreas.hansson@arm.com 26110713Sandreas.hansson@arm.comclass SnoopRespPacketQueue : public PacketQueue 26210713Sandreas.hansson@arm.com{ 26310713Sandreas.hansson@arm.com 26410713Sandreas.hansson@arm.com protected: 26510713Sandreas.hansson@arm.com 26610713Sandreas.hansson@arm.com MasterPort& masterPort; 26710713Sandreas.hansson@arm.com 26812083Sspwilson2@wisc.edu // Static definition so it can be called when constructing the parent 26912083Sspwilson2@wisc.edu // without us being completely initialized. 27012083Sspwilson2@wisc.edu static const std::string name(const MasterPort& masterPort, 27112083Sspwilson2@wisc.edu const std::string& label) 27212083Sspwilson2@wisc.edu { return masterPort.name() + "-" + label; } 27312083Sspwilson2@wisc.edu 27410713Sandreas.hansson@arm.com public: 27510713Sandreas.hansson@arm.com 27610713Sandreas.hansson@arm.com /** 27710713Sandreas.hansson@arm.com * Create a snoop response packet queue, linked to an event 27810713Sandreas.hansson@arm.com * manager, a master port, and a label that will be used for 27910713Sandreas.hansson@arm.com * functional print request packets. 28010713Sandreas.hansson@arm.com * 28110713Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 28210713Sandreas.hansson@arm.com * @param _masterPort Master port used to send the packets 28313564Snikos.nikoleris@arm.com * @param force_order Force insertion order for packets with same address 28410713Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 28510713Sandreas.hansson@arm.com */ 28610713Sandreas.hansson@arm.com SnoopRespPacketQueue(EventManager& _em, MasterPort& _masterPort, 28713564Snikos.nikoleris@arm.com bool force_order = false, 28810713Sandreas.hansson@arm.com const std::string _label = "SnoopRespPacketQueue"); 28910713Sandreas.hansson@arm.com 29010713Sandreas.hansson@arm.com virtual ~SnoopRespPacketQueue() { } 29110713Sandreas.hansson@arm.com 29210713Sandreas.hansson@arm.com const std::string name() const 29312083Sspwilson2@wisc.edu { return name(masterPort, label); } 29410713Sandreas.hansson@arm.com 29510713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 29610713Sandreas.hansson@arm.com 29710713Sandreas.hansson@arm.com}; 29810713Sandreas.hansson@arm.com 29910713Sandreas.hansson@arm.comclass RespPacketQueue : public PacketQueue 3008975Sandreas.hansson@arm.com{ 3018975Sandreas.hansson@arm.com 3028975Sandreas.hansson@arm.com protected: 3038975Sandreas.hansson@arm.com 3048975Sandreas.hansson@arm.com SlavePort& slavePort; 3058975Sandreas.hansson@arm.com 30612083Sspwilson2@wisc.edu // Static definition so it can be called when constructing the parent 30712083Sspwilson2@wisc.edu // without us being completely initialized. 30812083Sspwilson2@wisc.edu static const std::string name(const SlavePort& slavePort, 30912083Sspwilson2@wisc.edu const std::string& label) 31012083Sspwilson2@wisc.edu { return slavePort.name() + "-" + label; } 31112083Sspwilson2@wisc.edu 3128975Sandreas.hansson@arm.com public: 3138975Sandreas.hansson@arm.com 3148975Sandreas.hansson@arm.com /** 31510713Sandreas.hansson@arm.com * Create a response packet queue, linked to an event manager, a 3168975Sandreas.hansson@arm.com * slave port, and a label that will be used for functional print 3178975Sandreas.hansson@arm.com * request packets. 3188975Sandreas.hansson@arm.com * 3198975Sandreas.hansson@arm.com * @param _em Event manager used for scheduling this queue 3208975Sandreas.hansson@arm.com * @param _slavePort Slave port used to send the packets 32113564Snikos.nikoleris@arm.com * @param force_order Force insertion order for packets with same address 3228975Sandreas.hansson@arm.com * @param _label Label to push on the label stack for print request packets 3238975Sandreas.hansson@arm.com */ 32410713Sandreas.hansson@arm.com RespPacketQueue(EventManager& _em, SlavePort& _slavePort, 32513564Snikos.nikoleris@arm.com bool force_order = false, 32613564Snikos.nikoleris@arm.com const std::string _label = "RespPacketQueue"); 3278975Sandreas.hansson@arm.com 32810713Sandreas.hansson@arm.com virtual ~RespPacketQueue() { } 3298975Sandreas.hansson@arm.com 3308975Sandreas.hansson@arm.com const std::string name() const 33112083Sspwilson2@wisc.edu { return name(slavePort, label); } 3328975Sandreas.hansson@arm.com 33310713Sandreas.hansson@arm.com bool sendTiming(PacketPtr pkt); 3348975Sandreas.hansson@arm.com 3358975Sandreas.hansson@arm.com}; 3368975Sandreas.hansson@arm.com 3378948Sandreas.hansson@arm.com#endif // __MEM_PACKET_QUEUE_HH__ 338