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;
56 drop_error = vlib_error_set (drop_error_node, drop_error_code);
58 n_buffers_left = n_buffers;
59 while (n_buffers_left > 0)
61 vlib_get_next_frame (vm, node, next_index, args, n_args_left);
63 n_left_this_frame = clib_min (n_buffers_left, n_args_left);
64 n_buffers_left -= n_left_this_frame;
65 n_args_left -= n_left_this_frame;
67 while (n_left_this_frame >= 4)
69 u32 bi0, bi1, bi2, bi3;
70 vlib_buffer_t *b0, *b1, *b2, *b3;
72 args[0] = bi0 = buffers[0];
73 args[1] = bi1 = buffers[1];
74 args[2] = bi2 = buffers[2];
75 args[3] = bi3 = buffers[3];
77 b0 = vlib_get_buffer (vm, bi0);
78 b1 = vlib_get_buffer (vm, bi1);
79 b2 = vlib_get_buffer (vm, bi2);
80 b3 = vlib_get_buffer (vm, bi3);
82 b0->error = drop_error;
83 b1->error = drop_error;
84 b2->error = drop_error;
85 b3->error = drop_error;
89 n_left_this_frame -= 4;
92 while (n_left_this_frame >= 1)
97 args[0] = bi0 = buffers[0];
99 b0 = vlib_get_buffer (vm, bi0);
100 b0->error = drop_error;
104 n_left_this_frame -= 1;
107 vlib_put_next_frame (vm, node, next_index, n_args_left);
113 /* Reserves given number of error codes for given node. */
115 vlib_register_errors (vlib_main_t * vm,
116 u32 node_index, u32 n_errors, char *error_strings[])
118 vlib_error_main_t *em = &vm->error_main;
119 vlib_node_t *n = vlib_get_node (vm, node_index);
123 ASSERT (vlib_get_thread_index () == 0);
125 /* Free up any previous error strings. */
127 heap_dealloc (em->error_strings_heap, n->error_heap_handle);
129 n->n_errors = n_errors;
130 n->error_strings = error_strings;
135 n->error_heap_index =
136 heap_alloc (em->error_strings_heap, n_errors, n->error_heap_handle);
138 l = vec_len (em->error_strings_heap);
140 clib_memcpy (vec_elt_at_index (em->error_strings_heap, n->error_heap_index),
141 error_strings, n_errors * sizeof (error_strings[0]));
143 vec_validate (vm->error_elog_event_types, l - 1);
145 /* Switch to the stats segment ... */
146 oldheap = vlib_stats_push_heap (0);
148 /* Allocate a counter/elog type for each error. */
149 vec_validate (em->counters, l - 1);
151 /* Zero counters for re-registrations of errors. */
152 if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
153 clib_memcpy (em->counters + n->error_heap_index,
154 em->counters_last_clear + n->error_heap_index,
155 n_errors * sizeof (em->counters[0]));
157 clib_memset (em->counters + n->error_heap_index,
158 0, n_errors * sizeof (em->counters[0]));
160 /* Register counter indices in the stat segment directory */
165 for (i = 0; i < n_errors; i++)
167 error_name = format (0, "/err/%v/%s%c", n->name, error_strings[i], 0);
168 /* Note: error_name consumed by the following call */
169 vlib_stats_register_error_index (oldheap, error_name, em->counters,
170 n->error_heap_index + i);
174 /* (re)register the em->counters base address, switch back to main heap */
175 vlib_stats_pop_heap2 (em->counters, vm->thread_index, oldheap, 1);
181 clib_memset (&t, 0, sizeof (t));
182 for (i = 0; i < n_errors; i++)
184 t.format = (char *) format (0, "%v %s: %%d",
185 n->name, error_strings[i]);
186 vm->error_elog_event_types[n->error_heap_index + i] = t;
191 static clib_error_t *
192 show_errors (vlib_main_t * vm,
193 unformat_input_t * input, vlib_cli_command_t * cmd)
195 vlib_error_main_t *em = &vm->error_main;
203 if (unformat (input, "verbose %d", &verbose))
205 else if (unformat (input, "verbose"))
208 vec_validate (sums, vec_len (em->counters));
211 vlib_cli_output (vm, "%=10s%=40s%=20s%=6s", "Count", "Node", "Reason",
214 vlib_cli_output (vm, "%=10s%=40s%=6s", "Count", "Node", "Reason");
219 em = &this_vlib_main->error_main;
222 vlib_cli_output(vm, "Thread %u (%v):", index,
223 vlib_worker_threads[index].name);
225 for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
227 n = vlib_get_node (this_vlib_main, ni);
228 for (code = 0; code < n->n_errors; code++)
230 i = n->error_heap_index + code;
232 if (i < vec_len (em->counters_last_clear))
233 c -= em->counters_last_clear[i];
236 if (c == 0 && verbose < 2)
240 vlib_cli_output (vm, "%10Ld%=40v%=20s%=6d", c, n->name,
241 em->error_strings_heap[i], i);
243 vlib_cli_output (vm, "%10d%=40v%s", c, n->name,
244 em->error_strings_heap[i]);
252 vlib_cli_output (vm, "Total:");
254 for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
256 n = vlib_get_node (vm, ni);
257 for (code = 0; code < n->n_errors; code++)
259 i = n->error_heap_index + code;
263 vlib_cli_output (vm, "%10Ld%=40v%=20s%=10d", sums[i], n->name,
264 em->error_strings_heap[i], i);
275 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
276 .path = "show errors",
277 .short_help = "Show error counts",
278 .function = show_errors,
283 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
284 .path = "show node counters",
285 .short_help = "Show node counters",
286 .function = show_errors,
290 static clib_error_t *
291 clear_error_counters (vlib_main_t * vm,
292 unformat_input_t * input, vlib_cli_command_t * cmd)
294 vlib_error_main_t *em;
299 em = &this_vlib_main->error_main;
300 vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
301 for (i = 0; i < vec_len (em->counters); i++)
302 em->counters_last_clear[i] = em->counters[i];
309 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
310 .path = "clear errors",
311 .short_help = "Clear error counters",
312 .function = clear_error_counters,
317 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
318 .path = "clear node counters",
319 .short_help = "Clear node counters",
320 .function = clear_error_counters,
325 * fd.io coding-style-patch-verification: ON
328 * eval: (c-set-style "gnu")