resources/libraries/python/DPDK/L3fwdTest.py

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