gem5  v21.1.0.2
mem_delay.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __MEM_MEM_DELAY_HH__
39 #define __MEM_MEM_DELAY_HH__
40 
41 #include "mem/qport.hh"
42 #include "sim/clocked_object.hh"
43 
44 namespace gem5
45 {
46 
47 struct MemDelayParams;
48 struct SimpleMemDelayParams;
49 
65 class MemDelay : public ClockedObject
66 {
67 
68  public:
69  MemDelay(const MemDelayParams &params);
70 
71  void init() override;
72 
73  protected: // Port interface
74  Port &getPort(const std::string &if_name,
75  PortID idx=InvalidPortID) override;
76 
78  {
79  public:
80  RequestPort(const std::string &_name, MemDelay &_parent);
81 
82  protected:
83  bool recvTimingResp(PacketPtr pkt) override;
84 
85  void recvFunctionalSnoop(PacketPtr pkt) override;
86 
87  Tick recvAtomicSnoop(PacketPtr pkt) override;
88 
89  void recvTimingSnoopReq(PacketPtr pkt) override;
90 
91  void recvRangeChange() override {
93  }
94 
95  bool isSnooping() const override {
97  }
98 
99  private:
101  };
102 
104  {
105  public:
106  ResponsePort(const std::string &_name, MemDelay &_parent);
107 
108  protected:
109  Tick recvAtomic(PacketPtr pkt) override;
110  bool recvTimingReq(PacketPtr pkt) override;
111  void recvFunctional(PacketPtr pkt) override;
112  bool recvTimingSnoopResp(PacketPtr pkt) override;
113 
114  AddrRangeList getAddrRanges() const override {
116  }
117 
118  bool tryTiming(PacketPtr pkt) override { return true; }
119 
120  private:
121 
123 
124  };
125 
127 
130 
134 
135  protected:
141  virtual Tick delayReq(PacketPtr pkt) { return 0; }
142 
148  virtual Tick delayResp(PacketPtr pkt) { return 0; }
149 
155  virtual Tick delaySnoopResp(PacketPtr pkt) { return 0; }
156 };
157 
166 class SimpleMemDelay : public MemDelay
167 {
168  public:
169  SimpleMemDelay(const SimpleMemDelayParams &params);
170 
171  protected:
172  Tick delayReq(PacketPtr pkt) override;
173  Tick delayResp(PacketPtr pkt) override;
174 
175  protected: // Params
178 
181 };
182 
183 } // namespace gem5
184 
185 #endif //__MEM_MEM_DELAY_HH__
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::MemDelay::ResponsePort::recvTimingSnoopResp
bool recvTimingSnoopResp(PacketPtr pkt) override
Receive a timing snoop response from the peer.
Definition: mem_delay.cc:172
gem5::MemDelay::RequestPort::recvRangeChange
void recvRangeChange() override
Called to receive an address range change from the peer response port.
Definition: mem_delay.hh:91
gem5::MemDelay::RequestPort::recvFunctionalSnoop
void recvFunctionalSnoop(PacketPtr pkt) override
Receive a functional snoop request packet from the peer.
Definition: mem_delay.cc:106
gem5::MemDelay::reqQueue
ReqPacketQueue reqQueue
Definition: mem_delay.hh:131
gem5::RespPacketQueue
Definition: packet_queue.hh:300
gem5::MemDelay::requestPort
RequestPort requestPort
Definition: mem_delay.hh:128
gem5::QueuedRequestPort
The QueuedRequestPort combines two queues, a request queue and a snoop response queue,...
Definition: qport.hh:109
gem5::MemDelay::responsePort
ResponsePort responsePort
Definition: mem_delay.hh:129
gem5::SimpleMemDelay::readRespDelay
const Tick readRespDelay
Definition: mem_delay.hh:177
gem5::MemDelay::ResponsePort::ResponsePort
ResponsePort(const std::string &_name, MemDelay &_parent)
Definition: mem_delay.cc:131
gem5::MemDelay::ResponsePort::parent
MemDelay & parent
Definition: mem_delay.hh:122
gem5::MemDelay::respQueue
RespPacketQueue respQueue
Definition: mem_delay.hh:132
gem5::MemDelay::RequestPort::parent
MemDelay & parent
Definition: mem_delay.hh:100
gem5::MemDelay::ResponsePort::tryTiming
bool tryTiming(PacketPtr pkt) override
Availability request from the peer.
Definition: mem_delay.hh:118
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::SimpleMemDelay::readReqDelay
const Tick readReqDelay
Definition: mem_delay.hh:176
gem5::MemDelay::RequestPort::isSnooping
bool isSnooping() const override
Determine if this request port is snooping or not.
Definition: mem_delay.hh:95
gem5::MemDelay
This abstract component provides a mechanism to delay packets.
Definition: mem_delay.hh:65
gem5::MemDelay::RequestPort::recvAtomicSnoop
Tick recvAtomicSnoop(PacketPtr pkt) override
Receive an atomic snoop request packet from our peer.
Definition: mem_delay.cc:116
gem5::MemDelay::RequestPort::recvTimingResp
bool recvTimingResp(PacketPtr pkt) override
Receive a timing response from the peer.
Definition: mem_delay.cc:91
gem5::SimObject::params
const Params & params() const
Definition: sim_object.hh:176
gem5::QueuedResponsePort
A queued port is a port that has an infinite queue for outgoing packets and thus decouples the module...
Definition: qport.hh:61
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::ResponsePort::isSnooping
bool isSnooping() const
Find out if the peer request port is snooping or not.
Definition: port.hh:291
gem5::SimpleMemDelay::SimpleMemDelay
SimpleMemDelay(const SimpleMemDelayParams &params)
Definition: mem_delay.cc:183
gem5::MemDelay::ResponsePort
Definition: mem_delay.hh:103
gem5::RequestPort::getAddrRanges
AddrRangeList getAddrRanges() const
Get the address ranges of the connected responder port.
Definition: port.cc:151
gem5::SimpleMemDelay::writeReqDelay
const Tick writeReqDelay
Definition: mem_delay.hh:179
gem5::ClockedObject
The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to ...
Definition: clocked_object.hh:234
gem5::ResponsePort::sendRangeChange
void sendRangeChange() const
Called by the owner to send a range change.
Definition: port.hh:296
gem5::MemDelay::RequestPort
Definition: mem_delay.hh:77
gem5::MemDelay::trySatisfyFunctional
bool trySatisfyFunctional(PacketPtr pkt)
Definition: mem_delay.cc:77
gem5::MemDelay::delayResp
virtual Tick delayResp(PacketPtr pkt)
Delay a response by some number of ticks.
Definition: mem_delay.hh:148
gem5::MemDelay::snoopRespQueue
SnoopRespPacketQueue snoopRespQueue
Definition: mem_delay.hh:133
gem5::MemDelay::getPort
Port & getPort(const std::string &if_name, PortID idx=InvalidPortID) override
Get a port with a given name and index.
Definition: mem_delay.cc:65
gem5::SimpleMemDelay::writeRespDelay
const Tick writeRespDelay
Definition: mem_delay.hh:180
gem5::SimpleMemDelay::delayResp
Tick delayResp(PacketPtr pkt) override
Delay a response by some number of ticks.
Definition: mem_delay.cc:205
gem5::MemDelay::ResponsePort::recvTimingReq
bool recvTimingReq(PacketPtr pkt) override
Receive a timing request from the peer.
Definition: mem_delay.cc:146
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
qport.hh
gem5::MemDelay::delaySnoopResp
virtual Tick delaySnoopResp(PacketPtr pkt)
Delay a snoop response by some number of ticks.
Definition: mem_delay.hh:155
gem5::SimpleMemDelay
Delay packets by a constant time.
Definition: mem_delay.hh:166
clocked_object.hh
gem5::MemDelay::ResponsePort::recvFunctional
void recvFunctional(PacketPtr pkt) override
Receive a functional request packet from the peer.
Definition: mem_delay.cc:162
gem5::MemDelay::ResponsePort::getAddrRanges
AddrRangeList getAddrRanges() const override
Get a list of the non-overlapping address ranges the owner is responsible for.
Definition: mem_delay.hh:114
gem5::ReqPacketQueue
Definition: packet_queue.hh:226
gem5::SimpleMemDelay::delayReq
Tick delayReq(PacketPtr pkt) override
Delay a request by some number of ticks.
Definition: mem_delay.cc:193
gem5::MemDelay::RequestPort::RequestPort
RequestPort(const std::string &_name, MemDelay &_parent)
Definition: mem_delay.cc:83
std::list< AddrRange >
gem5::SnoopRespPacketQueue
Definition: packet_queue.hh:262
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::MemDelay::RequestPort::recvTimingSnoopReq
void recvTimingSnoopReq(PacketPtr pkt) override
Receive a timing snoop request from the peer.
Definition: mem_delay.cc:124
gem5::MemDelay::MemDelay
MemDelay(const MemDelayParams &params)
Definition: mem_delay.cc:46
gem5::MemDelay::delayReq
virtual Tick delayReq(PacketPtr pkt)
Delay a request by some number of ticks.
Definition: mem_delay.hh:141
gem5::Named::_name
const std::string _name
Definition: named.hh:41
gem5::MemDelay::ResponsePort::recvAtomic
Tick recvAtomic(PacketPtr pkt) override
Receive an atomic request packet from the peer.
Definition: mem_delay.cc:138
gem5::MemDelay::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: mem_delay.cc:57

Generated on Tue Sep 21 2021 12:25:32 for gem5 by doxygen 1.8.17