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>
28 #include <vnet/vnet_msg_enum.h>
30 #define vl_typedefs /* define message structures */
31 #include <vnet/vnet_all_api_h.h>
34 #define vl_endianfun /* define message structures */
35 #include <vnet/vnet_all_api_h.h>
38 /* instantiate all the print functions we know about */
39 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
41 #include <vnet/vnet_all_api_h.h>
44 #include <vlibapi/api_helper_macros.h>
45 #include <vnet/devices/tap/tap.h>
47 #define foreach_tapv2_api_msg \
48 _(TAP_CREATE_V2, tap_create_v2) \
49 _(TAP_DELETE_V2, tap_delete_v2) \
50 _(SW_INTERFACE_TAP_V2_DUMP, sw_interface_tap_v2_dump)
53 vl_api_tap_create_v2_t_handler (vl_api_tap_create_v2_t * mp)
55 vnet_main_t *vnm = vnet_get_main ();
56 vlib_main_t *vm = vlib_get_main ();
57 vl_api_tap_create_v2_reply_t *rmp;
58 vl_api_registration_t *reg;
59 tap_create_if_args_t _a, *ap = &_a;
61 clib_memset (ap, 0, sizeof (*ap));
63 ap->id = ntohl (mp->id);
64 if (!mp->use_random_mac)
66 clib_memcpy (ap->mac_addr, mp->mac_address, 6);
69 ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
70 ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
71 ap->sw_if_index = (u32) ~ 0;
73 if (mp->host_if_name_set)
74 ap->host_if_name = mp->host_if_name;
76 if (mp->host_mac_addr_set)
78 clib_memcpy (ap->host_mac_addr, mp->host_mac_addr, 6);
82 if (mp->host_namespace_set)
83 ap->host_namespace = mp->host_namespace;
85 if (mp->host_bridge_set)
86 ap->host_bridge = mp->host_bridge;
88 if (mp->host_ip4_addr_set)
90 clib_memcpy (&ap->host_ip4_addr.as_u8, mp->host_ip4_addr, 4);
91 ap->host_ip4_prefix_len = mp->host_ip4_prefix_len;
94 if (mp->host_ip6_addr_set)
96 clib_memcpy (&ap->host_ip6_addr, mp->host_ip6_addr, 16);
97 ap->host_ip6_prefix_len = mp->host_ip6_prefix_len;
100 if (mp->host_ip4_gw_set)
102 clib_memcpy (&ap->host_ip4_gw, mp->host_ip4_gw, 4);
103 ap->host_ip4_gw_set = 1;
106 if (mp->host_ip6_gw_set)
108 clib_memcpy (&ap->host_ip6_gw, mp->host_ip6_gw, 16);
109 ap->host_ip6_gw_set = 1;
112 tap_create_if (vm, ap);
114 reg = vl_api_client_index_to_registration (mp->client_index);
118 /* If a tag was supplied... */
121 /* Make sure it's a proper C-string */
122 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
123 u8 *tag = format (0, "%s%c", mp->tag, 0);
124 vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
128 rmp = vl_msg_api_alloc (sizeof (*rmp));
129 rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
130 rmp->context = mp->context;
131 rmp->retval = ntohl (ap->rv);
132 rmp->sw_if_index = ntohl (ap->sw_if_index);
134 vl_api_send_msg (reg, (u8 *) rmp);
138 tap_send_sw_interface_event_deleted (vpe_api_main_t * am,
139 vl_api_registration_t * reg,
142 vl_api_sw_interface_event_t *mp;
144 mp = vl_msg_api_alloc (sizeof (*mp));
145 clib_memset (mp, 0, sizeof (*mp));
146 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
147 mp->sw_if_index = ntohl (sw_if_index);
149 mp->admin_up_down = 0;
150 mp->link_up_down = 0;
152 vl_api_send_msg (reg, (u8 *) mp);
156 vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
158 vnet_main_t *vnm = vnet_get_main ();
159 vlib_main_t *vm = vlib_get_main ();
161 vpe_api_main_t *vam = &vpe_api_main;
162 vl_api_tap_delete_v2_reply_t *rmp;
163 vl_api_registration_t *reg;
164 u32 sw_if_index = ntohl (mp->sw_if_index);
166 rv = tap_delete_if (vm, sw_if_index);
168 reg = vl_api_client_index_to_registration (mp->client_index);
172 rmp = vl_msg_api_alloc (sizeof (*rmp));
173 rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_V2_REPLY);
174 rmp->context = mp->context;
175 rmp->retval = ntohl (rv);
177 vl_api_send_msg (reg, (u8 *) rmp);
181 vnet_clear_sw_interface_tag (vnm, sw_if_index);
182 tap_send_sw_interface_event_deleted (vam, reg, sw_if_index);
187 tap_send_sw_interface_details (vpe_api_main_t * am,
188 vl_api_registration_t * reg,
189 tap_interface_details_t * tap_if, u32 context)
191 vl_api_sw_interface_tap_v2_details_t *mp;
192 mp = vl_msg_api_alloc (sizeof (*mp));
193 clib_memset (mp, 0, sizeof (*mp));
194 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
195 mp->id = htonl (tap_if->id);
196 mp->sw_if_index = htonl (tap_if->sw_if_index);
197 clib_memcpy (mp->dev_name, tap_if->dev_name,
198 MIN (ARRAY_LEN (mp->dev_name) - 1,
199 strlen ((const char *) tap_if->dev_name)));
200 mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
201 mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
202 clib_memcpy (mp->host_mac_addr, tap_if->host_mac_addr, 6);
203 clib_memcpy (mp->host_if_name, tap_if->host_if_name,
204 MIN (ARRAY_LEN (mp->host_if_name) - 1,
205 strlen ((const char *) tap_if->host_if_name)));
206 clib_memcpy (mp->host_namespace, tap_if->host_namespace,
207 MIN (ARRAY_LEN (mp->host_namespace) - 1,
208 strlen ((const char *) tap_if->host_namespace)));
209 clib_memcpy (mp->host_bridge, tap_if->host_bridge,
210 MIN (ARRAY_LEN (mp->host_bridge) - 1,
211 strlen ((const char *) tap_if->host_bridge)));
212 if (tap_if->host_ip4_prefix_len)
213 clib_memcpy (&mp->host_ip4_addr, &tap_if->host_ip4_addr, 4);
214 mp->host_ip4_prefix_len = tap_if->host_ip4_prefix_len;
215 if (tap_if->host_ip6_prefix_len)
216 clib_memcpy (&mp->host_ip6_addr, &tap_if->host_ip6_addr, 16);
217 mp->host_ip6_prefix_len = tap_if->host_ip6_prefix_len;
219 mp->context = context;
220 vl_api_send_msg (reg, (u8 *) mp);
224 vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
228 vpe_api_main_t *am = &vpe_api_main;
229 vl_api_registration_t *reg;
230 tap_interface_details_t *tapifs = NULL;
231 tap_interface_details_t *tap_if = NULL;
233 reg = vl_api_client_index_to_registration (mp->client_index);
237 rv = tap_dump_ifs (&tapifs);
241 vec_foreach (tap_if, tapifs)
243 tap_send_sw_interface_details (am, reg, tap_if, mp->context);
249 #define vl_msg_name_crc_list
250 #include <vnet/vnet_all_api_h.h>
251 #undef vl_msg_name_crc_list
254 tap_setup_message_id_table (api_main_t * am)
256 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
257 foreach_vl_msg_name_crc_tapv2;
261 static clib_error_t *
262 tapv2_api_hookup (vlib_main_t * vm)
264 api_main_t *am = &api_main;
267 vl_msg_api_set_handlers(VL_API_##N, #n, \
268 vl_api_##n##_t_handler, \
270 vl_api_##n##_t_endian, \
271 vl_api_##n##_t_print, \
272 sizeof(vl_api_##n##_t), 1);
273 foreach_tapv2_api_msg;
277 * Set up the (msg_name, crc, message-id) table
279 tap_setup_message_id_table (am);
284 VLIB_API_INIT_FUNCTION (tapv2_api_hookup);
287 * fd.io coding-style-patch-verification: ON
290 * eval: (c-set-style "gnu")