resources/libraries/python/DPDK/L3fwdTest.py

   1 # Copyright (c) 2021 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.DpdkUtil import DpdkUtil
  20 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
  21 from resources.libraries.python.topology import NodeType, Topology
  22
  23
  24 NB_PORTS = 2
  25
  26 class L3fwdTest:
  27     """Test the DPDK l3fwd performance."""
  28
  29     @staticmethod
  30     def start_l3fwd(
  31             nodes, node, if1, if2, lcores_list, nb_cores, queue_nums,
  32             jumbo_frames):
  33         """
  34         Execute the l3fwd on the dut_node.
  35
  36         :param nodes: All the nodes info in the topology file.
  37         :param node: DUT node.
  38         :param if1: The test link interface 1.
  39         :param if2: The test link interface 2.
  40         :param lcores_list: The lcore list string for the l3fwd routing
  41         :param nb_cores: The cores number for the forwarding
  42         :param queue_nums: The queues number for the NIC
  43         :param jumbo_frames: Indication if the jumbo frames are used (True) or
  44                              not (False).
  45         :type nodes: dict
  46         :type node: dict
  47         :type if1: str
  48         :type if2: str
  49         :type lcores_list: str
  50         :type nb_cores: str
  51         :type queue_nums: str
  52         :type jumbo_frames: bool
  53         """
  54         if node[u"type"] == NodeType.DUT:
  55             adj_mac0, adj_mac1, if_pci0, if_pci1 = L3fwdTest.get_adj_mac(
  56                 nodes, node, if1, if2
  57             )
  58
  59             lcores = [int(item) for item in lcores_list.split(u",")]
  60
  61             # prepare the port config param
  62             nb_cores = int(nb_cores)
  63             index = 0
  64             port_config = ''
  65             for port in range(0, NB_PORTS):
  66                 for queue in range(0, int(queue_nums)):
  67                     index = 0 if nb_cores == 1 else index
  68                     port_config += \
  69                         f"({port}, {queue}, {lcores[index % NB_PORTS]}),"
  70                     index += 1
  71
  72             if jumbo_frames:
  73                 l3fwd_args = DpdkUtil.get_l3fwd_args(
  74                     eal_corelist=f"1,{lcores_list}",
  75                     eal_driver=False,
  76                     eal_pci_whitelist0=if_pci0,
  77                     eal_pci_whitelist1=if_pci1,
  78                     eal_in_memory=True,
  79                     pmd_config=f"\\\"{port_config.rstrip(u',')}\\\"",
  80                     pmd_eth_dest_0=f"\\\"0,{adj_mac0}\\\"",
  81                     pmd_eth_dest_1=f"\\\"1,{adj_mac1}\\\"",
  82                     pmd_parse_ptype=True,
  83                     pmd_enable_jumbo=jumbo_frames,
  84                     pmd_max_pkt_len=jumbo_frames
  85                 )
  86             else:
  87                 l3fwd_args = DpdkUtil.get_l3fwd_args(
  88                     eal_corelist=f"1,{lcores_list}",
  89                     eal_driver=False,
  90                     eal_pci_whitelist0=if_pci0,
  91                     eal_pci_whitelist1=if_pci1,
  92                     eal_in_memory=True,
  93                     pmd_config=f"\\\"{port_config.rstrip(u',')}\\\"",
  94                     pmd_eth_dest_0=f"\\\"0,{adj_mac0}\\\"",
  95                     pmd_eth_dest_1=f"\\\"1,{adj_mac1}\\\"",
  96                     pmd_parse_ptype=True
  97                 )
  98
  99             command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
 100                 f"/entry/run_l3fwd.sh \"{l3fwd_args} -P -L -p 0x3\""
 101             message = f"Failed to execute l3fwd test at node {node['host']}"
 102             exec_cmd_no_error(node, command, timeout=1800, message=message)
 103
 104
 105     @staticmethod
 106     def get_adj_mac(nodes, node, if1, if2):
 107         """
 108         Get adjacency MAC addresses of the DUT node.
 109
 110         :param nodes: All the nodes info in the topology file.
 111         :param node: DUT node.
 112         :param if1: The test link interface 1.
 113         :param if2: The test link interface 2.
 114         :type nodes: dict
 115         :type node: dict
 116         :type if1: str
 117         :type if2: str
 118         :returns: Returns MAC addresses of adjacency DUT nodes and PCI
 119             addresses.
 120         :rtype: str
 121         """
 122         if_key0 = if1
 123         if_key1 = if2
 124         if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
 125         if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
 126
 127         # Detect which is the port 0.
 128         if min(if_pci0, if_pci1) != if_pci0:
 129             if_key0, if_key1 = if_key1, if_key0
 130             L3fwdTest.patch_l3fwd(node, u"patch_l3fwd_flip_routes")
 131
 132         adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface(
 133             nodes, node, if_key0
 134         )
 135         adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface(
 136             nodes, node, if_key1
 137         )
 138         if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
 139         if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
 140         adj_mac0 = Topology.get_interface_mac(adj_node0, adj_if_key0)
 141         adj_mac1 = Topology.get_interface_mac(adj_node1, adj_if_key1)
 142
 143         return adj_mac0, adj_mac1, if_pci0, if_pci1
 144
 145     @staticmethod
 146     def patch_l3fwd(node, patch):
 147         """
 148         Patch l3fwd application and recompile.
 149
 150         :param node: DUT node.
 151         :param patch: Patch to apply.
 152         :type node: dict
 153         :type patch: str
 154         :raises RuntimeError: Patching of l3fwd failed.
 155         """
 156         command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
 157             f"/entry/patch_l3fwd.sh " \
 158             f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
 159             f"/entry/{patch}"
 160         message = f"Failed to patch l3fwd at node {node['host']}"
 161         ret_code, stdout, _ = exec_cmd(node, command, timeout=1800)
 162         if ret_code != 0 and u"Skipping patch." not in stdout:
 163             raise RuntimeError(message)