1 # Copyright (c) 2019 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 """Common IP utilities library."""
18 from enum import IntEnum
19 from ipaddress import ip_address
21 from resources.libraries.python.Constants import Constants
22 from resources.libraries.python.InterfaceUtil import InterfaceUtil
23 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
24 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
25 from resources.libraries.python.topology import Topology
26 from resources.libraries.python.VatExecutor import VatTerminal
29 # from vpp/src/vnet/vnet/mpls/mpls_types.h
30 MPLS_IETF_MAX_LABEL = 0xfffff
31 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
34 class AddressFamily(IntEnum):
35 """IP address family."""
40 class FibPathType(IntEnum):
42 FIB_PATH_TYPE_NORMAL = 0
43 FIB_PATH_TYPE_LOCAL = 1
44 FIB_PATH_TYPE_DROP = 2
45 FIB_PATH_TYPE_UDP_ENCAP = 3
46 FIB_PATH_TYPE_BIER_IMP = 4
47 FIB_PATH_TYPE_ICMP_UNREACH = 5
48 FIB_PATH_TYPE_ICMP_PROHIBIT = 6
49 FIB_PATH_TYPE_SOURCE_LOOKUP = 7
51 FIB_PATH_TYPE_INTERFACE_RX = 9
52 FIB_PATH_TYPE_CLASSIFY = 10
55 class FibPathFlags(IntEnum):
57 FIB_PATH_FLAG_NONE = 0
58 FIB_PATH_FLAG_RESOLVE_VIA_ATTACHED = 1 #pylint: disable=invalid-name
59 FIB_PATH_FLAG_RESOLVE_VIA_HOST = 2
62 class FibPathNhProto(IntEnum):
63 """FIB path next-hop protocol."""
64 FIB_PATH_NH_PROTO_IP4 = 0
65 FIB_PATH_NH_PROTO_IP6 = 1
66 FIB_PATH_NH_PROTO_MPLS = 2
67 FIB_PATH_NH_PROTO_ETHERNET = 3
68 FIB_PATH_NH_PROTO_BIER = 4
72 """Common IP utilities"""
75 def ip_to_int(ip_str):
76 """Convert IP address from string format (e.g. 10.0.0.1) to integer
77 representation (167772161).
79 :param ip_str: IP address in string representation.
81 :returns: Integer representation of IP address.
84 return int(ip_address(unicode(ip_str)))
87 def int_to_ip(ip_int):
88 """Convert IP address from integer representation (e.g. 167772161) to
89 string format (10.0.0.1).
91 :param ip_int: IP address in integer representation.
93 :returns: String representation of IP address.
96 return str(ip_address(ip_int))
99 def vpp_get_interface_ip_addresses(node, interface, ip_version):
100 """Get list of IP addresses from an interface on a VPP node.
102 :param node: VPP node.
103 :param interface: Name of an interface on the VPP node.
104 :param ip_version: IP protocol version (ipv4 or ipv6).
107 :type ip_version: str
108 :returns: List of dictionaries, each containing IP address, subnet
109 prefix length and also the subnet mask for ipv4 addresses.
110 Note: A single interface may have multiple IP addresses assigned.
113 sw_if_index = InterfaceUtil.get_interface_index(node, interface)
118 is_ipv6 = 1 if ip_version == 'ipv6' else 0
120 cmd = 'ip_address_dump'
121 args = dict(sw_if_index=sw_if_index,
123 err_msg = 'Failed to get L2FIB dump on host {host}'.format(
126 with PapiSocketExecutor(node) as papi_exec:
127 details = papi_exec.add(cmd, **args).get_details(err_msg)
129 # TODO: CSIT currently looks only whether the list is empty.
130 # Add proper value processing if values become important.
135 def vpp_get_ip_tables(node):
136 """Get dump of all IP FIB tables on a VPP node.
138 :param node: VPP node.
142 PapiSocketExecutor.run_cli_cmd(node, 'show ip fib')
143 PapiSocketExecutor.run_cli_cmd(node, 'show ip fib summary')
144 PapiSocketExecutor.run_cli_cmd(node, 'show ip6 fib')
145 PapiSocketExecutor.run_cli_cmd(node, 'show ip6 fib summary')
148 def vpp_get_ip_tables_prefix(node, address):
149 """Get dump of all IP FIB tables on a VPP node.
151 :param node: VPP node.
152 :param address: IP address.
156 addr = ip_address(unicode(address))
158 PapiSocketExecutor.run_cli_cmd(
159 node, 'show {ip_ver} fib {addr}/{addr_len}'.format(
160 ip_ver='ip6' if addr.version == 6 else 'ip',
162 addr_len=addr.max_prefixlen))
165 def get_interface_vrf_table(node, interface, ip_version='ipv4'):
166 """Get vrf ID for the given interface.
168 :param node: VPP node.
169 :param interface: Name or sw_if_index of a specific interface.
171 :param ip_version: IP protocol version (ipv4 or ipv6).
172 :type interface: str or int
173 :type ip_version: str
174 :returns: vrf ID of the specified interface.
177 sw_if_index = InterfaceUtil.get_interface_index(node, interface)
179 cmd = 'sw_interface_get_table'
181 sw_if_index=sw_if_index,
182 is_ipv6=True if ip_version == 'ipv6' else False
184 err_msg = 'Failed to get VRF id assigned to interface {ifc}'.format(
187 with PapiSocketExecutor(node) as papi_exec:
188 reply = papi_exec.add(cmd, **args).get_reply(err_msg)
190 return reply['vrf_id']
193 def vpp_ip_source_check_setup(node, if_name):
194 """Setup Reverse Path Forwarding source check on interface.
196 :param node: VPP node.
197 :param if_name: Interface name to setup RPF source check.
201 cmd = 'ip_source_check_interface_add_del'
203 sw_if_index=InterfaceUtil.get_interface_index(node, if_name),
207 err_msg = 'Failed to enable source check on interface {ifc}'.format(
209 with PapiSocketExecutor(node) as papi_exec:
210 papi_exec.add(cmd, **args).get_reply(err_msg)
213 def vpp_ip_probe(node, interface, addr):
214 """Run ip probe on VPP node.
216 :param node: VPP node.
217 :param interface: Interface key or name.
218 :param addr: IPv4/IPv6 address.
223 cmd = 'ip_probe_neighbor'
225 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
227 err_msg = 'VPP ip probe {dev} {ip} failed on {h}'.format(
228 dev=interface, ip=addr, h=node['host'])
230 with PapiSocketExecutor(node) as papi_exec:
231 papi_exec.add(cmd, **args).get_reply(err_msg)
234 def ip_addresses_should_be_equal(ip1, ip2):
235 """Fails if the given IP addresses are unequal.
237 :param ip1: IPv4 or IPv6 address.
238 :param ip2: IPv4 or IPv6 address.
242 addr1 = ip_address(unicode(ip1))
243 addr2 = ip_address(unicode(ip2))
246 raise AssertionError('IP addresses are not equal: {0} != {1}'.
250 def setup_network_namespace(node, namespace_name, interface_name,
252 """Setup namespace on given node and attach interface and IP to
253 this namespace. Applicable also on TG node.
255 :param node: VPP node.
256 :param namespace_name: Namespace name.
257 :param interface_name: Interface name.
258 :param ip_addr: IP address of namespace's interface.
259 :param prefix: IP address prefix length.
261 :type namespace_name: str
262 :type interface_name: str
266 cmd = ('ip netns add {0}'.format(namespace_name))
267 exec_cmd_no_error(node, cmd, sudo=True)
269 cmd = ('ip link set dev {0} up netns {1}'.format(interface_name,
271 exec_cmd_no_error(node, cmd, sudo=True)
273 cmd = ('ip netns exec {0} ip addr add {1}/{2} dev {3}'.format(
274 namespace_name, ip_addr, prefix, interface_name))
275 exec_cmd_no_error(node, cmd, sudo=True)
278 def linux_enable_forwarding(node, ip_ver='ipv4'):
279 """Enable forwarding on a Linux node, e.g. VM.
281 :param node: VPP node.
282 :param ip_ver: IP version, 'ipv4' or 'ipv6'.
286 cmd = 'sysctl -w net.{0}.ip_forward=1'.format(ip_ver)
287 exec_cmd_no_error(node, cmd, sudo=True)
290 def get_linux_interface_name(node, pci_addr):
291 """Get the interface name.
293 :param node: VPP/TG node.
294 :param pci_addr: PCI address
297 :returns: Interface name
299 :raises RuntimeError: If cannot get the information about interfaces.
301 regex_intf_info = r"pci@" \
302 r"([0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}.[0-9a-f])\s*" \
303 r"([a-zA-Z0-9]*)\s*network"
305 cmd = "lshw -class network -businfo"
306 ret_code, stdout, stderr = exec_cmd(node, cmd, timeout=30, sudo=True)
308 raise RuntimeError('Could not get information about interfaces:\n'
309 '{err}'.format(err=stderr))
311 for line in stdout.splitlines()[2:]:
313 if re.search(regex_intf_info, line).group(1) == pci_addr:
314 return re.search(regex_intf_info, line).group(2)
315 except AttributeError:
320 def set_linux_interface_up(node, interface):
321 """Set the specified interface up.
323 :param node: VPP/TG node.
324 :param interface: Interface in namespace.
327 :raises RuntimeError: If the interface could not be set up.
329 cmd = "ip link set {0} up".format(interface)
330 exec_cmd_no_error(node, cmd, timeout=30, sudo=True)
333 def set_linux_interface_ip(node, interface, ip_addr, prefix,
335 """Set IP address to interface in linux.
337 :param node: VPP/TG node.
338 :param interface: Interface in namespace.
339 :param ip_addr: IP to be set on interface.
340 :param prefix: IP prefix.
341 :param namespace: Execute command in namespace. Optional
347 :raises RuntimeError: IP could not be set.
349 if namespace is not None:
350 cmd = 'ip netns exec {ns} ip addr add {ip}/{p} dev {dev}'.format(
351 ns=namespace, ip=ip_addr, p=prefix, dev=interface)
353 cmd = 'ip addr add {ip}/{p} dev {dev}'.format(
354 ip=ip_addr, p=prefix, dev=interface)
356 exec_cmd_no_error(node, cmd, timeout=5, sudo=True)
359 def add_linux_route(node, ip_addr, prefix, gateway, namespace=None):
360 """Add linux route in namespace.
362 :param node: Node where to execute command.
363 :param ip_addr: Route destination IP address.
364 :param prefix: IP prefix.
365 :param namespace: Execute command in namespace. Optional.
366 :param gateway: Gateway address.
373 if namespace is not None:
374 cmd = 'ip netns exec {} ip route add {}/{} via {}'.format(
375 namespace, ip_addr, prefix, gateway)
377 cmd = 'ip route add {}/{} via {}'.format(ip_addr, prefix, gateway)
378 exec_cmd_no_error(node, cmd, sudo=True)
381 def vpp_interface_set_ip_address(node, interface, address,
383 """Set IP address to VPP interface.
385 :param node: VPP node.
386 :param interface: Interface name.
387 :param address: IP address.
388 :param prefix_length: Prefix length.
392 :type prefix_length: int
394 ip_addr = ip_address(unicode(address))
396 cmd = 'sw_interface_add_del_address'
398 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
401 prefix=IPUtil.create_prefix_object(
403 prefix_length if prefix_length else 128
404 if ip_addr.version == 6 else 32)
406 err_msg = 'Failed to add IP address on interface {ifc}'.format(
408 with PapiSocketExecutor(node) as papi_exec:
409 papi_exec.add(cmd, **args).get_reply(err_msg)
412 def vpp_add_ip_neighbor(node, iface_key, ip_addr, mac_address):
413 """Add IP neighbor on DUT node.
415 :param node: VPP node.
416 :param iface_key: Interface key.
417 :param ip_addr: IP address of the interface.
418 :param mac_address: MAC address of the interface.
422 :type mac_address: str
424 dst_ip = ip_address(unicode(ip_addr))
427 sw_if_index=Topology.get_interface_sw_index(node, iface_key),
429 mac_address=str(mac_address),
430 ip_address=str(dst_ip))
431 cmd = 'ip_neighbor_add_del'
435 err_msg = 'Failed to add IP neighbor on interface {ifc}'.format(
437 with PapiSocketExecutor(node) as papi_exec:
438 papi_exec.add(cmd, **args).get_reply(err_msg)
441 def union_addr(ip_addr):
442 """Creates union IP address.
444 :param ip_addr: IPv4 or IPv6 address.
445 :type ip_addr: IPv4Address or IPv6Address
446 :returns: Union IP address.
449 return dict(ip6=ip_addr.packed) if ip_addr.version == 6 \
450 else dict(ip4=ip_addr.packed)
453 def create_ip_address_object(ip_addr):
454 """Create IP address object.
456 :param ip_addr: IPv4 or IPv6 address
457 :type ip_addr: IPv4Address or IPv6Address
458 :returns: IP address object.
463 AddressFamily, 'ADDRESS_IP6' if ip_addr.version == 6
464 else 'ADDRESS_IP4').value,
465 un=IPUtil.union_addr(ip_addr))
468 def create_prefix_object(ip_addr, addr_len):
469 """Create prefix object.
471 :param ip_addr: IPv4 or IPv6 address.
472 :para, addr_len: Length of IP address.
473 :type ip_addr: IPv4Address or IPv6Address
475 :returns: Prefix object.
478 addr = IPUtil.create_ip_address_object(ip_addr)
486 def compose_vpp_route_structure(node, network, prefix_len, **kwargs):
487 """Create route object for ip_route_add_del api call.
489 :param node: VPP node.
490 :param network: Route destination network address.
491 :param prefix_len: Route destination network prefix length.
492 :param kwargs: Optional key-value arguments:
494 gateway: Route gateway address. (str)
495 interface: Route interface. (str)
496 vrf: VRF table ID. (int)
497 count: number of IP addresses to add starting from network IP (int)
498 local: The route is local with same prefix (increment is 1).
499 If None, then is not used. (bool)
500 lookup_vrf: VRF table ID for lookup. (int)
501 multipath: Enable multipath routing. (bool)
502 weight: Weight value for unequal cost multipath routing. (int)
506 :type prefix_len: int
508 :returns: route parameter basic structure
511 interface = kwargs.get('interface', '')
512 gateway = kwargs.get('gateway', '')
514 net_addr = ip_address(unicode(network))
516 prefix = IPUtil.create_prefix_object(net_addr, prefix_len)
520 address=IPUtil.union_addr(ip_address(unicode(gateway))) if gateway
522 via_label=MPLS_LABEL_INVALID,
523 obj_id=Constants.BITWISE_NON_ZERO
526 sw_if_index=InterfaceUtil.get_interface_index(node, interface)
527 if interface else Constants.BITWISE_NON_ZERO,
528 table_id=int(kwargs.get('lookup_vrf', 0)),
529 rpf_id=Constants.BITWISE_NON_ZERO,
530 weight=int(kwargs.get('weight', 1)),
533 FibPathType, 'FIB_PATH_TYPE_LOCAL'
534 if kwargs.get('local', False)
535 else 'FIB_PATH_TYPE_NORMAL').value,
536 flags=getattr(FibPathFlags, 'FIB_PATH_FLAG_NONE').value,
538 FibPathNhProto, 'FIB_PATH_NH_PROTO_IP6'
539 if net_addr.version == 6
540 else 'FIB_PATH_NH_PROTO_IP4').value,
543 label_stack=list(0 for _ in range(16))
548 table_id=int(kwargs.get('vrf', 0)),
556 def vpp_route_add(node, network, prefix_len, **kwargs):
557 """Add route to the VPP node.
559 :param node: VPP node.
560 :param network: Route destination network address.
561 :param prefix_len: Route destination network prefix length.
562 :param kwargs: Optional key-value arguments:
564 gateway: Route gateway address. (str)
565 interface: Route interface. (str)
566 vrf: VRF table ID. (int)
567 count: number of IP addresses to add starting from network IP (int)
568 local: The route is local with same prefix (increment is 1).
569 If None, then is not used. (bool)
570 lookup_vrf: VRF table ID for lookup. (int)
571 multipath: Enable multipath routing. (bool)
572 weight: Weight value for unequal cost multipath routing. (int)
576 :type prefix_len: int
579 count = kwargs.get("count", 1)
582 gateway = kwargs.get("gateway", '')
583 interface = kwargs.get("interface", '')
584 vrf = kwargs.get("vrf", None)
585 multipath = kwargs.get("multipath", False)
587 with VatTerminal(node, json_param=False) as vat:
588 vat.vat_terminal_exec_cmd_from_template(
591 prefix_length=prefix_len,
592 via='via {}'.format(gateway) if gateway else '',
593 sw_if_index='sw_if_index {}'.format(
594 InterfaceUtil.get_interface_index(node, interface))
595 if interface else '',
596 vrf='vrf {}'.format(vrf) if vrf else '',
597 count='count {}'.format(count) if count else '',
598 multipath='multipath' if multipath else '')
601 net_addr = ip_address(unicode(network))
602 cmd = 'ip_route_add_del'
605 is_multipath=int(kwargs.get('multipath', False)),
609 err_msg = 'Failed to add route(s) on host {host}'.format(
611 with PapiSocketExecutor(node) as papi_exec:
612 for i in xrange(kwargs.get('count', 1)):
613 args['route'] = IPUtil.compose_vpp_route_structure(
614 node, net_addr + i, prefix_len, **kwargs)
615 history = False if 1 < i < kwargs.get('count', 1) else True
616 papi_exec.add(cmd, history=history, **args)
617 papi_exec.get_replies(err_msg)
620 def flush_ip_addresses(node, interface):
621 """Flush all IP addresses from specified interface.
623 :param node: VPP node.
624 :param interface: Interface name.
628 cmd = 'sw_interface_add_del_address'
630 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
634 err_msg = 'Failed to flush IP address on interface {ifc}'.format(
636 with PapiSocketExecutor(node) as papi_exec:
637 papi_exec.add(cmd, **args).get_reply(err_msg)
640 def add_fib_table(node, table_id, ipv6=False):
641 """Create new FIB table according to ID.
643 :param node: Node to add FIB on.
644 :param table_id: FIB table ID.
645 :param ipv6: Is this an IPv6 table
650 cmd = 'ip_table_add_del'
652 table_id=int(table_id),
657 err_msg = 'Failed to add FIB table on host {host}'.format(
659 with PapiSocketExecutor(node) as papi_exec:
660 papi_exec.add(cmd, **args).get_reply(err_msg)