FD.io VPP  v18.04-17-g3a0d853
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_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 
143 /* Reserves given number of error codes for given node. */
144 void
146  u32 node_index, u32 n_errors, char *error_strings[])
147 {
148  vlib_error_main_t *em = &vm->error_main;
149  vlib_node_t *n = vlib_get_node (vm, node_index);
150  uword l;
151 
152  ASSERT (vlib_get_thread_index () == 0);
153 
154  /* Free up any previous error strings. */
155  if (n->n_errors > 0)
157 
158  n->n_errors = n_errors;
159  n->error_strings = error_strings;
160 
161  if (n_errors == 0)
162  return;
163 
164  n->error_heap_index =
165  heap_alloc (em->error_strings_heap, n_errors, n->error_heap_handle);
166 
167  l = vec_len (em->error_strings_heap);
168 
170  error_strings, n_errors * sizeof (error_strings[0]));
171 
172  /* Allocate a counter/elog type for each error. */
173  vec_validate (em->counters, l - 1);
175 
176  /* Zero counters for re-registrations of errors. */
177  if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
180  n_errors * sizeof (em->counters[0]));
181  else
182  memset (em->counters + n->error_heap_index,
183  0, n_errors * sizeof (em->counters[0]));
184 
185  {
187  uword i;
188 
189  memset (&t, 0, sizeof (t));
190  for (i = 0; i < n_errors; i++)
191  {
192  t.format = (char *) format (0, "%v %s: %%d",
193  n->name, error_strings[i]);
195  }
196  }
197 }
198 
199 static clib_error_t *
201  unformat_input_t * input, vlib_cli_command_t * cmd)
202 {
203  vlib_error_main_t *em = &vm->error_main;
204  vlib_node_t *n;
205  u32 code, i, ni;
206  u64 c;
207  int index = 0;
208  int verbose = 0;
209  u64 *sums = 0;
210 
211  if (unformat (input, "verbose %d", &verbose))
212  ;
213  else if (unformat (input, "verbose"))
214  verbose = 1;
215 
216  vec_validate (sums, vec_len (em->counters));
217 
218  if (verbose)
219  vlib_cli_output (vm, "%=10s%=40s%=20s%=6s", "Count", "Node", "Reason",
220  "Index");
221  else
222  vlib_cli_output (vm, "%=10s%=40s%=6s", "Count", "Node", "Reason");
223 
224 
225  /* *INDENT-OFF* */
227  em = &this_vlib_main->error_main;
228 
229  if (verbose)
230  vlib_cli_output(vm, "Thread %u (%v):", index,
231  vlib_worker_threads[index].name);
232 
233  for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
234  {
235  n = vlib_get_node (this_vlib_main, ni);
236  for (code = 0; code < n->n_errors; code++)
237  {
238  i = n->error_heap_index + code;
239  c = em->counters[i];
240  if (i < vec_len (em->counters_last_clear))
241  c -= em->counters_last_clear[i];
242  sums[i] += c;
243 
244  if (c == 0 && verbose < 2)
245  continue;
246 
247  if (verbose)
248  vlib_cli_output (vm, "%10Ld%=40v%=20s%=6d", c, n->name,
249  em->error_strings_heap[i], i);
250  else
251  vlib_cli_output (vm, "%10d%=40v%s", c, n->name,
252  em->error_strings_heap[i]);
253  }
254  }
255  index++;
256  }));
257  /* *INDENT-ON* */
258 
259  if (verbose)
260  vlib_cli_output (vm, "Total:");
261 
262  for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
263  {
264  n = vlib_get_node (vm, ni);
265  for (code = 0; code < n->n_errors; code++)
266  {
267  i = n->error_heap_index + code;
268  if (sums[i])
269  {
270  if (verbose)
271  vlib_cli_output (vm, "%10Ld%=40v%=20s%=10d", sums[i], n->name,
272  em->error_strings_heap[i], i);
273  }
274  }
275  }
276 
277  vec_free (sums);
278 
279  return 0;
280 }
281 
282 /* *INDENT-OFF* */
283 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
284  .path = "show errors",
285  .short_help = "Show error counts",
286  .function = show_errors,
287 };
288 /* *INDENT-ON* */
289 
290 /* *INDENT-OFF* */
291 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
292  .path = "show node counters",
293  .short_help = "Show node counters",
294  .function = show_errors,
295 };
296 /* *INDENT-ON* */
297 
298 static clib_error_t *
300  unformat_input_t * input, vlib_cli_command_t * cmd)
301 {
302  vlib_error_main_t *em;
303  u32 i;
304 
305  /* *INDENT-OFF* */
307  em = &this_vlib_main->error_main;
309  for (i = 0; i < vec_len (em->counters); i++)
310  em->counters_last_clear[i] = em->counters[i];
311  }));
312  /* *INDENT-ON* */
313  return 0;
314 }
315 
316 /* *INDENT-OFF* */
317 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
318  .path = "clear errors",
319  .short_help = "Clear error counters",
320  .function = clear_error_counters,
321 };
322 /* *INDENT-ON* */
323 
324 /* *INDENT-OFF* */
325 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
326  .path = "clear node counters",
327  .short_help = "Clear node counters",
328  .function = clear_error_counters,
329 };
330 /* *INDENT-ON* */
331 
332 /*
333  * fd.io coding-style-patch-verification: ON
334  *
335  * Local Variables:
336  * eval: (c-set-style "gnu")
337  * End:
338  */
#define vec_validate(V, I)
Make sure vector is long enough for given index (no header, unspecified alignment) ...
Definition: vec.h:434
u32 error_heap_index
Definition: node.h:278
#define clib_min(x, y)
Definition: clib.h:340
static clib_error_t * show_errors(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: error.c:200
char ** error_strings
Definition: node.h:281
int i
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:419
char * format
Format string.
Definition: elog.h:91
void vlib_register_errors(vlib_main_t *vm, u32 node_index, u32 n_errors, char *error_strings[])
Definition: error.c:145
u64 * counters_last_clear
Definition: error.h:81
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:640
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
unsigned long u64
Definition: types.h:89
elog_event_type_t * error_elog_event_types
Definition: main.h:164
vlib_worker_thread_t * vlib_worker_threads
Definition: threads.c:35
u32 error_heap_handle
Definition: node.h:277
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:141
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 vlib_error_t
Definition: error.h:44
u32 node_index
Node index.
Definition: node.h:437
#define foreach_vlib_main(body)
Definition: threads.h:244
#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:364
vlib_error_t error
Error code for buffers to be enqueued to error handler.
Definition: buffer.h:130
u8 * name
Definition: node.h:221
u64 * counters
Definition: error.h:78
#define VLIB_REGISTER_NODE(x,...)
Definition: node.h:143
char ** error_strings_heap
Definition: error.h:85
svmdb_client_t * c
u16 n_vectors
Definition: node.h:344
static_always_inline uword vlib_get_thread_index(void)
Definition: threads.h:221
vlib_main_t * vm
Definition: buffer.c:294
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:336
static uword misc_drop_buffers(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
Definition: error.c:114
#define clib_memcpy(a, b, c)
Definition: string.h:75
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:454
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:154
#define ASSERT(truth)
unsigned int u32
Definition: types.h:88
void heap_dealloc(void *v, uword handle)
Definition: heap.c:496
static void * vlib_frame_args(vlib_frame_t *f)
Get pointer to frame scalar data.
Definition: node_funcs.h:284
#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:299
static char * misc_drop_buffers_error_strings[]
Definition: error.c:125
u64 uword
Definition: types.h:112
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
vlib_node_main_t node_main
Definition: main.h:132
u16 n_errors
Definition: node.h:271
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:680
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:57
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:972