Port on the CPU-side that receives requests. More...

Inheritance diagram for gem5::SimpleCache::CPUSidePort:

Public Member Functions
	CPUSidePort (const std::string &name, int id, SimpleCache *owner)
	Constructor.

void	sendPacket (PacketPtr pkt)
	Send a packet across this port.

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

void	trySendRetry ()
	Send a retry to the peer port only if it is needed.

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) override
	Receive an atomic request packet from the request port.

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

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

void	recvRespRetry () override
	Called by the request port if sendTimingResp was called on this response port (causing recvTimingResp to be called on the request port) 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
int	id
	Since this is a vector port, need to know what number this one is.

SimpleCache *	owner
	The object that owns this object (SimpleCache)

bool	needRetry
	True if the port needs to send a retry req.

PacketPtr	blockedPacket
	If we tried to send a packet and it was blocked, store it here.

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

Port on the CPU-side that receives requests.

Mostly just forwards requests to the cache (owner)

Definition at line 57 of file simple_cache.hh.

Constructor & Destructor Documentation

◆ CPUSidePort()

gem5::SimpleCache::CPUSidePort::CPUSidePort	(	const std::string &	name,
		int	id,
		SimpleCache *	owner )

inline

Constructor.

Just calls the superclass constructor.

Definition at line 76 of file simple_cache.hh.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::SimpleCache::CPUSidePort::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 89 of file simple_cache.cc.

◆ recvAtomic()

Tick gem5::SimpleCache::CPUSidePort::recvAtomic ( PacketPtr pkt )

inlineoverrideprotectedvirtual

Receive an atomic request packet from the request port.

No need to implement in this simple cache.

Implements gem5::AtomicResponseProtocol.

Definition at line 110 of file simple_cache.hh.

References panic.

◆ recvFunctional()

void gem5::SimpleCache::CPUSidePort::recvFunctional ( PacketPtr pkt )

overrideprotectedvirtual

Receive a functional request packet from the request port.

Performs a "debug" access updating/reading the data in place.

Parameters

packet the requestor sent.

Implements gem5::FunctionalResponseProtocol.

Definition at line 106 of file simple_cache.cc.

◆ recvRespRetry()

void gem5::SimpleCache::CPUSidePort::recvRespRetry ( )

overrideprotectedvirtual

Called by the request port if sendTimingResp was called on this response port (causing recvTimingResp to be called on the request port) and was unsuccessful.

Implements gem5::TimingResponseProtocol.

Definition at line 136 of file simple_cache.cc.

References DPRINTF, and gem5::Packet::print().

◆ recvTimingReq()

bool gem5::SimpleCache::CPUSidePort::recvTimingReq ( PacketPtr pkt )

overrideprotectedvirtual

Receive a timing request from the request port.

Parameters

the	packet that the requestor sent

Returns: whether this object can consume to packet. If false, we will call sendRetry() when we can try to receive this request again.

Implements gem5::TimingResponseProtocol.

Definition at line 113 of file simple_cache.cc.

References DPRINTF, and gem5::Packet::print().

◆ sendPacket()

void gem5::SimpleCache::CPUSidePort::sendPacket ( PacketPtr pkt )

Send a packet across this port.

This is called by the owner and all of the flow control is hanled in this function. This is a convenience function for the SimpleCache to send pkts.

Parameters

packet to send.

Definition at line 74 of file simple_cache.cc.

References blockedPacket, DPRINTF, panic_if, gem5::Packet::print(), and gem5::ResponsePort::sendTimingResp().

◆ trySendRetry()

void gem5::SimpleCache::CPUSidePort::trySendRetry ( )

Send a retry to the peer port only if it is needed.

This is called from the SimpleCache whenever it is unblocked.

Definition at line 95 of file simple_cache.cc.

References DPRINTF.

Member Data Documentation

◆ blockedPacket

PacketPtr gem5::SimpleCache::CPUSidePort::blockedPacket

private

If we tried to send a packet and it was blocked, store it here.

Definition at line 70 of file simple_cache.hh.

Referenced by sendPacket().

◆ id

int gem5::SimpleCache::CPUSidePort::id

private

Since this is a vector port, need to know what number this one is.

Definition at line 61 of file simple_cache.hh.

◆ needRetry

bool gem5::SimpleCache::CPUSidePort::needRetry

private

True if the port needs to send a retry req.

Definition at line 67 of file simple_cache.hh.

◆ owner

SimpleCache* gem5::SimpleCache::CPUSidePort::owner

private

The object that owns this object (SimpleCache)

Definition at line 64 of file simple_cache.hh.

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

learning_gem5/part2/simple_cache.hh
learning_gem5/part2/simple_cache.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CPUSidePort()

Member Function Documentation

◆ getAddrRanges()

◆ recvAtomic()

◆ recvFunctional()

◆ recvRespRetry()

◆ recvTimingReq()

◆ sendPacket()

◆ trySendRetry()

Member Data Documentation

◆ blockedPacket

◆ id

◆ needRetry

◆ owner