gem5::memory::qos::MemSinkCtrl::MemoryPort Class Reference

Inheritance diagram for gem5::memory::qos::MemSinkCtrl::MemoryPort:

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

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

Private Attributes
MemSinkCtrl &	mem
	reference to parent memory object
RespPacketQueue	queue
	Outgoing packet responses queue.

Additional Inherited Members
Protected Attributes inherited from gem5::QueuedResponsePort
RespPacketQueue &	respQueue
	Packet queue used to store outgoing responses.
Protected Attributes inherited from gem5::ResponsePort
SimObject &	owner
Protected Attributes inherited from gem5::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.
Port *	_peer
	A pointer to this port's peer.
bool	_connected
	Whether this port is currently connected to a peer port.

Detailed Description

Definition at line 84 of file mem_sink.hh.

Constructor & Destructor Documentation

MemoryPort()

gem5::memory::qos::MemSinkCtrl::MemoryPort::MemoryPort	(	const std::string &	n,
		MemSinkCtrl &	m )

Constructor.

Parameters

n	port name
m	reference to ProfileGen parent object

Definition at line 353 of file mem_sink.cc.

Member Function Documentation

getAddrRanges()

AddrRangeList gem5::memory::qos::MemSinkCtrl::MemoryPort::getAddrRanges ( ) const

protectedvirtual

Gets the configured address ranges for this port.

Returns

the configured address ranges for this port

Implements gem5::ResponsePort.

Definition at line 360 of file mem_sink.cc.

References mem.

recvAtomic()

Tick gem5::memory::qos::MemSinkCtrl::MemoryPort::recvAtomic ( PacketPtr pkt )

protectedvirtual

Receive a Packet in Atomic mode.

Parameters

pkt	pointer to memory packet

Returns

packet access latency in ticks

Implements gem5::AtomicResponseProtocol.

Definition at line 368 of file mem_sink.cc.

References mem.

recvFunctional()

void gem5::memory::qos::MemSinkCtrl::MemoryPort::recvFunctional ( PacketPtr pkt )

protectedvirtual

Receive a Packet in Functional mode.

Parameters

pkt	pointer to memory packet

Implements gem5::FunctionalResponseProtocol.

Definition at line 374 of file mem_sink.cc.

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

recvTimingReq()

bool gem5::memory::qos::MemSinkCtrl::MemoryPort::recvTimingReq ( PacketPtr pkt )

protectedvirtual

Receive a Packet in Timing mode.

Parameters

pkt	pointer to memory packet

Returns

true if the request was accepted

Implements gem5::TimingResponseProtocol.

Definition at line 389 of file mem_sink.cc.

References mem.

Member Data Documentation

mem

MemSinkCtrl& gem5::memory::qos::MemSinkCtrl::MemoryPort::mem

private

reference to parent memory object

Definition at line 88 of file mem_sink.hh.

queue

RespPacketQueue gem5::memory::qos::MemSinkCtrl::MemoryPort::queue

private

Outgoing packet responses queue.

Definition at line 91 of file mem_sink.hh.

---

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

• mem/qos/mem_sink.hh
• mem/qos/mem_sink.cc