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, exec_cmd
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
148 # Properly enable cards in case they were disabled. This will be
149 # followed in https://jira.fd.io/browse/VPP-1934.
150 cmd = u"for i in $(sudo vppctl sho int | grep Eth | cut -d' ' -f1); do"\
151 u" sudo vppctl set int sta $i up; done"
152 exec_cmd(node, cmd, sudo=False)
155 def verify_vpp(node):
156 """Verify that VPP is installed and started on the specified topology
157 node. Adjust privileges so user can connect without sudo.
159 :param node: Topology node.
161 :raises RuntimeError: If VPP service fails to start.
163 DUTSetup.verify_program_installed(node, 'vpp')
165 # Verify responsiveness of vppctl.
166 VPPUtil.verify_vpp_started(node)
168 VPPUtil.adjust_privileges(node)
169 # Verify responsiveness of PAPI.
170 VPPUtil.show_log(node)
171 VPPUtil.vpp_show_version(node)
173 DUTSetup.get_service_logs(node, Constants.VPP_UNIT)
176 def verify_vpp_on_all_duts(nodes):
177 """Verify that VPP is installed and started on all DUT nodes.
179 :param nodes: Nodes in the topology.
182 for node in nodes.values():
183 if node[u"type"] == NodeType.DUT:
184 VPPUtil.verify_vpp(node)
187 def vpp_show_version(node):
188 """Run "show_version" PAPI command.
190 :param node: Node to run command on.
192 :returns: VPP version.
195 cmd = u"show_version"
196 with PapiSocketExecutor(node) as papi_exec:
197 reply = papi_exec.add(cmd).get_reply()
198 logger.info(f"VPP version: {reply[u'version']}\n")
199 return f"{reply[u'version']}"
202 def show_vpp_version_on_all_duts(nodes):
203 """Show VPP version verbose on all DUTs.
205 :param nodes: Nodes in the topology.
208 for node in nodes.values():
209 if node[u"type"] == NodeType.DUT:
210 VPPUtil.vpp_show_version(node)
213 def vpp_show_interfaces(node):
214 """Run "show interface" CLI command.
216 :param node: Node to run command on.
220 cmd = u"sw_interface_dump"
222 name_filter_valid=False,
225 err_msg = f"Failed to get interface dump on host {node[u'host']}"
226 with PapiSocketExecutor(node) as papi_exec:
227 details = papi_exec.add(cmd, **args).get_details(err_msg)
229 for if_dump in details:
230 if_dump[u"l2_address"] = str(if_dump[u"l2_address"])
231 if_dump[u"b_dmac"] = str(if_dump[u"b_dmac"])
232 if_dump[u"b_smac"] = str(if_dump[u"b_smac"])
233 if_dump[u"flags"] = if_dump[u"flags"].value
234 if_dump[u"type"] = if_dump[u"type"].value
235 if_dump[u"link_duplex"] = if_dump[u"link_duplex"].value
236 if_dump[u"sub_if_flags"] = if_dump[u"sub_if_flags"].value \
237 if hasattr(if_dump[u"sub_if_flags"], u"value") \
238 else int(if_dump[u"sub_if_flags"])
239 # TODO: return only base data
240 logger.trace(f"Interface data of host {node[u'host']}:\n{details}")
243 def vpp_enable_traces_on_dut(node, fail_on_error=False):
244 """Enable vpp packet traces on the DUT node.
246 :param node: DUT node to set up.
247 :param fail_on_error: If True, keyword fails if an error occurs,
250 :type fail_on_error: bool
253 u"trace add dpdk-input 50",
254 u"trace add vhost-user-input 50",
255 u"trace add memif-input 50",
256 u"trace add avf-input 50"
261 PapiSocketExecutor.run_cli_cmd_on_all_sockets(node, cmd)
262 except AssertionError:
267 def vpp_enable_traces_on_all_duts(nodes, fail_on_error=False):
268 """Enable vpp packet traces on all DUTs in the given topology.
270 :param nodes: Nodes in the topology.
271 :param fail_on_error: If True, keyword fails if an error occurs,
274 :type fail_on_error: bool
276 for node in nodes.values():
277 if node[u"type"] == NodeType.DUT:
278 VPPUtil.vpp_enable_traces_on_dut(node, fail_on_error)
281 def vpp_enable_elog_traces(node):
282 """Enable API/CLI/Barrier traces on the specified topology node.
284 :param node: Topology node.
287 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
288 node, u"elog trace api cli barrier")
291 def vpp_enable_elog_traces_on_all_duts(nodes):
292 """Enable API/CLI/Barrier traces on all DUTs in the given topology.
294 :param nodes: Nodes in the topology.
297 for node in nodes.values():
298 if node[u"type"] == NodeType.DUT:
299 VPPUtil.vpp_enable_elog_traces(node)
302 def show_event_logger(node):
303 """Show event logger on the specified topology node.
305 :param node: Topology node.
308 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
309 node, u"show event-logger")
312 def show_event_logger_on_all_duts(nodes):
313 """Show event logger on all DUTs in the given topology.
315 :param nodes: Nodes in the topology.
318 for node in nodes.values():
319 if node[u"type"] == NodeType.DUT:
320 VPPUtil.show_event_logger(node)
324 """Show logging on the specified topology node.
326 :param node: Topology node.
329 PapiSocketExecutor.run_cli_cmd(node, u"show logging")
332 def show_log_on_all_duts(nodes):
333 """Show logging on all DUTs in the given topology.
335 :param nodes: Nodes in the topology.
338 for node in nodes.values():
339 if node[u"type"] == NodeType.DUT:
340 VPPUtil.show_log(node)
343 def vpp_show_threads(node):
344 """Show VPP threads on node.
346 :param node: Node to run command on.
348 :returns: VPP thread data.
351 cmd = u"show_threads"
352 with PapiSocketExecutor(node) as papi_exec:
353 reply = papi_exec.add(cmd).get_reply()
355 threads_data = reply[u"thread_data"]
356 logger.trace(f"show threads:\n{threads_data}")