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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 This file defines vpe control-plane API messages for
19 the Linux kernel TAP device driver
22 option version = "4.0.0";
24 import "vnet/interface_types.api";
25 import "vnet/ethernet/ethernet_types.api";
26 import "vnet/ip/ip_types.api";
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 */
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
70 autoendian define tap_create_v3
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];
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;
90 vl_api_ip4_address_t host_ip4_gw;
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];
99 string host_bridge[64];
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
108 autoendian define tap_create_v3_reply
112 vl_api_interface_index_t sw_if_index;
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
149 u32 id [default=0xffffffff];
150 bool use_random_mac [default=true];
151 vl_api_mac_address_t mac_address;
152 u8 num_rx_queues [default=1];
153 u16 tx_ring_sz [default=256];
154 u16 rx_ring_sz [default=256];
157 bool host_mac_addr_set;
158 vl_api_mac_address_t host_mac_addr;
159 bool host_ip4_prefix_set;
160 vl_api_ip4_address_with_prefix_t host_ip4_prefix;
161 bool host_ip6_prefix_set;
162 vl_api_ip6_address_with_prefix_t host_ip6_prefix;
163 bool host_ip4_gw_set;
164 vl_api_ip4_address_t host_ip4_gw;
165 bool host_ip6_gw_set;
166 vl_api_ip6_address_t host_ip6_gw;
167 vl_api_tap_flags_t tap_flags;
168 bool host_namespace_set;
169 string host_namespace[64];
170 bool host_if_name_set;
171 string host_if_name[64];
172 bool host_bridge_set;
173 string host_bridge[64];
177 /** \brief Reply for tap create reply
178 @param context - returned sender context, to match reply w/ request
179 @param retval - return code
180 @param sw_if_index - software index allocated for the new tap interface
182 define tap_create_v2_reply
186 vl_api_interface_index_t sw_if_index;
189 /** \brief Delete tap interface
190 @param client_index - opaque cookie to identify the sender
191 @param context - sender context, to match reply w/ request
192 @param sw_if_index - interface index of existing tap interface
194 autoreply define tap_delete_v2
198 vl_api_interface_index_t sw_if_index;
201 /** \brief Dump tap interfaces request
202 @param sw_if_index - filter by sw_if_index
204 define sw_interface_tap_v2_dump
208 vl_api_interface_index_t sw_if_index [default=0xffffffff];
211 /** \brief Reply for tap dump request
212 @param sw_if_index - software index of tap interface
213 @param id - interface id
214 @param tx_ring_sz - the number of entries of TX ring
215 @param rx_ring_sz - the number of entries of RX ring
216 @param host_mtu_size - host mtu size
217 @param host_mac_addr - mac address assigned to the host side of the interface
218 @param host_ip4_prefix - host IPv4 ip address
219 @param host_ip6_prefix - host IPv6 ip address
220 @param tap_flags - flags for the TAP interface creation
221 @param dev_name - Linux tap device name
222 @param host_if_name - host side interface name
223 @param host_namespace - host namespace the interface is attached into
224 @param host_bridge - host bridge the interface is attached into
226 define sw_interface_tap_v2_details
234 vl_api_mac_address_t host_mac_addr;
235 vl_api_ip4_address_with_prefix_t host_ip4_prefix;
236 vl_api_ip6_address_with_prefix_t host_ip6_prefix;
237 vl_api_tap_flags_t tap_flags;
239 string host_if_name[64];
240 string host_namespace[64];
241 string host_bridge[64];
246 * eval: (c-set-style "gnu")