1 # Copyright (c) 2016 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 """Interface util library"""
16 from time import time, sleep
18 from robot.api import logger
20 from resources.libraries.python.ssh import SSH
21 from resources.libraries.python.IPUtil import convert_ipv4_netmask_prefix
22 from resources.libraries.python.ssh import exec_cmd_no_error
23 from resources.libraries.python.topology import NodeType, Topology
24 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
25 from resources.libraries.python.VatJsonUtil import VatJsonUtil
26 from resources.libraries.python.parsers.JsonParser import JsonParser
29 class InterfaceUtil(object):
30 """General utilities for managing interfaces"""
32 __UDEV_IF_RULES_FILE = '/etc/udev/rules.d/10-network.rules'
35 def set_interface_state(node, interface, state, if_type="key"):
36 """Set interface state on a node.
38 Function can be used for DUTs as well as for TGs.
40 :param node: Node where the interface is.
41 :param interface: Interface key or sw_if_index or name.
42 :param state: One of 'up' or 'down'.
43 :param if_type: Interface type
45 :type interface: str or int
52 if isinstance(interface, basestring):
53 sw_if_index = Topology.get_interface_sw_index(node, interface)
54 iface_name = Topology.get_interface_name(node, interface)
56 sw_if_index = interface
57 elif if_type == "name":
58 iface_key = Topology.get_interface_by_name(node, interface)
59 if iface_key is not None:
60 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
61 iface_name = interface
63 raise ValueError("if_type unknown: {}".format(if_type))
65 if node['type'] == NodeType.DUT:
71 raise ValueError('Unexpected interface state: {}'.format(state))
72 VatExecutor.cmd_from_template(node, 'set_if_state.vat',
73 sw_if_index=sw_if_index, state=state)
74 elif node['type'] == NodeType.TG or node['type'] == NodeType.VM:
75 cmd = 'ip link set {} {}'.format(iface_name, state)
76 exec_cmd_no_error(node, cmd, sudo=True)
78 raise Exception('Node {} has unknown NodeType: "{}"'.
79 format(node['host'], node['type']))
82 def set_interface_ethernet_mtu(node, iface_key, mtu):
83 """Set Ethernet MTU for specified interface.
85 Function can be used only for TGs.
87 :param node: Node where the interface is.
88 :param interface: Interface key from topology file.
89 :param mtu: MTU to set.
95 if node['type'] == NodeType.DUT:
96 ValueError('Node {}: Setting Ethernet MTU for interface '
97 'on DUT nodes not supported', node['host'])
98 elif node['type'] == NodeType.TG:
99 iface_name = Topology.get_interface_name(node, iface_key)
100 cmd = 'ip link set {} mtu {}'.format(iface_name, mtu)
101 exec_cmd_no_error(node, cmd, sudo=True)
103 raise ValueError('Node {} has unknown NodeType: "{}"'.
104 format(node['host'], node['type']))
107 def set_default_ethernet_mtu_on_all_interfaces_on_node(node):
108 """Set default Ethernet MTU on all interfaces on node.
110 Function can be used only for TGs.
112 :param node: Node where to set default MTU.
116 for ifc in node['interfaces']:
117 InterfaceUtil.set_interface_ethernet_mtu(node, ifc, 1500)
120 def vpp_node_interfaces_ready_wait(node, timeout=10):
121 """Wait until all interfaces with admin-up are in link-up state.
123 :param node: Node to wait on.
124 :param timeout: Waiting timeout in seconds (optional, default 10s).
127 :raises: RuntimeError if the timeout period value has elapsed.
133 out = InterfaceUtil.vpp_get_interface_data(node)
134 if time() - start > timeout:
135 for interface in out:
136 if interface.get('admin_up_down') == 1:
137 if interface.get('link_up_down') != 1:
138 logger.debug('{0} link-down'.format(
139 interface.get('interface_name')))
140 raise RuntimeError('timeout, not up {0}'.format(not_ready))
142 for interface in out:
143 if interface.get('admin_up_down') == 1:
144 if interface.get('link_up_down') != 1:
145 not_ready.append(interface.get('interface_name'))
149 logger.debug('Interfaces still in link-down state: {0}, '
150 'waiting...'.format(not_ready))
154 def vpp_nodes_interfaces_ready_wait(nodes, timeout=10):
155 """Wait until all interfaces with admin-up are in link-up state for
158 :param nodes: List of nodes to wait on.
159 :param timeout: Seconds to wait per node for all interfaces to come up.
162 :raises: RuntimeError if the timeout period value has elapsed.
165 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
168 def all_vpp_interfaces_ready_wait(nodes, timeout=10):
169 """Wait until all interfaces with admin-up are in link-up state for all
170 nodes in the topology.
172 :param nodes: Nodes in the topology.
173 :param timeout: Seconds to wait per node for all interfaces to come up.
176 :raises: RuntimeError if the timeout period value has elapsed.
178 for node in nodes.values():
179 if node['type'] == NodeType.DUT:
180 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
183 def vpp_get_interface_data(node, interface=None):
184 """Get all interface data from a VPP node. If a name or
185 sw_interface_index is provided, return only data for the matching
188 :param node: VPP node to get interface data from.
189 :param interface: Numeric index or name string of a specific interface.
191 :type interface: int or str
192 :return: List of dictionaries containing data for each interface, or a
193 single dictionary for the specified interface.
196 with VatTerminal(node) as vat:
197 response = vat.vat_terminal_exec_cmd_from_template(
198 "interface_dump.vat")
202 if interface is not None:
203 if isinstance(interface, basestring):
204 param = "interface_name"
205 elif isinstance(interface, int):
206 param = "sw_if_index"
210 if data_if[param] == interface:
216 def vpp_get_interface_ip_addresses(node, interface, ip_version):
217 """Get list of IP addresses from an interface on a VPP node.
219 :param node: VPP node to get data from.
220 :param interface: Name of an interface on the VPP node.
221 :param ip_version: IP protocol version (ipv4 or ipv6).
224 :type ip_version: str
225 :return: List of dictionaries, each containing IP address, subnet
226 prefix length and also the subnet mask for ipv4 addresses.
227 Note: A single interface may have multiple IP addresses assigned.
230 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
232 with VatTerminal(node) as vat:
233 response = vat.vat_terminal_exec_cmd_from_template(
234 "ip_address_dump.vat", ip_version=ip_version,
235 sw_if_index=sw_if_index)
239 if ip_version == "ipv4":
241 item["netmask"] = convert_ipv4_netmask_prefix(
242 item["prefix_length"])
246 def tg_set_interface_driver(node, pci_addr, driver):
247 """Set interface driver on the TG node.
249 :param node: Node to set interface driver on (must be TG node).
250 :param pci_addr: PCI address of the interface.
251 :param driver: Driver name.
256 old_driver = InterfaceUtil.tg_get_interface_driver(node, pci_addr)
257 if old_driver == driver:
263 # Unbind from current driver
264 if old_driver is not None:
265 cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/unbind"'.format(
266 pci_addr, old_driver)
267 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
268 if int(ret_code) != 0:
269 raise Exception("'{0}' failed on '{1}'".format(cmd,
272 # Bind to the new driver
273 cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/bind"'.format(
275 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
276 if int(ret_code) != 0:
277 raise Exception("'{0}' failed on '{1}'".format(cmd, node['host']))
280 def tg_get_interface_driver(node, pci_addr):
281 """Get interface driver from the TG node.
283 :param node: Node to get interface driver on (must be TG node).
284 :param pci_addr: PCI address of the interface.
287 :return: Interface driver or None if not found.
291 # lspci -vmmks 0000:00:05.0
293 Class: Ethernet controller
295 Device: Virtio network device
296 SVendor: Red Hat, Inc
304 cmd = 'lspci -vmmks {0}'.format(pci_addr)
306 (ret_code, stdout, _) = ssh.exec_command(cmd)
307 if int(ret_code) != 0:
308 raise Exception("'{0}' failed on '{1}'".format(cmd, node['host']))
310 for line in stdout.splitlines():
313 (name, value) = line.split("\t", 1)
314 if name == 'Driver:':
320 def tg_set_interfaces_udev_rules(node):
321 """Set udev rules for interfaces.
323 Create udev rules file in /etc/udev/rules.d where are rules for each
324 interface used by TG node, based on MAC interface has specific name.
325 So after unbind and bind again to kernel driver interface has same
326 name as before. This must be called after TG has set name for each
327 port in topology dictionary.
329 SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="52:54:00:e1:8a:0f",
332 :param node: Node to set udev rules on (must be TG node).
338 cmd = 'rm -f {0}'.format(InterfaceUtil.__UDEV_IF_RULES_FILE)
339 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
340 if int(ret_code) != 0:
341 raise Exception("'{0}' failed on '{1}'".format(cmd, node['host']))
343 for interface in node['interfaces'].values():
344 rule = 'SUBSYSTEM==\\"net\\", ACTION==\\"add\\", ATTR{address}' + \
345 '==\\"' + interface['mac_address'] + '\\", NAME=\\"' + \
346 interface['name'] + '\\"'
347 cmd = 'sh -c "echo \'{0}\' >> {1}"'.format(
348 rule, InterfaceUtil.__UDEV_IF_RULES_FILE)
349 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
350 if int(ret_code) != 0:
351 raise Exception("'{0}' failed on '{1}'".format(cmd,
354 cmd = '/etc/init.d/udev restart'
355 ssh.exec_command_sudo(cmd)
358 def tg_set_interfaces_default_driver(node):
359 """Set interfaces default driver specified in topology yaml file.
361 :param node: Node to setup interfaces driver on (must be TG node).
364 for interface in node['interfaces'].values():
365 InterfaceUtil.tg_set_interface_driver(node,
366 interface['pci_address'],
370 def update_vpp_interface_data_on_node(node):
371 """Update vpp generated interface data for a given node in DICT__nodes.
373 Updates interface names, software if index numbers and any other details
374 generated specifically by vpp that are unknown before testcase run.
375 It does this by dumping interface list to JSON output from all
376 devices using vpp_api_test, and pairing known information from topology
377 (mac address/pci address of interface) to state from VPP.
379 :param node: Node selected from DICT__nodes.
382 vat_executor = VatExecutor()
383 vat_executor.execute_script_json_out("dump_interfaces.vat", node)
384 interface_dump_json = vat_executor.get_script_stdout()
385 VatJsonUtil.update_vpp_interface_data_from_json(node,
389 def update_tg_interface_data_on_node(node):
390 """Update interface name for TG/linux node in DICT__nodes.
392 :param node: Node selected from DICT__nodes.
396 # for dev in `ls /sys/class/net/`;
397 > do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
398 "52:54:00:9f:82:63": "eth0"
399 "52:54:00:77:ae:a9": "eth1"
400 "52:54:00:e1:8a:0f": "eth2"
401 "00:00:00:00:00:00": "lo"
403 .. todo:: parse lshw -json instead
405 # First setup interface driver specified in yaml file
406 InterfaceUtil.tg_set_interfaces_default_driver(node)
408 # Get interface names
412 cmd = ('for dev in `ls /sys/class/net/`; do echo "\\"`cat '
413 '/sys/class/net/$dev/address`\\": \\"$dev\\""; done;')
415 (ret_code, stdout, _) = ssh.exec_command(cmd)
416 if int(ret_code) != 0:
417 raise Exception('Get interface name and MAC failed')
418 tmp = "{" + stdout.rstrip().replace('\n', ',') + "}"
419 interfaces = JsonParser().parse_data(tmp)
420 for interface in node['interfaces'].values():
421 name = interfaces.get(interface['mac_address'])
424 interface['name'] = name
426 # Set udev rules for interfaces
427 InterfaceUtil.tg_set_interfaces_udev_rules(node)
430 def update_all_interface_data_on_all_nodes(nodes):
431 """Update interface names on all nodes in DICT__nodes.
433 This method updates the topology dictionary by querying interface lists
434 of all nodes mentioned in the topology dictionary.
436 :param nodes: Nodes in the topology.
439 for node_data in nodes.values():
440 if node_data['type'] == NodeType.DUT:
441 InterfaceUtil.update_vpp_interface_data_on_node(node_data)
442 elif node_data['type'] == NodeType.TG:
443 InterfaceUtil.update_tg_interface_data_on_node(node_data)
446 def create_vlan_subinterface(node, interface, vlan):
447 """Create VLAN subinterface on node.
449 :param node: Node to add VLAN subinterface on.
450 :param interface: Interface name on which create VLAN subinterface.
451 :param vlan: VLAN ID of the subinterface to be created.
455 :return: Name and index of created subinterface.
458 iface_key = Topology.get_interface_by_name(node, interface)
459 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
461 output = VatExecutor.cmd_from_template(node, "create_vlan_subif.vat",
462 sw_if_index=sw_if_index,
464 if output[0]["retval"] == 0:
465 sw_subif_index = output[0]["sw_if_index"]
466 logger.trace('VLAN subinterface with sw_if_index {} and VLAN ID {} '
467 'created on node {}'.format(sw_subif_index,
470 raise RuntimeError('Unable to create VLAN subinterface on node {}'
471 .format(node['host']))
473 with VatTerminal(node, False) as vat:
474 vat.vat_terminal_exec_cmd('exec show interfaces')
476 return '{}.{}'.format(interface, vlan), sw_subif_index
479 def create_vxlan_interface(node, vni, source_ip, destination_ip):
480 """Create VXLAN interface and return sw if index of created interface.
482 Executes "vxlan_add_del_tunnel src {src} dst {dst} vni {vni}" VAT
485 :param node: Node where to create VXLAN interface.
486 :param vni: VXLAN Network Identifier.
487 :param source_ip: Source IP of a VXLAN Tunnel End Point.
488 :param destination_ip: Destination IP of a VXLAN Tunnel End Point.
492 :type destination_ip: str
493 :return: SW IF INDEX of created interface.
496 output = VatExecutor.cmd_from_template(node, "vxlan_create.vat",
502 if output["retval"] == 0:
503 return output["sw_if_index"]
505 raise RuntimeError('Unable to create VXLAN interface on node {0}'
509 def vxlan_dump(node, interface=None):
510 """Get VxLAN data for the given interface.
512 :param node: VPP node to get interface data from.
513 :param interface: Numeric index or name string of a specific interface.
514 If None, information about all VxLAN interfaces is returned.
516 :type interface: int or str
517 :return: Dictionary containing data for the given VxLAN interface or if
518 interface=None, the list of dictionaries with all VxLAN interfaces.
521 param = "sw_if_index"
522 if interface is None:
525 elif isinstance(interface, basestring):
526 sw_if_index = Topology.get_interface_sw_index(node, interface)
527 elif isinstance(interface, int):
528 sw_if_index = interface
530 raise Exception("Wrong interface format {0}".format(interface))
532 with VatTerminal(node) as vat:
533 response = vat.vat_terminal_exec_cmd_from_template(
534 "vxlan_dump.vat", param=param, sw_if_index=sw_if_index)
537 for vxlan in response[0]:
538 if vxlan["sw_if_index"] == sw_if_index:
544 def vhost_user_dump(node):
545 """Get vhost-user data for the given node.
547 :param node: VPP node to get interface data from.
549 :return: List of dictionaries with all vhost-user interfaces.
552 with VatTerminal(node) as vat:
553 response = vat.vat_terminal_exec_cmd_from_template(
554 "vhost_user_dump.vat")
559 def tap_dump(node, name=None):
560 """Get all TAP interface data from the given node, or data about
561 a specific TAP interface.
563 :param node: VPP node to get data from.
564 :param name: Optional name of a specific TAP interface.
567 :return: Dictionary of information about a specific TAP interface, or
568 a List of dictionaries containing all TAP data for the given node.
571 with VatTerminal(node) as vat:
572 response = vat.vat_terminal_exec_cmd_from_template(
577 for item in response[0]:
578 if name == item['dev_name']:
583 def create_subinterface(node, interface, sub_id, outer_vlan_id=None,
584 inner_vlan_id=None, type_subif=None):
585 """Create sub-interface on node. It is possible to set required
586 sub-interface type and VLAN tag(s).
588 :param node: Node to add sub-interface.
589 :param interface: Interface name on which create sub-interface.
590 :param sub_id: ID of the sub-interface to be created.
591 :param outer_vlan_id: Optional outer VLAN ID.
592 :param inner_vlan_id: Optional inner VLAN ID.
593 :param type_subif: Optional type of sub-interface. Values supported by
594 VPP: [no_tags] [one_tag] [two_tags] [dot1ad] [exact_match] [default_sub]
596 :type interface: str or int
598 :type outer_vlan_id: int
599 :type inner_vlan_id: int
600 :type type_subif: str
601 :return: Name and index of created sub-interface.
603 :raises RuntimeError: If it is not possible to create sub-interface.
606 outer_vlan_id = 'outer_vlan_id {0}'.format(outer_vlan_id)\
607 if outer_vlan_id else ''
609 inner_vlan_id = 'inner_vlan_id {0}'.format(inner_vlan_id)\
610 if inner_vlan_id else ''
612 if type_subif is None:
615 if isinstance(interface, basestring):
616 iface_key = Topology.get_interface_by_name(node, interface)
617 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
619 sw_if_index = interface
621 output = VatExecutor.cmd_from_template(node, "create_sub_interface.vat",
622 sw_if_index=sw_if_index,
624 outer_vlan_id=outer_vlan_id,
625 inner_vlan_id=inner_vlan_id,
626 type_subif=type_subif)
628 if output[0]["retval"] == 0:
629 sw_subif_index = output[0]["sw_if_index"]
630 logger.trace('Created subinterface with index {}'
631 .format(sw_subif_index))
633 raise RuntimeError('Unable to create sub-interface on node {}'
634 .format(node['host']))
636 with VatTerminal(node, json_param=False) as vat:
637 vat.vat_terminal_exec_cmd('exec show interfaces')
639 name = '{}.{}'.format(interface, sub_id)
640 return name, sw_subif_index
643 def create_gre_tunnel_interface(node, source_ip, destination_ip):
644 """Create GRE tunnel interface on node.
646 :param node: VPP node to add tunnel interface.
647 :param source_ip: Source of the GRE tunnel.
648 :param destination_ip: Destination of the GRE tunnel.
651 :type destination_ip: str
652 :return: Name and index of created GRE tunnel interface.
654 :raises RuntimeError: If unable to create GRE tunnel interface.
656 output = VatExecutor.cmd_from_template(node, "create_gre.vat",
661 if output["retval"] == 0:
662 sw_if_index = output["sw_if_index"]
664 vat_executor = VatExecutor()
665 vat_executor.execute_script_json_out("dump_interfaces.vat", node)
666 interface_dump_json = vat_executor.get_script_stdout()
667 name = VatJsonUtil.get_interface_name_from_json(
668 interface_dump_json, sw_if_index)
669 return name, sw_if_index
671 raise RuntimeError('Unable to create GRE tunnel on node {}.'
675 def vpp_create_loopback(node):
676 """Create loopback interface on VPP node.
678 :param node: Node to create loopback interface on.
680 :return: SW interface index.
683 out = VatExecutor.cmd_from_template(node, "create_loopback.vat")
684 if out[0].get('retval') == 0:
685 return out[0].get('sw_if_index')
687 raise RuntimeError('Create loopback failed on node "{}"'
688 .format(node['host']))
691 def vpp_enable_input_acl_interface(node, interface, ip_version,
693 """Enable input acl on interface.
695 :param node: VPP node to setup interface for input acl.
696 :param interface: Interface to setup input acl.
697 :param ip_version: Version of IP protocol.
698 :param table_index: Classify table index.
700 :type interface: str or int
701 :type ip_version: str
702 :type table_index: int
704 if isinstance(interface, basestring):
705 sw_if_index = Topology.get_interface_sw_index(node, interface)
707 sw_if_index = interface
709 with VatTerminal(node) as vat:
710 vat.vat_terminal_exec_cmd_from_template("input_acl_int.vat",
711 sw_if_index=sw_if_index,
712 ip_version=ip_version,
713 table_index=table_index)
716 def get_sw_if_index(node, interface_name):
717 """Get sw_if_index for the given interface from actual interface dump.
719 :param node: VPP node to get interface data from.
720 :param interface_name: Name of the specific interface.
722 :type interface_name: str
723 :return: sw_if_index of the given interface.
727 with VatTerminal(node) as vat:
728 if_data = vat.vat_terminal_exec_cmd_from_template(
729 "interface_dump.vat")
730 for interface in if_data[0]:
731 if interface["interface_name"] == interface_name:
732 return interface["sw_if_index"]
737 def vxlan_gpe_dump(node, interface_name=None):
738 """Get VxLAN GPE data for the given interface.
740 :param node: VPP node to get interface data from.
741 :param interface_name: Name of the specific interface. If None,
742 information about all VxLAN GPE interfaces is returned.
744 :type interface_name: str
745 :return: Dictionary containing data for the given VxLAN GPE interface or
746 if interface=None, the list of dictionaries with all VxLAN GPE
751 with VatTerminal(node) as vat:
752 vxlan_gpe_data = vat.vat_terminal_exec_cmd_from_template(
753 "vxlan_gpe_dump.vat")
756 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface_name)
758 for vxlan_gpe in vxlan_gpe_data[0]:
759 if vxlan_gpe["sw_if_index"] == sw_if_index:
763 return vxlan_gpe_data[0]
766 def vpp_proxy_arp_interface_enable(node, interface):
767 """Enable proxy ARP on interface.
769 :param node: VPP node to enable proxy ARP on interface.
770 :param interface: Interface to enable proxy ARP.
772 :type interface: str or int
774 if isinstance(interface, basestring):
775 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
777 sw_if_index = interface
779 with VatTerminal(node) as vat:
780 vat.vat_terminal_exec_cmd_from_template(
781 "proxy_arp_intfc_enable.vat",
782 sw_if_index=sw_if_index)