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

#include <token_port.hh>

Inheritance diagram for gem5::TokenResponsePort:
gem5::ResponsePort gem5::Port gem5::AtomicResponseProtocol gem5::TimingResponseProtocol gem5::FunctionalResponseProtocol gem5::ruby::GPUCoalescer::GMTokenPort

Public Member Functions

 TokenResponsePort (const std::string &name, ClockedObject *owner, PortID id=InvalidPortID)
 
 ~TokenResponsePort ()
 
void bind (Port &peer) override
 Bind this response port to a request port. More...
 
void unbind () override
 Unbind this response port and associated request port. More...
 
void sendTokens (int num_tokens)
 Return num_tokens tokens back to the request port. More...
 
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. 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...
 
virtual AddrRangeList getAddrRanges () const =0
 Get a list of the non-overlapping address ranges the owner is responsible for. 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...
 

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. More...
 

Private Attributes

TokenRequestPorttokenRequestPort
 
std::deque< PacketPtrrespQueue
 

Additional Inherited Members

- 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...
 
virtual Tick recvAtomic (PacketPtr pkt)=0
 Receive an atomic request packet from the peer. 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...
 
virtual bool recvTimingReq (PacketPtr pkt)=0
 Receive a timing request from the peer. 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...
 
virtual void recvFunctional (PacketPtr pkt)=0
 Receive a functional request packet from the peer. More...
 
- 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

Definition at line 93 of file token_port.hh.

Constructor & Destructor Documentation

◆ TokenResponsePort()

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

Definition at line 103 of file token_port.hh.

◆ ~TokenResponsePort()

gem5::TokenResponsePort::~TokenResponsePort ( )
inline

Definition at line 107 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 89 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 118 of file token_port.cc.

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

◆ sendTimingResp()

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

Definition at line 133 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 80 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 129 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 111 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 98 of file token_port.hh.

Referenced by recvRespRetry(), and sendTimingResp().

◆ tokenRequestPort

TokenRequestPort* gem5::TokenResponsePort::tokenRequestPort
private

Definition at line 96 of file token_port.hh.

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


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

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