#include <token_port.hh>
Inheritance diagram for TokenRequestPort:
Public Member Functions | |
| TokenRequestPort (const std::string &name, SimObject *owner, PortID id=InvalidPortID) | |
| void | bind (Port &peer) override |
| Bind this request port to response port. More... | |
| void | unbind () override |
| Unbind port. More... | |
| void | recvTokens (int num_tokens) |
| Receive tokens returned by the response port. More... | |
| bool | haveTokens (int num_tokens) |
| Query if there are at least num_tokens tokens available to acquire. More... | |
| void | acquireTokens (int num_tokens) |
| Acquire tokens by decrementing the number of available tokens across the port. More... | |
| void | setTokenManager (TokenManager *_tokenManager) |
| Specify a token manger, which will handle tracking of tokens for a TokenRequestPort/ResponseRequestPort pair. More... | |
 Public Member Functions inherited from RequestPort | |
| RequestPort (const std::string &name, SimObject *_owner, PortID id=InvalidPortID) | |
| Request port. More... | |
| virtual | ~RequestPort () |
| 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 Port | |
| virtual | ~Port () |
| Virtual destructor due to inheritance. More... | |
| Port & | getPeer () |
| 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 Attributes | |
| TokenManager * | tokenManager |
Additional Inherited Members | |
| Protected Member Functions inherited from 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 Port | |
| void | reportUnbound () const |
| 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... | |
| virtual bool | recvTimingResp (PacketPtr pkt)=0 |
| Receive a timing response from the peer. More... | |
| virtual void | recvReqRetry ()=0 |
| 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 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... | |
| Protected Attributes inherited from RequestPort | |
| SimObject & | owner |
| 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
Definition at line 43 of file token_port.hh.
Constructor & Destructor Documentation
◆ TokenRequestPort()
|
inline |
Definition at line 50 of file token_port.hh.
Member Function Documentation
◆ acquireTokens()
| void TokenRequestPort::acquireTokens | ( | int | num_tokens | ) |
Acquire tokens by decrementing the number of available tokens across the port.
This does the opposite of recvTokens.
Definition at line 65 of file token_port.cc.
References TokenManager::acquireTokens(), Port::name(), panic_if, and tokenManager.
◆ bind()
|
overridevirtual |
Bind this request port to response port.
Called by the response port in this token implementation.
Reimplemented from RequestPort.
Definition at line 43 of file token_port.cc.
References RequestPort::bind().
Referenced by TokenResponsePort::bind().
◆ haveTokens()
| bool TokenRequestPort::haveTokens | ( | int | num_tokens | ) |
Query if there are at least num_tokens tokens available to acquire.
Definition at line 57 of file token_port.cc.
References TokenManager::haveTokens(), Port::name(), panic_if, and tokenManager.
◆ recvTokens()
| void TokenRequestPort::recvTokens | ( | int | num_tokens | ) |
Receive tokens returned by the response port.
This increments the number or available tokens across the port.
Definition at line 49 of file token_port.cc.
References Port::name(), panic_if, TokenManager::recvTokens(), and tokenManager.
Referenced by TokenResponsePort::sendTokens().
◆ setTokenManager()
| void TokenRequestPort::setTokenManager | ( | TokenManager * | _tokenManager | ) |
Specify a token manger, which will handle tracking of tokens for a TokenRequestPort/ResponseRequestPort pair.
Definition at line 73 of file token_port.cc.
References tokenManager.
Referenced by ComputeUnit::init().
◆ unbind()
|
inlineoverridevirtual |
Unbind port.
Handled by response port in token implementation.
Reimplemented from RequestPort.
Definition at line 64 of file token_port.hh.
Member Data Documentation
◆ tokenManager
|
private |
Definition at line 47 of file token_port.hh.
Referenced by acquireTokens(), haveTokens(), recvTokens(), and setTokenManager().
The documentation for this class was generated from the following files:
- mem/token_port.hh
- mem/token_port.cc