gem5  v20.1.0.0
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  * Author: Giacomo Travaglini
38  */
39 
40 #ifndef __MEM_QOS_POLICY_PF_HH__
41 #define __MEM_QOS_POLICY_PF_HH__
42 
43 #include "mem/qos/policy.hh"
44 #include "params/QoSPropFairPolicy.hh"
45 
46 namespace QoS {
47 
59 class PropFairPolicy : public Policy
60 {
61  using Params = QoSPropFairPolicyParams;
62  const Params *params() const
63  { return static_cast<const Params *>(_params); }
64 
65  public:
66  PropFairPolicy(const Params*);
67  virtual ~PropFairPolicy();
68 
77  void initRequestorName(const std::string requestor, const double score);
78 
87  void initRequestorObj(const SimObject* requestor, const double score);
88 
96  virtual uint8_t
97  schedule(const RequestorID id, const uint64_t pkt_size) override;
98 
99  protected:
100  template <typename Requestor>
101  void initRequestor(const Requestor requestor, const double score);
102 
103  inline double
104  updateScore(const double old_score, const uint64_t served_bytes) const;
105 
106  protected:
108  const double weight;
109 
113 };
114 
115 } // namespace QoS
116 
117 #endif // __MEM_QOS_POLICY_PF_HH__
QoS
Definition: mem_ctrl.cc:42
QoS::PropFairPolicy::initRequestor
void initRequestor(const Requestor requestor, const double score)
Definition: policy_pf.cc:58
QoS::PropFairPolicy::history
std::vector< RequestorHistory > history
Definition: policy_pf.hh:112
QoS::PropFairPolicy::~PropFairPolicy
virtual ~PropFairPolicy()
Definition: policy_pf.cc:53
std::vector
STL vector class.
Definition: stl.hh:37
QoS::PropFairPolicy::weight
const double weight
PF Policy weight.
Definition: policy_pf.hh:108
QoS::PropFairPolicy::updateScore
double updateScore(const double old_score, const uint64_t served_bytes) const
Definition: policy_pf.cc:85
QoS::PropFairPolicy
Proportional Fair QoS Policy Providing a configurable fair scheduling policy based on utilization; ut...
Definition: policy_pf.hh:59
RequestorID
uint16_t RequestorID
Definition: request.hh:85
QoS::PropFairPolicy::PropFairPolicy
PropFairPolicy(const Params *)
Definition: policy_pf.cc:46
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:92
policy.hh
std::pair
STL pair class.
Definition: stl.hh:58
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:79
SimObject::_params
const SimObjectParams * _params
Cached copy of the object parameters.
Definition: sim_object.hh:110
QoS::Policy
QoS Policy base class.
Definition: policy.hh:58
QoS::Policy::Params
QoSPolicyParams Params
Definition: policy.hh:61
QoS::PropFairPolicy::Params
QoSPropFairPolicyParams Params
Definition: policy_pf.hh:61
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:73
QoS::PropFairPolicy::params
const Params * params() const
Definition: policy_pf.hh:62
SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:92

Generated on Wed Sep 30 2020 14:02:13 for gem5 by doxygen 1.8.17