gem5  v22.0.0.2
policy_pf.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_QOS_POLICY_PF_HH__
39 #define __MEM_QOS_POLICY_PF_HH__
40 
41 #include <vector>
42 
43 #include "base/compiler.hh"
44 #include "mem/qos/policy.hh"
45 #include "mem/request.hh"
46 
47 namespace gem5
48 {
49 
50 struct QoSPropFairPolicyParams;
51 
52 namespace memory
53 {
54 
56 namespace qos
57 {
58 
70 class PropFairPolicy : public Policy
71 {
72  using Params = QoSPropFairPolicyParams;
73 
74  public:
75  PropFairPolicy(const Params &);
76  virtual ~PropFairPolicy();
77 
86  void initRequestorName(const std::string requestor, const double score);
87 
96  void initRequestorObj(const SimObject* requestor, const double score);
97 
105  virtual uint8_t
106  schedule(const RequestorID id, const uint64_t pkt_size) override;
107 
108  protected:
109  template <typename Requestor>
110  void initRequestor(const Requestor requestor, const double score);
111 
112  inline double
113  updateScore(const double old_score, const uint64_t served_bytes) const;
114 
115  protected:
117  const double weight;
118 
122 };
123 
124 } // namespace qos
125 } // namespace memory
126 } // namespace gem5
127 
128 #endif // __MEM_QOS_POLICY_PF_HH__
gem5::memory::qos::Policy
QoS Policy base class.
Definition: policy.hh:71
memory
Definition: mem.h:38
gem5::memory::qos::PropFairPolicy::~PropFairPolicy
virtual ~PropFairPolicy()
Definition: policy_pf.cc:62
gem5::memory::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(QoS, qos)
std::vector
STL vector class.
Definition: stl.hh:37
request.hh
gem5::memory::qos::PropFairPolicy::weight
const double weight
PF Policy weight.
Definition: policy_pf.hh:117
gem5::memory::qos::PropFairPolicy
Proportional Fair QoS Policy Providing a configurable fair scheduling policy based on utilization; ut...
Definition: policy_pf.hh:70
gem5::memory::qos::PropFairPolicy::updateScore
double updateScore(const double old_score, const uint64_t served_bytes) const
Definition: policy_pf.cc:94
gem5::memory::qos::PropFairPolicy::schedule
virtual uint8_t schedule(const RequestorID id, const uint64_t pkt_size) override
Schedules a packet based on proportional fair configuration.
Definition: policy_pf.cc:101
gem5::memory::qos::Policy::Params
QoSPolicyParams Params
Definition: policy.hh:74
compiler.hh
policy.hh
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
std::pair
STL pair class.
Definition: stl.hh:58
gem5::memory::qos::PropFairPolicy::initRequestor
void initRequestor(const Requestor requestor, const double score)
Definition: policy_pf.cc:67
gem5::memory::qos::PropFairPolicy::initRequestorName
void initRequestorName(const std::string requestor, const double score)
Initialize the requestor's score by providing the requestor's name and initial score value.
Definition: policy_pf.cc:82
gem5::memory::qos::PropFairPolicy::PropFairPolicy
PropFairPolicy(const Params &)
Definition: policy_pf.cc:55
gem5::RequestorID
uint16_t RequestorID
Definition: request.hh:95
gem5::memory::qos::PropFairPolicy::initRequestorObj
void initRequestorObj(const SimObject *requestor, const double score)
Initialize the requestor's score by providing the requestor's SimObject pointer and initial score val...
Definition: policy_pf.cc:88
gem5::memory::qos::PropFairPolicy::history
std::vector< RequestorHistory > history
Definition: policy_pf.hh:121
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: gpu_translation_state.hh:37

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