gem5  v22.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 
38 #ifndef __MEM_QOS_POLICY_FIXED_PRIO_HH__
39 #define __MEM_QOS_POLICY_FIXED_PRIO_HH__
40 
41 #include <cstdint>
42 #include <map>
43 
44 #include "base/compiler.hh"
45 #include "mem/qos/policy.hh"
46 
47 namespace gem5
48 {
49 
50 struct QoSFixedPriorityPolicyParams;
51 
52 namespace memory
53 {
54 
56 namespace qos
57 {
58 
66 {
67  using Params = QoSFixedPriorityPolicyParams;
68 
69  public:
70  FixedPriorityPolicy(const Params &);
71  virtual ~FixedPriorityPolicy();
72 
73  void init() override;
74 
83  void initRequestorName(std::string requestor, uint8_t priority);
84 
92  void initRequestorObj(const SimObject* requestor, uint8_t priority);
93 
101  virtual uint8_t schedule(const RequestorID, const uint64_t) override;
102 
103  protected:
105  const uint8_t defaultPriority;
106 
111  std::map<RequestorID, uint8_t> priorityMap;
112 };
113 
114 } // namespace qos
115 } // namespace memory
116 } // namespace gem5
117 
118 #endif // __MEM_QOS_POLICY_FIXED_PRIO_HH__
Abstract superclass for simulation objects.
Definition: sim_object.hh:148
void initRequestorObj(const SimObject *requestor, uint8_t priority)
Initialize the fixed requestor's priority by providing the requestor's SimObject pointer and priority...
const uint8_t defaultPriority
Default fixed priority value for non-listed requestors.
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
std::map< RequestorID, uint8_t > priorityMap
Priority map, associates configured requestors with a fixed QoS priority value.
virtual uint8_t schedule(const RequestorID, const uint64_t) override
Schedules a packet based on fixed priority configuration.
void initRequestorName(std::string requestor, uint8_t priority)
Initialize the fixed requestor's priority by providing the requestor's name and priority value.
QoS Policy base class.
Definition: policy.hh:72
QoSPolicyParams Params
Definition: policy.hh:74
GEM5_DEPRECATED_NAMESPACE(QoS, qos)
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
uint16_t RequestorID
Definition: request.hh:95
Definition: mem.h:38

Generated on Wed Dec 21 2022 10:22:37 for gem5 by doxygen 1.9.1