X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=resources%2Flibraries%2Fpython%2FDPDK%2FDPDKTools.py;h=b403c3a5f9279ab277e68bbd4410e491e3896b87;hb=HEAD;hp=ecb23fb4c3b62d106ad9d0b3b13dbeb7210d1e44;hpb=d68951ac245150eeefa6e0f4156e4c1b5c9e9325;p=csit.git diff --git a/resources/libraries/python/DPDK/DPDKTools.py b/resources/libraries/python/DPDK/DPDKTools.py index ecb23fb4c3..83ddae8b4a 100644 --- a/resources/libraries/python/DPDK/DPDKTools.py +++ b/resources/libraries/python/DPDK/DPDKTools.py @@ -1,4 +1,4 @@ -# Copyright (c) 2019 Cisco and/or its affiliates. +# Copyright (c) 2021 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: @@ -12,12 +12,12 @@ # limitations under the License. -"""This module implements initialization and cleanup of DPDK environment.""" +"""This module implements initialization and cleanup of DPDK framework.""" from robot.api import logger from resources.libraries.python.Constants import Constants -from resources.libraries.python.ssh import SSH, exec_cmd_no_error +from resources.libraries.python.ssh import exec_cmd_no_error from resources.libraries.python.topology import NodeType, Topology @@ -28,102 +28,99 @@ class DPDKTools: """ @staticmethod - def initialize_dpdk_environment(dut_node, dut_if1, dut_if2): + def initialize_dpdk_framework(node, if1, if2, nic_driver): """ - Initialize the DPDK test environment on the dut_node. - Load the module uio and igb_uio, then bind the test NIC to the igb_uio. - - :param dut_node: Will init the DPDK on this node. - :param dut_if1: DUT interface name. - :param dut_if2: DUT interface name. - :type dut_node: dict - :type dut_if1: str - :type dut_if2: str - :raises RuntimeError: If it fails to bind the interfaces to igb_uio. - """ - if dut_node[u"type"] == NodeType.DUT: - pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1) - pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2) - - ssh = SSH() - ssh.connect(dut_node) + Initialize the DPDK framework on the DUT node. Bind interfaces to + driver. - arch = Topology.get_node_arch(dut_node) - cmd = f"{Constants.REMOTE_FW_DIR}/tests/dpdk/dpdk_scripts" \ - f"/init_dpdk.sh {pci_address1} {pci_address2} {arch}" + :param node: DUT node. + :param if1: DUT first interface name. + :param if2: DUT second interface name. + :param nic_driver: Interface driver. + :type node: dict + :type if1: str + :type if2: str + :type nic_driver: str + :raises RuntimeError: If it fails to bind the interfaces to driver. + """ + if node[u"type"] == NodeType.DUT: + pci_address1 = Topology.get_interface_pci_addr(node, if1) + pci_address2 = Topology.get_interface_pci_addr(node, if2) - ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600) - if ret_code != 0: - raise RuntimeError( - f"Failed to bind the interfaces to igb_uio at node " - f"{dut_node['host']}" - ) + command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\ + f"/entry/init_dpdk.sh " \ + f"{nic_driver} {pci_address1} {pci_address2}" + message = u"Initialize the DPDK failed!" + exec_cmd_no_error(node, command, timeout=600, message=message) @staticmethod - def cleanup_dpdk_environment(dut_node, dut_if1, dut_if2): + def cleanup_dpdk_framework(node, if1, if2): """ - Cleanup the DPDK test environment on the DUT node. - Unbind the NIC from the igb_uio and bind them to the kernel driver. - - :param dut_node: Will cleanup the DPDK on this node. - :param dut_if1: DUT interface name. - :param dut_if2: DUT interface name. - :type dut_node: dict - :type dut_if1: str - :type dut_if2: str + Cleanup the DPDK framework on the DUT node. Bind interfaces to + default driver specified in topology. + + :param node: Will cleanup the DPDK on this node. + :param if1: DUT first interface name. + :param if2: DUT second interface name. + :type node: dict + :type if1: str + :type if2: str :raises RuntimeError: If it fails to cleanup the dpdk. """ - if dut_node[u"type"] == NodeType.DUT: - pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1) - if1_driver = Topology.get_interface_driver(dut_node, dut_if1) - pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2) - if2_driver = Topology.get_interface_driver(dut_node, dut_if2) + if node[u"type"] == NodeType.DUT: + pci_address1 = Topology.get_interface_pci_addr(node, if1) + pci_address2 = Topology.get_interface_pci_addr(node, if2) + # We are not supporting more than one driver yet. + nic_driver = Topology.get_interface_driver(node, if1) + + command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\ + f"/entry/cleanup_dpdk.sh " \ + f"{nic_driver} {pci_address1} {pci_address2}" + message = u"Cleanup the DPDK failed!" + exec_cmd_no_error(node, command, timeout=1200, message=message) - ssh = SSH() - ssh.connect(dut_node) + @staticmethod + def get_dpdk_version(node): + """Log and return the installed DPDK version. - cmd = f"{Constants.REMOTE_FW_DIR}/tests/dpdk/dpdk_scripts" \ - f"/cleanup_dpdk.sh {if1_driver} {pci_address1} {if2_driver} " \ - f"{pci_address2}" + The logged string ends with newline, the returned one is stripped. - ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600) - if ret_code != 0: - raise RuntimeError( - f"Failed to cleanup the dpdk at node {dut_node[u'host']}" - ) + :param node: Node from topology file. + :type node: dict + :returns: Stripped DPDK version string. + :rtype: str + :raises RuntimeError: If command returns nonzero return code. + """ + command = f"cat {Constants.REMOTE_FW_DIR}/dpdk*/VERSION" + message = u"Get DPDK version failed!" + stdout, _ = exec_cmd_no_error(node, command, message=message) + # TODO: PAL should already tolerate stripped value in the log. + logger.info(f"DPDK Version: {stdout}") + return stdout.strip() @staticmethod - def install_dpdk_test(node): + def install_dpdk_framework(node): """ - Prepare the DPDK test environment + Prepare the DPDK framework on the DUT node. - :param node: Dictionary created from topology + :param node: Node from topology file. :type node: dict - :returns: nothing :raises RuntimeError: If command returns nonzero return code. """ - arch = Topology.get_node_arch(node) - - command = f"{Constants.REMOTE_FW_DIR}/tests/dpdk/dpdk_scripts" \ - f"/install_dpdk.sh {arch}" + command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}" \ + f"/entry/install_dpdk.sh" message = u"Install the DPDK failed!" - exec_cmd_no_error(node, command, timeout=600, message=message) - - command = f"cat {Constants.REMOTE_FW_DIR}/dpdk*/VERSION" - message = u"Get DPDK version failed!" - stdout, _ = exec_cmd_no_error(node, command, message=message) - - logger.info(f"DPDK Version: {stdout}") + exec_cmd_no_error(node, command, timeout=3600, message=message) + DPDKTools.get_dpdk_version(node) @staticmethod - def install_dpdk_test_on_all_duts(nodes): + def install_dpdk_framework_on_all_duts(nodes): """ - Prepare the DPDK test environment on all DUTs. + Prepare the DPDK framework on all DUTs. :param nodes: Nodes from topology file. :type nodes: dict - :returns: nothing """ for node in list(nodes.values()): if node[u"type"] == NodeType.DUT: - DPDKTools.install_dpdk_test(node) + DPDKTools.install_dpdk_framework(node)