2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * error.c: VLIB error handler
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #include <vlib/vlib.h>
41 #include <vppinfra/heap.h>
42 #include <vlib/stats/stats.h>
45 vlib_error_drop_buffers (vlib_main_t * vm,
46 vlib_node_runtime_t * node,
48 u32 next_buffer_stride,
51 u32 drop_error_node, u32 drop_error_code)
53 u32 n_left_this_frame, n_buffers_left, *args, n_args_left;
54 vlib_error_t drop_error;
57 n = vlib_get_node (vm, drop_error_node);
58 drop_error = n->error_heap_index + drop_error_code;
60 n_buffers_left = n_buffers;
61 while (n_buffers_left > 0)
63 vlib_get_next_frame (vm, node, next_index, args, n_args_left);
65 n_left_this_frame = clib_min (n_buffers_left, n_args_left);
66 n_buffers_left -= n_left_this_frame;
67 n_args_left -= n_left_this_frame;
69 while (n_left_this_frame >= 4)
71 u32 bi0, bi1, bi2, bi3;
72 vlib_buffer_t *b0, *b1, *b2, *b3;
74 args[0] = bi0 = buffers[0];
75 args[1] = bi1 = buffers[1];
76 args[2] = bi2 = buffers[2];
77 args[3] = bi3 = buffers[3];
79 b0 = vlib_get_buffer (vm, bi0);
80 b1 = vlib_get_buffer (vm, bi1);
81 b2 = vlib_get_buffer (vm, bi2);
82 b3 = vlib_get_buffer (vm, bi3);
84 b0->error = drop_error;
85 b1->error = drop_error;
86 b2->error = drop_error;
87 b3->error = drop_error;
91 n_left_this_frame -= 4;
94 while (n_left_this_frame >= 1)
99 args[0] = bi0 = buffers[0];
101 b0 = vlib_get_buffer (vm, bi0);
102 b0->error = drop_error;
106 n_left_this_frame -= 1;
109 vlib_put_next_frame (vm, node, next_index, n_args_left);
116 format_stats_counter_name (u8 *s, va_list *va)
118 u8 *id = va_arg (*va, u8 *);
120 for (u32 i = 0; id[i] != 0; i++)
121 vec_add1 (s, id[i] == ' ' ? ' ' : id[i]);
127 vlib_unregister_errors (vlib_main_t *vm, u32 node_index)
129 vlib_error_main_t *em = &vm->error_main;
130 vlib_node_t *n = vlib_get_node (vm, node_index);
131 vlib_error_desc_t *cd;
135 cd = vec_elt_at_index (em->counters_heap, n->error_heap_index);
136 for (u32 i = 0; i < n->n_errors; i++)
137 vlib_stats_remove_entry (cd[i].stats_entry_index);
138 heap_dealloc (em->counters_heap, n->error_heap_handle);
143 /* Reserves given number of error codes for given node. */
145 vlib_register_errors (vlib_main_t *vm, u32 node_index, u32 n_errors,
146 char *error_strings[], vlib_error_desc_t counters[])
148 vlib_error_main_t *em = &vm->error_main;
149 vlib_node_main_t *nm = &vm->node_main;
150 vlib_node_t *n = vlib_get_node (vm, node_index);
151 vlib_error_desc_t *cd;
152 u32 n_threads = vlib_get_n_threads ();
153 elog_event_type_t t = {};
157 ASSERT (vlib_get_thread_index () == 0);
159 vlib_stats_segment_lock ();
161 /* Free up any previous error strings. */
162 vlib_unregister_errors (vm, node_index);
164 n->n_errors = n_errors;
165 n->error_counters = counters;
170 n->error_heap_index =
171 heap_alloc (em->counters_heap, n_errors, n->error_heap_handle);
172 l = vec_len (em->counters_heap);
173 cd = vec_elt_at_index (em->counters_heap, n->error_heap_index);
178 for (int i = 0; i < n_errors; i++)
180 cd[i].name = error_strings[i];
181 cd[i].desc = error_strings[i];
182 cd[i].severity = VL_COUNTER_SEVERITY_ERROR;
186 clib_memcpy (cd, counters, n_errors * sizeof (counters[0]));
188 vec_validate (vm->error_elog_event_types, l - 1);
190 if (em->stats_err_entry_index == 0)
191 em->stats_err_entry_index = vlib_stats_add_counter_vector ("/node/errors");
193 ASSERT (em->stats_err_entry_index != 0 && em->stats_err_entry_index != ~0);
195 vlib_stats_validate (em->stats_err_entry_index, n_threads - 1, l - 1);
196 sc = vlib_stats_get_entry_data_pointer (em->stats_err_entry_index);
198 for (int i = 0; i < n_threads; i++)
200 vlib_main_t *tvm = vlib_get_main_by_index (i);
201 vlib_error_main_t *tem = &tvm->error_main;
202 tem->counters = sc[i];
204 /* Zero counters for re-registrations of errors. */
205 if (n->error_heap_index + n_errors <= vec_len (tem->counters_last_clear))
206 clib_memcpy (tem->counters + n->error_heap_index,
207 tem->counters_last_clear + n->error_heap_index,
208 n_errors * sizeof (tem->counters[0]));
210 clib_memset (tem->counters + n->error_heap_index, 0,
211 n_errors * sizeof (tem->counters[0]));
214 /* Register counter indices in the stat segment directory */
215 for (int i = 0; i < n_errors; i++)
216 cd[i].stats_entry_index = vlib_stats_add_symlink (
217 em->stats_err_entry_index, n->error_heap_index + i, "/err/%v/%U",
218 n->name, format_stats_counter_name, cd[i].name);
220 vec_validate (nm->node_by_error, n->error_heap_index + n_errors - 1);
222 for (u32 i = 0; i < n_errors; i++)
224 t.format = (char *) format (0, "%v %s: %%d", n->name, cd[i].name);
225 vec_free (vm->error_elog_event_types[n->error_heap_index + i].format);
226 vm->error_elog_event_types[n->error_heap_index + i] = t;
227 nm->node_by_error[n->error_heap_index + i] = n->index;
231 vlib_stats_segment_unlock ();
235 unformat_vlib_error (unformat_input_t *input, va_list *args)
237 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
238 const vlib_error_main_t *em = &vm->error_main;
239 vlib_error_t *error_index = va_arg (*args, vlib_error_t *);
240 const vlib_node_t *node;
245 if (!unformat (input, "%U.%s", unformat_vlib_node, vm, &node_index,
249 node = vlib_get_node (vm, node_index);
250 for (i = 0; i < node->n_errors; i++)
252 vlib_error_t ei = node->error_heap_index + i;
253 if (strcmp (em->counters_heap[ei].name, error_name) == 0)
256 vec_free (error_name);
261 vec_free (error_name);
266 sev2str (enum vl_counter_severity_e s)
270 case VL_COUNTER_SEVERITY_ERROR:
272 case VL_COUNTER_SEVERITY_WARN:
274 case VL_COUNTER_SEVERITY_INFO:
281 static clib_error_t *
282 show_errors (vlib_main_t * vm,
283 unformat_input_t * input, vlib_cli_command_t * cmd)
285 vlib_error_main_t *em = &vm->error_main;
293 if (unformat (input, "verbose %d", &verbose))
295 else if (unformat (input, "verbose"))
298 vec_validate (sums, vec_len (em->counters));
301 vlib_cli_output (vm, "%=10s%=35s%=35s%=10s%=6s", "Count", "Node",
302 "Reason", "Severity", "Index");
304 vlib_cli_output (vm, "%=10s%=35s%=35s%=10s", "Count", "Node", "Reason",
309 em = &this_vlib_main->error_main;
312 vlib_cli_output (vm, "Thread %u (%v):", index,
313 vlib_worker_threads[index].name);
315 for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
317 n = vlib_get_node (this_vlib_main, ni);
318 for (code = 0; code < n->n_errors; code++)
320 i = n->error_heap_index + code;
322 if (i < vec_len (em->counters_last_clear))
323 c -= em->counters_last_clear[i];
326 if (c == 0 && verbose < 2)
330 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s%=6d", c, n->name,
331 em->counters_heap[i].desc,
332 sev2str (em->counters_heap[i].severity), i);
334 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s", c, n->name,
335 em->counters_heap[i].desc,
336 sev2str (em->counters_heap[i].severity));
343 vlib_cli_output (vm, "Total:");
345 for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
347 n = vlib_get_node (vm, ni);
348 for (code = 0; code < n->n_errors; code++)
350 i = n->error_heap_index + code;
354 vlib_cli_output (vm, "%10lu%=40v%=20s%=10d", sums[i], n->name,
355 em->counters_heap[i].desc, i);
366 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
367 .path = "show errors",
368 .short_help = "Show error counts",
369 .function = show_errors,
374 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
375 .path = "show node counters",
376 .short_help = "Show node counters",
377 .function = show_errors,
381 static clib_error_t *
382 clear_error_counters (vlib_main_t * vm,
383 unformat_input_t * input, vlib_cli_command_t * cmd)
385 vlib_error_main_t *em;
390 em = &this_vlib_main->error_main;
391 vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
392 for (i = 0; i < vec_len (em->counters); i++)
393 em->counters_last_clear[i] = em->counters[i];
399 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
400 .path = "clear errors",
401 .short_help = "Clear error counters",
402 .function = clear_error_counters,
407 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
408 .path = "clear node counters",
409 .short_help = "Clear node counters",
410 .function = clear_error_counters,
415 * fd.io coding-style-patch-verification: ON
418 * eval: (c-set-style "gnu")