The simple timing port uses a queued port to implement recvFunctional and recvTimingReq through recvAtomic. More...

#include <tport.hh>

Inheritance diagram for gem5::SimpleTimingPort:

Public Member Functions
	SimpleTimingPort (const std::string &name, SimObject *owner)
	Create a new SimpleTimingPort that relies on a packet queue to hold responses, and implements recvTimingReq and recvFunctional through calls to recvAtomic.

virtual	~SimpleTimingPort ()

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.

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.

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
void	recvFunctional (PacketPtr pkt)
	Implemented using recvAtomic().

bool	recvTimingReq (PacketPtr pkt)
	Implemented using recvAtomic().

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

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.

Protected Attributes
std::unique_ptr< Packet >	pendingDelete
	Upstream caches need this packet until true is returned, so hold it for deletion until a subsequent call.

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.

Private Attributes
RespPacketQueue	queueImpl
	The packet queue used to store outgoing responses.

Detailed Description

The simple timing port uses a queued port to implement recvFunctional and recvTimingReq through recvAtomic.

It is always a response port.

Definition at line 62 of file tport.hh.

Constructor & Destructor Documentation

◆ SimpleTimingPort()

gem5::SimpleTimingPort::SimpleTimingPort	(	const std::string &	name,
		SimObject *	owner )

Create a new SimpleTimingPort that relies on a packet queue to hold responses, and implements recvTimingReq and recvFunctional through calls to recvAtomic.

Once a request arrives, it is passed to recvAtomic, and in the case of a timing access any response is scheduled to be sent after the delay of the atomic operation.

Parameters

name	port name
owner	structural owner

Definition at line 47 of file tport.cc.

◆ ~SimpleTimingPort()

virtual gem5::SimpleTimingPort::~SimpleTimingPort ( )

inlinevirtual

Definition at line 106 of file tport.hh.

Member Function Documentation

◆ recvAtomic()

virtual Tick gem5::SimpleTimingPort::recvAtomic ( PacketPtr pkt )

protectedpure virtual

Receive an atomic request packet from the peer.

Implements gem5::AtomicResponseProtocol.

Implemented in gem5::PioPort< Device >, gem5::PioPort< gem5::PioDevice >, gem5::PioPort< gem5::X86ISA::Interrupts >, gem5::SMMUControlPort, gem5::X86ISA::IntResponsePort< Device >, and gem5::X86ISA::IntResponsePort< gem5::X86ISA::Interrupts >.

Referenced by recvFunctional(), and recvTimingReq().

◆ recvFunctional()

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

protectedvirtual

Implemented using recvAtomic().

Implements gem5::FunctionalResponseProtocol.

Definition at line 54 of file tport.cc.

References recvAtomic(), gem5::QueuedResponsePort::respQueue, and gem5::PacketQueue::trySatisfyFunctional().

◆ recvTimingReq()

bool gem5::SimpleTimingPort::recvTimingReq ( PacketPtr pkt )

protectedvirtual

Implemented using recvAtomic().

Implements gem5::TimingResponseProtocol.

Definition at line 63 of file tport.cc.

References gem5::Packet::cacheResponding(), gem5::curTick(), gem5::Packet::isResponse(), gem5::Packet::needsResponse(), panic, pendingDelete, recvAtomic(), and gem5::QueuedResponsePort::schedTimingResp().

Member Data Documentation

◆ pendingDelete

std::unique_ptr<Packet> gem5::SimpleTimingPort::pendingDelete

protected

Upstream caches need this packet until true is returned, so hold it for deletion until a subsequent call.

Definition at line 89 of file tport.hh.

Referenced by recvTimingReq().

◆ queueImpl

RespPacketQueue gem5::SimpleTimingPort::queueImpl

private

The packet queue used to store outgoing responses.

Note that the queue is made private and that we avoid overloading the name used in the QueuedResponsePort. Access is provided through the queue reference in the base class.

Definition at line 73 of file tport.hh.

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

mem/tport.hh
mem/tport.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes