QoSPolicy.py revision 13720:18f5d3990ac9 
1# Copyright (c) 2018 ARM Limited
2# All rights reserved.
3#
4# The license below extends only to copyright in the software and shall
5# not be construed as granting a license to any other intellectual
6# property including but not limited to intellectual property relating
7# to a hardware implementation of the functionality of the software
8# licensed hereunder.  You may use the software subject to the license
9# terms below provided that you ensure that this notice is replicated
10# unmodified and in its entirety in all distributions of the software,
11# modified or unmodified, in source code or in binary form.
12#
13# Redistribution and use in source and binary forms, with or without
14# modification, are permitted provided that the following conditions are
15# met: redistributions of source code must retain the above copyright
16# notice, this list of conditions and the following disclaimer;
17# redistributions in binary form must reproduce the above copyright
18# notice, this list of conditions and the following disclaimer in the
19# documentation and/or other materials provided with the distribution;
20# neither the name of the copyright holders nor the names of its
21# contributors may be used to endorse or promote products derived from
22# this software without specific prior written permission.
23#
24# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35#
36# Authors: Giacomo Travaglini
37
38from six import string_types
39
40from m5.SimObject import *
41from m5.params import *
42
43# QoS scheduler policy used to serve incoming transaction
44class QoSPolicy(SimObject):
45    type = 'QoSPolicy'
46    abstract = True
47    cxx_header = "mem/qos/policy.hh"
48    cxx_class = 'QoS::Policy'
49
50class QoSFixedPriorityPolicy(QoSPolicy):
51    type = 'QoSFixedPriorityPolicy'
52    cxx_header = "mem/qos/policy_fixed_prio.hh"
53    cxx_class = 'QoS::FixedPriorityPolicy'
54
55    cxx_exports = [
56        PyBindMethod('initMasterName'),
57        PyBindMethod('initMasterObj'),
58    ]
59
60    _mpriorities = None
61
62    def setMasterPriority(self, master, priority):
63        if not self._mpriorities:
64            self._mpriorities = []
65
66        self._mpriorities.append([master, priority])
67
68    def init(self):
69        if not self._mpriorities:
70            print("Error, use setMasterPriority to init masters/priorities\n");
71            exit(1)
72        else:
73            for mprio in self._mpriorities:
74                master = mprio[0]
75                priority = mprio[1]
76                if isinstance(master, string_types):
77                    self.getCCObject().initMasterName(
78                        master, int(priority))
79                else:
80                    self.getCCObject().initMasterObj(
81                        master.getCCObject(), priority)
82
83    # default fixed priority value for non-listed Masters
84    qos_fixed_prio_default_prio = Param.UInt8(0,
85        "Default priority for non-listed Masters")
86
87class QoSPropFairPolicy(QoSPolicy):
88    type = 'QoSPropFairPolicy'
89    cxx_header = "mem/qos/policy_pf.hh"
90    cxx_class = 'QoS::PropFairPolicy'
91
92    cxx_exports = [
93        PyBindMethod('initMasterName'),
94        PyBindMethod('initMasterObj'),
95    ]
96
97    _mscores = None
98
99    def setInitialScore(self, master, score):
100        if not self._mscores:
101            self._mscores = []
102
103        self._mscores.append([master, score])
104
105    def init(self):
106        if not self._mscores:
107            print("Error, use setInitialScore to init masters/scores\n");
108            exit(1)
109        else:
110            for mprio in self._mscores:
111                master = mprio[0]
112                score = mprio[1]
113                if isinstance(master, string_types):
114                    self.getCCObject().initMasterName(
115                        master, float(score))
116                else:
117                    self.getCCObject().initMasterObj(
118                        master.getCCObject(), float(score))
119
120    weight = Param.Float(0.5, "Pf score weight")
121