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.
14 """VPP util library."""
16 from robot.api import logger
18 from resources.libraries.python.Constants import Constants
19 from resources.libraries.python.DUTSetup import DUTSetup
20 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
21 from resources.libraries.python.ssh import exec_cmd_no_error
22 from resources.libraries.python.topology import Topology, SocketType, NodeType
26 """General class for any VPP related methods/functions."""
29 def show_vpp_settings(node, *additional_cmds):
30 """Print default VPP settings. In case others are needed, can be
31 accepted as next parameters (each setting one parameter), preferably
34 :param node: VPP node.
35 :param additional_cmds: Additional commands that the vpp should print
38 :type additional_cmds: tuple
40 def_setting_tb_displayed = {
41 u"IPv6 FIB": u"ip6 fib",
42 u"IPv4 FIB": u"ip fib",
43 u"Interface IP": u"int addr",
44 u"Interfaces": u"int",
50 for cmd in additional_cmds:
51 def_setting_tb_displayed[f"Custom Setting: {cmd}"] = cmd
53 for _, cmd in def_setting_tb_displayed.items():
54 command = f"vppctl sh {cmd}"
55 exec_cmd_no_error(node, command, timeout=30, sudo=True)
58 def restart_vpp_service(node, node_key=None):
59 """Restart VPP service on the specified topology node.
61 :param node: Topology node.
62 :param node_key: Topology node key.
66 DUTSetup.restart_service(node, Constants.VPP_UNIT)
68 Topology.add_new_socket(
69 node, SocketType.PAPI, node_key, Constants.SOCKSVR_PATH)
70 Topology.add_new_socket(
71 node, SocketType.STATS, node_key, Constants.SOCKSTAT_PATH)
74 def restart_vpp_service_on_all_duts(nodes):
75 """Restart VPP service on all DUT nodes.
77 :param nodes: Topology nodes.
80 for node_key, node in nodes.items():
81 if node[u"type"] == NodeType.DUT:
82 VPPUtil.restart_vpp_service(node, node_key)
85 def stop_vpp_service(node, node_key=None):
86 """Stop VPP service on the specified topology node.
88 :param node: Topology node.
89 :param node_key: Topology node key.
93 DUTSetup.stop_service(node, Constants.VPP_UNIT)
95 Topology.del_node_socket_id(node, SocketType.PAPI, node_key)
96 Topology.del_node_socket_id(node, SocketType.STATS, node_key)
99 def stop_vpp_service_on_all_duts(nodes):
100 """Stop VPP service on all DUT nodes.
102 :param nodes: Topology nodes.
105 for node_key, node in nodes.items():
106 if node[u"type"] == NodeType.DUT:
107 VPPUtil.stop_vpp_service(node, node_key)
110 def verify_vpp_installed(node):
111 """Verify that VPP is installed on the specified topology node.
113 :param node: Topology node.
116 DUTSetup.verify_program_installed(node, u"vpp")
119 def adjust_privileges(node):
120 """Adjust privileges to control VPP without sudo.
122 :param node: Topology node.
125 cmd = u"chmod -R o+rwx /run/vpp"
127 node, cmd, sudo=True, message=u"Failed to adjust privileges!",
131 def verify_vpp_started(node):
132 """Verify that VPP is started on the specified topology node.
134 :param node: Topology node.
137 cmd = u"echo \"show pci\" | sudo socat - UNIX-CONNECT:/run/vpp/cli.sock"
139 node, cmd, sudo=False, message=u"VPP failed to start!", retries=120
142 cmd = u"vppctl show pci 2>&1 | fgrep -v \"Connection refused\" | " \
143 u"fgrep -v \"No such file or directory\""
145 node, cmd, sudo=True, message=u"VPP failed to start!", retries=120
149 def verify_vpp(node):
150 """Verify that VPP is installed and started on the specified topology
151 node. Adjust privileges so user can connect without sudo.
153 :param node: Topology node.
155 :raises RuntimeError: If VPP service fails to start.
157 DUTSetup.verify_program_installed(node, 'vpp')
159 # Verify responsiveness of vppctl.
160 VPPUtil.verify_vpp_started(node)
162 VPPUtil.adjust_privileges(node)
163 # Verify responsiveness of PAPI.
164 VPPUtil.show_log(node)
165 VPPUtil.vpp_show_version(node)
167 DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
170 def verify_vpp_on_all_duts(nodes):
171 """Verify that VPP is installed and started on all DUT nodes.
173 :param nodes: Nodes in the topology.
176 for node in nodes.values():
177 if node[u"type"] == NodeType.DUT:
178 VPPUtil.verify_vpp(node)
181 def vpp_show_version(node):
182 """Run "show_version" PAPI command.
184 :param node: Node to run command on.
186 :returns: VPP version.
189 cmd = u"show_version"
190 with PapiSocketExecutor(node) as papi_exec:
191 reply = papi_exec.add(cmd).get_reply()
192 logger.info(f"VPP version: {reply[u'version']}\n")
193 return f"{reply[u'version']}"
196 def show_vpp_version_on_all_duts(nodes):
197 """Show VPP version verbose on all DUTs.
199 :param nodes: Nodes in the topology.
202 for node in nodes.values():
203 if node[u"type"] == NodeType.DUT:
204 VPPUtil.vpp_show_version(node)
207 def vpp_show_interfaces(node):
208 """Run "show interface" CLI command.
210 :param node: Node to run command on.
214 cmd = u"sw_interface_dump"
216 name_filter_valid=False,
219 err_msg = f"Failed to get interface dump on host {node[u'host']}"
220 with PapiSocketExecutor(node) as papi_exec:
221 details = papi_exec.add(cmd, **args).get_details(err_msg)
223 for if_dump in details:
224 if_dump[u"l2_address"] = str(if_dump[u"l2_address"])
225 if_dump[u"b_dmac"] = str(if_dump[u"b_dmac"])
226 if_dump[u"b_smac"] = str(if_dump[u"b_smac"])
227 if_dump[u"flags"] = if_dump[u"flags"].value
228 if_dump[u"type"] = if_dump[u"type"].value
229 if_dump[u"link_duplex"] = if_dump[u"link_duplex"].value
230 if_dump[u"sub_if_flags"] = if_dump[u"sub_if_flags"].value \
231 if hasattr(if_dump[u"sub_if_flags"], u"value") \
232 else int(if_dump[u"sub_if_flags"])
233 # TODO: return only base data
234 logger.trace(f"Interface data of host {node[u'host']}:\n{details}")
237 def vpp_enable_traces_on_dut(node, fail_on_error=False):
238 """Enable vpp packet traces on the DUT node.
240 :param node: DUT node to set up.
241 :param fail_on_error: If True, keyword fails if an error occurs,
244 :type fail_on_error: bool
247 u"trace add dpdk-input 50",
248 u"trace add vhost-user-input 50",
249 u"trace add memif-input 50",
250 u"trace add avf-input 50"
255 PapiSocketExecutor.run_cli_cmd_on_all_sockets(node, cmd)
256 except AssertionError:
261 def vpp_enable_traces_on_all_duts(nodes, fail_on_error=False):
262 """Enable vpp packet traces on all DUTs in the given topology.
264 :param nodes: Nodes in the topology.
265 :param fail_on_error: If True, keyword fails if an error occurs,
268 :type fail_on_error: bool
270 for node in nodes.values():
271 if node[u"type"] == NodeType.DUT:
272 VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error)
275 def vpp_enable_elog_traces(node):
276 """Enable API/CLI/Barrier traces on the specified topology node.
278 :param node: Topology node.
281 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
282 node, u"elog trace api cli barrier")
285 def vpp_enable_elog_traces_on_all_duts(nodes):
286 """Enable API/CLI/Barrier traces on all DUTs in the given topology.
288 :param nodes: Nodes in the topology.
291 for node in nodes.values():
292 if node[u"type"] == NodeType.DUT:
293 VPPUtil.vpp_enable_elog_traces(node)
296 def show_event_logger(node):
297 """Show event logger on the specified topology node.
299 :param node: Topology node.
302 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
303 node, u"show event-logger")
306 def show_event_logger_on_all_duts(nodes):
307 """Show event logger on all DUTs in the given topology.
309 :param nodes: Nodes in the topology.
312 for node in nodes.values():
313 if node[u"type"] == NodeType.DUT:
314 VPPUtil.show_event_logger(node)
318 """Show logging on the specified topology node.
320 :param node: Topology node.
323 PapiSocketExecutor.run_cli_cmd(node, u"show logging")
326 def show_log_on_all_duts(nodes):
327 """Show logging on all DUTs in the given topology.
329 :param nodes: Nodes in the topology.
332 for node in nodes.values():
333 if node[u"type"] == NodeType.DUT:
334 VPPUtil.show_log(node)
337 def vpp_show_threads(node):
338 """Show VPP threads on node.
340 :param node: Node to run command on.
342 :returns: VPP thread data.
345 cmd = u"show_threads"
346 with PapiSocketExecutor(node) as papi_exec:
347 reply = papi_exec.add(cmd).get_reply()
349 threads_data = list()
350 for thread in reply[u"thread_data"]:
353 if isinstance(item, str):
354 item = item.rstrip('\x00')
355 thread_data.append(item)
356 threads_data.append(thread_data)
358 logger.trace(f"show threads:\n{threads_data}")