FD.io VPP  v19.01.1-17-ge106252
Vector Packet Processing
error.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * error.c: VLIB error handler
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 #include <vlib/vlib.h>
41 #include <vppinfra/heap.h>
42 
43 uword
45  vlib_node_runtime_t * node,
46  u32 * buffers,
47  u32 next_buffer_stride,
48  u32 n_buffers,
49  u32 next_index,
50  u32 drop_error_node, u32 drop_error_code)
51 {
52  u32 n_left_this_frame, n_buffers_left, *args, n_args_left;
53  vlib_error_t drop_error;
54 
55  drop_error = vlib_error_set (drop_error_node, drop_error_code);
56 
57  n_buffers_left = n_buffers;
58  while (n_buffers_left > 0)
59  {
60  vlib_get_next_frame (vm, node, next_index, args, n_args_left);
61 
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;
65 
66  while (n_left_this_frame >= 4)
67  {
68  u32 bi0, bi1, bi2, bi3;
69  vlib_buffer_t *b0, *b1, *b2, *b3;
70 
71  args[0] = bi0 = buffers[0];
72  args[1] = bi1 = buffers[1];
73  args[2] = bi2 = buffers[2];
74  args[3] = bi3 = buffers[3];
75 
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);
80 
81  b0->error = drop_error;
82  b1->error = drop_error;
83  b2->error = drop_error;
84  b3->error = drop_error;
85 
86  buffers += 4;
87  args += 4;
88  n_left_this_frame -= 4;
89  }
90 
91  while (n_left_this_frame >= 1)
92  {
93  u32 bi0;
94  vlib_buffer_t *b0;
95 
96  args[0] = bi0 = buffers[0];
97 
98  b0 = vlib_get_buffer (vm, bi0);
99  b0->error = drop_error;
100 
101  buffers += 1;
102  args += 1;
103  n_left_this_frame -= 1;
104  }
105 
106  vlib_put_next_frame (vm, node, next_index, n_args_left);
107  }
108 
109  return n_buffers;
110 }
111 
112 /* Convenience node to drop a vector of buffers with a "misc error". */
113 static uword
115  vlib_node_runtime_t * node, vlib_frame_t * frame)
116 {
117  return vlib_error_drop_buffers (vm, node, vlib_frame_vector_args (frame),
118  /* buffer stride */ 1,
119  frame->n_vectors,
120  /* next */ 0,
121  node->node_index,
122  /* error */ 0);
123 }
124 
126  [0] = "misc. errors",
127 };
128 
129 /* *INDENT-OFF* */
131  .function = misc_drop_buffers,
132  .name = "misc-drop-buffers",
133  .vector_size = sizeof (u32),
134  .n_errors = 1,
135  .n_next_nodes = 1,
136  .next_nodes = {
137  "error-drop",
138  },
139  .error_strings = misc_drop_buffers_error_strings,
140 };
141 /* *INDENT-ON* */
142 
144  __attribute__ ((weak));
145 void
146 vlib_stats_register_error_index (u8 * notused, u64 * notused2, u64 notused3)
147 {
148 };
149 
150 void vlib_stats_pop_heap2 (void *, u32, void *) __attribute__ ((weak));
151 void
152 vlib_stats_pop_heap2 (void *notused, u32 notused2, void *notused3)
153 {
154 };
155 
156 
157 /* Reserves given number of error codes for given node. */
158 void
160  u32 node_index, u32 n_errors, char *error_strings[])
161 {
162  vlib_error_main_t *em = &vm->error_main;
163  vlib_node_t *n = vlib_get_node (vm, node_index);
164  uword l;
165  void *oldheap;
166  void *vlib_stats_push_heap (void) __attribute__ ((weak));
167 
168  ASSERT (vlib_get_thread_index () == 0);
169 
170  /* Free up any previous error strings. */
171  if (n->n_errors > 0)
173 
174  n->n_errors = n_errors;
175  n->error_strings = error_strings;
176 
177  if (n_errors == 0)
178  return;
179 
180  n->error_heap_index =
181  heap_alloc (em->error_strings_heap, n_errors, n->error_heap_handle);
182 
183  l = vec_len (em->error_strings_heap);
184 
186  error_strings, n_errors * sizeof (error_strings[0]));
187 
189 
190  /* Switch to the stats segment ... */
191  oldheap = vlib_stats_push_heap ();
192 
193  /* Allocate a counter/elog type for each error. */
194  vec_validate (em->counters, l - 1);
195 
196  /* Zero counters for re-registrations of errors. */
197  if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
200  n_errors * sizeof (em->counters[0]));
201  else
203  0, n_errors * sizeof (em->counters[0]));
204 
205  /* Register counter indices in the stat segment directory */
206  {
207  int i;
208  u8 *error_name;
209 
210  for (i = 0; i < n_errors; i++)
211  {
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);
216  }
217  }
218 
219  /* (re)register the em->counters base address, switch back to main heap */
220  vlib_stats_pop_heap2 (em->counters, vm->thread_index, oldheap);
221 
222  {
224  uword i;
225 
226  clib_memset (&t, 0, sizeof (t));
227  for (i = 0; i < n_errors; i++)
228  {
229  t.format = (char *) format (0, "%v %s: %%d",
230  n->name, error_strings[i]);
232  }
233  }
234 }
235 
236 static clib_error_t *
238  unformat_input_t * input, vlib_cli_command_t * cmd)
239 {
240  vlib_error_main_t *em = &vm->error_main;
241  vlib_node_t *n;
242  u32 code, i, ni;
243  u64 c;
244  int index = 0;
245  int verbose = 0;
246  u64 *sums = 0;
247 
248  if (unformat (input, "verbose %d", &verbose))
249  ;
250  else if (unformat (input, "verbose"))
251  verbose = 1;
252 
253  vec_validate (sums, vec_len (em->counters));
254 
255  if (verbose)
256  vlib_cli_output (vm, "%=10s%=40s%=20s%=6s", "Count", "Node", "Reason",
257  "Index");
258  else
259  vlib_cli_output (vm, "%=10s%=40s%=6s", "Count", "Node", "Reason");
260 
261 
262  /* *INDENT-OFF* */
264  em = &this_vlib_main->error_main;
265 
266  if (verbose)
267  vlib_cli_output(vm, "Thread %u (%v):", index,
268  vlib_worker_threads[index].name);
269 
270  for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
271  {
272  n = vlib_get_node (this_vlib_main, ni);
273  for (code = 0; code < n->n_errors; code++)
274  {
275  i = n->error_heap_index + code;
276  c = em->counters[i];
277  if (i < vec_len (em->counters_last_clear))
278  c -= em->counters_last_clear[i];
279  sums[i] += c;
280 
281  if (c == 0 && verbose < 2)
282  continue;
283 
284  if (verbose)
285  vlib_cli_output (vm, "%10Ld%=40v%=20s%=6d", c, n->name,
286  em->error_strings_heap[i], i);
287  else
288  vlib_cli_output (vm, "%10d%=40v%s", c, n->name,
289  em->error_strings_heap[i]);
290  }
291  }
292  index++;
293  }));
294  /* *INDENT-ON* */
295 
296  if (verbose)
297  vlib_cli_output (vm, "Total:");
298 
299  for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
300  {
301  n = vlib_get_node (vm, ni);
302  for (code = 0; code < n->n_errors; code++)
303  {
304  i = n->error_heap_index + code;
305  if (sums[i])
306  {
307  if (verbose)
308  vlib_cli_output (vm, "%10Ld%=40v%=20s%=10d", sums[i], n->name,
309  em->error_strings_heap[i], i);
310  }
311  }
312  }
313 
314  vec_free (sums);
315 
316  return 0;
317 }
318 
319 /* *INDENT-OFF* */
320 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
321  .path = "show errors",
322  .short_help = "Show error counts",
323  .function = show_errors,
324 };
325 /* *INDENT-ON* */
326 
327 /* *INDENT-OFF* */
328 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
329  .path = "show node counters",
330  .short_help = "Show node counters",
331  .function = show_errors,
332 };
333 /* *INDENT-ON* */
334 
335 static clib_error_t *
337  unformat_input_t * input, vlib_cli_command_t * cmd)
338 {
339  vlib_error_main_t *em;
340  u32 i;
341 
342  /* *INDENT-OFF* */
344  em = &this_vlib_main->error_main;
346  for (i = 0; i < vec_len (em->counters); i++)
347  em->counters_last_clear[i] = em->counters[i];
348  }));
349  /* *INDENT-ON* */
350  return 0;
351 }
352 
353 /* *INDENT-OFF* */
354 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
355  .path = "clear errors",
356  .short_help = "Clear error counters",
357  .function = clear_error_counters,
358 };
359 /* *INDENT-ON* */
360 
361 /* *INDENT-OFF* */
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,
366 };
367 /* *INDENT-ON* */
368 
369 /*
370  * fd.io coding-style-patch-verification: ON
371  *
372  * Local Variables:
373  * eval: (c-set-style "gnu")
374  * End:
375  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:439
u32 error_heap_index
Definition: node.h:348
#define clib_min(x, y)
Definition: clib.h:295
void vlib_stats_register_error_index(u8 *, u64 *, u64)
Definition: error.c:146
unsigned long u64
Definition: types.h:89
static clib_error_t * show_errors(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: error.c:237
u32 thread_index
Definition: main.h:179
char ** error_strings
Definition: node.h:351
u16 vlib_error_t
Definition: error.h:44
int i
clib_memset(h->entries, 0, sizeof(h->entries[0])*entries)
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
char * format
Format string.
Definition: elog.h:91
unsigned char u8
Definition: types.h:56
#define clib_memcpy(d, s, n)
Definition: string.h:180
void vlib_register_errors(vlib_main_t *vm, u32 node_index, u32 n_errors, char *error_strings[])
Definition: error.c:159
u64 * counters_last_clear
Definition: error.h:81
void vlib_stats_pop_heap2(void *, u32, void *)
Definition: error.c:152
static vlib_node_registration_t misc_drop_buffers_node
(constructor) VLIB_REGISTER_NODE (misc_drop_buffers_node)
Definition: error.c:130
vlib_node_t ** nodes
Definition: node.h:722
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
elog_event_type_t * error_elog_event_types
Definition: main.h:167
unsigned int u32
Definition: types.h:88
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:36
u32 error_heap_handle
Definition: node.h:347
static vlib_error_t vlib_error_set(u32 node_index, u32 code)
Definition: error.h:59
vlib_error_main_t error_main
Definition: main.h:143
uword vlib_error_drop_buffers(vlib_main_t *vm, vlib_node_runtime_t *node, u32 *buffers, u32 next_buffer_stride, u32 n_buffers, u32 next_index, u32 drop_error_node, u32 drop_error_code)
Definition: error.c:44
struct _unformat_input_t unformat_input_t
u32 node_index
Node index.
Definition: node.h:519
#define foreach_vlib_main(body)
Definition: threads.h:235
#define vlib_get_next_frame(vm, node, next_index, vectors, n_vectors_left)
Get pointer to next frame vector data by (vlib_node_runtime_t, next_index).
Definition: node_funcs.h:368
u8 name[64]
Definition: memclnt.api:152
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:139
void * vlib_stats_push_heap(void)
Definition: counter.c:79
u8 * name
Definition: node.h:288
u64 * counters
Definition: error.h:78
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:169
char ** error_strings_heap
Definition: error.h:85
svmdb_client_t * c
u16 n_vectors
Definition: node.h:420
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:212
vlib_main_t * vm
Definition: buffer.c:301
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
static uword misc_drop_buffers(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: error.c:114
void vlib_put_next_frame(vlib_main_t *vm, vlib_node_runtime_t *r, u32 next_index, u32 n_vectors_left)
Release pointer to next frame vector data.
Definition: main.c:459
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:155
#define ASSERT(truth)
void heap_dealloc(void *v, uword handle)
Definition: heap.c:496
#define heap_alloc(v, size, handle)
Definition: heap.h:337
static clib_error_t * clear_error_counters(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: error.c:336
static char * misc_drop_buffers_error_strings[]
Definition: error.c:125
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vlib_node_main_t node_main
Definition: main.h:129
u64 uword
Definition: types.h:112
static void * vlib_frame_vector_args(vlib_frame_t *f)
Get pointer to frame vector data.
Definition: node_funcs.h:274
u16 n_errors
Definition: node.h:341
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:725
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:62
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972