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
QueuedSlavePort Class Reference

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

#include <qport.hh>

Inheritance diagram for QueuedSlavePort:
SlavePort BaseSlavePort Port BaseCache::CacheSlavePort CoherentXBar::CoherentXBarSlavePort DRAMCtrl::MemoryPort NoncoherentXBar::NoncoherentXBarSlavePort RubyPort::MemSlavePort RubyPort::PioSlavePort SimpleTimingPort MessageSlavePort PioPort X86ISA::IntDevice::IntSlavePort

Public Member Functions

 QueuedSlavePort (const std::string &name, MemObject *owner, RespPacketQueue &resp_queue, PortID id=InvalidPortID)
 Create a QueuedPort with a given name, owner, and a supplied implementation of a packet queue. More...
 
virtual ~QueuedSlavePort ()
 
void schedTimingResp (PacketPtr pkt, Tick when, bool force_order=false)
 Schedule the sending of a timing response. More...
 
bool checkFunctional (PacketPtr pkt)
 Check the list of buffered packets against the supplied functional request. More...
 
- Public Member Functions inherited from SlavePort
 SlavePort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 Slave port. More...
 
virtual ~SlavePort ()
 
Tick sendAtomicSnoop (PacketPtr pkt)
 Send an atomic snoop request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
void sendFunctionalSnoop (PacketPtr pkt)
 Send a functional snoop 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 sendTimingResp (PacketPtr pkt)
 Attempt to send a timing response to the master port by calling its corresponding receive function. More...
 
void sendTimingSnoopReq (PacketPtr pkt)
 Attempt to send a timing snoop request packet to the master port by calling its corresponding receive function. More...
 
void sendRetryReq ()
 Send a retry to the master port that previously attempted a sendTimingReq to this slave port and failed. More...
 
void sendRetrySnoopResp ()
 Send a retry to the master port that previously attempted a sendTimingSnoopResp to this slave port and failed. More...
 
bool isSnooping () const
 Find out if the peer master port is snooping or not. More...
 
void sendRangeChange () const
 Called by the owner to send a range change. More...
 
virtual AddrRangeList getAddrRanges () const =0
 Get a list of the non-overlapping address ranges the owner is responsible for. More...
 
- Public Member Functions inherited from BaseSlavePort
BaseMasterPortgetMasterPort () 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 recvRespRetry ()
 Called by the master port if sendTimingResp was called on this slave port (causing recvTimingResp to be called on the master port) and was unsuccesful. More...
 
- Protected Member Functions inherited from SlavePort
void unbind ()
 Called by the master port to unbind. More...
 
void bind (MasterPort &master_port)
 Called by the master port to bind. More...
 
virtual Tick recvAtomic (PacketPtr pkt)=0
 Receive an atomic request packet from the master port. More...
 
virtual void recvFunctional (PacketPtr pkt)=0
 Receive a functional request packet from the master port. More...
 
virtual bool recvTimingReq (PacketPtr pkt)=0
 Receive a timing request from the master port. More...
 
virtual bool recvTimingSnoopResp (PacketPtr pkt)
 Receive a timing snoop response from the master port. More...
 
- Protected Member Functions inherited from BaseSlavePort
 BaseSlavePort (const std::string &name, MemObject *owner, PortID id=InvalidPortID)
 
virtual ~BaseSlavePort ()
 
- 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

RespPacketQueuerespQueue
 Packet queue used to store outgoing responses. More...
 
- Protected Attributes inherited from BaseSlavePort
BaseMasterPort_baseMasterPort
 
- 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

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

Definition at line 59 of file qport.hh.

Constructor & Destructor Documentation

QueuedSlavePort::QueuedSlavePort ( const std::string &  name,
MemObject owner,
RespPacketQueue resp_queue,
PortID  id = InvalidPortID 
)
inline

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.

Definition at line 78 of file qport.hh.

virtual QueuedSlavePort::~QueuedSlavePort ( )
inlinevirtual

Definition at line 83 of file qport.hh.

Member Function Documentation

bool QueuedSlavePort::checkFunctional ( PacketPtr  pkt)
inline

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

Definition at line 96 of file qport.hh.

References PacketQueue::checkFunctional(), and respQueue.

Referenced by Cache::functionalAccess().

void QueuedSlavePort::recvRespRetry ( )
inlineprotectedvirtual

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

Implements SlavePort.

Definition at line 67 of file qport.hh.

References respQueue, and PacketQueue::retry().

void QueuedSlavePort::schedTimingResp ( PacketPtr  pkt,
Tick  when,
bool  force_order = false 
)
inline

Schedule the sending of a timing response.

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

Definition at line 91 of file qport.hh.

References respQueue, and PacketQueue::schedSendTiming().

Referenced by DRAMCtrl::accessAndRespond(), Cache::handleUncacheableWriteResp(), SimpleTimingPort::recvTimingReq(), Cache::recvTimingReq(), RubyPort::PioMasterPort::recvTimingResp(), and Cache::recvTimingResp().

Member Data Documentation

RespPacketQueue& QueuedSlavePort::respQueue
protected

Packet queue used to store outgoing responses.

Definition at line 65 of file qport.hh.

Referenced by checkFunctional(), SimpleTimingPort::recvFunctional(), recvRespRetry(), and schedTimingResp().


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