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   u8 mac_addr[6];
  30   u16 rx_ring_sz;
  31   u16 tx_ring_sz;
  32   u32 tap_flags;
  33 #define TAP_FLAG_GSO (1 << 0)
  34   u8 *host_namespace;
  35   u8 *host_if_name;
  36   u8 host_mac_addr[6];
  37   u8 *host_bridge;
  38   ip4_address_t host_ip4_addr;
  39   u8 host_ip4_prefix_len;
  40   ip4_address_t host_ip4_gw;
  41   u8 host_ip4_gw_set;
  42   ip6_address_t host_ip6_addr;
  43   u8 host_ip6_prefix_len;
  44   ip6_address_t host_ip6_gw;
  45   u8 host_ip6_gw_set;
  46   u8 host_mtu_set;
  47   u32 host_mtu_size;
  48   /* return */
  49   u32 sw_if_index;
  50   int rv;
  51   clib_error_t *error;
  52 } tap_create_if_args_t;
  53
  54 /** TAP interface details struct */
  55 typedef struct
  56 {
  57   u32 id;
  58   u32 sw_if_index;
  59   u32 tap_flags;
  60   u8 dev_name[64];
  61   u16 tx_ring_sz;
  62   u16 rx_ring_sz;
  63   u8 host_mac_addr[6];
  64   u8 host_if_name[64];
  65   u8 host_namespace[64];
  66   u8 host_bridge[64];
  67   u8 host_ip4_addr[4];
  68   u8 host_ip4_prefix_len;
  69   u8 host_ip6_addr[16];
  70   u8 host_ip6_prefix_len;
  71   u32 host_mtu_size;
  72 } tap_interface_details_t;
  73
  74 typedef struct
  75 {
  76   /* logging */
  77   vlib_log_class_t log_default;
  78
  79   /* bit-map of in-use IDs */
  80   uword *tap_ids;
  81
  82   /* host mtu size, configurable through startup.conf */
  83   int host_mtu_size;
  84 } tap_main_t;
  85
  86 void tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args);
  87 int tap_delete_if (vlib_main_t * vm, u32 sw_if_index);
  88 int tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index,
  89                             int enable_disable);
  90 int tap_dump_ifs (tap_interface_details_t ** out_tapids);
  91
  92 #endif /* _VNET_DEVICES_VIRTIO_TAP_H_ */
  93
  94 /*
  95  * fd.io coding-style-patch-verification: ON
  96  *
  97  * Local Variables:
  98  * eval: (c-set-style "gnu")
  99  * End:
 100  */