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