gem5  v21.2.1.1
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
gem5::GUPSGen::GenPort Class Reference

definition of the GenPort class which is of the type RequestPort. More...

Inheritance diagram for gem5::GUPSGen::GenPort:
gem5::RequestPort gem5::Port gem5::AtomicRequestProtocol gem5::TimingRequestProtocol gem5::FunctionalRequestProtocol

Public Member Functions

 GenPort (const std::string &name, GUPSGen *owner)
 
bool blocked ()
 Return whether the port is blocked. More...
 
void sendTimingPacket (PacketPtr pkt)
 This function send a timing request to the port's peer responsePort. More...
 
void sendFunctionalPacket (PacketPtr pkt)
 This function send a functional request to the port's peer responsePort. More...
 
- Public Member Functions inherited from gem5::RequestPort
 RequestPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Request port. More...
 
virtual ~RequestPort ()
 
void bind (Port &peer) override
 Bind this request port to a response port. More...
 
void unbind () override
 Unbind this request port and the associated response port. More...
 
virtual bool isSnooping () const
 Determine if this request port is snooping or not. More...
 
AddrRangeList getAddrRanges () const
 Get the address ranges of the connected responder port. More...
 
void printAddr (Addr a)
 Inject a PrintReq for the given address to print the state of that address throughout the memory system. More...
 
Tick sendAtomic (PacketPtr pkt)
 Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
Tick sendAtomicBackdoor (PacketPtr pkt, MemBackdoorPtr &backdoor)
 Send an atomic request packet like above, but also request a backdoor to the data being accessed. More...
 
void sendFunctional (PacketPtr pkt) const
 Send a functional 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 sendTimingReq (PacketPtr pkt)
 Attempt to send a timing request to the responder port by calling its corresponding receive function. More...
 
bool tryTiming (PacketPtr pkt) const
 Check if the responder can handle a timing request. More...
 
bool sendTimingSnoopResp (PacketPtr pkt)
 Attempt to send a timing snoop response packet to the response port by calling its corresponding receive function. More...
 
virtual void sendRetryResp ()
 Send a retry to the response port that previously attempted a sendTimingResp to this request 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

bool recvTimingResp (PacketPtr pkt) override
 Receive a timing response from the peer. More...
 
void recvReqRetry () override
 Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful. More...
 
- Protected Member Functions inherited from gem5::RequestPort
virtual void recvRangeChange ()
 Called to receive an address range change from the peer response port. More...
 
Tick recvAtomicSnoop (PacketPtr pkt) override
 Default implementations. More...
 
void recvFunctionalSnoop (PacketPtr pkt) override
 Receive a functional snoop request packet from the peer. More...
 
void recvTimingSnoopReq (PacketPtr pkt) override
 Receive a timing snoop request from the peer. More...
 
void recvRetrySnoopResp () override
 Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to be called on the peer) and was unsuccessful. 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::AtomicRequestProtocol
Tick send (AtomicResponseProtocol *peer, PacketPtr pkt)
 Send an atomic request packet, where the data is moved and the state is updated in zero time, without interleaving with other memory accesses. More...
 
Tick sendBackdoor (AtomicResponseProtocol *peer, PacketPtr pkt, MemBackdoorPtr &backdoor)
 Send an atomic request packet like above, but also request a backdoor to the data being accessed. More...
 
- Protected Member Functions inherited from gem5::TimingRequestProtocol
bool sendReq (TimingResponseProtocol *peer, PacketPtr pkt)
 Attempt to send a timing request to the peer by calling its corresponding receive function. More...
 
bool trySend (TimingResponseProtocol *peer, PacketPtr pkt) const
 Check if the peer can handle a timing request. More...
 
bool sendSnoopResp (TimingResponseProtocol *peer, PacketPtr pkt)
 Attempt to send a timing snoop response packet to it's peer by calling its corresponding receive function. More...
 
void sendRetryResp (TimingResponseProtocol *peer)
 Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed. More...
 
- Protected Member Functions inherited from gem5::FunctionalRequestProtocol
void send (FunctionalResponseProtocol *peer, PacketPtr pkt) const
 Send a functional 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

GUPSGenowner
 Pointer to the GUPSGen this port belongs to. More...
 
bool _blocked
 Boolean value to remember if the port is previously blocked and is occupied by a previous request, it should not accept new requests if it is blocked, instead, it will be freed by a recvReqRetry call from outside. More...
 
PacketPtr blockedPacket
 Pointer to the blocked packet in the port. More...
 

Additional Inherited Members

- Protected Attributes inherited from gem5::RequestPort
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 of the GenPort class which is of the type RequestPort.

It defines the functionalities required for outside communication of memory packets from the GUPSGen simobject. It also implements functionalities of receiving responses from outside.

Definition at line 63 of file gups_gen.hh.

Constructor & Destructor Documentation

◆ GenPort()

gem5::GUPSGen::GenPort::GenPort ( const std::string &  name,
GUPSGen owner 
)
inline

Definition at line 89 of file gups_gen.hh.

Member Function Documentation

◆ blocked()

bool gem5::GUPSGen::GenPort::blocked ( )
inline

Return whether the port is blocked.

Returns
true if the port is blocked.
false if the port is free.

Definition at line 100 of file gups_gen.hh.

References _blocked.

Referenced by gem5::GUPSGen::sendNextReq().

◆ recvReqRetry()

void gem5::GUPSGen::GenPort::recvReqRetry ( )
overrideprotectedvirtual

Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on the peer) and was unsuccessful.

Implements gem5::TimingRequestProtocol.

Definition at line 304 of file gups_gen.cc.

References DPRINTF.

◆ recvTimingResp()

bool gem5::GUPSGen::GenPort::recvTimingResp ( PacketPtr  pkt)
overrideprotectedvirtual

Receive a timing response from the peer.

Implements gem5::TimingRequestProtocol.

Definition at line 321 of file gups_gen.cc.

◆ sendFunctionalPacket()

void gem5::GUPSGen::GenPort::sendFunctionalPacket ( PacketPtr  pkt)

This function send a functional request to the port's peer responsePort.

Parameters
pktPointer to the packet for the timing request

Definition at line 298 of file gups_gen.cc.

Referenced by gem5::GUPSGen::startup().

◆ sendTimingPacket()

void gem5::GUPSGen::GenPort::sendTimingPacket ( PacketPtr  pkt)

This function send a timing request to the port's peer responsePort.

Parameters
pktPointer to the packet for the timing request

Definition at line 283 of file gups_gen.cc.

References _blocked, blockedPacket, DPRINTF, panic_if, and gem5::RequestPort::sendTimingReq().

Referenced by gem5::GUPSGen::sendNextReq().

Member Data Documentation

◆ _blocked

bool gem5::GUPSGen::GenPort::_blocked
private

Boolean value to remember if the port is previously blocked and is occupied by a previous request, it should not accept new requests if it is blocked, instead, it will be freed by a recvReqRetry call from outside.

Definition at line 78 of file gups_gen.hh.

Referenced by blocked(), and sendTimingPacket().

◆ blockedPacket

PacketPtr gem5::GUPSGen::GenPort::blockedPacket
private

Pointer to the blocked packet in the port.

It is initialized as nullptr and will be set to the address of the packet which is blocked. It will reset upon recvReqRetry call.

Definition at line 85 of file gups_gen.hh.

Referenced by sendTimingPacket().

◆ owner

GUPSGen* gem5::GUPSGen::GenPort::owner
private

Pointer to the GUPSGen this port belongs to.

Definition at line 70 of file gups_gen.hh.


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

Generated on Wed May 4 2022 12:14:38 for gem5 by doxygen 1.8.17