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_plugin(
66 node, inside_vrf=0, outside_vrf=0, users=0, user_memory=0,
67 sessions=0, session_memory=0, user_sessions=0, mode=u""):
68 """Enable NAT44 plugin.
70 :param node: DUT node.
71 :param inside_vrf: Inside VRF ID.
72 :param outside_vrf: Outside VRF ID.
73 :param users: Maximum number of users. Used only in endpoint-independent
75 :param user_memory: User memory size - overwrite auto calculated hash
76 allocation parameter if non-zero.
77 :param sessions: Maximum number of sessions.
78 :param session_memory: Session memory size - overwrite auto calculated
79 hash allocation parameter if non-zero.
80 :param user_sessions: Maximum number of sessions per user. Used only in
81 endpoint-independent mode.
82 :param mode: NAT44 mode. Valid values:
83 - endpoint-independent
89 :type inside_vrf: str or int
90 :type outside_vrf: str or int
91 :type users: str or int
92 :type user_memory: str or int
93 :type sessions: str or int
94 :type session_memory: str or int
95 :type user_sessions: str or int
98 cmd = u"nat44_plugin_enable_disable"
99 err_msg = f"Failed to enable NAT44 plugin on the host {node[u'host']}!"
102 inside_vrf=int(inside_vrf),
103 outside_vrf=int(outside_vrf),
105 user_memory=int(user_memory),
106 sessions=int(sessions),
107 session_memory=int(session_memory),
108 user_sessions=int(user_sessions),
111 f"NAT44_IS_{mode.replace(u'-', u'_').upper()}"
115 with PapiSocketExecutor(node) as papi_exec:
116 papi_exec.add(cmd, **args_in).get_reply(err_msg)
119 def set_nat44_interface(node, interface, flag):
120 """Set inside and outside interfaces for NAT44.
122 :param node: DUT node.
123 :param interface: NAT44 interface.
124 :param flag: Interface NAT configuration flag name.
129 cmd = u"nat44_interface_add_del_feature"
131 err_msg = f"Failed to set {flag} interface {interface} for NAT44 " \
132 f"on host {node[u'host']}"
134 sw_if_index=InterfaceUtil.get_sw_if_index(node, interface),
136 flags=getattr(NatConfigFlags, flag).value
139 with PapiSocketExecutor(node) as papi_exec:
140 papi_exec.add(cmd, **args_in).get_reply(err_msg)
143 def set_nat44_interfaces(node, int_in, int_out):
144 """Set inside and outside interfaces for NAT44.
146 :param node: DUT node.
147 :param int_in: Inside interface.
148 :param int_out: Outside interface.
153 NATUtil.set_nat44_interface(node, int_in, u"NAT_IS_INSIDE")
154 NATUtil.set_nat44_interface(node, int_out, u"NAT_IS_OUTSIDE")
157 def set_nat44_address_range(
158 node, start_ip, end_ip, vrf_id=Constants.BITWISE_NON_ZERO,
159 flag=u"NAT_IS_NONE"):
160 """Set NAT44 address range.
162 The return value is a callable (zero argument Python function)
163 which can be used to reset NAT state, so repeated trial measurements
164 hit the same slow path.
166 :param node: DUT node.
167 :param start_ip: IP range start.
168 :param end_ip: IP range end.
169 :param vrf_id: VRF index (Optional).
170 :param flag: NAT flag name.
176 :returns: Resetter of the NAT state.
177 :rtype: Callable[[], None]
179 cmd = u"nat44_add_del_address_range"
180 err_msg = f"Failed to set NAT44 address range on host {node[u'host']}"
183 first_ip_address=IPv4Address(str(start_ip)).packed,
184 last_ip_address=IPv4Address(str(end_ip)).packed,
186 flags=getattr(NatConfigFlags, flag).value
189 with PapiSocketExecutor(node) as papi_exec:
190 papi_exec.add(cmd, **args_in).get_reply(err_msg)
192 # A closure, accessing the variables above.
194 """Delete and re-add the NAT range setting."""
195 with PapiSocketExecutor(node) as papi_exec:
196 args_in[u"is_add"] = False
197 papi_exec.add(cmd, **args_in)
198 args_in[u"is_add"] = True
199 papi_exec.add(cmd, **args_in)
200 papi_exec.get_replies(err_msg)
205 def show_nat44_config(node):
206 """Show the NAT44 plugin running configuration.
208 :param node: DUT node.
211 cmd = u"nat44_show_running_config"
212 err_msg = f"Failed to get NAT44 configuration on host {node[u'host']}"
214 with PapiSocketExecutor(node) as papi_exec:
215 reply = papi_exec.add(cmd).get_reply(err_msg)
217 logger.debug(f"NAT44 Configuration:\n{pformat(reply)}")
220 def show_nat44_summary(node):
221 """Show NAT44 summary on the specified topology node.
223 :param node: Topology node.
225 :returns: NAT44 summary data.
228 return PapiSocketExecutor.run_cli_cmd(node, u"show nat44 summary")
231 def show_nat_base_data(node):
232 """Show the NAT base data.
237 nat44_interface_addr_dump
239 nat44_static_mapping_dump
242 :param node: DUT node.
247 u"nat44_interface_addr_dump",
248 u"nat44_address_dump",
249 u"nat44_static_mapping_dump",
250 u"nat44_interface_dump",
252 PapiSocketExecutor.dump_and_log(node, cmds)
255 def show_nat_user_data(node):
256 """Show the NAT user data.
261 nat44_user_session_dump
263 :param node: DUT node.
268 u"nat44_user_session_dump",
270 PapiSocketExecutor.dump_and_log(node, cmds)
273 def compute_max_translations_per_thread(sessions, threads):
274 """Compute value of max_translations_per_thread NAT44 parameter based on
275 total number of worker threads.
277 :param sessions: Required number of NAT44 sessions.
278 :param threads: Number of worker threads.
281 :returns: Value of max_translations_per_thread NAT44 parameter.
284 # vpp-device tests have not dedicated physical core so
285 # ${dp_count_int} == 0 but we need to use one thread
286 threads = 1 if not int(threads) else int(threads)
287 rest, mult = modf(log2(sessions/(10*threads)))
288 return 2 ** (int(mult) + (1 if rest else 0)) * 10
291 def get_nat44_sessions_number(node, proto):
292 """Get number of established NAT44 sessions from NAT44 mapping data.
294 This keyword uses output from a CLI command,
295 so it can start failing when VPP changes the output format.
296 TODO: Switch to API (or stat segment) when available.
298 The current implementation supports both 2202 and post-2202 format.
299 (The Gerrit number changing the output format is 34877.)
301 For TCP proto, the post-2202 format includes "timed out"
302 established sessions into its count of total sessions.
303 As the tests should fail if a session is timed-out,
304 the logic substracts timed out sessions for the resturned value.
306 The 2202 output reports most of TCP sessions as in "transitory" state,
307 as opposed to "established", but the previous CSIT logic tolerated that.
308 Ideally, whis keyword would add establised and transitory sessions
309 (but without CLOSED and WAIT_CLOSED sessions) and return that.
310 The current implementation simply returns "total tcp sessions" value,
311 to preserve the previous CSIT behavior for 2202 output.
313 :param node: DUT node.
314 :param proto: Required protocol - TCP/UDP/ICMP.
317 :returns: Number of active established NAT44 sessions.
319 :raises ValueError: If not supported protocol.
320 :raises RuntimeError: If output is not formatted as expected.
322 proto_l = proto.strip().lower()
323 if proto_l not in [u"udp", u"tcp", u"icmp"]:
324 raise ValueError(f"Unsupported protocol: {proto}!")
325 summary_text = NATUtil.show_nat44_summary(node)
326 summary_lines = summary_text.splitlines()
327 # Output from VPP v22.02 and before, delete when no longer needed.
328 pattern_2202 = f"total {proto_l} sessions:"
329 if pattern_2202 in summary_text:
330 for line in summary_lines:
331 if pattern_2202 not in line:
333 return int(line.split(u":", 1)[1].strip())
334 # Post-2202, the proto info and session info are not on the same line.
336 for line in summary_lines:
338 if f"{proto_l} sessions:" in line:
341 # Proto is found, find the line we are interested in.
342 if proto_l == u"tcp" and u"established" not in line:
344 if u"total" not in line and u"established" not in line:
345 raise RuntimeError(f"show nat summary: no {proto} total.")
346 # We have the line with relevant numbers.
347 total_part, timed_out_part = line.split(u"(", 1)
348 timed_out_part = timed_out_part.split(u")", 1)[0]
349 total_count = int(total_part.split(u":", 1)[1].strip())
350 timed_out_count = int(timed_out_part.split(u":", 1)[1].strip())
351 active_count = total_count - timed_out_count
353 raise RuntimeError(u"Unknown format of show nat44 summary")
356 # DET44 means deterministic mode of NAT44
358 def enable_det44_plugin(node, inside_vrf=0, outside_vrf=0):
359 """Enable DET44 plugin.
361 :param node: DUT node.
362 :param inside_vrf: Inside VRF ID.
363 :param outside_vrf: Outside VRF ID.
365 :type inside_vrf: str or int
366 :type outside_vrf: str or int
368 cmd = u"det44_plugin_enable_disable"
369 err_msg = f"Failed to enable DET44 plugin on the host {node[u'host']}!"
372 inside_vrf=int(inside_vrf),
373 outside_vrf=int(outside_vrf)
376 with PapiSocketExecutor(node) as papi_exec:
377 papi_exec.add(cmd, **args_in).get_reply(err_msg)
380 def set_det44_interface(node, if_key, is_inside):
381 """Enable DET44 feature on the interface.
383 :param node: DUT node.
384 :param if_key: Interface key from topology file of interface
385 to enable DET44 feature on.
386 :param is_inside: True if interface is inside, False if outside.
389 :type is_inside: bool
391 cmd = u"det44_interface_add_del_feature"
392 err_msg = f"Failed to enable DET44 feature on the interface {if_key} " \
393 f"on the host {node[u'host']}!"
397 sw_if_index=Topology.get_interface_sw_index(node, if_key)
400 with PapiSocketExecutor(node) as papi_exec:
401 papi_exec.add(cmd, **args_in).get_reply(err_msg)
404 def set_det44_mapping(node, ip_in, subnet_in, ip_out, subnet_out):
405 """Set DET44 mapping.
407 The return value is a callable (zero argument Python function)
408 which can be used to reset NAT state, so repeated trial measurements
409 hit the same slow path.
411 :param node: DUT node.
412 :param ip_in: Inside IP.
413 :param subnet_in: Inside IP subnet.
414 :param ip_out: Outside IP.
415 :param subnet_out: Outside IP subnet.
418 :type subnet_in: str or int
420 :type subnet_out: str or int
422 cmd = u"det44_add_del_map"
423 err_msg = f"Failed to set DET44 mapping on the host {node[u'host']}!"
426 in_addr=IPv4Address(str(ip_in)).packed,
427 in_plen=int(subnet_in),
428 out_addr=IPv4Address(str(ip_out)).packed,
429 out_plen=int(subnet_out)
432 with PapiSocketExecutor(node) as papi_exec:
433 papi_exec.add(cmd, **args_in).get_reply(err_msg)
435 # A closure, accessing the variables above.
437 """Delete and re-add the deterministic NAT mapping."""
438 with PapiSocketExecutor(node) as papi_exec:
439 args_in[u"is_add"] = False
440 papi_exec.add(cmd, **args_in)
441 args_in[u"is_add"] = True
442 papi_exec.add(cmd, **args_in)
443 papi_exec.get_replies(err_msg)
448 def get_det44_mapping(node):
449 """Get DET44 mapping data.
451 :param node: DUT node.
453 :returns: Dictionary of DET44 mapping data.
456 cmd = u"det44_map_dump"
457 err_msg = f"Failed to get DET44 mapping data on the host " \
460 with PapiSocketExecutor(node) as papi_exec:
461 details = papi_exec.add(cmd, **args_in).get_reply(err_msg)
466 def get_det44_sessions_number(node):
467 """Get number of established DET44 sessions from actual DET44 mapping
469 :param node: DUT node.
471 :returns: Number of established DET44 sessions.
474 det44_data = NATUtil.get_det44_mapping(node)
475 return det44_data.get(u"ses_num", 0)
478 def show_det44(node):
487 :param node: DUT node.
491 u"det44_interface_dump",
493 u"det44_session_dump",
495 PapiSocketExecutor.dump_and_log(node, cmds)