gem5  v21.1.0.2
base_gen.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012-2013, 2017-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 here under. 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 
43 #ifndef __CPU_TRAFFIC_GEN_BASE_GEN_HH__
44 #define __CPU_TRAFFIC_GEN_BASE_GEN_HH__
45 
46 #include <cstdint>
47 #include <string>
48 
49 #include "base/types.hh"
50 #include "mem/packet.hh"
51 #include "mem/request.hh"
52 
53 namespace gem5
54 {
55 
56 class BaseTrafficGen;
57 class SimObject;
58 
64 class BaseGen
65 {
66 
67  protected:
68 
70  const std::string _name;
71 
74 
83  PacketPtr getPacket(Addr addr, unsigned size, const MemCmd& cmd,
84  Request::FlagsType flags = 0);
85 
86  public:
87 
89  const Tick duration;
90 
98  BaseGen(SimObject &obj, RequestorID requestor_id, Tick _duration);
99 
100  virtual ~BaseGen() { }
101 
107  std::string name() const { return _name; }
108 
112  virtual void enter() = 0;
113 
119  virtual PacketPtr getNextPacket() = 0;
120 
124  virtual void exit() { };
125 
135  virtual Tick nextPacketTick(bool elastic, Tick delay) const = 0;
136 
137 };
138 
139 class StochasticGen : public BaseGen
140 {
141  public:
143  RequestorID requestor_id, Tick _duration,
144  Addr start_addr, Addr end_addr,
145  Addr _blocksize, Addr cacheline_size,
146  Tick min_period, Tick max_period,
147  uint8_t read_percent, Addr data_limit);
148 
149  protected:
152 
154  const Addr endAddr;
155 
158 
161 
165 
169  const uint8_t readPercent;
170 
173 };
174 
175 } // namespace gem5
176 
177 #endif
gem5::StochasticGen::minPeriod
const Tick minPeriod
Request generation period.
Definition: base_gen.hh:163
gem5::BaseGen::getNextPacket
virtual PacketPtr getNextPacket()=0
Get the next generated packet.
gem5::StochasticGen::blocksize
const Addr blocksize
Blocksize and address increment.
Definition: base_gen.hh:157
gem5::BaseGen::name
std::string name() const
Get the name, useful for DPRINTFs.
Definition: base_gen.hh:107
gem5::BaseGen::_name
const std::string _name
Name to use for status and debug printing.
Definition: base_gen.hh:70
gem5::StochasticGen::StochasticGen
StochasticGen(SimObject &obj, RequestorID requestor_id, Tick _duration, Addr start_addr, Addr end_addr, Addr _blocksize, Addr cacheline_size, Tick min_period, Tick max_period, uint8_t read_percent, Addr data_limit)
Definition: base_gen.cc:78
gem5::BaseGen::nextPacketTick
virtual Tick nextPacketTick(bool elastic, Tick delay) const =0
Determine the tick when the next packet is available.
gem5::Request::FlagsType
uint64_t FlagsType
Definition: request.hh:100
request.hh
gem5::BaseGen::getPacket
PacketPtr getPacket(Addr addr, unsigned size, const MemCmd &cmd, Request::FlagsType flags=0)
Generate a new request and associated packet.
Definition: base_gen.cc:55
packet.hh
gem5::MemCmd
Definition: packet.hh:75
gem5::StochasticGen
Definition: base_gen.hh:139
gem5::BaseGen::~BaseGen
virtual ~BaseGen()
Definition: base_gen.hh:100
gem5::StochasticGen::startAddr
const Addr startAddr
Start of address range.
Definition: base_gen.hh:151
gem5::StochasticGen::dataLimit
const Addr dataLimit
Maximum amount of data to manipulate.
Definition: base_gen.hh:172
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::StochasticGen::endAddr
const Addr endAddr
End of address range.
Definition: base_gen.hh:154
gem5::StochasticGen::maxPeriod
const Tick maxPeriod
Definition: base_gen.hh:164
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::BaseGen::exit
virtual void exit()
Exit this generator state.
Definition: base_gen.hh:124
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::BaseGen
Base class for all generators, with the shared functionality and virtual functions for entering,...
Definition: base_gen.hh:64
gem5::BaseGen::enter
virtual void enter()=0
Enter this generator state.
types.hh
gem5::StochasticGen::readPercent
const uint8_t readPercent
Percent of generated transactions that should be reads.
Definition: base_gen.hh:169
gem5::StochasticGen::cacheLineSize
const Addr cacheLineSize
Cache line size in the simulated system.
Definition: base_gen.hh:160
gem5::BaseGen::requestorId
const RequestorID requestorId
The RequestorID used for generating requests.
Definition: base_gen.hh:73
gem5::RequestorID
uint16_t RequestorID
Definition: request.hh:95
gem5::BaseGen::duration
const Tick duration
Time to spend in this state.
Definition: base_gen.hh:89
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::BaseGen::BaseGen
BaseGen(SimObject &obj, RequestorID requestor_id, Tick _duration)
Create a base generator.
Definition: base_gen.cc:48
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84

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