2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
15 #include <vnet/vnet.h>
16 #include <vppinfra/vec.h>
17 #include <vppinfra/error.h>
18 #include <vppinfra/format.h>
19 #include <vppinfra/xxhash.h>
21 #include <vnet/ethernet/ethernet.h>
22 #include <dpdk/device/dpdk.h>
23 #include <vnet/classify/vnet_classify.h>
24 #include <vnet/mpls/packet.h>
26 #include <dpdk/device/dpdk_priv.h>
30 * @brief CLI for DPDK Abstraction Layer and pcap Tx Trace.
32 * This file contains the source code for CLI for DPDK
33 * Abstraction Layer and pcap Tx Trace.
38 get_hqos (u32 hw_if_index, u32 subport_id, dpdk_device_t ** xd,
39 dpdk_device_config_t ** devconf)
41 dpdk_main_t *dm = &dpdk_main;
42 vnet_hw_interface_t *hw;
43 struct rte_eth_dev_info dev_info;
45 clib_error_t *error = NULL;
48 if (hw_if_index == (u32) ~ 0)
50 error = clib_error_return (0, "please specify valid interface name");
56 error = clib_error_return (0, "Invalid subport");
60 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
61 *xd = vec_elt_at_index (dm->devices, hw->dev_instance);
63 rte_eth_dev_info_get ((*xd)->device_index, &dev_info);
65 { /* bonded interface has no pci info */
66 vlib_pci_addr_t pci_addr;
68 pci_addr.domain = dev_info.pci_dev->addr.domain;
69 pci_addr.bus = dev_info.pci_dev->addr.bus;
70 pci_addr.slot = dev_info.pci_dev->addr.devid;
71 pci_addr.function = dev_info.pci_dev->addr.function;
74 hash_get (dm->conf->device_config_index_by_pci_addr, pci_addr.as_u32);
78 (*devconf) = pool_elt_at_index (dm->conf->dev_confs, p[0]);
80 (*devconf) = &dm->conf->default_devconf;
87 pcap_trace_command_fn (vlib_main_t * vm,
88 unformat_input_t * input, vlib_cli_command_t * cmd)
90 #define PCAP_DEF_PKT_TO_CAPTURE (100)
92 unformat_input_t _line_input, *line_input = &_line_input;
93 dpdk_main_t *dm = &dpdk_main;
95 u8 *chroot_filename = 0;
99 clib_error_t *error = 0;
101 /* Get a line of input. */
102 if (!unformat_user (input, unformat_line_input, line_input))
105 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
107 if (unformat (line_input, "on"))
109 if (dm->tx_pcap_enable == 0)
115 vlib_cli_output (vm, "pcap tx capture already on...");
120 else if (unformat (line_input, "off"))
122 if (dm->tx_pcap_enable)
124 vlib_cli_output (vm, "captured %d pkts...",
125 dm->pcap_main.n_packets_captured + 1);
126 if (dm->pcap_main.n_packets_captured)
128 dm->pcap_main.n_packets_to_capture =
129 dm->pcap_main.n_packets_captured;
130 error = pcap_write (&dm->pcap_main);
132 clib_error_report (error);
134 vlib_cli_output (vm, "saved to %s...", dm->pcap_filename);
137 dm->tx_pcap_enable = 0;
141 vlib_cli_output (vm, "pcap tx capture already off...");
146 else if (unformat (line_input, "max %d", &max))
148 if (dm->tx_pcap_enable)
151 "can't change max value while pcap tx capture active...");
156 else if (unformat (line_input, "intfc %U",
157 unformat_vnet_sw_interface, dm->vnet_main,
158 &dm->pcap_sw_if_index))
161 else if (unformat (line_input, "intfc any"))
163 dm->pcap_sw_if_index = 0;
165 else if (unformat (line_input, "file %s", &filename))
167 if (dm->tx_pcap_enable)
170 "can't change file while pcap tx capture active...");
175 /* Brain-police user path input */
176 if (strstr ((char *) filename, "..")
177 || index ((char *) filename, '/'))
179 vlib_cli_output (vm, "illegal characters in filename '%s'",
182 "Hint: Only filename, do not enter directory structure.");
188 chroot_filename = format (0, "/tmp/%s%c", filename, 0);
191 else if (unformat (line_input, "status"))
193 if (dm->pcap_sw_if_index == 0)
195 vlib_cli_output (vm, "max is %d for any interface to file %s",
197 pcap_pkts_to_capture ? dm->pcap_pkts_to_capture
198 : PCAP_DEF_PKT_TO_CAPTURE,
200 pcap_filename ? dm->pcap_filename : (u8 *)
205 vlib_cli_output (vm, "max is %d for interface %U to file %s",
207 pcap_pkts_to_capture ? dm->pcap_pkts_to_capture
208 : PCAP_DEF_PKT_TO_CAPTURE,
209 format_vnet_sw_if_index_name, dm->vnet_main,
210 dm->pcap_sw_if_index,
212 pcap_filename ? dm->pcap_filename : (u8 *)
216 if (dm->tx_pcap_enable == 0)
218 vlib_cli_output (vm, "pcap tx capture is off...");
222 vlib_cli_output (vm, "pcap tx capture is on: %d of %d pkts...",
223 dm->pcap_main.n_packets_captured,
224 dm->pcap_main.n_packets_to_capture);
231 error = clib_error_return (0, "unknown input `%U'",
232 format_unformat_error, line_input);
237 unformat_free (line_input);
242 /* Since no error, save configured values. */
245 if (dm->pcap_filename)
246 vec_free (dm->pcap_filename);
247 vec_add1 (chroot_filename, 0);
248 dm->pcap_filename = chroot_filename;
252 dm->pcap_pkts_to_capture = max;
257 if (dm->pcap_filename == 0)
258 dm->pcap_filename = format (0, "/tmp/vpe.pcap%c", 0);
260 memset (&dm->pcap_main, 0, sizeof (dm->pcap_main));
261 dm->pcap_main.file_name = (char *) dm->pcap_filename;
262 dm->pcap_main.n_packets_to_capture = PCAP_DEF_PKT_TO_CAPTURE;
263 if (dm->pcap_pkts_to_capture)
264 dm->pcap_main.n_packets_to_capture = dm->pcap_pkts_to_capture;
266 dm->pcap_main.packet_type = PCAP_PACKET_TYPE_ethernet;
267 dm->tx_pcap_enable = 1;
268 vlib_cli_output (vm, "pcap tx capture on...");
271 else if (chroot_filename)
272 vec_free (chroot_filename);
279 * This command is used to start or stop a packet capture, or show
280 * the status of packet capture.
282 * This command has the following optional parameters:
284 * - <b>on|off</b> - Used to start or stop a packet capture.
286 * - <b>max <nn></b> - Depth of local buffer. Once '<em>nn</em>' number
287 * of packets have been received, buffer is flushed to file. Once another
288 * '<em>nn</em>' number of packets have been received, buffer is flushed
289 * to file, overwriting previous write. If not entered, value defaults
290 * to 100. Can only be updated if packet capture is off.
292 * - <b>intfc <interface>|any</b> - Used to specify a given interface,
293 * or use '<em>any</em>' to run packet capture on all interfaces.
294 * '<em>any</em>' is the default if not provided. Settings from a previous
295 * packet capture are preserved, so '<em>any</em>' can be used to reset
296 * the interface setting.
298 * - <b>file <name></b> - Used to specify the output filename. The file will
299 * be placed in the '<em>/tmp</em>' directory, so only the filename is
300 * supported. Directory should not be entered. If file already exists, file
301 * will be overwritten. If no filename is provided, '<em>/tmp/vpe.pcap</em>'
302 * will be used. Can only be updated if packet capture is off.
304 * - <b>status</b> - Displays the current status and configured attributes
305 * associated with a packet capture. If packet capture is in progress,
306 * '<em>status</em>' also will return the number of packets currently in
307 * the local buffer. All additional attributes entered on command line
308 * with '<em>status</em>' will be ingnored and not applied.
311 * Example of how to display the status of a tx packet capture when off:
312 * @cliexstart{pcap tx trace status}
313 * max is 100, for any interface to file /tmp/vpe.pcap
314 * pcap tx capture is off...
316 * Example of how to start a tx packet capture:
317 * @cliexstart{pcap tx trace on max 35 intfc GigabitEthernet0/8/0 file vppTest.pcap}
318 * pcap tx capture on...
320 * Example of how to display the status of a tx packet capture in progress:
321 * @cliexstart{pcap tx trace status}
322 * max is 35, for interface GigabitEthernet0/8/0 to file /tmp/vppTest.pcap
323 * pcap tx capture is on: 20 of 35 pkts...
325 * Example of how to stop a tx packet capture:
326 * @cliexstart{vppctl pcap tx trace off}
327 * captured 21 pkts...
328 * saved to /tmp/vppTest.pcap...
332 VLIB_CLI_COMMAND (pcap_trace_command, static) = {
333 .path = "pcap tx trace",
335 "pcap tx trace [on|off] [max <nn>] [intfc <interface>|any] [file <name>] [status]",
336 .function = pcap_trace_command_fn,
341 static clib_error_t *
342 show_dpdk_buffer (vlib_main_t * vm, unformat_input_t * input,
343 vlib_cli_command_t * cmd)
345 struct rte_mempool *rmp;
348 for (i = 0; i < vec_len (dpdk_main.pktmbuf_pools); i++)
350 rmp = dpdk_main.pktmbuf_pools[i];
353 unsigned count = rte_mempool_avail_count (rmp);
354 unsigned free_count = rte_mempool_in_use_count (rmp);
357 "name=\"%s\" available = %7d allocated = %7d total = %7d\n",
358 rmp->name, (u32) count, (u32) free_count,
359 (u32) (count + free_count));
363 vlib_cli_output (vm, "rte_mempool is NULL (!)\n");
370 * This command displays statistics of each DPDK mempool.
373 * Example of how to display DPDK buffer data:
374 * @cliexstart{show dpdk buffer}
375 * name="mbuf_pool_socket0" available = 15104 allocated = 1280 total = 16384
379 VLIB_CLI_COMMAND (cmd_show_dpdk_bufferr,static) = {
380 .path = "show dpdk buffer",
381 .short_help = "show dpdk buffer",
382 .function = show_dpdk_buffer,
387 static clib_error_t *
388 test_dpdk_buffer (vlib_main_t * vm, unformat_input_t * input,
389 vlib_cli_command_t * cmd)
391 static u32 *allocated_buffers;
394 u32 first, actual_alloc;
396 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
398 if (unformat (input, "allocate %d", &n_alloc))
400 else if (unformat (input, "free %d", &n_free))
408 if (vec_len (allocated_buffers) < n_free)
409 return clib_error_return (0, "Can't free %d, only %d allocated",
410 n_free, vec_len (allocated_buffers));
412 first = vec_len (allocated_buffers) - n_free;
413 vlib_buffer_free (vm, allocated_buffers + first, n_free);
414 _vec_len (allocated_buffers) = first;
418 first = vec_len (allocated_buffers);
419 vec_validate (allocated_buffers,
420 vec_len (allocated_buffers) + n_alloc - 1);
422 actual_alloc = vlib_buffer_alloc (vm, allocated_buffers + first,
424 _vec_len (allocated_buffers) = first + actual_alloc;
426 if (actual_alloc < n_alloc)
427 vlib_cli_output (vm, "WARNING: only allocated %d buffers",
431 vlib_cli_output (vm, "Currently %d buffers allocated",
432 vec_len (allocated_buffers));
434 if (allocated_buffers && vec_len (allocated_buffers) == 0)
435 vec_free (allocated_buffers);
441 * This command tests the allocation and freeing of DPDK buffers.
442 * If both '<em>allocate</em>' and '<em>free</em>' are entered on the
443 * same command, the '<em>free</em>' is executed first. If no
444 * parameters are provided, this command display how many DPDK buffers
445 * the test command has allocated.
450 * Example of how to display how many DPDK buffer test command has allcoated:
451 * @cliexstart{test dpdk buffer}
452 * Currently 0 buffers allocated
455 * Example of how to allocate DPDK buffers using the test command:
456 * @cliexstart{test dpdk buffer allocate 10}
457 * Currently 10 buffers allocated
460 * Example of how to free DPDK buffers allocated by the test command:
461 * @cliexstart{test dpdk buffer free 10}
462 * Currently 0 buffers allocated
467 VLIB_CLI_COMMAND (cmd_test_dpdk_buffer,static) = {
468 .path = "test dpdk buffer",
469 .short_help = "test dpdk buffer [allocate <nn>] [free <nn>]",
470 .function = test_dpdk_buffer,
475 static clib_error_t *
476 set_dpdk_if_desc (vlib_main_t * vm, unformat_input_t * input,
477 vlib_cli_command_t * cmd)
479 unformat_input_t _line_input, *line_input = &_line_input;
480 dpdk_main_t *dm = &dpdk_main;
481 vnet_hw_interface_t *hw;
483 u32 hw_if_index = (u32) ~ 0;
484 u32 nb_rx_desc = (u32) ~ 0;
485 u32 nb_tx_desc = (u32) ~ 0;
486 clib_error_t *error = NULL;
488 if (!unformat_user (input, unformat_line_input, line_input))
491 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
494 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
497 else if (unformat (line_input, "tx %d", &nb_tx_desc))
499 else if (unformat (line_input, "rx %d", &nb_rx_desc))
503 error = clib_error_return (0, "parse error: '%U'",
504 format_unformat_error, line_input);
509 if (hw_if_index == (u32) ~ 0)
511 error = clib_error_return (0, "please specify valid interface name");
515 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
516 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
518 if ((xd->flags & DPDK_DEVICE_FLAG_PMD) == 0)
521 clib_error_return (0,
522 "number of descriptors can be set only for "
527 if ((nb_rx_desc == (u32) ~ 0 || nb_rx_desc == xd->nb_rx_desc) &&
528 (nb_tx_desc == (u32) ~ 0 || nb_tx_desc == xd->nb_tx_desc))
530 error = clib_error_return (0, "nothing changed");
534 if (nb_rx_desc != (u32) ~ 0)
535 xd->nb_rx_desc = nb_rx_desc;
537 if (nb_tx_desc != (u32) ~ 0)
538 xd->nb_tx_desc = nb_tx_desc;
540 error = dpdk_port_setup (dm, xd);
543 unformat_free (line_input);
549 * This command sets the number of DPDK '<em>rx</em>' and
550 * '<em>tx</em>' descriptors for the given physical interface. Use
551 * the command '<em>show hardware-interface</em>' to display the
552 * current descriptor allocation.
555 * Example of how to set the DPDK interface descriptors:
556 * @cliexcmd{set dpdk interface descriptors GigabitEthernet0/8/0 rx 512 tx 512}
559 VLIB_CLI_COMMAND (cmd_set_dpdk_if_desc,static) = {
560 .path = "set dpdk interface descriptors",
561 .short_help = "set dpdk interface descriptors <interface> [rx <nn>] [tx <nn>]",
562 .function = set_dpdk_if_desc,
567 dpdk_device_queue_sort (void *a1, void *a2)
569 dpdk_device_and_queue_t *dq1 = a1;
570 dpdk_device_and_queue_t *dq2 = a2;
572 if (dq1->device > dq2->device)
574 else if (dq1->device < dq2->device)
576 else if (dq1->queue_id > dq2->queue_id)
578 else if (dq1->queue_id < dq2->queue_id)
585 static clib_error_t *
586 show_dpdk_if_hqos_placement (vlib_main_t * vm, unformat_input_t * input,
587 vlib_cli_command_t * cmd)
589 vlib_thread_main_t *tm = vlib_get_thread_main ();
590 dpdk_main_t *dm = &dpdk_main;
591 dpdk_device_and_queue_t *dq;
594 if (tm->n_vlib_mains == 1)
595 vlib_cli_output (vm, "All interfaces are handled by main thread");
597 for (cpu = 0; cpu < vec_len (dm->devices_by_hqos_cpu); cpu++)
599 if (cpu >= dm->hqos_cpu_first_index &&
600 cpu < (dm->hqos_cpu_first_index + dm->hqos_cpu_count))
601 vlib_cli_output (vm, "Thread %u (%s at lcore %u):", cpu,
602 vlib_worker_threads[cpu].name,
603 vlib_worker_threads[cpu].lcore_id);
605 vec_foreach (dq, dm->devices_by_hqos_cpu[cpu])
607 u32 hw_if_index = dm->devices[dq->device].hw_if_index;
608 vnet_hw_interface_t *hi =
609 vnet_get_hw_interface (dm->vnet_main, hw_if_index);
610 vlib_cli_output (vm, " %v queue %u", hi->name, dq->queue_id);
617 * This command is used to display the thread and core each
618 * DPDK output interface and HQoS queue is assigned too.
621 * Example of how to display the DPDK output interface and HQoS queue placement:
622 * @cliexstart{show dpdk interface hqos placement}
623 * Thread 1 (vpp_hqos-threads_0 at lcore 3):
624 * GigabitEthernet0/8/0 queue 0
625 * Thread 2 (vpp_hqos-threads_1 at lcore 4):
626 * GigabitEthernet0/9/0 queue 0
630 VLIB_CLI_COMMAND (cmd_show_dpdk_if_hqos_placement, static) = {
631 .path = "show dpdk interface hqos placement",
632 .short_help = "show dpdk interface hqos placement",
633 .function = show_dpdk_if_hqos_placement,
637 static clib_error_t *
638 set_dpdk_if_hqos_placement (vlib_main_t * vm, unformat_input_t * input,
639 vlib_cli_command_t * cmd)
641 unformat_input_t _line_input, *line_input = &_line_input;
642 dpdk_main_t *dm = &dpdk_main;
643 dpdk_device_and_queue_t *dq;
644 vnet_hw_interface_t *hw;
646 u32 hw_if_index = (u32) ~ 0;
649 clib_error_t *error = NULL;
651 if (!unformat_user (input, unformat_line_input, line_input))
654 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
657 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
660 else if (unformat (line_input, "thread %d", &cpu))
664 error = clib_error_return (0, "parse error: '%U'",
665 format_unformat_error, line_input);
670 if (hw_if_index == (u32) ~ 0)
671 return clib_error_return (0, "please specify valid interface name");
673 if (cpu < dm->hqos_cpu_first_index ||
674 cpu >= (dm->hqos_cpu_first_index + dm->hqos_cpu_count))
676 error = clib_error_return (0, "please specify valid thread id");
680 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
681 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
683 for (i = 0; i < vec_len (dm->devices_by_hqos_cpu); i++)
685 vec_foreach (dq, dm->devices_by_hqos_cpu[i])
687 if (hw_if_index == dm->devices[dq->device].hw_if_index)
689 if (cpu == i) /* nothing to do */
692 vec_del1 (dm->devices_by_hqos_cpu[i],
693 dq - dm->devices_by_hqos_cpu[i]);
694 vec_add2 (dm->devices_by_hqos_cpu[cpu], dq, 1);
696 dq->device = xd->device_index;
698 vec_sort_with_function (dm->devices_by_hqos_cpu[i],
699 dpdk_device_queue_sort);
701 vec_sort_with_function (dm->devices_by_hqos_cpu[cpu],
702 dpdk_device_queue_sort);
709 error = clib_error_return (0, "not found");
712 unformat_free (line_input);
718 * This command is used to assign a given DPDK output interface and
719 * HQoS queue to a different thread. This will not create a thread,
720 * so the thread must already exist. Use '<em>/etc/vpp/startup.conf</em>'
721 * for the initial thread creation. See @ref qos_doc for more details.
724 * Example of how to display the DPDK output interface and HQoS queue placement:
725 * @cliexstart{show dpdk interface hqos placement}
726 * Thread 1 (vpp_hqos-threads_0 at lcore 3):
727 * GigabitEthernet0/8/0 queue 0
728 * Thread 2 (vpp_hqos-threads_1 at lcore 4):
729 * GigabitEthernet0/9/0 queue 0
731 * Example of how to assign a DPDK output interface and HQoS queue to a thread:
732 * @cliexcmd{set dpdk interface hqos placement GigabitEthernet0/8/0 thread 2}
735 VLIB_CLI_COMMAND (cmd_set_dpdk_if_hqos_placement, static) = {
736 .path = "set dpdk interface hqos placement",
737 .short_help = "set dpdk interface hqos placement <interface> thread <n>",
738 .function = set_dpdk_if_hqos_placement,
742 static clib_error_t *
743 set_dpdk_if_hqos_pipe (vlib_main_t * vm, unformat_input_t * input,
744 vlib_cli_command_t * cmd)
746 unformat_input_t _line_input, *line_input = &_line_input;
747 dpdk_main_t *dm = &dpdk_main;
748 vnet_hw_interface_t *hw;
750 u32 hw_if_index = (u32) ~ 0;
751 u32 subport_id = (u32) ~ 0;
752 u32 pipe_id = (u32) ~ 0;
753 u32 profile_id = (u32) ~ 0;
755 clib_error_t *error = NULL;
757 if (!unformat_user (input, unformat_line_input, line_input))
760 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
763 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
766 else if (unformat (line_input, "subport %d", &subport_id))
768 else if (unformat (line_input, "pipe %d", &pipe_id))
770 else if (unformat (line_input, "profile %d", &profile_id))
774 error = clib_error_return (0, "parse error: '%U'",
775 format_unformat_error, line_input);
780 if (hw_if_index == (u32) ~ 0)
782 error = clib_error_return (0, "please specify valid interface name");
786 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
787 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
790 rte_sched_pipe_config (xd->hqos_ht->hqos, subport_id, pipe_id,
794 error = clib_error_return (0, "pipe configuration failed");
799 unformat_free (line_input);
805 * This command is used to change the profile associate with a HQoS pipe. The
806 * '<em><profile_id></em>' is zero based. Use the command
807 * '<em>show dpdk interface hqos</em>' to display the content of each profile.
808 * See @ref qos_doc for more details.
811 * Currently there is not an API to create a new HQoS pipe profile. One is
812 * created by default in the code (search for '<em>hqos_pipe_params_default</em>'').
813 * Additional profiles can be created in code and code recompiled. Then use this
814 * command to assign it.
817 * Example of how to assign a new profile to a HQoS pipe:
818 * @cliexcmd{set dpdk interface hqos pipe GigabitEthernet0/8/0 subport 0 pipe 2 profile 1}
821 VLIB_CLI_COMMAND (cmd_set_dpdk_if_hqos_pipe, static) =
823 .path = "set dpdk interface hqos pipe",
824 .short_help = "set dpdk interface hqos pipe <interface> subport <subport_id> pipe <pipe_id> "
825 "profile <profile_id>",
826 .function = set_dpdk_if_hqos_pipe,
830 static clib_error_t *
831 set_dpdk_if_hqos_subport (vlib_main_t * vm, unformat_input_t * input,
832 vlib_cli_command_t * cmd)
834 unformat_input_t _line_input, *line_input = &_line_input;
835 dpdk_main_t *dm = &dpdk_main;
836 dpdk_device_t *xd = NULL;
837 u32 hw_if_index = (u32) ~ 0;
838 u32 subport_id = (u32) ~ 0;
839 struct rte_sched_subport_params p;
841 clib_error_t *error = NULL;
842 u32 tb_rate = (u32) ~ 0;
843 u32 tb_size = (u32) ~ 0;
844 u32 tc_rate[RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE] =
845 { (u32) ~ 0, (u32) ~ 0, (u32) ~ 0, (u32) ~ 0 };
846 u32 tc_period = (u32) ~ 0;
847 dpdk_device_config_t *devconf = NULL;
849 if (!unformat_user (input, unformat_line_input, line_input))
852 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
855 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
858 else if (unformat (line_input, "subport %d", &subport_id))
860 else if (unformat (line_input, "rate %d", &tb_rate))
862 else if (unformat (line_input, "bktsize %d", &tb_size))
864 else if (unformat (line_input, "tc0 %d", &tc_rate[0]))
866 else if (unformat (line_input, "tc1 %d", &tc_rate[1]))
868 else if (unformat (line_input, "tc2 %d", &tc_rate[2]))
870 else if (unformat (line_input, "tc3 %d", &tc_rate[3]))
872 else if (unformat (line_input, "period %d", &tc_period))
876 error = clib_error_return (0, "parse error: '%U'",
877 format_unformat_error, line_input);
882 error = get_hqos (hw_if_index, subport_id, &xd, &devconf);
886 /* Copy the current values over to local structure. */
887 memcpy (&p, &devconf->hqos.subport[subport_id], sizeof (p));
889 /* Update local structure with input values. */
890 if (tb_rate != (u32) ~ 0)
893 p.tc_rate[0] = tb_rate;
894 p.tc_rate[1] = tb_rate;
895 p.tc_rate[2] = tb_rate;
896 p.tc_rate[3] = tb_rate;
898 if (tb_size != (u32) ~ 0)
902 if (tc_rate[0] != (u32) ~ 0)
904 p.tc_rate[0] = tc_rate[0];
906 if (tc_rate[1] != (u32) ~ 0)
908 p.tc_rate[1] = tc_rate[1];
910 if (tc_rate[2] != (u32) ~ 0)
912 p.tc_rate[2] = tc_rate[2];
914 if (tc_rate[3] != (u32) ~ 0)
916 p.tc_rate[3] = tc_rate[3];
918 if (tc_period != (u32) ~ 0)
920 p.tc_period = tc_period;
924 rv = rte_sched_subport_config (xd->hqos_ht->hqos, subport_id, &p);
927 error = clib_error_return (0, "subport configuration failed");
932 /* Successfully applied, so save of the input values. */
933 memcpy (&devconf->hqos.subport[subport_id], &p, sizeof (p));
938 unformat_free (line_input);
944 * This command is used to set the subport level parameters such as token
945 * bucket rate (bytes per seconds), token bucket size (bytes), traffic class
946 * rates (bytes per seconds) and token update period (Milliseconds).
948 * By default, the '<em>rate</em>' is set to 1250000000 bytes/second (10GbE
949 * rate) and each of the four traffic classes is set to 100% of the port rate.
950 * If the '<em>rate</em>' is updated by this command, all four traffic classes
951 * are assigned the same value. Each of the four traffic classes can be updated
955 * Example of how modify the subport attributes for a 1GbE link:
956 * @cliexcmd{set dpdk interface hqos subport GigabitEthernet0/8/0 subport 0 rate 125000000}
959 VLIB_CLI_COMMAND (cmd_set_dpdk_if_hqos_subport, static) = {
960 .path = "set dpdk interface hqos subport",
961 .short_help = "set dpdk interface hqos subport <interface> subport <subport_id> "
962 "[rate <n>] [bktsize <n>] [tc0 <n>] [tc1 <n>] [tc2 <n>] [tc3 <n>] "
964 .function = set_dpdk_if_hqos_subport,
968 static clib_error_t *
969 set_dpdk_if_hqos_tctbl (vlib_main_t * vm, unformat_input_t * input,
970 vlib_cli_command_t * cmd)
972 unformat_input_t _line_input, *line_input = &_line_input;
973 vlib_thread_main_t *tm = vlib_get_thread_main ();
974 dpdk_main_t *dm = &dpdk_main;
975 vnet_hw_interface_t *hw;
977 u32 hw_if_index = (u32) ~ 0;
979 u32 queue = (u32) ~ 0;
980 u32 entry = (u32) ~ 0;
982 clib_error_t *error = NULL;
984 if (!unformat_user (input, unformat_line_input, line_input))
987 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
990 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
993 else if (unformat (line_input, "entry %d", &entry))
995 else if (unformat (line_input, "tc %d", &tc))
997 else if (unformat (line_input, "queue %d", &queue))
1001 error = clib_error_return (0, "parse error: '%U'",
1002 format_unformat_error, line_input);
1007 if (hw_if_index == (u32) ~ 0)
1009 error = clib_error_return (0, "please specify valid interface name");
1014 error = clib_error_return (0, "invalid entry");
1017 if (tc >= RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE)
1019 error = clib_error_return (0, "invalid traffic class");
1022 if (queue >= RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS)
1024 error = clib_error_return (0, "invalid traffic class queue");
1028 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
1029 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
1031 /* Detect the set of worker threads */
1032 uword *p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1033 /* Should never happen, shut up Coverity warning */
1036 error = clib_error_return (0, "no worker registrations?");
1040 vlib_thread_registration_t *tr = (vlib_thread_registration_t *) p[0];
1041 int worker_thread_first = tr->first_index;
1042 int worker_thread_count = tr->count;
1044 val = tc * RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS + queue;
1045 for (i = 0; i < worker_thread_count; i++)
1046 xd->hqos_wt[worker_thread_first + i].hqos_tc_table[entry] = val;
1049 unformat_free (line_input);
1055 * This command is used to set the traffic class translation table. The
1056 * traffic class translation table is used to map 64 values (0-63) to one of
1057 * four traffic class and one of four HQoS input queue. Use the '<em>show
1058 * dpdk interface hqos</em>' command to display the traffic class translation
1059 * table. See @ref qos_doc for more details.
1061 * This command has the following parameters:
1063 * - <b><interface></b> - Used to specify the output interface.
1065 * - <b>entry <map_val></b> - Mapped value (0-63) to assign traffic class and queue to.
1067 * - <b>tc <tc_id></b> - Traffic class (0-3) to be used by the provided mapped value.
1069 * - <b>queue <queue_id></b> - HQoS input queue (0-3) to be used by the provided mapped value.
1072 * Example of how modify the traffic class translation table:
1073 * @cliexcmd{set dpdk interface hqos tctbl GigabitEthernet0/8/0 entry 16 tc 2 queue 2}
1076 VLIB_CLI_COMMAND (cmd_set_dpdk_if_hqos_tctbl, static) = {
1077 .path = "set dpdk interface hqos tctbl",
1078 .short_help = "set dpdk interface hqos tctbl <interface> entry <map_val> tc <tc_id> queue <queue_id>",
1079 .function = set_dpdk_if_hqos_tctbl,
1083 static clib_error_t *
1084 set_dpdk_if_hqos_pktfield (vlib_main_t * vm, unformat_input_t * input,
1085 vlib_cli_command_t * cmd)
1087 unformat_input_t _line_input, *line_input = &_line_input;
1088 vlib_thread_main_t *tm = vlib_get_thread_main ();
1089 dpdk_main_t *dm = &dpdk_main;
1090 clib_error_t *error = NULL;
1092 /* Device specific data */
1093 struct rte_eth_dev_info dev_info;
1094 dpdk_device_config_t *devconf = 0;
1095 vnet_hw_interface_t *hw;
1097 u32 hw_if_index = (u32) ~ 0;
1099 /* Detect the set of worker threads */
1100 uword *p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1101 /* Should never happen, shut up Coverity warning */
1103 return clib_error_return (0, "no worker registrations?");
1105 vlib_thread_registration_t *tr = (vlib_thread_registration_t *) p[0];
1106 int worker_thread_first = tr->first_index;
1107 int worker_thread_count = tr->count;
1109 /* Packet field configuration */
1110 u64 mask = (u64) ~ 0;
1112 u32 offset = (u32) ~ 0;
1115 u32 n_subports_per_port, n_pipes_per_subport, tctbl_size;
1119 /* Parse input arguments */
1120 if (!unformat_user (input, unformat_line_input, line_input))
1123 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1126 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
1129 else if (unformat (line_input, "id subport"))
1131 else if (unformat (line_input, "id pipe"))
1133 else if (unformat (line_input, "id tc"))
1135 else if (unformat (line_input, "id %d", &id))
1137 else if (unformat (line_input, "offset %d", &offset))
1139 else if (unformat (line_input, "mask %llx", &mask))
1143 error = clib_error_return (0, "parse error: '%U'",
1144 format_unformat_error, line_input);
1150 if (hw_if_index == (u32) ~ 0)
1152 error = clib_error_return (0, "please specify valid interface name");
1156 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
1157 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
1159 rte_eth_dev_info_get (xd->device_index, &dev_info);
1160 if (dev_info.pci_dev)
1161 { /* bonded interface has no pci info */
1162 vlib_pci_addr_t pci_addr;
1164 pci_addr.domain = dev_info.pci_dev->addr.domain;
1165 pci_addr.bus = dev_info.pci_dev->addr.bus;
1166 pci_addr.slot = dev_info.pci_dev->addr.devid;
1167 pci_addr.function = dev_info.pci_dev->addr.function;
1170 hash_get (dm->conf->device_config_index_by_pci_addr, pci_addr.as_u32);
1174 devconf = pool_elt_at_index (dm->conf->dev_confs, p[0]);
1176 devconf = &dm->conf->default_devconf;
1178 if (devconf->hqos_enabled == 0)
1180 vlib_cli_output (vm, "HQoS disabled for this interface");
1184 n_subports_per_port = devconf->hqos.port.n_subports_per_port;
1185 n_pipes_per_subport = devconf->hqos.port.n_pipes_per_subport;
1186 tctbl_size = RTE_DIM (devconf->hqos.tc_table);
1188 /* Validate packet field configuration: id, offset and mask */
1191 error = clib_error_return (0, "invalid packet field id");
1198 if (dpdk_hqos_validate_mask (mask, n_subports_per_port) != 0)
1200 error = clib_error_return (0, "invalid subport ID mask "
1201 "(n_subports_per_port = %u)",
1202 n_subports_per_port);
1207 if (dpdk_hqos_validate_mask (mask, n_pipes_per_subport) != 0)
1209 error = clib_error_return (0, "invalid pipe ID mask "
1210 "(n_pipes_per_subport = %u)",
1211 n_pipes_per_subport);
1217 if (dpdk_hqos_validate_mask (mask, tctbl_size) != 0)
1219 error = clib_error_return (0, "invalid TC table index mask "
1220 "(TC table size = %u)", tctbl_size);
1225 /* Propagate packet field configuration to all workers */
1226 for (i = 0; i < worker_thread_count; i++)
1230 xd->hqos_wt[worker_thread_first + i].hqos_field0_slabpos = offset;
1231 xd->hqos_wt[worker_thread_first + i].hqos_field0_slabmask = mask;
1232 xd->hqos_wt[worker_thread_first + i].hqos_field0_slabshr =
1233 __builtin_ctzll (mask);
1236 xd->hqos_wt[worker_thread_first + i].hqos_field1_slabpos = offset;
1237 xd->hqos_wt[worker_thread_first + i].hqos_field1_slabmask = mask;
1238 xd->hqos_wt[worker_thread_first + i].hqos_field1_slabshr =
1239 __builtin_ctzll (mask);
1243 xd->hqos_wt[worker_thread_first + i].hqos_field2_slabpos = offset;
1244 xd->hqos_wt[worker_thread_first + i].hqos_field2_slabmask = mask;
1245 xd->hqos_wt[worker_thread_first + i].hqos_field2_slabshr =
1246 __builtin_ctzll (mask);
1250 unformat_free (line_input);
1256 * This command is used to set the packet fields required for classifiying the
1257 * incoming packet. As a result of classification process, packet field
1258 * information will be mapped to 5 tuples (subport, pipe, traffic class, pipe,
1259 * color) and stored in packet mbuf.
1261 * This command has the following parameters:
1263 * - <b><interface></b> - Used to specify the output interface.
1265 * - <b>id subport|pipe|tc</b> - Classification occurs across three fields.
1266 * This parameter indicates which of the three masks are being configured. Legacy
1267 * code used 0-2 to represent these three fields, so 0-2 is still accepted.
1268 * - <b>subport|0</b> - Currently only one subport is supported, so only
1269 * an empty mask is supported for the subport classification.
1270 * - <b>pipe|1</b> - Currently, 4096 pipes per subport are supported, so a
1271 * 12-bit mask should be configure to map to the 0-4095 pipes.
1272 * - <b>tc|2</b> - The translation table (see '<em>set dpdk interface hqos
1273 * tctbl</em>' command) maps each value (0-63) into one of the 4 traffic classes
1274 * per pipe. A 6-bit mask should be configure to map this field to a traffic class.
1276 * - <b>offset <n></b> - Offset in the packet to apply the 64-bit mask for classification.
1277 * The offset should be on an 8-byte boundary (0,8,16,24..).
1279 * - <b>mask <hex-mask></b> - 64-bit mask to apply to packet at the given '<em>offset</em>'.
1280 * Bits must be contiguous and should not include '<em>0x</em>'.
1282 * The default values for the '<em>pktfield</em>' assumes Ethernet/IPv4/UDP packets with
1283 * no VLAN. Adjust based on expected packet format and desired classification field.
1284 * - '<em>subport</em>' is always empty (offset 0 mask 0000000000000000)
1285 * - By default, '<em>pipe</em>' maps to the UDP payload bits 12 .. 23 (offset 40
1286 * mask 0000000fff000000)
1287 * - By default, '<em>tc</em>' maps to the DSCP field in IP header (offset 48 mask
1291 * Example of how modify the '<em>pipe</em>' classification filter to match VLAN:
1292 * @cliexcmd{set dpdk interface hqos pktfield GigabitEthernet0/8/0 id pipe offset 8 mask 0000000000000FFF}
1295 VLIB_CLI_COMMAND (cmd_set_dpdk_if_hqos_pktfield, static) = {
1296 .path = "set dpdk interface hqos pktfield",
1297 .short_help = "set dpdk interface hqos pktfield <interface> id subport|pipe|tc offset <n> "
1299 .function = set_dpdk_if_hqos_pktfield,
1303 static clib_error_t *
1304 show_dpdk_if_hqos (vlib_main_t * vm, unformat_input_t * input,
1305 vlib_cli_command_t * cmd)
1307 unformat_input_t _line_input, *line_input = &_line_input;
1308 vlib_thread_main_t *tm = vlib_get_thread_main ();
1309 dpdk_main_t *dm = &dpdk_main;
1310 vnet_hw_interface_t *hw;
1312 dpdk_device_config_hqos_t *cfg;
1313 dpdk_device_hqos_per_hqos_thread_t *ht;
1314 dpdk_device_hqos_per_worker_thread_t *wk;
1316 u32 hw_if_index = (u32) ~ 0;
1317 u32 profile_id, subport_id, i;
1318 struct rte_eth_dev_info dev_info;
1319 dpdk_device_config_t *devconf = 0;
1320 vlib_thread_registration_t *tr;
1322 clib_error_t *error = NULL;
1324 if (!unformat_user (input, unformat_line_input, line_input))
1327 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1330 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
1335 error = clib_error_return (0, "parse error: '%U'",
1336 format_unformat_error, line_input);
1341 if (hw_if_index == (u32) ~ 0)
1343 error = clib_error_return (0, "please specify interface name!!");
1347 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
1348 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
1350 rte_eth_dev_info_get (xd->device_index, &dev_info);
1351 if (dev_info.pci_dev)
1352 { /* bonded interface has no pci info */
1353 vlib_pci_addr_t pci_addr;
1355 pci_addr.domain = dev_info.pci_dev->addr.domain;
1356 pci_addr.bus = dev_info.pci_dev->addr.bus;
1357 pci_addr.slot = dev_info.pci_dev->addr.devid;
1358 pci_addr.function = dev_info.pci_dev->addr.function;
1361 hash_get (dm->conf->device_config_index_by_pci_addr, pci_addr.as_u32);
1365 devconf = pool_elt_at_index (dm->conf->dev_confs, p[0]);
1367 devconf = &dm->conf->default_devconf;
1369 if (devconf->hqos_enabled == 0)
1371 vlib_cli_output (vm, "HQoS disabled for this interface");
1375 /* Detect the set of worker threads */
1376 p = hash_get_mem (tm->thread_registrations_by_name, "workers");
1378 /* Should never happen, shut up Coverity warning */
1381 error = clib_error_return (0, "no worker registrations?");
1385 tr = (vlib_thread_registration_t *) p[0];
1387 cfg = &devconf->hqos;
1389 wk = &xd->hqos_wt[tr->first_index];
1390 tctbl = wk->hqos_tc_table;
1392 vlib_cli_output (vm, " Thread:");
1393 vlib_cli_output (vm, " Input SWQ size = %u packets", cfg->swq_size);
1394 vlib_cli_output (vm, " Enqueue burst size = %u packets",
1395 ht->hqos_burst_enq);
1396 vlib_cli_output (vm, " Dequeue burst size = %u packets",
1397 ht->hqos_burst_deq);
1399 vlib_cli_output (vm,
1400 " Packet field 0: slab position = %4u, slab bitmask = 0x%016llx (subport)",
1401 wk->hqos_field0_slabpos, wk->hqos_field0_slabmask);
1402 vlib_cli_output (vm,
1403 " Packet field 1: slab position = %4u, slab bitmask = 0x%016llx (pipe)",
1404 wk->hqos_field1_slabpos, wk->hqos_field1_slabmask);
1405 vlib_cli_output (vm,
1406 " Packet field 2: slab position = %4u, slab bitmask = 0x%016llx (tc)",
1407 wk->hqos_field2_slabpos, wk->hqos_field2_slabmask);
1408 vlib_cli_output (vm,
1409 " Packet field 2 tc translation table: ([Mapped Value Range]: tc/queue tc/queue ...)");
1410 vlib_cli_output (vm,
1412 "%u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u",
1413 tctbl[0] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1414 tctbl[0] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1415 tctbl[1] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1416 tctbl[1] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1417 tctbl[2] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1418 tctbl[2] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1419 tctbl[3] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1420 tctbl[3] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1421 tctbl[4] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1422 tctbl[4] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1423 tctbl[5] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1424 tctbl[5] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1425 tctbl[6] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1426 tctbl[6] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1427 tctbl[7] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1428 tctbl[7] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1429 tctbl[8] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1430 tctbl[8] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1431 tctbl[9] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1432 tctbl[9] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1433 tctbl[10] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1434 tctbl[10] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1435 tctbl[11] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1436 tctbl[11] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1437 tctbl[12] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1438 tctbl[12] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1439 tctbl[13] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1440 tctbl[13] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1441 tctbl[14] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1442 tctbl[14] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1443 tctbl[15] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1444 tctbl[15] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS);
1445 vlib_cli_output (vm,
1447 "%u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u",
1448 tctbl[16] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1449 tctbl[16] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1450 tctbl[17] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1451 tctbl[17] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1452 tctbl[18] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1453 tctbl[18] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1454 tctbl[19] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1455 tctbl[19] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1456 tctbl[20] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1457 tctbl[20] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1458 tctbl[21] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1459 tctbl[21] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1460 tctbl[22] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1461 tctbl[22] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1462 tctbl[23] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1463 tctbl[23] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1464 tctbl[24] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1465 tctbl[24] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1466 tctbl[25] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1467 tctbl[25] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1468 tctbl[26] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1469 tctbl[26] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1470 tctbl[27] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1471 tctbl[27] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1472 tctbl[28] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1473 tctbl[28] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1474 tctbl[29] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1475 tctbl[29] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1476 tctbl[30] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1477 tctbl[30] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1478 tctbl[31] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1479 tctbl[31] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS);
1480 vlib_cli_output (vm,
1482 "%u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u",
1483 tctbl[32] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1484 tctbl[32] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1485 tctbl[33] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1486 tctbl[33] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1487 tctbl[34] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1488 tctbl[34] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1489 tctbl[35] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1490 tctbl[35] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1491 tctbl[36] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1492 tctbl[36] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1493 tctbl[37] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1494 tctbl[37] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1495 tctbl[38] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1496 tctbl[38] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1497 tctbl[39] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1498 tctbl[39] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1499 tctbl[40] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1500 tctbl[40] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1501 tctbl[41] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1502 tctbl[41] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1503 tctbl[42] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1504 tctbl[42] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1505 tctbl[43] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1506 tctbl[43] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1507 tctbl[44] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1508 tctbl[44] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1509 tctbl[45] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1510 tctbl[45] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1511 tctbl[46] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1512 tctbl[46] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1513 tctbl[47] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1514 tctbl[47] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS);
1515 vlib_cli_output (vm,
1517 "%u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u %u/%u",
1518 tctbl[48] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1519 tctbl[48] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1520 tctbl[49] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1521 tctbl[49] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1522 tctbl[50] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1523 tctbl[50] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1524 tctbl[51] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1525 tctbl[51] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1526 tctbl[52] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1527 tctbl[52] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1528 tctbl[53] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1529 tctbl[53] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1530 tctbl[54] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1531 tctbl[54] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1532 tctbl[55] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1533 tctbl[55] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1534 tctbl[56] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1535 tctbl[56] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1536 tctbl[57] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1537 tctbl[57] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1538 tctbl[58] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1539 tctbl[58] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1540 tctbl[59] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1541 tctbl[59] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1542 tctbl[60] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1543 tctbl[60] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1544 tctbl[61] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1545 tctbl[61] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1546 tctbl[62] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1547 tctbl[62] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1548 tctbl[63] / RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS,
1549 tctbl[63] % RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS);
1550 vlib_cli_output (vm, " Port:");
1551 vlib_cli_output (vm, " Rate = %u bytes/second", cfg->port.rate);
1552 vlib_cli_output (vm, " MTU = %u bytes", cfg->port.mtu);
1553 vlib_cli_output (vm, " Frame overhead = %u bytes",
1554 cfg->port.frame_overhead);
1555 vlib_cli_output (vm, " Number of subports = %u",
1556 cfg->port.n_subports_per_port);
1557 vlib_cli_output (vm, " Number of pipes per subport = %u",
1558 cfg->port.n_pipes_per_subport);
1559 vlib_cli_output (vm,
1560 " Packet queue size: TC0 = %u, TC1 = %u, TC2 = %u, TC3 = %u packets",
1561 cfg->port.qsize[0], cfg->port.qsize[1], cfg->port.qsize[2],
1562 cfg->port.qsize[3]);
1563 vlib_cli_output (vm, " Number of pipe profiles = %u",
1564 cfg->port.n_pipe_profiles);
1566 for (subport_id = 0; subport_id < vec_len (cfg->subport); subport_id++)
1568 vlib_cli_output (vm, " Subport %u:", subport_id);
1569 vlib_cli_output (vm, " Rate = %u bytes/second",
1570 cfg->subport[subport_id].tb_rate);
1571 vlib_cli_output (vm, " Token bucket size = %u bytes",
1572 cfg->subport[subport_id].tb_size);
1573 vlib_cli_output (vm,
1574 " Traffic class rate: TC0 = %u, TC1 = %u, TC2 = %u, TC3 = %u bytes/second",
1575 cfg->subport[subport_id].tc_rate[0],
1576 cfg->subport[subport_id].tc_rate[1],
1577 cfg->subport[subport_id].tc_rate[2],
1578 cfg->subport[subport_id].tc_rate[3]);
1579 vlib_cli_output (vm, " TC period = %u milliseconds",
1580 cfg->subport[subport_id].tc_period);
1583 for (profile_id = 0; profile_id < vec_len (cfg->pipe); profile_id++)
1585 vlib_cli_output (vm, " Pipe profile %u:", profile_id);
1586 vlib_cli_output (vm, " Rate = %u bytes/second",
1587 cfg->pipe[profile_id].tb_rate);
1588 vlib_cli_output (vm, " Token bucket size = %u bytes",
1589 cfg->pipe[profile_id].tb_size);
1590 vlib_cli_output (vm,
1591 " Traffic class rate: TC0 = %u, TC1 = %u, TC2 = %u, TC3 = %u bytes/second",
1592 cfg->pipe[profile_id].tc_rate[0],
1593 cfg->pipe[profile_id].tc_rate[1],
1594 cfg->pipe[profile_id].tc_rate[2],
1595 cfg->pipe[profile_id].tc_rate[3]);
1596 vlib_cli_output (vm, " TC period = %u milliseconds",
1597 cfg->pipe[profile_id].tc_period);
1598 #ifdef RTE_SCHED_SUBPORT_TC_OV
1599 vlib_cli_output (vm, " TC3 oversubscription_weight = %u",
1600 cfg->pipe[profile_id].tc_ov_weight);
1603 for (i = 0; i < RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE; i++)
1605 vlib_cli_output (vm,
1606 " TC%u WRR weights: Q0 = %u, Q1 = %u, Q2 = %u, Q3 = %u",
1607 i, cfg->pipe[profile_id].wrr_weights[i * 4],
1608 cfg->pipe[profile_id].wrr_weights[i * 4 + 1],
1609 cfg->pipe[profile_id].wrr_weights[i * 4 + 2],
1610 cfg->pipe[profile_id].wrr_weights[i * 4 + 3]);
1614 #ifdef RTE_SCHED_RED
1615 vlib_cli_output (vm, " Weighted Random Early Detection (WRED):");
1616 for (i = 0; i < RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE; i++)
1618 vlib_cli_output (vm, " TC%u min: G = %u, Y = %u, R = %u", i,
1619 cfg->port.red_params[i][e_RTE_METER_GREEN].min_th,
1620 cfg->port.red_params[i][e_RTE_METER_YELLOW].min_th,
1621 cfg->port.red_params[i][e_RTE_METER_RED].min_th);
1623 vlib_cli_output (vm, " TC%u max: G = %u, Y = %u, R = %u", i,
1624 cfg->port.red_params[i][e_RTE_METER_GREEN].max_th,
1625 cfg->port.red_params[i][e_RTE_METER_YELLOW].max_th,
1626 cfg->port.red_params[i][e_RTE_METER_RED].max_th);
1628 vlib_cli_output (vm,
1629 " TC%u inverted probability: G = %u, Y = %u, R = %u",
1630 i, cfg->port.red_params[i][e_RTE_METER_GREEN].maxp_inv,
1631 cfg->port.red_params[i][e_RTE_METER_YELLOW].maxp_inv,
1632 cfg->port.red_params[i][e_RTE_METER_RED].maxp_inv);
1634 vlib_cli_output (vm, " TC%u weight: R = %u, Y = %u, R = %u", i,
1635 cfg->port.red_params[i][e_RTE_METER_GREEN].wq_log2,
1636 cfg->port.red_params[i][e_RTE_METER_YELLOW].wq_log2,
1637 cfg->port.red_params[i][e_RTE_METER_RED].wq_log2);
1642 unformat_free (line_input);
1648 * This command is used to display details of an output interface's HQoS
1652 * Example of how to display HQoS settings for an interfaces:
1653 * @cliexstart{show dpdk interface hqos GigabitEthernet0/8/0}
1655 * Input SWQ size = 4096 packets
1656 * Enqueue burst size = 256 packets
1657 * Dequeue burst size = 220 packets
1658 * Packet field 0: slab position = 0, slab bitmask = 0x0000000000000000 (subport)
1659 * Packet field 1: slab position = 40, slab bitmask = 0x0000000fff000000 (pipe)
1660 * Packet field 2: slab position = 8, slab bitmask = 0x00000000000000fc (tc)
1661 * Packet field 2 tc translation table: ([Mapped Value Range]: tc/queue tc/queue ...)
1662 * [ 0 .. 15]: 0/0 0/1 0/2 0/3 1/0 1/1 1/2 1/3 2/0 2/1 2/2 2/3 3/0 3/1 3/2 3/3
1663 * [16 .. 31]: 0/0 0/1 0/2 0/3 1/0 1/1 1/2 1/3 2/0 2/1 2/2 2/3 3/0 3/1 3/2 3/3
1664 * [32 .. 47]: 0/0 0/1 0/2 0/3 1/0 1/1 1/2 1/3 2/0 2/1 2/2 2/3 3/0 3/1 3/2 3/3
1665 * [48 .. 63]: 0/0 0/1 0/2 0/3 1/0 1/1 1/2 1/3 2/0 2/1 2/2 2/3 3/0 3/1 3/2 3/3
1667 * Rate = 1250000000 bytes/second
1669 * Frame overhead = 24 bytes
1670 * Number of subports = 1
1671 * Number of pipes per subport = 4096
1672 * Packet queue size: TC0 = 64, TC1 = 64, TC2 = 64, TC3 = 64 packets
1673 * Number of pipe profiles = 2
1675 * Rate = 1250000000 bytes/second
1676 * Token bucket size = 1000000 bytes
1677 * Traffic class rate: TC0 = 1250000000, TC1 = 1250000000, TC2 = 1250000000, TC3 = 1250000000 bytes/second
1678 * TC period = 10 milliseconds
1680 * Rate = 305175 bytes/second
1681 * Token bucket size = 1000000 bytes
1682 * Traffic class rate: TC0 = 305175, TC1 = 305175, TC2 = 305175, TC3 = 305175 bytes/second
1683 * TC period = 40 milliseconds
1684 * TC0 WRR weights: Q0 = 1, Q1 = 1, Q2 = 1, Q3 = 1
1685 * TC1 WRR weights: Q0 = 1, Q1 = 1, Q2 = 1, Q3 = 1
1686 * TC2 WRR weights: Q0 = 1, Q1 = 1, Q2 = 1, Q3 = 1
1687 * TC3 WRR weights: Q0 = 1, Q1 = 1, Q2 = 1, Q3 = 1
1691 VLIB_CLI_COMMAND (cmd_show_dpdk_if_hqos, static) = {
1692 .path = "show dpdk interface hqos",
1693 .short_help = "show dpdk interface hqos <interface>",
1694 .function = show_dpdk_if_hqos,
1699 static clib_error_t *
1700 show_dpdk_hqos_queue_stats (vlib_main_t * vm, unformat_input_t * input,
1701 vlib_cli_command_t * cmd)
1703 unformat_input_t _line_input, *line_input = &_line_input;
1704 clib_error_t *error = NULL;
1705 #ifdef RTE_SCHED_COLLECT_STATS
1706 dpdk_main_t *dm = &dpdk_main;
1707 u32 hw_if_index = (u32) ~ 0;
1708 u32 subport = (u32) ~ 0;
1709 u32 pipe = (u32) ~ 0;
1711 u32 tc_q = (u32) ~ 0;
1712 vnet_hw_interface_t *hw;
1715 struct rte_eth_dev_info dev_info;
1716 dpdk_device_config_t *devconf = 0;
1718 struct rte_sched_queue_stats stats;
1721 if (!unformat_user (input, unformat_line_input, line_input))
1724 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
1727 (line_input, "%U", unformat_vnet_hw_interface, dm->vnet_main,
1731 else if (unformat (line_input, "subport %d", &subport))
1734 else if (unformat (line_input, "pipe %d", &pipe))
1737 else if (unformat (line_input, "tc %d", &tc))
1740 else if (unformat (line_input, "tc_q %d", &tc_q))
1745 error = clib_error_return (0, "parse error: '%U'",
1746 format_unformat_error, line_input);
1751 if (hw_if_index == (u32) ~ 0)
1753 error = clib_error_return (0, "please specify interface name!!");
1757 hw = vnet_get_hw_interface (dm->vnet_main, hw_if_index);
1758 xd = vec_elt_at_index (dm->devices, hw->dev_instance);
1760 rte_eth_dev_info_get (xd->device_index, &dev_info);
1761 if (dev_info.pci_dev)
1762 { /* bonded interface has no pci info */
1763 vlib_pci_addr_t pci_addr;
1765 pci_addr.domain = dev_info.pci_dev->addr.domain;
1766 pci_addr.bus = dev_info.pci_dev->addr.bus;
1767 pci_addr.slot = dev_info.pci_dev->addr.devid;
1768 pci_addr.function = dev_info.pci_dev->addr.function;
1771 hash_get (dm->conf->device_config_index_by_pci_addr, pci_addr.as_u32);
1775 devconf = pool_elt_at_index (dm->conf->dev_confs, p[0]);
1777 devconf = &dm->conf->default_devconf;
1779 if (devconf->hqos_enabled == 0)
1781 vlib_cli_output (vm, "HQoS disabled for this interface");
1786 * Figure out which queue to query. cf rte_sched_port_qindex. (Not sure why
1787 * that method isn't made public by DPDK - how _should_ we get the queue ID?)
1789 qindex = subport * devconf->hqos.port.n_pipes_per_subport + pipe;
1790 qindex = qindex * RTE_SCHED_TRAFFIC_CLASSES_PER_PIPE + tc;
1791 qindex = qindex * RTE_SCHED_QUEUES_PER_TRAFFIC_CLASS + tc_q;
1793 if (rte_sched_queue_read_stats (xd->hqos_ht->hqos, qindex, &stats, &qlen) !=
1796 error = clib_error_return (0, "failed to read stats");
1800 vlib_cli_output (vm, "%=24s%=16s", "Stats Parameter", "Value");
1801 vlib_cli_output (vm, "%=24s%=16d", "Packets", stats.n_pkts);
1802 vlib_cli_output (vm, "%=24s%=16d", "Packets dropped", stats.n_pkts_dropped);
1803 #ifdef RTE_SCHED_RED
1804 vlib_cli_output (vm, "%=24s%=16d", "Packets dropped (RED)",
1805 stats.n_pkts_red_dropped);
1807 vlib_cli_output (vm, "%=24s%=16d", "Bytes", stats.n_bytes);
1808 vlib_cli_output (vm, "%=24s%=16d", "Bytes dropped", stats.n_bytes_dropped);
1812 /* Get a line of input */
1813 if (!unformat_user (input, unformat_line_input, line_input))
1816 vlib_cli_output (vm, "RTE_SCHED_COLLECT_STATS disabled in DPDK");
1822 unformat_free (line_input);
1828 * This command is used to display statistics associated with a HQoS traffic class
1832 * Statistic collection by the scheduler is disabled by default in DPDK. In order to
1833 * turn it on, add the following line to '<em>../vpp/dpdk/Makefile</em>':
1834 * - <b>$(call set,RTE_SCHED_COLLECT_STATS,y)</b>
1837 * Example of how to display statistics of HQoS a HQoS traffic class queue:
1838 * @cliexstart{show dpdk hqos queue GigabitEthernet0/9/0 subport 0 pipe 3181 tc 0 tc_q 0}
1839 * Stats Parameter Value
1847 VLIB_CLI_COMMAND (cmd_show_dpdk_hqos_queue_stats, static) = {
1848 .path = "show dpdk hqos queue",
1849 .short_help = "show dpdk hqos queue <interface> subport <subport_id> pipe <pipe_id> tc <tc_id> tc_q <queue_id>",
1850 .function = show_dpdk_hqos_queue_stats,
1854 static clib_error_t *
1855 show_dpdk_version_command_fn (vlib_main_t * vm,
1856 unformat_input_t * input,
1857 vlib_cli_command_t * cmd)
1859 #define _(a,b,c) vlib_cli_output (vm, "%-25s " b, a ":", c);
1860 _("DPDK Version", "%s", rte_version ());
1861 _("DPDK EAL init args", "%s", dpdk_config_main.eal_init_args_str);
1867 * This command is used to display the current DPDK version and
1868 * the list of arguments passed to DPDK when started.
1871 * Example of how to display how many DPDK buffer test command has allcoated:
1872 * @cliexstart{show dpdk version}
1873 * DPDK Version: DPDK 16.11.0
1874 * DPDK EAL init args: -c 1 -n 4 --huge-dir /run/vpp/hugepages --file-prefix vpp -w 0000:00:08.0 -w 0000:00:09.0 --master-lcore 0 --socket-mem 256
1878 VLIB_CLI_COMMAND (show_vpe_version_command, static) = {
1879 .path = "show dpdk version",
1880 .short_help = "show dpdk version",
1881 .function = show_dpdk_version_command_fn,
1886 dpdk_cli_init (vlib_main_t * vm)
1891 VLIB_INIT_FUNCTION (dpdk_cli_init);
1894 * fd.io coding-style-patch-verification: ON
1897 * eval: (c-set-style "gnu")