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