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 #define foreach_tapv2_flags  \
  26   _ (GSO, 0)                 \
  27   _ (CSUM_OFFLOAD, 1)        \
  28   _ (PERSIST, 2)             \
  29   _ (ATTACH, 3)              \
  30   _ (TUN, 4)                 \
  31   _ (GRO_COALESCE, 5)
  32
  33 typedef enum
  34 {
  35 #define _(a, b) TAP_FLAG_##a = (1 << b),
  36   foreach_tapv2_flags
  37 #undef _
  38 } tap_flag_t;
  39
  40 typedef struct
  41 {
  42   u32 id;
  43   u8 mac_addr_set;
  44   mac_address_t mac_addr;
  45   u8 num_rx_queues;
  46   u16 rx_ring_sz;
  47   u16 tx_ring_sz;
  48   u32 tap_flags;
  49   u8 *host_namespace;
  50   u8 *host_if_name;
  51   mac_address_t host_mac_addr;
  52   u8 *host_bridge;
  53   ip4_address_t host_ip4_addr;
  54   u8 host_ip4_prefix_len;
  55   ip4_address_t host_ip4_gw;
  56   u8 host_ip4_gw_set;
  57   ip6_address_t host_ip6_addr;
  58   u8 host_ip6_prefix_len;
  59   ip6_address_t host_ip6_gw;
  60   u8 host_ip6_gw_set;
  61   u8 host_mtu_set;
  62   u32 host_mtu_size;
  63   /* return */
  64   u32 sw_if_index;
  65   int rv;
  66   clib_error_t *error;
  67 } tap_create_if_args_t;
  68
  69 /** TAP interface details struct */
  70 typedef struct
  71 {
  72   u32 id;
  73   u32 sw_if_index;
  74   u32 tap_flags;
  75   u8 dev_name[64];
  76   u16 tx_ring_sz;
  77   u16 rx_ring_sz;
  78   mac_address_t host_mac_addr;
  79   u8 host_if_name[64];
  80   u8 host_namespace[64];
  81   u8 host_bridge[64];
  82   ip4_address_t host_ip4_addr;
  83   u8 host_ip4_prefix_len;
  84   ip6_address_t host_ip6_addr;
  85   u8 host_ip6_prefix_len;
  86   u32 host_mtu_size;
  87 } tap_interface_details_t;
  88
  89 typedef struct
  90 {
  91   /* logging */
  92   vlib_log_class_t log_default;
  93
  94   /* bit-map of in-use IDs */
  95   uword *tap_ids;
  96
  97   /* host mtu size, configurable through startup.conf */
  98   int host_mtu_size;
  99 } tap_main_t;
 100
 101 void tap_create_if (vlib_main_t * vm, tap_create_if_args_t * args);
 102 int tap_delete_if (vlib_main_t * vm, u32 sw_if_index);
 103 int tap_gso_enable_disable (vlib_main_t * vm, u32 sw_if_index,
 104                             int enable_disable);
 105 int
 106 tap_csum_offload_enable_disable (vlib_main_t * vm, u32 sw_if_index,
 107                                  int enable_disable);
 108 int tap_dump_ifs (tap_interface_details_t ** out_tapids);
 109
 110 #endif /* _VNET_DEVICES_VIRTIO_TAP_H_ */
 111
 112 /*
 113  * fd.io coding-style-patch-verification: ON
 114  *
 115  * Local Variables:
 116  * eval: (c-set-style "gnu")
 117  * End:
 118  */