2 *------------------------------------------------------------------
3 * Copyright (c) 2018 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #include <vlib/vlib.h>
19 #include <vlib/unix/unix.h>
20 #include <vlib/pci/pci.h>
21 #include <vnet/ethernet/ethernet.h>
24 #include <vlibapi/api.h>
25 #include <vlibmemory/api.h>
27 #include <vppinfra/error.h>
28 #include <vmxnet3/vmxnet3.h>
30 #define __plugin_msg_base vmxnet3_test_main.msg_id_base
31 #include <vlibapi/vat_helper_macros.h>
33 /* declare message IDs */
34 #include <vmxnet3/vmxnet3_msg_enum.h>
36 /* Get CRC codes of the messages defined outside of this plugin */
37 #define vl_msg_name_crc_list
38 #include <vpp/api/vpe_all_api_h.h>
39 #undef vl_msg_name_crc_list
41 /* define message structures */
43 #include <vpp/api/vpe_all_api_h.h>
44 #include <vmxnet3/vmxnet3_all_api_h.h>
47 /* declare message handlers for each api */
49 #include <vmxnet3/vmxnet3_all_api_h.h>
52 /* instantiate all the print functions we know about */
53 #define vl_print(handle, ...)
55 #include <vmxnet3/vmxnet3_all_api_h.h>
58 /* get API version number */
59 #define vl_api_version(n,v) static u32 api_version=(v);
60 #include <vmxnet3/vmxnet3_all_api_h.h>
65 /* API message ID base */
69 } vmxnet3_test_main_t;
71 vmxnet3_test_main_t vmxnet3_test_main;
73 #define foreach_standard_reply_retval_handler \
74 _(vmxnet3_delete_reply)
77 static void vl_api_##n##_t_handler \
78 (vl_api_##n##_t * mp) \
80 vat_main_t * vam = vmxnet3_test_main.vat_main; \
81 i32 retval = ntohl(mp->retval); \
82 if (vam->async_mode) { \
83 vam->async_errors += (retval < 0); \
85 vam->retval = retval; \
86 vam->result_ready = 1; \
89 foreach_standard_reply_retval_handler;
92 #define foreach_vpe_api_reply_msg \
93 _(VMXNET3_CREATE_REPLY, vmxnet3_create_reply) \
94 _(VMXNET3_DELETE_REPLY, vmxnet3_delete_reply) \
95 _(VMXNET3_DETAILS, vmxnet3_details)
97 /* vmxnet3 create API */
99 api_vmxnet3_create (vat_main_t * vam)
101 unformat_input_t *i = vam->input;
102 vl_api_vmxnet3_create_t *mp;
103 vmxnet3_create_if_args_t args;
107 clib_memset (&args, 0, sizeof (vmxnet3_create_if_args_t));
109 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
111 if (unformat (i, "%U", unformat_vlib_pci_addr, &args.addr))
113 else if (unformat (i, "elog"))
114 args.enable_elog = 1;
115 else if (unformat (i, "bind"))
117 else if (unformat (i, "gso"))
119 else if (unformat (i, "rx-queue-size %u", &size))
120 args.rxq_size = size;
121 else if (unformat (i, "tx-queue-size %u", &size))
122 args.txq_size = size;
123 else if (unformat (i, "num-tx-queues %u", &size))
125 else if (unformat (i, "num-rx-queues %u", &size))
129 clib_warning ("unknown input '%U'", format_unformat_error, i);
134 M (VMXNET3_CREATE, mp);
136 mp->pci_addr = clib_host_to_net_u32 (args.addr.as_u32);
137 mp->enable_elog = clib_host_to_net_u16 (args.enable_elog);
138 mp->rxq_size = clib_host_to_net_u16 (args.rxq_size);
139 mp->txq_size = clib_host_to_net_u16 (args.txq_size);
140 mp->txq_num = clib_host_to_net_u16 (args.txq_num);
141 mp->rxq_num = clib_host_to_net_u16 (args.rxq_num);
142 mp->bind = args.bind;
143 mp->enable_gso = args.enable_gso;
151 /* vmxnet3-create reply handler */
153 vl_api_vmxnet3_create_reply_t_handler (vl_api_vmxnet3_create_reply_t * mp)
155 vat_main_t *vam = vmxnet3_test_main.vat_main;
156 i32 retval = ntohl (mp->retval);
160 fformat (vam->ofp, "created vmxnet3 with sw_if_index %d\n",
161 ntohl (mp->sw_if_index));
164 vam->retval = retval;
165 vam->result_ready = 1;
166 vam->regenerate_interface_table = 1;
169 /* vmxnet3 delete API */
171 api_vmxnet3_delete (vat_main_t * vam)
173 unformat_input_t *i = vam->input;
174 vl_api_vmxnet3_delete_t *mp;
176 u8 index_defined = 0;
179 while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
181 if (unformat (i, "sw_if_index %u", &sw_if_index))
185 clib_warning ("unknown input '%U'", format_unformat_error, i);
192 errmsg ("missing sw_if_index\n");
196 M (VMXNET3_DELETE, mp);
198 mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
207 api_vmxnet3_dump (vat_main_t * vam)
209 vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
210 vl_api_vmxnet3_dump_t *mp;
211 vl_api_control_ping_t *mp_ping;
214 if (vam->json_output)
216 clib_warning ("JSON output not supported for vmxnet3_dump");
220 M (VMXNET3_DUMP, mp);
223 /* Use a control ping for synchronization */
224 mp_ping = vl_msg_api_alloc_as_if_client (sizeof (*mp_ping));
225 mp_ping->_vl_msg_id = htons (vxm->ping_id);
226 mp_ping->client_index = vam->my_client_index;
228 fformat (vam->ofp, "Sending ping id=%d\n", vxm->ping_id);
230 vam->result_ready = 0;
238 format_pci_addr (u8 * s, va_list * va)
240 vlib_pci_addr_t *addr = va_arg (*va, vlib_pci_addr_t *);
241 return format (s, "%04x:%02x:%02x.%x", addr->domain, addr->bus,
242 addr->slot, addr->function);
246 vl_api_vmxnet3_details_t_handler (vl_api_vmxnet3_details_t * mp)
248 vat_main_t *vam = vmxnet3_test_main.vat_main;
249 u32 pci_addr = ntohl (mp->pci_addr);
252 fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
256 mp->if_name, ntohl (mp->sw_if_index), format_ethernet_address,
257 mp->hw_addr, mp->version,
258 format_pci_addr, &pci_addr, mp->admin_up_down ? "up" : "down");
259 for (qid = 0; qid < mp->rx_count; qid++)
261 vl_api_vmxnet3_rx_list_t *rx_list = &mp->rx_list[qid];
264 " RX completion next index %u\n"
265 " ring 0 size %u fill %u consume %u produce %u\n"
266 " ring 1 size %u fill %u consume %u produce %u\n",
268 ntohs (rx_list->rx_next),
269 ntohs (rx_list->rx_qsize), ntohs (rx_list->rx_fill[0]),
270 ntohs (rx_list->rx_consume[0]),
271 ntohs (rx_list->rx_produce[0]),
272 ntohs (rx_list->rx_qsize), ntohs (rx_list->rx_fill[1]),
273 ntohs (rx_list->rx_consume[1]),
274 ntohs (rx_list->rx_produce[1]));
276 for (qid = 0; qid < mp->tx_count; qid++)
278 vl_api_vmxnet3_tx_list_t *tx_list = &mp->tx_list[qid];
281 " TX completion next index %u\n"
282 " size %u consume %u produce %u\n",
284 ntohs (tx_list->tx_next),
285 ntohs (tx_list->tx_qsize), ntohs (tx_list->tx_consume),
286 ntohs (tx_list->tx_produce));
291 * List of messages that the api test plugin sends,
292 * and that the data plane plugin processes
294 #define foreach_vpe_api_msg \
295 _(vmxnet3_create, "<pci-address> [rx-queue-size <size>] " \
296 "[tx-queue-size <size>] [num-tx-queues <num>]" \
297 "[num-rx-queues <num>] [bind] [gso]") \
298 _(vmxnet3_delete, "sw_if_index <sw_if_index>") \
302 vmxnet3_vat_api_hookup (vat_main_t * vam)
304 vmxnet3_test_main_t *vxm __attribute__ ((unused)) = &vmxnet3_test_main;
306 vl_msg_api_set_handlers((VL_API_##N + vxm->msg_id_base), \
308 vl_api_##n##_t_handler, \
310 vl_api_##n##_t_endian, \
311 vl_api_##n##_t_print, \
312 sizeof(vl_api_##n##_t), 1);
313 foreach_vpe_api_reply_msg;
317 hash_set_mem (vam->function_by_name, #n, api_##n);
321 #define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
327 vat_plugin_register (vat_main_t * vam)
329 vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
334 name = format (0, "vmxnet3_%08x%c", api_version, 0);
335 vxm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
338 if (vxm->msg_id_base == (u16) ~ 0)
339 return clib_error_return (0, "vmxnet3 plugin not loaded...");
341 /* Get the control ping ID */
342 #define _(id,n,crc) \
343 const char *id ## _CRC __attribute__ ((unused)) = #n "_" #crc;
344 foreach_vl_msg_name_crc_vpe;
346 vxm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
348 vmxnet3_vat_api_hookup (vam);
354 * fd.io coding-style-patch-verification: ON
357 * eval: (c-set-style "gnu")