src/vlib/error.c

   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 #include <vlib/stats/stats.h>
  43
  44 uword
  45 vlib_error_drop_buffers (vlib_main_t * vm,
  46                          vlib_node_runtime_t * node,
  47                          u32 * buffers,
  48                          u32 next_buffer_stride,
  49                          u32 n_buffers,
  50                          u32 next_index,
  51                          u32 drop_error_node, u32 drop_error_code)
  52 {
  53   u32 n_left_this_frame, n_buffers_left, *args, n_args_left;
  54   vlib_error_t drop_error;
  55   vlib_node_t *n;
  56
  57   n = vlib_get_node (vm, drop_error_node);
  58   drop_error = n->error_heap_index + drop_error_code;
  59
  60   n_buffers_left = n_buffers;
  61   while (n_buffers_left > 0)
  62     {
  63       vlib_get_next_frame (vm, node, next_index, args, n_args_left);
  64
  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;
  68
  69       while (n_left_this_frame >= 4)
  70         {
  71           u32 bi0, bi1, bi2, bi3;
  72           vlib_buffer_t *b0, *b1, *b2, *b3;
  73
  74           args[0] = bi0 = buffers[0];
  75           args[1] = bi1 = buffers[1];
  76           args[2] = bi2 = buffers[2];
  77           args[3] = bi3 = buffers[3];
  78
  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);
  83
  84           b0->error = drop_error;
  85           b1->error = drop_error;
  86           b2->error = drop_error;
  87           b3->error = drop_error;
  88
  89           buffers += 4;
  90           args += 4;
  91           n_left_this_frame -= 4;
  92         }
  93
  94       while (n_left_this_frame >= 1)
  95         {
  96           u32 bi0;
  97           vlib_buffer_t *b0;
  98
  99           args[0] = bi0 = buffers[0];
 100
 101           b0 = vlib_get_buffer (vm, bi0);
 102           b0->error = drop_error;
 103
 104           buffers += 1;
 105           args += 1;
 106           n_left_this_frame -= 1;
 107         }
 108
 109       vlib_put_next_frame (vm, node, next_index, n_args_left);
 110     }
 111
 112   return n_buffers;
 113 }
 114
 115 static u8 *
 116 format_stats_counter_name (u8 *s, va_list *va)
 117 {
 118   u8 *id = va_arg (*va, u8 *);
 119
 120   for (u32 i = 0; id[i] != 0; i++)
 121     vec_add1 (s, id[i] == ' ' ? ' ' : id[i]);
 122
 123   return s;
 124 }
 125
 126 /* Reserves given number of error codes for given node. */
 127 void
 128 vlib_register_errors (vlib_main_t *vm, u32 node_index, u32 n_errors,
 129                       char *error_strings[], vlib_error_desc_t counters[])
 130 {
 131   vlib_error_main_t *em = &vm->error_main;
 132   vlib_node_main_t *nm = &vm->node_main;
 133   vlib_node_t *n = vlib_get_node (vm, node_index);
 134   vlib_error_desc_t *cd;
 135   u32 n_threads = vlib_get_n_threads ();
 136   elog_event_type_t t = {};
 137   uword l;
 138   u64 **sc;
 139
 140   ASSERT (vlib_get_thread_index () == 0);
 141
 142   vlib_stats_segment_lock ();
 143
 144   /* Free up any previous error strings. */
 145   if (n->n_errors > 0)
 146     {
 147       cd = vec_elt_at_index (em->counters_heap, n->error_heap_index);
 148       for (u32 i = 0; i < n->n_errors; i++)
 149         vlib_stats_remove_entry (cd[i].stats_entry_index);
 150       heap_dealloc (em->counters_heap, n->error_heap_handle);
 151     }
 152
 153   n->n_errors = n_errors;
 154   n->error_counters = counters;
 155
 156   if (n_errors == 0)
 157     goto done;
 158
 159   n->error_heap_index =
 160     heap_alloc (em->counters_heap, n_errors, n->error_heap_handle);
 161   l = vec_len (em->counters_heap);
 162   cd = vec_elt_at_index (em->counters_heap, n->error_heap_index);
 163
 164   /*  Legacy node */
 165   if (!counters)
 166     {
 167       for (int i = 0; i < n_errors; i++)
 168         {
 169           cd[i].name = error_strings[i];
 170           cd[i].desc = error_strings[i];
 171           cd[i].severity = VL_COUNTER_SEVERITY_ERROR;
 172         }
 173     }
 174   else
 175     clib_memcpy (cd, counters, n_errors * sizeof (counters[0]));
 176
 177   vec_validate (vm->error_elog_event_types, l - 1);
 178
 179   if (em->stats_err_entry_index == 0)
 180     em->stats_err_entry_index = vlib_stats_add_counter_vector ("/node/errors");
 181
 182   ASSERT (em->stats_err_entry_index != 0 && em->stats_err_entry_index != ~0);
 183
 184   vlib_stats_validate (em->stats_err_entry_index, n_threads - 1, l - 1);
 185   sc = vlib_stats_get_entry_data_pointer (em->stats_err_entry_index);
 186
 187   for (int i = 0; i < n_threads; i++)
 188     {
 189       vlib_main_t *tvm = vlib_get_main_by_index (i);
 190       vlib_error_main_t *tem = &tvm->error_main;
 191       tem->counters = sc[i];
 192
 193       /* Zero counters for re-registrations of errors. */
 194       if (n->error_heap_index + n_errors <= vec_len (tem->counters_last_clear))
 195         clib_memcpy (tem->counters + n->error_heap_index,
 196                      tem->counters_last_clear + n->error_heap_index,
 197                      n_errors * sizeof (tem->counters[0]));
 198       else
 199         clib_memset (tem->counters + n->error_heap_index, 0,
 200                      n_errors * sizeof (tem->counters[0]));
 201     }
 202
 203   /* Register counter indices in the stat segment directory */
 204   for (int i = 0; i < n_errors; i++)
 205     cd[i].stats_entry_index = vlib_stats_add_symlink (
 206       em->stats_err_entry_index, n->error_heap_index + i, "/err/%v/%U",
 207       n->name, format_stats_counter_name, cd[i].name);
 208
 209   vec_validate (nm->node_by_error, n->error_heap_index + n_errors - 1);
 210
 211   for (u32 i = 0; i < n_errors; i++)
 212     {
 213       t.format = (char *) format (0, "%v %s: %%d", n->name, cd[i].name);
 214       vm->error_elog_event_types[n->error_heap_index + i] = t;
 215       nm->node_by_error[n->error_heap_index + i] = n->index;
 216     }
 217
 218 done:
 219   vlib_stats_segment_unlock ();
 220 }
 221
 222 uword
 223 unformat_vlib_error (unformat_input_t *input, va_list *args)
 224 {
 225   vlib_main_t *vm = va_arg (*args, vlib_main_t *);
 226   const vlib_error_main_t *em = &vm->error_main;
 227   vlib_error_t *error_index = va_arg (*args, vlib_error_t *);
 228   const vlib_node_t *node;
 229   char *error_name;
 230   u32 node_index;
 231   vlib_error_t i;
 232
 233   if (!unformat (input, "%U.%s", unformat_vlib_node, vm, &node_index,
 234                  &error_name))
 235     return 0;
 236
 237   node = vlib_get_node (vm, node_index);
 238   for (i = 0; i < node->n_errors; i++)
 239     {
 240       vlib_error_t ei = node->error_heap_index + i;
 241       if (strcmp (em->counters_heap[ei].name, error_name) == 0)
 242         {
 243           *error_index = ei;
 244           vec_free (error_name);
 245           return 1;
 246         }
 247     }
 248
 249   vec_free (error_name);
 250   return 0;
 251 }
 252
 253 static char *
 254 sev2str (enum vl_counter_severity_e s)
 255 {
 256   switch (s)
 257     {
 258     case VL_COUNTER_SEVERITY_ERROR:
 259       return "error";
 260     case VL_COUNTER_SEVERITY_WARN:
 261       return "warn";
 262     case VL_COUNTER_SEVERITY_INFO:
 263       return "info";
 264     default:
 265       return "unknown";
 266     }
 267 }
 268
 269 static clib_error_t *
 270 show_errors (vlib_main_t * vm,
 271              unformat_input_t * input, vlib_cli_command_t * cmd)
 272 {
 273   vlib_error_main_t *em = &vm->error_main;
 274   vlib_node_t *n;
 275   u32 code, i, ni;
 276   u64 c;
 277   int index = 0;
 278   int verbose = 0;
 279   u64 *sums = 0;
 280
 281   if (unformat (input, "verbose %d", &verbose))
 282     ;
 283   else if (unformat (input, "verbose"))
 284     verbose = 1;
 285
 286   vec_validate (sums, vec_len (em->counters));
 287
 288   if (verbose)
 289     vlib_cli_output (vm, "%=10s%=35s%=35s%=10s%=6s", "Count", "Node",
 290                      "Reason", "Severity", "Index");
 291   else
 292     vlib_cli_output (vm, "%=10s%=35s%=35s%=10s", "Count", "Node", "Reason",
 293                      "Severity");
 294
 295   foreach_vlib_main ()
 296     {
 297       em = &this_vlib_main->error_main;
 298
 299       if (verbose)
 300         vlib_cli_output (vm, "Thread %u (%v):", index,
 301                          vlib_worker_threads[index].name);
 302
 303       for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
 304         {
 305           n = vlib_get_node (this_vlib_main, ni);
 306           for (code = 0; code < n->n_errors; code++)
 307             {
 308               i = n->error_heap_index + code;
 309               c = em->counters[i];
 310               if (i < vec_len (em->counters_last_clear))
 311                 c -= em->counters_last_clear[i];
 312               sums[i] += c;
 313
 314               if (c == 0 && verbose < 2)
 315                 continue;
 316
 317               if (verbose)
 318                 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s%=6d", c, n->name,
 319                                  em->counters_heap[i].desc,
 320                                  sev2str (em->counters_heap[i].severity), i);
 321               else
 322                 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s", c, n->name,
 323                                  em->counters_heap[i].desc,
 324                                  sev2str (em->counters_heap[i].severity));
 325             }
 326         }
 327       index++;
 328     }
 329
 330   if (verbose)
 331     vlib_cli_output (vm, "Total:");
 332
 333   for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
 334     {
 335       n = vlib_get_node (vm, ni);
 336       for (code = 0; code < n->n_errors; code++)
 337         {
 338           i = n->error_heap_index + code;
 339           if (sums[i])
 340             {
 341               if (verbose)
 342                 vlib_cli_output (vm, "%10lu%=40v%=20s%=10d", sums[i], n->name,
 343                                  em->counters_heap[i].desc, i);
 344             }
 345         }
 346     }
 347
 348   vec_free (sums);
 349
 350   return 0;
 351 }
 352
 353 /* *INDENT-OFF* */
 354 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
 355   .path = "show errors",
 356   .short_help = "Show error counts",
 357   .function = show_errors,
 358 };
 359 /* *INDENT-ON* */
 360
 361 /* *INDENT-OFF* */
 362 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
 363   .path = "show node counters",
 364   .short_help = "Show node counters",
 365   .function = show_errors,
 366 };
 367 /* *INDENT-ON* */
 368
 369 static clib_error_t *
 370 clear_error_counters (vlib_main_t * vm,
 371                       unformat_input_t * input, vlib_cli_command_t * cmd)
 372 {
 373   vlib_error_main_t *em;
 374   u32 i;
 375
 376   foreach_vlib_main ()
 377     {
 378       em = &this_vlib_main->error_main;
 379       vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
 380       for (i = 0; i < vec_len (em->counters); i++)
 381         em->counters_last_clear[i] = em->counters[i];
 382     }
 383   return 0;
 384 }
 385
 386 /* *INDENT-OFF* */
 387 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
 388   .path = "clear errors",
 389   .short_help = "Clear error counters",
 390   .function = clear_error_counters,
 391 };
 392 /* *INDENT-ON* */
 393
 394 /* *INDENT-OFF* */
 395 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
 396   .path = "clear node counters",
 397   .short_help = "Clear node counters",
 398   .function = clear_error_counters,
 399 };
 400 /* *INDENT-ON* */
 401
 402 /*
 403  * fd.io coding-style-patch-verification: ON
 404  *
 405  * Local Variables:
 406  * eval: (c-set-style "gnu")
 407  * End:
 408  */