2012-03-22 11:36:27 +01:00
|
|
|
/*
|
2015-03-02 10:00:35 +01:00
|
|
|
* Copyright (c) 2012,2015 ARM Limited
|
2012-03-22 11:36:27 +01:00
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* The license below extends only to copyright in the software and shall
|
|
|
|
* not be construed as granting a license to any other intellectual
|
|
|
|
* property including but not limited to intellectual property relating
|
|
|
|
* to a hardware implementation of the functionality of the software
|
|
|
|
* licensed hereunder. You may use the software subject to the license
|
|
|
|
* terms below provided that you ensure that this notice is replicated
|
|
|
|
* unmodified and in its entirety in all distributions of the software,
|
|
|
|
* modified or unmodified, in source code or in binary form.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions are
|
|
|
|
* met: redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer;
|
|
|
|
* redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution;
|
|
|
|
* neither the name of the copyright holders nor the names of its
|
|
|
|
* contributors may be used to endorse or promote products derived from
|
|
|
|
* this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*
|
|
|
|
* Authors: Andreas Hansson
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __MEM_QPORT_HH__
|
|
|
|
#define __MEM_QPORT_HH__
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @file
|
|
|
|
* Declaration of the queued port.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "mem/packet_queue.hh"
|
|
|
|
#include "mem/port.hh"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A queued port is a port that has an infinite queue for outgoing
|
|
|
|
* packets and thus decouples the module that wants to send
|
|
|
|
* request/responses from the flow control (retry mechanism) of the
|
|
|
|
* port. A queued port can be used by both a master and a slave. The
|
|
|
|
* queue is a parameter to allow tailoring of the queue implementation
|
|
|
|
* (used in the cache).
|
|
|
|
*/
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
class QueuedSlavePort : public SlavePort
|
2012-03-22 11:36:27 +01:00
|
|
|
{
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
2015-03-02 10:00:35 +01:00
|
|
|
/** Packet queue used to store outgoing responses. */
|
|
|
|
RespPacketQueue &respQueue;
|
2012-03-22 11:36:27 +01:00
|
|
|
|
2015-03-02 10:00:35 +01:00
|
|
|
void recvRespRetry() { respQueue.retry(); }
|
2012-03-22 11:36:27 +01:00
|
|
|
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a QueuedPort with a given name, owner, and a supplied
|
|
|
|
* implementation of a packet queue. The external definition of
|
|
|
|
* the queue enables e.g. the cache to implement a specific queue
|
|
|
|
* behaviuor in a subclass, and provide the latter to the
|
|
|
|
* QueuePort constructor.
|
|
|
|
*/
|
|
|
|
QueuedSlavePort(const std::string& name, MemObject* owner,
|
2015-03-02 10:00:35 +01:00
|
|
|
RespPacketQueue &resp_queue, PortID id = InvalidPortID) :
|
|
|
|
SlavePort(name, owner, id), respQueue(resp_queue)
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
{ }
|
|
|
|
|
|
|
|
virtual ~QueuedSlavePort() { }
|
|
|
|
|
2012-08-22 17:39:56 +02:00
|
|
|
/**
|
|
|
|
* Schedule the sending of a timing response.
|
|
|
|
*
|
|
|
|
* @param pkt Packet to send
|
|
|
|
* @param when Absolute time (in ticks) to send packet
|
|
|
|
*/
|
2015-11-06 09:26:37 +01:00
|
|
|
void schedTimingResp(PacketPtr pkt, Tick when, bool force_order = false)
|
|
|
|
{ respQueue.schedSendTiming(pkt, when, force_order); }
|
2012-08-22 17:39:56 +02:00
|
|
|
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
/** Check the list of buffered packets against the supplied
|
|
|
|
* functional request. */
|
2015-03-02 10:00:35 +01:00
|
|
|
bool checkFunctional(PacketPtr pkt)
|
|
|
|
{ return respQueue.checkFunctional(pkt); }
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
};
|
|
|
|
|
2015-03-02 10:00:35 +01:00
|
|
|
/**
|
|
|
|
* The QueuedMasterPort combines two queues, a request queue and a
|
|
|
|
* snoop response queue, that both share the same port. The flow
|
|
|
|
* control for requests and snoop responses are completely
|
|
|
|
* independent, and so each queue manages its own flow control
|
|
|
|
* (retries).
|
|
|
|
*/
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
class QueuedMasterPort : public MasterPort
|
|
|
|
{
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
2015-03-02 10:00:35 +01:00
|
|
|
/** Packet queue used to store outgoing requests. */
|
|
|
|
ReqPacketQueue &reqQueue;
|
|
|
|
|
|
|
|
/** Packet queue used to store outgoing snoop responses. */
|
|
|
|
SnoopRespPacketQueue &snoopRespQueue;
|
|
|
|
|
|
|
|
void recvReqRetry() { reqQueue.retry(); }
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
|
2015-03-02 10:00:35 +01:00
|
|
|
void recvRetrySnoopResp() { snoopRespQueue.retry(); }
|
2012-03-22 11:36:27 +01:00
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a QueuedPort with a given name, owner, and a supplied
|
2015-03-02 10:00:35 +01:00
|
|
|
* implementation of two packet queues. The external definition of
|
|
|
|
* the queues enables e.g. the cache to implement a specific queue
|
2012-03-22 11:36:27 +01:00
|
|
|
* behaviuor in a subclass, and provide the latter to the
|
|
|
|
* QueuePort constructor.
|
|
|
|
*/
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
QueuedMasterPort(const std::string& name, MemObject* owner,
|
2015-03-02 10:00:35 +01:00
|
|
|
ReqPacketQueue &req_queue,
|
|
|
|
SnoopRespPacketQueue &snoop_resp_queue,
|
|
|
|
PortID id = InvalidPortID) :
|
|
|
|
MasterPort(name, owner, id), reqQueue(req_queue),
|
|
|
|
snoopRespQueue(snoop_resp_queue)
|
2012-03-22 11:36:27 +01:00
|
|
|
{ }
|
|
|
|
|
MEM: Introduce the master/slave port sub-classes in C++
This patch introduces the notion of a master and slave port in the C++
code, thus bringing the previous classification from the Python
classes into the corresponding simulation objects and memory objects.
The patch enables us to classify behaviours into the two bins and add
assumptions and enfore compliance, also simplifying the two
interfaces. As a starting point, isSnooping is confined to a master
port, and getAddrRanges to slave ports. More of these specilisations
are to come in later patches.
The getPort function is not getMasterPort and getSlavePort, and
returns a port reference rather than a pointer as NULL would never be
a valid return value. The default implementation of these two
functions is placed in MemObject, and calls fatal.
The one drawback with this specific patch is that it requires some
code duplication, e.g. QueuedPort becomes QueuedMasterPort and
QueuedSlavePort, and BusPort becomes BusMasterPort and BusSlavePort
(avoiding multiple inheritance). With the later introduction of the
port interfaces, moving the functionality outside the port itself, a
lot of the duplicated code will disappear again.
2012-03-30 15:40:11 +02:00
|
|
|
virtual ~QueuedMasterPort() { }
|
2012-03-22 11:36:27 +01:00
|
|
|
|
2012-08-22 17:39:56 +02:00
|
|
|
/**
|
|
|
|
* Schedule the sending of a timing request.
|
|
|
|
*
|
|
|
|
* @param pkt Packet to send
|
|
|
|
* @param when Absolute time (in ticks) to send packet
|
|
|
|
*/
|
|
|
|
void schedTimingReq(PacketPtr pkt, Tick when)
|
2015-03-02 10:00:35 +01:00
|
|
|
{ reqQueue.schedSendTiming(pkt, when); }
|
2012-08-22 17:39:56 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Schedule the sending of a timing snoop response.
|
|
|
|
*
|
|
|
|
* @param pkt Packet to send
|
|
|
|
* @param when Absolute time (in ticks) to send packet
|
|
|
|
*/
|
mem: Add option to force in-order insertion in PacketQueue
By default, the packet queue is ordered by the ticks of the to-be-sent
packages. With the recent modifications of packages sinking their header time
when their resposne leaves the caches, there could be cases of MSHR targets
being allocated and ordered A, B, but their responses being sent out in the
order B,A. This led to inconsistencies in bus traffic, in particular the snoop
filter observing first a ReadExResp and later a ReadRespWithInv. Logically,
these were ordered the other way around behind the MSHR, but due to the timing
adjustments when inserting into the PacketQueue, they were sent out in the
wrong order on the bus, confusing the snoop filter.
This patch adds a flag (off by default) such that these special cases can
request in-order insertion into the packet queue, which might offset timing
slighty. This is expected to occur rarely and not affect timing results.
2015-03-02 10:00:49 +01:00
|
|
|
void schedTimingSnoopResp(PacketPtr pkt, Tick when, bool force_order =
|
|
|
|
false)
|
|
|
|
{ snoopRespQueue.schedSendTiming(pkt, when, force_order); }
|
2012-08-22 17:39:56 +02:00
|
|
|
|
2012-03-22 11:36:27 +01:00
|
|
|
/** Check the list of buffered packets against the supplied
|
|
|
|
* functional request. */
|
2015-03-02 10:00:35 +01:00
|
|
|
bool checkFunctional(PacketPtr pkt)
|
|
|
|
{
|
|
|
|
return reqQueue.checkFunctional(pkt) ||
|
|
|
|
snoopRespQueue.checkFunctional(pkt);
|
|
|
|
}
|
2012-03-22 11:36:27 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // __MEM_QPORT_HH__
|