flow: add vnet/flow formal API
[vpp.git] / src / vnet / vnet.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  * vnet.h: general networking definitions
17  *
18  * Copyright (c) 2011 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_vnet_vnet_h
41 #define included_vnet_vnet_h
42
43 #include <stddef.h>
44
45 #include <vppinfra/types.h>
46
47 #include <vppinfra/pcap.h>
48 #include <vnet/buffer.h>
49 #include <vnet/config.h>
50 #include <vnet/interface.h>
51 #include <vnet/api_errno.h>
52 #include <vnet/ip/ip_table.h>
53
54 typedef struct vnet_main_t
55 {
56   u32 local_interface_hw_if_index;
57   u32 local_interface_sw_if_index;
58
59   vnet_interface_main_t interface_main;
60
61   /* set up by constructors */
62   vnet_device_class_t *device_class_registrations;
63   vnet_hw_interface_class_t *hw_interface_class_registrations;
64     _vnet_interface_function_list_elt_t
65     * hw_interface_add_del_functions[VNET_ITF_FUNC_N_PRIO];
66     _vnet_interface_function_list_elt_t
67     * hw_interface_link_up_down_functions[VNET_ITF_FUNC_N_PRIO];
68     _vnet_interface_function_list_elt_t
69     * sw_interface_add_del_functions[VNET_ITF_FUNC_N_PRIO];
70     _vnet_interface_function_list_elt_t
71     * sw_interface_admin_up_down_functions[VNET_ITF_FUNC_N_PRIO];
72     _vnet_interface_function_list_elt_t
73     * sw_interface_mtu_change_functions[VNET_ITF_FUNC_N_PRIO];
74
75   uword *interface_tag_by_sw_if_index;
76
77     _vnet_ip_table_function_list_elt_t
78     * ip_table_add_del_functions[VNET_ITF_FUNC_N_PRIO];
79
80   /*
81    * Last "api" error, preserved so we can issue reasonable diagnostics
82    * at or near the top of the food chain
83    */
84   vnet_api_error_t api_errno;
85
86   vlib_main_t *vlib_main;
87 } vnet_main_t;
88
89 extern vnet_main_t vnet_main;
90
91 #include <vnet/interface_funcs.h>
92 #include <vnet/global_funcs.h>
93
94 #endif /* included_vnet_vnet_h */
95
96 /*
97  * fd.io coding-style-patch-verification: ON
98  *
99  * Local Variables:
100  * eval: (c-set-style "gnu")
101  * End:
102  */