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/stat_weak_inlines.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);
115 /* Reserves given number of error codes for given node. */
117 vlib_register_errors (vlib_main_t * vm,
118 u32 node_index, u32 n_errors, char *error_strings[],
119 vl_counter_t counters[])
121 vlib_error_main_t *em = &vm->error_main;
122 vlib_node_main_t *nm = &vm->node_main;
124 vlib_node_t *n = vlib_get_node (vm, node_index);
128 ASSERT (vlib_get_thread_index () == 0);
130 /* Free up any previous error strings. */
132 heap_dealloc (em->counters_heap, n->error_heap_handle);
134 n->n_errors = n_errors;
135 n->error_counters = counters;
143 counters = clib_mem_alloc (sizeof (counters[0]) * n_errors);
145 for (i = 0; i < n_errors; i++)
147 counters[i].name = error_strings[i];
148 counters[i].desc = error_strings[i];
149 counters[i].severity = VL_COUNTER_SEVERITY_ERROR;
153 n->error_heap_index =
154 heap_alloc (em->counters_heap, n_errors, n->error_heap_handle);
155 l = vec_len (em->counters_heap);
156 clib_memcpy (vec_elt_at_index (em->counters_heap, n->error_heap_index),
157 counters, n_errors * sizeof (counters[0]));
159 vec_validate (vm->error_elog_event_types, l - 1);
161 /* Switch to the stats segment ... */
162 oldheap = vlib_stats_push_heap (0);
164 /* Allocate a counter/elog type for each error. */
165 vec_validate (em->counters, l - 1);
167 /* Zero counters for re-registrations of errors. */
168 if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
169 clib_memcpy (em->counters + n->error_heap_index,
170 em->counters_last_clear + n->error_heap_index,
171 n_errors * sizeof (em->counters[0]));
173 clib_memset (em->counters + n->error_heap_index,
174 0, n_errors * sizeof (em->counters[0]));
176 /* Register counter indices in the stat segment directory */
181 for (i = 0; i < n_errors; i++)
183 vec_reset_length (error_name);
185 format (error_name, "/err/%v/%s%c", n->name, counters[i].name, 0);
186 vlib_stats_register_error_index (oldheap, error_name, em->counters,
187 n->error_heap_index + i);
190 vec_free (error_name);
193 /* (re)register the em->counters base address, switch back to main heap */
194 vlib_stats_pop_heap2 (em->counters, vm->thread_index, oldheap, 1);
200 clib_memset (&t, 0, sizeof (t));
202 vec_validate (nm->node_by_error, n->error_heap_index + n_errors - 1);
203 for (i = 0; i < n_errors; i++)
205 t.format = (char *) format (0, "%v %s: %%d",
206 n->name, counters[i].name);
207 vm->error_elog_event_types[n->error_heap_index + i] = t;
208 nm->node_by_error[n->error_heap_index + i] = n->index;
214 unformat_vlib_error (unformat_input_t *input, va_list *args)
216 vlib_main_t *vm = va_arg (*args, vlib_main_t *);
217 const vlib_error_main_t *em = &vm->error_main;
218 vlib_error_t *error_index = va_arg (*args, vlib_error_t *);
219 const vlib_node_t *node;
224 if (!unformat (input, "%U.%s", unformat_vlib_node, vm, &node_index,
228 node = vlib_get_node (vm, node_index);
229 for (i = 0; i < node->n_errors; i++)
231 vlib_error_t ei = node->error_heap_index + i;
232 if (strcmp (em->counters_heap[ei].name, error_name) == 0)
235 vec_free (error_name);
240 vec_free (error_name);
245 sev2str (enum vl_counter_severity_e s)
249 case VL_COUNTER_SEVERITY_ERROR:
251 case VL_COUNTER_SEVERITY_WARN:
253 case VL_COUNTER_SEVERITY_INFO:
260 static clib_error_t *
261 show_errors (vlib_main_t * vm,
262 unformat_input_t * input, vlib_cli_command_t * cmd)
264 vlib_error_main_t *em = &vm->error_main;
272 if (unformat (input, "verbose %d", &verbose))
274 else if (unformat (input, "verbose"))
277 vec_validate (sums, vec_len (em->counters));
280 vlib_cli_output (vm, "%=10s%=35s%=35s%=10s%=6s", "Count", "Node",
281 "Reason", "Severity", "Index");
283 vlib_cli_output (vm, "%=10s%=35s%=35s%=10s", "Count", "Node", "Reason",
288 em = &this_vlib_main->error_main;
291 vlib_cli_output (vm, "Thread %u (%v):", index,
292 vlib_worker_threads[index].name);
294 for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
296 n = vlib_get_node (this_vlib_main, ni);
297 for (code = 0; code < n->n_errors; code++)
299 i = n->error_heap_index + code;
301 if (i < vec_len (em->counters_last_clear))
302 c -= em->counters_last_clear[i];
305 if (c == 0 && verbose < 2)
309 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s%=6d", c, n->name,
310 em->counters_heap[i].name,
311 sev2str (em->counters_heap[i].severity), i);
313 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s", c, n->name,
314 em->counters_heap[i].name,
315 sev2str (em->counters_heap[i].severity));
322 vlib_cli_output (vm, "Total:");
324 for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
326 n = vlib_get_node (vm, ni);
327 for (code = 0; code < n->n_errors; code++)
329 i = n->error_heap_index + code;
333 vlib_cli_output (vm, "%10lu%=40v%=20s%=10d", sums[i], n->name,
334 em->counters_heap[i].name, i);
345 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
346 .path = "show errors",
347 .short_help = "Show error counts",
348 .function = show_errors,
353 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
354 .path = "show node counters",
355 .short_help = "Show node counters",
356 .function = show_errors,
360 static clib_error_t *
361 clear_error_counters (vlib_main_t * vm,
362 unformat_input_t * input, vlib_cli_command_t * cmd)
364 vlib_error_main_t *em;
369 em = &this_vlib_main->error_main;
370 vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
371 for (i = 0; i < vec_len (em->counters); i++)
372 em->counters_last_clear[i] = em->counters[i];
378 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
379 .path = "clear errors",
380 .short_help = "Clear error counters",
381 .function = clear_error_counters,
386 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
387 .path = "clear node counters",
388 .short_help = "Clear node counters",
389 .function = clear_error_counters,
394 * fd.io coding-style-patch-verification: ON
397 * eval: (c-set-style "gnu")