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 void
 127 vlib_unregister_errors (vlib_main_t *vm, u32 node_index)
 128 {
 129   vlib_error_main_t *em = &vm->error_main;
 130   vlib_node_t *n = vlib_get_node (vm, node_index);
 131   vlib_error_desc_t *cd;
 132
 133   if (n->n_errors > 0)
 134     {
 135       cd = vec_elt_at_index (em->counters_heap, n->error_heap_index);
 136       for (u32 i = 0; i < n->n_errors; i++)
 137         vlib_stats_remove_entry (cd[i].stats_entry_index);
 138       heap_dealloc (em->counters_heap, n->error_heap_handle);
 139       n->n_errors = 0;
 140     }
 141 }
 142
 143 /* Reserves given number of error codes for given node. */
 144 void
 145 vlib_register_errors (vlib_main_t *vm, u32 node_index, u32 n_errors,
 146                       char *error_strings[], vlib_error_desc_t counters[])
 147 {
 148   vlib_error_main_t *em = &vm->error_main;
 149   vlib_node_main_t *nm = &vm->node_main;
 150   vlib_node_t *n = vlib_get_node (vm, node_index);
 151   vlib_error_desc_t *cd;
 152   u32 n_threads = vlib_get_n_threads ();
 153   elog_event_type_t t = {};
 154   uword l;
 155   u64 **sc;
 156
 157   ASSERT (vlib_get_thread_index () == 0);
 158
 159   vlib_stats_segment_lock ();
 160
 161   /* Free up any previous error strings. */
 162   vlib_unregister_errors (vm, node_index);
 163
 164   n->n_errors = n_errors;
 165   n->error_counters = counters;
 166
 167   if (n_errors == 0)
 168     goto done;
 169
 170   n->error_heap_index =
 171     heap_alloc (em->counters_heap, n_errors, n->error_heap_handle);
 172   l = vec_len (em->counters_heap);
 173   cd = vec_elt_at_index (em->counters_heap, n->error_heap_index);
 174
 175   /*  Legacy node */
 176   if (!counters)
 177     {
 178       for (int i = 0; i < n_errors; i++)
 179         {
 180           cd[i].name = error_strings[i];
 181           cd[i].desc = error_strings[i];
 182           cd[i].severity = VL_COUNTER_SEVERITY_ERROR;
 183         }
 184     }
 185   else
 186     clib_memcpy (cd, counters, n_errors * sizeof (counters[0]));
 187
 188   vec_validate (vm->error_elog_event_types, l - 1);
 189
 190   if (em->stats_err_entry_index == 0)
 191     em->stats_err_entry_index = vlib_stats_add_counter_vector ("/node/errors");
 192
 193   ASSERT (em->stats_err_entry_index != 0 && em->stats_err_entry_index != ~0);
 194
 195   vlib_stats_validate (em->stats_err_entry_index, n_threads - 1, l - 1);
 196   sc = vlib_stats_get_entry_data_pointer (em->stats_err_entry_index);
 197
 198   for (int i = 0; i < n_threads; i++)
 199     {
 200       vlib_main_t *tvm = vlib_get_main_by_index (i);
 201       vlib_error_main_t *tem = &tvm->error_main;
 202       tem->counters = sc[i];
 203
 204       /* Zero counters for re-registrations of errors. */
 205       if (n->error_heap_index + n_errors <= vec_len (tem->counters_last_clear))
 206         clib_memcpy (tem->counters + n->error_heap_index,
 207                      tem->counters_last_clear + n->error_heap_index,
 208                      n_errors * sizeof (tem->counters[0]));
 209       else
 210         clib_memset (tem->counters + n->error_heap_index, 0,
 211                      n_errors * sizeof (tem->counters[0]));
 212     }
 213
 214   /* Register counter indices in the stat segment directory */
 215   for (int i = 0; i < n_errors; i++)
 216     cd[i].stats_entry_index = vlib_stats_add_symlink (
 217       em->stats_err_entry_index, n->error_heap_index + i, "/err/%v/%U",
 218       n->name, format_stats_counter_name, cd[i].name);
 219
 220   vec_validate (nm->node_by_error, n->error_heap_index + n_errors - 1);
 221
 222   for (u32 i = 0; i < n_errors; i++)
 223     {
 224       t.format = (char *) format (0, "%v %s: %%d", n->name, cd[i].name);
 225       vm->error_elog_event_types[n->error_heap_index + i] = t;
 226       nm->node_by_error[n->error_heap_index + i] = n->index;
 227     }
 228
 229 done:
 230   vlib_stats_segment_unlock ();
 231 }
 232
 233 uword
 234 unformat_vlib_error (unformat_input_t *input, va_list *args)
 235 {
 236   vlib_main_t *vm = va_arg (*args, vlib_main_t *);
 237   const vlib_error_main_t *em = &vm->error_main;
 238   vlib_error_t *error_index = va_arg (*args, vlib_error_t *);
 239   const vlib_node_t *node;
 240   char *error_name;
 241   u32 node_index;
 242   vlib_error_t i;
 243
 244   if (!unformat (input, "%U.%s", unformat_vlib_node, vm, &node_index,
 245                  &error_name))
 246     return 0;
 247
 248   node = vlib_get_node (vm, node_index);
 249   for (i = 0; i < node->n_errors; i++)
 250     {
 251       vlib_error_t ei = node->error_heap_index + i;
 252       if (strcmp (em->counters_heap[ei].name, error_name) == 0)
 253         {
 254           *error_index = ei;
 255           vec_free (error_name);
 256           return 1;
 257         }
 258     }
 259
 260   vec_free (error_name);
 261   return 0;
 262 }
 263
 264 static char *
 265 sev2str (enum vl_counter_severity_e s)
 266 {
 267   switch (s)
 268     {
 269     case VL_COUNTER_SEVERITY_ERROR:
 270       return "error";
 271     case VL_COUNTER_SEVERITY_WARN:
 272       return "warn";
 273     case VL_COUNTER_SEVERITY_INFO:
 274       return "info";
 275     default:
 276       return "unknown";
 277     }
 278 }
 279
 280 static clib_error_t *
 281 show_errors (vlib_main_t * vm,
 282              unformat_input_t * input, vlib_cli_command_t * cmd)
 283 {
 284   vlib_error_main_t *em = &vm->error_main;
 285   vlib_node_t *n;
 286   u32 code, i, ni;
 287   u64 c;
 288   int index = 0;
 289   int verbose = 0;
 290   u64 *sums = 0;
 291
 292   if (unformat (input, "verbose %d", &verbose))
 293     ;
 294   else if (unformat (input, "verbose"))
 295     verbose = 1;
 296
 297   vec_validate (sums, vec_len (em->counters));
 298
 299   if (verbose)
 300     vlib_cli_output (vm, "%=10s%=35s%=35s%=10s%=6s", "Count", "Node",
 301                      "Reason", "Severity", "Index");
 302   else
 303     vlib_cli_output (vm, "%=10s%=35s%=35s%=10s", "Count", "Node", "Reason",
 304                      "Severity");
 305
 306   foreach_vlib_main ()
 307     {
 308       em = &this_vlib_main->error_main;
 309
 310       if (verbose)
 311         vlib_cli_output (vm, "Thread %u (%v):", index,
 312                          vlib_worker_threads[index].name);
 313
 314       for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
 315         {
 316           n = vlib_get_node (this_vlib_main, ni);
 317           for (code = 0; code < n->n_errors; code++)
 318             {
 319               i = n->error_heap_index + code;
 320               c = em->counters[i];
 321               if (i < vec_len (em->counters_last_clear))
 322                 c -= em->counters_last_clear[i];
 323               sums[i] += c;
 324
 325               if (c == 0 && verbose < 2)
 326                 continue;
 327
 328               if (verbose)
 329                 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s%=6d", c, n->name,
 330                                  em->counters_heap[i].desc,
 331                                  sev2str (em->counters_heap[i].severity), i);
 332               else
 333                 vlib_cli_output (vm, "%10lu%=35v%=35s%=10s", c, n->name,
 334                                  em->counters_heap[i].desc,
 335                                  sev2str (em->counters_heap[i].severity));
 336             }
 337         }
 338       index++;
 339     }
 340
 341   if (verbose)
 342     vlib_cli_output (vm, "Total:");
 343
 344   for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
 345     {
 346       n = vlib_get_node (vm, ni);
 347       for (code = 0; code < n->n_errors; code++)
 348         {
 349           i = n->error_heap_index + code;
 350           if (sums[i])
 351             {
 352               if (verbose)
 353                 vlib_cli_output (vm, "%10lu%=40v%=20s%=10d", sums[i], n->name,
 354                                  em->counters_heap[i].desc, i);
 355             }
 356         }
 357     }
 358
 359   vec_free (sums);
 360
 361   return 0;
 362 }
 363
 364 /* *INDENT-OFF* */
 365 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
 366   .path = "show errors",
 367   .short_help = "Show error counts",
 368   .function = show_errors,
 369 };
 370 /* *INDENT-ON* */
 371
 372 /* *INDENT-OFF* */
 373 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
 374   .path = "show node counters",
 375   .short_help = "Show node counters",
 376   .function = show_errors,
 377 };
 378 /* *INDENT-ON* */
 379
 380 static clib_error_t *
 381 clear_error_counters (vlib_main_t * vm,
 382                       unformat_input_t * input, vlib_cli_command_t * cmd)
 383 {
 384   vlib_error_main_t *em;
 385   u32 i;
 386
 387   foreach_vlib_main ()
 388     {
 389       em = &this_vlib_main->error_main;
 390       vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
 391       for (i = 0; i < vec_len (em->counters); i++)
 392         em->counters_last_clear[i] = em->counters[i];
 393     }
 394   return 0;
 395 }
 396
 397 /* *INDENT-OFF* */
 398 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
 399   .path = "clear errors",
 400   .short_help = "Clear error counters",
 401   .function = clear_error_counters,
 402 };
 403 /* *INDENT-ON* */
 404
 405 /* *INDENT-OFF* */
 406 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
 407   .path = "clear node counters",
 408   .short_help = "Clear node counters",
 409   .function = clear_error_counters,
 410 };
 411 /* *INDENT-ON* */
 412
 413 /*
 414  * fd.io coding-style-patch-verification: ON
 415  *
 416  * Local Variables:
 417  * eval: (c-set-style "gnu")
 418  * End:
 419  */