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 vlib_main_t *vm = vlib_get_main ();
56 vl_api_tap_create_v2_reply_t *rmp;
57 vl_api_registration_t *reg;
58 tap_create_if_args_t _a, *ap = &_a;
60 memset (ap, 0, sizeof (*ap));
63 if (!mp->use_random_mac)
65 clib_memcpy (ap->mac_addr, mp->mac_address, 6);
68 ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
69 ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
70 ap->sw_if_index = (u32) ~ 0;
72 if (mp->host_if_name_set)
73 ap->host_if_name = mp->host_if_name;
75 if (mp->host_mac_addr_set)
77 clib_memcpy (ap->host_mac_addr, mp->host_mac_addr, 6);
81 if (mp->host_namespace_set)
82 ap->host_namespace = mp->host_namespace;
84 if (mp->host_bridge_set)
85 ap->host_bridge = mp->host_bridge;
87 if (mp->host_ip4_addr_set)
89 clib_memcpy (&ap->host_ip4_addr.as_u8, mp->host_ip4_addr, 4);
90 ap->host_ip4_prefix_len = mp->host_ip4_prefix_len;
93 if (mp->host_ip6_addr_set)
95 clib_memcpy (&ap->host_ip6_addr, mp->host_ip6_addr, 16);
96 ap->host_ip6_prefix_len = mp->host_ip6_prefix_len;
99 if (mp->host_ip4_gw_set)
101 clib_memcpy (&ap->host_ip4_gw, mp->host_ip4_gw, 4);
102 ap->host_ip4_gw_set = 1;
105 if (mp->host_ip6_gw_set)
107 clib_memcpy (&ap->host_ip6_gw, mp->host_ip6_gw, 16);
108 ap->host_ip6_gw_set = 1;
111 tap_create_if (vm, ap);
113 reg = vl_api_client_index_to_registration (mp->client_index);
117 rmp = vl_msg_api_alloc (sizeof (*rmp));
118 rmp->_vl_msg_id = ntohs (VL_API_TAP_CREATE_V2_REPLY);
119 rmp->context = mp->context;
120 rmp->retval = ntohl (ap->rv);
121 rmp->sw_if_index = ntohl (ap->sw_if_index);
123 vl_api_send_msg (reg, (u8 *) rmp);
127 tap_send_sw_interface_event_deleted (vpe_api_main_t * am,
128 vl_api_registration_t * reg,
131 vl_api_sw_interface_event_t *mp;
133 mp = vl_msg_api_alloc (sizeof (*mp));
134 memset (mp, 0, sizeof (*mp));
135 mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_EVENT);
136 mp->sw_if_index = ntohl (sw_if_index);
138 mp->admin_up_down = 0;
139 mp->link_up_down = 0;
141 vl_api_send_msg (reg, (u8 *) mp);
145 vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
147 vlib_main_t *vm = vlib_get_main ();
149 vpe_api_main_t *vam = &vpe_api_main;
150 vl_api_tap_delete_v2_reply_t *rmp;
151 vl_api_registration_t *reg;
152 u32 sw_if_index = ntohl (mp->sw_if_index);
154 rv = tap_delete_if (vm, sw_if_index);
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_DELETE_V2_REPLY);
162 rmp->context = mp->context;
163 rmp->retval = ntohl (rv);
165 vl_api_send_msg (reg, (u8 *) rmp);
168 tap_send_sw_interface_event_deleted (vam, reg, sw_if_index);
172 tap_send_sw_interface_details (vpe_api_main_t * am,
173 vl_api_registration_t * reg,
174 tap_interface_details_t * tap_if, u32 context)
176 vl_api_sw_interface_tap_v2_details_t *mp;
177 mp = vl_msg_api_alloc (sizeof (*mp));
178 memset (mp, 0, sizeof (*mp));
179 mp->_vl_msg_id = htons (VL_API_SW_INTERFACE_TAP_V2_DETAILS);
180 mp->id = htonl (tap_if->id);
181 mp->sw_if_index = htonl (tap_if->sw_if_index);
182 clib_memcpy (mp->dev_name, tap_if->dev_name,
183 MIN (ARRAY_LEN (mp->dev_name) - 1,
184 strlen ((const char *) tap_if->dev_name)));
185 mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
186 mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
187 clib_memcpy (mp->host_mac_addr, tap_if->host_mac_addr, 6);
188 clib_memcpy (mp->host_if_name, tap_if->host_if_name,
189 MIN (ARRAY_LEN (mp->host_if_name) - 1,
190 strlen ((const char *) tap_if->host_if_name)));
191 clib_memcpy (mp->host_namespace, tap_if->host_namespace,
192 MIN (ARRAY_LEN (mp->host_namespace) - 1,
193 strlen ((const char *) tap_if->host_namespace)));
194 clib_memcpy (mp->host_bridge, tap_if->host_bridge,
195 MIN (ARRAY_LEN (mp->host_bridge) - 1,
196 strlen ((const char *) tap_if->host_bridge)));
197 if (tap_if->host_ip4_prefix_len)
198 clib_memcpy (&mp->host_ip4_addr, &tap_if->host_ip4_addr, 4);
199 mp->host_ip4_prefix_len = tap_if->host_ip4_prefix_len;
200 if (tap_if->host_ip6_prefix_len)
201 clib_memcpy (&mp->host_ip6_addr, &tap_if->host_ip6_addr, 16);
202 mp->host_ip6_prefix_len = tap_if->host_ip6_prefix_len;
204 mp->context = context;
205 vl_api_send_msg (reg, (u8 *) mp);
209 vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
213 vpe_api_main_t *am = &vpe_api_main;
214 vl_api_registration_t *reg;
215 tap_interface_details_t *tapifs = NULL;
216 tap_interface_details_t *tap_if = NULL;
218 reg = vl_api_client_index_to_registration (mp->client_index);
222 rv = tap_dump_ifs (&tapifs);
226 vec_foreach (tap_if, tapifs)
228 tap_send_sw_interface_details (am, reg, tap_if, mp->context);
234 #define vl_msg_name_crc_list
235 #include <vnet/vnet_all_api_h.h>
236 #undef vl_msg_name_crc_list
239 tap_setup_message_id_table (api_main_t * am)
241 #define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
242 foreach_vl_msg_name_crc_tapv2;
246 static clib_error_t *
247 tapv2_api_hookup (vlib_main_t * vm)
249 api_main_t *am = &api_main;
252 vl_msg_api_set_handlers(VL_API_##N, #n, \
253 vl_api_##n##_t_handler, \
255 vl_api_##n##_t_endian, \
256 vl_api_##n##_t_print, \
257 sizeof(vl_api_##n##_t), 1);
258 foreach_tapv2_api_msg;
262 * Set up the (msg_name, crc, message-id) table
264 tap_setup_message_id_table (am);
269 VLIB_API_INIT_FUNCTION (tapv2_api_hookup);
272 * fd.io coding-style-patch-verification: ON
275 * eval: (c-set-style "gnu")