resources/libraries/python/DPDK/L3fwdTest.py

   1 # Copyright (c) 2019 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """
  15 This module exists to provide the l3fwd test for DPDK on topology nodes.
  16 """
  17
  18 from resources.libraries.python.ssh import SSH
  19 from resources.libraries.python.constants import Constants
  20 from resources.libraries.python.topology import NodeType, Topology
  21
  22
  23 class L3fwdTest(object):
  24     """Test the DPDK l3fwd performance."""
  25
  26     @staticmethod
  27     def start_the_l3fwd_test(nodes_info, dut_node, dut_if1, dut_if2,
  28                              nb_cores, lcores_list, queue_nums, jumbo_frames):
  29         """
  30         Execute the l3fwd on the dut_node.
  31
  32         :param nodes_info: All the nodes info in the topology file.
  33         :param dut_node: Will execute the l3fwd on this node
  34         :param dut_if1: The test link interface 1.
  35         :param dut_if2: The test link interface 2.
  36         :param nb_cores: The cores number for the forwarding
  37         :param lcores_list: The lcore list string for the l3fwd routing
  38         :param queue_nums: The queues number for the NIC
  39         :param jumbo_frames: Indication if the jumbo frames are used (True) or
  40                              not (False).
  41         :type nodes_info: dict
  42         :type dut_node: dict
  43         :type dut_if1: str
  44         :type dut_if2: str
  45         :type nb_cores: str
  46         :type lcores_list: str
  47         :type queue_nums: str
  48         :type jumbo_frames: bool
  49         """
  50         if dut_node['type'] == NodeType.DUT:
  51             adj_mac0, adj_mac1 = L3fwdTest.get_adj_mac(nodes_info, dut_node,
  52                                                        dut_if1, dut_if2)
  53
  54             list_cores = [int(item) for item in lcores_list.split(',')]
  55
  56             # prepare the port config param
  57             nb_cores = int(nb_cores)
  58             index = 0
  59             port_config = ''
  60             for port in range(0, 2):
  61                 for queue in range(0, int(queue_nums)):
  62                     index = 0 if nb_cores == 1 else index
  63                     port_config += '({port}, {queue}, {core}),'.\
  64                         format(port=port, queue=queue, core=list_cores[index])
  65                     index += 1
  66
  67             ssh = SSH()
  68             ssh.connect(dut_node)
  69
  70             cmd = '{fwdir}/tests/dpdk/dpdk_scripts/run_l3fwd.sh ' \
  71                   '"{lcores}" "{ports}" {mac1} {mac2} {jumbo}'.\
  72                   format(fwdir=Constants.REMOTE_FW_DIR, lcores=lcores_list,
  73                          ports=port_config.rstrip(','), mac1=adj_mac0,
  74                          mac2=adj_mac1, jumbo='yes' if jumbo_frames else 'no')
  75
  76             ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
  77             if ret_code != 0:
  78                 raise Exception('Failed to execute l3fwd test at node {name}'
  79                                 .format(name=dut_node['host']))
  80
  81     @staticmethod
  82     def get_adj_mac(nodes_info, dut_node, dut_if1, dut_if2):
  83         """
  84         Get adjacency MAC addresses of the DUT node.
  85
  86         :param nodes_info: All the nodes info in the topology file.
  87         :param dut_node: Will execute the l3fwd on this node
  88         :param dut_if1: The test link interface 1.
  89         :param dut_if2: The test link interface 2.
  90         :type nodes_info: dict
  91         :type dut_node: dict
  92         :type dut_if1: str
  93         :type dut_if2: str
  94         :returns: Returns MAC addresses of adjacency DUT nodes.
  95         :rtype: str
  96         """
  97         if_key0 = dut_if1
  98         if_key1 = dut_if2
  99         if_pci0 = Topology.get_interface_pci_addr(dut_node, if_key0)
 100         if_pci1 = Topology.get_interface_pci_addr(dut_node, if_key1)
 101
 102         # detect which is the port 0
 103         if min(if_pci0, if_pci1) != if_pci0:
 104             if_key0, if_key1 = if_key1, if_key0
 105             L3fwdTest.patch_l3fwd(dut_node, 'patch_l3fwd_flip_routes')
 106
 107         adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface( \
 108                                  nodes_info, dut_node, if_key0)
 109         adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface( \
 110                                  nodes_info, dut_node, if_key1)
 111
 112         adj_mac0 = Topology.get_interface_mac(adj_node0, adj_if_key0)
 113         adj_mac1 = Topology.get_interface_mac(adj_node1, adj_if_key1)
 114
 115         return adj_mac0, adj_mac1
 116
 117     @staticmethod
 118     def patch_l3fwd(node, patch):
 119         """
 120         Patch l3fwd application and recompile.
 121
 122         :param node: Dictionary created from topology.
 123         :param patch: Patch to apply.
 124         :type node: dict
 125         :type patch: str
 126         :raises RuntimeError: Patching of l3fwd failed.
 127         """
 128         arch = Topology.get_node_arch(node)
 129
 130         ssh = SSH()
 131         ssh.connect(node)
 132
 133         ret_code, _, _ = ssh.exec_command(
 134             '{fwdir}/tests/dpdk/dpdk_scripts/patch_l3fwd.sh {arch} '
 135             '{fwdir}/tests/dpdk/dpdk_scripts/{patch}'.
 136             format(fwdir=Constants.REMOTE_FW_DIR, arch=arch, patch=patch),
 137             timeout=600)
 138
 139         if ret_code != 0:
 140             raise RuntimeError('Patch of l3fwd failed.')
 141