FD.io VPP  v20.05.1-6-gf53edbc3b
Vector Packet Processing
error_funcs.h
Go to the documentation of this file.
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  if (VLIB_ELOG_MAIN_LOOP > 0 && increment > 0)
49  {
50  elog_main_t *em = &vm->elog_main;
51  elog (em, vec_elt_at_index (vm->error_elog_event_types, counter),
52  increment);
53  }
54 }
55 
56 always_inline void
58  uword counter, uword increment)
59 {
60  vlib_node_t *n = vlib_get_node (vm, node_index);
61  vlib_error_main_t *em = &vm->error_main;
62 
63  ASSERT (counter < n->n_errors);
64  counter += n->error_heap_index;
65 
66  ASSERT (counter < vec_len (em->counters));
67  em->counters[counter] += increment;
68 
69  vlib_error_elog_count (vm, counter, increment);
70 }
71 
72 /* Drop all buffers in frame with given error code. */
73 uword
75  vlib_node_runtime_t * node,
76  u32 * buffers,
77  u32 next_buffer_stride,
78  u32 n_buffers,
79  u32 error_next_index,
80  u32 error_node, u32 error_code);
81 
82 #endif /* included_vlib_error_funcs_h */
83 
84 /*
85  * fd.io coding-style-patch-verification: ON
86  *
87  * Local Variables:
88  * eval: (c-set-style "gnu")
89  * End:
90  */
u32 error_heap_index
Definition: node.h:327
static void vlib_error_count(vlib_main_t *vm, uword node_index, uword counter, uword increment)
Definition: error_funcs.h:57
uword vlib_error_drop_buffers(vlib_main_t *vm, vlib_node_runtime_t *node, u32 *buffers, u32 next_buffer_stride, u32 n_buffers, u32 error_next_index, u32 error_node, u32 error_code)
Definition: error.c:45
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
elog_event_type_t * error_elog_event_types
Definition: main.h:206
unsigned int u32
Definition: types.h:88
vlib_error_main_t error_main
Definition: main.h:179
#define always_inline
Definition: ipsec.h:28
static void elog(elog_main_t *em, elog_event_type_t *type, u32 data)
Log a single-datum event.
Definition: elog.h:367
#define VLIB_ELOG_MAIN_LOOP
Definition: main.h:58
vlib node functions
u64 * counters
Definition: error.h:48
elog_main_t elog_main
Definition: main.h:193
#define ASSERT(truth)
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u64 uword
Definition: types.h:112
static void vlib_error_elog_count(vlib_main_t *vm, uword counter, uword increment)
Definition: error_funcs.h:46
static vlib_node_t * vlib_get_node(vlib_main_t *vm, u32 i)
Get vlib node by index.
Definition: node_funcs.h:59