gem5  v20.0.0.2
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Bridge::BridgeMasterPort Class Reference

Port on the side that forwards requests and receives responses. More...

#include <bridge.hh>

Inheritance diagram for Bridge::BridgeMasterPort:
MasterPort Port AtomicRequestProtocol TimingRequestProtocol FunctionalRequestProtocol

Public Member Functions

 BridgeMasterPort (const std::string &_name, Bridge &_bridge, BridgeSlavePort &_slavePort, Cycles _delay, int _req_limit)
 Constructor for the BridgeMasterPort. More...
 
bool reqQueueFull () const
 Is this side blocked from accepting new request packets. More...
 
void schedTimingReq (PacketPtr pkt, Tick when)
 Queue a request packet to be sent out later and also schedule a send if necessary. More...
 
bool trySatisfyFunctional (PacketPtr pkt)
 Check a functional request against the packets in our request queue. More...
 
- Public Member Functions inherited from MasterPort
 MasterPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
 Master port. More...
 
virtual ~MasterPort ()
 
void bind (Port &peer) override
 Bind this master port to a slave port. More...
 
void unbind () override
 Unbind this master port and the associated slave port. More...
 
virtual bool isSnooping () const
 Determine if this master port is snooping or not. More...
 
AddrRangeList getAddrRanges () const
 Get the address ranges of the connected slave 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 slave port by calling its corresponding receive function. More...
 
bool tryTiming (PacketPtr pkt) const
 Check if the slave can handle a timing request. More...
 
bool sendTimingSnoopResp (PacketPtr pkt)
 Attempt to send a timing snoop response packet to the slave port by calling its corresponding receive function. More...
 
virtual void sendRetryResp ()
 Send a retry to the slave port that previously attempted a sendTimingResp to this master port and failed. More...
 
- Public Member Functions inherited from 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)
 When receiving a timing request from the peer port, pass it to the bridge. More...
 
void recvReqRetry ()
 When receiving a retry request from the peer port, pass it to the bridge. More...
 
- Protected Member Functions inherited from MasterPort
virtual void recvRangeChange ()
 Called to receive an address range change from the peer slave 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 Port
 Port (const std::string &_name, PortID _id)
 Abstract base class for ports. More...
 
- Protected Member Functions inherited from 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 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 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 Member Functions

void trySendTiming ()
 Handle send event, scheduled when the packet at the head of the outbound queue is ready to transmit (for timing accesses only). More...
 

Private Attributes

Bridgebridge
 The bridge to which this port belongs. More...
 
BridgeSlavePortslavePort
 The slave port on the other side of the bridge. More...
 
const Cycles delay
 Minimum delay though this bridge. More...
 
std::deque< DeferredPackettransmitList
 Request packet queue. More...
 
const unsigned int reqQueueLimit
 Max queue size for request packets. More...
 
EventFunctionWrapper sendEvent
 Send event for the request queue. More...
 

Additional Inherited Members

- Protected Attributes inherited from MasterPort
SimObjectowner
 
- Protected Attributes inherited from 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 side that forwards requests and receives responses.

The master port has a buffer for the requests not yet sent.

Definition at line 219 of file bridge.hh.

Constructor & Destructor Documentation

◆ BridgeMasterPort()

Bridge::BridgeMasterPort::BridgeMasterPort ( const std::string &  _name,
Bridge _bridge,
BridgeSlavePort _slavePort,
Cycles  _delay,
int  _req_limit 
)

Constructor for the BridgeMasterPort.

Parameters
_namethe port name including the owner
_bridgethe structural owner
_slavePortthe slave port on the other side of the bridge
_delaythe delay in cycles from receiving to sending
_req_limitthe size of the request queue

Definition at line 65 of file bridge.cc.

References trySendTiming().

Member Function Documentation

◆ recvReqRetry()

void Bridge::BridgeMasterPort::recvReqRetry ( )
protectedvirtual

When receiving a retry request from the peer port, pass it to the bridge.

Implements TimingRequestProtocol.

Definition at line 325 of file bridge.cc.

◆ recvTimingResp()

bool Bridge::BridgeMasterPort::recvTimingResp ( PacketPtr  pkt)
protectedvirtual

When receiving a timing request from the peer port, pass it to the bridge.

Implements TimingRequestProtocol.

Definition at line 120 of file bridge.cc.

References Packet::cmdString(), DPRINTF, Packet::getAddr(), Packet::headerDelay, Packet::payloadDelay, Bridge::BridgeSlavePort::schedTimingResp(), and Bridge::slavePort.

◆ reqQueueFull()

bool Bridge::BridgeMasterPort::reqQueueFull ( ) const

Is this side blocked from accepting new request packets.

Returns
true if the occupied space has reached the set limit

Definition at line 114 of file bridge.cc.

Referenced by Bridge::BridgeSlavePort::recvTimingReq(), and Bridge::BridgeSlavePort::trySendTiming().

◆ schedTimingReq()

void Bridge::BridgeMasterPort::schedTimingReq ( PacketPtr  pkt,
Tick  when 
)

Queue a request packet to be sent out later and also schedule a send if necessary.

Parameters
pkta request to send out after a delay
whentick when response packet should be sent

Definition at line 212 of file bridge.cc.

References ArmISA::sendEvent().

Referenced by Bridge::BridgeSlavePort::recvTimingReq().

◆ trySatisfyFunctional()

bool Bridge::BridgeMasterPort::trySatisfyFunctional ( PacketPtr  pkt)

Check a functional request against the packets in our request queue.

Parameters
pktpacket to check against
Returns
true if we find a match

Definition at line 370 of file bridge.cc.

References ArmISA::i, Packet::makeResponse(), and Packet::trySatisfyFunctional().

Referenced by Bridge::BridgeSlavePort::recvFunctional().

◆ trySendTiming()

void Bridge::BridgeMasterPort::trySendTiming ( )
private

Handle send event, scheduled when the packet at the head of the outbound queue is ready to transmit (for timing accesses only).

Definition at line 243 of file bridge.cc.

References curTick(), DPRINTF, Packet::getAddr(), Bridge::BridgeSlavePort::retryStalledReq(), ArmISA::sendEvent(), Bridge::slavePort, and Bridge::DeferredPacket::tick.

Referenced by BridgeMasterPort().

Member Data Documentation

◆ bridge

Bridge& Bridge::BridgeMasterPort::bridge
private

The bridge to which this port belongs.

Definition at line 225 of file bridge.hh.

◆ delay

const Cycles Bridge::BridgeMasterPort::delay
private

Minimum delay though this bridge.

Definition at line 233 of file bridge.hh.

◆ reqQueueLimit

const unsigned int Bridge::BridgeMasterPort::reqQueueLimit
private

Max queue size for request packets.

Definition at line 244 of file bridge.hh.

◆ sendEvent

EventFunctionWrapper Bridge::BridgeMasterPort::sendEvent
private

Send event for the request queue.

Definition at line 254 of file bridge.hh.

◆ slavePort

BridgeSlavePort& Bridge::BridgeMasterPort::slavePort
private

The slave port on the other side of the bridge.

Definition at line 230 of file bridge.hh.

◆ transmitList

std::deque<DeferredPacket> Bridge::BridgeMasterPort::transmitList
private

Request packet queue.

Request packets are held in this queue for a specified delay to model the processing delay of the bridge. We use a deque as we need to iterate over the items for functional accesses.

Definition at line 241 of file bridge.hh.


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

Generated on Mon Jun 8 2020 15:45:20 for gem5 by doxygen 1.8.13