#include <token_port.hh>

Inheritance diagram for gem5::TokenResponsePort:

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

	~TokenResponsePort ()

void	bind (Port &peer) override
	Bind this response port to a request port.

void	unbind () override
	Unbind this response port and associated request port.

void	sendTokens (int num_tokens)
	Return num_tokens tokens back to the request port.

bool	sendTimingResp (PacketPtr pkt)

bool	trySatisfyFunctional (PacketPtr)

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.

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.

Private Member Functions
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.

Private Attributes
TokenRequestPort *	tokenRequestPort

std::deque< PacketPtr >	respQueue

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.

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.

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.

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 91 of file token_port.hh.

Constructor & Destructor Documentation

◆ TokenResponsePort()

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

inline

Definition at line 101 of file token_port.hh.

◆ ~TokenResponsePort()

gem5::TokenResponsePort::~TokenResponsePort ( )

inline

Definition at line 105 of file token_port.hh.

Member Function Documentation

◆ bind()

void gem5::TokenResponsePort::bind ( Port & peer )

overridevirtual

Bind this response port to a request port.

This also does the mirror action and binds the request port to the response port as well as binding the base class types.

Reimplemented from gem5::ResponsePort.

Definition at line 87 of file token_port.cc.

References gem5::TokenRequestPort::bind(), fatal, gem5::Port::name(), and tokenRequestPort.

◆ recvRespRetry()

void gem5::TokenResponsePort::recvRespRetry ( )

overrideprivatevirtual

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

Implements gem5::TimingResponseProtocol.

Definition at line 116 of file token_port.cc.

References panic_if, respQueue, and gem5::ResponsePort::sendTimingResp().

◆ sendTimingResp()

bool gem5::TokenResponsePort::sendTimingResp ( PacketPtr pkt )

Definition at line 131 of file token_port.cc.

References respQueue, and gem5::ResponsePort::sendTimingResp().

◆ sendTokens()

void gem5::TokenResponsePort::sendTokens ( int num_tokens )

Return num_tokens tokens back to the request port.

Definition at line 78 of file token_port.cc.

References fatal_if, gem5::TokenRequestPort::recvTokens(), and tokenRequestPort.

Referenced by gem5::ruby::UncoalescedTable::updateResources().

◆ trySatisfyFunctional()

bool gem5::TokenResponsePort::trySatisfyFunctional ( PacketPtr )

inline

Definition at line 127 of file token_port.hh.

◆ unbind()

void gem5::TokenResponsePort::unbind ( )

overridevirtual

Unbind this response port and associated request port.

Reimplemented from gem5::ResponsePort.

Definition at line 109 of file token_port.cc.

References gem5::ResponsePort::responderUnbind(), and tokenRequestPort.

Member Data Documentation

◆ respQueue

std::deque<PacketPtr> gem5::TokenResponsePort::respQueue

private

Definition at line 96 of file token_port.hh.

Referenced by recvRespRetry(), and sendTimingResp().

◆ tokenRequestPort

TokenRequestPort* gem5::TokenResponsePort::tokenRequestPort

private

Definition at line 94 of file token_port.hh.

Referenced by bind(), sendTokens(), and unbind().

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

mem/token_port.hh
mem/token_port.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TokenResponsePort()

◆ ~TokenResponsePort()

Member Function Documentation

◆ bind()

◆ recvRespRetry()

◆ sendTimingResp()

◆ sendTokens()

◆ trySatisfyFunctional()

◆ unbind()

Member Data Documentation

◆ respQueue

◆ tokenRequestPort