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:
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 exists to provide the l3fwd test for DPDK on topology nodes.
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
27 """Test the DPDK l3fwd performance."""
31 nodes, node, if1, if2, lcores_list, nb_cores, queue_nums,
34 Execute the l3fwd on the dut_node.
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
49 :type lcores_list: str
52 :type jumbo_frames: bool
54 if node[u"type"] == NodeType.DUT:
55 adj_mac0, adj_mac1, if_pci0, if_pci1 = L3fwdTest.get_adj_mac(
59 lcores = [int(item) for item in lcores_list.split(u",")]
61 # prepare the port config param
62 nb_cores = int(nb_cores)
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
69 f"({port}, {queue}, {lcores[index % NB_PORTS]}),"
73 l3fwd_args = DpdkUtil.get_l3fwd_args(
74 eal_corelist=f"1,{lcores_list}",
76 eal_pci_whitelist0=if_pci0,
77 eal_pci_whitelist1=if_pci1,
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}\\\"",
83 pmd_max_pkt_len=jumbo_frames
86 l3fwd_args = DpdkUtil.get_l3fwd_args(
87 eal_corelist=f"1,{lcores_list}",
89 eal_pci_whitelist0=if_pci0,
90 eal_pci_whitelist1=if_pci1,
92 pmd_config=f"\\\"{port_config.rstrip(u',')}\\\"",
93 pmd_eth_dest_0=f"\\\"0,{adj_mac0}\\\"",
94 pmd_eth_dest_1=f"\\\"1,{adj_mac1}\\\"",
98 command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
99 f"/entry/run_l3fwd.sh \"{l3fwd_args} -P -L -p 0x3\""
100 message = f"Failed to execute l3fwd test at node {node['host']}"
101 exec_cmd_no_error(node, command, timeout=1800, message=message)
105 def get_adj_mac(nodes, node, if1, if2):
107 Get adjacency MAC addresses of the DUT node.
109 :param nodes: All the nodes info in the topology file.
110 :param node: DUT node.
111 :param if1: The test link interface 1.
112 :param if2: The test link interface 2.
117 :returns: Returns MAC addresses of adjacency DUT nodes and PCI
123 if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
124 if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
126 # Detect which is the port 0.
127 if min(if_pci0, if_pci1) != if_pci0:
128 if_key0, if_key1 = if_key1, if_key0
129 L3fwdTest.patch_l3fwd(node, u"patch_l3fwd_flip_routes")
131 adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface(
134 adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface(
137 if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
138 if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
139 adj_mac0 = Topology.get_interface_mac(adj_node0, adj_if_key0)
140 adj_mac1 = Topology.get_interface_mac(adj_node1, adj_if_key1)
142 return adj_mac0, adj_mac1, if_pci0, if_pci1
145 def patch_l3fwd(node, patch):
147 Patch l3fwd application and recompile.
149 :param node: DUT node.
150 :param patch: Patch to apply.
153 :raises RuntimeError: Patching of l3fwd failed.
155 command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
156 f"/entry/patch_l3fwd.sh " \
157 f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
159 message = f"Failed to patch l3fwd at node {node['host']}"
160 ret_code, stdout, _ = exec_cmd(node, command, timeout=1800)
161 if ret_code != 0 and u"Skipping patch." not in stdout:
162 raise RuntimeError(message)