Fix warnings reported by gen_doc.sh
[csit.git] / resources / libraries / python / DPDK / L3fwdTest.py
1 # Copyright (c) 2018 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.ssh import SSH
19 from resources.libraries.python.constants import Constants
20 from resources.libraries.python.topology import NodeType, Topology
21
22 class L3fwdTest(object):
23     """Test the DPDK l3fwd performance."""
24
25     @staticmethod
26     def start_the_l3fwd_test(nodes_info, dut_node, dut_if1, dut_if2,
27                              nb_cores, lcores_list, queue_nums, jumbo_frames):
28         """
29         Execute the l3fwd on the dut_node.
30
31         :param nodes_info: All the nodes info in the topology file.
32         :param dut_node: Will execute the l3fwd on this node
33         :param dut_if1: The test link interface 1.
34         :param dut_if2: The test link interface 2.
35         :param nb_cores: The cores number for the forwarding
36         :param lcores_list: The lcore list string for the l3fwd routing
37         :param queue_nums: The queues number for the NIC
38         :param jumbo_frames: Is jumbo frames or not. Accepted: yes / no
39         :type nodes_info: dict
40         :type dut_node: dict
41         :type dut_if1: str
42         :type dut_if2: str
43         :type nb_cores: str
44         :type lcores_list: str
45         :type queue_nums: str
46         :type jumbo_frames: str
47         :returns: none
48         """
49         if dut_node['type'] == NodeType.DUT:
50             adj_mac0, adj_mac1 = L3fwdTest.get_adj_mac(nodes_info, dut_node,
51                                                        dut_if1, dut_if2)
52
53             list_cores = lcores_list.split(',')
54
55             # prepare the port config param
56             index = 0
57             port_config = ''
58             for port in range(0, 2):
59                 for queue in range(0, int(queue_nums)):
60                     if int(nb_cores) == 1:
61                         index = 0
62                         temp_str = '({port}, {queue}, {core}),'.\
63                         format(port=port, queue=queue,
64                                core=int(list_cores[index]))
65                     else:
66                         temp_str = '({port}, {queue}, {core}),'.\
67                         format(port=port, queue=queue,
68                                core=int(list_cores[index]))
69
70                     port_config += temp_str
71                     index = index + 1
72
73             ssh = SSH()
74             ssh.connect(dut_node)
75
76             cmd = '{fwdir}/tests/dpdk/dpdk_scripts/run_l3fwd.sh ' \
77                   '"{lcores}" "{ports}" {mac1} {mac2} {jumbo}'.\
78                   format(fwdir=Constants.REMOTE_FW_DIR, lcores=lcores_list,
79                          ports=port_config.rstrip(','), mac1=adj_mac0,
80                          mac2=adj_mac1, jumbo=jumbo_frames)
81
82             ret_code, _, _ = ssh.exec_command_sudo(cmd, timeout=600)
83             if ret_code != 0:
84                 raise Exception('Failed to execute l3fwd test at node {name}'
85                                 .format(name=dut_node['host']))
86
87     @staticmethod
88     def get_adj_mac(nodes_info, dut_node, dut_if1, dut_if2):
89         """
90         Get adjacency MAC addresses of the DUT node.
91
92         :param nodes_info: All the nodes info in the topology file.
93         :param dut_node: Will execute the l3fwd on this node
94         :param dut_if1: The test link interface 1.
95         :param dut_if2: The test link interface 2.
96         :type nodes_info: dict
97         :type dut_node: dict
98         :type dut_if1: str
99         :type dut_if2: str
100         :returns: Returns MAC addresses of adjacency DUT nodes.
101         :rtype: str
102         """
103         if_key0 = dut_if1
104         if_key1 = dut_if2
105         if_pci0 = Topology.get_interface_pci_addr(dut_node, if_key0)
106         if_pci1 = Topology.get_interface_pci_addr(dut_node, if_key1)
107
108         # detect which is the port 0
109         if min(if_pci0, if_pci1) != if_pci0:
110             if_key0, if_key1 = if_key1, if_key0
111
112         adj_node0, adj_if_key0 = Topology.get_adjacent_node_and_interface( \
113                                  nodes_info, dut_node, if_key0)
114         adj_node1, adj_if_key1 = Topology.get_adjacent_node_and_interface( \
115                                  nodes_info, dut_node, if_key1)
116
117         adj_mac0 = Topology.get_interface_mac(adj_node0, adj_if_key0)
118         adj_mac1 = Topology.get_interface_mac(adj_node1, adj_if_key1)
119
120         return adj_mac0, adj_mac1

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.