vlib/vlib/error_funcs.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_funcs.h: VLIB error handling
  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_funcs_h
  41 #define included_vlib_error_funcs_h
  42
  43 #include <vlib/node_funcs.h>
  44
  45 always_inline void
  46 vlib_error_elog_count (vlib_main_t * vm, uword counter, uword increment)
  47 {
  48   elog_main_t *em = &vm->elog_main;
  49   if (VLIB_ELOG_MAIN_LOOP > 0 && increment > 0)
  50     elog (em, vec_elt_at_index (vm->error_elog_event_types, counter),
  51           increment);
  52 }
  53
  54 always_inline void
  55 vlib_error_count (vlib_main_t * vm, uword node_index,
  56                   uword counter, uword increment)
  57 {
  58   vlib_node_t *n = vlib_get_node (vm, node_index);
  59   vlib_error_main_t *em = &vm->error_main;
  60
  61   ASSERT (counter < n->n_errors);
  62   counter += n->error_heap_index;
  63
  64   ASSERT (counter < vec_len (em->counters));
  65   em->counters[counter] += increment;
  66
  67   vlib_error_elog_count (vm, counter, increment);
  68 }
  69
  70 /* Drop all buffers in frame with given error code. */
  71 uword
  72 vlib_error_drop_buffers (vlib_main_t * vm,
  73                          vlib_node_runtime_t * node,
  74                          u32 * buffers,
  75                          u32 next_buffer_stride,
  76                          u32 n_buffers,
  77                          u32 error_next_index,
  78                          u32 error_node, u32 error_code);
  79
  80 #endif /* included_vlib_error_funcs_h */
  81
  82 /*
  83  * fd.io coding-style-patch-verification: ON
  84  *
  85  * Local Variables:
  86  * eval: (c-set-style "gnu")
  87  * End:
  88  */