1 # Copyright (c) 2019 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 cmd = u"command -v vpp"
117 exec_cmd_no_error(node, cmd, message=u"VPP is not installed!")
120 def adjust_privileges(node):
121 """Adjust privileges to control VPP without sudo.
123 :param node: Topology node.
126 cmd = u"chmod -R o+rwx /run/vpp"
128 node, cmd, sudo=True, message=u"Failed to adjust privileges!",
132 def verify_vpp_started(node):
133 """Verify that VPP is started on the specified topology node.
135 :param node: Topology node.
138 cmd = u"echo \"show ver\" | sudo socat - UNIX-CONNECT:/run/vpp/cli.sock"
140 node, cmd, sudo=False, message=u"VPP failed to start!", retries=120
143 cmd = u"vppctl show ver 2>&1 | fgrep -v \"Connection refused\" | " \
144 u"fgrep -v \"No such file or directory\""
146 node, cmd, sudo=True, message=u"VPP failed to start!", retries=120
150 def verify_vpp(node):
151 """Verify that VPP is installed and started on the specified topology
152 node. Adjust privileges so user can connect without sudo.
154 :param node: Topology node.
156 :raises RuntimeError: If VPP service fails to start.
158 VPPUtil.verify_vpp_installed(node)
160 # Verify responsiveness of vppctl.
161 VPPUtil.verify_vpp_started(node)
163 VPPUtil.adjust_privileges(node)
164 # Verify responsiveness of PAPI.
165 VPPUtil.show_log(node)
166 VPPUtil.vpp_show_version(node)
168 DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
171 def verify_vpp_on_all_duts(nodes):
172 """Verify that VPP is installed and started on all DUT nodes.
174 :param nodes: Nodes in the topology.
177 for node in nodes.values():
178 if node[u"type"] == NodeType.DUT:
179 VPPUtil.verify_vpp(node)
182 def vpp_show_version(node):
183 """Run "show_version" PAPI command.
185 :param node: Node to run command on.
187 :returns: VPP version.
190 cmd = u"show_version"
191 with PapiSocketExecutor(node) as papi_exec:
192 reply = papi_exec.add(cmd).get_reply()
193 logger.info(f"VPP version: {reply[u'version']}\n")
194 return f"{reply[u'version']}"
197 def show_vpp_version_on_all_duts(nodes):
198 """Show VPP version verbose on all DUTs.
200 :param nodes: Nodes in the topology.
203 for node in nodes.values():
204 if node[u"type"] == NodeType.DUT:
205 VPPUtil.vpp_show_version(node)
208 def vpp_show_interfaces(node):
209 """Run "show interface" CLI command.
211 :param node: Node to run command on.
215 cmd = u"sw_interface_dump"
217 name_filter_valid=False,
220 err_msg = f"Failed to get interface dump on host {node[u'host']}"
221 with PapiSocketExecutor(node) as papi_exec:
222 details = papi_exec.add(cmd, **args).get_details(err_msg)
224 for if_dump in details:
225 if_dump[u"l2_address"] = str(if_dump[u"l2_address"])
226 if_dump[u"b_dmac"] = str(if_dump[u"b_dmac"])
227 if_dump[u"b_smac"] = str(if_dump[u"b_smac"])
228 if_dump[u"flags"] = if_dump[u"flags"].value
229 if_dump[u"type"] = if_dump[u"type"].value
230 if_dump[u"link_duplex"] = if_dump[u"link_duplex"].value
231 if_dump[u"sub_if_flags"] = if_dump[u"sub_if_flags"].value \
232 if hasattr(if_dump[u"sub_if_flags"], u"value") \
233 else int(if_dump[u"sub_if_flags"])
234 # TODO: return only base data
235 logger.trace(f"Interface data of host {node[u'host']}:\n{details}")
238 def vpp_enable_traces_on_dut(node, fail_on_error=False):
239 """Enable vpp packet traces on the DUT node.
241 :param node: DUT node to set up.
242 :param fail_on_error: If True, keyword fails if an error occurs,
245 :type fail_on_error: bool
248 u"trace add dpdk-input 50",
249 u"trace add vhost-user-input 50",
250 u"trace add memif-input 50",
251 u"trace add avf-input 50"
256 PapiSocketExecutor.run_cli_cmd_on_all_sockets(node, cmd)
257 except AssertionError:
262 def vpp_enable_traces_on_all_duts(nodes, fail_on_error=False):
263 """Enable vpp packet traces on all DUTs in the given topology.
265 :param nodes: Nodes in the topology.
266 :param fail_on_error: If True, keyword fails if an error occurs,
269 :type fail_on_error: bool
271 for node in nodes.values():
272 if node[u"type"] == NodeType.DUT:
273 VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error)
276 def vpp_enable_elog_traces(node):
277 """Enable API/CLI/Barrier traces on the specified topology node.
279 :param node: Topology node.
282 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
283 node, u"elog trace api cli barrier")
286 def vpp_enable_elog_traces_on_all_duts(nodes):
287 """Enable API/CLI/Barrier traces on all DUTs in the given topology.
289 :param nodes: Nodes in the topology.
292 for node in nodes.values():
293 if node[u"type"] == NodeType.DUT:
294 VPPUtil.vpp_enable_elog_traces(node)
297 def show_event_logger(node):
298 """Show event logger on the specified topology node.
300 :param node: Topology node.
303 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
304 node, u"show event-logger")
307 def show_event_logger_on_all_duts(nodes):
308 """Show event logger on all DUTs in the given topology.
310 :param nodes: Nodes in the topology.
313 for node in nodes.values():
314 if node[u"type"] == NodeType.DUT:
315 VPPUtil.show_event_logger(node)
319 """Show logging on the specified topology node.
321 :param node: Topology node.
324 PapiSocketExecutor.run_cli_cmd(node, u"show logging")
327 def show_log_on_all_duts(nodes):
328 """Show logging on all DUTs in the given topology.
330 :param nodes: Nodes in the topology.
333 for node in nodes.values():
334 if node[u"type"] == NodeType.DUT:
335 VPPUtil.show_log(node)
338 def vpp_show_threads(node):
339 """Show VPP threads on node.
341 :param node: Node to run command on.
343 :returns: VPP thread data.
346 cmd = u"show_threads"
347 with PapiSocketExecutor(node) as papi_exec:
348 reply = papi_exec.add(cmd).get_reply()
350 threads_data = list()
351 for thread in reply[u"thread_data"]:
354 if isinstance(item, str):
355 item = item.rstrip('\x00')
356 thread_data.append(item)
357 threads_data.append(thread_data)
359 logger.trace(f"show threads:\n{threads_data}")