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