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,
  51                          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
  56   drop_error = vlib_error_set (drop_error_node, drop_error_code);
  57
  58   n_buffers_left = n_buffers;
  59   while (n_buffers_left > 0)
  60     {
  61       vlib_get_next_frame (vm, node, next_index, args, n_args_left);
  62
  63       n_left_this_frame = clib_min (n_buffers_left, n_args_left);
  64       n_buffers_left -= n_left_this_frame;
  65       n_args_left -= n_left_this_frame;
  66
  67       while (n_left_this_frame >= 4)
  68         {
  69           u32 bi0, bi1, bi2, bi3;
  70           vlib_buffer_t * b0, * b1, * b2, * b3;
  71
  72           args[0] = bi0 = buffers[0];
  73           args[1] = bi1 = buffers[1];
  74           args[2] = bi2 = buffers[2];
  75           args[3] = bi3 = buffers[3];
  76
  77           b0 = vlib_get_buffer (vm, bi0);
  78           b1 = vlib_get_buffer (vm, bi1);
  79           b2 = vlib_get_buffer (vm, bi2);
  80           b3 = vlib_get_buffer (vm, bi3);
  81
  82           b0->error = drop_error;
  83           b1->error = drop_error;
  84           b2->error = drop_error;
  85           b3->error = drop_error;
  86
  87           buffers += 4;
  88           args += 4;
  89           n_left_this_frame -= 4;
  90         }
  91
  92       while (n_left_this_frame >= 1)
  93         {
  94           u32 bi0;
  95           vlib_buffer_t * b0;
  96
  97           args[0] = bi0 = buffers[0];
  98
  99           b0 = vlib_get_buffer (vm, bi0);
 100           b0->error = drop_error;
 101
 102           buffers += 1;
 103           args += 1;
 104           n_left_this_frame -= 1;
 105         }
 106
 107       vlib_put_next_frame (vm, node, next_index, n_args_left);
 108     }
 109
 110   return n_buffers;
 111 }
 112
 113 /* Convenience node to drop a vector of buffers with a "misc error". */
 114 static uword
 115 misc_drop_buffers (vlib_main_t * vm,
 116                    vlib_node_runtime_t * node,
 117                    vlib_frame_t * frame)
 118 {
 119     return vlib_error_drop_buffers (vm, node,
 120                                     vlib_frame_args (frame),
 121                                     /* buffer stride */ 1,
 122                                     frame->n_vectors,
 123                                     /* next */ 0,
 124                                     node->node_index,
 125                                     /* error */ 0);
 126 }
 127
 128 static char * misc_drop_buffers_error_strings[] = {
 129     [0] = "misc. errors",
 130 };
 131
 132 VLIB_REGISTER_NODE (misc_drop_buffers_node,static) = {
 133   .function = misc_drop_buffers,
 134   .name = "misc-drop-buffers",
 135   .vector_size = sizeof (u32),
 136   .n_errors = 1,
 137   .n_next_nodes = 1,
 138   .next_nodes = {
 139       "error-drop",
 140   },
 141   .error_strings = misc_drop_buffers_error_strings,
 142 };
 143
 144 /* Reserves given number of error codes for given node. */
 145 void vlib_register_errors (vlib_main_t * vm,
 146                            u32 node_index,
 147                            u32 n_errors,
 148                            char * error_strings[])
 149 {
 150   vlib_error_main_t * em = &vm->error_main;
 151   vlib_node_t * n = vlib_get_node (vm, node_index);
 152   uword l;
 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,
 166                 n->error_heap_handle);
 167
 168   l = vec_len (em->error_strings_heap);
 169
 170   memcpy (vec_elt_at_index (em->error_strings_heap, n->error_heap_index),
 171           error_strings,
 172           n_errors * sizeof (error_strings[0]));
 173
 174   /* Allocate a counter/elog type for each error. */
 175   vec_validate (em->counters, l - 1);
 176   vec_validate (vm->error_elog_event_types, l - 1);
 177
 178   /* Zero counters for re-registrations of errors. */
 179   if (n->error_heap_index + n_errors <= vec_len (em->counters_last_clear))
 180     memcpy (em->counters + n->error_heap_index,
 181             em->counters_last_clear + n->error_heap_index,
 182             n_errors * sizeof (em->counters[0]));
 183   else
 184     memset (em->counters + n->error_heap_index,
 185             0,
 186             n_errors * sizeof (em->counters[0]));
 187
 188   {
 189     elog_event_type_t t;
 190     uword i;
 191
 192     memset (&t, 0, sizeof (t));
 193     for (i = 0; i < n_errors; i++)
 194       {
 195         t.format = (char *) format (0, "%v %s: %%d",
 196                                     n->name,
 197                                     error_strings[i]);
 198         vm->error_elog_event_types[n->error_heap_index + i] = t;
 199       }
 200   }
 201 }
 202
 203 static clib_error_t *
 204 show_errors (vlib_main_t * vm,
 205              unformat_input_t * input,
 206              vlib_cli_command_t * cmd)
 207 {
 208   vlib_error_main_t * em = &vm->error_main;
 209   vlib_node_t * n;
 210   u32 code, i, ni;
 211   u64 c;
 212
 213   vlib_cli_output (vm, "%=16s%=40s%=20s", "Count", "Node", "Reason");
 214
 215   for (ni = 0; ni < vec_len (vm->node_main.nodes); ni++)
 216     {
 217       n = vlib_get_node (vm, ni);
 218       for (code = 0; code < n->n_errors; code++)
 219         {
 220           i = n->error_heap_index + code;
 221           c = em->counters[i];
 222           if (i < vec_len (em->counters_last_clear))
 223             c -= em->counters_last_clear[i];
 224
 225           if (c == 0)
 226             continue;
 227
 228           vlib_cli_output (vm, "%16Ld%=40v%s", c, n->name, em->error_strings_heap[i]);
 229         }
 230     }
 231
 232   return 0;
 233 }
 234
 235 VLIB_CLI_COMMAND (cli_show_errors, static) = {
 236   .path = "show errors",
 237   .short_help = "Show error counts",
 238   .function = show_errors,
 239 };
 240
 241 VLIB_CLI_COMMAND (cli_show_node_counters, static) = {
 242   .path = "show node counters",
 243   .short_help = "Show node counters",
 244   .function = show_errors,
 245 };
 246
 247 static clib_error_t *
 248 clear_error_counters (vlib_main_t * vm,
 249                       unformat_input_t * input,
 250                       vlib_cli_command_t * cmd)
 251 {
 252   vlib_error_main_t * em = &vm->error_main;
 253   u32 i;
 254
 255   vec_validate (em->counters_last_clear, vec_len (em->counters) - 1);
 256   for (i = 0; i < vec_len (em->counters); i++)
 257     em->counters_last_clear[i] = em->counters[i];
 258   return 0;
 259 }
 260
 261 VLIB_CLI_COMMAND (cli_clear_error_counters, static) = {
 262   .path = "clear errors",
 263   .short_help = "Clear error counters",
 264   .function = clear_error_counters,
 265 };
 266
 267 VLIB_CLI_COMMAND (cli_clear_node_counters, static) = {
 268   .path = "clear node counters",
 269   .short_help = "Clear node counters",
 270   .function = clear_error_counters,
 271 };