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 counters utilities library."""
16 from pprint import pformat
18 from robot.api import logger
20 from resources.libraries.python.PapiExecutor import PapiExecutor, \
22 from resources.libraries.python.topology import Topology, SocketType, NodeType
26 """VPP counters utilities."""
29 self._stats_table = None
32 def vpp_show_errors(node):
33 """Run "show errors" debug CLI command.
35 :param node: Node to run command on.
38 PapiSocketExecutor.run_cli_cmd_on_all_sockets(node, u"show errors")
41 def vpp_show_errors_on_all_duts(nodes):
42 """Show errors on all DUTs.
44 :param nodes: VPP nodes.
47 for node in nodes.values():
48 if node[u"type"] == NodeType.DUT:
49 VppCounters.vpp_show_errors(node)
52 def vpp_show_runtime(node, log_zeros=False):
53 """Run "show runtime" CLI command.
55 :param node: Node to run command on.
56 :param log_zeros: Log also items with zero values.
60 args = dict(path=u"^/sys/node")
61 sockets = Topology.get_node_sockets(node, socket_type=SocketType.STATS)
63 for socket in sockets.values():
64 with PapiExecutor(node) as papi_exec:
65 stats = papi_exec.add(u"vpp-stats", **args).\
66 get_stats(socket=socket)[0]
68 names = stats[u"/sys/node/names"]
77 runtime.append({u"name": name})
79 for idx, runtime_item in enumerate(runtime):
82 for thread in stats[u"/sys/node/calls"]:
83 calls_th.append(thread[idx])
84 runtime_item[u"calls"] = calls_th
87 for thread in stats[u"/sys/node/vectors"]:
88 vectors_th.append(thread[idx])
89 runtime_item[u"vectors"] = vectors_th
92 for thread in stats[u"/sys/node/suspends"]:
93 suspends_th.append(thread[idx])
94 runtime_item[u"suspends"] = suspends_th
97 for thread in stats[u"/sys/node/clocks"]:
98 clocks_th.append(thread[idx])
99 runtime_item[u"clocks"] = clocks_th
101 if (sum(calls_th) or sum(vectors_th) or
102 sum(suspends_th) or sum(clocks_th)):
103 runtime_nz.append(runtime_item)
107 f"stats runtime ({node[u'host']} - {socket}):\n"
108 f"{pformat(runtime)}"
112 f"stats runtime ({node[u'host']} - {socket}):\n"
113 f"{pformat(runtime_nz)}"
115 # Run also the CLI command, the above sometimes misses some info.
116 PapiSocketExecutor.run_cli_cmd_on_all_sockets(node, u"show runtime")
119 def vpp_show_runtime_on_all_duts(nodes):
120 """Clear VPP runtime counters on all DUTs.
122 :param nodes: VPP nodes.
125 for node in nodes.values():
126 if node[u"type"] == NodeType.DUT:
127 VppCounters.vpp_show_runtime(node)
130 def vpp_show_hardware(node):
131 """Run "show hardware" debug CLI command.
133 :param node: Node to run command on.
136 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
137 node, u"show hardware verbose"
141 def vpp_show_memory(node):
142 """Run "show memory" debug CLI command.
144 Currently, every flag is hardcoded, giving the longest output.
146 :param node: Node to run command on.
149 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
150 node, u"show memory verbose api-segment stats-segment main-heap"
154 def vpp_show_memory_on_all_duts(nodes):
155 """Run "show memory" on all DUTs.
157 :param nodes: VPP nodes.
160 for node in nodes.values():
161 if node[u"type"] == NodeType.DUT:
162 VppCounters.vpp_show_memory(node)
165 def vpp_clear_runtime(node):
166 """Run "clear runtime" CLI command.
168 :param node: Node to run command on.
171 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
172 node, u"clear runtime", log=False
176 def vpp_clear_runtime_on_all_duts(nodes):
177 """Run "clear runtime" CLI command on all DUTs.
179 :param nodes: VPP nodes.
182 for node in nodes.values():
183 if node[u"type"] == NodeType.DUT:
184 VppCounters.vpp_clear_runtime(node)
187 def vpp_clear_hardware(node):
188 """Run "clear hardware" CLI command.
190 :param node: Node to run command on.
192 :returns: Verified data from PAPI response.
195 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
196 node, u"clear hardware", log=False
200 def vpp_clear_hardware_on_all_duts(nodes):
201 """Clear hardware on all DUTs.
203 :param nodes: VPP nodes.
206 for node in nodes.values():
207 if node[u"type"] == NodeType.DUT:
208 VppCounters.vpp_clear_hardware(node)
211 def vpp_clear_errors(node):
212 """Run "clear errors" CLI command.
214 :param node: Node to run command on.
217 PapiSocketExecutor.run_cli_cmd_on_all_sockets(
218 node, u"clear errors", log=False
222 def vpp_clear_errors_on_all_duts(nodes):
223 """Clear VPP errors counters on all DUTs.
225 :param nodes: VPP nodes.
228 for node in nodes.values():
229 if node[u"type"] == NodeType.DUT:
230 VppCounters.vpp_clear_errors(node)
233 def show_vpp_statistics(node):
234 """Show [errors, hardware] stats.
236 :param node: VPP node.
239 VppCounters.vpp_show_errors(node)
240 VppCounters.vpp_show_hardware(node)
243 def show_statistics_on_all_duts(nodes):
244 """Show statistics on all DUTs.
246 :param nodes: DUT nodes.
249 for node in nodes.values():
250 if node[u"type"] == NodeType.DUT:
251 VppCounters.show_vpp_statistics(node)
254 def clear_vpp_statistics(node):
255 """Clear [errors, hardware] stats.
257 :param node: VPP node.
260 VppCounters.vpp_clear_errors(node)
261 VppCounters.vpp_clear_hardware(node)
264 def clear_statistics_on_all_duts(nodes):
265 """Clear statistics on all DUTs.
267 :param nodes: DUT nodes.
270 for node in nodes.values():
271 if node[u"type"] == NodeType.DUT:
272 VppCounters.clear_vpp_statistics(node)