src/vlib/error.h

   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.h: drop/punt error packets
  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 #ifndef included_vlib_error_h
  41 #define included_vlib_error_h
  42
  43 #include <vppinfra/format.h>
  44
  45 typedef u16 vlib_error_t;
  46
  47 enum vl_counter_severity_e
  48 {
  49   VL_COUNTER_SEVERITY_ERROR,
  50   VL_COUNTER_SEVERITY_WARN,
  51   VL_COUNTER_SEVERITY_INFO,
  52 };
  53
  54 typedef struct
  55 {
  56   char *name;
  57   char *desc;
  58   enum vl_counter_severity_e severity;
  59   u32 stats_entry_index;
  60 } vlib_error_desc_t;
  61
  62 typedef struct
  63 {
  64   /* Error counters. */
  65   u64 *counters;
  66
  67   /* Counter values as of last counter clear. */
  68   u64 *counters_last_clear;
  69
  70   /* Counter structures in heap. Heap index
  71      indexes counter vector. */
  72   vlib_error_desc_t *counters_heap;
  73
  74   /* stats segment entry index */
  75   u32 stats_err_entry_index;
  76 } vlib_error_main_t;
  77
  78 /* Per node error registration. */
  79 void vlib_register_errors (struct vlib_main_t *vm, u32 node_index,
  80                            u32 n_errors, char *error_strings[],
  81                            vlib_error_desc_t counters[]);
  82
  83 unformat_function_t unformat_vlib_error;
  84
  85 #endif /* included_vlib_error_h */
  86
  87 /*
  88  * fd.io coding-style-patch-verification: ON
  89  *
  90  * Local Variables:
  91  * eval: (c-set-style "gnu")
  92  * End:
  93  */