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/error.h>
  49 #include <vnet/buffer.h>
  50 #include <vnet/config.h>
  51 #include <vnet/interface.h>
  52 #include <vnet/api_errno.h>
  53
  54 /* ip table add delete callback */
  55 typedef struct _vnet_ip_table_function_list_elt
  56 {
  57   struct _vnet_ip_table_function_list_elt *next_ip_table_function;
  58   clib_error_t *(*fp) (struct vnet_main_t * vnm, u32 table_id, u32 flags);
  59 } _vnet_ip_table_function_list_elt_t;
  60
  61 typedef struct
  62 {
  63   /* Trace RX pkts */
  64   u8 pcap_rx_enable;
  65   /* Trace TX pkts */
  66   u8 pcap_tx_enable;
  67   /* Trace drop pkts */
  68   u8 pcap_drop_enable;
  69   u8 pad1;
  70   u32 max_bytes_per_pkt;
  71   u32 pcap_sw_if_index;
  72   pcap_main_t pcap_main;
  73   u32 filter_classify_table_index;
  74   vlib_is_packet_traced_fn_t *current_filter_function;
  75   vlib_error_t pcap_error_index;
  76 } vnet_pcap_t;
  77
  78 typedef struct vnet_main_t
  79 {
  80   u32 local_interface_hw_if_index;
  81   u32 local_interface_sw_if_index;
  82
  83   vnet_interface_main_t interface_main;
  84
  85   /* set up by constructors */
  86   vnet_device_class_t *device_class_registrations;
  87   vnet_hw_interface_class_t *hw_interface_class_registrations;
  88     _vnet_interface_function_list_elt_t
  89     * hw_interface_add_del_functions[VNET_ITF_FUNC_N_PRIO];
  90     _vnet_interface_function_list_elt_t
  91     * hw_interface_link_up_down_functions[VNET_ITF_FUNC_N_PRIO];
  92     _vnet_interface_function_list_elt_t
  93     * sw_interface_add_del_functions[VNET_ITF_FUNC_N_PRIO];
  94     _vnet_interface_function_list_elt_t
  95     * sw_interface_admin_up_down_functions[VNET_ITF_FUNC_N_PRIO];
  96     _vnet_interface_function_list_elt_t
  97     * sw_interface_mtu_change_functions[VNET_ITF_FUNC_N_PRIO];
  98
  99   uword *interface_tag_by_sw_if_index;
 100
 101     _vnet_ip_table_function_list_elt_t
 102     * ip_table_add_del_functions[VNET_ITF_FUNC_N_PRIO];
 103
 104     /* pcap rx / tx tracing */
 105     vnet_pcap_t pcap;
 106
 107     /*
 108      * Last "api" error, preserved so we can issue reasonable diagnostics
 109      * at or near the top of the food chain
 110      */
 111     vnet_api_error_t api_errno;
 112
 113     vlib_main_t *vlib_main;
 114 } vnet_main_t;
 115
 116 extern vnet_main_t vnet_main;
 117
 118 #include <vppinfra/pcap_funcs.h>
 119 #include <vnet/interface_funcs.h>
 120 #include <vnet/global_funcs.h>
 121
 122 #endif /* included_vnet_vnet_h */
 123
 124 /*
 125  * fd.io coding-style-patch-verification: ON
 126  *
 127  * Local Variables:
 128  * eval: (c-set-style "gnu")
 129  * End:
 130  */