gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
gem5::SimpleMemobj::CPUSidePort Class Reference

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

Inheritance diagram for gem5::SimpleMemobj::CPUSidePort:
gem5::ResponsePort gem5::Port gem5::AtomicResponseProtocol gem5::TimingResponseProtocol gem5::FunctionalResponseProtocol

Public Member Functions

 CPUSidePort (const std::string &name, SimpleMemobj *owner)
 Constructor. More...
 
void sendPacket (PacketPtr pkt)
 Send a packet across this port. More...
 
AddrRangeList getAddrRanges () const override
 Get a list of the non-overlapping address ranges the owner is responsible for. More...
 
void trySendRetry ()
 Send a retry to the peer port only if it is needed. More...
 
- Public Member Functions inherited from gem5::ResponsePort
 ResponsePort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Response port. More...
 
virtual ~ResponsePort ()
 
bool isSnooping () const
 Find out if the peer request port is snooping or not. More...
 
void sendRangeChange () const
 Called by the owner to send a range change. More...
 
void unbind () override
 We let the request port do the work, so these don't do anything. More...
 
void bind (Port &peer) override
 Attach to a peer port. More...
 
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. More...
 
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. More...
 
bool sendTimingResp (PacketPtr pkt)
 Attempt to send a timing response to the request port by calling its corresponding receive function. More...
 
void sendTimingSnoopReq (PacketPtr pkt)
 Attempt to send a timing snoop request packet to the request port by calling its corresponding receive function. More...
 
void sendRetryReq ()
 Send a retry to the request port that previously attempted a sendTimingReq to this response port and failed. More...
 
void sendRetrySnoopResp ()
 Send a retry to the request port that previously attempted a sendTimingSnoopResp to this response port and failed. More...
 
- Public Member Functions inherited from gem5::Port
virtual ~Port ()
 Virtual destructor due to inheritance. More...
 
PortgetPeer ()
 Return a reference to this port's peer. More...
 
const std::string name () const
 Return port name (for DPRINTF). More...
 
PortID getId () const
 Get the port id. More...
 
bool isConnected () const
 Is this port currently connected to a peer? More...
 
void takeOverFrom (Port *old)
 A utility function to make it easier to swap out ports. More...
 

Protected Member Functions

Tick recvAtomic (PacketPtr pkt) override
 Receive an atomic request packet from the request port. More...
 
void recvFunctional (PacketPtr pkt) override
 Receive a functional request packet from the request port. More...
 
bool recvTimingReq (PacketPtr pkt) override
 Receive a timing request from the request port. More...
 
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 unsuccesful. More...
 
- Protected Member Functions inherited from gem5::ResponsePort
void responderUnbind ()
 Called by the request port to unbind. More...
 
void responderBind (RequestPort &request_port)
 Called by the request port to bind. More...
 
Tick recvAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor) override
 Default implementations. More...
 
bool tryTiming (PacketPtr pkt) override
 Availability request from the peer. More...
 
bool recvTimingSnoopResp (PacketPtr pkt) override
 Receive a timing snoop response from the peer. More...
 
- Protected Member Functions inherited from gem5::Port
void reportUnbound () const
 
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- 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. More...
 
- 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. More...
 
void sendSnoopReq (TimingRequestProtocol *peer, PacketPtr pkt)
 Attempt to send a timing snoop request packet to the peer by calling its corresponding receive function. More...
 
void sendRetryReq (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed. More...
 
void sendRetrySnoopResp (TimingRequestProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed. More...
 
- 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. More...
 

Private Attributes

SimpleMemobjowner
 The object that owns this object (SimpleMemobj) More...
 
bool needRetry
 True if the port needs to send a retry req. More...
 
PacketPtr blockedPacket
 If we tried to send a packet and it was blocked, store it here. More...
 

Additional Inherited Members

- Protected Attributes inherited from gem5::ResponsePort
SimObjectowner
 
- 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. More...
 
Port_peer
 A pointer to this port's peer. More...
 
bool _connected
 Whether this port is currently connected to a peer port. More...
 

Detailed Description

Port on the CPU-side that receives requests.

Mostly just forwards requests to the owner. Part of a vector of ports. One for each CPU port (e.g., data, inst)

Definition at line 54 of file simple_memobj.hh.

Constructor & Destructor Documentation

◆ CPUSidePort()

gem5::SimpleMemobj::CPUSidePort::CPUSidePort ( const std::string &  name,
SimpleMemobj owner 
)
inline

Constructor.

Just calls the superclass constructor.

Definition at line 70 of file simple_memobj.hh.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::SimpleMemobj::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 78 of file simple_memobj.cc.

◆ recvAtomic()

Tick gem5::SimpleMemobj::CPUSidePort::recvAtomic ( PacketPtr  pkt)
inlineoverrideprotectedvirtual

Receive an atomic request packet from the request port.

No need to implement in this simple memobj.

Implements gem5::AtomicResponseProtocol.

Definition at line 103 of file simple_memobj.hh.

References panic.

◆ recvFunctional()

void gem5::SimpleMemobj::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
packetthe requestor sent.

Implements gem5::FunctionalResponseProtocol.

Definition at line 95 of file simple_memobj.cc.

◆ recvRespRetry()

void gem5::SimpleMemobj::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 unsuccesful.

Implements gem5::TimingResponseProtocol.

Definition at line 114 of file simple_memobj.cc.

◆ recvTimingReq()

bool gem5::SimpleMemobj::CPUSidePort::recvTimingReq ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a timing request from the request port.

Parameters
thepacket that the requestor sent
Returns
whether this object can consume the packet. If false, we will call sendRetry() when we can try to receive this request again.

Implements gem5::TimingResponseProtocol.

Definition at line 102 of file simple_memobj.cc.

◆ sendPacket()

void gem5::SimpleMemobj::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.

Parameters
packetto send.

Definition at line 65 of file simple_memobj.cc.

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

Referenced by gem5::SimpleMemobj::handleResponse().

◆ trySendRetry()

void gem5::SimpleMemobj::CPUSidePort::trySendRetry ( )

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

This is called from the SimpleMemobj whenever it is unblocked.

Definition at line 84 of file simple_memobj.cc.

References DPRINTF.

Referenced by gem5::SimpleMemobj::handleResponse().

Member Data Documentation

◆ blockedPacket

PacketPtr gem5::SimpleMemobj::CPUSidePort::blockedPacket
private

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

Definition at line 64 of file simple_memobj.hh.

Referenced by sendPacket().

◆ needRetry

bool gem5::SimpleMemobj::CPUSidePort::needRetry
private

True if the port needs to send a retry req.

Definition at line 61 of file simple_memobj.hh.

◆ owner

SimpleMemobj* gem5::SimpleMemobj::CPUSidePort::owner
private

The object that owns this object (SimpleMemobj)

Definition at line 58 of file simple_memobj.hh.


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

Generated on Tue Sep 21 2021 12:28:10 for gem5 by doxygen 1.8.17