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