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.Constants import Constants
  19 from resources.libraries.python.ssh import SSH
  20 from resources.libraries.python.topology import NodeType, Topology
  21
  22
  23 class L3fwdTest:
  24     """Test the DPDK l3fwd performance."""
  25
  26     @staticmethod
  27     def start_the_l3fwd_test(
  28             nodes_info, dut_node, dut_if1, dut_if2, nb_cores, lcores_list,
  29             queue_nums, jumbo_frames):
  30         """
  31         Execute the l3fwd on the dut_node.
  32
  33         :param nodes_info: All the nodes info in the topology file.
  34         :param dut_node: Will execute the l3fwd on this node
  35         :param dut_if1: The test link interface 1.
  36         :param dut_if2: The test link interface 2.
  37         :param nb_cores: The cores number for the forwarding
  38         :param lcores_list: The lcore list string for the l3fwd routing
  39         :param queue_nums: The queues number for the NIC
  40         :param jumbo_frames: Indication if the jumbo frames are used (True) or
  41                              not (False).
  42         :type nodes_info: dict
  43         :type dut_node: dict
  44         :type dut_if1: str
  45         :type dut_if2: str
  46         :type nb_cores: str
  47         :type lcores_list: str
  48         :type queue_nums: str
  49         :type jumbo_frames: bool
  50         """
  51         if dut_node[u"type"] == NodeType.DUT:
  52             adj_mac0, adj_mac1 = L3fwdTest.get_adj_mac(
  53                 nodes_info, dut_node, dut_if1, dut_if2
  54             )
  55
  56             list_cores = [int(item) for item in lcores_list.split(u",")]
  57
  58             # prepare the port config param
  59             nb_cores = int(nb_cores)
  60             index = 0
  61             port_config = ''
  62             for port in range(0, 2):
  63                 for queue in range(0, int(queue_nums)):
  64                     index = 0 if nb_cores == 1 else index
  65                     port_config += f"({port}, {queue}, {list_cores[index]}),"
  66                     index += 1
  67
  68             ssh = SSH()
  69             ssh.connect(dut_node)
  70
  71             cmd = f"{Constants.REMOTE_FW_DIR}/tests/dpdk/dpdk_scripts" \
  72                 f"/run_l3fwd.sh \"{lcores_list}\" " \
  73                 f"\"{port_config.rstrip(u',')}\" " \
  74                 f"{adj_mac0} {adj_mac1} {u'yes' if jumbo_frames else u'no'}"
  75
  76             ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
  77             if ret_code != 0:
  78                 raise Exception(
  79                     f"Failed to execute l3fwd test at node {dut_node[u'host']}"
  80                 )
  81
  82     @staticmethod
  83     def get_adj_mac(nodes_info, dut_node, dut_if1, dut_if2):
  84         """
  85         Get adjacency MAC addresses of the DUT node.
  86
  87         :param nodes_info: All the nodes info in the topology file.
  88         :param dut_node: Will execute the l3fwd on this node
  89         :param dut_if1: The test link interface 1.
  90         :param dut_if2: The test link interface 2.
  91         :type nodes_info: dict
  92         :type dut_node: dict
  93         :type dut_if1: str
  94         :type dut_if2: str
  95         :returns: Returns MAC addresses of adjacency DUT nodes.
  96         :rtype: str
  97         """
  98         if_key0 = dut_if1
  99         if_key1 = dut_if2
 100         if_pci0 = Topology.get_interface_pci_addr(dut_node, if_key0)
 101         if_pci1 = Topology.get_interface_pci_addr(dut_node, if_key1)
 102
 103         # detect which is the port 0
 104         if min(if_pci0, if_pci1) != if_pci0:
 105             if_key0, if_key1 = if_key1, if_key0
 106             L3fwdTest.patch_l3fwd(dut_node, u"patch_l3fwd_flip_routes")
 107
 108         adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface(
 109             nodes_info, dut_node, if_key0
 110         )
 111         adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface(
 112             nodes_info, dut_node, if_key1
 113         )
 114
 115         adj_mac0 = Topology.get_interface_mac(adj_node0, adj_if_key0)
 116         adj_mac1 = Topology.get_interface_mac(adj_node1, adj_if_key1)
 117
 118         return adj_mac0, adj_mac1
 119
 120     @staticmethod
 121     def patch_l3fwd(node, patch):
 122         """
 123         Patch l3fwd application and recompile.
 124
 125         :param node: Dictionary created from topology.
 126         :param patch: Patch to apply.
 127         :type node: dict
 128         :type patch: str
 129         :raises RuntimeError: Patching of l3fwd failed.
 130         """
 131         arch = Topology.get_node_arch(node)
 132
 133         ssh = SSH()
 134         ssh.connect(node)
 135
 136         ret_code, _, _ = ssh.exec_command(
 137             f"{Constants.REMOTE_FW_DIR}/tests/dpdk/dpdk_scripts/patch_l3fwd.sh "
 138             f"{arch} {Constants.REMOTE_FW_DIR}/tests/dpdk/dpdk_scripts/{patch}",
 139             timeout=600
 140         )
 141
 142         if ret_code != 0:
 143             raise RuntimeError(u"Patch of l3fwd failed.")