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 = "3.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_FLAG_GSO = 1,
  30         TAP_FLAG_CSUM_OFFLOAD = 2,
  31 };
  32
  33 /** \brief Initialize a new tap interface with the given parameters
  34     @param client_index - opaque cookie to identify the sender
  35     @param context - sender context, to match reply w/ request
  36     @param id - interface id, 0xffffffff means auto
  37     @param use_random_mac - let the system generate a unique mac address
  38     @param mac_address - mac addr to assign to the interface if use_random not set
  39     @param num_rx_queues - number of rx queues
  40     @param tx_ring_sz - the number of entries of TX ring
  41     @param rx_ring_sz - the number of entries of RX ring
  42     @param host_mtu_set - host MTU should be set
  43     @param host_mtu_size - host MTU size
  44     @param host_mac_addr_set - host side interface mac address should be set
  45     @param host_mac_addr - host side interface mac address
  46     @param host_ip4_prefix_set - host IPv4 ip address should be set
  47     @param host_ip4_prefix - host IPv4 ip address
  48     @param host_ip6_prefix_set - host IPv6 ip address should be set
  49     @param host_ip6_prefix - host IPv6 ip address
  50     @param host_ip4_gw_set - host IPv4 default gateway should be set
  51     @param host_ip4_gw - host IPv4 default gateway
  52     @param host_ip6_gw_set - host IPv6 default gateway should be set
  53     @param host_ip6_gw - host IPv6 default gateway
  54     @param tap_flags - flags for the TAP interface creation
  55     @param host_if_name_set - host side interface name should be set
  56     @param host_if_name - host side interface name
  57     @param host_namespace_set - host namespece should be set
  58     @param host_namespace - host namespace to attach interface to
  59     @param host_bridge_set - host bridge should be set
  60     @param host_bridge - host bridge to attach interface to
  61     @param tag - tag
  62 */
  63 define tap_create_v2
  64 {
  65   u32 client_index;
  66   u32 context;
  67   u32 id [default=0xffffffff];
  68   bool use_random_mac [default=true];
  69   vl_api_mac_address_t mac_address;
  70   u8 num_rx_queues [default=1];
  71   u16 tx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  72   u16 rx_ring_sz; /* optional, default is 256 entries, must be power of 2 */
  73   bool host_mtu_set;
  74   u32 host_mtu_size;
  75   bool host_mac_addr_set;
  76   vl_api_mac_address_t host_mac_addr;
  77   bool host_ip4_prefix_set;
  78   vl_api_ip4_address_with_prefix_t host_ip4_prefix;
  79   bool host_ip6_prefix_set;
  80   vl_api_ip6_address_with_prefix_t host_ip6_prefix;
  81   bool host_ip4_gw_set;
  82   vl_api_ip4_address_t host_ip4_gw;
  83   bool host_ip6_gw_set;
  84   vl_api_ip6_address_t host_ip6_gw;
  85   vl_api_tap_flags_t tap_flags;
  86   bool host_namespace_set;
  87   string host_namespace[64];
  88   bool host_if_name_set;
  89   string host_if_name[64];
  90   bool host_bridge_set;
  91   string host_bridge[64];
  92   string tag[];
  93 };
  94
  95 /** \brief Reply for tap create reply
  96     @param context - returned sender context, to match reply w/ request
  97     @param retval - return code
  98     @param sw_if_index - software index allocated for the new tap interface
  99 */
 100 define tap_create_v2_reply
 101 {
 102   u32 context;
 103   i32 retval;
 104   vl_api_interface_index_t sw_if_index;
 105 };
 106
 107 /** \brief Delete tap interface
 108     @param client_index - opaque cookie to identify the sender
 109     @param context - sender context, to match reply w/ request
 110     @param sw_if_index - interface index of existing tap interface
 111 */
 112 autoreply define tap_delete_v2
 113 {
 114   u32 client_index;
 115   u32 context;
 116   vl_api_interface_index_t sw_if_index;
 117 };
 118
 119 /** \brief Dump tap interfaces request
 120     @param sw_if_index - filter by sw_if_index UNIMPLEMENTED
 121 */
 122 define sw_interface_tap_v2_dump
 123 {
 124   u32 client_index;
 125   u32 context;
 126   vl_api_interface_index_t sw_if_index [default=0xffffffff];
 127 };
 128
 129 /** \brief Reply for tap dump request
 130     @param sw_if_index - software index of tap interface
 131     @param id - interface id
 132     @param tx_ring_sz - the number of entries of TX ring
 133     @param rx_ring_sz - the number of entries of RX ring
 134     @param host_mtu_size - host mtu size
 135     @param host_mac_addr - mac address assigned to the host side of the interface
 136     @param host_ip4_prefix - host IPv4 ip address
 137     @param host_ip6_prefix - host IPv6 ip address
 138     @param tap_flags - flags for the TAP interface creation
 139     @param dev_name - Linux tap device name
 140     @param host_if_name - host side interface name
 141     @param host_namespace - host namespace the interface is attached into
 142     @param host_bridge - host bridge the interface is attached into
 143 */
 144 define sw_interface_tap_v2_details
 145 {
 146   u32 context;
 147   u32 sw_if_index;
 148   u32 id;
 149   u16 tx_ring_sz;
 150   u16 rx_ring_sz;
 151   u32 host_mtu_size;
 152   vl_api_mac_address_t host_mac_addr;
 153   vl_api_ip4_address_with_prefix_t host_ip4_prefix;
 154   vl_api_ip6_address_with_prefix_t host_ip6_prefix;
 155   vl_api_tap_flags_t tap_flags;
 156   string dev_name[64];
 157   string host_if_name[64];
 158   string host_namespace[64];
 159   string host_bridge[64];
 160 };
 161
 162 /*
 163  * Local Variables:
 164  * eval: (c-set-style "gnu")
 165  * End:
 166  */