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>
44 vlib_error_drop_buffers (vlib_main_t * vm,
45 vlib_node_runtime_t * node,
47 u32 next_buffer_stride,
50 u32 drop_error_node, u32 drop_error_code)
52 u32 n_left_this_frame, n_buffers_left, *args, n_args_left;
53 vlib_error_t drop_error;
55 drop_error = vlib_error_set (drop_error_node, drop_error_code);
57 n_buffers_left = n_buffers;
58 while (n_buffers_left > 0)
60 vlib_get_next_frame (vm, node, next_index, args, n_args_left);
62 n_left_this_frame = clib_min (n_buffers_left, n_args_left);
63 n_buffers_left -= n_left_this_frame;
64 n_args_left -= n_left_this_frame;
66 while (n_left_this_frame >= 4)
68 u32 bi0, bi1, bi2, bi3;
69 vlib_buffer_t *b0, *b1, *b2, *b3;
71 args[0] = bi0 = buffers[0];
72 args[1] = bi1 = buffers[1];
73 args[2] = bi2 = buffers[2];
74 args[3] = bi3 = buffers[3];
76 b0 = vlib_get_buffer (vm, bi0);
77 b1 = vlib_get_buffer (vm, bi1);
78 b2 = vlib_get_buffer (vm, bi2);
79 b3 = vlib_get_buffer (vm, bi3);
81 b0->error = drop_error;
82 b1->error = drop_error;
83 b2->error = drop_error;
84 b3->error = drop_error;
88 n_left_this_frame -= 4;
91 while (n_left_this_frame >= 1)
96 args[0] = bi0 = buffers[0];
98 b0 = vlib_get_buffer (vm, bi0);
99 b0->error = drop_error;
103 n_left_this_frame -= 1;
106 vlib_put_next_frame (vm, node, next_index, n_args_left);
112 /* Convenience node to drop a vector of buffers with a "misc error". */
114 misc_drop_buffers (vlib_main_t * vm,
115 vlib_node_runtime_t * node, vlib_frame_t * frame)
117 return vlib_error_drop_buffers (vm, node, vlib_frame_args (frame),
118 /* buffer stride */ 1,
125 static char *misc_drop_buffers_error_strings[] = {
126 [0] = "misc. errors",
130 VLIB_REGISTER_NODE (misc_drop_buffers_node,static) = {
131 .function = misc_drop_buffers,
132 .name = "misc-drop-buffers",
133 .vector_size = sizeof (u32),
139 .error_strings = misc_drop_buffers_error_strings,
143 void vlib_stats_register_error_index (u8 *, u64 *, u64)
144 __attribute__ ((weak));
146 vlib_stats_register_error_index (u8 * notused, u64 * notused2, u64 notused3)
150 void vlib_stats_pop_heap2 (void *, u32, void *) __attribute__ ((weak));
152 vlib_stats_pop_heap2 (void *notused, u32 notused2, void *notused3)
157 /* Reserves given number of error codes for given node. */
159 vlib_register_errors (vlib_main_t * vm,
160 u32 node_index, u32 n_errors, char *error_strings[])
162 vlib_error_main_t *em = &vm->error_main;
163 vlib_node_t *n = vlib_get_node (vm, node_index);
166 void *vlib_stats_push_heap (void) __attribute__ ((weak));
168 ASSERT (vlib_get_thread_index () == 0);
170 /* Free up any previous error strings. */
172 heap_dealloc (em->error_strings_heap, n->error_heap_handle);
174 n->n_errors = n_errors;
175 n->error_strings = error_strings;
180 n->error_heap_index =
181 heap_alloc (em->error_strings_heap, n_errors, n->error_heap_handle);
183 l = vec_len (em->error_strings_heap);
185 clib_memcpy (vec_elt_at_index (em->error_strings_heap, n->error_heap_index),
186 error_strings, n_errors * sizeof (error_strings[0]));
188 vec_validate (vm->error_elog_event_types, l - 1);
190 /* Switch to the stats segment ... */
191 oldheap = vlib_stats_push_heap ();
193 /* Allocate a counter/elog type for each error. */
194 vec_validate (em->counters, l - 1);
196 /* Zero counters for re-registrations of errors. */
197 if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
198 clib_memcpy (em->counters + n->error_heap_index,
199 em->counters_last_clear + n->error_heap_index,
200 n_errors * sizeof (em->counters[0]));
202 clib_memset (em->counters + n->error_heap_index,
203 0, n_errors * sizeof (em->counters[0]));
205 /* Register counter indices in the stat segment directory */
210 for (i = 0; i < n_errors; i++)
212 error_name = format (0, "/err/%v/%s%c", n->name, error_strings[i], 0);
213 /* Note: error_name consumed by the following call */
214 vlib_stats_register_error_index (error_name, em->counters,
215 n->error_heap_index + i);
219 /* (re)register the em->counters base address, switch back to main heap */
220 vlib_stats_pop_heap2 (em->counters, vm->thread_index, oldheap);
226 clib_memset (&t, 0, sizeof (t));
227 for (i = 0; i < n_errors; i++)
229 t.format = (char *) format (0, "%v %s: %%d",
230 n->name, error_strings[i]);
231 vm->error_elog_event_types[n->error_heap_index + i] = t;
236 static clib_error_t *
237 show_errors (vlib_main_t * vm,
238 unformat_input_t * input, vlib_cli_command_t * cmd)
240 vlib_error_main_t *em = &vm->error_main;
248 if (unformat (input, "verbose %d", &verbose))
250 else if (unformat (input, "verbose"))
253 vec_validate (sums, vec_len (em->counters));
256 vlib_cli_output (vm, "%=10s%=40s%=20s%=6s", "Count", "Node", "Reason",
259 vlib_cli_output (vm, "%=10s%=40s%=6s", "Count", "Node", "Reason");
264 em = &this_vlib_main->error_main;
267 vlib_cli_output(vm, "Thread %u (%v):", index,
268 vlib_worker_threads[index].name);
270 for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
272 n = vlib_get_node (this_vlib_main, ni);
273 for (code = 0; code < n->n_errors; code++)
275 i = n->error_heap_index + code;
277 if (i < vec_len (em->counters_last_clear))
278 c -= em->counters_last_clear[i];
281 if (c == 0 && verbose < 2)
285 vlib_cli_output (vm, "%10Ld%=40v%=20s%=6d", c, n->name,
286 em->error_strings_heap[i], i);
288 vlib_cli_output (vm, "%10d%=40v%s", c, n->name,
289 em->error_strings_heap[i]);
297 vlib_cli_output (vm, "Total:");
299 for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
301 n = vlib_get_node (vm, ni);
302 for (code = 0; code < n->n_errors; code++)
304 i = n->error_heap_index + code;
308 vlib_cli_output (vm, "%10Ld%=40v%=20s%=10d", sums[i], n->name,
309 em->error_strings_heap[i], i);
320 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
321 .path = "show errors",
322 .short_help = "Show error counts",
323 .function = show_errors,
328 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
329 .path = "show node counters",
330 .short_help = "Show node counters",
331 .function = show_errors,
335 static clib_error_t *
336 clear_error_counters (vlib_main_t * vm,
337 unformat_input_t * input, vlib_cli_command_t * cmd)
339 vlib_error_main_t *em;
344 em = &this_vlib_main->error_main;
345 vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
346 for (i = 0; i < vec_len (em->counters); i++)
347 em->counters_last_clear[i] = em->counters[i];
354 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
355 .path = "clear errors",
356 .short_help = "Clear error counters",
357 .function = clear_error_counters,
362 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
363 .path = "clear node counters",
364 .short_help = "Clear node counters",
365 .function = clear_error_counters,
370 * fd.io coding-style-patch-verification: ON
373 * eval: (c-set-style "gnu")