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