4 * Copyright (c) 2017 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
21 #include <vlibapi/api.h>
22 #include <vlibmemory/api.h>
24 #include <vppinfra/error.h>
25 #include <vnet/ip/ip.h>
26 #include <memif/memif.h>
27 #include <memif/private.h>
29 #define __plugin_msg_base memif_test_main.msg_id_base
30 #include <vlibapi/vat_helper_macros.h>
32 /* declare message IDs */
33 #include <memif/memif_msg_enum.h>
35 /* Get CRC codes of the messages defined outside of this plugin */
36 #define vl_msg_name_crc_list
37 #include <vpp/api/vpe_all_api_h.h>
38 #undef vl_msg_name_crc_list
40 /* define message structures */
42 #include <vpp/api/vpe_all_api_h.h>
43 #include <memif/memif_all_api_h.h>
46 /* declare message handlers for each api */
48 #define vl_endianfun /* define message structures */
49 #include <memif/memif_all_api_h.h>
52 /* instantiate all the print functions we know about */
53 #define vl_print(handle, ...)
55 #include <memif/memif_all_api_h.h>
58 /* Get the API version number. */
59 #define vl_api_version(n,v) static u32 api_version=(v);
60 #include <memif/memif_all_api_h.h>
65 /* API message ID base */
71 memif_test_main_t memif_test_main;
73 /* standard reply handlers */
74 #define foreach_standard_reply_retval_handler \
78 static void vl_api_##n##_t_handler \
79 (vl_api_##n##_t * mp) \
81 vat_main_t * vam = memif_test_main.vat_main; \
82 i32 retval = ntohl(mp->retval); \
83 if (vam->async_mode) { \
84 vam->async_errors += (retval < 0); \
86 vam->retval = retval; \
87 vam->result_ready = 1; \
90 foreach_standard_reply_retval_handler;
94 * Table of message reply handlers, must include boilerplate handlers
97 #define foreach_vpe_api_reply_msg \
98 _(MEMIF_CREATE_REPLY, memif_create_reply) \
99 _(MEMIF_DELETE_REPLY, memif_delete_reply) \
100 _(MEMIF_DETAILS, memif_details) \
101 _(MEMIF_SOCKET_FILENAME_DETAILS, memif_socket_filename_details) \
102 _(MEMIF_SOCKET_FILENAME_ADD_DEL_REPLY, memif_socket_filename_add_del_reply)
105 unformat_memif_queues (unformat_input_t * input, va_list * args)
107 u32 *rx_queues = va_arg (*args, u32 *);
108 u32 *tx_queues = va_arg (*args, u32 *);
110 if (unformat (input, "rx-queues %u", rx_queues))
112 if (unformat (input, "tx-queues %u", tx_queues))
118 /* memif_socket_filename_add_del API */
120 api_memif_socket_filename_add_del (vat_main_t * vam)
122 unformat_input_t *i = vam->input;
123 vl_api_memif_socket_filename_add_del_t *mp;
133 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
135 if (unformat (i, "id %u", &socket_id))
137 else if (unformat (i, "filename %s", &socket_filename))
139 else if (unformat (i, "del"))
141 else if (unformat (i, "add"))
145 vec_free (socket_filename);
146 clib_warning ("unknown input `%U'", format_unformat_error, i);
151 if (socket_id == 0 || socket_id == ~0)
153 vec_free (socket_filename);
154 errmsg ("Invalid socket id");
158 if (is_add && (!socket_filename || *socket_filename == 0))
160 vec_free (socket_filename);
161 errmsg ("Invalid socket filename");
165 M2 (MEMIF_SOCKET_FILENAME_ADD_DEL, mp, strlen ((char *) socket_filename));
168 mp->socket_id = htonl (socket_id);
169 char *p = (char *) &mp->socket_filename;
171 vl_api_to_api_string (strlen ((char *) socket_filename),
172 (char *) socket_filename, (vl_api_string_t *) p);
174 vec_free (socket_filename);
182 /* memif_socket_filename_add_del reply handler */
183 static void vl_api_memif_socket_filename_add_del_reply_t_handler
184 (vl_api_memif_socket_filename_add_del_reply_t * mp)
186 vat_main_t *vam = memif_test_main.vat_main;
187 i32 retval = ntohl (mp->retval);
189 vam->retval = retval;
190 vam->result_ready = 1;
191 vam->regenerate_interface_table = 1;
194 /* memif-create API */
196 api_memif_create (vat_main_t * vam)
198 unformat_input_t *i = vam->input;
199 vl_api_memif_create_t *mp;
206 u8 hw_addr[6] = { 0 };
207 u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES;
208 u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES;
210 u8 mode = MEMIF_INTERFACE_MODE_ETHERNET;
212 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
214 if (unformat (i, "id %u", &id))
216 else if (unformat (i, "socket-id %u", &socket_id))
218 else if (unformat (i, "secret %s", &secret))
220 else if (unformat (i, "ring_size %u", &ring_size))
222 else if (unformat (i, "buffer_size %u", &buffer_size))
224 else if (unformat (i, "master"))
226 else if (unformat (i, "slave %U",
227 unformat_memif_queues, &rx_queues, &tx_queues))
229 else if (unformat (i, "mode ip"))
230 mode = MEMIF_INTERFACE_MODE_IP;
231 else if (unformat (i, "hw_addr %U", unformat_ethernet_address, hw_addr))
235 clib_warning ("unknown input '%U'", format_unformat_error, i);
242 errmsg ("invalid socket-id\n");
246 if (!is_pow2 (ring_size))
248 errmsg ("ring size must be power of 2\n");
252 if (rx_queues > 255 || rx_queues < 1)
254 errmsg ("rx queue must be between 1 - 255\n");
258 if (tx_queues > 255 || tx_queues < 1)
260 errmsg ("tx queue must be between 1 - 255\n");
264 M2 (MEMIF_CREATE, mp, strlen ((char *) secret));
267 mp->id = clib_host_to_net_u32 (id);
269 mp->ring_size = clib_host_to_net_u32 (ring_size);
270 mp->buffer_size = clib_host_to_net_u16 (buffer_size & 0xffff);
271 mp->socket_id = clib_host_to_net_u32 (socket_id);
274 char *p = (char *) &mp->secret;
275 p += vl_api_to_api_string (strlen ((char *) secret), (char *) secret,
276 (vl_api_string_t *) p);
279 memcpy (mp->hw_addr, hw_addr, 6);
280 mp->rx_queues = rx_queues;
281 mp->tx_queues = tx_queues;
288 /* memif-create reply handler */
289 static void vl_api_memif_create_reply_t_handler
290 (vl_api_memif_create_reply_t * mp)
292 vat_main_t *vam = memif_test_main.vat_main;
293 i32 retval = ntohl (mp->retval);
297 fformat (vam->ofp, "created memif with sw_if_index %d\n",
298 ntohl (mp->sw_if_index));
301 vam->retval = retval;
302 vam->result_ready = 1;
303 vam->regenerate_interface_table = 1;
306 /* memif-delete API */
308 api_memif_delete (vat_main_t * vam)
310 unformat_input_t *i = vam->input;
311 vl_api_memif_delete_t *mp;
313 u8 index_defined = 0;
316 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
318 if (unformat (i, "sw_if_index %u", &sw_if_index))
322 clib_warning ("unknown input '%U'", format_unformat_error, i);
329 errmsg ("missing sw_if_index\n");
333 M (MEMIF_DELETE, mp);
335 mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
344 api_memif_dump (vat_main_t * vam)
346 memif_test_main_t *mm = &memif_test_main;
347 vl_api_memif_dump_t *mp;
348 vl_api_control_ping_t *mp_ping;
351 if (vam->json_output)
353 clib_warning ("JSON output not supported for memif_dump");
360 /* Use a control ping for synchronization */
361 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
362 mp_ping->_vl_msg_id = htons (mm->ping_id);
363 mp_ping->client_index = vam->my_client_index;
365 fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
367 vam->result_ready = 0;
374 /* memif-details message handler */
376 vl_api_memif_details_t_handler (vl_api_memif_details_t * mp)
378 vat_main_t *vam = memif_test_main.vat_main;
380 fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
381 " id %u socket-id %u role %s\n"
382 " ring_size %u buffer_size %u\n"
383 " state %s link %s\n",
384 mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
385 mp->hw_addr, clib_net_to_host_u32 (mp->id),
386 clib_net_to_host_u32 (mp->socket_id),
387 mp->role ? "slave" : "master",
388 ntohl (mp->ring_size), ntohs (mp->buffer_size),
389 (mp->flags & IF_STATUS_API_FLAG_ADMIN_UP) ? "up" : "down",
390 (mp->flags & IF_STATUS_API_FLAG_LINK_UP) ? "up" : "down");
393 /* memif_socket_filename_dump API */
395 api_memif_socket_filename_dump (vat_main_t * vam)
397 memif_test_main_t *mm = &memif_test_main;
398 vl_api_memif_socket_filename_dump_t *mp;
399 vl_api_control_ping_t *mp_ping;
402 if (vam->json_output)
405 ("JSON output not supported for memif_socket_filename_dump");
409 M (MEMIF_SOCKET_FILENAME_DUMP, mp);
412 /* Use a control ping for synchronization */
413 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
414 mp_ping->_vl_msg_id = htons (mm->ping_id);
415 mp_ping->client_index = vam->my_client_index;
417 fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
419 vam->result_ready = 0;
426 /* memif_socket_format_details message handler */
427 static void vl_api_memif_socket_filename_details_t_handler
428 (vl_api_memif_socket_filename_details_t * mp)
430 vat_main_t *vam = memif_test_main.vat_main;
433 "id %u : filename %s\n",
434 ntohl (mp->socket_id), mp->socket_filename);
438 * List of messages that the api test plugin sends,
439 * and that the data plane plugin processes
441 #define foreach_vpe_api_msg \
442 _(memif_create, "[id <id>] [socket-id <id>] [ring_size <size>] " \
443 "[buffer_size <size>] [hw_addr <mac_address>] " \
444 "[secret <string>] [mode ip] <master|slave>") \
445 _(memif_delete, "<sw_if_index>") \
447 _(memif_socket_filename_dump, "") \
448 _(memif_socket_filename_add_del, "[add|del] id <id> filename <file>")
451 memif_vat_api_hookup (vat_main_t * vam)
453 memif_test_main_t *mm __attribute__ ((unused)) = &memif_test_main;
454 /* Hook up handlers for replies from the data plane plug-in */
456 vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base), \
458 vl_api_##n##_t_handler, \
460 vl_api_##n##_t_endian, \
461 vl_api_##n##_t_print, \
462 sizeof(vl_api_##n##_t), 1);
463 foreach_vpe_api_reply_msg;
466 /* API messages we can send */
468 hash_set_mem (vam->function_by_name, #n, api_##n);
473 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
479 vat_plugin_register (vat_main_t * vam)
481 memif_test_main_t *mm = &memif_test_main;
486 /* Ask the vpp engine for the first assigned message-id */
487 name = format (0, "memif_%08x%c", api_version, 0);
488 mm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
491 if (mm->msg_id_base == (u16) ~ 0)
492 return clib_error_return (0, "memif plugin not loaded...");
494 /* Get the control ping ID */
495 #define _(id,n,crc) \
496 const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
497 foreach_vl_msg_name_crc_vpe;
499 mm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
501 if (mm->msg_id_base != (u16) ~ 0)
502 memif_vat_api_hookup (vam);
508 * fd.io coding-style-patch-verification: ON
511 * eval: (c-set-style "gnu")