1 # Copyright (c) 2022 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 """NAT utilities library."""
16 from math import log2, modf
17 from pprint import pformat
18 from enum import IntEnum
20 from ipaddress import IPv4Address
21 from robot.api import logger
23 from resources.libraries.python.Constants import Constants
24 from resources.libraries.python.InterfaceUtil import InterfaceUtil
25 from resources.libraries.python.topology import Topology
26 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
29 class NatConfigFlags(IntEnum):
30 """NAT plugin configuration flags"""
32 NAT_IS_TWICE_NAT = 0x01
33 NAT_IS_SELF_TWICE_NAT = 0x02
34 NAT_IS_OUT2IN_ONLY = 0x04
35 NAT_IS_ADDR_ONLY = 0x08
39 NAT_IS_EXT_HOST_VALID = 0x80
42 class Nat44ConfigFlags(IntEnum):
43 """NAT44 configuration flags"""
44 NAT44_IS_ENDPOINT_INDEPENDENT = 0x00
45 NAT44_IS_ENDPOINT_DEPENDENT = 0x01
46 NAT44_IS_STATIC_MAPPING_ONLY = 0x02
47 NAT44_IS_CONNECTION_TRACKING = 0x04
48 NAT44_IS_OUT2IN_DPO = 0x08
51 class NatAddrPortAllocAlg(IntEnum):
52 """NAT Address and port assignment algorithms."""
53 NAT_ALLOC_ALG_DEFAULT = 0
54 NAT_ALLOC_ALG_MAP_E = 1
55 NAT_ALLOC_ALG_PORT_RANGE = 2
59 """This class defines the methods to set NAT."""
65 def enable_nat44_ed_plugin(
66 node, inside_vrf=0, outside_vrf=0, sessions=0, session_memory=0,
69 """Enable NAT44 plugin.
71 :param node: DUT node.
72 :param inside_vrf: Inside VRF ID.
73 :param outside_vrf: Outside VRF ID.
74 :param sessions: Maximum number of sessions.
75 :param session_memory: Session memory size - overwrite auto calculated
76 hash allocation parameter if non-zero.
77 :param mode: NAT44 mode. Valid values:
78 - endpoint-independent
84 :type inside_vrf: str or int
85 :type outside_vrf: str or int
86 :type sessions: str or int
87 :type session_memory: str or int
90 cmd = u"nat44_ed_plugin_enable_disable"
91 err_msg = f"Failed to enable NAT44 plugin on the host {node[u'host']}!"
94 inside_vrf=int(inside_vrf),
95 outside_vrf=int(outside_vrf),
96 sessions=int(sessions),
97 session_memory=int(session_memory),
100 f"NAT44_IS_{mode.replace(u'-', u'_').upper()}"
104 with PapiSocketExecutor(node) as papi_exec:
105 papi_exec.add(cmd, **args_in).get_reply(err_msg)
108 def set_nat44_interface(node, interface, flag):
109 """Set inside and outside interfaces for NAT44.
111 :param node: DUT node.
112 :param interface: NAT44 interface.
113 :param flag: Interface NAT configuration flag name.
118 cmd = u"nat44_interface_add_del_feature"
120 err_msg = f"Failed to set {flag} interface {interface} for NAT44 " \
121 f"on host {node[u'host']}"
123 sw_if_index=InterfaceUtil.get_sw_if_index(node, interface),
125 flags=getattr(NatConfigFlags, flag).value
128 with PapiSocketExecutor(node) as papi_exec:
129 papi_exec.add(cmd, **args_in).get_reply(err_msg)
132 def set_nat44_interfaces(node, int_in, int_out):
133 """Set inside and outside interfaces for NAT44.
135 :param node: DUT node.
136 :param int_in: Inside interface.
137 :param int_out: Outside interface.
142 NATUtil.set_nat44_interface(node, int_in, u"NAT_IS_INSIDE")
143 NATUtil.set_nat44_interface(node, int_out, u"NAT_IS_OUTSIDE")
146 def set_nat44_address_range(
147 node, start_ip, end_ip, vrf_id=Constants.BITWISE_NON_ZERO,
148 flag=u"NAT_IS_NONE"):
149 """Set NAT44 address range.
151 The return value is a callable (zero argument Python function)
152 which can be used to reset NAT state, so repeated trial measurements
153 hit the same slow path.
155 :param node: DUT node.
156 :param start_ip: IP range start.
157 :param end_ip: IP range end.
158 :param vrf_id: VRF index (Optional).
159 :param flag: NAT flag name.
165 :returns: Resetter of the NAT state.
166 :rtype: Callable[[], None]
168 cmd = u"nat44_add_del_address_range"
169 err_msg = f"Failed to set NAT44 address range on host {node[u'host']}"
172 first_ip_address=IPv4Address(str(start_ip)).packed,
173 last_ip_address=IPv4Address(str(end_ip)).packed,
175 flags=getattr(NatConfigFlags, flag).value
178 with PapiSocketExecutor(node) as papi_exec:
179 papi_exec.add(cmd, **args_in).get_reply(err_msg)
181 # A closure, accessing the variables above.
183 """Delete and re-add the NAT range setting."""
184 with PapiSocketExecutor(node) as papi_exec:
185 args_in[u"is_add"] = False
186 papi_exec.add(cmd, **args_in)
187 args_in[u"is_add"] = True
188 papi_exec.add(cmd, **args_in)
189 papi_exec.get_replies(err_msg)
194 def show_nat44_config(node):
195 """Show the NAT44 plugin running configuration.
197 :param node: DUT node.
200 cmd = u"nat44_show_running_config"
201 err_msg = f"Failed to get NAT44 configuration on host {node[u'host']}"
203 with PapiSocketExecutor(node) as papi_exec:
204 reply = papi_exec.add(cmd).get_reply(err_msg)
206 logger.debug(f"NAT44 Configuration:\n{pformat(reply)}")
209 def show_nat44_summary(node):
210 """Show NAT44 summary on the specified topology node.
212 :param node: Topology node.
214 :returns: NAT44 summary data.
217 return PapiSocketExecutor.run_cli_cmd(node, u"show nat44 summary")
220 def show_nat_base_data(node):
221 """Show the NAT base data.
226 nat44_interface_addr_dump
228 nat44_static_mapping_dump
231 :param node: DUT node.
236 u"nat44_interface_addr_dump",
237 u"nat44_address_dump",
238 u"nat44_static_mapping_dump",
239 u"nat44_interface_dump",
241 PapiSocketExecutor.dump_and_log(node, cmds)
244 def show_nat_user_data(node):
245 """Show the NAT user data.
250 nat44_user_session_dump
252 :param node: DUT node.
257 u"nat44_user_session_dump",
259 PapiSocketExecutor.dump_and_log(node, cmds)
262 def compute_max_translations_per_thread(sessions, threads):
263 """Compute value of max_translations_per_thread NAT44 parameter based on
264 total number of worker threads.
266 :param sessions: Required number of NAT44 sessions.
267 :param threads: Number of worker threads.
270 :returns: Value of max_translations_per_thread NAT44 parameter.
273 # vpp-device tests have not dedicated physical core so
274 # ${dp_count_int} == 0 but we need to use one thread
275 threads = 1 if not int(threads) else int(threads)
276 rest, mult = modf(log2(sessions/(10*threads)))
277 return 2 ** (int(mult) + (1 if rest else 0)) * 10
280 def get_nat44_sessions_number(node, proto):
281 """Get number of expected NAT44 sessions from NAT44 mapping data.
283 This keyword uses output from a CLI command,
284 so it can start failing when VPP changes the output format.
285 TODO: Switch to API (or stat segment) when available.
287 The current implementation supports both 2202 and post-2202 format.
288 (The Gerrit number changing the output format is 34877.)
290 For TCP proto, the expected state after rampup is
291 some number of sessions in transitory state (VPP has seen the FINs),
292 and some number of sessions in established state (meaning
293 some FINs were lost in the last trial).
294 While the two states may need slightly different number of cycles
295 to process next packet, the current implementation considers
296 both of them the "fast path", so they are both counted as expected.
298 As the tests should fail if a session is timed-out,
299 the logic substracts timed out sessions for the returned value
300 (only available for post-2202 format).
302 TODO: Investigate if it is worth to insert additional rampup trials
303 in TPUT tests to ensure all sessions are transitory before next
306 :param node: DUT node.
307 :param proto: Required protocol - TCP/UDP/ICMP.
310 :returns: Number of active established NAT44 sessions.
312 :raises ValueError: If not supported protocol.
313 :raises RuntimeError: If output is not formatted as expected.
315 proto_l = proto.strip().lower()
316 if proto_l not in [u"udp", u"tcp", u"icmp"]:
317 raise ValueError(f"Unsupported protocol: {proto}!")
318 summary_text = NATUtil.show_nat44_summary(node)
319 summary_lines = summary_text.splitlines()
320 # Output from VPP v22.02 and before, delete when no longer needed.
321 pattern_2202 = f"total {proto_l} sessions:"
322 if pattern_2202 in summary_text:
323 for line in summary_lines:
324 if pattern_2202 not in line:
326 return int(line.split(u":", 1)[1].strip())
327 # Post-2202, the proto info and session info are not on the same line.
329 for line in summary_lines:
331 if f"{proto_l} sessions:" in line:
334 # Proto is found, find the line we are interested in.
335 if u"total" not in line:
336 raise RuntimeError(f"show nat summary: no {proto} total.")
337 # We have the line with relevant numbers.
338 total_part, timed_out_part = line.split(u"(", 1)
339 timed_out_part = timed_out_part.split(u")", 1)[0]
340 total_count = int(total_part.split(u":", 1)[1].strip())
341 timed_out_count = int(timed_out_part.split(u":", 1)[1].strip())
342 active_count = total_count - timed_out_count
344 raise RuntimeError(u"Unknown format of show nat44 summary")
347 # DET44 means deterministic mode of NAT44
349 def enable_det44_plugin(node, inside_vrf=0, outside_vrf=0):
350 """Enable DET44 plugin.
352 :param node: DUT node.
353 :param inside_vrf: Inside VRF ID.
354 :param outside_vrf: Outside VRF ID.
356 :type inside_vrf: str or int
357 :type outside_vrf: str or int
359 cmd = u"det44_plugin_enable_disable"
360 err_msg = f"Failed to enable DET44 plugin on the host {node[u'host']}!"
363 inside_vrf=int(inside_vrf),
364 outside_vrf=int(outside_vrf)
367 with PapiSocketExecutor(node) as papi_exec:
368 papi_exec.add(cmd, **args_in).get_reply(err_msg)
371 def set_det44_interface(node, if_key, is_inside):
372 """Enable DET44 feature on the interface.
374 :param node: DUT node.
375 :param if_key: Interface key from topology file of interface
376 to enable DET44 feature on.
377 :param is_inside: True if interface is inside, False if outside.
380 :type is_inside: bool
382 cmd = u"det44_interface_add_del_feature"
383 err_msg = f"Failed to enable DET44 feature on the interface {if_key} " \
384 f"on the host {node[u'host']}!"
388 sw_if_index=Topology.get_interface_sw_index(node, if_key)
391 with PapiSocketExecutor(node) as papi_exec:
392 papi_exec.add(cmd, **args_in).get_reply(err_msg)
395 def set_det44_mapping(node, ip_in, subnet_in, ip_out, subnet_out):
396 """Set DET44 mapping.
398 The return value is a callable (zero argument Python function)
399 which can be used to reset NAT state, so repeated trial measurements
400 hit the same slow path.
402 :param node: DUT node.
403 :param ip_in: Inside IP.
404 :param subnet_in: Inside IP subnet.
405 :param ip_out: Outside IP.
406 :param subnet_out: Outside IP subnet.
409 :type subnet_in: str or int
411 :type subnet_out: str or int
413 cmd = u"det44_add_del_map"
414 err_msg = f"Failed to set DET44 mapping on the host {node[u'host']}!"
417 in_addr=IPv4Address(str(ip_in)).packed,
418 in_plen=int(subnet_in),
419 out_addr=IPv4Address(str(ip_out)).packed,
420 out_plen=int(subnet_out)
423 with PapiSocketExecutor(node) as papi_exec:
424 papi_exec.add(cmd, **args_in).get_reply(err_msg)
426 # A closure, accessing the variables above.
428 """Delete and re-add the deterministic NAT mapping."""
429 with PapiSocketExecutor(node) as papi_exec:
430 args_in[u"is_add"] = False
431 papi_exec.add(cmd, **args_in)
432 args_in[u"is_add"] = True
433 papi_exec.add(cmd, **args_in)
434 papi_exec.get_replies(err_msg)
439 def get_det44_mapping(node):
440 """Get DET44 mapping data.
442 :param node: DUT node.
444 :returns: Dictionary of DET44 mapping data.
447 cmd = u"det44_map_dump"
448 err_msg = f"Failed to get DET44 mapping data on the host " \
451 with PapiSocketExecutor(node) as papi_exec:
452 details = papi_exec.add(cmd, **args_in).get_reply(err_msg)
457 def get_det44_sessions_number(node):
458 """Get number of established DET44 sessions from actual DET44 mapping
460 :param node: DUT node.
462 :returns: Number of established DET44 sessions.
465 det44_data = NATUtil.get_det44_mapping(node)
466 return det44_data.get(u"ses_num", 0)
469 def show_det44(node):
478 :param node: DUT node.
482 u"det44_interface_dump",
484 u"det44_session_dump",
486 PapiSocketExecutor.dump_and_log(node, cmds)