dpdk:enable flow director perfect mode - vpp

about summary refs log tree commit diff stats

diff options

author	Eyal Bari <ebari@cisco.com>	2018-05-16 11:30:23 +0300
committer	Damjan Marion <dmarion.lists@gmail.com>	2018-05-21 19:16:37 +0000
commit	bd81bdf226c1dc03baaf05f17cf68fbb17bc5dd7 (patch)
tree	2ca4ff0abb81fd144af40c30cc037a9055dfbc3a /src/plugins/dpdk/device
parent	a52e1668c9976bd5cdd20d02b668df41ea41f16f (diff)

dpdk:enable flow director perfect mode

when flows are enabled on the device Change-Id: I971764988d5a9e7078468f627205b3fa60736263 Signed-off-by: Eyal Bari <ebari@cisco.com>

Diffstat (limited to 'src/plugins/dpdk/device')

-rw-r--r--

src/plugins/dpdk/device/common.c

-rw-r--r--

src/plugins/dpdk/device/flow.c

-rwxr-xr-x

src/plugins/dpdk/device/init.c

3 files changed, 25 insertions, 4 deletions

href='#n152'>152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107

# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Interface util library."""

from socket import AF_INET, AF_INET6, inet_ntop, inet_pton
from time import sleep

from enum import IntEnum
from ipaddress import IPv4Address, IPv6Address
from ipaddress import AddressValueError, NetmaskValueError
from robot.api import logger

from resources.libraries.python.Constants import Constants
from resources.libraries.python.CpuUtils import CpuUtils
from resources.libraries.python.DUTSetup import DUTSetup
from resources.libraries.python.IPUtil import convert_ipv4_netmask_prefix
from resources.libraries.python.L2Util import L2Util
from resources.libraries.python.PapiExecutor import PapiExecutor
from resources.libraries.python.parsers.JsonParser import JsonParser
from resources.libraries.python.ssh import SSH, exec_cmd_no_error
from resources.libraries.python.topology import NodeType, Topology
from resources.libraries.python.VPPUtil import VPPUtil


class LinkBondLoadBalance(IntEnum):
    """Link bonding load balance."""
    L2 = 0
    L34 = 1
    L23 = 2


class LinkBondMode(IntEnum):
    """Link bonding load balance."""
    ROUND_ROBIN = 1
    ACTIVE_BACKUP = 2
    XOR = 3
    BROADCAST = 4
    LACP = 5


class InterfaceUtil(object):
    """General utilities for managing interfaces"""

    __UDEV_IF_RULES_FILE = '/etc/udev/rules.d/10-network.rules'

    @staticmethod
    def pci_to_int(pci_str):
        """Convert PCI address from string format (0000:18:0a.0) to
        integer representation (169345024).

        :param pci_str: PCI address in string representation.
        :type pci_str: str
        :returns: Integer representation of PCI address.
        :rtype: int
        """

        pci = list(pci_str.split(':')[0:2])
        pci.extend(pci_str.split(':')[2].split('.'))

        return (int(pci[0], 16) | int(pci[1], 16) << 16 |
                int(pci[2], 16) << 24 | int(pci[3], 16) << 29)

    @staticmethod
    def get_interface_index(node, interface):
        """Get interface sw_if_index from topology file.

        :param node: Node where the interface is.
        :param interface: Numeric index or name string of a specific interface.
        :type node: dict
        :type interface: str or int
        :returns: SW interface index.
        :rtype: int
        """

        try:
            sw_if_index = int(interface)
        except ValueError:
            sw_if_index = Topology.get_interface_sw_index(node, interface)
            if sw_if_index is None:
                sw_if_index = \
                    Topology.get_interface_sw_index_by_name(node, interface)
        except TypeError as err:
            raise TypeError('Wrong interface format {ifc}: {err}'.format(
                ifc=interface, err=err.message))

        return sw_if_index

    @staticmethod
    def set_interface_state(node, interface, state, if_type='key'):
        """Set interface state on a node.

        Function can be used for DUTs as well as for TGs.

        :param node: Node where the interface is.
        :param interface: Interface key or sw_if_index or name.
        :param state: One of 'up' or 'down'.
        :param if_type: Interface type
        :type node: dict
        :type interface: str or int
        :type state: str
        :type if_type: str
        :returns: Nothing.
        :raises ValueError: If the interface type is unknown.
        :raises ValueError: If the state of interface is unexpected.
        :raises ValueError: If the node has an unknown node type.
        """

        if if_type == 'key':
            if isinstance(interface, basestring):
                sw_if_index = Topology.get_interface_sw_index(node, interface)
                iface_name = Topology.get_interface_name(node, interface)
            else:
                sw_if_index = interface
        elif if_type == 'name':
            iface_key = Topology.get_interface_by_name(node, interface)
            if iface_key is not None:
                sw_if_index = Topology.get_interface_sw_index(node, iface_key)
            iface_name = interface
        else:
            raise ValueError('Unknown if_type: {type}'.format(type=if_type))

        if node['type'] == NodeType.DUT:
            if state == 'up':
                admin_up_down = 1
            elif state == 'down':
                admin_up_down = 0
            else:
                raise ValueError('Unexpected interface state: {state}'.format(
                    state=state))
            cmd = 'sw_interface_set_flags'
            err_msg = 'Failed to set interface state on host {host}'.format(
                host=node['host'])
            args = dict(sw_if_index=sw_if_index,
                        admin_up_down=admin_up_down)
            with PapiExecutor(node) as papi_exec:
                papi_exec.add(cmd, **args).get_replies(err_msg).\
                    verify_reply(err_msg=err_msg)
        elif node['type'] == NodeType.TG or node['type'] == NodeType.VM:
            cmd = 'ip link set {ifc} {state}'.format(
                ifc=iface_name, state=state)
            exec_cmd_no_error(node, cmd, sudo=True)
        else:
            raise ValueError('Node {} has unknown NodeType: "{}"'
                             .format(node['host'], node['type']))

    @staticmethod
    def set_interface_ethernet_mtu(node, iface_key, mtu):
        """Set Ethernet MTU for specified interface.

        Function can be used only for TGs.

        :param node: Node where the interface is.
        :param iface_key: Interface key from topology file.
        :param mtu: MTU to set.
        :type node: dict
        :type iface_key: str
        :type mtu: int
        :returns: Nothing.
        :raises ValueError: If the node type is "DUT".
        :raises ValueError: If the node has an unknown node type.
        """

        if node['type'] == NodeType.DUT:
            raise ValueError('Node {}: Setting Ethernet MTU for interface '
                             'on DUT nodes not supported', node['host'])
        elif node['type'] == NodeType.TG:
            iface_name = Topology.get_interface_name(node, iface_key)
            cmd = 'ip link set {} mtu {}'.format(iface_name, mtu)
            exec_cmd_no_error(node, cmd, sudo=True)
        else:
            raise ValueError('Node {} has unknown NodeType: "{}"'
                             .format(node['host'], node['type']))

    @staticmethod
    def set_default_ethernet_mtu_on_all_interfaces_on_node(node):
        """Set default Ethernet MTU on all interfaces on node.

        Function can be used only for TGs.

        :param node: Node where to set default MTU.
        :type node: dict
        :returns: Nothing.
        """

        for ifc in node['interfaces']:
            InterfaceUtil.set_interface_ethernet_mtu(node, ifc, 1500)

    @staticmethod
    def vpp_set_interface_mtu(node, interface, mtu=9200):
        """Set Ethernet MTU on interface.

        :param node: VPP node.
        :param interface: Interface to setup MTU. Default: 9200.
        :param mtu: Ethernet MTU size in Bytes.
        :type node: dict
        :type interface: str or int
        :type mtu: int
        """

        if isinstance(interface, basestring):
            sw_if_index = Topology.get_interface_sw_index(node, interface)
        else:
            sw_if_index = interface

        cmd = 'hw_interface_set_mtu'
        err_msg = 'Failed to set interface MTU on host {host}'.format(
            host=node['host'])
        args = dict(sw_if_index=sw_if_index,
                    mtu=int(mtu))
        with PapiExecutor(node) as papi_exec:
            papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

    @staticmethod
    def vpp_set_interfaces_mtu_on_node(node, mtu=9200):
        """Set Ethernet MTU on all interfaces.

        :param node: VPP node.
        :param mtu: Ethernet MTU size in Bytes. Default: 9200.
        :type node: dict
        :type mtu: int
        """

        for interface in node['interfaces']:
            InterfaceUtil.vpp_set_interface_mtu(node, interface, mtu)

    @staticmethod
    def vpp_set_interfaces_mtu_on_all_duts(nodes, mtu=9200):
        """Set Ethernet MTU on all interfaces on all DUTs.

        :param nodes: VPP nodes.
        :param mtu: Ethernet MTU size in Bytes. Default: 9200.
        :type nodes: dict
        :type mtu: int
        """

        for node in nodes.values():
            if node['type'] == NodeType.DUT:
                InterfaceUtil.vpp_set_interfaces_mtu_on_node(node, mtu)

    @staticmethod
    def vpp_node_interfaces_ready_wait(node, retries=15):
        """Wait until all interfaces with admin-up are in link-up state.

        :param node: Node to wait on.
        :param retries: Number of retries to check interface status (optional,
            default 15).
        :type node: dict
        :type retries: int
        :returns: Nothing.
        :raises RuntimeError: If any interface is not in link-up state after
            defined number of retries.
        """

        for _ in xrange(0, retries):
            not_ready = list()
            out = InterfaceUtil.vpp_get_interface_data(node)
            for interface in out:
                if interface.get('admin_up_down') == 1:
                    if interface.get('link_up_down') != 1:
                        not_ready.append(interface.get('interface_name'))
            if not not_ready:
                break
            else:
                logger.debug('Interfaces still in link-down state:\n{ifs} '
                             '\nWaiting...'.format(ifs=not_ready))
                sleep(1)
        else:
            err = 'Timeout, interfaces not up:\n{ifs}'.format(ifs=not_ready) \
                if 'not_ready' in locals() else 'No check executed!'
            raise RuntimeError(err)

    @staticmethod
    def all_vpp_interfaces_ready_wait(nodes, retries=15):
        """Wait until all interfaces with admin-up are in link-up state for all
        nodes in the topology.

        :param nodes: Nodes in the topology.
        :param retries: Number of retries to check interface status (optional,
            default 15).
        :type nodes: dict
        :type retries: int
        :returns: Nothing.
        """

        for node in nodes.values():
            if node['type'] == NodeType.DUT:
                InterfaceUtil.vpp_node_interfaces_ready_wait(node, retries)

    @staticmethod
    def vpp_get_interface_data(node, interface=None):
        """Get all interface data from a VPP node. If a name or
        sw_interface_index is provided, return only data for the matching
        interface(s).

        :param node: VPP node to get interface data from.
        :param interface: Numeric index or name string of a specific interface.
        :type node: dict
        :type interface: int or str
        :returns: List of dictionaries containing data for each interface, or a
            single dictionary for the specified interface.
        :rtype: list or dict
        :raises TypeError: if the data type of interface is neither basestring
            nor int.
        """

        if interface is not None:
            if isinstance(interface, basestring):
                param = 'interface_name'
            elif isinstance(interface, int):
                param = 'sw_if_index'
            else:
                raise TypeError('Wrong interface format {ifc}'.format(
                    ifc=interface))
        else:
            param = ''

        cmd = 'sw_interface_dump'
        cmd_reply = 'sw_interface_details'
        args = dict(name_filter_valid=0,
                    name_filter='')
        err_msg = 'Failed to get interface dump on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg)

        papi_if_dump = papi_resp.reply[0]['api_reply']

        def process_if_dump(if_dump):
            """Process interface dump.

            :param if_dump: Interface dump.
            :type if_dump: dict
            :returns: Processed interface dump.
            :rtype: dict
            """
            if_dump['interface_name'] = if_dump['interface_name'].rstrip('\x00')
            if_dump['tag'] = if_dump['tag'].rstrip('\x00')
            if_dump['l2_address'] = L2Util.bin_to_mac(if_dump['l2_address'])
            if_dump['b_dmac'] = L2Util.bin_to_mac(if_dump['b_dmac'])
            if_dump['b_smac'] = L2Util.bin_to_mac(if_dump['b_smac'])
            return if_dump

        data = list() if interface is None else dict()
        for item in papi_if_dump:
            if interface is None:
                data.append(process_if_dump(item[cmd_reply]))
            elif str(item[cmd_reply].get(param)).rstrip('\x00') == \
                    str(interface):
                data = process_if_dump(item[cmd_reply])
                break

        logger.debug('Interface data:\n{if_data}'.format(if_data=data))
        return data

    @staticmethod
    def vpp_get_interface_name(node, sw_if_index):
        """Get interface name for the given SW interface index from actual
        interface dump.

        :param node: VPP node to get interface data from.
        :param sw_if_index: SW interface index of the specific interface.
        :type node: dict
        :type sw_if_index: int
        :returns: Name of the given interface.
        :rtype: str
        """

        if_data = InterfaceUtil.vpp_get_interface_data(node, sw_if_index)
        if if_data['sup_sw_if_index'] != if_data['sw_if_index']:
            if_data = InterfaceUtil.vpp_get_interface_data(
                node, if_data['sup_sw_if_index'])

        return if_data.get('interface_name')

    @staticmethod
    def vpp_get_interface_sw_index(node, interface_name):
        """Get interface name for the given SW interface index from actual
        interface dump.

        :param node: VPP node to get interface data from.
        :param interface_name: Interface name.
        :type node: dict
        :type interface_name: str
        :returns: Name of the given interface.
        :rtype: str
        """

        if_data = InterfaceUtil.vpp_get_interface_data(node, interface_name)

        return if_data.get('sw_if_index')

    @staticmethod
    def vpp_get_interface_mac(node, interface):
        """Get MAC address for the given interface from actual interface dump.

        :param node: VPP node to get interface data from.
        :param interface: Numeric index or name string of a specific interface.
        :type node: dict
        :type interface: int or str
        :returns: MAC address.
        :rtype: str
        """

        if_data = InterfaceUtil.vpp_get_interface_data(node, interface)
        if if_data['sup_sw_if_index'] != if_data['sw_if_index']:
            if_data = InterfaceUtil.vpp_get_interface_data(
                node, if_data['sup_sw_if_index'])

        return if_data.get('l2_address')

    @staticmethod
    def vpp_get_interface_ip_addresses(node, interface, ip_version):
        """Get list of IP addresses from an interface on a VPP node.

        TODO: Move to IPUtils

        :param node: VPP node to get data from.
        :param interface: Name of an interface on the VPP node.
        :param ip_version: IP protocol version (ipv4 or ipv6).
        :type node: dict
        :type interface: str
        :type ip_version: str
        :returns: List of dictionaries, each containing IP address, subnet
            prefix length and also the subnet mask for ipv4 addresses.
            Note: A single interface may have multiple IP addresses assigned.
        :rtype: list
        """

        try:
            sw_if_index = Topology.convert_interface_reference(
                node, interface, 'sw_if_index')
        except RuntimeError:
            if isinstance(interface, basestring):
                sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
            else:
                raise

        is_ipv6 = 1 if ip_version == 'ipv6' else 0

        cmd = 'ip_address_dump'
        cmd_reply = 'ip_address_details'
        args = dict(sw_if_index=sw_if_index,
                    is_ipv6=is_ipv6)
        err_msg = 'Failed to get L2FIB dump on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg)

        data = list()
        for item in papi_resp.reply[0]['api_reply']:
            item[cmd_reply]['ip'] = inet_ntop(AF_INET6, item[cmd_reply]['ip']) \
                if is_ipv6 else inet_ntop(AF_INET, item[cmd_reply]['ip'][0:4])
            data.append(item[cmd_reply])

        if ip_version == 'ipv4':
            for item in data:
                item['netmask'] = convert_ipv4_netmask_prefix(
                    item['prefix_length'])
        return data

    @staticmethod
    def tg_set_interface_driver(node, pci_addr, driver):
        """Set interface driver on the TG node.

        :param node: Node to set interface driver on (must be TG node).
        :param pci_addr: PCI address of the interface.
        :param driver: Driver name.
        :type node: dict
        :type pci_addr: str
        :type driver: str
        :raises RuntimeError: If unbinding from the current driver fails.
        :raises RuntimeError: If binding to the new driver fails.
        """
        old_driver = InterfaceUtil.tg_get_interface_driver(node, pci_addr)
        if old_driver == driver:
            return

        ssh = SSH()
        ssh.connect(node)

        # Unbind from current driver
        if old_driver is not None:
            cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/unbind"'\
                .format(pci_addr, old_driver)
            (ret_code, _, _) = ssh.exec_command_sudo(cmd)
            if int(ret_code) != 0:
                raise RuntimeError("'{0}' failed on '{1}'"
                                   .format(cmd, node['host']))

        # Bind to the new driver
        cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/bind"'\
            .format(pci_addr, driver)
        (ret_code, _, _) = ssh.exec_command_sudo(cmd)
        if int(ret_code) != 0:
            raise RuntimeError("'{0}' failed on '{1}'"
                               .format(cmd, node['host']))

    @staticmethod
    def tg_get_interface_driver(node, pci_addr):
        """Get interface driver from the TG node.

        :param node: Node to get interface driver on (must be TG node).
        :param pci_addr: PCI address of the interface.
        :type node: dict
        :type pci_addr: str
        :returns: Interface driver or None if not found.
        :rtype: str
        :raises RuntimeError: If PCI rescan or lspci command execution failed.
        """
        return DUTSetup.get_pci_dev_driver(node, pci_addr)

    @staticmethod
    def tg_set_interfaces_udev_rules(node):
        """Set udev rules for interfaces.

        Create udev rules file in /etc/udev/rules.d where are rules for each
        interface used by TG node, based on MAC interface has specific name.
        So after unbind and bind again to kernel driver interface has same
        name as before. This must be called after TG has set name for each
        port in topology dictionary.
        udev rule example
        SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="52:54:00:e1:8a:0f",
        NAME="eth1"

        :param node: Node to set udev rules on (must be TG node).
        :type node: dict
        :raises RuntimeError: If setting of udev rules fails.
        """
        ssh = SSH()
        ssh.connect(node)

        cmd = 'rm -f {0}'.format(InterfaceUtil.__UDEV_IF_RULES_FILE)
        (ret_code, _, _) = ssh.exec_command_sudo(cmd)
        if int(ret_code) != 0:
            raise RuntimeError("'{0}' failed on '{1}'"
                               .format(cmd, node['host']))

        for interface in node['interfaces'].values():
            rule = 'SUBSYSTEM==\\"net\\", ACTION==\\"add\\", ATTR{address}' + \
                   '==\\"' + interface['mac_address'] + '\\", NAME=\\"' + \
                   interface['name'] + '\\"'
            cmd = 'sh -c "echo \'{0}\' >> {1}"'.format(
                rule, InterfaceUtil.__UDEV_IF_RULES_FILE)
            (ret_code, _, _) = ssh.exec_command_sudo(cmd)
            if int(ret_code) != 0:
                raise RuntimeError("'{0}' failed on '{1}'"
                                   .format(cmd, node['host']))

        cmd = '/etc/init.d/udev restart'
        ssh.exec_command_sudo(cmd)

    @staticmethod
    def tg_set_interfaces_default_driver(node):
        """Set interfaces default driver specified in topology yaml file.

        :param node: Node to setup interfaces driver on (must be TG node).
        :type node: dict
        """
        for interface in node['interfaces'].values():
            InterfaceUtil.tg_set_interface_driver(node,
                                                  interface['pci_address'],
                                                  interface['driver'])

    @staticmethod
    def update_vpp_interface_data_on_node(node):
        """Update vpp generated interface data for a given node in DICT__nodes.

        Updates interface names, software if index numbers and any other details
        generated specifically by vpp that are unknown before testcase run.
        It does this by dumping interface list from all devices using python
        api, and pairing known information from topology (mac address) to state
        from VPP.

        :param node: Node selected from DICT__nodes.
        :type node: dict
        """

        interface_list = InterfaceUtil.vpp_get_interface_data(node)
        interface_dict = dict()
        for ifc in interface_list:
            interface_dict[ifc['l2_address']] = ifc

        for if_name, if_data in node['interfaces'].items():
            ifc_dict = interface_dict.get(if_data['mac_address'])
            if ifc_dict is not None:
                if_data['name'] = ifc_dict['interface_name']
                if_data['vpp_sw_index'] = ifc_dict['sw_if_index']
                if_data['mtu'] = ifc_dict['mtu'][0]
                logger.trace('Interface {ifc} found by MAC {mac}'.format(
                    ifc=if_name, mac=if_data['mac_address']))
            else:
                logger.trace('Interface {ifc} not found by MAC {mac}'.format(
                    ifc=if_name, mac=if_data['mac_address']))
                if_data['vpp_sw_index'] = None

    @staticmethod
    def update_nic_interface_names(node):
        """Update interface names based on nic type and PCI address.

        This method updates interface names in the same format as VPP does.

        :param node: Node dictionary.
        :type node: dict
        """
        for ifc in node['interfaces'].values():
            if_pci = ifc['pci_address'].replace('.', ':').split(':')
            bus = '{:x}'.format(int(if_pci[1], 16))
            dev = '{:x}'.format(int(if_pci[2], 16))
            fun = '{:x}'.format(int(if_pci[3], 16))
            loc = '{bus}/{dev}/{fun}'.format(bus=bus, dev=dev, fun=fun)
            if ifc['model'] == 'Intel-XL710':
                ifc['name'] = 'FortyGigabitEthernet{loc}'.format(loc=loc)
            elif ifc['model'] == 'Intel-X710':
                ifc['name'] = 'TenGigabitEthernet{loc}'.format(loc=loc)
            elif ifc['model'] == 'Intel-X520-DA2':
                ifc['name'] = 'TenGigabitEthernet{loc}'.format(loc=loc)
            elif ifc['model'] == 'Cisco-VIC-1385':
                ifc['name'] = 'FortyGigabitEthernet{loc}'.format(loc=loc)
            elif ifc['model'] == 'Cisco-VIC-1227':
                ifc['name'] = 'TenGigabitEthernet{loc}'.format(loc=loc)
            else:
                ifc['name'] = 'UnknownEthernet{loc}'.format(loc=loc)

    @staticmethod
    def update_nic_interface_names_on_all_duts(nodes):
        """Update interface names based on nic type and PCI address on all DUTs.

        This method updates interface names in the same format as VPP does.

        :param nodes: Topology nodes.
        :type nodes: dict
        """
        for node in nodes.values():
            if node['type'] == NodeType.DUT:
                InterfaceUtil.update_nic_interface_names(node)

    @staticmethod
    def update_tg_interface_data_on_node(node, skip_tg_udev=False):
        """Update interface name for TG/linux node in DICT__nodes.

        .. note::
            # for dev in `ls /sys/class/net/`;
            > do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
            "52:54:00:9f:82:63": "eth0"
            "52:54:00:77:ae:a9": "eth1"
            "52:54:00:e1:8a:0f": "eth2"
            "00:00:00:00:00:00": "lo"

        :param node: Node selected from DICT__nodes.
        :param skip_tg_udev: Skip udev rename on TG node.
        :type node: dict
        :type skip_tg_udev: bool
        :raises RuntimeError: If getting of interface name and MAC fails.
        """
        # First setup interface driver specified in yaml file
        InterfaceUtil.tg_set_interfaces_default_driver(node)

        # Get interface names
        ssh = SSH()
        ssh.connect(node)

        cmd = ('for dev in `ls /sys/class/net/`; do echo "\\"`cat '
               '/sys/class/net/$dev/address`\\": \\"$dev\\""; done;')

        (ret_code, stdout, _) = ssh.exec_command(cmd)
        if int(ret_code) != 0:
            raise RuntimeError('Get interface name and MAC failed')
        tmp = "{" + stdout.rstrip().replace('\n', ',') + "}"
        interfaces = JsonParser().parse_data(tmp)
        for interface in node['interfaces'].values():
            name = interfaces.get(interface['mac_address'])
            if name is None:
                continue
            interface['name'] = name

        # Set udev rules for interfaces
        if not skip_tg_udev:
            InterfaceUtil.tg_set_interfaces_udev_rules(node)

    @staticmethod
    def iface_update_numa_node(node):
        """For all interfaces from topology file update numa node based on
           information from the node.

        :param node: Node from topology.
        :type node: dict
        :returns: Nothing.
        :raises ValueError: If numa node ia less than 0.
        :raises RuntimeError: If update of numa node failes.
        """
        ssh = SSH()
        for if_key in Topology.get_node_interfaces(node):
            if_pci = Topology.get_interface_pci_addr(node, if_key)
            ssh.connect(node)
            cmd = "cat /sys/bus/pci/devices/{}/numa_node".format(if_pci)
            for _ in range(3):
                (ret, out, _) = ssh.exec_command(cmd)
                if ret == 0:
                    try:
                        numa_node = int(out)
                        if numa_node < 0:
                            if CpuUtils.cpu_node_count(node) == 1:
                                numa_node = 0
                            else:
                                raise ValueError
                    except ValueError:
                        logger.trace('Reading numa location failed for: {0}'
                                     .format(if_pci))
                    else:
                        Topology.set_interface_numa_node(node, if_key,
                                                         numa_node)
                        break
            else:
                raise RuntimeError('Update numa node failed for: {0}'
                                   .format(if_pci))

    @staticmethod
    def update_all_numa_nodes(nodes, skip_tg=False):
        """For all nodes and all their interfaces from topology file update numa
        node information based on information from the node.

        :param nodes: Nodes in the topology.
        :param skip_tg: Skip TG node
        :type nodes: dict
        :type skip_tg: bool
        :returns: Nothing.
        """
        for node in nodes.values():
            if node['type'] == NodeType.DUT:
                InterfaceUtil.iface_update_numa_node(node)
            elif node['type'] == NodeType.TG and not skip_tg:
                InterfaceUtil.iface_update_numa_node(node)

    @staticmethod
    def update_all_interface_data_on_all_nodes(nodes, skip_tg=False,
                                               skip_tg_udev=False,
                                               numa_node=False):
        """Update interface names on all nodes in DICT__nodes.

        This method updates the topology dictionary by querying interface lists
        of all nodes mentioned in the topology dictionary.

        :param nodes: Nodes in the topology.
        :param skip_tg: Skip TG node.
        :param skip_tg_udev: Skip udev rename on TG node.
        :param numa_node: Retrieve numa_node location.
        :type nodes: dict
        :type skip_tg: bool
        :type skip_tg_udev: bool
        :type numa_node: bool
        """
        for node_data in nodes.values():
            if node_data['type'] == NodeType.DUT:
                InterfaceUtil.update_vpp_interface_data_on_node(node_data)
            elif node_data['type'] == NodeType.TG and not skip_tg:
                InterfaceUtil.update_tg_interface_data_on_node(
                    node_data, skip_tg_udev)

            if numa_node:
                if node_data['type'] == NodeType.DUT:
                    InterfaceUtil.iface_update_numa_node(node_data)
                elif node_data['type'] == NodeType.TG and not skip_tg:
                    InterfaceUtil.iface_update_numa_node(node_data)

    @staticmethod
    def create_vlan_subinterface(node, interface, vlan):
        """Create VLAN sub-interface on node.

        :param node: Node to add VLAN subinterface on.
        :param interface: Interface name on which create VLAN subinterface.
        :param vlan: VLAN ID of the subinterface to be created.
        :type node: dict
        :type interface: str
        :type vlan: int
        :returns: Name and index of created subinterface.
        :rtype: tuple
        :raises RuntimeError: if it is unable to create VLAN subinterface on the
            node.
        """

        iface_key = Topology.get_interface_by_name(node, interface)
        sw_if_index = Topology.get_interface_sw_index(node, iface_key)

        cmd = 'create_vlan_subif'
        args = dict(sw_if_index=sw_if_index,
                    vlan_id=int(vlan))
        err_msg = 'Failed to create VLAN sub-interface on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_if_idx = papi_resp['sw_if_index']
        if_key = Topology.add_new_port(node, 'vlan_subif')
        Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
        Topology.update_interface_name(node, if_key, ifc_name)

        return '{ifc}.{vlan}'.format(ifc=interface, vlan=vlan), sw_if_idx

    @staticmethod
    def create_vxlan_interface(node, vni, source_ip, destination_ip):
        """Create VXLAN interface and return sw if index of created interface.

        :param node: Node where to create VXLAN interface.
        :param vni: VXLAN Network Identifier.
        :param source_ip: Source IP of a VXLAN Tunnel End Point.
        :param destination_ip: Destination IP of a VXLAN Tunnel End Point.
        :type node: dict
        :type vni: int
        :type source_ip: str
        :type destination_ip: str
        :returns: SW IF INDEX of created interface.
        :rtype: int
        :raises RuntimeError: if it is unable to create VxLAN interface on the
            node.
        """

        try:
            src_address = IPv6Address(unicode(source_ip))
            dst_address = IPv6Address(unicode(destination_ip))
            af_inet = AF_INET6
            is_ipv6 = 1
        except (AddressValueError, NetmaskValueError):
            src_address = IPv4Address(unicode(source_ip))
            dst_address = IPv4Address(unicode(destination_ip))
            af_inet = AF_INET
            is_ipv6 = 0

        cmd = 'vxlan_add_del_tunnel'
        args = dict(is_add=1,
                    is_ipv6=is_ipv6,
                    instance=Constants.BITWISE_NON_ZERO,
                    src_address=inet_pton(af_inet, str(src_address)),
                    dst_address=inet_pton(af_inet, str(dst_address)),
                    mcast_sw_if_index=Constants.BITWISE_NON_ZERO,
                    encap_vrf_id=0,
                    decap_next_index=Constants.BITWISE_NON_ZERO,
                    vni=int(vni))
        err_msg = 'Failed to create VXLAN tunnel interface on host {host}'.\
            format(host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_if_idx = papi_resp['sw_if_index']
        if_key = Topology.add_new_port(node, 'vxlan_tunnel')
        Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
        Topology.update_interface_name(node, if_key, ifc_name)

        return sw_if_idx

    @staticmethod
    def vxlan_dump(node, interface=None):
        """Get VxLAN data for the given interface.

        :param node: VPP node to get interface data from.
        :param interface: Numeric index or name string of a specific interface.
            If None, information about all VxLAN interfaces is returned.
        :type node: dict
        :type interface: int or str
        :returns: Dictionary containing data for the given VxLAN interface or if
            interface=None, the list of dictionaries with all VxLAN interfaces.
        :rtype: dict or list
        :raises TypeError: if the data type of interface is neither basestring
            nor int.
        """

        if interface is not None:
            sw_if_index = InterfaceUtil.get_interface_index(node, interface)
        else:
            sw_if_index = int(Constants.BITWISE_NON_ZERO)

        cmd = 'vxlan_tunnel_dump'
        cmd_reply = 'vxlan_tunnel_details'
        args = dict(sw_if_index=sw_if_index)
        err_msg = 'Failed to get VXLAN dump on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg)

        papi_vxlan_dump = papi_resp.reply[0]['api_reply']

        def process_vxlan_dump(vxlan_dump):
            """Process vxlan dump.

            :param vxlan_dump: Vxlan interface dump.
            :type vxlan_dump: dict
            :returns: Processed vxlan interface dump.
            :rtype: dict
            """
            if vxlan_dump['is_ipv6']:
                vxlan_dump['src_address'] = \
                    inet_ntop(AF_INET6, vxlan_dump['src_address'])
                vxlan_dump['dst_address'] = \
                    inet_ntop(AF_INET6, vxlan_dump['dst_address'])
            else:
                vxlan_dump['src_address'] = \
                    inet_ntop(AF_INET, vxlan_dump['src_address'][0:4])
                vxlan_dump['dst_address'] = \
                    inet_ntop(AF_INET, vxlan_dump['dst_address'][0:4])
            return vxlan_dump

        data = list() if interface is None else dict()
        for item in papi_vxlan_dump:
            if interface is None:
                data.append(process_vxlan_dump(item[cmd_reply]))
            elif item[cmd_reply]['sw_if_index'] == sw_if_index:
                data = process_vxlan_dump(item[cmd_reply])
                break

        logger.debug('VXLAN data:\n{vxlan_data}'.format(vxlan_data=data))
        return data

    @staticmethod
    def vhost_user_dump(node):
        """Get vhost-user data for the given node.

        TODO: Move to VhostUser.py

        :param node: VPP node to get interface data from.
        :type node: dict
        :returns: List of dictionaries with all vhost-user interfaces.
        :rtype: list
        """

        cmd = 'sw_interface_vhost_user_dump'
        cmd_reply = 'sw_interface_vhost_user_details'
        err_msg = 'Failed to get vhost-user dump on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd).get_dump(err_msg)

        papi_vxlan_dump = papi_resp.reply[0]['api_reply']

        def process_vhost_dump(vhost_dump):
            """Process vhost dump.

            :param vhost_dump: Vhost interface dump.
            :type vhost_dump: dict
            :returns: Processed vhost interface dump.
            :rtype: dict
            """
            vhost_dump['interface_name'] = \
                vhost_dump['interface_name'].rstrip('\x00')
            vhost_dump['sock_filename'] = \
                vhost_dump['sock_filename'].rstrip('\x00')
            return vhost_dump

        data = list()
        for item in papi_vxlan_dump:
            data.append(process_vhost_dump(item[cmd_reply]))

        logger.debug('Vhost-user data:\n{vhost_data}'.format(vhost_data=data))
        return data

    @staticmethod
    def tap_dump(node, name=None):
        """Get all TAP interface data from the given node, or data about
        a specific TAP interface.

        TODO: Move to Tap.py

        :param node: VPP node to get data from.
        :param name: Optional name of a specific TAP interface.
        :type node: dict
        :type name: str
        :returns: Dictionary of information about a specific TAP interface, or
            a List of dictionaries containing all TAP data for the given node.
        :rtype: dict or list
        """

        cmd = 'sw_interface_tap_v2_dump'
        cmd_reply = 'sw_interface_tap_v2_details'
        err_msg = 'Failed to get TAP dump on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd).get_dump(err_msg)

        papi_tap_dump = papi_resp.reply[0]['api_reply']

        def process_tap_dump(tap_dump):
            """Process tap dump.

            :param tap_dump: Tap interface dump.
            :type tap_dump: dict
            :returns: Processed tap interface dump.
            :rtype: dict
            """
            tap_dump['dev_name'] = tap_dump['dev_name'].rstrip('\x00')
            tap_dump['host_if_name'] = tap_dump['host_if_name'].rstrip('\x00')
            tap_dump['host_namespace'] = \
                tap_dump['host_namespace'].rstrip('\x00')
            tap_dump['host_mac_addr'] = \
                L2Util.bin_to_mac(tap_dump['host_mac_addr'])
            tap_dump['host_ip4_addr'] = \
                inet_ntop(AF_INET, tap_dump['host_ip4_addr'])
            tap_dump['host_ip6_addr'] = \
                inet_ntop(AF_INET6, tap_dump['host_ip6_addr'])
            return tap_dump

        data = list() if name is None else dict()
        for item in papi_tap_dump:
            if name is None:
                data.append(process_tap_dump(item[cmd_reply]))
            elif item[cmd_reply].get('dev_name').rstrip('\x00') == name:
                data = process_tap_dump(item[cmd_reply])
                break

        logger.debug('TAP data:\n{tap_data}'.format(tap_data=data))
        return data

    @staticmethod
    def create_subinterface(node, interface, sub_id, outer_vlan_id=None,
                            inner_vlan_id=None, type_subif=None):
        """Create sub-interface on node. It is possible to set required
        sub-interface type and VLAN tag(s).

        :param node: Node to add sub-interface.
        :param interface: Interface name on which create sub-interface.
        :param sub_id: ID of the sub-interface to be created.
        :param outer_vlan_id: Optional outer VLAN ID.
        :param inner_vlan_id: Optional inner VLAN ID.
        :param type_subif: Optional type of sub-interface. Values supported by
            VPP: [no_tags] [one_tag] [two_tags] [dot1ad] [exact_match]
            [default_sub]
        :type node: dict
        :type interface: str or int
        :type sub_id: int
        :type outer_vlan_id: int
        :type inner_vlan_id: int
        :type type_subif: str
        :returns: Name and index of created sub-interface.
        :rtype: tuple
        :raises RuntimeError: If it is not possible to create sub-interface.
        """

        subif_types = type_subif.split()

        cmd = 'create_subif'
        args = dict(
            sw_if_index=InterfaceUtil.get_interface_index(node, interface),
            sub_id=int(sub_id),
            no_tags=1 if 'no_tags' in subif_types else 0,
            one_tag=1 if 'one_tag' in subif_types else 0,
            two_tags=1 if 'two_tags' in subif_types else 0,
            dot1ad=1 if 'dot1ad' in subif_types else 0,
            exact_match=1 if 'exact_match' in subif_types else 0,
            default_sub=1 if 'default_sub' in subif_types else 0,
            outer_vlan_id_any=1 if type_subif == 'default_sub' else 0,
            inner_vlan_id_any=1 if type_subif == 'default_sub' else 0,
            outer_vlan_id=int(outer_vlan_id) if outer_vlan_id else 0,
            inner_vlan_id=int(inner_vlan_id) if inner_vlan_id else 0)
        err_msg = 'Failed to create sub-interface on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_subif_idx = papi_resp['sw_if_index']
        if_key = Topology.add_new_port(node, 'subinterface')
        Topology.update_interface_sw_if_index(node, if_key, sw_subif_idx)
        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_subif_idx)
        Topology.update_interface_name(node, if_key, ifc_name)

        return '{ifc}.{s_id}'.format(ifc=interface, s_id=sub_id), sw_subif_idx

    @staticmethod
    def create_gre_tunnel_interface(node, source_ip, destination_ip):
        """Create GRE tunnel interface on node.

        :param node: VPP node to add tunnel interface.
        :param source_ip: Source of the GRE tunnel.
        :param destination_ip: Destination of the GRE tunnel.
        :type node: dict
        :type source_ip: str
        :type destination_ip: str
        :returns: Name and index of created GRE tunnel interface.
        :rtype: tuple
        :raises RuntimeError: If unable to create GRE tunnel interface.
        """

        cmd = 'gre_tunnel_add_del'
        tunnel = dict(type=0,
                      instance=Constants.BITWISE_NON_ZERO,
                      src=str(source_ip),
                      dst=str(destination_ip),
                      outer_fib_id=0,
                      session_id=0)
        args = dict(is_add=1,
                    tunnel=tunnel)
        err_msg = 'Failed to create GRE tunnel interface on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_if_idx = papi_resp['sw_if_index']
        if_key = Topology.add_new_port(node, 'gre_tunnel')
        Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
        Topology.update_interface_name(node, if_key, ifc_name)

        return ifc_name, sw_if_idx

    @staticmethod
    def vpp_create_loopback(node):
        """Create loopback interface on VPP node.

        :param node: Node to create loopback interface on.
        :type node: dict
        :returns: SW interface index.
        :rtype: int
        :raises RuntimeError: If it is not possible to create loopback on the
            node.
        """

        cmd = 'create_loopback'
        args = dict(mac_address=0)
        err_msg = 'Failed to create loopback interface on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_if_idx = papi_resp['sw_if_index']
        if_key = Topology.add_new_port(node, 'loopback')
        Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
        ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
        Topology.update_interface_name(node, if_key, ifc_name)

        return sw_if_idx

    @staticmethod
    def vpp_create_bond_interface(node, mode, load_balance=None, mac=None):
        """Create bond interface on VPP node.

        :param node: DUT node from topology.
        :param mode: Link bonding mode.
        :param load_balance: Load balance (optional, valid for xor and lacp
            modes, otherwise ignored).
        :param mac: MAC address to assign to the bond interface (optional).
        :type node: dict
        :type mode: str
        :type load_balance: str
        :type mac: str
        :returns: Interface key (name) in topology.
        :rtype: str
        :raises RuntimeError: If it is not possible to create bond interface on
            the node.
        """

        cmd = 'bond_create'
        args = dict(id=int(Constants.BITWISE_NON_ZERO),
                    use_custom_mac=0 if mac is None else 1,
                    mac_address=0 if mac is None else L2Util.mac_to_bin(mac),
                    mode=getattr(LinkBondMode, '{md}'.format(
                        md=mode.replace('-', '_').upper())).value,
                    lb=0 if load_balance is None else getattr(
                        LinkBondLoadBalance, '{lb}'.format(
                            lb=load_balance.upper())).value)
        err_msg = 'Failed to create bond interface on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_if_idx = papi_resp['sw_if_index']
        InterfaceUtil.add_eth_interface(node, sw_if_idx=sw_if_idx,
                                        ifc_pfx='eth_bond')
        if_key = Topology.get_interface_by_sw_index(node, sw_if_idx)

        return if_key

    @staticmethod
    def add_eth_interface(node, ifc_name=None, sw_if_idx=None, ifc_pfx=None):
        """Add ethernet interface to current topology.

        :param node: DUT node from topology.
        :param ifc_name: Name of the interface.
        :param sw_if_idx: SW interface index.
        :param ifc_pfx: Interface key prefix.
        :type node: dict
        :type ifc_name: str
        :type sw_if_idx: int
        :type ifc_pfx: str
        """

        if_key = Topology.add_new_port(node, ifc_pfx)

        if ifc_name and sw_if_idx is None:
            sw_if_idx = InterfaceUtil.vpp_get_interface_sw_index(node, ifc_name)
        Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
        if sw_if_idx and ifc_name is None:
            ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
        Topology.update_interface_name(node, if_key, ifc_name)
        ifc_mac = InterfaceUtil.vpp_get_interface_mac(node, sw_if_idx)
        Topology.update_interface_mac_address(node, if_key, ifc_mac)

    @staticmethod
    def vpp_create_avf_interface(node, vf_pci_addr, num_rx_queues=None):
        """Create AVF interface on VPP node.

        :param node: DUT node from topology.
        :param vf_pci_addr: Virtual Function PCI address.
        :param num_rx_queues: Number of RX queues.
        :type node: dict
        :type vf_pci_addr: str
        :type num_rx_queues: int
        :returns: Interface key (name) in topology.
        :rtype: str
        :raises RuntimeError: If it is not possible to create AVF interface on
            the node.
        """

        cmd = 'avf_create'
        args = dict(pci_addr=InterfaceUtil.pci_to_int(vf_pci_addr),
                    enable_elog=0,
                    rxq_num=int(num_rx_queues) if num_rx_queues else 0,
                    rxq_size=0,
                    txq_size=0)
        err_msg = 'Failed to create AVF interface on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

        sw_if_idx = papi_resp['sw_if_index']
        InterfaceUtil.add_eth_interface(node, sw_if_idx=sw_if_idx,
                                        ifc_pfx='eth_avf')
        if_key = Topology.get_interface_by_sw_index(node, sw_if_idx)

        return if_key

    @staticmethod
    def vpp_enslave_physical_interface(node, interface, bond_if):
        """Enslave physical interface to bond interface on VPP node.

        :param node: DUT node from topology.
        :param interface: Physical interface key from topology file.
        :param bond_if: Load balance
        :type node: dict
        :type interface: str
        :type bond_if: str
        :raises RuntimeError: If it is not possible to enslave physical
            interface to bond interface on the node.
        """

        cmd = 'bond_enslave'
        args = dict(
            sw_if_index=Topology.get_interface_sw_index(node, interface),
            bond_sw_if_index=Topology.get_interface_sw_index(node, bond_if),
            is_passive=0,
            is_long_timeout=0)
        err_msg = 'Failed to enslave physical interface {ifc} to bond ' \
                  'interface {bond} on host {host}'.format(ifc=interface,
                                                           bond=bond_if,
                                                           host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

    @staticmethod
    def vpp_show_bond_data_on_node(node, details=False):
        """Show (detailed) bond information on VPP node.

        :param node: DUT node from topology.
        :param details: If detailed information is required or not.
        :type node: dict
        :type details: bool
        """

        cmd = 'sw_interface_bond_dump'
        cmd_reply = 'sw_interface_bond_details'
        err_msg = 'Failed to get bond interface dump on host {host}'.format(
            host=node['host'])

        data = ('Bond data on node {host}:\n'.format(host=node['host']))
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd).get_dump(err_msg)

        papi_dump = papi_resp.reply[0]['api_reply']
        for item in papi_dump:
            data += ('{b}\n'.format(b=item[cmd_reply]['interface_name'].
                                    rstrip('\x00')))
            data += ('  mode: {m}\n'.
                     format(m=LinkBondMode(item[cmd_reply]['mode']).name.
                            lower()))
            data += ('  load balance: {lb}\n'.
                     format(lb=LinkBondLoadBalance(item[cmd_reply]['lb']).name.
                            lower()))
            data += ('  number of active slaves: {n}\n'.
                     format(n=item[cmd_reply]['active_slaves']))
            if details:
                slave_data = InterfaceUtil.vpp_bond_slave_dump(
                    node, Topology.get_interface_by_sw_index(
                        node, item[cmd_reply]['sw_if_index']))
                for slave in slave_data:
                    if not slave['is_passive']:
                        data += ('    {s}\n'.format(s=slave['interface_name']))
            data += ('  number of slaves: {n}\n'.
                     format(n=item[cmd_reply]['slaves']))
            if details:
                for slave in slave_data:
                    data += ('    {s}\n'.format(s=slave['interface_name']))
            data += ('  interface id: {i}\n'.
                     format(i=item[cmd_reply]['id']))
            data += ('  sw_if_index: {i}\n'.
                     format(i=item[cmd_reply]['sw_if_index']))
        logger.info(data)

    @staticmethod
    def vpp_bond_slave_dump(node, interface):
        """Get bond interface slave(s) data on VPP node.

        :param node: DUT node from topology.
        :param interface: Physical interface key from topology file.
        :type node: dict
        :type interface: str
        :returns: Bond slave interface data.
        :rtype: dict
        """
        cmd = 'sw_interface_slave_dump'
        cmd_reply = 'sw_interface_slave_details'
        args = dict(sw_if_index=Topology.get_interface_sw_index(
            node, interface))
        err_msg = 'Failed to get slave dump on host {host}'.format(
            host=node['host'])

        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg)

        papi_dump = papi_resp.reply[0]['api_reply']

        def process_slave_dump(slave_dump):
            """Process slave dump.

            :param slave_dump: Slave interface dump.
            :type slave_dump: dict
            :returns: Processed slave interface dump.
            :rtype: dict
            """
            slave_dump['interface_name'] = slave_dump['interface_name'].\
                rstrip('\x00')
            return slave_dump

        data = list()
        for item in papi_dump:
            data.append(process_slave_dump(item[cmd_reply]))

        logger.debug('Slave data:\n{slave_data}'.format(slave_data=data))
        return data

    @staticmethod
    def vpp_show_bond_data_on_all_nodes(nodes, details=False):
        """Show (detailed) bond information on all VPP nodes in DICT__nodes.

        :param nodes: Nodes in the topology.
        :param details: If detailed information is required or not.
        :type nodes: dict
        :type details: bool
        """
        for node_data in nodes.values():
            if node_data['type'] == NodeType.DUT:
                InterfaceUtil.vpp_show_bond_data_on_node(node_data, details)

    @staticmethod
    def vpp_enable_input_acl_interface(node, interface, ip_version,
                                       table_index):
        """Enable input acl on interface.

        :param node: VPP node to setup interface for input acl.
        :param interface: Interface to setup input acl.
        :param ip_version: Version of IP protocol.
        :param table_index: Classify table index.
        :type node: dict
        :type interface: str or int
        :type ip_version: str
        :type table_index: int
        """

        cmd = 'input_acl_set_interface'
        args = dict(
            sw_if_index=InterfaceUtil.get_interface_index(node, interface),
            ip4_table_index=table_index if ip_version == 'ip4'
            else Constants.BITWISE_NON_ZERO,
            ip6_table_index=table_index if ip_version == 'ip6'
            else Constants.BITWISE_NON_ZERO,
            l2_table_index=table_index if ip_version == 'l2'
            else Constants.BITWISE_NON_ZERO,
            is_add=1)
        err_msg = 'Failed to enable input acl on interface {ifc}'.format(
            ifc=interface)
        with PapiExecutor(node) as papi_exec:
            papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

    @staticmethod
    def get_interface_classify_table(node, interface):
        """Get name of classify table for the given interface.

        TODO: Move to Classify.py.

        :param node: VPP node to get data from.
        :param interface: Name or sw_if_index of a specific interface.
        :type node: dict
        :type interface: str or int
        :returns: Classify table name.
        :rtype: str
        """
        if isinstance(interface, basestring):
            sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
        else:
            sw_if_index = interface

        cmd = 'classify_table_by_interface'
        args = dict(sw_if_index=sw_if_index)
        err_msg = 'Failed to get classify table name by interface {ifc}'.format(
            ifc=interface)
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg). \
                verify_reply(err_msg=err_msg)

        return papi_resp

    @staticmethod
    def get_interface_vrf_table(node, interface, ip_version='ipv4'):
        """Get vrf ID for the given interface.

        TODO: Move to proper IP library when implementing CSIT-1459.

        :param node: VPP node.
        :param interface: Name or sw_if_index of a specific interface.
        :type node: dict
        :param ip_version: IP protocol version (ipv4 or ipv6).
        :type interface: str or int
        :type ip_version: str
        :returns: vrf ID of the specified interface.
        :rtype: int
        """
        if isinstance(interface, basestring):
            sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
        else:
            sw_if_index = interface

        is_ipv6 = 1 if ip_version == 'ipv6' else 0

        cmd = 'sw_interface_get_table'
        args = dict(sw_if_index=sw_if_index,
                    is_ipv6=is_ipv6)
        err_msg = 'Failed to get VRF id assigned to interface {ifc}'.format(
            ifc=interface)
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_replies(err_msg). \
                verify_reply(err_msg=err_msg)

        return papi_resp['vrf_id']

    @staticmethod
    def get_sw_if_index(node, interface_name):
        """Get sw_if_index for the given interface from actual interface dump.

        :param node: VPP node to get interface data from.
        :param interface_name: Name of the specific interface.
        :type node: dict
        :type interface_name: str
        :returns: sw_if_index of the given interface.
        :rtype: str
        """

        interface_data = InterfaceUtil.vpp_get_interface_data(
            node, interface=interface_name)
        return interface_data.get('sw_if_index')

    @staticmethod
    def vxlan_gpe_dump(node, interface_name=None):
        """Get VxLAN GPE data for the given interface.

        :param node: VPP node to get interface data from.
        :param interface_name: Name of the specific interface. If None,
            information about all VxLAN GPE interfaces is returned.
        :type node: dict
        :type interface_name: str
        :returns: Dictionary containing data for the given VxLAN GPE interface
            or if interface=None, the list of dictionaries with all VxLAN GPE
            interfaces.
        :rtype: dict or list
        """

        if interface_name is not None:
            sw_if_index = InterfaceUtil.get_interface_index(
                node, interface_name)
        else:
            sw_if_index = int(Constants.BITWISE_NON_ZERO)

        cmd = 'vxlan_gpe_tunnel_dump'
        cmd_reply = 'vxlan_gpe_tunnel_details'
        args = dict(sw_if_index=sw_if_index)
        err_msg = 'Failed to get VXLAN-GPE dump on host {host}'.format(
            host=node['host'])
        with PapiExecutor(node) as papi_exec:
            papi_resp = papi_exec.add(cmd, **args).get_dump(err_msg)

        papi_vxlan_dump = papi_resp.reply[0]['api_reply']

        def process_vxlan_gpe_dump(vxlan_dump):
            """Process vxlan_gpe dump.

            :param vxlan_dump: Vxlan_gpe nterface dump.
            :type vxlan_dump: dict
            :returns: Processed vxlan_gpe interface dump.
            :rtype: dict
            """
            if vxlan_dump['is_ipv6']:
                vxlan_dump['local'] = \
                    inet_ntop(AF_INET6, vxlan_dump['local'])
                vxlan_dump['remote'] = \
                    inet_ntop(AF_INET6, vxlan_dump['remote'])
            else:
                vxlan_dump['local'] = \
                    inet_ntop(AF_INET, vxlan_dump['local'][0:4])
                vxlan_dump['remote'] = \
                    inet_ntop(AF_INET, vxlan_dump['remote'][0:4])
            return vxlan_dump

        data = list() if interface_name is None else dict()
        for item in papi_vxlan_dump:
            if interface_name is None:
                data.append(process_vxlan_gpe_dump(item[cmd_reply]))
            elif item[cmd_reply]['sw_if_index'] == sw_if_index:
                data = process_vxlan_gpe_dump(item[cmd_reply])
                break

        logger.debug('VXLAN-GPE data:\n{vxlan_gpe_data}'.format(
            vxlan_gpe_data=data))
        return data

    @staticmethod
    def vpp_ip_source_check_setup(node, if_name):
        """Setup Reverse Path Forwarding source check on interface.

        TODO: Move to proper IP library when implementing CSIT-1459.

        :param node: Node to setup RPF source check.
        :param if_name: Interface name to setup RPF source check.
        :type node: dict
        :type if_name: str
        """

        cmd = 'ip_source_check_interface_add_del'
        args = dict(
            sw_if_index=InterfaceUtil.get_interface_index(node, if_name),
            is_add=1,
            loose=0)
        err_msg = 'Failed to enable source check on interface {ifc}'.format(
            ifc=if_name)
        with PapiExecutor(node) as papi_exec:
            papi_exec.add(cmd, **args).get_replies(err_msg). \
                verify_reply(err_msg=err_msg)

    @staticmethod
    def assign_interface_to_fib_table(node, interface, table_id, ipv6=False):
        """Assign VPP interface to specific VRF/FIB table.

        :param node: VPP node where the FIB and interface are located.
        :param interface: Interface to be assigned to FIB.
        :param table_id: VRF table ID.
        :param ipv6: Assign to IPv6 table. Default False.
        :type node: dict
        :type interface: str or int
        :type table_id: int
        :type ipv6: bool
        """

        cmd = 'sw_interface_set_table'
        args = dict(
            sw_if_index=InterfaceUtil.get_interface_index(node, interface),
            is_ipv6=1 if ipv6 else 0,
            vrf_id=int(table_id))
        err_msg = 'Failed to assign interface {ifc} to FIB table'.format(
            ifc=interface)
        with PapiExecutor(node) as papi_exec:
            papi_exec.add(cmd, **args).get_replies(err_msg). \
                verify_reply(err_msg=err_msg)

    @staticmethod
    def set_linux_interface_mac(node, interface, mac, namespace=None,
                                vf_id=None):
        """Set MAC address for interface in linux.

        :param node: Node where to execute command.
        :param interface: Interface in namespace.
        :param mac: MAC to be assigned to interface.
        :param namespace: Execute command in namespace. Optional
        :param vf_id: Virtual Function id. Optional
        :type node: dict
        :type interface: str
        :type mac: str
        :type namespace: str
        :type vf_id: int
        """
        mac_str = 'vf {vf_id} mac {mac}'.format(vf_id=vf_id, mac=mac) \
            if vf_id is not None else 'address {mac}'.format(mac=mac)
        ns_str = 'ip netns exec {ns}'.format(ns=namespace) if namespace else ''

        cmd = ('{ns} ip link set {interface} {mac}'.
               format(ns=ns_str, interface=interface, mac=mac_str))
        exec_cmd_no_error(node, cmd, sudo=True)

    @staticmethod
    def set_linux_interface_trust_on(node, interface, namespace=None,
                                     vf_id=None):
        """Set trust on (promisc) for interface in linux.

        :param node: Node where to execute command.
        :param interface: Interface in namespace.
        :param namespace: Execute command in namespace. Optional
        :param vf_id: Virtual Function id. Optional
        :type node: dict
        :type interface: str
        :type namespace: str
        :type vf_id: int
        """
        trust_str = 'vf {vf_id} trust on'.format(vf_id=vf_id) \
            if vf_id is not None else 'trust on'
        ns_str = 'ip netns exec {ns}'.format(ns=namespace) if namespace else ''

        cmd = ('{ns} ip link set dev {interface} {trust}'.
               format(ns=ns_str, interface=interface, trust=trust_str))
        exec_cmd_no_error(node, cmd, sudo=True)

    @staticmethod
    def set_linux_interface_spoof_off(node, interface, namespace=None,
                                      vf_id=None):
        """Set spoof off for interface in linux.

        :param node: Node where to execute command.
        :param interface: Interface in namespace.
        :param namespace: Execute command in namespace. Optional
        :param vf_id: Virtual Function id. Optional
        :type node: dict
        :type interface: str
        :type namespace: str
        :type vf_id: int
        """
        spoof_str = 'vf {vf_id} spoof off'.format(vf_id=vf_id) \
            if vf_id is not None else 'spoof off'
        ns_str = 'ip netns exec {ns}'.format(ns=namespace) if namespace else ''

        cmd = ('{ns} ip link set dev {interface} {spoof}'.
               format(ns=ns_str, interface=interface, spoof=spoof_str))
        exec_cmd_no_error(node, cmd, sudo=True)

    @staticmethod
    def init_avf_interface(node, ifc_key, numvfs=1, osi_layer='L2'):
        """Init PCI device by creating VFs and bind them to vfio-pci for AVF
        driver testing on DUT.

        :param node: DUT node.
        :param ifc_key: Interface key from topology file.
        :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
        :param osi_layer: OSI Layer type to initialize TG with.
            Default value "L2" sets linux interface spoof off.
        :type node: dict
        :type ifc_key: str
        :type numvfs: int
        :type osi_layer: str
        :returns: Virtual Function topology interface keys.
        :rtype: list
        :raises RuntimeError: If a reason preventing initialization is found.
        """
        ssh = SSH()
        ssh.connect(node)

        # Read PCI address and driver.
        pf_pci_addr = Topology.get_interface_pci_addr(node, ifc_key)
        pf_mac_addr = Topology.get_interface_mac(node, ifc_key).split(":")
        uio_driver = Topology.get_uio_driver(node)
        kernel_driver = Topology.get_interface_driver(node, ifc_key)
        if kernel_driver != "i40e":
            raise RuntimeError(
                "AVF needs i40e driver, not {driver} at node {host} ifc {ifc}"\
                .format(driver=kernel_driver, host=node["host"], ifc=ifc_key))
        current_driver = DUTSetup.get_pci_dev_driver(
            node, pf_pci_addr.replace(':', r'\:'))

        VPPUtil.stop_vpp_service(node)
        if current_driver != kernel_driver:
            # PCI device must be re-bound to kernel driver before creating VFs.
            DUTSetup.verify_kernel_module(node, kernel_driver, force_load=True)
            # Stop VPP to prevent deadlock.
            # Unbind from current driver.
            DUTSetup.pci_driver_unbind(node, pf_pci_addr)
            # Bind to kernel driver.
            DUTSetup.pci_driver_bind(node, pf_pci_addr, kernel_driver)

        # Initialize PCI VFs
        DUTSetup.set_sriov_numvfs(node, pf_pci_addr, numvfs)

        vf_ifc_keys = []
        # Set MAC address and bind each virtual function to uio driver.
        for vf_id in range(numvfs):
            vf_mac_addr = ":".join([pf_mac_addr[0], pf_mac_addr[2],
                                    pf_mac_addr[3], pf_mac_addr[4],
                                    pf_mac_addr[5], "{:02x}".format(vf_id)])

            pf_dev = '`basename /sys/bus/pci/devices/{pci}/net/*`'.\
                format(pci=pf_pci_addr)
            InterfaceUtil.set_linux_interface_trust_on(node, pf_dev,
                                                       vf_id=vf_id)
            if osi_layer == 'L2':
                InterfaceUtil.set_linux_interface_spoof_off(node, pf_dev,
                                                            vf_id=vf_id)
            InterfaceUtil.set_linux_interface_mac(node, pf_dev, vf_mac_addr,
                                                  vf_id=vf_id)

            DUTSetup.pci_vf_driver_unbind(node, pf_pci_addr, vf_id)
            DUTSetup.pci_vf_driver_bind(node, pf_pci_addr, vf_id, uio_driver)

            # Add newly created ports into topology file
            vf_ifc_name = '{pf_if_key}_vf'.format(pf_if_key=ifc_key)
            vf_pci_addr = DUTSetup.get_virtfn_pci_addr(node, pf_pci_addr, vf_id)
            vf_ifc_key = Topology.add_new_port(node, vf_ifc_name)
            Topology.update_interface_name(node, vf_ifc_key,
                                           vf_ifc_name+str(vf_id+1))
            Topology.update_interface_mac_address(node, vf_ifc_key, vf_mac_addr)
            Topology.update_interface_pci_address(node, vf_ifc_key, vf_pci_addr)
            vf_ifc_keys.append(vf_ifc_key)

        return vf_ifc_keys

    @staticmethod
    def vpp_create_multiple_vxlan_ipv4_tunnels(
            node, node_vxlan_if, node_vlan_if, op_node, op_node_if,
            n_tunnels, vni_start, src_ip_start, dst_ip_start, ip_step, ip_limit,
            bd_id_start):
        """Create multiple VXLAN tunnel interfaces and VLAN sub-interfaces on
        VPP node.

        Put each pair of VXLAN tunnel interface and VLAN sub-interface to
        separate bridge-domain.

        :param node: VPP node to create VXLAN tunnel interfaces.
        :param node_vxlan_if: VPP node interface key to create VXLAN tunnel
            interfaces.
        :param node_vlan_if: VPP node interface key to create VLAN
            sub-interface.
        :param op_node: Opposite VPP node for VXLAN tunnel interfaces.
        :param op_node_if: Opposite VPP node interface key for VXLAN tunnel
            interfaces.
        :param n_tunnels: Number of tunnel interfaces to create.
        :param vni_start: VNI start ID.
        :param src_ip_start: VXLAN tunnel source IP address start.
        :param dst_ip_start: VXLAN tunnel destination IP address start.
        :param ip_step: IP address incremental step.
        :param ip_limit: IP address limit.
        :param bd_id_start: Bridge-domain ID start.
        :type node: dict
        :type node_vxlan_if: str
        :type node_vlan_if: str
        :type op_node: dict
        :type op_node_if: str
        :type n_tunnels: int
        :type vni_start: int
        :type src_ip_start: str
        :type dst_ip_start: str
        :type ip_step: int
        :type ip_limit: str
        :type bd_id_start: int
        """
        # configure IPs, create VXLAN interfaces and VLAN sub-interfaces
        vxlan_count = InterfaceUtil.vpp_create_vxlan_and_vlan_interfaces(
            node, node_vxlan_if, node_vlan_if, n_tunnels, vni_start,
            src_ip_start, dst_ip_start, ip_step, ip_limit)

        # update topology with VXLAN interfaces and VLAN sub-interfaces data
        # and put interfaces up
        InterfaceUtil.vpp_put_vxlan_and_vlan_interfaces_up(
            node, vxlan_count, node_vlan_if)

        # configure bridge domains, ARPs and routes
        InterfaceUtil.vpp_put_vxlan_and_vlan_interfaces_to_bridge_domain(
            node, node_vxlan_if, vxlan_count, op_node, op_node_if, dst_ip_start,
            ip_step, bd_id_start)

    @staticmethod
    def vpp_create_vxlan_and_vlan_interfaces(
            node, node_vxlan_if, node_vlan_if, vxlan_count, vni_start,
            src_ip_start, dst_ip_start, ip_step, ip_limit):
        """
        Configure IPs, create VXLAN interfaces and VLAN sub-interfaces on VPP
        node.

        :param node: VPP node.
        :param node_vxlan_if: VPP node interface key to create VXLAN tunnel
            interfaces.
        :param node_vlan_if: VPP node interface key to create VLAN
            sub-interface.
        :param vxlan_count: Number of tunnel interfaces to create.
        :param vni_start: VNI start ID.
        :param src_ip_start: VXLAN tunnel source IP address start.
        :param dst_ip_start: VXLAN tunnel destination IP address start.
        :param ip_step: IP address incremental step.
        :param ip_limit: IP address limit.
        :type node: dict
        :type node_vxlan_if: str
        :type node_vlan_if: str
        :type vxlan_count: int
        :type vni_start: int
        :type src_ip_start: str
        :type dst_ip_start: str
        :type ip_step: int
        :type ip_limit: str
        :returns: Number of created VXLAN interfaces.
        :rtype: int
        """

        try:
            src_address_start = IPv6Address(unicode(src_ip_start))
            dst_address_start = IPv6Address(unicode(dst_ip_start))
            ip_address_limit = IPv6Address(unicode(ip_limit))
            af_inet = AF_INET6
            is_ipv6 = 1
        except (AddressValueError, NetmaskValueError):
            src_address_start = IPv4Address(unicode(src_ip_start))
            dst_address_start = IPv4Address(unicode(dst_ip_start))
            ip_address_limit = IPv4Address(unicode(ip_limit))
            af_inet = AF_INET
            is_ipv6 = 0

        with PapiExecutor(node) as papi_exec:
            for i in xrange(0, vxlan_count):
                src_ip = src_address_start + i * ip_step
                dst_ip = dst_address_start + i * ip_step
                if src_ip > ip_address_limit or dst_ip > ip_address_limit:
                    logger.warn("Can't do more iterations - IP address limit "
                                "has been reached.")
                    vxlan_count = i
                    break
                cmd = 'sw_interface_add_del_address'
                args = dict(
                    sw_if_index=InterfaceUtil.get_interface_index(
                        node, node_vxlan_if),
                    is_add=1,
                    is_ipv6=0,
                    del_all=0,
                    address_length=128 if is_ipv6 else 32,
                    address=inet_pton(af_inet, str(src_ip)))
                papi_exec.add(cmd, **args)
                cmd = 'vxlan_add_del_tunnel'
                args = dict(
                    is_add=1,
                    is_ipv6=0,
                    instance=Constants.BITWISE_NON_ZERO,
                    src_address=inet_pton(af_inet, str(src_ip)),
                    dst_address=inet_pton(af_inet, str(dst_ip)),
                    mcast_sw_if_index=Constants.BITWISE_NON_ZERO,
                    encap_vrf_id=0,
                    decap_next_index=Constants.BITWISE_NON_ZERO,
                    vni=int(vni_start)+i)
                papi_exec.add(cmd, **args)
                cmd = 'create_vlan_subif'
                args = dict(
                    sw_if_index=InterfaceUtil.get_interface_index(
                        node, node_vlan_if),
                    vlan_id=i+1)
                papi_exec.add(cmd, **args)
            papi_exec.get_replies().verify_replies()

        return vxlan_count

    @staticmethod
    def vpp_put_vxlan_and_vlan_interfaces_up(node, vxlan_count, node_vlan_if):
        """
        Update topology with VXLAN interfaces and VLAN sub-interfaces data
        and put interfaces up.

        :param node: VPP node.
        :param vxlan_count: Number of tunnel interfaces.
        :param node_vlan_if: VPP node interface key where VLAN sub-interfaces
            have been created.
        :type node: dict
        :type vxlan_count: int
        :type node_vlan_if: str
        """

        if_data = InterfaceUtil.vpp_get_interface_data(node)

        with PapiExecutor(node) as papi_exec:
            for i in xrange(0, vxlan_count):
                vxlan_subif_key = Topology.add_new_port(node, 'vxlan_tunnel')
                vxlan_subif_name = 'vxlan_tunnel{nr}'.format(nr=i)
                vxlan_found = False
                vxlan_subif_idx = None
                vlan_subif_key = Topology.add_new_port(node, 'vlan_subif')
                vlan_subif_name = '{if_name}.{vlan}'.format(
                    if_name=Topology.get_interface_name(
                        node, node_vlan_if), vlan=i+1)
                vlan_found = False
                vlan_idx = None
                for data in if_data:
                    if not vxlan_found \
                            and data['interface_name'] == vxlan_subif_name:
                        vxlan_subif_idx = data['sw_if_index']
                        vxlan_found = True
                    elif not vlan_found \
                            and data['interface_name'] == vlan_subif_name:
                        vlan_idx = data['sw_if_index']
                        vlan_found = True
                    if vxlan_found and vlan_found:
                        break
                Topology.update_interface_sw_if_index(
                    node, vxlan_subif_key, vxlan_subif_idx)
                Topology.update_interface_name(
                    node, vxlan_subif_key, vxlan_subif_name)
                cmd = 'sw_interface_set_flags'
                args1 = dict(sw_if_index=vxlan_subif_idx,
                             admin_up_down=1)
                Topology.update_interface_sw_if_index(
                    node, vlan_subif_key, vlan_idx)
                Topology.update_interface_name(
                    node, vlan_subif_key, vlan_subif_name)
                args2 = dict(sw_if_index=vlan_idx,
                             admin_up_down=1)
                papi_exec.add(cmd, **args1).add(cmd, **args2)
            papi_exec.get_replies().verify_replies()

    @staticmethod
    def vpp_put_vxlan_and_vlan_interfaces_to_bridge_domain(
            node, node_vxlan_if, vxlan_count, op_node, op_node_if, dst_ip_start,
            ip_step, bd_id_start):
        """
        Configure ARPs and routes for VXLAN interfaces and put each pair of
        VXLAN tunnel interface and VLAN sub-interface to separate bridge-domain.

        :param node: VPP node.
        :param node_vxlan_if: VPP node interface key where VXLAN tunnel
            interfaces have been created.
        :param vxlan_count: Number of tunnel interfaces.
        :param op_node: Opposite VPP node for VXLAN tunnel interfaces.
        :param op_node_if: Opposite VPP node interface key for VXLAN tunnel
            interfaces.
        :param dst_ip_start: VXLAN tunnel destination IP address start.
        :param ip_step: IP address incremental step.
        :param bd_id_start: Bridge-domain ID start.
        :type node: dict
        :type node_vxlan_if: str
        :type vxlan_count: int
        :type op_node: dict
        :type op_node_if:
        :type dst_ip_start: str
        :type ip_step: int
        :type bd_id_start: int
        """

        try:
            dst_address_start = IPv6Address(unicode(dst_ip_start))
            af_inet = AF_INET6
            is_ipv6 = 1
        except (AddressValueError, NetmaskValueError):
            dst_address_start = IPv4Address(unicode(dst_ip_start))
            af_inet = AF_INET
            is_ipv6 = 0

        with PapiExecutor(node) as papi_exec:
            for i in xrange(0, vxlan_count):
                dst_ip = dst_address_start + i * ip_step
                neighbor = dict(
                    sw_if_index=Topology.get_interface_sw_index(
                        node, node_vxlan_if),
                    flags=0,
                    mac_address=str(
                        Topology.get_interface_mac(op_node, op_node_if)),
                    ip_address=str(dst_ip))
                cmd = 'ip_neighbor_add_del'
                args = dict(
                    is_add=1,
                    neighbor=neighbor)
                papi_exec.add(cmd, **args)
                cmd = 'ip_add_del_route'
                args = dict(
                    next_hop_sw_if_index=Topology.get_interface_sw_index(
                        node, node_vxlan_if),
                    table_id=0,
                    is_add=1,
                    is_ipv6=is_ipv6,
                    next_hop_weight=1,
                    next_hop_proto=1 if is_ipv6 else 0,
                    dst_address_length=128 if is_ipv6 else 32,
                    dst_address=inet_pton(af_inet, str(dst_ip)),
                    next_hop_address=inet_pton(af_inet, str(dst_ip)))
                papi_exec.add(cmd, **args)
                cmd = 'sw_interface_set_l2_bridge'
                args = dict(
                    rx_sw_if_index=Topology.get_interface_sw_index(
                        node, 'vxlan_tunnel{nr}'.format(nr=i+1)),
                    bd_id=int(bd_id_start+i),
                    shg=0,
                    port_type=0,
                    enable=1)
                papi_exec.add(cmd, **args)
                args = dict(
                    rx_sw_if_index=Topology.get_interface_sw_index(
                        node, 'vlan_subif{nr}'.format(nr=i+1)),
                    bd_id=int(bd_id_start+i),
                    shg=0,
                    port_type=0,
                    enable=1)
                papi_exec.add(cmd, **args)
            papi_exec.get_replies().verify_replies()

    @staticmethod
    def vpp_sw_interface_rx_placement_dump(node):
        """Dump VPP interface RX placement on node.

        :param node: Node to run command on.
        :type node: dict
        :returns: Thread mapping information as a list of dictionaries.
        :rtype: list
        """

        cmd = 'sw_interface_rx_placement_dump'
        cmd_reply = 'sw_interface_rx_placement_details'
        err_msg = "Failed to run '{cmd}' PAPI command on host {host}!".format(
            cmd=cmd, host=node['host'])
        with PapiExecutor(node) as papi_exec:
            for ifc in node['interfaces'].values():
                if ifc['vpp_sw_index'] is not None:
                    papi_exec.add(cmd, sw_if_index=ifc['vpp_sw_index'])
            papi_resp = papi_exec.get_dump(err_msg)
        thr_mapping = [s[cmd_reply] for r in papi_resp.reply
                       for s in r['api_reply']]
        return sorted(thr_mapping, key=lambda k: k['sw_if_index'])

    @staticmethod
    def vpp_sw_interface_set_rx_placement(node, sw_if_index, queue_id,
                                          worker_id):
        """Set interface RX placement to worker on node.

        :param node: Node to run command on.
        :param sw_if_index: VPP SW interface index.
        :param queue_id: VPP interface queue ID.
        :param worker_id: VPP worker ID (indexing from 0).
        :type node: dict
        :type sw_if_index: int
        :type queue_id: int
        :type worker_id: int
        :raises RuntimeError: If failed to run command on host or if no API
            reply received.
        """

        cmd = 'sw_interface_set_rx_placement'
        err_msg = "Failed to set interface RX placement to worker on host " \
                  "{host}!".format(host=node['host'])
        args = dict(sw_if_index=sw_if_index, queue_id=queue_id,
                    worker_id=worker_id)
        with PapiExecutor(node) as papi_exec:
            papi_exec.add(cmd, **args).get_replies(err_msg).\
                verify_reply(err_msg=err_msg)

    @staticmethod
    def vpp_round_robin_rx_placement(node, prefix):
        """Set Round Robin interface RX placement on all worker threads
        on node.

        :param node: Topology nodes.
        :param prefix: Interface name prefix.
        :type node: dict
        :type prefix: str
        """
        worker_id = 0
        worker_cnt = len(VPPUtil.vpp_show_threads(node)) - 1
        for placement in InterfaceUtil.vpp_sw_interface_rx_placement_dump(node):
            for interface in node['interfaces'].values():
                if placement['sw_if_index'] == interface['vpp_sw_index'] \
                    and prefix in interface['name']:
                    InterfaceUtil.vpp_sw_interface_set_rx_placement(
                        node, placement['sw_if_index'], placement['queue_id'],
                        worker_id % worker_cnt)
                    worker_id += 1

    @staticmethod
    def vpp_round_robin_rx_placement_on_all_duts(nodes, prefix):
        """Set Round Robin interface RX placement on all worker threads
        on all DUTs.

        :param nodes: Topology nodes.
        :param prefix: Interface name prefix.
        :type nodes: dict
        :type prefix: str
        """
        for node in nodes.values():
            if node['type'] == NodeType.DUT:
                InterfaceUtil.vpp_round_robin_rx_placement(node, prefix)


context:
space:
mode: