#include <RubyPort.hh>

Inheritance diagram for gem5::ruby::RubyPort::MemResponsePort:

Public Member Functions
	MemResponsePort (const std::string &_name, RubyPort &_port, bool _access_backing_store, PortID id, bool _no_retry_on_stall)

void	hitCallback (PacketPtr pkt)

void	evictionCallback (Addr address)

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
bool	recvTimingReq (PacketPtr pkt)
	Receive a timing request from the peer.

Tick	recvAtomic (PacketPtr pkt)
	Receive an atomic request packet from the peer.

void	recvFunctional (PacketPtr pkt)
	Receive a functional request packet from the peer.

AddrRangeList	getAddrRanges () const
	Get a list of the non-overlapping address ranges the owner is responsible for.

void	addToRetryList ()

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 Member Functions
bool	isShadowRomAddress (Addr addr) const

bool	isPhysMemAddress (PacketPtr pkt) const

Private Attributes
RubyPort &	owner

RespPacketQueue	queue

bool	access_backing_store

bool	no_retry_on_stall

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 82 of file RubyPort.hh.

Constructor & Destructor Documentation

◆ MemResponsePort()

gem5::ruby::RubyPort::MemResponsePort::MemResponsePort	(	const std::string &	_name,
		RubyPort &	_port,
		bool	_access_backing_store,
		PortID	id,
		bool	_no_retry_on_stall )

Definition at line 163 of file RubyPort.cc.

References gem5::Named::_name, and DPRINTF.

Member Function Documentation

◆ addToRetryList()

void gem5::ruby::RubyPort::MemResponsePort::addToRetryList ( )

protected

Definition at line 377 of file RubyPort.cc.

◆ evictionCallback()

void gem5::ruby::RubyPort::MemResponsePort::evictionCallback ( Addr address )

◆ getAddrRanges()

AddrRangeList gem5::ruby::RubyPort::MemResponsePort::getAddrRanges ( ) const

inlineprotectedvirtual

Get a list of the non-overlapping address ranges the owner is responsible for.

All response ports must override this function and return a populated list with at least one item.

Returns: a list of ranges responded to

Implements gem5::ResponsePort.

Definition at line 105 of file RubyPort.hh.

◆ hitCallback()

void gem5::ruby::RubyPort::MemResponsePort::hitCallback ( PacketPtr pkt )

◆ isPhysMemAddress()

bool gem5::ruby::RubyPort::MemResponsePort::isPhysMemAddress ( PacketPtr pkt ) const

private

Definition at line 687 of file RubyPort.cc.

References gem5::X86ISA::addr, and gem5::Packet::getAddr().

◆ isShadowRomAddress()

bool gem5::ruby::RubyPort::MemResponsePort::isShadowRomAddress ( Addr addr ) const

private

Definition at line 673 of file RubyPort.cc.

References gem5::X86ISA::addr.

◆ recvAtomic()

Tick gem5::ruby::RubyPort::MemResponsePort::recvAtomic ( PacketPtr pkt )

protectedvirtual

Receive an atomic request packet from the peer.

Implements gem5::AtomicResponseProtocol.

Definition at line 322 of file RubyPort.cc.

References gem5::Packet::cmd, DPRINTF, gem5::Packet::getAddr(), gem5::ruby::RubySystem::getBlockSizeBytes(), gem5::ruby::getOffset(), gem5::Packet::getSize(), gem5::MemCmd::MemSyncReq, panic, gem5::Packet::pushSenderState(), gem5::ruby::AbstractController::recvAtomic(), and gem5::ArmISA::rs.

◆ recvFunctional()

void gem5::ruby::RubyPort::MemResponsePort::recvFunctional ( PacketPtr pkt )

protectedvirtual

Receive a functional request packet from the peer.

Implements gem5::FunctionalResponseProtocol.

Definition at line 391 of file RubyPort.cc.

References gem5::Packet::cmdString(), DPRINTF, fatal, gem5::Packet::getAddr(), gem5::ruby::RubySystem::getBlockSizeBytes(), gem5::Packet::getSize(), gem5::Packet::isRead(), gem5::Packet::isResponse(), gem5::Packet::isWrite(), gem5::ruby::makeLineAddress(), gem5::Packet::makeResponse(), gem5::Packet::needsResponse(), panic, gem5::ArmISA::rs, gem5::Packet::setFunctionalResponseStatus(), and gem5::Packet::suppressFuncError().

◆ recvTimingReq()

bool gem5::ruby::RubyPort::MemResponsePort::recvTimingReq ( PacketPtr pkt )

protectedvirtual

Receive a timing request from the peer.

Implements gem5::TimingResponseProtocol.

Definition at line 252 of file RubyPort.cc.

References gem5::ruby::RubyPort::addToRetryList(), gem5::Packet::cacheResponding(), gem5::Packet::cmd, gem5::Packet::cmdString(), gem5::curTick(), DPRINTF, gem5::Packet::getAddr(), gem5::Packet::makeResponse(), gem5::MemCmd::MemSyncReq, panic, gem5::Packet::popSenderState(), gem5::Packet::pushSenderState(), gem5::Packet::req, gem5::ArmISA::rs, gem5::safe_cast(), gem5::ArmISA::ss, and warn_once.

Member Data Documentation

◆ access_backing_store

bool gem5::ruby::RubyPort::MemResponsePort::access_backing_store

private

Definition at line 87 of file RubyPort.hh.

◆ no_retry_on_stall

bool gem5::ruby::RubyPort::MemResponsePort::no_retry_on_stall

private

Definition at line 88 of file RubyPort.hh.

◆ owner

RubyPort& gem5::ruby::RubyPort::MemResponsePort::owner

private

Definition at line 85 of file RubyPort.hh.

◆ queue

RespPacketQueue gem5::ruby::RubyPort::MemResponsePort::queue

private

Definition at line 86 of file RubyPort.hh.

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

mem/ruby/system/RubyPort.hh
mem/ruby/system/RubyPort.cc

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MemResponsePort()

Member Function Documentation

◆ addToRetryList()

◆ evictionCallback()

◆ getAddrRanges()

◆ hitCallback()

◆ isPhysMemAddress()

◆ isShadowRomAddress()

◆ recvAtomic()

◆ recvFunctional()

◆ recvTimingReq()

Member Data Documentation

◆ access_backing_store

◆ no_retry_on_stall

◆ owner

◆ queue