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;
153 if (args.is_master == 0)
155 args.rx_queues = MEMIF_DEFAULT_RX_QUEUES;
156 args.tx_queues = MEMIF_DEFAULT_TX_QUEUES;
159 args.rx_queues = mp->rx_queues;
163 args.tx_queues = mp->tx_queues;
170 ring_size = ntohl (mp->ring_size);
172 if (!is_pow2 (ring_size))
174 rv = VNET_API_ERROR_INVALID_ARGUMENT;
177 args.log2_ring_size = min_log2 (ring_size);
180 args.buffer_size = MEMIF_DEFAULT_BUFFER_SIZE;
183 args.buffer_size = ntohs (mp->buffer_size);
187 mac_address_decode (mp->hw_addr, &mac);
188 if (memcmp (&mac, empty_hw_addr, 6) != 0)
190 memcpy (args.hw_addr, &mac, 6);
191 args.hw_addr_set = 1;
194 rv = memif_create_if (vm, &args);
196 vec_free (args.secret);
200 REPLY_MACRO2 (VL_API_MEMIF_CREATE_REPLY,
202 rmp->sw_if_index = htonl (args.sw_if_index);
208 * @brief Message handler for memif_delete API.
209 * @param mp vl_api_memif_delete_t * mp the api message
212 vl_api_memif_delete_t_handler (vl_api_memif_delete_t * mp)
214 memif_main_t *mm = &memif_main;
215 vlib_main_t *vm = vlib_get_main ();
216 vnet_main_t *vnm = vnet_get_main ();
217 vl_api_memif_delete_reply_t *rmp;
218 vnet_hw_interface_t *hi;
223 vnet_get_sup_hw_interface_api_visible_or_null (vnm,
224 ntohl (mp->sw_if_index));
226 if (hi == NULL || memif_device_class.index != hi->dev_class_index)
227 rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
230 mif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
231 rv = memif_delete_if (vm, mif);
234 REPLY_MACRO (VL_API_MEMIF_DELETE_REPLY);
238 send_memif_details (vl_api_registration_t * reg,
240 vnet_sw_interface_t * swif,
241 u8 * interface_name, u32 context)
243 vl_api_memif_details_t *mp;
244 vnet_main_t *vnm = vnet_get_main ();
245 memif_main_t *mm = &memif_main;
246 vnet_hw_interface_t *hwif;
247 memif_socket_file_t *msf;
249 hwif = vnet_get_sup_hw_interface (vnm, swif->sw_if_index);
251 mp = vl_msg_api_alloc (sizeof (*mp));
252 clib_memset (mp, 0, sizeof (*mp));
254 mp->_vl_msg_id = htons (VL_API_MEMIF_DETAILS + mm->msg_id_base);
255 mp->context = context;
257 mp->sw_if_index = htonl (swif->sw_if_index);
258 strncpy ((char *) mp->if_name,
259 (char *) interface_name, ARRAY_LEN (mp->if_name) - 1);
261 if (hwif->hw_address)
263 mac_address_encode ((mac_address_t *) hwif->hw_address, mp->hw_addr);
266 mp->id = clib_host_to_net_u32 (mif->id);
268 msf = pool_elt_at_index (mm->socket_files, mif->socket_file_index);
269 mp->socket_id = clib_host_to_net_u32 (msf->socket_id);
272 (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) ? MEMIF_ROLE_API_SLAVE :
273 MEMIF_ROLE_API_MASTER;
274 mp->role = htonl (mp->role);
275 mp->mode = htonl (mif->mode);
276 mp->ring_size = htonl (1 << mif->run.log2_ring_size);
277 mp->buffer_size = htons (mif->run.buffer_size);
278 mp->zero_copy = (mif->flags & MEMIF_IF_FLAG_ZERO_COPY) ? 1 : 0;
281 mp->flags |= (swif->flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
282 IF_STATUS_API_FLAG_ADMIN_UP : 0;
283 mp->flags |= (hwif->flags & VNET_HW_INTERFACE_FLAG_LINK_UP) ?
284 IF_STATUS_API_FLAG_LINK_UP : 0;
285 mp->flags = htonl (mp->flags);
288 vl_api_send_msg (reg, (u8 *) mp);
292 * @brief Message handler for memif_dump API.
293 * @param mp vl_api_memif_dump_t * mp the api message
296 vl_api_memif_dump_t_handler (vl_api_memif_dump_t * mp)
298 memif_main_t *mm = &memif_main;
299 vnet_main_t *vnm = vnet_get_main ();
300 vnet_sw_interface_t *swif;
303 vl_api_registration_t *reg;
305 reg = vl_api_client_index_to_registration (mp->client_index);
310 pool_foreach (mif, mm->interfaces,
312 swif = vnet_get_sw_interface (vnm, mif->sw_if_index);
314 if_name = format (if_name, "%U%c",
315 format_vnet_sw_interface_name,
318 send_memif_details (reg, mif, swif, if_name, mp->context);
319 _vec_len (if_name) = 0;
327 send_memif_socket_filename_details (vl_api_registration_t * reg,
329 u8 * socket_filename, u32 context)
331 vl_api_memif_socket_filename_details_t *mp;
332 memif_main_t *mm = &memif_main;
334 mp = vl_msg_api_alloc (sizeof (*mp));
335 clib_memset (mp, 0, sizeof (*mp));
337 mp->_vl_msg_id = htons (VL_API_MEMIF_SOCKET_FILENAME_DETAILS
339 mp->context = context;
341 mp->socket_id = clib_host_to_net_u32 (socket_id);
342 strncpy ((char *) mp->socket_filename,
343 (char *) socket_filename, ARRAY_LEN (mp->socket_filename) - 1);
345 vl_api_send_msg (reg, (u8 *) mp);
349 * @brief Message handler for memif_socket_filename_dump API.
350 * @param mp vl_api_memif_socket_filename_dump_t api message
353 vl_api_memif_socket_filename_dump_t_handler
354 (vl_api_memif_socket_filename_dump_t * mp)
356 memif_main_t *mm = &memif_main;
357 vl_api_registration_t *reg;
361 reg = vl_api_client_index_to_registration (mp->client_index);
366 hash_foreach (sock_id, msf_idx, mm->socket_file_index_by_sock_id,
368 memif_socket_file_t *msf;
371 msf = pool_elt_at_index(mm->socket_files, msf_idx);
372 filename = msf->filename;
373 send_memif_socket_filename_details(reg, sock_id, filename, mp->context);
378 #define vl_msg_name_crc_list
379 #include <memif/memif_all_api_h.h>
380 #undef vl_msg_name_crc_list
383 setup_message_id_table (memif_main_t * mm, api_main_t * am)
385 #define _(id,n,crc) \
386 vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id + mm->msg_id_base);
387 foreach_vl_msg_name_crc_memif;
391 /* Set up the API message handling tables */
393 memif_plugin_api_hookup (vlib_main_t * vm)
395 memif_main_t *mm = &memif_main;
396 api_main_t *am = &api_main;
399 /* Construct the API name */
400 name = format (0, "memif_%08x%c", api_version, 0);
402 /* Ask for a correctly-sized block of API message decode slots */
403 mm->msg_id_base = vl_msg_api_get_msg_ids
404 ((char *) name, VL_MSG_FIRST_AVAILABLE);
407 vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base), \
409 vl_api_##n##_t_handler, \
411 vl_api_##n##_t_endian, \
412 vl_api_##n##_t_print, \
413 sizeof(vl_api_##n##_t), 1);
414 foreach_memif_plugin_api_msg;
418 * Set up the (msg_name, crc, message-id) table
420 setup_message_id_table (mm, am);
427 * fd.io coding-style-patch-verification: ON
430 * eval: (c-set-style "gnu")