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, IPv4Network, IPv6Network
21 from resources.libraries.python.Constants import Constants
22 from resources.libraries.python.InterfaceUtil import InterfaceUtil
23 from resources.libraries.python.PapiExecutor import PapiExecutor
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
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)
116 is_ipv6 = 1 if ip_version == 'ipv6' else 0
118 cmd = 'ip_address_dump'
119 args = dict(sw_if_index=sw_if_index,
121 err_msg = 'Failed to get L2FIB dump on host {host}'.format(
124 with PapiExecutor(node) as papi_exec:
125 details = papi_exec.add(cmd, **args).get_details(err_msg)
128 item['ip'] = item['prefix'].split('/')[0]
129 item['prefix_length'] = int(item['prefix'].split('/')[1])
130 item['is_ipv6'] = is_ipv6
132 str(IPv6Network(unicode('::/{pl}'.format(
133 pl=item['prefix_length']))).netmask) \
135 else str(IPv4Network(unicode('0.0.0.0/{pl}'.format(
136 pl=item['prefix_length']))).netmask)
141 def vpp_get_ip_tables(node):
142 """Get dump of all IP FIB tables on a VPP node.
144 :param node: VPP node.
148 PapiExecutor.run_cli_cmd(node, 'show ip fib')
149 PapiExecutor.run_cli_cmd(node, 'show ip fib summary')
150 PapiExecutor.run_cli_cmd(node, 'show ip6 fib')
151 PapiExecutor.run_cli_cmd(node, 'show ip6 fib summary')
154 def vpp_get_ip_tables_prefix(node, address):
155 """Get dump of all IP FIB tables on a VPP node.
157 :param node: VPP node.
160 addr = ip_address(unicode(address))
162 PapiExecutor.run_cli_cmd(
163 node, 'show {ip_ver} fib {addr}/{addr_len}'.format(
164 ip_ver='ip6' if addr.version == 6 else 'ip',
166 addr_len=addr.max_prefixlen))
169 def get_interface_vrf_table(node, interface, ip_version='ipv4'):
170 """Get vrf ID for the given interface.
172 :param node: VPP node.
173 :param interface: Name or sw_if_index of a specific interface.
175 :param ip_version: IP protocol version (ipv4 or ipv6).
176 :type interface: str or int
177 :type ip_version: str
178 :returns: vrf ID of the specified interface.
181 sw_if_index = InterfaceUtil.get_interface_index(node, interface)
183 is_ipv6 = 1 if ip_version == 'ipv6' else 0
185 cmd = 'sw_interface_get_table'
186 args = dict(sw_if_index=sw_if_index,
188 err_msg = 'Failed to get VRF id assigned to interface {ifc}'.format(
191 with PapiExecutor(node) as papi_exec:
192 reply = papi_exec.add(cmd, **args).get_reply(err_msg)
194 return reply['vrf_id']
197 def vpp_ip_source_check_setup(node, if_name):
198 """Setup Reverse Path Forwarding source check on interface.
200 :param node: VPP node.
201 :param if_name: Interface name to setup RPF source check.
205 cmd = 'ip_source_check_interface_add_del'
207 sw_if_index=InterfaceUtil.get_interface_index(node, if_name),
210 err_msg = 'Failed to enable source check on interface {ifc}'.format(
212 with PapiExecutor(node) as papi_exec:
213 papi_exec.add(cmd, **args).get_reply(err_msg)
216 def vpp_ip_probe(node, interface, addr):
217 """Run ip probe on VPP node.
219 :param node: VPP node.
220 :param interface: Interface key or name.
221 :param addr: IPv4/IPv6 address.
226 cmd = 'ip_probe_neighbor'
228 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
230 err_msg = 'VPP ip probe {dev} {ip} failed on {h}'.format(
231 dev=interface, ip=addr, h=node['host'])
233 with PapiExecutor(node) as papi_exec:
234 papi_exec.add(cmd, **args).get_reply(err_msg)
237 def ip_addresses_should_be_equal(ip1, ip2):
238 """Fails if the given IP addresses are unequal.
240 :param ip1: IPv4 or IPv6 address.
241 :param ip2: IPv4 or IPv6 address.
245 addr1 = ip_address(unicode(ip1))
246 addr2 = ip_address(unicode(ip2))
249 raise AssertionError('IP addresses are not equal: {0} != {1}'.
253 def setup_network_namespace(node, namespace_name, interface_name,
255 """Setup namespace on given node and attach interface and IP to
256 this namespace. Applicable also on TG node.
258 :param node: VPP node.
259 :param namespace_name: Namespace name.
260 :param interface_name: Interface name.
261 :param ip_addr: IP address of namespace's interface.
262 :param prefix: IP address prefix length.
264 :type namespace_name: str
265 :type interface_name: str
269 cmd = ('ip netns add {0}'.format(namespace_name))
270 exec_cmd_no_error(node, cmd, sudo=True)
272 cmd = ('ip link set dev {0} up netns {1}'.format(interface_name,
274 exec_cmd_no_error(node, cmd, sudo=True)
276 cmd = ('ip netns exec {0} ip addr add {1}/{2} dev {3}'.format(
277 namespace_name, ip_addr, prefix, interface_name))
278 exec_cmd_no_error(node, cmd, sudo=True)
281 def linux_enable_forwarding(node, ip_ver='ipv4'):
282 """Enable forwarding on a Linux node, e.g. VM.
284 :param node: VPP node.
285 :param ip_ver: IP version, 'ipv4' or 'ipv6'.
289 cmd = 'sysctl -w net.{0}.ip_forward=1'.format(ip_ver)
290 exec_cmd_no_error(node, cmd, sudo=True)
293 def get_linux_interface_name(node, pci_addr):
294 """Get the interface name.
296 :param node: VPP/TG node.
297 :param pci_addr: PCI address
300 :returns: Interface name
302 :raises RuntimeError: If cannot get the information about interfaces.
304 regex_intf_info = r"pci@" \
305 r"([0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}.[0-9a-f])\s*" \
306 r"([a-zA-Z0-9]*)\s*network"
308 cmd = "lshw -class network -businfo"
309 ret_code, stdout, stderr = exec_cmd(node, cmd, timeout=30, sudo=True)
311 raise RuntimeError('Could not get information about interfaces:\n'
312 '{err}'.format(err=stderr))
314 for line in stdout.splitlines()[2:]:
316 if re.search(regex_intf_info, line).group(1) == pci_addr:
317 return re.search(regex_intf_info, line).group(2)
318 except AttributeError:
323 def set_linux_interface_up(node, interface):
324 """Set the specified interface up.
326 :param node: VPP/TG node.
327 :param interface: Interface in namespace.
330 :raises RuntimeError: If the interface could not be set up.
332 cmd = "ip link set {0} up".format(interface)
333 exec_cmd_no_error(node, cmd, timeout=30, sudo=True)
336 def set_linux_interface_ip(node, interface, ip_addr, prefix,
338 """Set IP address to interface in linux.
340 :param node: VPP/TG node.
341 :param interface: Interface in namespace.
342 :param ip_addr: IP to be set on interface.
343 :param prefix: IP prefix.
344 :param namespace: Execute command in namespace. Optional
350 :raises RuntimeError: IP could not be set.
352 if namespace is not None:
353 cmd = 'ip netns exec {ns} ip addr add {ip}/{p} dev {dev}'.format(
354 ns=namespace, ip=ip_addr, p=prefix, dev=interface)
356 cmd = 'ip addr add {ip}/{p} dev {dev}'.format(
357 ip=ip_addr, p=prefix, dev=interface)
359 exec_cmd_no_error(node, cmd, timeout=5, sudo=True)
362 def add_linux_route(node, ip_addr, prefix, gateway, namespace=None):
363 """Add linux route in namespace.
365 :param node: Node where to execute command.
366 :param ip_addr: Route destination IP address.
367 :param prefix: IP prefix.
368 :param namespace: Execute command in namespace. Optional.
369 :param gateway: Gateway address.
376 if namespace is not None:
377 cmd = 'ip netns exec {} ip route add {}/{} via {}'.format(
378 namespace, ip_addr, prefix, gateway)
380 cmd = 'ip route add {}/{} via {}'.format(ip_addr, prefix, gateway)
381 exec_cmd_no_error(node, cmd, sudo=True)
384 def vpp_interface_set_ip_address(node, interface, address,
386 """Set IP address to VPP interface.
388 :param node: VPP node.
389 :param interface: Interface name.
390 :param address: IP address.
391 :param prefix_length: Prefix length.
395 :type prefix_length: int
397 ip_addr = ip_address(unicode(address))
399 cmd = 'sw_interface_add_del_address'
401 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
403 is_ipv6=1 if ip_addr.version == 6 else 0,
405 address_length=int(prefix_length) if prefix_length else 128
406 if ip_addr.version == 6 else 32,
407 address=ip_addr.packed)
408 err_msg = 'Failed to add IP address on interface {ifc}'.format(
410 with PapiExecutor(node) as papi_exec:
411 papi_exec.add(cmd, **args).get_reply(err_msg)
414 def vpp_add_ip_neighbor(node, iface_key, ip_addr, mac_address):
415 """Add IP neighbor on DUT node.
417 :param node: VPP node.
418 :param iface_key: Interface key.
419 :param ip_addr: IP address of the interface.
420 :param mac_address: MAC address of the interface.
424 :type mac_address: str
426 dst_ip = ip_address(unicode(ip_addr))
429 sw_if_index=Topology.get_interface_sw_index(node, iface_key),
431 mac_address=str(mac_address),
432 ip_address=str(dst_ip))
433 cmd = 'ip_neighbor_add_del'
437 err_msg = 'Failed to add IP neighbor on interface {ifc}'.format(
439 with PapiExecutor(node) as papi_exec:
440 papi_exec.add(cmd, **args).get_reply(err_msg)
443 def union_addr(ip_addr):
444 """Creates union IP address.
446 :param ip_addr: IPv4 or IPv6 address.
447 :type ip_addr: IPv4Address or IPv6Address
448 :returns: Union IP address.
451 return dict(ip6=ip_addr.packed) if ip_addr.version == 6 \
452 else dict(ip4=ip_addr.packed)
455 def compose_vpp_route_structure(node, network, prefix_len, **kwargs):
456 """Create route object for ip_route_add_del api call.
458 :param node: VPP node.
459 :param network: Route destination network address.
460 :param prefix_len: Route destination network prefix length.
461 :param kwargs: Optional key-value arguments:
463 gateway: Route gateway address. (str)
464 interface: Route interface. (str)
465 vrf: VRF table ID. (int)
466 count: number of IP addresses to add starting from network IP (int)
467 local: The route is local with same prefix (increment is 1).
468 If None, then is not used. (bool)
469 lookup_vrf: VRF table ID for lookup. (int)
470 multipath: Enable multipath routing. (bool)
471 weight: Weight value for unequal cost multipath routing. (int)
475 :type prefix_len: int
477 :returns: route parameter basic structure
480 interface = kwargs.get('interface', '')
481 gateway = kwargs.get('gateway', '')
483 net_addr = ip_address(unicode(network))
487 AddressFamily, 'ADDRESS_IP6' if net_addr.version == 6
488 else 'ADDRESS_IP4').value,
496 address=IPUtil.union_addr(ip_address(unicode(gateway))) if gateway
498 via_label=MPLS_LABEL_INVALID,
499 obj_id=Constants.BITWISE_NON_ZERO)
501 sw_if_index=InterfaceUtil.get_interface_index(node, interface)
502 if interface else Constants.BITWISE_NON_ZERO,
503 table_id=int(kwargs.get('lookup_vrf', 0)),
504 rpf_id=Constants.BITWISE_NON_ZERO,
505 weight=int(kwargs.get('weight', 1)),
508 FibPathType, 'FIB_PATH_TYPE_LOCAL'
509 if kwargs.get('local', False)
510 else 'FIB_PATH_TYPE_NORMAL').value,
511 flags=getattr(FibPathFlags, 'FIB_PATH_FLAG_NONE').value,
513 FibPathNhProto, 'FIB_PATH_NH_PROTO_IP6'
514 if net_addr.version == 6
515 else 'FIB_PATH_NH_PROTO_IP4').value,
518 label_stack=list(0 for _ in range(16)))
522 table_id=int(kwargs.get('vrf', 0)),
530 def vpp_route_add(node, network, prefix_len, **kwargs):
531 """Add route to the VPP node.
533 :param node: VPP node.
534 :param network: Route destination network address.
535 :param prefix_len: Route destination network prefix length.
536 :param kwargs: Optional key-value arguments:
538 gateway: Route gateway address. (str)
539 interface: Route interface. (str)
540 vrf: VRF table ID. (int)
541 count: number of IP addresses to add starting from network IP (int)
542 local: The route is local with same prefix (increment is 1).
543 If None, then is not used. (bool)
544 lookup_vrf: VRF table ID for lookup. (int)
545 multipath: Enable multipath routing. (bool)
546 weight: Weight value for unequal cost multipath routing. (int)
550 :type prefix_len: int
553 count = kwargs.get("count", 1)
556 gateway = kwargs.get("gateway", '')
557 interface = kwargs.get("interface", '')
558 vrf = kwargs.get("vrf", None)
559 multipath = kwargs.get("multipath", False)
561 with VatTerminal(node, json_param=False) as vat:
562 vat.vat_terminal_exec_cmd_from_template(
565 prefix_length=prefix_len,
566 via='via {}'.format(gateway) if gateway else '',
567 sw_if_index='sw_if_index {}'.format(
568 InterfaceUtil.get_interface_index(node, interface))
569 if interface else '',
570 vrf='vrf {}'.format(vrf) if vrf else '',
571 count='count {}'.format(count) if count else '',
572 multipath='multipath' if multipath else '')
575 net_addr = ip_address(unicode(network))
576 cmd = 'ip_route_add_del'
577 route = IPUtil.compose_vpp_route_structure(
578 node, network, prefix_len, **kwargs)
581 is_multipath=int(kwargs.get('multipath', False)),
584 err_msg = 'Failed to add route(s) on host {host}'.format(
586 with PapiExecutor(node) as papi_exec:
587 for i in xrange(kwargs.get('count', 1)):
588 args['route']['prefix']['address']['un'] = \
589 IPUtil.union_addr(net_addr + i)
590 history = False if 1 < i < kwargs.get('count', 1) else True
591 papi_exec.add(cmd, history=history, **args)
592 if i > 0 and i % Constants.PAPI_MAX_API_BULK == 0:
593 papi_exec.get_replies(err_msg)
594 papi_exec.get_replies(err_msg)
597 def flush_ip_addresses(node, interface):
598 """Flush all IP addresses from specified interface.
600 :param node: VPP node.
601 :param interface: Interface name.
605 cmd = 'sw_interface_add_del_address'
607 sw_if_index=InterfaceUtil.get_interface_index(node, interface),
609 err_msg = 'Failed to flush IP address on interface {ifc}'.format(
611 with PapiExecutor(node) as papi_exec:
612 papi_exec.add(cmd, **args).get_reply(err_msg)
615 def add_fib_table(node, table_id, ipv6=False):
616 """Create new FIB table according to ID.
618 :param node: Node to add FIB on.
619 :param table_id: FIB table ID.
620 :param ipv6: Is this an IPv6 table
625 cmd = 'ip_table_add_del'
627 table_id=int(table_id),
632 err_msg = 'Failed to add FIB table on host {host}'.format(
634 with PapiExecutor(node) as papi_exec:
635 papi_exec.add(cmd, **args).get_reply(err_msg)