src/vnet/devices/tap/tap.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef _VNET_DEVICES_VIRTIO_TAP_H_
  19 #define _VNET_DEVICES_VIRTIO_TAP_H_
  20
  21 #ifndef MIN
  22 #define MIN(x,y) (((x)<(y))?(x):(y))
  23 #endif
  24
  25 typedef struct
  26 {
  27   u32 id;
  28   u8 mac_addr_set;
  29   mac_address_t mac_addr;
  30   u8 num_rx_queues;
  31   u16 rx_ring_sz;
  32   u16 tx_ring_sz;
  33   u32 tap_flags;
  34 #define TAP_FLAG_GSO (1 << 0)
  35 #define TAP_FLAG_CSUM_OFFLOAD (1 << 1)
  36   u8 *host_namespace;
  37   u8 *host_if_name;
  38   mac_address_t host_mac_addr;
  39   u8 *host_bridge;
  40   ip4_address_t host_ip4_addr;
  41   u8 host_ip4_prefix_len;
  42   ip4_address_t host_ip4_gw;
  43   u8 host_ip4_gw_set;
  44   ip6_address_t host_ip6_addr;
  45   u8 host_ip6_prefix_len;
  46   ip6_address_t host_ip6_gw;
  47   u8 host_ip6_gw_set;
  48   u8 host_mtu_set;
  49   u32 host_mtu_size;
  50   /* return */
  51   u32 sw_if_index;
  52   int rv;
  53   clib_error_t *error;
  54 } tap_create_if_args_t;
  55
  56 /** TAP interface details struct */
  57 typedef struct
  58 {
  59   u32 id;
  60   u32 sw_if_index;
  61   u32 tap_flags;
  62   u8 dev_name[64];
  63   u16 tx_ring_sz;
  64   u16 rx_ring_sz;
  65   mac_address_t host_mac_addr;
  66   u8 host_if_name[64];
  67   u8 host_namespace[64];
  68   u8 host_bridge[64];
  69   ip4_address_t host_ip4_addr;
  70   u8 host_ip4_prefix_len;
  71   ip6_address_t host_ip6_addr;
  72   u8 host_ip6_prefix_len;
  73   u32 host_mtu_size;
  74 } tap_interface_details_t;
  75
  76 typedef struct
  77 {
  78   /* logging */
  79   vlib_log_class_t log_default;
  80
  81   /* bit-map of in-use IDs */
  82   uword *tap_ids;
  83
  84   /* host mtu size, configurable through startup.conf */
  85   int host_mtu_size;
  86 } tap_main_t;
  87
  88 void tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args);
  89 int tap_delete_if (vlib_main_t * vm, u32 sw_if_index);
  90 int tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index,
  91                             int enable_disable);
  92 int
  93 tap_csum_offload_enable_disable (vlib_main_t * vm, u32 sw_if_index,
  94                                  int enable_disable);
  95 int tap_dump_ifs (tap_interface_details_t ** out_tapids);
  96
  97 #endif /* _VNET_DEVICES_VIRTIO_TAP_H_ */
  98
  99 /*
 100  * fd.io coding-style-patch-verification: ON
 101  *
 102  * Local Variables:
 103  * eval: (c-set-style "gnu")
 104  * End:
 105  */