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:
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
25 """Test the DPDK l3fwd performance."""
29 nodes, node, if1, if2, lcores_list, nb_cores, queue_nums,
32 Execute the l3fwd on the dut_node.
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
47 :type lcores_list: str
50 :type jumbo_frames: bool
52 if node[u"type"] == NodeType.DUT:
53 adj_mac0, adj_mac1, if_pci0, if_pci1 = L3fwdTest.get_adj_mac(
57 list_cores = [int(item) for item in lcores_list.split(u",")]
59 # prepare the port config param
60 nb_cores = int(nb_cores)
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]}),"
70 l3fwd_args = DpdkUtil.get_l3fwd_args(
71 eal_corelist=f"1,{lcores_list}",
73 eal_pci_whitelist0=if_pci0,
74 eal_pci_whitelist1=if_pci1,
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}\\\"",
80 pmd_enable_jumbo=jumbo_frames,
81 pmd_max_pkt_len=jumbo_frames
84 l3fwd_args = DpdkUtil.get_l3fwd_args(
85 eal_corelist=f"1,{lcores_list}",
87 eal_pci_whitelist0=if_pci0,
88 eal_pci_whitelist1=if_pci1,
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}\\\"",
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)
103 def get_adj_mac(nodes, node, if1, if2):
105 Get adjacency MAC addresses of the DUT node.
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.
115 :returns: Returns MAC addresses of adjacency DUT nodes and PCI
121 if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
122 if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
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")
129 adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface(
132 adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface(
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)
140 return adj_mac0, adj_mac1, if_pci0, if_pci1
143 def patch_l3fwd(node, patch):
145 Patch l3fwd application and recompile.
147 :param node: DUT node.
148 :param patch: Patch to apply.
151 :raises RuntimeError: Patching of l3fwd failed.
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}"\
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)