resources/libraries/python/InterfaceUtil.py

   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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """Interface util library"""
  15
  16 from time import time, sleep
  17
  18 from robot.api import logger
  19
  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
  27
  28
  29 class InterfaceUtil(object):
  30     """General utilities for managing interfaces"""
  31
  32     __UDEV_IF_RULES_FILE = '/etc/udev/rules.d/10-network.rules'
  33
  34     @staticmethod
  35     def set_interface_state(node, interface, state, if_type="key"):
  36         """Set interface state on a node.
  37
  38         Function can be used for DUTs as well as for TGs.
  39
  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
  44         :type node: dict
  45         :type interface: str or int
  46         :type state: str
  47         :type if_type: str
  48         :returns: Nothing.
  49         :raises ValueError: If the interface type is unknown.
  50         :raises ValueError: If the state of interface is unexpected.
  51         :raises ValueError: If the node has an unknown node type.
  52         """
  53
  54         if if_type == "key":
  55             if isinstance(interface, basestring):
  56                 sw_if_index = Topology.get_interface_sw_index(node, interface)
  57                 iface_name = Topology.get_interface_name(node, interface)
  58             else:
  59                 sw_if_index = interface
  60         elif if_type == "name":
  61             iface_key = Topology.get_interface_by_name(node, interface)
  62             if iface_key is not None:
  63                 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
  64             iface_name = interface
  65         else:
  66             raise ValueError("if_type unknown: {}".format(if_type))
  67
  68         if node['type'] == NodeType.DUT:
  69             if state == 'up':
  70                 state = 'admin-up'
  71             elif state == 'down':
  72                 state = 'admin-down'
  73             else:
  74                 raise ValueError('Unexpected interface state: {}'.format(state))
  75             VatExecutor.cmd_from_template(node, 'set_if_state.vat',
  76                                           sw_if_index=sw_if_index, state=state)
  77         elif node['type'] == NodeType.TG or node['type'] == NodeType.VM:
  78             cmd = 'ip link set {} {}'.format(iface_name, state)
  79             exec_cmd_no_error(node, cmd, sudo=True)
  80         else:
  81             raise ValueError('Node {} has unknown NodeType: "{}"'
  82                              .format(node['host'], node['type']))
  83
  84     @staticmethod
  85     def set_interface_ethernet_mtu(node, iface_key, mtu):
  86         """Set Ethernet MTU for specified interface.
  87
  88         Function can be used only for TGs.
  89
  90         :param node: Node where the interface is.
  91         :param iface_key: Interface key from topology file.
  92         :param mtu: MTU to set.
  93         :type node: dict
  94         :type iface_key: str
  95         :type mtu: int
  96         :returns: Nothing.
  97         :raises ValueError: If the node type is "DUT".
  98         :raises ValueError: If the node has an unknown node type.
  99         """
 100         if node['type'] == NodeType.DUT:
 101             raise ValueError('Node {}: Setting Ethernet MTU for interface '
 102                              'on DUT nodes not supported', node['host'])
 103         elif node['type'] == NodeType.TG:
 104             iface_name = Topology.get_interface_name(node, iface_key)
 105             cmd = 'ip link set {} mtu {}'.format(iface_name, mtu)
 106             exec_cmd_no_error(node, cmd, sudo=True)
 107         else:
 108             raise ValueError('Node {} has unknown NodeType: "{}"'
 109                              .format(node['host'], node['type']))
 110
 111     @staticmethod
 112     def set_default_ethernet_mtu_on_all_interfaces_on_node(node):
 113         """Set default Ethernet MTU on all interfaces on node.
 114
 115         Function can be used only for TGs.
 116
 117         :param node: Node where to set default MTU.
 118         :type node: dict
 119         :returns: Nothing.
 120         """
 121         for ifc in node['interfaces']:
 122             InterfaceUtil.set_interface_ethernet_mtu(node, ifc, 1500)
 123
 124     @staticmethod
 125     def vpp_node_interfaces_ready_wait(node, timeout=10):
 126         """Wait until all interfaces with admin-up are in link-up state.
 127
 128         :param node: Node to wait on.
 129         :param timeout: Waiting timeout in seconds (optional, default 10s).
 130         :type node: dict
 131         :type timeout: int
 132         :returns: Nothing.
 133         :raises: RuntimeError if the timeout period value has elapsed.
 134         """
 135         if_ready = False
 136         not_ready = []
 137         start = time()
 138         while not if_ready:
 139             out = InterfaceUtil.vpp_get_interface_data(node)
 140             if time() - start > timeout:
 141                 for interface in out:
 142                     if interface.get('admin_up_down') == 1:
 143                         if interface.get('link_up_down') != 1:
 144                             logger.debug('{0} link-down'.format(
 145                                 interface.get('interface_name')))
 146                 raise RuntimeError('timeout, not up {0}'.format(not_ready))
 147             not_ready = []
 148             for interface in out:
 149                 if interface.get('admin_up_down') == 1:
 150                     if interface.get('link_up_down') != 1:
 151                         not_ready.append(interface.get('interface_name'))
 152             if not not_ready:
 153                 if_ready = True
 154             else:
 155                 logger.debug('Interfaces still in link-down state: {0}, '
 156                              'waiting...'.format(not_ready))
 157                 sleep(1)
 158
 159     @staticmethod
 160     def vpp_nodes_interfaces_ready_wait(nodes, timeout=10):
 161         """Wait until all interfaces with admin-up are in link-up state for
 162         listed nodes.
 163
 164         :param nodes: List of nodes to wait on.
 165         :param timeout: Seconds to wait per node for all interfaces to come up.
 166         :type nodes: list
 167         :type timeout: int
 168         :returns: Nothing.
 169         """
 170         for node in nodes:
 171             InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
 172
 173     @staticmethod
 174     def all_vpp_interfaces_ready_wait(nodes, timeout=10):
 175         """Wait until all interfaces with admin-up are in link-up state for all
 176         nodes in the topology.
 177
 178         :param nodes: Nodes in the topology.
 179         :param timeout: Seconds to wait per node for all interfaces to come up.
 180         :type nodes: dict
 181         :type timeout: int
 182         :returns: Nothing.
 183         """
 184         for node in nodes.values():
 185             if node['type'] == NodeType.DUT:
 186                 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
 187
 188     @staticmethod
 189     def vpp_get_interface_data(node, interface=None):
 190         """Get all interface data from a VPP node. If a name or
 191         sw_interface_index is provided, return only data for the matching
 192         interface.
 193
 194         :param node: VPP node to get interface data from.
 195         :param interface: Numeric index or name string of a specific interface.
 196         :type node: dict
 197         :type interface: int or str
 198         :returns: List of dictionaries containing data for each interface, or a
 199         single dictionary for the specified interface.
 200         :rtype: list or dict
 201         :raises TypeError: if the data type of interface is neither basestring
 202         nor int.
 203         """
 204         with VatTerminal(node) as vat:
 205             response = vat.vat_terminal_exec_cmd_from_template(
 206                 "interface_dump.vat")
 207
 208         data = response[0]
 209
 210         if interface is not None:
 211             if isinstance(interface, basestring):
 212                 param = "interface_name"
 213             elif isinstance(interface, int):
 214                 param = "sw_if_index"
 215             else:
 216                 raise TypeError
 217             for data_if in data:
 218                 if data_if[param] == interface:
 219                     return data_if
 220             return dict()
 221         return data
 222
 223     @staticmethod
 224     def vpp_get_interface_mac(node, interface=None):
 225         """Get MAC address for the given interface from actual interface dump.
 226
 227         :param node: VPP node to get interface data from.
 228         :param interface: Numeric index or name string of a specific interface.
 229         :type node: dict
 230         :type interface: int or str
 231         :returns: MAC address.
 232         :rtype: str
 233         """
 234
 235         if_data = InterfaceUtil.vpp_get_interface_data(node, interface)
 236         if if_data['sup_sw_if_index'] != if_data['sw_if_index']:
 237             if_data = InterfaceUtil.vpp_get_interface_data(
 238                 node, if_data['sup_sw_if_index'])
 239         mac_data = [str(hex(item))[2:] for item in if_data['l2_address'][:6]]
 240         mac_data_nice = []
 241         for item in mac_data:
 242             if len(item) == 1:
 243                 item = '0' + item
 244             mac_data_nice.append(item)
 245         mac = ":".join(mac_data_nice)
 246         return mac
 247
 248     @staticmethod
 249     def vpp_get_interface_ip_addresses(node, interface, ip_version):
 250         """Get list of IP addresses from an interface on a VPP node.
 251
 252          :param node: VPP node to get data from.
 253          :param interface: Name of an interface on the VPP node.
 254          :param ip_version: IP protocol version (ipv4 or ipv6).
 255          :type node: dict
 256          :type interface: str
 257          :type ip_version: str
 258          :returns: List of dictionaries, each containing IP address, subnet
 259          prefix length and also the subnet mask for ipv4 addresses.
 260          Note: A single interface may have multiple IP addresses assigned.
 261          :rtype: list
 262         """
 263
 264         try:
 265             sw_if_index = Topology.convert_interface_reference(
 266                 node, interface, "sw_if_index")
 267         except RuntimeError:
 268             if isinstance(interface, basestring):
 269                 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 270             else:
 271                 raise
 272
 273         with VatTerminal(node) as vat:
 274             response = vat.vat_terminal_exec_cmd_from_template(
 275                 "ip_address_dump.vat", ip_version=ip_version,
 276                 sw_if_index=sw_if_index)
 277
 278         data = response[0]
 279
 280         if ip_version == "ipv4":
 281             for item in data:
 282                 item["netmask"] = convert_ipv4_netmask_prefix(
 283                     item["prefix_length"])
 284         return data
 285
 286     @staticmethod
 287     def tg_set_interface_driver(node, pci_addr, driver):
 288         """Set interface driver on the TG node.
 289
 290         :param node: Node to set interface driver on (must be TG node).
 291         :param pci_addr: PCI address of the interface.
 292         :param driver: Driver name.
 293         :type node: dict
 294         :type pci_addr: str
 295         :type driver: str
 296         :returns: None.
 297         :raises RuntimeError: If unbinding from the current driver fails.
 298         :raises RuntimeError: If binding to the new driver fails.
 299         """
 300         old_driver = InterfaceUtil.tg_get_interface_driver(node, pci_addr)
 301         if old_driver == driver:
 302             return
 303
 304         ssh = SSH()
 305         ssh.connect(node)
 306
 307         # Unbind from current driver
 308         if old_driver is not None:
 309             cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/unbind"'\
 310                 .format(pci_addr, old_driver)
 311             (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 312             if int(ret_code) != 0:
 313                 raise RuntimeError("'{0}' failed on '{1}'"
 314                                    .format(cmd, node['host']))
 315
 316         # Bind to the new driver
 317         cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/bind"'\
 318             .format(pci_addr, driver)
 319         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 320         if int(ret_code) != 0:
 321             raise RuntimeError("'{0}' failed on '{1}'"
 322                                .format(cmd, node['host']))
 323
 324     @staticmethod
 325     def tg_get_interface_driver(node, pci_addr):
 326         """Get interface driver from the TG node.
 327
 328         :param node: Node to get interface driver on (must be TG node).
 329         :param pci_addr: PCI address of the interface.
 330         :type node: dict
 331         :type pci_addr: str
 332         :returns: Interface driver or None if not found.
 333         :rtype: str
 334         :raises RuntimeError: If it is not possible to get the interface driver
 335         information from the node.
 336
 337         .. note::
 338             # lspci -vmmks 0000:00:05.0
 339             Slot:   00:05.0
 340             Class:  Ethernet controller
 341             Vendor: Red Hat, Inc
 342             Device: Virtio network device
 343             SVendor:        Red Hat, Inc
 344             SDevice:        Device 0001
 345             PhySlot:        5
 346             Driver: virtio-pci
 347         """
 348         ssh = SSH()
 349         ssh.connect(node)
 350
 351         for i in range(3):
 352             logger.trace('Try {}: Get interface driver'.format(i))
 353             cmd = 'sh -c "echo 1 > /sys/bus/pci/rescan"'
 354             (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 355             if int(ret_code) != 0:
 356                 raise RuntimeError("'{0}' failed on '{1}'"
 357                                    .format(cmd, node['host']))
 358
 359             cmd = 'lspci -vmmks {0}'.format(pci_addr)
 360             (ret_code, stdout, _) = ssh.exec_command(cmd)
 361             if int(ret_code) != 0:
 362                 raise RuntimeError("'{0}' failed on '{1}'"
 363                                    .format(cmd, node['host']))
 364
 365             for line in stdout.splitlines():
 366                 if len(line) == 0:
 367                     continue
 368                 try:
 369                     (name, value) = line.split("\t", 1)
 370                 except ValueError:
 371                     if name != "Driver:":
 372                         pass
 373                     else:
 374                         return None
 375                 if name == 'Driver:':
 376                     return value if value else None
 377         else:
 378             raise RuntimeError('Get interface driver for: {0}'\
 379                                .format(pci_addr))
 380
 381     @staticmethod
 382     def tg_set_interfaces_udev_rules(node):
 383         """Set udev rules for interfaces.
 384
 385         Create udev rules file in /etc/udev/rules.d where are rules for each
 386         interface used by TG node, based on MAC interface has specific name.
 387         So after unbind and bind again to kernel driver interface has same
 388         name as before. This must be called after TG has set name for each
 389         port in topology dictionary.
 390         udev rule example
 391         SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="52:54:00:e1:8a:0f",
 392         NAME="eth1"
 393
 394         :param node: Node to set udev rules on (must be TG node).
 395         :type node: dict
 396         :raises RuntimeError: If setting of udev rules fails.
 397         """
 398         ssh = SSH()
 399         ssh.connect(node)
 400
 401         cmd = 'rm -f {0}'.format(InterfaceUtil.__UDEV_IF_RULES_FILE)
 402         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 403         if int(ret_code) != 0:
 404             raise RuntimeError("'{0}' failed on '{1}'"
 405                                .format(cmd, node['host']))
 406
 407         for interface in node['interfaces'].values():
 408             rule = 'SUBSYSTEM==\\"net\\", ACTION==\\"add\\", ATTR{address}' + \
 409                    '==\\"' + interface['mac_address'] + '\\", NAME=\\"' + \
 410                    interface['name'] + '\\"'
 411             cmd = 'sh -c "echo \'{0}\' >> {1}"'.format(
 412                 rule, InterfaceUtil.__UDEV_IF_RULES_FILE)
 413             (ret_code, _, _) = ssh.exec_command_sudo(cmd)
 414             if int(ret_code) != 0:
 415                 raise RuntimeError("'{0}' failed on '{1}'"
 416                                    .format(cmd, node['host']))
 417
 418         cmd = '/etc/init.d/udev restart'
 419         ssh.exec_command_sudo(cmd)
 420
 421     @staticmethod
 422     def tg_set_interfaces_default_driver(node):
 423         """Set interfaces default driver specified in topology yaml file.
 424
 425         :param node: Node to setup interfaces driver on (must be TG node).
 426         :type node: dict
 427         """
 428         for interface in node['interfaces'].values():
 429             InterfaceUtil.tg_set_interface_driver(node,
 430                                                   interface['pci_address'],
 431                                                   interface['driver'])
 432
 433     @staticmethod
 434     def update_vpp_interface_data_on_node(node):
 435         """Update vpp generated interface data for a given node in DICT__nodes.
 436
 437         Updates interface names, software if index numbers and any other details
 438         generated specifically by vpp that are unknown before testcase run.
 439         It does this by dumping interface list to JSON output from all
 440         devices using vpp_api_test, and pairing known information from topology
 441         (mac address/pci address of interface) to state from VPP.
 442
 443         :param node: Node selected from DICT__nodes.
 444         :type node: dict
 445         """
 446         vat_executor = VatExecutor()
 447         vat_executor.execute_script_json_out("dump_interfaces.vat", node)
 448         interface_dump_json = vat_executor.get_script_stdout()
 449         VatJsonUtil.update_vpp_interface_data_from_json(node,
 450                                                         interface_dump_json)
 451
 452     @staticmethod
 453     def update_tg_interface_data_on_node(node):
 454         """Update interface name for TG/linux node in DICT__nodes.
 455
 456         :param node: Node selected from DICT__nodes.
 457         :type node: dict
 458         :raises RuntimeError: If getting of interface name and MAC fails.
 459
 460         .. note::
 461             # for dev in `ls /sys/class/net/`;
 462             > do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
 463             "52:54:00:9f:82:63": "eth0"
 464             "52:54:00:77:ae:a9": "eth1"
 465             "52:54:00:e1:8a:0f": "eth2"
 466             "00:00:00:00:00:00": "lo"
 467
 468         .. todo:: parse lshw -json instead
 469         """
 470         # First setup interface driver specified in yaml file
 471         InterfaceUtil.tg_set_interfaces_default_driver(node)
 472
 473         # Get interface names
 474         ssh = SSH()
 475         ssh.connect(node)
 476
 477         cmd = ('for dev in `ls /sys/class/net/`; do echo "\\"`cat '
 478                '/sys/class/net/$dev/address`\\": \\"$dev\\""; done;')
 479
 480         (ret_code, stdout, _) = ssh.exec_command(cmd)
 481         if int(ret_code) != 0:
 482             raise RuntimeError('Get interface name and MAC failed')
 483         tmp = "{" + stdout.rstrip().replace('\n', ',') + "}"
 484         interfaces = JsonParser().parse_data(tmp)
 485         for interface in node['interfaces'].values():
 486             name = interfaces.get(interface['mac_address'])
 487             if name is None:
 488                 continue
 489             interface['name'] = name
 490
 491         # Set udev rules for interfaces
 492         InterfaceUtil.tg_set_interfaces_udev_rules(node)
 493
 494     @staticmethod
 495     def iface_update_numa_node(node):
 496         """For all interfaces from topology file update numa node based on
 497            information from the node.
 498
 499         :param node: Node from topology.
 500         :type node: dict
 501         :returns: Nothing.
 502         :raises ValueError: If numa node ia less than 0.
 503         :raises RuntimeError: If update of numa node failes.
 504         """
 505         ssh = SSH()
 506         for if_key in Topology.get_node_interfaces(node):
 507             if_pci = Topology.get_interface_pci_addr(node, if_key)
 508             ssh.connect(node)
 509             cmd = "cat /sys/bus/pci/devices/{}/numa_node".format(if_pci)
 510             for _ in range(3):
 511                 (ret, out, _) = ssh.exec_command(cmd)
 512                 if ret == 0:
 513                     try:
 514                         numa_node = int(out)
 515                         if numa_node < 0:
 516                             raise ValueError
 517                     except ValueError:
 518                         logger.trace('Reading numa location failed for: {0}'\
 519                             .format(if_pci))
 520                     else:
 521                         Topology.set_interface_numa_node(node, if_key,
 522                                                          numa_node)
 523                         break
 524             else:
 525                 raise RuntimeError('Update numa node failed for: {0}'\
 526                     .format(if_pci))
 527
 528     @staticmethod
 529     def update_all_numa_nodes(nodes, skip_tg=False):
 530         """For all nodes and all their interfaces from topology file update numa
 531         node information based on information from the node.
 532
 533         :param nodes: Nodes in the topology.
 534         :param skip_tg: Skip TG node
 535         :type nodes: dict
 536         :type skip_tg: bool
 537         :returns: Nothing.
 538         """
 539         for node in nodes.values():
 540             if node['type'] == NodeType.DUT:
 541                 InterfaceUtil.iface_update_numa_node(node)
 542             elif node['type'] == NodeType.TG and not skip_tg:
 543                 InterfaceUtil.iface_update_numa_node(node)
 544
 545     @staticmethod
 546     def update_all_interface_data_on_all_nodes(nodes, skip_tg=False,
 547                                                numa_node=False):
 548         """Update interface names on all nodes in DICT__nodes.
 549
 550         This method updates the topology dictionary by querying interface lists
 551         of all nodes mentioned in the topology dictionary.
 552
 553         :param nodes: Nodes in the topology.
 554         :param skip_tg: Skip TG node
 555         :param numa_node: Retrieve numa_node location.
 556         :type nodes: dict
 557         :type skip_tg: bool
 558         :type numa_node: bool
 559         """
 560         for node_data in nodes.values():
 561             if node_data['type'] == NodeType.DUT:
 562                 InterfaceUtil.update_vpp_interface_data_on_node(node_data)
 563             elif node_data['type'] == NodeType.TG and not skip_tg:
 564                 InterfaceUtil.update_tg_interface_data_on_node(node_data)
 565
 566             if numa_node:
 567                 if node_data['type'] == NodeType.DUT:
 568                     InterfaceUtil.iface_update_numa_node(node_data)
 569                 elif node_data['type'] == NodeType.TG and not skip_tg:
 570                     InterfaceUtil.iface_update_numa_node(node_data)
 571
 572     @staticmethod
 573     def create_vlan_subinterface(node, interface, vlan):
 574         """Create VLAN subinterface on node.
 575
 576         :param node: Node to add VLAN subinterface on.
 577         :param interface: Interface name on which create VLAN subinterface.
 578         :param vlan: VLAN ID of the subinterface to be created.
 579         :type node: dict
 580         :type interface: str
 581         :type vlan: int
 582         :returns: Name and index of created subinterface.
 583         :rtype: tuple
 584         :raises RuntimeError: if it is unable to create VLAN subinterface on the
 585         node.
 586         """
 587         iface_key = Topology.get_interface_by_name(node, interface)
 588         sw_if_index = Topology.get_interface_sw_index(node, iface_key)
 589
 590         output = VatExecutor.cmd_from_template(node, "create_vlan_subif.vat",
 591                                                sw_if_index=sw_if_index,
 592                                                vlan=vlan)
 593         if output[0]["retval"] == 0:
 594             sw_subif_index = output[0]["sw_if_index"]
 595             logger.trace('VLAN subinterface with sw_if_index {} and VLAN ID {} '
 596                          'created on node {}'.format(sw_subif_index,
 597                                                      vlan, node['host']))
 598         else:
 599             raise RuntimeError('Unable to create VLAN subinterface on node {}'
 600                                .format(node['host']))
 601
 602         with VatTerminal(node, False) as vat:
 603             vat.vat_terminal_exec_cmd('exec show interfaces')
 604
 605         return '{}.{}'.format(interface, vlan), sw_subif_index
 606
 607     @staticmethod
 608     def create_vxlan_interface(node, vni, source_ip, destination_ip):
 609         """Create VXLAN interface and return sw if index of created interface.
 610
 611         Executes "vxlan_add_del_tunnel src {src} dst {dst} vni {vni}" VAT
 612         command on the node.
 613
 614         :param node: Node where to create VXLAN interface.
 615         :param vni: VXLAN Network Identifier.
 616         :param source_ip: Source IP of a VXLAN Tunnel End Point.
 617         :param destination_ip: Destination IP of a VXLAN Tunnel End Point.
 618         :type node: dict
 619         :type vni: int
 620         :type source_ip: str
 621         :type destination_ip: str
 622         :returns: SW IF INDEX of created interface.
 623         :rtype: int
 624         :raises RuntimeError: if it is unable to create VxLAN interface on the
 625         node.
 626         """
 627         output = VatExecutor.cmd_from_template(node, "vxlan_create.vat",
 628                                                src=source_ip,
 629                                                dst=destination_ip,
 630                                                vni=vni)
 631         output = output[0]
 632
 633         if output["retval"] == 0:
 634             return output["sw_if_index"]
 635         else:
 636             raise RuntimeError('Unable to create VXLAN interface on node {0}'
 637                                .format(node))
 638
 639     @staticmethod
 640     def vxlan_dump(node, interface=None):
 641         """Get VxLAN data for the given interface.
 642
 643         :param node: VPP node to get interface data from.
 644         :param interface: Numeric index or name string of a specific interface.
 645         If None, information about all VxLAN interfaces is returned.
 646         :type node: dict
 647         :type interface: int or str
 648         :returns: Dictionary containing data for the given VxLAN interface or if
 649         interface=None, the list of dictionaries with all VxLAN interfaces.
 650         :rtype: dict or list
 651         :raises TypeError: if the data type of interface is neither basestring
 652         nor int.
 653         """
 654         param = "sw_if_index"
 655         if interface is None:
 656             param = ''
 657             sw_if_index = ''
 658         elif isinstance(interface, basestring):
 659             sw_if_index = Topology.get_interface_sw_index(node, interface)
 660         elif isinstance(interface, int):
 661             sw_if_index = interface
 662         else:
 663             raise TypeError("Wrong interface format {0}".format(interface))
 664
 665         with VatTerminal(node) as vat:
 666             response = vat.vat_terminal_exec_cmd_from_template(
 667                 "vxlan_dump.vat", param=param, sw_if_index=sw_if_index)
 668
 669         if sw_if_index:
 670             for vxlan in response[0]:
 671                 if vxlan["sw_if_index"] == sw_if_index:
 672                     return vxlan
 673             return {}
 674         return response[0]
 675
 676     @staticmethod
 677     def vhost_user_dump(node):
 678         """Get vhost-user data for the given node.
 679
 680         :param node: VPP node to get interface data from.
 681         :type node: dict
 682         :returns: List of dictionaries with all vhost-user interfaces.
 683         :rtype: list
 684         """
 685         with VatTerminal(node) as vat:
 686             response = vat.vat_terminal_exec_cmd_from_template(
 687                 "vhost_user_dump.vat")
 688
 689         return response[0]
 690
 691     @staticmethod
 692     def tap_dump(node, name=None):
 693         """Get all TAP interface data from the given node, or data about
 694         a specific TAP interface.
 695
 696         :param node: VPP node to get data from.
 697         :param name: Optional name of a specific TAP interface.
 698         :type node: dict
 699         :type name: str
 700         :returns: Dictionary of information about a specific TAP interface, or
 701         a List of dictionaries containing all TAP data for the given node.
 702         :rtype: dict or list
 703         """
 704         with VatTerminal(node) as vat:
 705             response = vat.vat_terminal_exec_cmd_from_template(
 706                 "tap_dump.vat")
 707         if name is None:
 708             return response[0]
 709         else:
 710             for item in response[0]:
 711                 if name == item['dev_name']:
 712                     return item
 713             return {}
 714
 715     @staticmethod
 716     def create_subinterface(node, interface, sub_id, outer_vlan_id=None,
 717                             inner_vlan_id=None, type_subif=None):
 718         """Create sub-interface on node. It is possible to set required
 719         sub-interface type and VLAN tag(s).
 720
 721         :param node: Node to add sub-interface.
 722         :param interface: Interface name on which create sub-interface.
 723         :param sub_id: ID of the sub-interface to be created.
 724         :param outer_vlan_id: Optional outer VLAN ID.
 725         :param inner_vlan_id: Optional inner VLAN ID.
 726         :param type_subif: Optional type of sub-interface. Values supported by
 727         VPP: [no_tags] [one_tag] [two_tags] [dot1ad] [exact_match] [default_sub]
 728         :type node: dict
 729         :type interface: str or int
 730         :type sub_id: int
 731         :type outer_vlan_id: int
 732         :type inner_vlan_id: int
 733         :type type_subif: str
 734         :returns: Name and index of created sub-interface.
 735         :rtype: tuple
 736         :raises RuntimeError: If it is not possible to create sub-interface.
 737         """
 738
 739         outer_vlan_id = 'outer_vlan_id {0}'.format(outer_vlan_id)\
 740             if outer_vlan_id else ''
 741
 742         inner_vlan_id = 'inner_vlan_id {0}'.format(inner_vlan_id)\
 743             if inner_vlan_id else ''
 744
 745         if type_subif is None:
 746             type_subif = ''
 747
 748         if isinstance(interface, basestring):
 749             iface_key = Topology.get_interface_by_name(node, interface)
 750             sw_if_index = Topology.get_interface_sw_index(node, iface_key)
 751         else:
 752             sw_if_index = interface
 753
 754         output = VatExecutor.cmd_from_template(node, "create_sub_interface.vat",
 755                                                sw_if_index=sw_if_index,
 756                                                sub_id=sub_id,
 757                                                outer_vlan_id=outer_vlan_id,
 758                                                inner_vlan_id=inner_vlan_id,
 759                                                type_subif=type_subif)
 760
 761         if output[0]["retval"] == 0:
 762             sw_subif_index = output[0]["sw_if_index"]
 763             logger.trace('Created subinterface with index {}'
 764                          .format(sw_subif_index))
 765         else:
 766             raise RuntimeError('Unable to create sub-interface on node {}'
 767                                .format(node['host']))
 768
 769         with VatTerminal(node, json_param=False) as vat:
 770             vat.vat_terminal_exec_cmd('exec show interfaces')
 771
 772         name = '{}.{}'.format(interface, sub_id)
 773         return name, sw_subif_index
 774
 775     @staticmethod
 776     def create_gre_tunnel_interface(node, source_ip, destination_ip):
 777         """Create GRE tunnel interface on node.
 778
 779         :param node: VPP node to add tunnel interface.
 780         :param source_ip: Source of the GRE tunnel.
 781         :param destination_ip: Destination of the GRE tunnel.
 782         :type node: dict
 783         :type source_ip: str
 784         :type destination_ip: str
 785         :returns: Name and index of created GRE tunnel interface.
 786         :rtype: tuple
 787         :raises RuntimeError: If unable to create GRE tunnel interface.
 788         """
 789         output = VatExecutor.cmd_from_template(node, "create_gre.vat",
 790                                                src=source_ip,
 791                                                dst=destination_ip)
 792         output = output[0]
 793
 794         if output["retval"] == 0:
 795             sw_if_index = output["sw_if_index"]
 796
 797             vat_executor = VatExecutor()
 798             vat_executor.execute_script_json_out("dump_interfaces.vat", node)
 799             interface_dump_json = vat_executor.get_script_stdout()
 800             name = VatJsonUtil.get_interface_name_from_json(
 801                 interface_dump_json, sw_if_index)
 802             return name, sw_if_index
 803         else:
 804             raise RuntimeError('Unable to create GRE tunnel on node {}.'
 805                                .format(node))
 806
 807     @staticmethod
 808     def vpp_create_loopback(node):
 809         """Create loopback interface on VPP node.
 810
 811         :param node: Node to create loopback interface on.
 812         :type node: dict
 813         :returns: SW interface index.
 814         :rtype: int
 815         :raises RuntimeError: If it is not possible to create loopback on the
 816         node.
 817         """
 818         out = VatExecutor.cmd_from_template(node, "create_loopback.vat")
 819         if out[0].get('retval') == 0:
 820             return out[0].get('sw_if_index')
 821         else:
 822             raise RuntimeError('Create loopback failed on node "{}"'
 823                                .format(node['host']))
 824
 825     @staticmethod
 826     def vpp_enable_input_acl_interface(node, interface, ip_version,
 827                                        table_index):
 828         """Enable input acl on interface.
 829
 830         :param node: VPP node to setup interface for input acl.
 831         :param interface: Interface to setup input acl.
 832         :param ip_version: Version of IP protocol.
 833         :param table_index: Classify table index.
 834         :type node: dict
 835         :type interface: str or int
 836         :type ip_version: str
 837         :type table_index: int
 838         """
 839         if isinstance(interface, basestring):
 840             sw_if_index = Topology.get_interface_sw_index(node, interface)
 841         else:
 842             sw_if_index = interface
 843
 844         with VatTerminal(node) as vat:
 845             vat.vat_terminal_exec_cmd_from_template("input_acl_int.vat",
 846                                                     sw_if_index=sw_if_index,
 847                                                     ip_version=ip_version,
 848                                                     table_index=table_index)
 849
 850     @staticmethod
 851     def get_interface_classify_table(node, interface):
 852         """Get name of classify table for the given interface.
 853
 854         :param node: VPP node to get data from.
 855         :param interface: Name or sw_if_index of a specific interface.
 856         :type node: dict
 857         :type interface: str or int
 858         :returns: Classify table name.
 859         :rtype: str
 860         """
 861         if isinstance(interface, basestring):
 862             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 863         else:
 864             sw_if_index = interface
 865
 866         with VatTerminal(node) as vat:
 867             data = vat.vat_terminal_exec_cmd_from_template(
 868                 "classify_interface_table.vat",
 869                 sw_if_index=sw_if_index)
 870         return data[0]
 871
 872     @staticmethod
 873     def get_interface_vrf_table(node, interface):
 874         """Get vrf ID for the given interface.
 875
 876         :param node: VPP node.
 877         :param interface: Name or sw_if_index of a specific interface.
 878         :type node: dict
 879         :type interface: str or int
 880         :returns: vrf ID of the specified interface.
 881         :rtype: int
 882         """
 883
 884         if isinstance(interface, basestring):
 885             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 886         else:
 887             sw_if_index = interface
 888
 889         with VatTerminal(node) as vat:
 890             data = vat.vat_terminal_exec_cmd_from_template(
 891                 "interface_vrf_dump.vat",
 892                 sw_if_index=sw_if_index)
 893         return data[0]["vrf_id"]
 894
 895     @staticmethod
 896     def get_sw_if_index(node, interface_name):
 897         """Get sw_if_index for the given interface from actual interface dump.
 898
 899         :param node: VPP node to get interface data from.
 900         :param interface_name: Name of the specific interface.
 901         :type node: dict
 902         :type interface_name: str
 903         :returns: sw_if_index of the given interface.
 904         :rtype: str
 905         """
 906
 907         with VatTerminal(node) as vat:
 908             if_data = vat.vat_terminal_exec_cmd_from_template(
 909                 "interface_dump.vat")
 910         for interface in if_data[0]:
 911             if interface["interface_name"] == interface_name:
 912                 return interface["sw_if_index"]
 913
 914         return None
 915
 916     @staticmethod
 917     def vxlan_gpe_dump(node, interface_name=None):
 918         """Get VxLAN GPE data for the given interface.
 919
 920         :param node: VPP node to get interface data from.
 921         :param interface_name: Name of the specific interface. If None,
 922         information about all VxLAN GPE interfaces is returned.
 923         :type node: dict
 924         :type interface_name: str
 925         :returns: Dictionary containing data for the given VxLAN GPE interface
 926         or if interface=None, the list of dictionaries with all VxLAN GPE
 927         interfaces.
 928         :rtype: dict or list
 929         """
 930
 931         with VatTerminal(node) as vat:
 932             vxlan_gpe_data = vat.vat_terminal_exec_cmd_from_template(
 933                 "vxlan_gpe_dump.vat")
 934
 935         if interface_name:
 936             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface_name)
 937             if sw_if_index:
 938                 for vxlan_gpe in vxlan_gpe_data[0]:
 939                     if vxlan_gpe["sw_if_index"] == sw_if_index:
 940                         return vxlan_gpe
 941             return {}
 942
 943         return vxlan_gpe_data[0]
 944
 945     @staticmethod
 946     def vpp_proxy_arp_interface_enable(node, interface):
 947         """Enable proxy ARP on interface.
 948
 949         :param node: VPP node to enable proxy ARP on interface.
 950         :param interface: Interface to enable proxy ARP.
 951         :type node: dict
 952         :type interface: str or int
 953         """
 954         if isinstance(interface, basestring):
 955             sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
 956         else:
 957             sw_if_index = interface
 958
 959         with VatTerminal(node) as vat:
 960             vat.vat_terminal_exec_cmd_from_template(
 961                 "proxy_arp_intfc_enable.vat",
 962                 sw_if_index=sw_if_index)
 963
 964     @staticmethod
 965     def vpp_ip_source_check_setup(node, interface):
 966         """Setup Reverse Path Forwarding source check on interface.
 967
 968         :param node: Node to setup RPF source check.
 969         :param interface: Interface name to setup RPF source check.
 970         :type node: dict
 971         :type interface: str
 972         """
 973         with VatTerminal(node) as vat:
 974             vat.vat_terminal_exec_cmd_from_template("ip_source_check.vat",
 975                                                     interface_name=interface)
 976
 977     @staticmethod
 978     def assign_interface_to_fib_table(node, interface, table_id, ipv6=False):
 979         """Assign VPP interface to specific VRF/FIB table.
 980
 981         :param node: VPP node where the FIB and interface are located.
 982         :param interface: Interface to be assigned to FIB.
 983         :param table_id: VRF table ID.
 984         :param ipv6: Assign to IPv6 table. Default False.
 985         :type node: dict
 986         :type interface: str or int
 987         :type table_id: int
 988         :type ipv6: bool
 989         """
 990         if isinstance(interface, basestring):
 991             sw_if_index = Topology.get_interface_sw_index(node, interface)
 992         else:
 993             sw_if_index = interface
 994
 995         ipv6 = 'ipv6' if ipv6 else ''
 996
 997         with VatTerminal(node) as vat:
 998             ret = vat.vat_terminal_exec_cmd_from_template(
 999                 "set_fib_to_interface.vat",
1000                 sw_index=sw_if_index, vrf=table_id, ipv6=ipv6)
1001
1002         if ret[0]["retval"] != 0:
1003             raise RuntimeError('Unable to assign interface to FIB node {}.'
1004                                .format(node))
1005
1006
1007     @staticmethod
1008     def set_linux_interface_mac(node, interface, mac, namespace=None):
1009         """Set MAC address for interface in linux.
1010
1011         :param node: Node where to execute command.
1012         :param interface: Interface in namespace.
1013         :param mac: MAC to be assigned to interface.
1014         :param namespace: Execute command in namespace. Optional
1015         :type node: dict
1016         :type interface: str
1017         :type mac: str
1018         :type namespace: str
1019         """
1020         if namespace is not None:
1021             cmd = 'ip netns exec {} ip link set {} address {}'.format(
1022                 namespace, interface, mac)
1023         else:
1024             cmd = 'ip link set {} address {}'.format(interface, mac)
1025         exec_cmd_no_error(node, cmd, sudo=True)