gem5  v22.0.0.2
stream_gen.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 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 
44 #ifndef __CPU_TRAFFIC_GEN_STREAM_GEN_HH__
45 #define __CPU_TRAFFIC_GEN_STREAM_GEN_HH__
46 
47 #include "params/BaseTrafficGen.hh"
48 
49 namespace gem5
50 {
51 
52 class StreamGen
53 {
54  protected:
55  StreamGen(const BaseTrafficGenParams &p)
56  : streamIds(p.sids), substreamIds(p.ssids)
57  {
58  // A non empty vector of StreamIDs must be provided.
59  // SubstreamIDs are not mandatory hence having an empty
60  // vector means that they are not used and no configuration
61  // error must be thrown
62  fatal_if(streamIds.empty(),
63  "Must provide a vector of StreamIDs");
64  }
65 
66  public:
67  virtual ~StreamGen() {};
68 
69  virtual uint32_t pickStreamID() = 0;
70  virtual uint32_t pickSubstreamID() = 0;
71 
81  static StreamGen* create(const BaseTrafficGenParams &p);
82 
91  bool ssidValid() const { return !substreamIds.empty(); }
92 
93  protected:
103 };
104 
105 class FixedStreamGen : public StreamGen
106 {
107  public:
108  FixedStreamGen(const BaseTrafficGenParams &p)
109  : StreamGen(p)
110  {
111  // For a fixed stream generator only one sid must be provided. The
112  // ssid can have either 0 (not used) or 1 value.
113  fatal_if(streamIds.size() != 1 || substreamIds.size() > 1,
114  "Invalid sids/ssids configuration");
115  }
116 
117  uint32_t pickStreamID() override
118  { return streamIds[0]; }
119 
120  uint32_t pickSubstreamID() override
121  { return substreamIds[0]; }
122 };
123 
125 {
126  public:
127  RandomStreamGen(const BaseTrafficGenParams &p)
128  : StreamGen(p)
129  {}
130 
131  uint32_t pickStreamID() override
132  { return randomPick(streamIds); }
133 
134  uint32_t pickSubstreamID() override
135  { return randomPick(substreamIds); }
136 
137  protected:
139  uint32_t randomPick(const std::vector<uint32_t> &svec);
140 };
141 
142 } // namespace gem5
143 
144 #endif // __CPU_TRAFFIC_GEN_STREAM_GEN_HH__
gem5::FixedStreamGen
Definition: stream_gen.hh:105
gem5::StreamGen::StreamGen
StreamGen(const BaseTrafficGenParams &p)
Definition: stream_gen.hh:55
gem5::RandomStreamGen::RandomStreamGen
RandomStreamGen(const BaseTrafficGenParams &p)
Definition: stream_gen.hh:127
gem5::FixedStreamGen::pickSubstreamID
uint32_t pickSubstreamID() override
Definition: stream_gen.hh:120
gem5::FixedStreamGen::pickStreamID
uint32_t pickStreamID() override
Definition: stream_gen.hh:117
gem5::FixedStreamGen::FixedStreamGen
FixedStreamGen(const BaseTrafficGenParams &p)
Definition: stream_gen.hh:108
gem5::RandomStreamGen
Definition: stream_gen.hh:124
std::vector< uint32_t >
gem5::RandomStreamGen::pickStreamID
uint32_t pickStreamID() override
Definition: stream_gen.hh:131
gem5::VegaISA::p
Bitfield< 54 > p
Definition: pagetable.hh:70
gem5::StreamGen::ssidValid
bool ssidValid() const
Returns true if the substreamID generation is valid and hence should be taken into account.
Definition: stream_gen.hh:91
gem5::StreamGen::pickStreamID
virtual uint32_t pickStreamID()=0
gem5::StreamGen::~StreamGen
virtual ~StreamGen()
Definition: stream_gen.hh:67
gem5::StreamGen
Definition: stream_gen.hh:52
gem5::StreamGen::substreamIds
std::vector< uint32_t > substreamIds
Definition: stream_gen.hh:102
gem5::RandomStreamGen::randomPick
uint32_t randomPick(const std::vector< uint32_t > &svec)
Function to pick one of the preset Stream or Substream ID.
Definition: stream_gen.cc:60
gem5::StreamGen::create
static StreamGen * create(const BaseTrafficGenParams &p)
Factory method for constructing a Stream generator.
Definition: stream_gen.cc:46
gem5::StreamGen::pickSubstreamID
virtual uint32_t pickSubstreamID()=0
gem5::RandomStreamGen::pickSubstreamID
uint32_t pickSubstreamID() override
Definition: stream_gen.hh:134
fatal_if
#define fatal_if(cond,...)
Conditional fatal macro that checks the supplied condition and only causes a fatal error if the condi...
Definition: logging.hh:226
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37
gem5::StreamGen::streamIds
std::vector< uint32_t > streamIds
Store preset Stream and Substream IDs to use for requests This is the set of available streamIDs the ...
Definition: stream_gen.hh:101

Generated on Thu Jul 28 2022 13:32:29 for gem5 by doxygen 1.8.17