2 *------------------------------------------------------------------
3 * tap_api.c - vnet tap device driver API support
5 * Copyright (c) 2016 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/unix/tuntap.h>
28 #include <vnet/unix/tapcli.h>
30 #include <vnet/vnet_msg_enum.h>
32 #define vl_typedefs /* define message structures */
33 #include <vnet/vnet_all_api_h.h>
36 #define vl_endianfun /* define message structures */
37 #include <vnet/vnet_all_api_h.h>
40 /* instantiate all the print functions we know about */
41 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
43 #include <vnet/vnet_all_api_h.h>
46 #include <vlibapi/api_helper_macros.h>
48 #define foreach_tap_api_msg \
49 _(TAP_CONNECT, tap_connect) \
50 _(TAP_MODIFY, tap_modify) \
51 _(TAP_DELETE, tap_delete) \
52 _(SW_INTERFACE_TAP_DUMP, sw_interface_tap_dump)
54 #define vl_msg_name_crc_list
55 #include <vnet/unix/tap.api.h>
56 #undef vl_msg_name_crc_list
59 * WARNING: replicated pending api refactor completion
62 send_sw_interface_event_deleted (vpe_api_main_t * am,
63 vl_api_registration_t * reg, u32 sw_if_index)
65 vl_api_sw_interface_event_t *mp;
67 mp = vl_msg_api_alloc (sizeof (*mp));
68 clib_memset (mp, 0, sizeof (*mp));
69 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
70 mp->sw_if_index = ntohl (sw_if_index);
72 mp->admin_up_down = 0;
75 vl_api_send_msg (reg, (u8 *) mp);
79 vl_api_tap_connect_t_handler (vl_api_tap_connect_t * mp)
81 vlib_main_t *vm = vlib_get_main ();
83 vl_api_tap_connect_reply_t *rmp;
84 vnet_main_t *vnm = vnet_get_main ();
85 vl_api_registration_t *reg;
86 u32 sw_if_index = (u32) ~ 0;
88 vnet_tap_connect_args_t _a, *ap = &_a;
90 clib_memset (ap, 0, sizeof (*ap));
92 ap->intfc_name = mp->tap_name;
93 if (!mp->use_random_mac)
94 ap->hwaddr_arg = mp->mac_address;
95 ap->renumber = mp->renumber;
96 ap->sw_if_indexp = &sw_if_index;
97 ap->custom_dev_instance = ntohl (mp->custom_dev_instance);
98 if (mp->ip4_address_set)
100 ap->ip4_address = (ip4_address_t *) mp->ip4_address;
101 ap->ip4_mask_width = mp->ip4_mask_width;
102 ap->ip4_address_set = 1;
104 if (mp->ip6_address_set)
106 ap->ip6_address = (ip6_address_t *) mp->ip6_address;
107 ap->ip6_mask_width = mp->ip6_mask_width;
108 ap->ip6_address_set = 1;
111 rv = vnet_tap_connect_renumber (vm, ap);
113 /* Add tag if supplied */
114 if (rv == 0 && mp->tag[0])
116 mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
117 tag = format (0, "%s%c", mp->tag, 0);
118 vnet_set_sw_interface_tag (vnm, tag, sw_if_index);
121 reg = vl_api_client_index_to_registration (mp->client_index);
125 rmp = vl_msg_api_alloc (sizeof (*rmp));
126 rmp->_vl_msg_id = ntohs (VL_API_TAP_CONNECT_REPLY);
127 rmp->context = mp->context;
128 rmp->retval = ntohl (rv);
129 rmp->sw_if_index = ntohl (sw_if_index);
131 vl_api_send_msg (reg, (u8 *) rmp);
135 vl_api_tap_modify_t_handler (vl_api_tap_modify_t * mp)
138 vl_api_tap_modify_reply_t *rmp;
139 vl_api_registration_t *reg;
140 u32 sw_if_index = (u32) ~ 0;
141 vlib_main_t *vm = vlib_get_main ();
142 vnet_tap_connect_args_t _a, *ap = &_a;
144 clib_memset (ap, 0, sizeof (*ap));
146 ap->orig_sw_if_index = ntohl (mp->sw_if_index);
147 ap->intfc_name = mp->tap_name;
148 if (!mp->use_random_mac)
149 ap->hwaddr_arg = mp->mac_address;
150 ap->sw_if_indexp = &sw_if_index;
151 ap->renumber = mp->renumber;
152 ap->custom_dev_instance = ntohl (mp->custom_dev_instance);
154 rv = vnet_tap_modify (vm, ap);
156 reg = vl_api_client_index_to_registration (mp->client_index);
160 rmp = vl_msg_api_alloc (sizeof (*rmp));
161 rmp->_vl_msg_id = ntohs (VL_API_TAP_MODIFY_REPLY);
162 rmp->context = mp->context;
163 rmp->retval = ntohl (rv);
164 rmp->sw_if_index = ntohl (sw_if_index);
166 vl_api_send_msg (reg, (u8 *) rmp);
170 vl_api_tap_delete_t_handler (vl_api_tap_delete_t * mp)
172 vlib_main_t *vm = vlib_get_main ();
174 vpe_api_main_t *vam = &vpe_api_main;
175 vl_api_tap_delete_reply_t *rmp;
176 vl_api_registration_t *reg;
177 u32 sw_if_index = ntohl (mp->sw_if_index);
179 rv = vnet_tap_delete (vm, sw_if_index);
182 vnet_main_t *vnm = vnet_get_main ();
183 vnet_clear_sw_interface_tag (vnm, sw_if_index);
186 reg = vl_api_client_index_to_registration (mp->client_index);
190 rmp = vl_msg_api_alloc (sizeof (*rmp));
191 rmp->_vl_msg_id = ntohs (VL_API_TAP_DELETE_REPLY);
192 rmp->context = mp->context;
193 rmp->retval = ntohl (rv);
195 vl_api_send_msg (reg, (u8 *) rmp);
198 send_sw_interface_event_deleted (vam, reg, sw_if_index);
202 send_sw_interface_tap_details (vpe_api_main_t * am,
203 vl_api_registration_t * reg,
204 tapcli_interface_details_t * tap_if,
207 vl_api_sw_interface_tap_details_t *mp;
208 mp = vl_msg_api_alloc (sizeof (*mp));
209 clib_memset (mp, 0, sizeof (*mp));
210 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_TAP_DETAILS);
211 mp->sw_if_index = ntohl (tap_if->sw_if_index);
212 strncpy ((char *) mp->dev_name,
213 (char *) tap_if->dev_name, ARRAY_LEN (mp->dev_name) - 1);
214 mp->context = context;
216 vl_api_send_msg (reg, (u8 *) mp);
220 vl_api_sw_interface_tap_dump_t_handler (vl_api_sw_interface_tap_dump_t * mp)
223 vpe_api_main_t *am = &vpe_api_main;
224 vl_api_registration_t *reg;
225 tapcli_interface_details_t *tapifs = NULL;
226 tapcli_interface_details_t *tap_if = NULL;
228 reg = vl_api_client_index_to_registration (mp->client_index);
232 rv = vnet_tap_dump_ifs (&tapifs);
236 vec_foreach (tap_if, tapifs)
238 send_sw_interface_tap_details (am, reg, tap_if, mp->context);
245 setup_message_id_table (api_main_t * am)
247 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
248 foreach_vl_msg_name_crc_tap;
252 static clib_error_t *
253 tap_api_hookup (vlib_main_t * vm)
255 api_main_t *am = &api_main;
258 vl_msg_api_set_handlers(VL_API_##N, #n, \
259 vl_api_##n##_t_handler, \
261 vl_api_##n##_t_endian, \
262 vl_api_##n##_t_print, \
263 sizeof(vl_api_##n##_t), 1);
268 * Set up the (msg_name, crc, message-id) table
270 setup_message_id_table (am);
275 VLIB_API_INIT_FUNCTION (tap_api_hookup);
278 * fd.io coding-style-patch-verification: ON
281 * eval: (c-set-style "gnu")