1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
15 """This module implements initialization and cleanup of DPDK environment."""
17 from resources.libraries.python.ssh import SSH
18 from resources.libraries.python.Constants import Constants
19 from resources.libraries.python.topology import NodeType, Topology
22 class DPDKTools(object):
23 """This class implements:
24 - Initialization of DPDK environment,
25 - Cleanup of DPDK environment.
29 def initialize_dpdk_environment(dut_node, dut_if1, dut_if2):
31 Initialize the DPDK test environment on the dut_node.
32 Load the module uio and igb_uio, then bind the test NIC to the igb_uio.
34 :param dut_node: Will init the DPDK on this node.
35 :param dut_if1: DUT interface name.
36 :param dut_if2: DUT interface name.
40 :raises RuntimeError: If it fails to bind the interfaces to igb_uio.
42 if dut_node['type'] == NodeType.DUT:
43 pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1)
44 pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2)
49 arch = Topology.get_node_arch(dut_node)
50 cmd = '{fwdir}/tests/dpdk/dpdk_scripts/init_dpdk.sh '\
51 '{pci1} {pci2} {arch}'.format(fwdir=Constants.REMOTE_FW_DIR,
56 ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
58 raise RuntimeError('Failed to bind the interfaces to igb_uio '
60 format(name=dut_node['host']))
63 def cleanup_dpdk_environment(dut_node, dut_if1, dut_if2):
65 Cleanup the DPDK test environment on the DUT node.
66 Unbind the NIC from the igb_uio and bind them to the kernel driver.
68 :param dut_node: Will cleanup the DPDK on this node.
69 :param dut_if1: DUT interface name.
70 :param dut_if2: DUT interface name.
74 :raises RuntimeError: If it fails to cleanup the dpdk.
76 if dut_node['type'] == NodeType.DUT:
77 pci_address1 = Topology.get_interface_pci_addr(dut_node, dut_if1)
78 if1_driver = Topology.get_interface_driver(dut_node, dut_if1)
79 pci_address2 = Topology.get_interface_pci_addr(dut_node, dut_if2)
80 if2_driver = Topology.get_interface_driver(dut_node, dut_if2)
85 cmd = '{fwdir}/tests/dpdk/dpdk_scripts/cleanup_dpdk.sh ' \
86 '{drv1} {pci1} {drv2} {pci2}'.\
87 format(fwdir=Constants.REMOTE_FW_DIR, drv1=if1_driver,
88 pci1=pci_address1, drv2=if2_driver, pci2=pci_address2)
90 ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
92 raise RuntimeError('Failed to cleanup the dpdk at node {name}'.
93 format(name=dut_node['host']))
96 def install_dpdk_test(node):
98 Prepare the DPDK test environment
100 :param node: Dictionary created from topology
103 :raises RuntimeError: If command returns nonzero return code.
105 arch = Topology.get_node_arch(node)
110 ret_code, _, _ = ssh.exec_command(
111 '{fwdir}/tests/dpdk/dpdk_scripts/install_dpdk.sh {arch}'.
112 format(fwdir=Constants.REMOTE_FW_DIR, arch=arch), timeout=600)
115 raise RuntimeError('Install the DPDK failed')
118 def install_dpdk_test_on_all_duts(nodes):
120 Prepare the DPDK test environment on all DUTs.
122 :param nodes: Nodes from topology file.
126 for node in nodes.values():
127 if node['type'] == NodeType.DUT:
128 DPDKTools.install_dpdk_test(node)