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/stat_weak_inlines.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 /* Reserves given number of error codes for given node. */
 116 void
 117 vlib_register_errors (vlib_main_t * vm,
 118                       u32 node_index, u32 n_errors, char *error_strings[],
 119                       vl_counter_t counters[])
 120 {
 121   vlib_error_main_t *em = &vm->error_main;
 122   vlib_node_main_t *nm = &vm->node_main;
 123
 124   vlib_node_t *n = vlib_get_node (vm, node_index);
 125   uword l;
 126   void *oldheap;
 127
 128   ASSERT (vlib_get_thread_index () == 0);
 129
 130   /* Free up any previous error strings. */
 131   if (n->n_errors > 0)
 132     heap_dealloc (em->counters_heap, n->error_heap_handle);
 133
 134   if (n_errors == 0)
 135     return;
 136
 137   n->n_errors = n_errors;
 138
 139   /*  Legacy node */
 140   if (!counters)
 141     {
 142       counters = clib_mem_alloc (sizeof (counters[0]) * n_errors);
 143       int i;
 144       for (i = 0; i < n_errors; i++)
 145         {
 146           counters[i].name = error_strings[i];  // XXX Make name saner
 147           counters[i].desc = error_strings[i];
 148           counters[i].severity = VL_COUNTER_SEVERITY_ERROR;
 149         }
 150     }
 151
 152   n->error_counters = counters;
 153
 154   n->error_heap_index =
 155     heap_alloc (em->counters_heap, n_errors, n->error_heap_handle);
 156   l = vec_len (em->counters_heap);
 157   clib_memcpy (vec_elt_at_index (em->counters_heap, n->error_heap_index),
 158                counters, n_errors * sizeof (counters[0]));
 159
 160   vec_validate (vm->error_elog_event_types, l - 1);
 161
 162   /* Switch to the stats segment ... */
 163   oldheap = vlib_stats_push_heap (0);
 164
 165   /* Allocate a counter/elog type for each error. */
 166   vec_validate (em->counters, l - 1);
 167
 168   /* Zero counters for re-registrations of errors. */
 169   if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
 170     clib_memcpy (em->counters + n->error_heap_index,
 171                  em->counters_last_clear + n->error_heap_index,
 172                  n_errors * sizeof (em->counters[0]));
 173   else
 174     clib_memset (em->counters + n->error_heap_index,
 175                  0, n_errors * sizeof (em->counters[0]));
 176
 177   /* Register counter indices in the stat segment directory */
 178   {
 179     int i;
 180     u8 *error_name = 0;
 181
 182     for (i = 0; i < n_errors; i++)
 183       {
 184         vec_reset_length (error_name);
 185         error_name =
 186           format (error_name, "/err/%v/%s%c", n->name, counters[i].name, 0);
 187         vlib_stats_register_error_index (oldheap, error_name, em->counters,
 188                                          n->error_heap_index + i);
 189       }
 190
 191     vec_free (error_name);
 192   }
 193
 194   /* (re)register the em->counters base address, switch back to main heap */
 195   vlib_stats_pop_heap2 (em->counters, vm->thread_index, oldheap, 1);
 196
 197   {
 198     elog_event_type_t t;
 199     uword i;
 200
 201     clib_memset (&t, 0, sizeof (t));
 202     if (n_errors > 0)
 203       vec_validate (nm->node_by_error, n->error_heap_index + n_errors - 1);
 204     for (i = 0; i < n_errors; i++)
 205       {
 206         t.format = (char *) format (0, "%v %s: %%d",
 207                                     n->name, counters[i].name);
 208         vm->error_elog_event_types[n->error_heap_index + i] = t;
 209         nm->node_by_error[n->error_heap_index + i] = n->index;
 210       }
 211   }
 212 }
 213
 214 static char *
 215 sev2str (enum vl_counter_severity_e s)
 216 {
 217   switch (s)
 218     {
 219     case VL_COUNTER_SEVERITY_ERROR:
 220       return "error";
 221     case VL_COUNTER_SEVERITY_WARN:
 222       return "warn";
 223     case VL_COUNTER_SEVERITY_INFO:
 224       return "info";
 225     default:
 226       return "unknown";
 227     }
 228 }
 229
 230 static clib_error_t *
 231 show_errors (vlib_main_t * vm,
 232              unformat_input_t * input, vlib_cli_command_t * cmd)
 233 {
 234   vlib_error_main_t *em = &vm->error_main;
 235   vlib_node_t *n;
 236   u32 code, i, ni;
 237   u64 c;
 238   int index = 0;
 239   int verbose = 0;
 240   u64 *sums = 0;
 241
 242   if (unformat (input, "verbose %d", &verbose))
 243     ;
 244   else if (unformat (input, "verbose"))
 245     verbose = 1;
 246
 247   vec_validate (sums, vec_len (em->counters));
 248
 249   if (verbose)
 250     vlib_cli_output (vm, "%=10s%=30s%=20s%=10s%=6s", "Count", "Node",
 251                      "Reason", "Severity", "Index");
 252   else
 253     vlib_cli_output (vm, "%=10s%=30s%=20s%=10s", "Count", "Node", "Reason",
 254                      "Severity");
 255
 256
 257   /* *INDENT-OFF* */
 258   foreach_vlib_main(({
 259     em = &this_vlib_main->error_main;
 260
 261     if (verbose)
 262       vlib_cli_output(vm, "Thread %u (%v):", index,
 263                       vlib_worker_threads[index].name);
 264
 265     for (ni = 0; ni < vec_len (this_vlib_main->node_main.nodes); ni++)
 266       {
 267         n = vlib_get_node (this_vlib_main, ni);
 268         for (code = 0; code < n->n_errors; code++)
 269           {
 270             i = n->error_heap_index + code;
 271             c = em->counters[i];
 272             if (i < vec_len (em->counters_last_clear))
 273               c -= em->counters_last_clear[i];
 274             sums[i] += c;
 275
 276             if (c == 0 && verbose < 2)
 277               continue;
 278
 279             if (verbose)
 280               vlib_cli_output (vm, "%10lu%=30v%=20s%=10s%=6d", c, n->name,
 281                                em->counters_heap[i].name,
 282                                sev2str(em->counters_heap[i].severity), i);
 283             else
 284               vlib_cli_output (vm, "%10lu%=30v%=20s%=10s", c, n->name,
 285                                em->counters_heap[i].name,
 286                                sev2str(em->counters_heap[i].severity));
 287           }
 288       }
 289     index++;
 290   }));
 291   /* *INDENT-ON* */
 292
 293   if (verbose)
 294     vlib_cli_output (vm, "Total:");
 295
 296   for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
 297     {
 298       n = vlib_get_node (vm, ni);
 299       for (code = 0; code < n->n_errors; code++)
 300         {
 301           i = n->error_heap_index + code;
 302           if (sums[i])
 303             {
 304               if (verbose)
 305                 vlib_cli_output (vm, "%10lu%=40v%=20s%=10d", sums[i], n->name,
 306                                  em->counters_heap[i].name, i);
 307             }
 308         }
 309     }
 310
 311   vec_free (sums);
 312
 313   return 0;
 314 }
 315
 316 /* *INDENT-OFF* */
 317 VLIB_CLI_COMMAND (vlib_cli_show_errors) = {
 318   .path = "show errors",
 319   .short_help = "Show error counts",
 320   .function = show_errors,
 321 };
 322 /* *INDENT-ON* */
 323
 324 /* *INDENT-OFF* */
 325 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
 326   .path = "show node counters",
 327   .short_help = "Show node counters",
 328   .function = show_errors,
 329 };
 330 /* *INDENT-ON* */
 331
 332 static clib_error_t *
 333 clear_error_counters (vlib_main_t * vm,
 334                       unformat_input_t * input, vlib_cli_command_t * cmd)
 335 {
 336   vlib_error_main_t *em;
 337   u32 i;
 338
 339   /* *INDENT-OFF* */
 340   foreach_vlib_main(({
 341     em = &this_vlib_main->error_main;
 342     vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
 343     for (i = 0; i < vec_len (em->counters); i++)
 344       em->counters_last_clear[i] = em->counters[i];
 345   }));
 346   /* *INDENT-ON* */
 347   return 0;
 348 }
 349
 350 /* *INDENT-OFF* */
 351 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
 352   .path = "clear errors",
 353   .short_help = "Clear error counters",
 354   .function = clear_error_counters,
 355 };
 356 /* *INDENT-ON* */
 357
 358 /* *INDENT-OFF* */
 359 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
 360   .path = "clear node counters",
 361   .short_help = "Clear node counters",
 362   .function = clear_error_counters,
 363 };
 364 /* *INDENT-ON* */
 365
 366 /*
 367  * fd.io coding-style-patch-verification: ON
 368  *
 369  * Local Variables:
 370  * eval: (c-set-style "gnu")
 371  * End:
 372  */