2 *------------------------------------------------------------------
3 * tap_api.c - vnet tap device driver API support
5 * Copyright (c) 2017 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <vnet/vnet.h>
21 #include <vlibmemory/api.h>
23 #include <vnet/interface.h>
24 #include <vnet/api_errno.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/ip/ip.h>
27 #include <vnet/ethernet/ethernet_types_api.h>
28 #include <vnet/ip/ip_types_api.h>
29 #include <vnet/devices/tap/tap.h>
31 #include <vnet/format_fns.h>
32 #include <vnet/devices/tap/tapv2.api_enum.h>
33 #include <vnet/devices/tap/tapv2.api_types.h>
35 #define REPLY_MSG_ID_BASE tap_main.msg_id_base
36 #include <vlibapi/api_helper_macros.h>
39 vl_api_tap_create_v3_t_handler (vl_api_tap_create_v3_t *mp)
41 vl_api_registration_t *reg;
44 reg = vl_api_client_index_to_registration (mp->client_index);
48 vnet_main_t *vnm = vnet_get_main ();
49 vlib_main_t *vm = vlib_get_main ();
50 vl_api_tap_create_v3_reply_t *rmp;
52 tap_create_if_args_t _a, *ap = &_a;
54 clib_memset (ap, 0, sizeof (*ap));
57 if (!mp->use_random_mac)
59 mac_address_decode (mp->mac_address, &ap->mac_addr);
62 ap->rx_ring_sz = mp->rx_ring_sz;
63 ap->tx_ring_sz = mp->tx_ring_sz;
64 ap->sw_if_index = (u32) ~0;
65 ap->num_rx_queues = clib_max (1, mp->num_rx_queues);
66 ap->num_tx_queues = mp->num_tx_queues;
68 if (mp->host_if_name_set)
69 ap->host_if_name = format (0, "%s%c", mp->host_if_name, 0);
71 if (mp->host_mac_addr_set)
73 mac_address_decode (mp->host_mac_addr, &ap->host_mac_addr);
76 if (mp->host_namespace_set)
77 ap->host_namespace = format (0, "%s%c", mp->host_namespace, 0);
79 if (mp->host_bridge_set)
80 ap->host_bridge = format (0, "%s%c", mp->host_bridge, 0);
82 if (mp->host_ip4_prefix_set)
84 ip4_address_decode (mp->host_ip4_prefix.address, &ap->host_ip4_addr);
85 ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
88 if (mp->host_ip6_prefix_set)
90 ip6_address_decode (mp->host_ip6_prefix.address, &ap->host_ip6_addr);
91 ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
94 if (mp->host_ip4_gw_set)
96 ip4_address_decode (mp->host_ip4_gw, &ap->host_ip4_gw);
97 ap->host_ip4_gw_set = 1;
100 if (mp->host_ip6_gw_set)
102 ip6_address_decode (mp->host_ip6_gw, &ap->host_ip6_gw);
103 ap->host_ip6_gw_set = 1;
106 if (mp->host_mtu_set)
108 ap->host_mtu_size = mp->host_mtu_size;
109 ap->host_mtu_set = 1;
112 ap->tap_flags = mp->tap_flags;
114 tap_create_if (vm, ap);
116 /* If a tag was supplied... */
117 if (vl_api_string_len (&mp->tag))
119 u8 *tag = vl_api_from_api_to_new_vec (mp, &mp->tag);
120 vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
123 vec_free (ap->host_if_name);
124 vec_free (ap->host_namespace);
125 vec_free (ap->host_bridge);
128 REPLY_MACRO2_END (VL_API_TAP_CREATE_V3_REPLY,
129 ({ rmp->sw_if_index = ap->sw_if_index; }));
133 vl_api_tap_create_v2_t_handler (vl_api_tap_create_v2_t * mp)
135 vl_api_registration_t *reg;
136 reg = vl_api_client_index_to_registration (mp->client_index);
140 vnet_main_t *vnm = vnet_get_main ();
141 vlib_main_t *vm = vlib_get_main ();
142 vl_api_tap_create_v2_reply_t *rmp;
144 tap_create_if_args_t _a, *ap = &_a;
146 clib_memset (ap, 0, sizeof (*ap));
148 ap->id = ntohl (mp->id);
149 if (!mp->use_random_mac)
151 mac_address_decode (mp->mac_address, &ap->mac_addr);
152 ap->mac_addr_set = 1;
154 ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
155 ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
156 ap->sw_if_index = (u32) ~ 0;
157 ap->num_rx_queues = 1;
158 ap->num_tx_queues = 1;
160 if (mp->num_rx_queues > 1)
161 ap->num_rx_queues = mp->num_rx_queues;
163 if (mp->host_if_name_set)
164 ap->host_if_name = format (0, "%s%c", mp->host_if_name, 0);
166 if (mp->host_mac_addr_set)
168 mac_address_decode (mp->host_mac_addr, &ap->host_mac_addr);
171 if (mp->host_namespace_set)
172 ap->host_namespace = format (0, "%s%c", mp->host_namespace, 0);
174 if (mp->host_bridge_set)
175 ap->host_bridge = format (0, "%s%c", mp->host_bridge, 0);
177 if (mp->host_ip4_prefix_set)
179 ip4_address_decode (mp->host_ip4_prefix.address, &ap->host_ip4_addr);
180 ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
183 if (mp->host_ip6_prefix_set)
185 ip6_address_decode (mp->host_ip6_prefix.address, &ap->host_ip6_addr);
186 ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
189 if (mp->host_ip4_gw_set)
191 ip4_address_decode (mp->host_ip4_gw, &ap->host_ip4_gw);
192 ap->host_ip4_gw_set = 1;
195 if (mp->host_ip6_gw_set)
197 ip6_address_decode (mp->host_ip6_gw, &ap->host_ip6_gw);
198 ap->host_ip6_gw_set = 1;
201 if (mp->host_mtu_set)
203 ap->host_mtu_size = ntohl (mp->host_mtu_size);
204 ap->host_mtu_set = 1;
207 STATIC_ASSERT (((int) TAP_API_FLAG_GSO == (int) TAP_FLAG_GSO),
208 "tap gso api flag mismatch");
209 STATIC_ASSERT (((int) TAP_API_FLAG_CSUM_OFFLOAD ==
210 (int) TAP_FLAG_CSUM_OFFLOAD),
211 "tap checksum offload api flag mismatch");
212 STATIC_ASSERT (((int) TAP_API_FLAG_PERSIST == (int) TAP_FLAG_PERSIST),
213 "tap persist api flag mismatch");
214 STATIC_ASSERT (((int) TAP_API_FLAG_ATTACH == (int) TAP_FLAG_ATTACH),
215 "tap attach api flag mismatch");
216 STATIC_ASSERT (((int) TAP_API_FLAG_TUN == (int) TAP_FLAG_TUN),
217 "tap tun api flag mismatch");
218 STATIC_ASSERT (((int) TAP_API_FLAG_GRO_COALESCE ==
219 (int) TAP_FLAG_GRO_COALESCE),
220 "tap gro coalesce api flag mismatch");
221 STATIC_ASSERT (((int) TAP_API_FLAG_PACKED == (int) TAP_FLAG_PACKED),
222 "tap packed api flag mismatch");
223 STATIC_ASSERT (((int) TAP_API_FLAG_IN_ORDER ==
224 (int) TAP_FLAG_IN_ORDER), "tap in-order api flag mismatch");
226 ap->tap_flags = ntohl (mp->tap_flags);
228 tap_create_if (vm, ap);
231 /* If a tag was supplied... */
232 if (vl_api_string_len (&mp->tag))
234 u8 *tag = vl_api_from_api_to_new_vec (mp, &mp->tag);
235 vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
238 rmp = vl_msg_api_alloc (sizeof (*rmp));
239 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_TAP_CREATE_V2_REPLY);
240 rmp->context = mp->context;
241 rmp->retval = ntohl (ap->rv);
242 rmp->sw_if_index = ntohl (ap->sw_if_index);
244 vl_api_send_msg (reg, (u8 *) rmp);
246 vec_free (ap->host_if_name);
247 vec_free (ap->host_namespace);
248 vec_free (ap->host_bridge);
253 vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
255 vl_api_registration_t *reg;
256 reg = vl_api_client_index_to_registration (mp->client_index);
260 vnet_main_t *vnm = vnet_get_main ();
261 vlib_main_t *vm = vlib_get_main ();
263 vl_api_tap_delete_v2_reply_t *rmp;
265 u32 sw_if_index = ntohl (mp->sw_if_index);
267 rv = tap_delete_if (vm, sw_if_index);
269 rmp = vl_msg_api_alloc (sizeof (*rmp));
270 rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_TAP_DELETE_V2_REPLY);
271 rmp->context = mp->context;
272 rmp->retval = ntohl (rv);
274 vl_api_send_msg (reg, (u8 *) rmp);
277 vnet_clear_sw_interface_tag (vnm, sw_if_index);
281 tap_send_sw_interface_details (vpe_api_main_t * am,
282 vl_api_registration_t * reg,
283 tap_interface_details_t * tap_if, u32 context)
285 vl_api_sw_interface_tap_v2_details_t *mp;
286 mp = vl_msg_api_alloc (sizeof (*mp));
287 clib_memset (mp, 0, sizeof (*mp));
289 htons (REPLY_MSG_ID_BASE + VL_API_SW_INTERFACE_TAP_V2_DETAILS);
290 mp->id = htonl (tap_if->id);
291 mp->sw_if_index = htonl (tap_if->sw_if_index);
292 mp->tap_flags = htonl (tap_if->tap_flags);
293 clib_memcpy (mp->dev_name, tap_if->dev_name,
294 MIN (ARRAY_LEN (mp->dev_name) - 1,
295 strlen ((const char *) tap_if->dev_name)));
296 mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
297 mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
298 mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
299 clib_memcpy (mp->host_if_name, tap_if->host_if_name,
300 MIN (ARRAY_LEN (mp->host_if_name) - 1,
301 strlen ((const char *) tap_if->host_if_name)));
302 clib_memcpy (mp->host_namespace, tap_if->host_namespace,
303 MIN (ARRAY_LEN (mp->host_namespace) - 1,
304 strlen ((const char *) tap_if->host_namespace)));
305 clib_memcpy (mp->host_bridge, tap_if->host_bridge,
306 MIN (ARRAY_LEN (mp->host_bridge) - 1,
307 strlen ((const char *) tap_if->host_bridge)));
308 mp->host_mtu_size = htonl (tap_if->host_mtu_size);
309 mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
311 if (tap_if->host_ip4_prefix_len)
312 ip4_address_encode (&tap_if->host_ip4_addr, mp->host_ip4_prefix.address);
313 mp->host_ip4_prefix.len = tap_if->host_ip4_prefix_len;
314 if (tap_if->host_ip6_prefix_len)
315 ip6_address_encode (&tap_if->host_ip6_addr, mp->host_ip6_prefix.address);
316 mp->host_ip6_prefix.len = tap_if->host_ip6_prefix_len;
318 mp->context = context;
319 vl_api_send_msg (reg, (u8 *) mp);
323 vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
327 vpe_api_main_t *am = &vpe_api_main;
328 vl_api_registration_t *reg;
329 tap_interface_details_t *tapifs = NULL;
330 tap_interface_details_t *tap_if = NULL;
331 u32 filter_sw_if_index;
333 reg = vl_api_client_index_to_registration (mp->client_index);
337 filter_sw_if_index = htonl (mp->sw_if_index);
338 if (mp->sw_if_index != ~0)
339 VALIDATE_SW_IF_INDEX (mp);
341 rv = tap_dump_ifs (&tapifs);
345 vec_foreach (tap_if, tapifs)
347 if ((filter_sw_if_index == ~0)
348 || (tap_if->sw_if_index == filter_sw_if_index))
349 tap_send_sw_interface_details (am, reg, tap_if, mp->context);
351 BAD_SW_IF_INDEX_LABEL;
355 #include <vnet/devices/tap/tapv2.api.c>
356 static clib_error_t *
357 tapv2_api_hookup (vlib_main_t * vm)
360 * Set up the (msg_name, crc, message-id) table
362 REPLY_MSG_ID_BASE = setup_message_id_table ();
367 VLIB_API_INIT_FUNCTION (tapv2_api_hookup);
370 * fd.io coding-style-patch-verification: ON
373 * eval: (c-set-style "gnu")