gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
gem5::SimpleTimingPort Class Referenceabstract

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

#include <tport.hh>

Inheritance diagram for gem5::SimpleTimingPort:
gem5::QueuedResponsePort gem5::ResponsePort gem5::Port gem5::AtomicResponseProtocol gem5::TimingResponseProtocol gem5::FunctionalResponseProtocol gem5::PioPort< Device > gem5::SMMUControlPort gem5::X86ISA::IntResponsePort< Device > gem5::X86ISA::IntResponsePort< gem5::X86ISA::Interrupts > gem5::PioPort< gem5::PioDevice > gem5::PioPort< gem5::X86ISA::Interrupts >

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. More...
 
virtual ~SimpleTimingPort ()
 
- Public Member Functions inherited from gem5::QueuedResponsePort
 QueuedResponsePort (const std::string &name, SimObject *owner, RespPacketQueue &resp_queue, PortID id=InvalidPortID)
 Create a QueuedPort with a given name, owner, and a supplied implementation of a packet queue. More...
 
virtual ~QueuedResponsePort ()
 
void schedTimingResp (PacketPtr pkt, Tick when)
 Schedule the sending of a timing response. More...
 
bool trySatisfyFunctional (PacketPtr pkt)
 Check the list of buffered packets against the supplied functional request. 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...
 
virtual AddrRangeList getAddrRanges () const =0
 Get a list of the non-overlapping address ranges the owner is responsible for. 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

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

Protected Attributes

std::unique_ptr< PacketpendingDelete
 Upstream caches need this packet until true is returned, so hold it for deletion until a subsequent call. More...
 
- Protected Attributes inherited from gem5::QueuedResponsePort
RespPacketQueuerespQueue
 Packet queue used to store outgoing responses. 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...
 

Private Attributes

RespPacketQueue queueImpl
 The packet queue used to store outgoing responses. More...
 

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
nameport name
ownerstructural 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

◆ recvFunctional()

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

◆ recvTimingReq()

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

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:

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