gem5  v20.1.0.0
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
QoS::MemSinkCtrl::MemoryPort Class Reference
Inheritance diagram for QoS::MemSinkCtrl::MemoryPort:
QueuedResponsePort ResponsePort Port AtomicResponseProtocol TimingResponseProtocol FunctionalResponseProtocol

Public Member Functions

 MemoryPort (const std::string &, MemSinkCtrl &)
 Constructor. More...
 
- Public Member Functions inherited from QueuedResponsePort
 QueuedResponsePort (const std::string &name, SimObject *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 ~QueuedResponsePort ()
 
void schedTimingResp (PacketPtr pkt, Tick when)
 Schedule the sending of a timing response. More...
 
bool trySatisfyFunctional (PacketPtr pkt)
 Check the list of buffered packets against the supplied functional request. More...
 
- Public Member Functions inherited from ResponsePort
 ResponsePort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Response port. More...
 
virtual ~ResponsePort ()
 
bool isSnooping () const
 Find out if the peer request port is snooping or not. More...
 
void sendRangeChange () const
 Called by the owner to send a range change. More...
 
void unbind () override
 We let the request port do the work, so these don't do anything. More...
 
void bind (Port &peer) override
 Attach to a peer port. More...
 
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) const
 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 request port by calling its corresponding receive function. More...
 
void sendTimingSnoopReq (PacketPtr pkt)
 Attempt to send a timing snoop request packet to the request port by calling its corresponding receive function. More...
 
void sendRetryReq ()
 Send a retry to the request port that previously attempted a sendTimingReq to this response port and failed. More...
 
void sendRetrySnoopResp ()
 Send a retry to the request port that previously attempted a sendTimingSnoopResp to this response port and failed. More...
 
- Public Member Functions inherited from Port
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 
PortgetPeer ()
 Return a reference to this port's peer. More...
 
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 
bool isConnected () const
 Is this port currently connected to a peer? More...
 
void takeOverFrom (Port *old)
 A utility function to make it easier to swap out ports. More...
 

Protected Member Functions

Tick recvAtomic (PacketPtr pkt)
 Receive a Packet in Atomic mode. More...
 
void recvFunctional (PacketPtr pkt)
 Receive a Packet in Functional mode. More...
 
bool recvTimingReq (PacketPtr pkt)
 Receive a Packet in Timing mode. More...
 
AddrRangeList getAddrRanges () const
 Gets the configured address ranges for this port. More...
 
- Protected Member Functions inherited from QueuedResponsePort
void recvRespRetry ()
 Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from ResponsePort
void responderUnbind ()
 Called by the request port to unbind. More...
 
void responderBind (RequestPort &request_port)
 Called by the request port to bind. More...
 
Tick recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
 Default implementations. More...
 
bool tryTiming (PacketPtr pkt) override
 Availability request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr pkt) override
 Receive a timing snoop response from the peer. More...
 
- Protected Member Functions inherited from Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from AtomicResponseProtocol
Tick sendSnoop (AtomicRequestProtocol *peer, 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...
 
- Protected Member Functions inherited from TimingResponseProtocol
bool sendResp (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing response to the peer by calling its corresponding receive function. More...
 
void sendSnoopReq (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing snoop request packet to the peer by calling its corresponding receive function. More...
 
void sendRetryReq (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed. More...
 
void sendRetrySnoopResp (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed. More...
 
- Protected Member Functions inherited from FunctionalResponseProtocol
void sendSnoop (FunctionalRequestProtocol *peer, PacketPtr pkt) const
 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...
 

Private Attributes

MemSinkCtrlmemory
 reference to parent memory object More...
 
RespPacketQueue queue
 Outgoing packet responses queue. More...
 

Additional Inherited Members

- Protected Attributes inherited from QueuedResponsePort
RespPacketQueuerespQueue
 Packet queue used to store outgoing responses. More...
 
- Protected Attributes inherited from ResponsePort
SimObjectowner
 
- 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...
 
Port_peer
 A pointer to this port's peer. More...
 
bool _connected
 Whether this port is currently connected to a peer port. More...
 

Detailed Description

Definition at line 71 of file mem_sink.hh.

Constructor & Destructor Documentation

◆ MemoryPort()

QoS::MemSinkCtrl::MemoryPort::MemoryPort ( const std::string &  n,
MemSinkCtrl m 
)

Constructor.

Parameters
nport name
mreference to ProfileGen parent object

Definition at line 349 of file mem_sink.cc.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList QoS::MemSinkCtrl::MemoryPort::getAddrRanges ( ) const
protectedvirtual

Gets the configured address ranges for this port.

Returns
the configured address ranges for this port

Implements ResponsePort.

Definition at line 356 of file mem_sink.cc.

◆ recvAtomic()

Tick QoS::MemSinkCtrl::MemoryPort::recvAtomic ( PacketPtr  pkt)
protectedvirtual

Receive a Packet in Atomic mode.

Parameters
pktpointer to memory packet
Returns
packet access latency in ticks

Implements AtomicResponseProtocol.

Definition at line 364 of file mem_sink.cc.

◆ recvFunctional()

void QoS::MemSinkCtrl::MemoryPort::recvFunctional ( PacketPtr  pkt)
protectedvirtual

Receive a Packet in Functional mode.

Parameters
pktpointer to memory packet

Implements FunctionalResponseProtocol.

Definition at line 370 of file mem_sink.cc.

References Packet::popLabel(), and Packet::pushLabel().

◆ recvTimingReq()

bool QoS::MemSinkCtrl::MemoryPort::recvTimingReq ( PacketPtr  pkt)
protectedvirtual

Receive a Packet in Timing mode.

Parameters
pktpointer to memory packet
Returns
true if the request was accepted

Implements TimingResponseProtocol.

Definition at line 385 of file mem_sink.cc.

Member Data Documentation

◆ memory

MemSinkCtrl& QoS::MemSinkCtrl::MemoryPort::memory
private

reference to parent memory object

Definition at line 75 of file mem_sink.hh.

◆ queue

RespPacketQueue QoS::MemSinkCtrl::MemoryPort::queue
private

Outgoing packet responses queue.

Definition at line 78 of file mem_sink.hh.


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

Generated on Wed Sep 30 2020 14:03:08 for gem5 by doxygen 1.8.17