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 *------------------------------------------------------------------
19 #include <sys/ioctl.h>
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vlib/pci/pci.h>
25 #include <vnet/ethernet/ethernet.h>
27 #include <vmxnet3/vmxnet3.h>
30 vmxnet3_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
31 vlib_cli_command_t * cmd)
33 unformat_input_t _line_input, *line_input = &_line_input;
34 vmxnet3_create_if_args_t args;
37 /* Get a line of input. */
38 if (!unformat_user (input, unformat_line_input, line_input))
41 clib_memset (&args, 0, sizeof (args));
42 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
44 if (unformat (line_input, "%U", unformat_vlib_pci_addr, &args.addr))
46 else if (unformat (line_input, "gso"))
48 else if (unformat (line_input, "elog"))
50 else if (unformat (line_input, "bind"))
52 else if (unformat (line_input, "rx-queue-size %u", &size))
54 else if (unformat (line_input, "tx-queue-size %u", &size))
56 else if (unformat (line_input, "num-tx-queues %u", &size))
58 else if (unformat (line_input, "num-rx-queues %u", &size))
61 return clib_error_return (0, "unknown input `%U'",
62 format_unformat_error, input);
64 unformat_free (line_input);
67 vmxnet3_create_if (vm, &args);
69 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
70 vnet_get_main (), args.sw_if_index);
76 VLIB_CLI_COMMAND (vmxnet3_create_command, static) = {
77 .path = "create interface vmxnet3",
78 .short_help = "create interface vmxnet3 <pci-address>"
79 " [rx-queue-size <size>] [tx-queue-size <size>]"
80 " [num-tx-queues <number>] [num-rx-queues <number>] [bind]"
82 .function = vmxnet3_create_command_fn,
87 vmxnet3_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
88 vlib_cli_command_t * cmd)
90 unformat_input_t _line_input, *line_input = &_line_input;
92 vnet_hw_interface_t *hw;
93 vmxnet3_main_t *vmxm = &vmxnet3_main;
95 vnet_main_t *vnm = vnet_get_main ();
97 /* Get a line of input. */
98 if (!unformat_user (input, unformat_line_input, line_input))
101 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
103 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
105 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
109 return clib_error_return (0, "unknown input `%U'",
110 format_unformat_error, input);
112 unformat_free (line_input);
114 if (sw_if_index == ~0)
115 return clib_error_return (0,
116 "please specify interface name or sw_if_index");
118 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
119 if (hw == NULL || vmxnet3_device_class.index != hw->dev_class_index)
120 return clib_error_return (0, "not a vmxnet3 interface");
122 vd = pool_elt_at_index (vmxm->devices, hw->dev_instance);
124 vmxnet3_delete_if (vm, vd);
130 VLIB_CLI_COMMAND (vmxnet3_delete_command, static) = {
131 .path = "delete interface vmxnet3",
132 .short_help = "delete interface vmxnet3 "
133 "{<interface> | sw_if_index <sw_idx>}",
134 .function = vmxnet3_delete_command_fn,
138 static clib_error_t *
139 vmxnet3_test_command_fn (vlib_main_t * vm, unformat_input_t * input,
140 vlib_cli_command_t * cmd)
142 unformat_input_t _line_input, *line_input = &_line_input;
143 u32 sw_if_index = ~0;
144 vnet_hw_interface_t *hw;
145 vmxnet3_main_t *vmxm = &vmxnet3_main;
146 vmxnet3_device_t *vd;
147 vnet_main_t *vnm = vnet_get_main ();
148 int enable_elog = 0, disable_elog = 0;
150 /* Get a line of input. */
151 if (!unformat_user (input, unformat_line_input, line_input))
154 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
156 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
158 else if (unformat (line_input, "elog-on"))
160 else if (unformat (line_input, "elog-off"))
162 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
166 return clib_error_return (0, "unknown input `%U'",
167 format_unformat_error, input);
169 unformat_free (line_input);
171 if (sw_if_index == ~0)
172 return clib_error_return (0,
173 "please specify interface name or sw_if_index");
175 hw = vnet_get_sup_hw_interface_api_visible_or_null (vnm, sw_if_index);
176 if (hw == NULL || vmxnet3_device_class.index != hw->dev_class_index)
177 return clib_error_return (0, "not a vmxnet3 interface");
179 vd = pool_elt_at_index (vmxm->devices, hw->dev_instance);
182 vd->flags |= VMXNET3_DEVICE_F_ELOG;
185 vd->flags &= ~VMXNET3_DEVICE_F_ELOG;
191 VLIB_CLI_COMMAND (vmxnet3_test_command, static) = {
192 .path = "test vmxnet3",
193 .short_help = "test vmxnet3 <interface> | sw_if_index <sw_idx> [irq] "
194 "[elog-on] [elog-off]",
195 .function = vmxnet3_test_command_fn,
200 show_vmxnet3 (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr,
201 u8 show_one_table, u32 which, u8 show_one_slot, u32 slot)
204 vmxnet3_device_t *vd;
205 vnet_main_t *vnm = &vnet_main;
206 vmxnet3_main_t *vmxm = &vmxnet3_main;
207 vnet_hw_interface_t *hi;
209 vmxnet3_rx_desc *rxd;
210 vmxnet3_rx_comp *rx_comp;
212 vmxnet3_tx_desc *txd;
213 vmxnet3_tx_comp *tx_comp;
219 for (i = 0; i < vec_len (hw_if_indices); i++)
221 hi = vnet_get_hw_interface (vnm, hw_if_indices[i]);
222 vd = vec_elt_at_index (vmxm->devices, hi->dev_instance);
223 vlib_cli_output (vm, "Interface: %U (ifindex %d)",
224 format_vnet_hw_if_index_name, vnm, hw_if_indices[i],
226 vlib_cli_output (vm, " Version: %u", vd->version);
227 vlib_cli_output (vm, " GSO enable: %u", vd->gso_enable);
228 vlib_cli_output (vm, " PCI Address: %U", format_vlib_pci_addr,
230 vlib_cli_output (vm, " Mac Address: %U", format_ethernet_address,
232 vlib_cli_output (vm, " hw if index: %u", vd->hw_if_index);
233 vlib_cli_output (vm, " Device instance: %u", vd->dev_instance);
234 vlib_cli_output (vm, " Number of interrupts: %u", vd->num_intrs);
236 vec_foreach_index (qid, vd->rxqs)
238 rxq = vec_elt_at_index (vd->rxqs, qid);
241 vlib_cli_output (vm, " Queue %u (RX)", qid);
242 vlib_cli_output (vm, " RX completion next index %u",
243 rxq->rx_comp_ring.next);
244 vlib_cli_output (vm, " RX completion generation flag 0x%x",
245 rxq->rx_comp_ring.gen);
247 /* RX descriptors tables */
248 for (rid = 0; rid < VMXNET3_RX_RING_SIZE; rid++)
250 vmxnet3_rx_ring *ring = &rxq->rx_ring[rid];
253 " ring %u size %u fill %u "
254 "consume %u produce %u", rid,
255 rxq->size, ring->fill, ring->consume,
259 vlib_cli_output (vm, "RX descriptors table");
260 vlib_cli_output (vm, " %5s %18s %10s",
261 "slot", "address", "flags");
262 for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
264 rxd = &rxq->rx_desc[rid][desc_idx];
265 vlib_cli_output (vm, " %5u 0x%016llx 0x%08x",
266 desc_idx, rxd->address, rxd->flags);
269 else if (show_one_table)
271 if (((which == VMXNET3_SHOW_RX_DESC0) && (rid == 0)) ||
272 ((which == VMXNET3_SHOW_RX_DESC1) && (rid == 1)))
274 vlib_cli_output (vm, "RX descriptors table");
275 vlib_cli_output (vm, " %5s %18s %10s",
276 "slot", "address", "flags");
279 rxd = &rxq->rx_desc[rid][slot];
280 vlib_cli_output (vm, " %5u 0x%016llx 0x%08x",
281 slot, rxd->address, rxd->flags);
284 for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
286 rxd = &rxq->rx_desc[rid][desc_idx];
287 vlib_cli_output (vm, " %5u 0x%016llx 0x%08x",
288 desc_idx, rxd->address,
295 /* RX completion table */
298 vlib_cli_output (vm, "RX completion descriptors table");
299 vlib_cli_output (vm, " %5s %10s %10s %10s %10s",
300 "slot", "index", "rss", "len", "flags");
301 for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
303 rx_comp = &rxq->rx_comp[desc_idx];
304 vlib_cli_output (vm, " %5u 0x%08x %10u %10u 0x%08x",
305 desc_idx, rx_comp->index, rx_comp->rss,
306 rx_comp->len, rx_comp->flags);
309 else if (show_one_table)
311 if (which == VMXNET3_SHOW_RX_COMP)
313 vlib_cli_output (vm, "RX completion descriptors table");
314 vlib_cli_output (vm, " %5s %10s %10s %10s %10s",
315 "slot", "index", "rss", "len", "flags");
318 rx_comp = &rxq->rx_comp[slot];
319 vlib_cli_output (vm, " %5u 0x%08x %10u %10u 0x%08x",
320 slot, rx_comp->index, rx_comp->rss,
321 rx_comp->len, rx_comp->flags);
324 for (desc_idx = 0; desc_idx < rxq->size; desc_idx++)
326 rx_comp = &rxq->rx_comp[desc_idx];
328 " %5u 0x%08x %10u %10u 0x%08x",
329 desc_idx, rx_comp->index, rx_comp->rss,
330 rx_comp->len, rx_comp->flags);
336 vec_foreach_index (qid, vd->txqs)
338 txq = vec_elt_at_index (vd->txqs, qid);
339 vlib_cli_output (vm, " Queue %u (TX)", qid);
340 vlib_cli_output (vm, " TX completion next index %u",
341 txq->tx_comp_ring.next);
342 vlib_cli_output (vm, " TX completion generation flag 0x%x",
343 txq->tx_comp_ring.gen);
344 vlib_cli_output (vm, " size %u consume %u produce %u",
345 txq->size, txq->tx_ring.consume,
346 txq->tx_ring.produce);
349 vlib_cli_output (vm, "TX descriptors table");
350 vlib_cli_output (vm, " %5s %18s %10s %10s",
351 "slot", "address", "flags0", "flags1");
352 for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
354 txd = &txq->tx_desc[desc_idx];
355 vlib_cli_output (vm, " %5u 0x%016llx 0x%08x 0x%08x",
356 desc_idx, txd->address, txd->flags[0],
360 vlib_cli_output (vm, "TX completion descriptors table");
361 vlib_cli_output (vm, " %5s %10s %10s",
362 "slot", "index", "flags");
363 for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
365 tx_comp = &txq->tx_comp[desc_idx];
366 vlib_cli_output (vm, " %5u 0x%08x 0x%08x",
367 desc_idx, tx_comp->index, tx_comp->flags);
370 else if (show_one_table)
372 if (which == VMXNET3_SHOW_TX_DESC)
374 vlib_cli_output (vm, "TX descriptors table");
375 vlib_cli_output (vm, " %5s %18s %10s %10s",
376 "slot", "address", "flags0", "flags1");
379 txd = &txq->tx_desc[slot];
380 vlib_cli_output (vm, " %5u 0x%016llx 0x%08x 0x%08x",
381 slot, txd->address, txd->flags[0],
385 for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
387 txd = &txq->tx_desc[desc_idx];
388 vlib_cli_output (vm, " %5u 0x%016llx 0x%08x 0x%08x",
389 desc_idx, txd->address, txd->flags[0],
393 else if (which == VMXNET3_SHOW_TX_COMP)
395 vlib_cli_output (vm, "TX completion descriptors table");
396 vlib_cli_output (vm, " %5s %10s %10s",
397 "slot", "index", "flags");
400 tx_comp = &txq->tx_comp[slot];
401 vlib_cli_output (vm, " %5u 0x%08x 0x%08x",
402 slot, tx_comp->index, tx_comp->flags);
405 for (desc_idx = 0; desc_idx < txq->size; desc_idx++)
407 tx_comp = &txq->tx_comp[desc_idx];
408 vlib_cli_output (vm, " %5u 0x%08x 0x%08x",
409 desc_idx, tx_comp->index,
418 static clib_error_t *
419 show_vmxnet3_fn (vlib_main_t * vm, unformat_input_t * input,
420 vlib_cli_command_t * cmd)
422 vmxnet3_main_t *vmxm = &vmxnet3_main;
423 vnet_main_t *vnm = &vnet_main;
424 vmxnet3_device_t *vd;
425 clib_error_t *error = 0;
426 u32 hw_if_index, *hw_if_indices = 0;
427 vnet_hw_interface_t *hi = 0;
428 u8 show_descr = 0, show_one_table = 0, show_one_slot = 0;
429 u32 which = ~0, slot;
431 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
434 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
436 hi = vnet_get_hw_interface (vnm, hw_if_index);
437 if (vmxnet3_device_class.index != hi->dev_class_index)
439 error = clib_error_return (0, "unknown input `%U'",
440 format_unformat_error, input);
443 vec_add1 (hw_if_indices, hw_if_index);
445 else if (unformat (input, "desc"))
449 vmxnet3_device_t *vd =
450 vec_elt_at_index (vmxm->devices, hi->dev_instance);
452 if (unformat (input, "rx-comp"))
455 which = VMXNET3_SHOW_RX_COMP;
456 if (unformat (input, "%u", &slot))
458 vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, 0);
460 if (slot >= rxq->size)
462 error = clib_error_return (0,
463 "slot size must be < rx queue "
464 "size %u", rxq->size);
470 else if (unformat (input, "rx-desc-0"))
473 which = VMXNET3_SHOW_RX_DESC0;
474 if (unformat (input, "%u", &slot))
476 vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, 0);
478 if (slot >= rxq->size)
480 error = clib_error_return (0,
481 "slot size must be < rx queue "
482 "size %u", rxq->size);
488 else if (unformat (input, "rx-desc-1"))
491 which = VMXNET3_SHOW_RX_DESC1;
492 if (unformat (input, "%u", &slot))
494 vmxnet3_rxq_t *rxq = vec_elt_at_index (vd->rxqs, 0);
496 if (slot >= rxq->size)
498 error = clib_error_return (0,
499 "slot size must be < rx queue "
500 "size %u", rxq->size);
506 else if (unformat (input, "tx-comp"))
509 which = VMXNET3_SHOW_TX_COMP;
510 if (unformat (input, "%u", &slot))
512 vmxnet3_txq_t *txq = vec_elt_at_index (vd->txqs, 0);
514 if (slot >= txq->size)
516 error = clib_error_return (0,
517 "slot size must be < tx queue "
518 "size %u", txq->size);
524 else if (unformat (input, "tx-desc"))
527 which = VMXNET3_SHOW_TX_DESC;
528 if (unformat (input, "%u", &slot))
530 vmxnet3_txq_t *txq = vec_elt_at_index (vd->txqs, 0);
532 if (slot >= txq->size)
534 error = clib_error_return (0,
535 "slot size must be < tx queue "
536 "size %u", txq->size);
544 error = clib_error_return (0, "unknown input `%U'",
545 format_unformat_error, input);
551 error = clib_error_return (0, "unknown input `%U'",
552 format_unformat_error, input);
557 if (vec_len (hw_if_indices) == 0)
559 pool_foreach (vd, vmxm->devices,
560 vec_add1 (hw_if_indices, vd->hw_if_index);
564 show_vmxnet3 (vm, hw_if_indices, show_descr, show_one_table, which,
565 show_one_slot, slot);
568 vec_free (hw_if_indices);
573 VLIB_CLI_COMMAND (show_vmxnet3_command, static) = {
574 .path = "show vmxnet3",
575 .short_help = "show vmxnet3 [[<interface>] ([desc] | ([rx-comp] | "
576 "[rx-desc-0] | [rx-desc-1] | [tx-comp] | [tx-desc]) [<slot>])]",
577 .function = show_vmxnet3_fn,
582 vmxnet3_cli_init (vlib_main_t * vm)
584 vmxnet3_main_t *vmxm = &vmxnet3_main;
586 /* initialize binary API */
587 vmxnet3_plugin_api_hookup (vm);
589 vmxm->log_default = vlib_log_register_class ("vmxnet3", 0);
593 VLIB_INIT_FUNCTION (vmxnet3_cli_init);
596 * fd.io coding-style-patch-verification: ON
599 * eval: (c-set-style "gnu")