src/vnet/devices/tap/tapv2.api

   1 /*
   2  * Copyright (c) 2017 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15
  16 /** \file
  17
  18     This file defines vpe control-plane API messages for
  19     the Linux kernel TAP device driver
  20 */
  21
  22 option version = "4.0.0";
  23
  24 import "vnet/interface_types.api";
  25 import "vnet/ethernet/ethernet_types.api";
  26 import "vnet/ip/ip_types.api";
  27
  28 enum tap_flags {
  29         TAP_API_FLAG_GSO = 1, /* enable gso on the interface */
  30         TAP_API_FLAG_CSUM_OFFLOAD = 2, /* enable checksum offload without gso on the interface */
  31         TAP_API_FLAG_PERSIST = 4, /* make the interface persistence to exist in linux even vpp crash/restart */
  32         TAP_API_FLAG_ATTACH = 8,  /* attach to the existing persistence interface after vpp crash/restart */
  33         TAP_API_FLAG_TUN = 16,  /* create TUN interface instead of tap */
  34         TAP_API_FLAG_GRO_COALESCE = 32, /* enable packet coalescing on tx side, provided gso enabled */
  35         TAP_API_FLAG_PACKED = 64 [backwards_compatible], /* enable packed ring support */
  36         TAP_API_FLAG_IN_ORDER = 128 [backwards_compatible], /* enable in-order desc support */
  37 };
  38
  39 /** \brief Initialize a new tap interface with the given parameters
  40     @param client_index - opaque cookie to identify the sender
  41     @param context - sender context, to match reply w/ request
  42     @param id - interface id, 0xffffffff means auto
  43     @param use_random_mac - let the system generate a unique mac address
  44     @param mac_address - mac addr to assign to the interface if use_random not set
  45     @param num_rx_queues - number of rx queues
  46     @param num_tx_queues - number of tx queues
  47     @param tx_ring_sz - the number of entries of TX ring, optional, default is 256 entries, must be power of 2
  48     @param rx_ring_sz - the number of entries of RX ring, optional, default is 256 entries, must be power of 2
  49     @param host_mtu_set - host MTU should be set
  50     @param host_mtu_size - host MTU size
  51     @param host_mac_addr_set - host side interface mac address should be set
  52     @param host_mac_addr - host side interface mac address
  53     @param host_ip4_prefix_set - host IPv4 ip address should be set
  54     @param host_ip4_prefix - host IPv4 ip address
  55     @param host_ip6_prefix_set - host IPv6 ip address should be set
  56     @param host_ip6_prefix - host IPv6 ip address
  57     @param host_ip4_gw_set - host IPv4 default gateway should be set
  58     @param host_ip4_gw - host IPv4 default gateway
  59     @param host_ip6_gw_set - host IPv6 default gateway should be set
  60     @param host_ip6_gw - host IPv6 default gateway
  61     @param tap_flags - flags for the TAP interface creation
  62     @param host_if_name_set - host side interface name should be set
  63     @param host_if_name - host side interface name
  64     @param host_namespace_set - host namespace should be set
  65     @param host_namespace - host namespace to attach interface to
  66     @param host_bridge_set - host bridge should be set
  67     @param host_bridge - host bridge to attach interface to
  68     @param tag - tag
  69 */
  70 autoendian define tap_create_v3
  71 {
  72   u32 client_index;
  73   u32 context;
  74   u32 id [default=0xffffffff];
  75   bool use_random_mac [default=true];
  76   vl_api_mac_address_t mac_address;
  77   u16 num_rx_queues [default=1];
  78   u16 num_tx_queues [default=1];
  79   u16 tx_ring_sz [default=256];
  80   u16 rx_ring_sz [default=256];
  81   bool host_mtu_set;
  82   u32 host_mtu_size;
  83   bool host_mac_addr_set;
  84   vl_api_mac_address_t host_mac_addr;
  85   bool host_ip4_prefix_set;
  86   vl_api_ip4_address_with_prefix_t host_ip4_prefix;
  87   bool host_ip6_prefix_set;
  88   vl_api_ip6_address_with_prefix_t host_ip6_prefix;
  89   bool host_ip4_gw_set;
  90   vl_api_ip4_address_t host_ip4_gw;
  91   bool host_ip6_gw_set;
  92   vl_api_ip6_address_t host_ip6_gw;
  93   vl_api_tap_flags_t tap_flags;
  94   bool host_namespace_set;
  95   string host_namespace[64];
  96   bool host_if_name_set;
  97   string host_if_name[64];
  98   bool host_bridge_set;
  99   string host_bridge[64];
 100   string tag[];
 101 };
 102
 103 /** \brief Reply for tap create reply
 104     @param context - returned sender context, to match reply w/ request
 105     @param retval - return code
 106     @param sw_if_index - software index allocated for the new tap interface
 107 */
 108 autoendian define tap_create_v3_reply
 109 {
 110   u32 context;
 111   i32 retval;
 112   vl_api_interface_index_t sw_if_index;
 113 };
 114
 115 /** \brief Initialize a new tap interface with the given parameters
 116     @param client_index - opaque cookie to identify the sender
 117     @param context - sender context, to match reply w/ request
 118     @param id - interface id, 0xffffffff means auto
 119     @param use_random_mac - let the system generate a unique mac address
 120     @param mac_address - mac addr to assign to the interface if use_random not set
 121     @param num_rx_queues - number of rx queues
 122     @param tx_ring_sz - the number of entries of TX ring, optional, default is 256 entries, must be power of 2
 123     @param rx_ring_sz - the number of entries of RX ring, optional, default is 256 entries, must be power of 2
 124     @param host_mtu_set - host MTU should be set
 125     @param host_mtu_size - host MTU size
 126     @param host_mac_addr_set - host side interface mac address should be set
 127     @param host_mac_addr - host side interface mac address
 128     @param host_ip4_prefix_set - host IPv4 ip address should be set
 129     @param host_ip4_prefix - host IPv4 ip address
 130     @param host_ip6_prefix_set - host IPv6 ip address should be set
 131     @param host_ip6_prefix - host IPv6 ip address
 132     @param host_ip4_gw_set - host IPv4 default gateway should be set
 133     @param host_ip4_gw - host IPv4 default gateway
 134     @param host_ip6_gw_set - host IPv6 default gateway should be set
 135     @param host_ip6_gw - host IPv6 default gateway
 136     @param tap_flags - flags for the TAP interface creation
 137     @param host_if_name_set - host side interface name should be set
 138     @param host_if_name - host side interface name
 139     @param host_namespace_set - host namespace should be set
 140     @param host_namespace - host namespace to attach interface to
 141     @param host_bridge_set - host bridge should be set
 142     @param host_bridge - host bridge to attach interface to
 143     @param tag - tag
 144 */
 145 define tap_create_v2
 146 {
 147   option deprecated;
 148
 149   u32 client_index;
 150   u32 context;
 151   u32 id [default=0xffffffff];
 152   bool use_random_mac [default=true];
 153   vl_api_mac_address_t mac_address;
 154   u8 num_rx_queues [default=1];
 155   u16 tx_ring_sz [default=256];
 156   u16 rx_ring_sz [default=256];
 157   bool host_mtu_set;
 158   u32 host_mtu_size;
 159   bool host_mac_addr_set;
 160   vl_api_mac_address_t host_mac_addr;
 161   bool host_ip4_prefix_set;
 162   vl_api_ip4_address_with_prefix_t host_ip4_prefix;
 163   bool host_ip6_prefix_set;
 164   vl_api_ip6_address_with_prefix_t host_ip6_prefix;
 165   bool host_ip4_gw_set;
 166   vl_api_ip4_address_t host_ip4_gw;
 167   bool host_ip6_gw_set;
 168   vl_api_ip6_address_t host_ip6_gw;
 169   vl_api_tap_flags_t tap_flags;
 170   bool host_namespace_set;
 171   string host_namespace[64];
 172   bool host_if_name_set;
 173   string host_if_name[64];
 174   bool host_bridge_set;
 175   string host_bridge[64];
 176   string tag[];
 177 };
 178
 179 /** \brief Reply for tap create reply
 180     @param context - returned sender context, to match reply w/ request
 181     @param retval - return code
 182     @param sw_if_index - software index allocated for the new tap interface
 183 */
 184 define tap_create_v2_reply
 185 {
 186   option deprecated;
 187
 188   u32 context;
 189   i32 retval;
 190   vl_api_interface_index_t sw_if_index;
 191 };
 192
 193 /** \brief Delete tap interface
 194     @param client_index - opaque cookie to identify the sender
 195     @param context - sender context, to match reply w/ request
 196     @param sw_if_index - interface index of existing tap interface
 197 */
 198 autoreply define tap_delete_v2
 199 {
 200   u32 client_index;
 201   u32 context;
 202   vl_api_interface_index_t sw_if_index;
 203 };
 204
 205 /** \brief Dump tap interfaces request
 206     @param sw_if_index - filter by sw_if_index
 207 */
 208 define sw_interface_tap_v2_dump
 209 {
 210   u32 client_index;
 211   u32 context;
 212   vl_api_interface_index_t sw_if_index [default=0xffffffff];
 213 };
 214
 215 /** \brief Reply for tap dump request
 216     @param sw_if_index - software index of tap interface
 217     @param id - interface id
 218     @param tx_ring_sz - the number of entries of TX ring
 219     @param rx_ring_sz - the number of entries of RX ring
 220     @param host_mtu_size - host mtu size
 221     @param host_mac_addr - mac address assigned to the host side of the interface
 222     @param host_ip4_prefix - host IPv4 ip address
 223     @param host_ip6_prefix - host IPv6 ip address
 224     @param tap_flags - flags for the TAP interface creation
 225     @param dev_name - Linux tap device name
 226     @param host_if_name - host side interface name
 227     @param host_namespace - host namespace the interface is attached into
 228     @param host_bridge - host bridge the interface is attached into
 229 */
 230 define sw_interface_tap_v2_details
 231 {
 232   u32 context;
 233   u32 sw_if_index;
 234   u32 id;
 235   u16 tx_ring_sz;
 236   u16 rx_ring_sz;
 237   u32 host_mtu_size;
 238   vl_api_mac_address_t host_mac_addr;
 239   vl_api_ip4_address_with_prefix_t host_ip4_prefix;
 240   vl_api_ip6_address_with_prefix_t host_ip6_prefix;
 241   vl_api_tap_flags_t tap_flags;
 242   string dev_name[64];
 243   string host_if_name[64];
 244   string host_namespace[64];
 245   string host_bridge[64];
 246 };
 247
 248 /*
 249  * Local Variables:
 250  * eval: (c-set-style "gnu")
 251  * End:
 252  */