1 # Copyright (c) 2020 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Policer utilities library."""
16 from enum import IntEnum
18 from resources.libraries.python.Constants import Constants
19 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
20 from resources.libraries.python.topology import Topology
23 class PolicerRateType(IntEnum):
24 """Policer rate types."""
30 class PolicerRoundType(IntEnum):
31 """Policer round types."""
38 class PolicerType(IntEnum):
41 TYPE_1R3C_RFC_2697 = 1
42 TYPE_2R3C_RFC_2698 = 2
43 TYPE_2R3C_RFC_4115 = 3
44 TYPE_2R3C_RFC_MEF5CF1 = 4
48 class PolicerAction(IntEnum):
55 class PolicerPreColor(IntEnum):
56 """Policer Pre-color."""
63 """DSCP for mark-and-transmit action."""
85 """Policer utilities."""
87 # TODO: Pylint says too-many-arguments and too-many-locals.
88 # It is right, we should refactor the code
89 # and group similar arguments together (into documented classes).
90 # Note that even the call from Robot Framework
91 # is not very readable with this many arguments.
93 def policer_set_configuration(
94 node, policer_name, cir, eir, cbs, ebs, rate_type, round_type,
95 policer_type, conform_action_type, exceed_action_type,
96 violate_action_type, color_aware, is_add=True, conform_dscp=None,
97 exceed_dscp=None, violate_dscp=None):
98 """Configure policer on VPP node.
100 :param node: VPP node.
101 :param policer_name: Name of the policer.
102 :param cir: Committed information rate.
103 :param eir: Excess (or Peak) information rate.
104 :param cbs: Committed burst size.
105 :param ebs: Excess (or Peak) burst size.
106 :param rate_type: Rate type.
107 :param round_type: Round type.
108 :param policer_type: Policer algorithm.
109 :param conform_action_type: Conform action type.
110 :param exceed_action_type: Exceed action type.
111 :param violate_action_type: Violate action type.
112 :param color_aware: Color-blind (cb) or color-aware (ca).
113 :param is_add: Add policer if True, else delete.
114 :param conform_dscp: DSCP for conform mark_and_transmit action.
115 :param exceed_dscp: DSCP for exceed mark_and_transmit action.
116 :param violate_dscp: DSCP for vilate mark_and_transmit action.
118 :type policer_name: str
124 :type round_type: str
125 :type policer_type: str
126 :type conform_action_type: str
127 :type exceed_action_type: str
128 :type violate_action_type: str
129 :type color_aware: str
131 :type conform_dscp: str
132 :type exceed_dscp: str
133 :type violate_dscp: str
135 conform_action = dict(
136 type=getattr(PolicerAction, conform_action_type.upper()).value,
137 dscp=Policer.get_dscp_num_value(conform_dscp) if
138 conform_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
141 exceed_action = dict(
142 type=getattr(PolicerAction, exceed_action_type.upper()).value,
143 dscp=Policer.get_dscp_num_value(exceed_dscp) if
144 exceed_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
147 violate_action = dict(
148 type=getattr(PolicerAction, violate_action_type.upper()).value,
149 dscp=Policer.get_dscp_num_value(violate_dscp) if
150 violate_action_type.upper() == PolicerAction.MARK_AND_TRANSMIT.name
154 cmd = u"policer_add_del"
157 name=str(policer_name),
162 rate_type=getattr(PolicerRateType, rate_type.upper()).value,
164 PolicerRoundType, f"ROUND_TO_{round_type.upper()}"
166 type=getattr(PolicerType, f"TYPE_{policer_type.upper()}").value,
167 conform_action=conform_action,
168 exceed_action=exceed_action,
169 violate_action=violate_action,
170 color_aware=bool(color_aware == u"'ca'")
172 err_msg = f"Failed to configure policer {policer_name} " \
173 f"on host {node['host']}"
175 with PapiSocketExecutor(node) as papi_exec:
176 reply = papi_exec.add(cmd, **args).get_reply(err_msg)
178 return reply[u"policer_index"]
181 def policer_classify_set_interface(
182 node, interface, ip4_table_index=Constants.BITWISE_NON_ZERO,
183 ip6_table_index=Constants.BITWISE_NON_ZERO,
184 l2_table_index=Constants.BITWISE_NON_ZERO, is_add=True):
185 """Set/unset policer classify interface.
187 :param node: VPP node.
188 :param interface: Interface name or sw_if_index to set/unset policer
190 :param ip4_table_index: IP4 classify table index (~0 to skip).
192 :param ip6_table_index: IP6 classify table index (~0 to skip).
194 :param l2_table_index: L2 classify table index (~0 to skip).
196 :param is_add: Set if True, else unset.
198 :type interface: str or int
199 :type ip4_table_index: int
200 :type ip6_table_index: int
201 :type l2_table_index: int
204 if isinstance(interface, str):
205 sw_if_index = Topology.get_interface_sw_index(node, interface)
207 sw_if_index = interface
209 cmd = u"policer_classify_set_interface"
212 sw_if_index=int(sw_if_index),
213 ip4_table_index=int(ip4_table_index),
214 ip6_table_index=int(ip6_table_index),
215 l2_table_index=int(l2_table_index)
217 err_msg = f"Failed to set/unset policer classify interface " \
218 f"{interface} on host {node[u'host']}"
220 with PapiSocketExecutor(node) as papi_exec:
221 papi_exec.add(cmd, **args).get_reply(err_msg)
224 def policer_classify_get_precolor(precolor):
225 """Return policer pre-color numeric value.
227 :param precolor: Policer pre-color name.
229 :returns: Policer pre-color numeric value.
232 return getattr(PolicerPreColor, precolor.upper()).value
235 def get_dscp_num_value(dscp):
236 """Return DSCP numeric value.
238 :param dscp: DSCP name.
240 :returns: DSCP numeric value.
243 return getattr(DSCP, f"D_{dscp.upper()}").value