gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QueuedMasterPort Class Reference

The QueuedMasterPort combines two queues, a request queue and a snoop response queue, that both share the same port. More...

#include <qport.hh>

Inheritance diagram for QueuedMasterPort:
MasterPort BaseMasterPort Port AbstractController::MemoryPort BaseCache::CacheMasterPort MessageMasterPort RubyPort::MemMasterPort RubyPort::PioMasterPort X86ISA::IntDevice::IntMasterPort

Public Member Functions

 QueuedMasterPort (const std::string &name, MemObject *owner, ReqPacketQueue &req_queue, SnoopRespPacketQueue &snoop_resp_queue, PortID id=InvalidPortID)
 Create a QueuedPort with a given name, owner, and a supplied implementation of two packet queues. More...
 
virtual ~QueuedMasterPort ()
 
void schedTimingReq (PacketPtr pkt, Tick when)
 Schedule the sending of a timing request. More...
 
void schedTimingSnoopResp (PacketPtr pkt, Tick when, bool force_order=false)
 Schedule the sending of a timing snoop response. More...
 
bool checkFunctional (PacketPtr pkt)
 Check the list of buffered packets against the supplied functional request. More...
 
- Public Member Functions inherited from MasterPort
 MasterPort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 Master port. More...
 
virtual ~MasterPort ()
 
void bind (BaseSlavePort &slave_port)
 Bind this master port to a slave port. More...
 
void unbind ()
 Unbind this master port and the associated slave port. More...
 
Tick sendAtomic (PacketPtr pkt)
 Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
void sendFunctional (PacketPtr pkt)
 Send a functional request packet, where the data is instantly updated everywhere in the memory system, without affecting the current state of any block or moving the block. More...
 
bool sendTimingReq (PacketPtr pkt)
 Attempt to send a timing request to the slave port by calling its corresponding receive function. More...
 
bool sendTimingSnoopResp (PacketPtr pkt)
 Attempt to send a timing snoop response packet to the slave port by calling its corresponding receive function. More...
 
virtual void sendRetryResp ()
 Send a retry to the slave port that previously attempted a sendTimingResp to this master port and failed. More...
 
virtual bool isSnooping () const
 Determine if this master port is snooping or not. More...
 
AddrRangeList getAddrRanges () const
 Get the address ranges of the connected slave port. More...
 
void printAddr (Addr a)
 Inject a PrintReq for the given address to print the state of that address throughout the memory system. More...
 
- Public Member Functions inherited from BaseMasterPort
BaseSlavePortgetSlavePort () const
 
bool isConnected () const
 
- Public Member Functions inherited from Port
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 

Protected Member Functions

void recvReqRetry ()
 Called by the slave port if sendTimingReq was called on this master port (causing recvTimingReq to be called on the slave port) and was unsuccesful. More...
 
void recvRetrySnoopResp ()
 Called by the slave port if sendTimingSnoopResp was called on this master port (causing recvTimingSnoopResp to be called on the slave port) and was unsuccesful. More...
 
- Protected Member Functions inherited from MasterPort
virtual Tick recvAtomicSnoop (PacketPtr pkt)
 Receive an atomic snoop request packet from the slave port. More...
 
virtual void recvFunctionalSnoop (PacketPtr pkt)
 Receive a functional snoop request packet from the slave port. More...
 
virtual bool recvTimingResp (PacketPtr pkt)=0
 Receive a timing response from the slave port. More...
 
virtual void recvTimingSnoopReq (PacketPtr pkt)
 Receive a timing snoop request from the slave port. More...
 
virtual void recvRangeChange ()
 Called to receive an address range change from the peer slave port. More...
 
- Protected Member Functions inherited from BaseMasterPort
 BaseMasterPort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 
virtual ~BaseMasterPort ()
 
- Protected Member Functions inherited from Port
 Port (const std::string &_name, MemObject &_owner, PortID _id)
 Abstract base class for ports. More...
 
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 

Protected Attributes

ReqPacketQueuereqQueue
 Packet queue used to store outgoing requests. More...
 
SnoopRespPacketQueuesnoopRespQueue
 Packet queue used to store outgoing snoop responses. More...
 
- Protected Attributes inherited from BaseMasterPort
BaseSlavePort_baseSlavePort
 
- Protected Attributes inherited from Port
const PortID id
 A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is not part of a vector. More...
 
MemObjectowner
 A reference to the MemObject that owns this port. More...
 

Detailed Description

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).

Definition at line 107 of file qport.hh.

Constructor & Destructor Documentation

QueuedMasterPort::QueuedMasterPort ( const std::string &  name,
MemObject owner,
ReqPacketQueue req_queue,
SnoopRespPacketQueue snoop_resp_queue,
PortID  id = InvalidPortID 
)
inline

Create a QueuedPort with a given name, owner, and a supplied implementation of two packet queues.

The external definition of the queues enables e.g. the cache to implement a specific queue behaviuor in a subclass, and provide the latter to the QueuePort constructor.

Definition at line 131 of file qport.hh.

virtual QueuedMasterPort::~QueuedMasterPort ( )
inlinevirtual

Definition at line 139 of file qport.hh.

Member Function Documentation

bool QueuedMasterPort::checkFunctional ( PacketPtr  pkt)
inline

Check the list of buffered packets against the supplied functional request.

Definition at line 162 of file qport.hh.

References PacketQueue::checkFunctional(), reqQueue, and snoopRespQueue.

Referenced by Cache::functionalAccess(), and AbstractController::functionalMemoryWrite().

void QueuedMasterPort::recvReqRetry ( )
inlineprotectedvirtual

Called by the slave port if sendTimingReq was called on this master port (causing recvTimingReq to be called on the slave port) and was unsuccesful.

Implements MasterPort.

Definition at line 118 of file qport.hh.

References reqQueue, and PacketQueue::retry().

void QueuedMasterPort::recvRetrySnoopResp ( )
inlineprotectedvirtual

Called by the slave port if sendTimingSnoopResp was called on this master port (causing recvTimingSnoopResp to be called on the slave port) and was unsuccesful.

Reimplemented from MasterPort.

Definition at line 120 of file qport.hh.

References PacketQueue::retry(), and snoopRespQueue.

void QueuedMasterPort::schedTimingReq ( PacketPtr  pkt,
Tick  when 
)
inline

Schedule the sending of a timing request.

Parameters
pktPacket to send
whenAbsolute time (in ticks) to send packet

Definition at line 147 of file qport.hh.

References reqQueue, and PacketQueue::schedSendTiming().

Referenced by AbstractController::queueMemoryRead(), AbstractController::queueMemoryWrite(), AbstractController::queueMemoryWritePartial(), and X86ISA::IntDevice::IntMasterPort::sendMessage().

void QueuedMasterPort::schedTimingSnoopResp ( PacketPtr  pkt,
Tick  when,
bool  force_order = false 
)
inline

Schedule the sending of a timing snoop response.

Parameters
pktPacket to send
whenAbsolute time (in ticks) to send packet

Definition at line 156 of file qport.hh.

References PacketQueue::schedSendTiming(), and snoopRespQueue.

Referenced by Cache::doTimingSupplyResponse(), and Cache::recvTimingSnoopResp().

Member Data Documentation

ReqPacketQueue& QueuedMasterPort::reqQueue
protected

Packet queue used to store outgoing requests.

Definition at line 113 of file qport.hh.

Referenced by checkFunctional(), recvReqRetry(), BaseCache::CacheMasterPort::schedSendEvent(), and schedTimingReq().

SnoopRespPacketQueue& QueuedMasterPort::snoopRespQueue
protected

Packet queue used to store outgoing snoop responses.

Definition at line 116 of file qport.hh.

Referenced by checkFunctional(), recvRetrySnoopResp(), and schedTimingSnoopResp().


The documentation for this class was generated from the following file:

Generated on Fri Jun 9 2017 13:04:17 for gem5 by doxygen 1.8.6