FD.io VPP  v21.01
Vector Packet Processing
vlib.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  * vlib.h: top-level include file
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_h
41 #define included_vlib_h
42 
43 #include <vppinfra/clib.h>
44 #include <vppinfra/elf_clib.h>
45 #include <vppinfra/callback.h>
46 
47 /* Generic definitions. */
48 #include <vlib/defs.h>
49 
50 /* Forward declarations of structs to avoid circular dependencies. */
51 struct vlib_main_t;
52 typedef u32 vlib_log_class_t;
53 
54 /* All includes in alphabetical order. */
55 #include <vlib/physmem.h>
56 #include <vlib/buffer.h>
57 #include <vlib/cli.h>
58 #include <vlib/counter.h>
59 #include <vlib/error.h>
60 #include <vlib/init.h>
61 #include <vlib/node.h>
62 #include <vlib/punt.h>
63 #include <vlib/trace.h>
64 #include <vlib/log.h>
65 
66 /* Main include depends on other vlib/ includes so we put it last. */
67 #include <vlib/main.h>
68 
69 /* Inline/extern function declarations. */
70 #include <vlib/threads.h>
71 #include <vlib/physmem_funcs.h>
72 #include <vlib/buffer_funcs.h>
73 #include <vlib/error_funcs.h>
74 #include <vlib/format_funcs.h>
75 #include <vlib/node_funcs.h>
76 #include <vlib/trace_funcs.h>
77 #include <vlib/global_funcs.h>
78 #include <vlib/buffer_node.h>
79 #include <vppinfra/pcap_funcs.h>
80 
81 #endif /* included_vlib_h */
82 
83 /*
84  * fd.io coding-style-patch-verification: ON
85  *
86  * Local Variables:
87  * eval: (c-set-style "gnu")
88  * End:
89  */
u32 vlib_log_class_t
Definition: vlib.h:51
vlib buffer access methods.
Callback multiplex scheme For a fully worked-out example, see .../src/vlib/main.
unsigned int u32
Definition: types.h:88
vlib node functions
Optimized thread-safe counters.
vlib buffer structure definition and a few select access methods.
vlib buffer/node functions