1 # Copyright (c) 2022 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 start l3fwd on topology nodes.
18 from robot.libraries.BuiltIn import BuiltIn
19 from resources.libraries.python.Constants import Constants
20 from resources.libraries.python.CpuUtils import CpuUtils
21 from resources.libraries.python.DpdkUtil import DpdkUtil
22 from resources.libraries.python.ssh import exec_cmd_no_error, exec_cmd
23 from resources.libraries.python.topology import NodeType, Topology
29 """This class start l3fwd on topology nodes and check if properly started.
33 def start_l3fwd_on_all_duts(
34 nodes, topology_info, phy_cores, rx_queues=None, jumbo_frames=False,
37 Execute the l3fwd on all dut nodes.
39 :param nodes: All the nodes info from the topology file.
40 :param topology_info: All the info from the topology file.
41 :param phy_cores: Number of physical cores to use.
42 :param rx_queues: Number of RX queues.
43 :param jumbo_frames: Jumbo frames on/off.
44 :param rxd: Number of RX descriptors.
45 :param txd: Number of TX descriptors.
48 :type topology_info: dict
51 :type jumbo_frames: bool
54 :raises RuntimeError: If bash return code is not 0.
56 cpu_count_int = dp_count_int = int(phy_cores)
57 dp_cores = cpu_count_int+1
60 compute_resource_info = CpuUtils.get_affinity_vswitch(
61 nodes, node, phy_cores, rx_queues=rx_queues,
65 BuiltIn().set_tags('MTHREAD')
67 BuiltIn().set_tags('STHREAD')
69 f"{dp_count_int}T{cpu_count_int}C"
72 cpu_dp = compute_resource_info[u"cpu_dp"]
73 rxq_count_int = compute_resource_info[u"rxq_count_int"]
74 if1 = topology_info[f"{node}_pf1"][0]
75 if2 = topology_info[f"{node}_pf2"][0]
76 L3fwdTest.start_l3fwd(
77 nodes, nodes[node], if1=if1, if2=if2, lcores_list=cpu_dp,
78 nb_cores=dp_count_int, queue_nums=rxq_count_int,
79 jumbo_frames=jumbo_frames
85 L3fwdTest.check_l3fwd(nodes[node])
88 L3fwdTest.start_l3fwd(
89 nodes, nodes[node], if1=if1, if2=if2,
90 lcores_list=cpu_dp, nb_cores=dp_count_int,
91 queue_nums=rxq_count_int, jumbo_frames=jumbo_frames
94 message = f"Failed to start l3fwd at node {node}"
95 raise RuntimeError(message)
99 nodes, node, if1, if2, lcores_list, nb_cores, queue_nums,
102 Execute the l3fwd on the dut_node.
104 :param nodes: All the nodes info in the topology file.
105 :param node: DUT node.
106 :param if1: The test link interface 1.
107 :param if2: The test link interface 2.
108 :param lcores_list: The lcore list string for the l3fwd routing
109 :param nb_cores: The cores number for the forwarding
110 :param queue_nums: The queues number for the NIC
111 :param jumbo_frames: Indication if the jumbo frames are used (True) or
117 :type lcores_list: str
119 :type queue_nums: str
120 :type jumbo_frames: bool
122 if node[u"type"] == NodeType.DUT:
123 adj_mac0, adj_mac1, if_pci0, if_pci1 = L3fwdTest.get_adj_mac(
124 nodes, node, if1, if2
127 lcores = [int(item) for item in lcores_list.split(u",")]
129 # prepare the port config param
130 nb_cores = int(nb_cores)
133 for port in range(0, NB_PORTS):
134 for queue in range(0, int(queue_nums)):
135 index = 0 if nb_cores == 1 else index
137 f"({port}, {queue}, {lcores[index % NB_PORTS]}),"
141 l3fwd_args = DpdkUtil.get_l3fwd_args(
142 eal_corelist=f"1,{lcores_list}",
144 eal_pci_whitelist0=if_pci0,
145 eal_pci_whitelist1=if_pci1,
147 pmd_config=f"\\\"{port_config.rstrip(u',')}\\\"",
148 pmd_eth_dest_0=f"\\\"0,{adj_mac0}\\\"",
149 pmd_eth_dest_1=f"\\\"1,{adj_mac1}\\\"",
150 pmd_parse_ptype=True,
151 pmd_max_pkt_len=jumbo_frames
154 l3fwd_args = DpdkUtil.get_l3fwd_args(
155 eal_corelist=f"1,{lcores_list}",
157 eal_pci_whitelist0=if_pci0,
158 eal_pci_whitelist1=if_pci1,
160 pmd_config=f"\\\"{port_config.rstrip(u',')}\\\"",
161 pmd_eth_dest_0=f"\\\"0,{adj_mac0}\\\"",
162 pmd_eth_dest_1=f"\\\"1,{adj_mac1}\\\"",
166 command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
167 f"/entry/run_l3fwd.sh \"{l3fwd_args} -P -L -p 0x3\""
168 message = f"Failed to execute l3fwd test at node {node['host']}"
169 exec_cmd_no_error(node, command, timeout=1800, message=message)
172 def check_l3fwd(node):
174 Execute the l3fwd check on the DUT node.
176 :param node: DUT node.
178 :raises RuntimeError: If the script "check_l3fwd.sh" fails.
180 if node[u"type"] == NodeType.DUT:
181 command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
182 f"/entry/check_l3fwd.sh"
183 message = "L3fwd not started properly"
184 exec_cmd_no_error(node, command, timeout=1800, message=message)
187 def get_adj_mac(nodes, node, if1, if2):
189 Get adjacency MAC addresses of the DUT node.
191 :param nodes: All the nodes info in the topology file.
192 :param node: DUT node.
193 :param if1: The test link interface 1.
194 :param if2: The test link interface 2.
199 :returns: Returns MAC addresses of adjacency DUT nodes and PCI
205 if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
206 if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
208 # Detect which is the port 0.
209 if min(if_pci0, if_pci1) != if_pci0:
210 if_key0, if_key1 = if_key1, if_key0
211 L3fwdTest.patch_l3fwd(node, u"patch_l3fwd_flip_routes")
213 adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface(
216 adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface(
219 if_pci0 = Topology.get_interface_pci_addr(node, if_key0)
220 if_pci1 = Topology.get_interface_pci_addr(node, if_key1)
221 adj_mac0 = Topology.get_interface_mac(adj_node0, adj_if_key0)
222 adj_mac1 = Topology.get_interface_mac(adj_node1, adj_if_key1)
224 return adj_mac0, adj_mac1, if_pci0, if_pci1
227 def patch_l3fwd(node, patch):
229 Patch l3fwd application and recompile.
231 :param node: DUT node.
232 :param patch: Patch to apply.
235 :raises RuntimeError: Patching of l3fwd failed.
237 command = f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
238 f"/entry/patch_l3fwd.sh " \
239 f"{Constants.REMOTE_FW_DIR}/{Constants.RESOURCES_LIB_SH}"\
241 message = f"Failed to patch l3fwd at node {node['host']}"
242 ret_code, stdout, _ = exec_cmd(node, command, timeout=1800)
243 if ret_code != 0 and u"Skipping patch." not in stdout:
244 raise RuntimeError(message)