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[])
120 vlib_error_main_t *em = &vm->error_main;
121 vlib_node_main_t *nm = &vm->node_main;
123 vlib_node_t *n = vlib_get_node (vm, node_index);
127 ASSERT (vlib_get_thread_index () == 0);
129 /* Free up any previous error strings. */
131 heap_dealloc (em->error_strings_heap, n->error_heap_handle);
133 n->n_errors = n_errors;
134 n->error_strings = error_strings;
139 n->error_heap_index =
140 heap_alloc (em->error_strings_heap, n_errors, n->error_heap_handle);
142 l = vec_len (em->error_strings_heap);
144 clib_memcpy (vec_elt_at_index (em->error_strings_heap, n->error_heap_index),
145 error_strings, n_errors * sizeof (error_strings[0]));
147 vec_validate (vm->error_elog_event_types, l - 1);
149 /* Switch to the stats segment ... */
150 oldheap = vlib_stats_push_heap (0);
152 /* Allocate a counter/elog type for each error. */
153 vec_validate (em->counters, l - 1);
155 /* Zero counters for re-registrations of errors. */
156 if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
157 clib_memcpy (em->counters + n->error_heap_index,
158 em->counters_last_clear + n->error_heap_index,
159 n_errors * sizeof (em->counters[0]));
161 clib_memset (em->counters + n->error_heap_index,
162 0, n_errors * sizeof (em->counters[0]));
164 /* Register counter indices in the stat segment directory */
169 for (i = 0; i < n_errors; i++)
171 vec_reset_length (error_name);
173 format (error_name, "/err/%v/%s%c", n->name, error_strings[i], 0);
174 vlib_stats_register_error_index (oldheap, error_name, em->counters,
175 n->error_heap_index + i);
178 vec_free (error_name);
181 /* (re)register the em->counters base address, switch back to main heap */
182 vlib_stats_pop_heap2 (em->counters, vm->thread_index, oldheap, 1);
188 clib_memset (&t, 0, sizeof (t));
190 vec_validate (nm->node_by_error, n->error_heap_index + n_errors - 1);
191 for (i = 0; i < n_errors; i++)
193 t.format = (char *) format (0, "%v %s: %%d",
194 n->name, error_strings[i]);
195 vm->error_elog_event_types[n->error_heap_index + i] = t;
196 nm->node_by_error[n->error_heap_index + i] = n->index;
201 static clib_error_t *
202 show_errors (vlib_main_t * vm,
203 unformat_input_t * input, vlib_cli_command_t * cmd)
205 vlib_error_main_t *em = &vm->error_main;
213 if (unformat (input, "verbose %d", &verbose))
215 else if (unformat (input, "verbose"))
218 vec_validate (sums, vec_len (em->counters));
221 vlib_cli_output (vm, "%=10s%=40s%=20s%=6s", "Count", "Node", "Reason",
224 vlib_cli_output (vm, "%=10s%=40s%=6s", "Count", "Node", "Reason");
229 em = &this_vlib_main->error_main;
232 vlib_cli_output(vm, "Thread %u (%v):", index,
233 vlib_worker_threads[index].name);
235 for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
237 n = vlib_get_node (this_vlib_main, ni);
238 for (code = 0; code < n->n_errors; code++)
240 i = n->error_heap_index + code;
242 if (i < vec_len (em->counters_last_clear))
243 c -= em->counters_last_clear[i];
246 if (c == 0 && verbose < 2)
250 vlib_cli_output (vm, "%10Ld%=40v%=20s%=6d", c, n->name,
251 em->error_strings_heap[i], i);
253 vlib_cli_output (vm, "%10d%=40v%s", c, n->name,
254 em->error_strings_heap[i]);
262 vlib_cli_output (vm, "Total:");
264 for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
266 n = vlib_get_node (vm, ni);
267 for (code = 0; code < n->n_errors; code++)
269 i = n->error_heap_index + code;
273 vlib_cli_output (vm, "%10Ld%=40v%=20s%=10d", sums[i], n->name,
274 em->error_strings_heap[i], i);
285 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
286 .path = "show errors",
287 .short_help = "Show error counts",
288 .function = show_errors,
293 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
294 .path = "show node counters",
295 .short_help = "Show node counters",
296 .function = show_errors,
300 static clib_error_t *
301 clear_error_counters (vlib_main_t * vm,
302 unformat_input_t * input, vlib_cli_command_t * cmd)
304 vlib_error_main_t *em;
309 em = &this_vlib_main->error_main;
310 vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
311 for (i = 0; i < vec_len (em->counters); i++)
312 em->counters_last_clear[i] = em->counters[i];
319 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
320 .path = "clear errors",
321 .short_help = "Clear error counters",
322 .function = clear_error_counters,
327 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
328 .path = "clear node counters",
329 .short_help = "Clear node counters",
330 .function = clear_error_counters,
335 * fd.io coding-style-patch-verification: ON
338 * eval: (c-set-style "gnu")