vmxnet3_test.c revision 2985e0af
1/*
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:
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
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 *------------------------------------------------------------------
16 */
17
18#include <vlib/vlib.h>
19#include <vlib/unix/unix.h>
20#include <vlib/pci/pci.h>
21#include <vnet/ethernet/ethernet.h>
22
23#include <vat/vat.h>
24#include <vlibapi/api.h>
25#include <vlibmemory/api.h>
26
27#include <vppinfra/error.h>
28#include <vmxnet3/vmxnet3.h>
29
30#define __plugin_msg_base vmxnet3_test_main.msg_id_base
31#include <vlibapi/vat_helper_macros.h>
32
33/* declare message IDs */
34#include <vmxnet3/vmxnet3_msg_enum.h>
35
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
40
41/* define message structures */
42#define vl_typedefs
43#include <vpp/api/vpe_all_api_h.h>
44#include <vmxnet3/vmxnet3_all_api_h.h>
45#undef vl_typedefs
46
47/* declare message handlers for each api */
48#define vl_endianfun
49#include <vmxnet3/vmxnet3_all_api_h.h>
50#undef vl_endianfun
51
52/* instantiate all the print functions we know about */
53#define vl_print(handle, ...)
54#define vl_printfun
55#include <vmxnet3/vmxnet3_all_api_h.h>
56#undef vl_printfun
57
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>
61#undef vp_api_version
62
63typedef struct
64{
65  /* API message ID base */
66  u16 msg_id_base;
67  u32 ping_id;
68  vat_main_t *vat_main;
69} vmxnet3_test_main_t;
70
71vmxnet3_test_main_t vmxnet3_test_main;
72
73#define foreach_standard_reply_retval_handler		\
74_(vmxnet3_delete_reply)
75
76#define _(n)                                            \
77    static void vl_api_##n##_t_handler                  \
78    (vl_api_##n##_t * mp)                               \
79    {                                                   \
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);          \
84        } else {                                        \
85            vam->retval = retval;                       \
86            vam->result_ready = 1;                      \
87        }                                               \
88    }
89foreach_standard_reply_retval_handler;
90#undef _
91
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)
96
97/* vmxnet3 create API */
98static int
99api_vmxnet3_create (vat_main_t * vam)
100{
101  unformat_input_t *i = vam->input;
102  vl_api_vmxnet3_create_t *mp;
103  vmxnet3_create_if_args_t args;
104  int ret;
105  u32 size;
106
107  clib_memset (&args, 0, sizeof (vmxnet3_create_if_args_t));
108
109  while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
110    {
111      if (unformat (i, "%U", unformat_vlib_pci_addr, &args.addr))
112	;
113      else if (unformat (i, "elog"))
114	args.enable_elog = 1;
115      else if (unformat (i, "bind"))
116	args.bind = 1;
117      else if (unformat (i, "gso"))
118	args.enable_gso = 1;
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))
124	args.txq_num = size;
125      else if (unformat (i, "num-rx-queues %u", &size))
126	args.rxq_num = size;
127      else
128	{
129	  clib_warning ("unknown input '%U'", format_unformat_error, i);
130	  return -99;
131	}
132    }
133
134  M (VMXNET3_CREATE, mp);
135
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;
144
145  S (mp);
146  W (ret);
147
148  return ret;
149}
150
151/* vmxnet3-create reply handler */
152static void
153vl_api_vmxnet3_create_reply_t_handler (vl_api_vmxnet3_create_reply_t * mp)
154{
155  vat_main_t *vam = vmxnet3_test_main.vat_main;
156  i32 retval = ntohl (mp->retval);
157
158  if (retval == 0)
159    {
160      fformat (vam->ofp, "created vmxnet3 with sw_if_index %d\n",
161	       ntohl (mp->sw_if_index));
162    }
163
164  vam->retval = retval;
165  vam->result_ready = 1;
166  vam->regenerate_interface_table = 1;
167}
168
169/* vmxnet3 delete API */
170static int
171api_vmxnet3_delete (vat_main_t * vam)
172{
173  unformat_input_t *i = vam->input;
174  vl_api_vmxnet3_delete_t *mp;
175  u32 sw_if_index = 0;
176  u8 index_defined = 0;
177  int ret;
178
179  while (unformat_check_input (i) != UNFORMAT_END_OF_INPUT)
180    {
181      if (unformat (i, "sw_if_index %u", &sw_if_index))
182	index_defined = 1;
183      else
184	{
185	  clib_warning ("unknown input '%U'", format_unformat_error, i);
186	  return -99;
187	}
188    }
189
190  if (!index_defined)
191    {
192      errmsg ("missing sw_if_index\n");
193      return -99;
194    }
195
196  M (VMXNET3_DELETE, mp);
197
198  mp->sw_if_index = clib_host_to_net_u32 (sw_if_index);
199
200  S (mp);
201  W (ret);
202
203  return ret;
204}
205
206static int
207api_vmxnet3_dump (vat_main_t * vam)
208{
209  vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
210  vl_api_vmxnet3_dump_t *mp;
211  vl_api_control_ping_t *mp_ping;
212  int ret;
213
214  if (vam->json_output)
215    {
216      clib_warning ("JSON output not supported for vmxnet3_dump");
217      return -99;
218    }
219
220  M (VMXNET3_DUMP, mp);
221  S (mp);
222
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;
227
228  fformat (vam->ofp, "Sending ping id=%d\n", vxm->ping_id);
229
230  vam->result_ready = 0;
231  S (mp_ping);
232
233  W (ret);
234  return ret;
235}
236
237static u8 *
238format_pci_addr (u8 * s, va_list * va)
239{
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);
243}
244
245static void
246vl_api_vmxnet3_details_t_handler (vl_api_vmxnet3_details_t * mp)
247{
248  vat_main_t *vam = vmxnet3_test_main.vat_main;
249  u32 pci_addr = ntohl (mp->pci_addr);
250  u16 qid;
251
252  fformat (vam->ofp, "%s: sw_if_index %u mac %U\n"
253	   "   version: %u\n"
254	   "   PCI Address: %U\n"
255	   "   state %s\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++)
260    {
261      vl_api_vmxnet3_rx_list_t *rx_list = &mp->rx_list[qid];
262      fformat (vam->ofp,
263	       "   RX Queue %u\n"
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",
267	       qid,
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]));
275    }
276  for (qid = 0; qid < mp->tx_count; qid++)
277    {
278      vl_api_vmxnet3_tx_list_t *tx_list = &mp->tx_list[qid];
279      fformat (vam->ofp,
280	       "   TX Queue %u\n"
281	       "     TX completion next index %u\n"
282	       "     size %u consume %u produce %u\n",
283	       qid,
284	       ntohs (tx_list->tx_next),
285	       ntohs (tx_list->tx_qsize), ntohs (tx_list->tx_consume),
286	       ntohs (tx_list->tx_produce));
287    }
288}
289
290/*
291 * List of messages that the api test plugin sends,
292 * and that the data plane plugin processes
293 */
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>")                  \
299_(vmxnet3_dump, "")
300
301static void
302vmxnet3_vat_api_hookup (vat_main_t * vam)
303{
304  vmxnet3_test_main_t *vxm __attribute__ ((unused)) = &vmxnet3_test_main;
305#define _(N,n)                                                  \
306  vl_msg_api_set_handlers((VL_API_##N + vxm->msg_id_base),      \
307                          #n,                                   \
308                          vl_api_##n##_t_handler,               \
309                          vl_noop_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;
314#undef _
315
316#define _(n,h)							\
317  hash_set_mem (vam->function_by_name, #n, api_##n);
318  foreach_vpe_api_msg;
319#undef _
320
321#define _(n,h) hash_set_mem (vam->help_by_name, #n, h);
322  foreach_vpe_api_msg;
323#undef _
324}
325
326clib_error_t *
327vat_plugin_register (vat_main_t * vam)
328{
329  vmxnet3_test_main_t *vxm = &vmxnet3_test_main;
330  u8 *name;
331
332  vxm->vat_main = vam;
333
334  name = format (0, "vmxnet3_%08x%c", api_version, 0);
335  vxm->msg_id_base = vl_client_get_first_plugin_msg_id ((char *) name);
336  vec_free (name);
337
338  if (vxm->msg_id_base == (u16) ~ 0)
339    return clib_error_return (0, "vmxnet3 plugin not loaded...");
340
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;
345#undef _
346  vxm->ping_id = vl_msg_api_get_msg_index ((u8 *) (VL_API_CONTROL_PING_CRC));
347
348  vmxnet3_vat_api_hookup (vam);
349
350  return 0;
351}
352
353/*
354 * fd.io coding-style-patch-verification: ON
355 *
356 * Local Variables:
357 * eval: (c-set-style "gnu")
358 * End:
359 */
360