gem5  v20.1.0.0
policy_fixed_prio.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: Matteo Andreozzi
38  */
39 
40 #ifndef __MEM_QOS_POLICY_FIXED_PRIO_HH__
41 #define __MEM_QOS_POLICY_FIXED_PRIO_HH__
42 
43 #include "mem/qos/policy.hh"
44 #include "params/QoSFixedPriorityPolicy.hh"
45 
46 namespace QoS {
47 
55 {
56  using Params = QoSFixedPriorityPolicyParams;
57 
58  public:
60  virtual ~FixedPriorityPolicy();
61 
62  void init() override;
63 
72  void initRequestorName(std::string requestor, uint8_t priority);
73 
81  void initRequestorObj(const SimObject* requestor, uint8_t priority);
82 
90  virtual uint8_t schedule(const RequestorID, const uint64_t) override;
91 
92  protected:
94  const uint8_t defaultPriority;
95 
100  std::map<RequestorID, uint8_t> priorityMap;
101 };
102 
103 } // namespace QoS
104 
105 #endif // __MEM_QOS_POLICY_FIXED_PRIO_HH__
QoS
Definition: mem_ctrl.cc:42
QoS::FixedPriorityPolicy::initRequestorObj
void initRequestorObj(const SimObject *requestor, uint8_t priority)
Initialize the fixed requestor's priority by providing the requestor's SimObject pointer and priority...
Definition: policy_fixed_prio.cc:69
QoS::FixedPriorityPolicy
Fixed Priority QoS Policy.
Definition: policy_fixed_prio.hh:54
QoS::FixedPriorityPolicy::defaultPriority
const uint8_t defaultPriority
Default fixed priority value for non-listed requestors.
Definition: policy_fixed_prio.hh:94
RequestorID
uint16_t RequestorID
Definition: request.hh:85
QoS::FixedPriorityPolicy::FixedPriorityPolicy
FixedPriorityPolicy(const Params *)
Definition: policy_fixed_prio.cc:49
QoS::FixedPriorityPolicy::schedule
virtual uint8_t schedule(const RequestorID, const uint64_t) override
Schedules a packet based on fixed priority configuration.
Definition: policy_fixed_prio.cc:77
policy.hh
QoS::FixedPriorityPolicy::~FixedPriorityPolicy
virtual ~FixedPriorityPolicy()
Definition: policy_fixed_prio.cc:53
QoS::FixedPriorityPolicy::initRequestorName
void initRequestorName(std::string requestor, uint8_t priority)
Initialize the fixed requestor's priority by providing the requestor's name and priority value.
Definition: policy_fixed_prio.cc:62
QoS::FixedPriorityPolicy::priorityMap
std::map< RequestorID, uint8_t > priorityMap
Priority map, associates configured requestors with a fixed QoS priority value.
Definition: policy_fixed_prio.hh:100
QoS::Policy
QoS Policy base class.
Definition: policy.hh:58
QoS::Policy::Params
QoSPolicyParams Params
Definition: policy.hh:61
QoS::FixedPriorityPolicy::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: policy_fixed_prio.cc:57
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