The ResponsePortWrapper converts inherit-based ResponsePort into callback-based. More...

#include <port_wrapper.hh>

Inheritance diagram for gem5::ResponsePortWrapper:

Public Types
using	GetAddrRangesCallback = std::function< AddrRangeList()>

using	RecvTimingReqCallback = std::function< bool(PacketPtr)>

using	RecvAtomicCallback = std::function< Tick(PacketPtr)>

using	RecvAtomicBackdoorCallback = std::function< Tick(PacketPtr, MemBackdoorPtr &)>

using	RecvFunctionalCallback = std::function< void(PacketPtr)>

using	RecvMemBackdoorReqCallback = std::function< void(const MemBackdoorReq &, MemBackdoorPtr &)>

using	RecvRespRetryCallback = std::function< void()>

Public Member Functions
	ResponsePortWrapper (const std::string &name, PortID id=InvalidPortID)

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

bool	recvTimingReq (PacketPtr) override
	Receive a timing request from the peer.

void	recvRespRetry () override
	Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called on the peer) and was unsuccessful.

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

Tick	recvAtomicBackdoor (PacketPtr, MemBackdoorPtr &) override
	Default implementations.

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

void	recvMemBackdoorReq (const MemBackdoorReq &, MemBackdoorPtr &) override
	Receive a request for a back door to a range of memory.

void	setGetAddrRangesCallback (GetAddrRangesCallback)

void	setTimingCallbacks (RecvTimingReqCallback, RecvRespRetryCallback)

void	setAtomicCallbacks (RecvAtomicCallback, RecvAtomicBackdoorCallback=nullptr)

void	setFunctionalCallbacks (RecvFunctionalCallback, RecvMemBackdoorReqCallback=nullptr)

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.

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

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.

virtual void	bind (Port &peer)
	Attach to a peer port.

virtual void	unbind ()
	Dettach from a peer port.

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.

Private Attributes
GetAddrRangesCallback	getAddrRangesCb = nullptr

RecvTimingReqCallback	recvTimingReqCb = nullptr

RecvRespRetryCallback	recvRespRetryCb = nullptr

RecvAtomicCallback	recvAtomicCb = nullptr

RecvAtomicBackdoorCallback	recvAtomicBackdoorCb = nullptr

RecvFunctionalCallback	recvFunctionalCb = nullptr

RecvMemBackdoorReqCallback	recvMemBackdoorReqCb = nullptr

Additional Inherited Members
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.

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

virtual Tick	recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)=0
	Receive an atomic request packet from the peer, and optionally provide a backdoor to the data being accessed.

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.

virtual bool	recvTimingReq (PacketPtr pkt)=0
	Receive a timing request from the peer.

virtual bool	tryTiming (PacketPtr pkt)=0
	Availability request from the peer.

virtual bool	recvTimingSnoopResp (PacketPtr pkt)=0
	Receive a timing snoop response from the peer.

virtual void	recvRespRetry ()=0
	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::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.

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

virtual void	recvMemBackdoorReq (const MemBackdoorReq &req, MemBackdoorPtr &backdoor)=0
	Receive a request for a back door to a range of memory.

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

The ResponsePortWrapper converts inherit-based ResponsePort into callback-based.

Definition at line 104 of file port_wrapper.hh.

Member Typedef Documentation

◆ GetAddrRangesCallback

using gem5::ResponsePortWrapper::GetAddrRangesCallback = std::function<AddrRangeList()>

Definition at line 107 of file port_wrapper.hh.

◆ RecvAtomicBackdoorCallback

using gem5::ResponsePortWrapper::RecvAtomicBackdoorCallback = std::function<Tick(PacketPtr, MemBackdoorPtr&)>

Definition at line 112 of file port_wrapper.hh.

◆ RecvAtomicCallback

using gem5::ResponsePortWrapper::RecvAtomicCallback = std::function<Tick(PacketPtr)>

Definition at line 111 of file port_wrapper.hh.

◆ RecvFunctionalCallback

using gem5::ResponsePortWrapper::RecvFunctionalCallback = std::function<void(PacketPtr)>

Definition at line 116 of file port_wrapper.hh.

◆ RecvMemBackdoorReqCallback

using gem5::ResponsePortWrapper::RecvMemBackdoorReqCallback = std::function<void(const MemBackdoorReq&, MemBackdoorPtr&)>

Definition at line 117 of file port_wrapper.hh.

◆ RecvRespRetryCallback

using gem5::ResponsePortWrapper::RecvRespRetryCallback = std::function<void()>

Definition at line 120 of file port_wrapper.hh.

◆ RecvTimingReqCallback

using gem5::ResponsePortWrapper::RecvTimingReqCallback = std::function<bool(PacketPtr)>

Definition at line 109 of file port_wrapper.hh.

Constructor & Destructor Documentation

◆ ResponsePortWrapper()

gem5::ResponsePortWrapper::ResponsePortWrapper	(	const std::string &	name,
		PortID	id = `InvalidPortID`
	)

Definition at line 76 of file port_wrapper.cc.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::ResponsePortWrapper::getAddrRanges ( ) const

overridevirtual

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 82 of file port_wrapper.cc.

References getAddrRangesCb, and panic_if.

◆ recvAtomic()

Tick gem5::ResponsePortWrapper::recvAtomic ( PacketPtr pkt )

overridevirtual

Receive an atomic request packet from the peer.

Implements gem5::AtomicResponseProtocol.

Definition at line 103 of file port_wrapper.cc.

References panic_if, and recvAtomicCb.

◆ recvAtomicBackdoor()

Tick gem5::ResponsePortWrapper::recvAtomicBackdoor	(	PacketPtr	pkt,
		MemBackdoorPtr &	backdoor
	)

overridevirtual

Default implementations.

Reimplemented from gem5::ResponsePort.

Definition at line 110 of file port_wrapper.cc.

References gem5::ResponsePort::recvAtomicBackdoor(), and recvAtomicBackdoorCb.

◆ recvFunctional()

void gem5::ResponsePortWrapper::recvFunctional ( PacketPtr pkt )

overridevirtual

Receive a functional request packet from the peer.

Implements gem5::FunctionalResponseProtocol.

Definition at line 120 of file port_wrapper.cc.

References panic_if, recvFunctionalCb, and recvTimingReqCb.

◆ recvMemBackdoorReq()

void gem5::ResponsePortWrapper::recvMemBackdoorReq	(	const MemBackdoorReq &	req,
		MemBackdoorPtr &	backdoor
	)

overridevirtual

Receive a request for a back door to a range of memory.

Parameters

req	An object which describes what back door is being requested.
backdoor	Can be set to a back door pointer by the target to let caller have direct access to the requested range.

Reimplemented from gem5::ResponsePort.

Definition at line 127 of file port_wrapper.cc.

References gem5::ResponsePort::recvMemBackdoorReq(), and recvMemBackdoorReqCb.