2 *------------------------------------------------------------------
3 * memif_api.c - memif api
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 <vlib/vlib.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <vlib/unix/unix.h>
23 #include <memif/memif.h>
24 #include <memif/private.h>
26 #include <vlibapi/api.h>
27 #include <vlibmemory/api.h>
29 #include <vnet/ip/ip_types_api.h>
30 #include <vnet/ethernet/ethernet_types_api.h>
32 /* define message IDs */
33 #include <memif/memif_msg_enum.h>
35 /* define message structures */
37 #include <memif/memif_all_api_h.h>
40 /* define generated endian-swappers */
42 #include <memif/memif_all_api_h.h>
45 /* instantiate all the print functions we know about */
46 #define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
48 #include <memif/memif_all_api_h.h>
51 /* Get the API version number */
52 #define vl_api_version(n,v) static u32 api_version=(v);
53 #include <memif/memif_all_api_h.h>
56 #define REPLY_MSG_ID_BASE mm->msg_id_base
57 #include <vlibapi/api_helper_macros.h>
59 #define foreach_memif_plugin_api_msg \
60 _(MEMIF_SOCKET_FILENAME_ADD_DEL, memif_socket_filename_add_del) \
61 _(MEMIF_CREATE, memif_create) \
62 _(MEMIF_DELETE, memif_delete) \
63 _(MEMIF_SOCKET_FILENAME_DUMP, memif_socket_filename_dump) \
64 _(MEMIF_DUMP, memif_dump) \
68 * @brief Message handler for memif_socket_filename_add_del API.
69 * @param mp the vl_api_memif_socket_filename_add_del_t API message
72 vl_api_memif_socket_filename_add_del_t_handler
73 (vl_api_memif_socket_filename_add_del_t * mp)
75 memif_main_t *mm = &memif_main;
80 vl_api_memif_socket_filename_add_del_reply_t *rmp;
87 socket_id = clib_net_to_host_u32 (mp->socket_id);
88 if (socket_id == 0 || socket_id == ~0)
90 rv = VNET_API_ERROR_INVALID_ARGUMENT;
96 mp->socket_filename[ARRAY_LEN (mp->socket_filename) - 1] = 0;
97 len = strlen ((char *) mp->socket_filename);
100 vec_validate (socket_filename, len);
101 memcpy (socket_filename, mp->socket_filename, len);
104 rv = memif_socket_filename_add_del (is_add, socket_id, socket_filename);
106 vec_free (socket_filename);
109 REPLY_MACRO (VL_API_MEMIF_SOCKET_FILENAME_ADD_DEL_REPLY);
114 * @brief Message handler for memif_create API.
115 * @param mp vl_api_memif_create_t * mp the api message
118 vl_api_memif_create_t_handler (vl_api_memif_create_t * mp)
120 memif_main_t *mm = &memif_main;
121 vlib_main_t *vm = vlib_get_main ();
122 vl_api_memif_create_reply_t *rmp;
123 memif_create_if_args_t args = { 0 };
124 u32 ring_size = MEMIF_DEFAULT_RING_SIZE;
125 static const u8 empty_hw_addr[6];
130 args.id = clib_net_to_host_u32 (mp->id);
133 args.socket_id = clib_net_to_host_u32 (mp->socket_id);
136 mp->secret[ARRAY_LEN (mp->secret) - 1] = 0;
137 if (strlen ((char *) mp->secret) > 0)
139 vec_validate (args.secret, strlen ((char *) mp->secret));
140 strncpy ((char *) args.secret, (char *) mp->secret,
141 vec_len (args.secret));
145 args.is_master = (ntohl (mp->role) == MEMIF_ROLE_API_MASTER);
148 args.mode = ntohl (mp->mode);
150 args.is_zero_copy = mp->no_zero_copy ? 0 : 1;
152 /* enable zero-copy */
153 args.is_zero_copy = 1;
156 if (args.is_master == 0)
158 args.rx_queues = MEMIF_DEFAULT_RX_QUEUES;
159 args.tx_queues = MEMIF_DEFAULT_TX_QUEUES;
162 args.rx_queues = mp->rx_queues;
166 args.tx_queues = mp->tx_queues;
173 ring_size = ntohl (mp->ring_size);
175 if (!is_pow2 (ring_size))
177 rv = VNET_API_ERROR_INVALID_ARGUMENT;
180 args.log2_ring_size = min_log2 (ring_size);
183 args.buffer_size = MEMIF_DEFAULT_BUFFER_SIZE;
186 args.buffer_size = ntohs (mp->buffer_size);
190 mac_address_decode (mp->hw_addr, &mac);
191 if (memcmp (&mac, empty_hw_addr, 6) != 0)
193 memcpy (args.hw_addr, &mac, 6);
194 args.hw_addr_set = 1;
197 rv = memif_create_if (vm, &args);
199 vec_free (args.secret);
203 REPLY_MACRO2 (VL_API_MEMIF_CREATE_REPLY,
205 rmp->sw_if_index = htonl (args.sw_if_index);
211 * @brief Message handler for memif_delete API.
212 * @param mp vl_api_memif_delete_t * mp the api message
215 vl_api_memif_delete_t_handler (vl_api_memif_delete_t * mp)
217 memif_main_t *mm = &memif_main;
218 vlib_main_t *vm = vlib_get_main ();
219 vnet_main_t *vnm = vnet_get_main ();
220 vl_api_memif_delete_reply_t *rmp;
221 vnet_hw_interface_t *hi;
226 vnet_get_sup_hw_interface_api_visible_or_null (vnm,
227 ntohl (mp->sw_if_index));
229 if (hi == NULL || memif_device_class.index != hi->dev_class_index)
230 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
233 mif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
234 rv = memif_delete_if (vm, mif);
237 REPLY_MACRO (VL_API_MEMIF_DELETE_REPLY);
241 send_memif_details (vl_api_registration_t * reg,
243 vnet_sw_interface_t * swif,
244 u8 * interface_name, u32 context)
246 vl_api_memif_details_t *mp;
247 vnet_main_t *vnm = vnet_get_main ();
248 memif_main_t *mm = &memif_main;
249 vnet_hw_interface_t *hwif;
250 memif_socket_file_t *msf;
252 hwif = vnet_get_sup_hw_interface (vnm, swif->sw_if_index);
254 mp = vl_msg_api_alloc (sizeof (*mp));
255 clib_memset (mp, 0, sizeof (*mp));
257 mp->_vl_msg_id = htons (VL_API_MEMIF_DETAILS + mm->msg_id_base);
258 mp->context = context;
260 mp->sw_if_index = htonl (swif->sw_if_index);
261 strncpy ((char *) mp->if_name,
262 (char *) interface_name, ARRAY_LEN (mp->if_name) - 1);
264 if (hwif->hw_address)
266 mac_address_encode ((mac_address_t *) hwif->hw_address, mp->hw_addr);
269 mp->id = clib_host_to_net_u32 (mif->id);
271 msf = pool_elt_at_index (mm->socket_files, mif->socket_file_index);
272 mp->socket_id = clib_host_to_net_u32 (msf->socket_id);
275 (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) ? MEMIF_ROLE_API_SLAVE :
276 MEMIF_ROLE_API_MASTER;
277 mp->role = htonl (mp->role);
278 mp->mode = htonl (mif->mode);
279 mp->ring_size = htonl (1 << mif->run.log2_ring_size);
280 mp->buffer_size = htons (mif->run.buffer_size);
281 mp->zero_copy = (mif->flags & MEMIF_IF_FLAG_ZERO_COPY) ? 1 : 0;
284 mp->flags |= (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
285 IF_STATUS_API_FLAG_ADMIN_UP : 0;
286 mp->flags |= (hwif->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
287 IF_STATUS_API_FLAG_LINK_UP : 0;
288 mp->flags = htonl (mp->flags);
291 vl_api_send_msg (reg, (u8 *) mp);
295 * @brief Message handler for memif_dump API.
296 * @param mp vl_api_memif_dump_t * mp the api message
299 vl_api_memif_dump_t_handler (vl_api_memif_dump_t * mp)
301 memif_main_t *mm = &memif_main;
302 vnet_main_t *vnm = vnet_get_main ();
303 vnet_sw_interface_t *swif;
306 vl_api_registration_t *reg;
308 reg = vl_api_client_index_to_registration (mp->client_index);
313 pool_foreach (mif, mm->interfaces,
315 swif = vnet_get_sw_interface (vnm, mif->sw_if_index);
317 if_name = format (if_name, "%U%c",
318 format_vnet_sw_interface_name,
321 send_memif_details (reg, mif, swif, if_name, mp->context);
322 _vec_len (if_name) = 0;
330 send_memif_socket_filename_details (vl_api_registration_t * reg,
332 u8 * socket_filename, u32 context)
334 vl_api_memif_socket_filename_details_t *mp;
335 memif_main_t *mm = &memif_main;
337 mp = vl_msg_api_alloc (sizeof (*mp));
338 clib_memset (mp, 0, sizeof (*mp));
340 mp->_vl_msg_id = htons (VL_API_MEMIF_SOCKET_FILENAME_DETAILS
342 mp->context = context;
344 mp->socket_id = clib_host_to_net_u32 (socket_id);
345 strncpy ((char *) mp->socket_filename,
346 (char *) socket_filename, ARRAY_LEN (mp->socket_filename) - 1);
348 vl_api_send_msg (reg, (u8 *) mp);
352 * @brief Message handler for memif_socket_filename_dump API.
353 * @param mp vl_api_memif_socket_filename_dump_t api message
356 vl_api_memif_socket_filename_dump_t_handler
357 (vl_api_memif_socket_filename_dump_t * mp)
359 memif_main_t *mm = &memif_main;
360 vl_api_registration_t *reg;
364 reg = vl_api_client_index_to_registration (mp->client_index);
369 hash_foreach (sock_id, msf_idx, mm->socket_file_index_by_sock_id,
371 memif_socket_file_t *msf;
374 msf = pool_elt_at_index(mm->socket_files, msf_idx);
375 filename = msf->filename;
376 send_memif_socket_filename_details(reg, sock_id, filename, mp->context);
381 #define vl_msg_name_crc_list
382 #include <memif/memif_all_api_h.h>
383 #undef vl_msg_name_crc_list
386 setup_message_id_table (memif_main_t * mm, api_main_t * am)
388 #define _(id,n,crc) \
389 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + mm->msg_id_base);
390 foreach_vl_msg_name_crc_memif;
394 /* Set up the API message handling tables */
396 memif_plugin_api_hookup (vlib_main_t * vm)
398 memif_main_t *mm = &memif_main;
399 api_main_t *am = &api_main;
402 /* Construct the API name */
403 name = format (0, "memif_%08x%c", api_version, 0);
405 /* Ask for a correctly-sized block of API message decode slots */
406 mm->msg_id_base = vl_msg_api_get_msg_ids
407 ((char *) name, VL_MSG_FIRST_AVAILABLE);
410 vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base), \
412 vl_api_##n##_t_handler, \
414 vl_api_##n##_t_endian, \
415 vl_api_##n##_t_print, \
416 sizeof(vl_api_##n##_t), 1);
417 foreach_memif_plugin_api_msg;
421 * Set up the (msg_name, crc, message-id) table
423 setup_message_id_table (mm, am);
430 * fd.io coding-style-patch-verification: ON
433 * eval: (c-set-style "gnu")