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