gem5  v21.1.0.2
policy.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_HH__
39 #define __MEM_QOS_POLICY_HH__
40 
41 #include <cstdint>
42 #include <utility>
43 
44 #include "base/compiler.hh"
45 #include "base/logging.hh"
46 #include "base/trace.hh"
47 #include "debug/QOS.hh"
48 #include "mem/qos/mem_ctrl.hh"
49 #include "mem/packet.hh"
50 #include "mem/request.hh"
51 
52 namespace gem5
53 {
54 
55 struct QoSPolicyParams;
56 
57 namespace memory
58 {
59 
61 namespace qos
62 {
63 
71 class Policy : public SimObject
72 {
73  public:
74  using Params = QoSPolicyParams;
75  Policy(const Params &p);
76 
77  virtual ~Policy();
78 
79  virtual void regStats() override {};
80 
81  virtual void init() override {};
82 
87  void setMemCtrl(MemCtrl* mem) { memCtrl = mem; };
88 
100  template <typename Requestor, typename T>
101  std::pair<RequestorID, T> pair(Requestor requestor, T value);
102 
110  virtual uint8_t schedule(const RequestorID requestor_id,
111  const uint64_t data) = 0;
112 
120  uint8_t schedule(const PacketPtr pkt);
121 
122  protected:
125 };
126 
127 template <typename Requestor, typename T>
129 Policy::pair(Requestor requestor, T value)
130 {
131  auto id = memCtrl->system()->lookupRequestorId(requestor);
132 
134  "Unable to find requestor %s\n", requestor);
135 
136  DPRINTF(QOS,
137  "Requestor %s [id %d] associated with QoS data %d\n",
138  requestor, id, value);
139 
140  return std::pair<RequestorID, T>(id, value);
141 }
142 
143 } // namespace qos
144 } // namespace memory
145 } // namespace gem5
146 
147 #endif /* __MEM_QOS_POLICY_HH__ */
gem5::memory::qos::Policy::memCtrl
MemCtrl * memCtrl
Pointer to parent memory controller implementing the policy.
Definition: policy.hh:124
gem5::System::lookupRequestorId
RequestorID lookupRequestorId(const SimObject *obj) const
Looks up the RequestorID for a given SimObject returns an invalid RequestorID (invldRequestorId) if n...
Definition: system.cc:543
data
const char data[]
Definition: circlebuf.test.cc:48
gem5::memory::qos::Policy
QoS Policy base class.
Definition: policy.hh:71
memory
Definition: mem.h:38
gem5::memory::qos::Policy::regStats
virtual void regStats() override
Callback to set stat parameters.
Definition: policy.hh:79
gem5::memory::qos::Policy::pair
std::pair< RequestorID, T > pair(Requestor requestor, T value)
Builds a RequestorID/value pair given a requestor input.
Definition: policy.hh:129
gem5::memory::GEM5_DEPRECATED_NAMESPACE
GEM5_DEPRECATED_NAMESPACE(QoS, qos)
request.hh
packet.hh
DPRINTF
#define DPRINTF(x,...)
Definition: trace.hh:186
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::memory::qos::MemCtrl::system
System * system() const
read the system pointer
Definition: mem_ctrl.hh:371
gem5::memory::qos::Policy::setMemCtrl
void setMemCtrl(MemCtrl *mem)
Setting a pointer to the Memory Controller implementing the policy.
Definition: policy.hh:87
gem5::memory::qos::Policy::Params
QoSPolicyParams Params
Definition: policy.hh:74
gem5::memory::qos::Policy::init
virtual void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: policy.hh:81
compiler.hh
gem5::memory::qos::Policy::Policy
Policy(const Params &p)
Definition: policy.cc:52
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
std::pair
STL pair class.
Definition: stl.hh:58
mem_ctrl.hh
panic_if
#define panic_if(cond,...)
Conditional panic macro that checks the supplied condition and only panics if the condition is true a...
Definition: logging.hh:203
logging.hh
mem
bool_vector8 mem[]
Definition: reset_stim.h:43
gem5::memory::qos::MemCtrl
The qos::MemCtrl is a base class for Memory objects which support QoS - it provides access to a set o...
Definition: mem_ctrl.hh:80
gem5::RequestorID
uint16_t RequestorID
Definition: request.hh:95
trace.hh
gem5::memory::qos::Policy::schedule
virtual uint8_t schedule(const RequestorID requestor_id, const uint64_t data)=0
Schedules data - must be defined by derived class.
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Request::invldRequestorId
@ invldRequestorId
Invalid requestor id for assertion checking only.
Definition: request.hh:267
gem5::memory::qos::Policy::~Policy
virtual ~Policy()
Definition: policy.cc:56

Generated on Tue Sep 21 2021 12:25:34 for gem5 by doxygen 1.8.17