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)
103 unformat_memif_queues (unformat_input_t * input, va_list * args)
105 u32 *rx_queues = va_arg (*args, u32 *);
106 u32 *tx_queues = va_arg (*args, u32 *);
108 if (unformat (input, "rx-queues %u", rx_queues))
110 if (unformat (input, "tx-queues %u", tx_queues))
116 /* memif-create API */
118 api_memif_create (vat_main_t * vam)
120 unformat_input_t *i = vam->input;
121 vl_api_memif_create_t *mp;
123 u8 *socket_filename = 0;
128 u8 hw_addr[6] = { 0 };
129 u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES;
130 u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES;
132 u8 mode = MEMIF_INTERFACE_MODE_ETHERNET;
134 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
136 if (unformat (i, "id %u", &id))
138 else if (unformat (i, "socket %s", &socket_filename))
140 else if (unformat (i, "secret %s", &secret))
142 else if (unformat (i, "ring_size %u", &ring_size))
144 else if (unformat (i, "buffer_size %u", &buffer_size))
146 else if (unformat (i, "master"))
148 else if (unformat (i, "slave %U",
149 unformat_memif_queues, &rx_queues, &tx_queues))
151 else if (unformat (i, "mode ip"))
152 mode = MEMIF_INTERFACE_MODE_IP;
153 else if (unformat (i, "hw_addr %U", unformat_ethernet_address, hw_addr))
157 clib_warning ("unknown input '%U'", format_unformat_error, i);
162 if (!is_pow2 (ring_size))
164 errmsg ("ring size must be power of 2\n");
168 if (rx_queues > 255 || rx_queues < 1)
170 errmsg ("rx queue must be between 1 - 255\n");
174 if (tx_queues > 255 || tx_queues < 1)
176 errmsg ("tx queue must be between 1 - 255\n");
180 M (MEMIF_CREATE, mp);
183 mp->id = clib_host_to_net_u32 (id);
185 mp->ring_size = clib_host_to_net_u32 (ring_size);
186 mp->buffer_size = clib_host_to_net_u16 (buffer_size & 0xffff);
187 if (socket_filename != 0)
189 strncpy ((char *) mp->socket_filename, (char *) socket_filename, 127);
190 vec_free (socket_filename);
194 strncpy ((char *) mp->secret, (char *) secret, 16);
197 memcpy (mp->hw_addr, hw_addr, 6);
198 mp->rx_queues = rx_queues;
199 mp->tx_queues = tx_queues;
206 /* memif-create reply handler */
207 static void vl_api_memif_create_reply_t_handler
208 (vl_api_memif_create_reply_t * mp)
210 vat_main_t *vam = memif_test_main.vat_main;
211 i32 retval = ntohl (mp->retval);
215 fformat (vam->ofp, "created memif with sw_if_index %d\n",
216 ntohl (mp->sw_if_index));
219 vam->retval = retval;
220 vam->result_ready = 1;
223 /* memif-delete API */
225 api_memif_delete (vat_main_t * vam)
227 unformat_input_t *i = vam->input;
228 vl_api_memif_delete_t *mp;
230 u8 index_defined = 0;
233 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
235 if (unformat (i, "sw_if_index %u", &sw_if_index))
239 clib_warning ("unknown input '%U'", format_unformat_error, i);
246 errmsg ("missing sw_if_index\n");
250 M (MEMIF_DELETE, mp);
252 mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
261 api_memif_dump (vat_main_t * vam)
263 memif_test_main_t *mm = &memif_test_main;
264 vl_api_memif_dump_t *mp;
265 vl_api_control_ping_t *mp_ping;
268 if (vam->json_output)
270 clib_warning ("JSON output not supported for memif_dump");
277 /* Use a control ping for synchronization */
278 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
279 mp_ping->_vl_msg_id = htons (mm->ping_id);
280 mp_ping->client_index = vam->my_client_index;
282 fformat (vam->ofp, "Sending ping id=%d\n", mm->ping_id);
284 vam->result_ready = 0;
291 /* memif-details message handler */
292 static void vl_api_memif_details_t_handler (vl_api_memif_details_t * mp)
294 vat_main_t *vam = memif_test_main.vat_main;
296 fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
297 " id %u socket %s role %s\n"
298 " ring_size %u buffer_size %u\n"
299 " state %s link %s\n",
300 mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
301 mp->hw_addr, clib_net_to_host_u32 (mp->id), mp->socket_filename,
302 mp->role ? "slave" : "master",
303 ntohl (mp->ring_size), ntohs (mp->buffer_size),
304 mp->admin_up_down ? "up" : "down",
305 mp->link_up_down ? "up" : "down");
309 * List of messages that the api test plugin sends,
310 * and that the data plane plugin processes
312 #define foreach_vpe_api_msg \
313 _(memif_create, "[id <id>] [socket <path>] [ring_size <size>] " \
314 "[buffer_size <size>] [hw_addr <mac_address>] " \
315 "[secret <string>] [mode ip] <master|slave>") \
316 _(memif_delete, "<sw_if_index>") \
320 memif_vat_api_hookup (vat_main_t * vam)
322 memif_test_main_t *mm __attribute__ ((unused)) = &memif_test_main;
323 /* Hook up handlers for replies from the data plane plug-in */
325 vl_msg_api_set_handlers((VL_API_##N + mm->msg_id_base), \
327 vl_api_##n##_t_handler, \
329 vl_api_##n##_t_endian, \
330 vl_api_##n##_t_print, \
331 sizeof(vl_api_##n##_t), 1);
332 foreach_vpe_api_reply_msg;
335 /* API messages we can send */
337 hash_set_mem (vam->function_by_name, #n, api_##n);
342 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
348 vat_plugin_register (vat_main_t * vam)
350 memif_test_main_t *mm = &memif_test_main;
355 /* Ask the vpp engine for the first assigned message-id */
356 name = format (0, "memif_%08x%c", api_version, 0);
357 mm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
359 /* Get the control ping ID */
360 #define _(id,n,crc) \
361 const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
362 foreach_vl_msg_name_crc_vpe;
364 mm->ping_id = vl_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
366 if (mm->msg_id_base != (u16) ~0)
367 memif_vat_api_hookup (vam);