1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
14 #include <sys/types.h>
16 #include <sys/queue.h>
23 #include <rte_common.h>
24 #include <rte_byteorder.h>
26 #include <rte_debug.h>
27 #include <rte_cycles.h>
28 #include <rte_memory.h>
29 #include <rte_launch.h>
31 #include <rte_per_lcore.h>
32 #include <rte_lcore.h>
33 #include <rte_atomic.h>
34 #include <rte_branch_prediction.h>
35 #include <rte_mempool.h>
36 #include <rte_interrupts.h>
38 #include <rte_ether.h>
39 #include <rte_ethdev.h>
40 #include <rte_string_fns.h>
41 #ifdef RTE_LIBRTE_CMDLINE
42 #include <cmdline_parse.h>
43 #include <cmdline_parse_etheraddr.h>
45 #ifdef RTE_LIBRTE_PMD_BOND
46 #include <rte_eth_bond.h>
56 #ifdef RTE_LIBRTE_CMDLINE
58 "[--cmdline-file=FILENAME] "
60 "[--help|-h] | [--auto-start|-a] | ["
61 "--tx-first | --stats-period=PERIOD | "
62 "--coremask=COREMASK --portmask=PORTMASK --numa "
63 "--mbuf-size= | --total-num-mbufs= | "
64 "--nb-cores= | --nb-ports= | "
65 #ifdef RTE_LIBRTE_CMDLINE
66 "--eth-peers-configfile= | "
67 "--eth-peer=X,M:M:M:M:M:M | "
69 "--pkt-filter-mode= |"
70 "--rss-ip | --rss-udp | "
71 "--rxpt= | --rxht= | --rxwt= | --rxfreet= | "
72 "--txpt= | --txht= | --txwt= | --txfreet= | "
73 "--txrst= | --tx-offloads= | --vxlan-gpe-port= ]\n",
75 #ifdef RTE_LIBRTE_CMDLINE
76 printf(" --interactive: run in interactive mode.\n");
77 printf(" --cmdline-file: execute cli commands before startup.\n");
79 printf(" --auto-start: start forwarding on init "
80 "[always when non-interactive].\n");
81 printf(" --help: display this message and quit.\n");
82 printf(" --tx-first: start forwarding sending a burst first "
83 "(only if interactive is disabled).\n");
84 printf(" --stats-period=PERIOD: statistics will be shown "
85 "every PERIOD seconds (only if interactive is disabled).\n");
86 printf(" --nb-cores=N: set the number of forwarding cores "
87 "(1 <= N <= %d).\n", nb_lcores);
88 printf(" --nb-ports=N: set the number of forwarding ports "
89 "(1 <= N <= %d).\n", nb_ports);
90 printf(" --coremask=COREMASK: hexadecimal bitmask of cores running "
91 "the packet forwarding test. The master lcore is reserved for "
92 "command line parsing only, and cannot be masked on for "
93 "packet forwarding.\n");
94 printf(" --portmask=PORTMASK: hexadecimal bitmask of ports used "
95 "by the packet forwarding test.\n");
96 printf(" --numa: enable NUMA-aware allocation of RX/TX rings and of "
97 "RX memory buffers (mbufs).\n");
98 printf(" --port-numa-config=(port,socket)[,(port,socket)]: "
99 "specify the socket on which the memory pool "
100 "used by the port will be allocated.\n");
101 printf(" --ring-numa-config=(port,flag,socket)[,(port,flag,socket)]: "
102 "specify the socket on which the TX/RX rings for "
103 "the port will be allocated "
104 "(flag: 1 for RX; 2 for TX; 3 for RX and TX).\n");
105 printf(" --socket-num=N: set socket from which all memory is allocated "
107 printf(" --mbuf-size=N: set the data size of mbuf to N bytes.\n");
108 printf(" --total-num-mbufs=N: set the number of mbufs to be allocated "
110 printf(" --max-pkt-len=N: set the maximum size of packet to N bytes.\n");
111 #ifdef RTE_LIBRTE_CMDLINE
112 printf(" --eth-peers-configfile=name: config file with ethernet addresses "
114 printf(" --eth-peer=X,M:M:M:M:M:M: set the MAC address of the X peer "
115 "port (0 <= X < %d).\n", RTE_MAX_ETHPORTS);
117 printf(" --pkt-filter-mode=N: set Flow Director mode "
118 "(N: none (default mode) or signature or perfect).\n");
119 printf(" --pkt-filter-report-hash=N: set Flow Director report mode "
120 "(N: none or match (default) or always).\n");
121 printf(" --pkt-filter-size=N: set Flow Director mode "
122 "(N: 64K (default mode) or 128K or 256K).\n");
123 printf(" --pkt-filter-drop-queue=N: set drop-queue. "
124 "In perfect mode, when you add a rule with queue = -1 "
125 "the packet will be enqueued into the rx drop-queue. "
126 "If the drop-queue doesn't exist, the packet is dropped. "
127 "By default drop-queue=127.\n");
128 #ifdef RTE_LIBRTE_LATENCY_STATS
129 printf(" --latencystats=N: enable latency and jitter statistcs "
130 "monitoring on forwarding lcore id N.\n");
132 printf(" --disable-crc-strip: disable CRC stripping by hardware.\n");
133 printf(" --enable-lro: enable large receive offload.\n");
134 printf(" --enable-rx-cksum: enable rx hardware checksum offload.\n");
135 printf(" --enable-rx-timestamp: enable rx hardware timestamp offload.\n");
136 printf(" --enable-hw-vlan: enable hardware vlan.\n");
137 printf(" --enable-hw-vlan-filter: enable hardware vlan filter.\n");
138 printf(" --enable-hw-vlan-strip: enable hardware vlan strip.\n");
139 printf(" --enable-hw-vlan-extend: enable hardware vlan extend.\n");
140 printf(" --enable-drop-en: enable per queue packet drop.\n");
141 printf(" --disable-rss: disable rss.\n");
142 printf(" --port-topology=N: set port topology (N: paired (default) or "
144 printf(" --forward-mode=N: set forwarding mode (N: %s).\n",
145 list_pkt_forwarding_modes());
146 printf(" --rss-ip: set RSS functions to IPv4/IPv6 only .\n");
147 printf(" --rss-udp: set RSS functions to IPv4/IPv6 + UDP.\n");
148 printf(" --rxq=N: set the number of RX queues per port to N.\n");
149 printf(" --rxd=N: set the number of descriptors in RX rings to N.\n");
150 printf(" --txq=N: set the number of TX queues per port to N.\n");
151 printf(" --txd=N: set the number of descriptors in TX rings to N.\n");
152 printf(" --burst=N: set the number of packets per burst to N.\n");
153 printf(" --mbcache=N: set the cache of mbuf memory pool to N.\n");
154 printf(" --rxpt=N: set prefetch threshold register of RX rings to N.\n");
155 printf(" --rxht=N: set the host threshold register of RX rings to N.\n");
156 printf(" --rxfreet=N: set the free threshold of RX descriptors to N "
157 "(0 <= N < value of rxd).\n");
158 printf(" --rxwt=N: set the write-back threshold register of RX rings to N.\n");
159 printf(" --txpt=N: set the prefetch threshold register of TX rings to N.\n");
160 printf(" --txht=N: set the nhost threshold register of TX rings to N.\n");
161 printf(" --txwt=N: set the write-back threshold register of TX rings to N.\n");
162 printf(" --txfreet=N: set the transmit free threshold of TX rings to N "
163 "(0 <= N <= value of txd).\n");
164 printf(" --txrst=N: set the transmit RS bit threshold of TX rings to N "
165 "(0 <= N <= value of txd).\n");
166 printf(" --tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping]: "
167 "tx queues statistics counters mapping "
168 "(0 <= mapping <= %d).\n", RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
169 printf(" --rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping]: "
170 "rx queues statistics counters mapping "
171 "(0 <= mapping <= %d).\n", RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
172 printf(" --no-flush-rx: Don't flush RX streams before forwarding."
173 " Used mainly with PCAP drivers.\n");
174 printf(" --txpkts=X[,Y]*: set TX segment sizes"
175 " or total packet length.\n");
176 printf(" --txonly-multi-flow: generate multiple flows in txonly mode\n");
177 printf(" --disable-link-check: disable check on link status when "
178 "starting/stopping ports.\n");
179 printf(" --no-lsc-interrupt: disable link status change interrupt.\n");
180 printf(" --no-rmv-interrupt: disable device removal interrupt.\n");
181 printf(" --bitrate-stats=N: set the logical core N to perform "
182 "bit-rate calculation.\n");
183 printf(" --print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|all>: "
184 "enable print of designated event or all of them.\n");
185 printf(" --mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|all>: "
186 "disable print of designated event or all of them.\n");
187 printf(" --flow-isolate-all: "
188 "requests flow API isolated mode on all ports at initialization time.\n");
189 printf(" --tx-offloads=0xXXXXXXXX: hexadecimal bitmask of TX queue offloads\n");
190 printf(" --hot-plug: enable hot plug for device.\n");
191 printf(" --vxlan-gpe-port=N: UPD port of tunnel VXLAN-GPE\n");
192 printf(" --mlockall: lock all memory\n");
193 printf(" --no-mlockall: do not lock all memory\n");
194 printf(" --mp-alloc <native|anon|xmem|xmemhuge>: mempool allocation method.\n"
195 " native: use regular DPDK memory to create and populate mempool\n"
196 " anon: use regular DPDK memory to create and anonymous memory to populate mempool\n"
197 " xmem: use anonymous memory to create and populate mempool\n"
198 " xmemhuge: use anonymous hugepage memory to create and populate mempool\n");
199 printf(" --noisy-tx-sw-buffer-size=N: size of FIFO buffer\n");
200 printf(" --noisy-tx-sw-buffer-flushtime=N: flush FIFO after N ms\n");
201 printf(" --noisy-lkup-memory=N: allocate N MB of VNF memory\n");
202 printf(" --noisy-lkup-num-writes=N: do N random writes per packet\n");
203 printf(" --noisy-lkup-num-reads=N: do N random reads per packet\n");
204 printf(" --noisy-lkup-num-writes=N: do N random reads and writes per packet\n");
205 printf(" --no-iova-contig: mempool memory can be IOVA non contiguous. "
206 "valid only with --mp-alloc=anon\n");
209 #ifdef RTE_LIBRTE_CMDLINE
211 init_peer_eth_addrs(char *config_filename)
217 config_file = fopen(config_filename, "r");
218 if (config_file == NULL) {
219 perror("Failed to open eth config file\n");
223 for (i = 0; i < RTE_MAX_ETHPORTS; i++) {
225 if (fgets(buf, sizeof(buf), config_file) == NULL)
228 if (cmdline_parse_etheraddr(NULL, buf, &peer_eth_addrs[i],
229 sizeof(peer_eth_addrs[i])) < 0) {
230 printf("Bad MAC address format on line %d\n", i+1);
236 nb_peer_eth_addrs = (portid_t) i;
242 * Parse the coremask given as argument (hexadecimal string) and set
243 * the global configuration of forwarding cores.
246 parse_fwd_coremask(const char *coremask)
249 unsigned long long int cm;
251 /* parse hexadecimal string */
253 cm = strtoull(coremask, &end, 16);
254 if ((coremask[0] == '\0') || (end == NULL) || (*end != '\0'))
255 rte_exit(EXIT_FAILURE, "Invalid fwd core mask\n");
256 else if (set_fwd_lcores_mask((uint64_t) cm) < 0)
257 rte_exit(EXIT_FAILURE, "coremask is not valid\n");
261 * Parse the coremask given as argument (hexadecimal string) and set
262 * the global configuration of forwarding cores.
265 parse_fwd_portmask(const char *portmask)
268 unsigned long long int pm;
270 /* parse hexadecimal string */
272 pm = strtoull(portmask, &end, 16);
273 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
274 rte_exit(EXIT_FAILURE, "Invalid fwd port mask\n");
276 set_fwd_ports_mask((uint64_t) pm);
281 parse_queue_stats_mapping_config(const char *q_arg, int is_rx)
284 const char *p, *p0 = q_arg;
292 unsigned long int_fld[_NUM_FLD];
293 char *str_fld[_NUM_FLD];
297 /* reset from value set at definition */
298 is_rx ? (nb_rx_queue_stats_mappings = 0) : (nb_tx_queue_stats_mappings = 0);
300 while ((p = strchr(p0,'(')) != NULL) {
302 if((p0 = strchr(p,')')) == NULL)
306 if(size >= sizeof(s))
309 snprintf(s, sizeof(s), "%.*s", size, p);
310 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
312 for (i = 0; i < _NUM_FLD; i++){
314 int_fld[i] = strtoul(str_fld[i], &end, 0);
315 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
318 /* Check mapping field is in correct range (0..RTE_ETHDEV_QUEUE_STAT_CNTRS-1) */
319 if (int_fld[FLD_STATS_COUNTER] >= RTE_ETHDEV_QUEUE_STAT_CNTRS) {
320 printf("Stats counter not in the correct range 0..%d\n",
321 RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
326 if ((nb_tx_queue_stats_mappings >=
327 MAX_TX_QUEUE_STATS_MAPPINGS)) {
328 printf("exceeded max number of TX queue "
329 "statistics mappings: %hu\n",
330 nb_tx_queue_stats_mappings);
333 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].port_id =
334 (uint8_t)int_fld[FLD_PORT];
335 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].queue_id =
336 (uint8_t)int_fld[FLD_QUEUE];
337 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].stats_counter_id =
338 (uint8_t)int_fld[FLD_STATS_COUNTER];
339 ++nb_tx_queue_stats_mappings;
342 if ((nb_rx_queue_stats_mappings >=
343 MAX_RX_QUEUE_STATS_MAPPINGS)) {
344 printf("exceeded max number of RX queue "
345 "statistics mappings: %hu\n",
346 nb_rx_queue_stats_mappings);
349 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].port_id =
350 (uint8_t)int_fld[FLD_PORT];
351 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].queue_id =
352 (uint8_t)int_fld[FLD_QUEUE];
353 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].stats_counter_id =
354 (uint8_t)int_fld[FLD_STATS_COUNTER];
355 ++nb_rx_queue_stats_mappings;
359 /* Reassign the rx/tx_queue_stats_mappings pointer to point to this newly populated array rather */
360 /* than to the default array (that was set at its definition) */
361 is_rx ? (rx_queue_stats_mappings = rx_queue_stats_mappings_array) :
362 (tx_queue_stats_mappings = tx_queue_stats_mappings_array);
367 print_invalid_socket_id_error(void)
371 printf("Invalid socket id, options are: ");
372 for (i = 0; i < num_sockets; i++) {
373 printf("%u%s", socket_ids[i],
374 (i == num_sockets - 1) ? "\n" : ",");
379 parse_portnuma_config(const char *q_arg)
382 const char *p, *p0 = q_arg;
384 uint8_t i, socket_id;
392 unsigned long int_fld[_NUM_FLD];
393 char *str_fld[_NUM_FLD];
395 /* reset from value set at definition */
396 while ((p = strchr(p0,'(')) != NULL) {
398 if((p0 = strchr(p,')')) == NULL)
402 if(size >= sizeof(s))
405 snprintf(s, sizeof(s), "%.*s", size, p);
406 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
408 for (i = 0; i < _NUM_FLD; i++) {
410 int_fld[i] = strtoul(str_fld[i], &end, 0);
411 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
414 port_id = (portid_t)int_fld[FLD_PORT];
415 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
416 port_id == (portid_t)RTE_PORT_ALL) {
420 socket_id = (uint8_t)int_fld[FLD_SOCKET];
421 if (new_socket_id(socket_id)) {
422 if (num_sockets >= RTE_MAX_NUMA_NODES) {
423 print_invalid_socket_id_error();
426 socket_ids[num_sockets++] = socket_id;
428 port_numa[port_id] = socket_id;
435 parse_ringnuma_config(const char *q_arg)
438 const char *p, *p0 = q_arg;
440 uint8_t i, ring_flag, socket_id;
449 unsigned long int_fld[_NUM_FLD];
450 char *str_fld[_NUM_FLD];
451 #define RX_RING_ONLY 0x1
452 #define TX_RING_ONLY 0x2
453 #define RXTX_RING 0x3
455 /* reset from value set at definition */
456 while ((p = strchr(p0,'(')) != NULL) {
458 if((p0 = strchr(p,')')) == NULL)
462 if(size >= sizeof(s))
465 snprintf(s, sizeof(s), "%.*s", size, p);
466 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
468 for (i = 0; i < _NUM_FLD; i++) {
470 int_fld[i] = strtoul(str_fld[i], &end, 0);
471 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
474 port_id = (portid_t)int_fld[FLD_PORT];
475 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
476 port_id == (portid_t)RTE_PORT_ALL) {
480 socket_id = (uint8_t)int_fld[FLD_SOCKET];
481 if (new_socket_id(socket_id)) {
482 if (num_sockets >= RTE_MAX_NUMA_NODES) {
483 print_invalid_socket_id_error();
486 socket_ids[num_sockets++] = socket_id;
488 ring_flag = (uint8_t)int_fld[FLD_FLAG];
489 if ((ring_flag < RX_RING_ONLY) || (ring_flag > RXTX_RING)) {
490 printf("Invalid ring-flag=%d config for port =%d\n",
495 switch (ring_flag & RXTX_RING) {
497 rxring_numa[port_id] = socket_id;
500 txring_numa[port_id] = socket_id;
503 rxring_numa[port_id] = socket_id;
504 txring_numa[port_id] = socket_id;
507 printf("Invalid ring-flag=%d config for port=%d\n",
517 parse_event_printing_config(const char *optarg, int enable)
521 if (!strcmp(optarg, "unknown"))
522 mask = UINT32_C(1) << RTE_ETH_EVENT_UNKNOWN;
523 else if (!strcmp(optarg, "intr_lsc"))
524 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_LSC;
525 else if (!strcmp(optarg, "queue_state"))
526 mask = UINT32_C(1) << RTE_ETH_EVENT_QUEUE_STATE;
527 else if (!strcmp(optarg, "intr_reset"))
528 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RESET;
529 else if (!strcmp(optarg, "vf_mbox"))
530 mask = UINT32_C(1) << RTE_ETH_EVENT_VF_MBOX;
531 else if (!strcmp(optarg, "ipsec"))
532 mask = UINT32_C(1) << RTE_ETH_EVENT_IPSEC;
533 else if (!strcmp(optarg, "macsec"))
534 mask = UINT32_C(1) << RTE_ETH_EVENT_MACSEC;
535 else if (!strcmp(optarg, "intr_rmv"))
536 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RMV;
537 else if (!strcmp(optarg, "dev_probed"))
538 mask = UINT32_C(1) << RTE_ETH_EVENT_NEW;
539 else if (!strcmp(optarg, "dev_released"))
540 mask = UINT32_C(1) << RTE_ETH_EVENT_DESTROY;
541 else if (!strcmp(optarg, "all"))
544 fprintf(stderr, "Invalid event: %s\n", optarg);
548 event_print_mask |= mask;
550 event_print_mask &= ~mask;
555 launch_args_parse(int argc, char** argv)
562 /* Default offloads for all ports. */
563 uint64_t rx_offloads = rx_mode.offloads;
564 uint64_t tx_offloads = tx_mode.offloads;
565 struct rte_eth_dev_info dev_info;
566 uint16_t rec_nb_pkts;
568 static struct option lgopts[] = {
570 #ifdef RTE_LIBRTE_CMDLINE
571 { "interactive", 0, 0, 0 },
572 { "cmdline-file", 1, 0, 0 },
573 { "auto-start", 0, 0, 0 },
574 { "eth-peers-configfile", 1, 0, 0 },
575 { "eth-peer", 1, 0, 0 },
577 { "tx-first", 0, 0, 0 },
578 { "stats-period", 1, 0, 0 },
579 { "ports", 1, 0, 0 },
580 { "nb-cores", 1, 0, 0 },
581 { "nb-ports", 1, 0, 0 },
582 { "coremask", 1, 0, 0 },
583 { "portmask", 1, 0, 0 },
585 { "no-numa", 0, 0, 0 },
586 { "mp-anon", 0, 0, 0 },
587 { "port-numa-config", 1, 0, 0 },
588 { "ring-numa-config", 1, 0, 0 },
589 { "socket-num", 1, 0, 0 },
590 { "mbuf-size", 1, 0, 0 },
591 { "total-num-mbufs", 1, 0, 0 },
592 { "max-pkt-len", 1, 0, 0 },
593 { "pkt-filter-mode", 1, 0, 0 },
594 { "pkt-filter-report-hash", 1, 0, 0 },
595 { "pkt-filter-size", 1, 0, 0 },
596 { "pkt-filter-drop-queue", 1, 0, 0 },
597 #ifdef RTE_LIBRTE_LATENCY_STATS
598 { "latencystats", 1, 0, 0 },
600 #ifdef RTE_LIBRTE_BITRATE
601 { "bitrate-stats", 1, 0, 0 },
603 { "disable-crc-strip", 0, 0, 0 },
604 { "enable-lro", 0, 0, 0 },
605 { "enable-rx-cksum", 0, 0, 0 },
606 { "enable-rx-timestamp", 0, 0, 0 },
607 { "enable-scatter", 0, 0, 0 },
608 { "enable-hw-vlan", 0, 0, 0 },
609 { "enable-hw-vlan-filter", 0, 0, 0 },
610 { "enable-hw-vlan-strip", 0, 0, 0 },
611 { "enable-hw-vlan-extend", 0, 0, 0 },
612 { "enable-drop-en", 0, 0, 0 },
613 { "disable-rss", 0, 0, 0 },
614 { "port-topology", 1, 0, 0 },
615 { "forward-mode", 1, 0, 0 },
616 { "rss-ip", 0, 0, 0 },
617 { "rss-udp", 0, 0, 0 },
622 { "burst", 1, 0, 0 },
623 { "mbcache", 1, 0, 0 },
627 { "txfreet", 1, 0, 0 },
628 { "txrst", 1, 0, 0 },
632 { "rxfreet", 1, 0, 0 },
633 { "tx-queue-stats-mapping", 1, 0, 0 },
634 { "rx-queue-stats-mapping", 1, 0, 0 },
635 { "no-flush-rx", 0, 0, 0 },
636 { "flow-isolate-all", 0, 0, 0 },
637 { "txpkts", 1, 0, 0 },
638 { "txonly-multi-flow", 0, 0, 0 },
639 { "disable-link-check", 0, 0, 0 },
640 { "no-lsc-interrupt", 0, 0, 0 },
641 { "no-rmv-interrupt", 0, 0, 0 },
642 { "print-event", 1, 0, 0 },
643 { "mask-event", 1, 0, 0 },
644 { "tx-offloads", 1, 0, 0 },
645 { "hot-plug", 0, 0, 0 },
646 { "vxlan-gpe-port", 1, 0, 0 },
647 { "mlockall", 0, 0, 0 },
648 { "no-mlockall", 0, 0, 0 },
649 { "mp-alloc", 1, 0, 0 },
650 { "noisy-tx-sw-buffer-size", 1, 0, 0 },
651 { "noisy-tx-sw-buffer-flushtime", 1, 0, 0 },
652 { "noisy-lkup-memory", 1, 0, 0 },
653 { "noisy-lkup-num-writes", 1, 0, 0 },
654 { "noisy-lkup-num-reads", 1, 0, 0 },
655 { "noisy-lkup-num-reads-writes", 1, 0, 0 },
656 { "no-iova-contig", 0, 0, 0 },
662 #ifdef RTE_LIBRTE_CMDLINE
663 #define SHORTOPTS "i"
667 while ((opt = getopt_long(argc, argvopt, SHORTOPTS "ah",
668 lgopts, &opt_idx)) != EOF) {
670 #ifdef RTE_LIBRTE_CMDLINE
672 printf("Interactive-mode selected\n");
677 printf("Auto-start selected\n");
681 case 0: /*long options */
682 if (!strcmp(lgopts[opt_idx].name, "help")) {
684 rte_exit(EXIT_SUCCESS, "Displayed help\n");
686 #ifdef RTE_LIBRTE_CMDLINE
687 if (!strcmp(lgopts[opt_idx].name, "interactive")) {
688 printf("Interactive-mode selected\n");
691 if (!strcmp(lgopts[opt_idx].name, "cmdline-file")) {
692 printf("CLI commands to be read from %s\n",
694 strlcpy(cmdline_filename, optarg,
695 sizeof(cmdline_filename));
697 if (!strcmp(lgopts[opt_idx].name, "auto-start")) {
698 printf("Auto-start selected\n");
701 if (!strcmp(lgopts[opt_idx].name, "tx-first")) {
702 printf("Ports to start sending a burst of "
706 if (!strcmp(lgopts[opt_idx].name, "stats-period")) {
710 n = strtoul(optarg, &end, 10);
711 if ((optarg[0] == '\0') || (end == NULL) ||
718 if (!strcmp(lgopts[opt_idx].name,
719 "eth-peers-configfile")) {
720 if (init_peer_eth_addrs(optarg) != 0)
721 rte_exit(EXIT_FAILURE,
722 "Cannot open logfile\n");
724 if (!strcmp(lgopts[opt_idx].name, "eth-peer")) {
726 uint8_t c, peer_addr[6];
729 n = strtoul(optarg, &port_end, 10);
730 if (errno != 0 || port_end == optarg || *port_end++ != ',')
731 rte_exit(EXIT_FAILURE,
732 "Invalid eth-peer: %s", optarg);
733 if (n >= RTE_MAX_ETHPORTS)
734 rte_exit(EXIT_FAILURE,
735 "eth-peer: port %d >= RTE_MAX_ETHPORTS(%d)\n",
736 n, RTE_MAX_ETHPORTS);
738 if (cmdline_parse_etheraddr(NULL, port_end,
739 &peer_addr, sizeof(peer_addr)) < 0)
740 rte_exit(EXIT_FAILURE,
741 "Invalid ethernet address: %s\n",
743 for (c = 0; c < 6; c++)
744 peer_eth_addrs[n].addr_bytes[c] =
749 if (!strcmp(lgopts[opt_idx].name, "nb-ports")) {
751 if (n > 0 && n <= nb_ports)
754 rte_exit(EXIT_FAILURE,
755 "Invalid port %d\n", n);
757 if (!strcmp(lgopts[opt_idx].name, "nb-cores")) {
759 if (n > 0 && n <= nb_lcores)
760 nb_fwd_lcores = (uint8_t) n;
762 rte_exit(EXIT_FAILURE,
763 "nb-cores should be > 0 and <= %d\n",
766 if (!strcmp(lgopts[opt_idx].name, "coremask"))
767 parse_fwd_coremask(optarg);
768 if (!strcmp(lgopts[opt_idx].name, "portmask"))
769 parse_fwd_portmask(optarg);
770 if (!strcmp(lgopts[opt_idx].name, "no-numa"))
772 if (!strcmp(lgopts[opt_idx].name, "numa"))
774 if (!strcmp(lgopts[opt_idx].name, "mp-anon")) {
775 mp_alloc_type = MP_ALLOC_ANON;
777 if (!strcmp(lgopts[opt_idx].name, "mp-alloc")) {
778 if (!strcmp(optarg, "native"))
779 mp_alloc_type = MP_ALLOC_NATIVE;
780 else if (!strcmp(optarg, "anon"))
781 mp_alloc_type = MP_ALLOC_ANON;
782 else if (!strcmp(optarg, "xmem"))
783 mp_alloc_type = MP_ALLOC_XMEM;
784 else if (!strcmp(optarg, "xmemhuge"))
785 mp_alloc_type = MP_ALLOC_XMEM_HUGE;
787 rte_exit(EXIT_FAILURE,
788 "mp-alloc %s invalid - must be: "
789 "native, anon, xmem or xmemhuge\n",
792 if (!strcmp(lgopts[opt_idx].name, "port-numa-config")) {
793 if (parse_portnuma_config(optarg))
794 rte_exit(EXIT_FAILURE,
795 "invalid port-numa configuration\n");
797 if (!strcmp(lgopts[opt_idx].name, "ring-numa-config"))
798 if (parse_ringnuma_config(optarg))
799 rte_exit(EXIT_FAILURE,
800 "invalid ring-numa configuration\n");
801 if (!strcmp(lgopts[opt_idx].name, "socket-num")) {
803 if (!new_socket_id((uint8_t)n)) {
804 socket_num = (uint8_t)n;
806 print_invalid_socket_id_error();
807 rte_exit(EXIT_FAILURE,
808 "Invalid socket id");
811 if (!strcmp(lgopts[opt_idx].name, "mbuf-size")) {
813 if (n > 0 && n <= 0xFFFF)
814 mbuf_data_size = (uint16_t) n;
816 rte_exit(EXIT_FAILURE,
817 "mbuf-size should be > 0 and < 65536\n");
819 if (!strcmp(lgopts[opt_idx].name, "total-num-mbufs")) {
822 param_total_num_mbufs = (unsigned)n;
824 rte_exit(EXIT_FAILURE,
825 "total-num-mbufs should be > 1024\n");
827 if (!strcmp(lgopts[opt_idx].name, "max-pkt-len")) {
829 if (n >= ETHER_MIN_LEN) {
830 rx_mode.max_rx_pkt_len = (uint32_t) n;
831 if (n > ETHER_MAX_LEN)
833 DEV_RX_OFFLOAD_JUMBO_FRAME;
835 rte_exit(EXIT_FAILURE,
836 "Invalid max-pkt-len=%d - should be > %d\n",
839 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-mode")) {
840 if (!strcmp(optarg, "signature"))
842 RTE_FDIR_MODE_SIGNATURE;
843 else if (!strcmp(optarg, "perfect"))
844 fdir_conf.mode = RTE_FDIR_MODE_PERFECT;
845 else if (!strcmp(optarg, "perfect-mac-vlan"))
846 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_MAC_VLAN;
847 else if (!strcmp(optarg, "perfect-tunnel"))
848 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_TUNNEL;
849 else if (!strcmp(optarg, "none"))
850 fdir_conf.mode = RTE_FDIR_MODE_NONE;
852 rte_exit(EXIT_FAILURE,
853 "pkt-mode-invalid %s invalid - must be: "
854 "none, signature, perfect, perfect-mac-vlan"
855 " or perfect-tunnel\n",
858 if (!strcmp(lgopts[opt_idx].name,
859 "pkt-filter-report-hash")) {
860 if (!strcmp(optarg, "none"))
862 RTE_FDIR_NO_REPORT_STATUS;
863 else if (!strcmp(optarg, "match"))
865 RTE_FDIR_REPORT_STATUS;
866 else if (!strcmp(optarg, "always"))
868 RTE_FDIR_REPORT_STATUS_ALWAYS;
870 rte_exit(EXIT_FAILURE,
871 "pkt-filter-report-hash %s invalid "
872 "- must be: none or match or always\n",
875 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-size")) {
876 if (!strcmp(optarg, "64K"))
878 RTE_FDIR_PBALLOC_64K;
879 else if (!strcmp(optarg, "128K"))
881 RTE_FDIR_PBALLOC_128K;
882 else if (!strcmp(optarg, "256K"))
884 RTE_FDIR_PBALLOC_256K;
886 rte_exit(EXIT_FAILURE, "pkt-filter-size %s invalid -"
887 " must be: 64K or 128K or 256K\n",
890 if (!strcmp(lgopts[opt_idx].name,
891 "pkt-filter-drop-queue")) {
894 fdir_conf.drop_queue = (uint8_t) n;
896 rte_exit(EXIT_FAILURE,
897 "drop queue %d invalid - must"
900 #ifdef RTE_LIBRTE_LATENCY_STATS
901 if (!strcmp(lgopts[opt_idx].name,
905 latencystats_lcore_id = (lcoreid_t) n;
906 latencystats_enabled = 1;
908 rte_exit(EXIT_FAILURE,
909 "invalid lcore id %d for latencystats"
910 " must be >= 0\n", n);
913 #ifdef RTE_LIBRTE_BITRATE
914 if (!strcmp(lgopts[opt_idx].name, "bitrate-stats")) {
917 bitrate_lcore_id = (lcoreid_t) n;
920 rte_exit(EXIT_FAILURE,
921 "invalid lcore id %d for bitrate stats"
922 " must be >= 0\n", n);
925 if (!strcmp(lgopts[opt_idx].name, "disable-crc-strip"))
926 rx_offloads |= DEV_RX_OFFLOAD_KEEP_CRC;
927 if (!strcmp(lgopts[opt_idx].name, "enable-lro"))
928 rx_offloads |= DEV_RX_OFFLOAD_TCP_LRO;
929 if (!strcmp(lgopts[opt_idx].name, "enable-scatter"))
930 rx_offloads |= DEV_RX_OFFLOAD_SCATTER;
931 if (!strcmp(lgopts[opt_idx].name, "enable-rx-cksum"))
932 rx_offloads |= DEV_RX_OFFLOAD_CHECKSUM;
933 if (!strcmp(lgopts[opt_idx].name,
934 "enable-rx-timestamp"))
935 rx_offloads |= DEV_RX_OFFLOAD_TIMESTAMP;
936 if (!strcmp(lgopts[opt_idx].name, "enable-hw-vlan"))
937 rx_offloads |= DEV_RX_OFFLOAD_VLAN;
939 if (!strcmp(lgopts[opt_idx].name,
940 "enable-hw-vlan-filter"))
941 rx_offloads |= DEV_RX_OFFLOAD_VLAN_FILTER;
943 if (!strcmp(lgopts[opt_idx].name,
944 "enable-hw-vlan-strip"))
945 rx_offloads |= DEV_RX_OFFLOAD_VLAN_STRIP;
947 if (!strcmp(lgopts[opt_idx].name,
948 "enable-hw-vlan-extend"))
949 rx_offloads |= DEV_RX_OFFLOAD_VLAN_EXTEND;
951 if (!strcmp(lgopts[opt_idx].name, "enable-drop-en"))
954 if (!strcmp(lgopts[opt_idx].name, "disable-rss"))
956 if (!strcmp(lgopts[opt_idx].name, "port-topology")) {
957 if (!strcmp(optarg, "paired"))
958 port_topology = PORT_TOPOLOGY_PAIRED;
959 else if (!strcmp(optarg, "chained"))
960 port_topology = PORT_TOPOLOGY_CHAINED;
961 else if (!strcmp(optarg, "loop"))
962 port_topology = PORT_TOPOLOGY_LOOP;
964 rte_exit(EXIT_FAILURE, "port-topology %s invalid -"
965 " must be: paired, chained or loop\n",
968 if (!strcmp(lgopts[opt_idx].name, "forward-mode"))
969 set_pkt_forwarding_mode(optarg);
970 if (!strcmp(lgopts[opt_idx].name, "rss-ip"))
972 if (!strcmp(lgopts[opt_idx].name, "rss-udp"))
973 rss_hf = ETH_RSS_UDP;
974 if (!strcmp(lgopts[opt_idx].name, "rxq")) {
976 if (n >= 0 && check_nb_rxq((queueid_t)n) == 0)
977 nb_rxq = (queueid_t) n;
979 rte_exit(EXIT_FAILURE, "rxq %d invalid - must be"
980 " >= 0 && <= %u\n", n,
981 get_allowed_max_nb_rxq(&pid));
983 if (!strcmp(lgopts[opt_idx].name, "txq")) {
985 if (n >= 0 && check_nb_txq((queueid_t)n) == 0)
986 nb_txq = (queueid_t) n;
988 rte_exit(EXIT_FAILURE, "txq %d invalid - must be"
989 " >= 0 && <= %u\n", n,
990 get_allowed_max_nb_txq(&pid));
992 if (!nb_rxq && !nb_txq) {
993 rte_exit(EXIT_FAILURE, "Either rx or tx queues should "
996 if (!strcmp(lgopts[opt_idx].name, "burst")) {
999 /* A burst size of zero means that the
1000 * PMD should be queried for
1001 * recommended Rx burst size. Since
1002 * testpmd uses a single size for all
1003 * ports, port 0 is queried for the
1004 * value, on the assumption that all
1005 * ports are of the same NIC model.
1007 rte_eth_dev_info_get(0, &dev_info);
1008 rec_nb_pkts = dev_info
1009 .default_rxportconf.burst_size;
1011 if (rec_nb_pkts == 0)
1012 rte_exit(EXIT_FAILURE,
1013 "PMD does not recommend a burst size. "
1014 "Provided value must be between "
1015 "1 and %d\n", MAX_PKT_BURST);
1016 else if (rec_nb_pkts > MAX_PKT_BURST)
1017 rte_exit(EXIT_FAILURE,
1018 "PMD recommended burst size of %d"
1019 " exceeds maximum value of %d\n",
1020 rec_nb_pkts, MAX_PKT_BURST);
1021 printf("Using PMD-provided burst value of %d\n",
1023 nb_pkt_per_burst = rec_nb_pkts;
1024 } else if (n > MAX_PKT_BURST)
1025 rte_exit(EXIT_FAILURE,
1026 "burst must be between1 and %d\n",
1029 nb_pkt_per_burst = (uint16_t) n;
1031 if (!strcmp(lgopts[opt_idx].name, "mbcache")) {
1034 (n <= RTE_MEMPOOL_CACHE_MAX_SIZE))
1035 mb_mempool_cache = (uint16_t) n;
1037 rte_exit(EXIT_FAILURE,
1038 "mbcache must be >= 0 and <= %d\n",
1039 RTE_MEMPOOL_CACHE_MAX_SIZE);
1041 if (!strcmp(lgopts[opt_idx].name, "txfreet")) {
1044 tx_free_thresh = (int16_t)n;
1046 rte_exit(EXIT_FAILURE, "txfreet must be >= 0\n");
1048 if (!strcmp(lgopts[opt_idx].name, "txrst")) {
1051 tx_rs_thresh = (int16_t)n;
1053 rte_exit(EXIT_FAILURE, "txrst must be >= 0\n");
1055 if (!strcmp(lgopts[opt_idx].name, "rxd")) {
1058 if (rx_free_thresh >= n)
1059 rte_exit(EXIT_FAILURE,
1061 "rx_free_thresh(%d)\n",
1062 (int)rx_free_thresh);
1064 nb_rxd = (uint16_t) n;
1066 rte_exit(EXIT_FAILURE,
1067 "rxd(%d) invalid - must be > 0\n",
1070 if (!strcmp(lgopts[opt_idx].name, "txd")) {
1073 nb_txd = (uint16_t) n;
1075 rte_exit(EXIT_FAILURE, "txd must be in > 0\n");
1077 if (!strcmp(lgopts[opt_idx].name, "txpt")) {
1080 tx_pthresh = (int8_t)n;
1082 rte_exit(EXIT_FAILURE, "txpt must be >= 0\n");
1084 if (!strcmp(lgopts[opt_idx].name, "txht")) {
1087 tx_hthresh = (int8_t)n;
1089 rte_exit(EXIT_FAILURE, "txht must be >= 0\n");
1091 if (!strcmp(lgopts[opt_idx].name, "txwt")) {
1094 tx_wthresh = (int8_t)n;
1096 rte_exit(EXIT_FAILURE, "txwt must be >= 0\n");
1098 if (!strcmp(lgopts[opt_idx].name, "rxpt")) {
1101 rx_pthresh = (int8_t)n;
1103 rte_exit(EXIT_FAILURE, "rxpt must be >= 0\n");
1105 if (!strcmp(lgopts[opt_idx].name, "rxht")) {
1108 rx_hthresh = (int8_t)n;
1110 rte_exit(EXIT_FAILURE, "rxht must be >= 0\n");
1112 if (!strcmp(lgopts[opt_idx].name, "rxwt")) {
1115 rx_wthresh = (int8_t)n;
1117 rte_exit(EXIT_FAILURE, "rxwt must be >= 0\n");
1119 if (!strcmp(lgopts[opt_idx].name, "rxfreet")) {
1122 rx_free_thresh = (int16_t)n;
1124 rte_exit(EXIT_FAILURE, "rxfreet must be >= 0\n");
1126 if (!strcmp(lgopts[opt_idx].name, "tx-queue-stats-mapping")) {
1127 if (parse_queue_stats_mapping_config(optarg, TX)) {
1128 rte_exit(EXIT_FAILURE,
1129 "invalid TX queue statistics mapping config entered\n");
1132 if (!strcmp(lgopts[opt_idx].name, "rx-queue-stats-mapping")) {
1133 if (parse_queue_stats_mapping_config(optarg, RX)) {
1134 rte_exit(EXIT_FAILURE,
1135 "invalid RX queue statistics mapping config entered\n");
1138 if (!strcmp(lgopts[opt_idx].name, "txpkts")) {
1139 unsigned seg_lengths[RTE_MAX_SEGS_PER_PKT];
1140 unsigned int nb_segs;
1142 nb_segs = parse_item_list(optarg, "txpkt segments",
1143 RTE_MAX_SEGS_PER_PKT, seg_lengths, 0);
1145 set_tx_pkt_segments(seg_lengths, nb_segs);
1147 rte_exit(EXIT_FAILURE, "bad txpkts\n");
1149 if (!strcmp(lgopts[opt_idx].name, "txonly-multi-flow"))
1150 txonly_multi_flow = 1;
1151 if (!strcmp(lgopts[opt_idx].name, "no-flush-rx"))
1153 if (!strcmp(lgopts[opt_idx].name, "disable-link-check"))
1155 if (!strcmp(lgopts[opt_idx].name, "no-lsc-interrupt"))
1157 if (!strcmp(lgopts[opt_idx].name, "no-rmv-interrupt"))
1159 if (!strcmp(lgopts[opt_idx].name, "flow-isolate-all"))
1160 flow_isolate_all = 1;
1161 if (!strcmp(lgopts[opt_idx].name, "tx-offloads")) {
1163 n = strtoull(optarg, &end, 16);
1165 tx_offloads = (uint64_t)n;
1167 rte_exit(EXIT_FAILURE,
1168 "tx-offloads must be >= 0\n");
1170 if (!strcmp(lgopts[opt_idx].name, "vxlan-gpe-port")) {
1173 vxlan_gpe_udp_port = (uint16_t)n;
1175 rte_exit(EXIT_FAILURE,
1176 "vxlan-gpe-port must be >= 0\n");
1178 if (!strcmp(lgopts[opt_idx].name, "print-event"))
1179 if (parse_event_printing_config(optarg, 1)) {
1180 rte_exit(EXIT_FAILURE,
1181 "invalid print-event argument\n");
1183 if (!strcmp(lgopts[opt_idx].name, "mask-event"))
1184 if (parse_event_printing_config(optarg, 0)) {
1185 rte_exit(EXIT_FAILURE,
1186 "invalid mask-event argument\n");
1188 if (!strcmp(lgopts[opt_idx].name, "hot-plug"))
1190 if (!strcmp(lgopts[opt_idx].name, "mlockall"))
1192 if (!strcmp(lgopts[opt_idx].name, "no-mlockall"))
1194 if (!strcmp(lgopts[opt_idx].name,
1195 "noisy-tx-sw-buffer-size")) {
1198 noisy_tx_sw_bufsz = n;
1200 rte_exit(EXIT_FAILURE,
1201 "noisy-tx-sw-buffer-size must be >= 0\n");
1203 if (!strcmp(lgopts[opt_idx].name,
1204 "noisy-tx-sw-buffer-flushtime")) {
1207 noisy_tx_sw_buf_flush_time = n;
1209 rte_exit(EXIT_FAILURE,
1210 "noisy-tx-sw-buffer-flushtime must be >= 0\n");
1212 if (!strcmp(lgopts[opt_idx].name,
1213 "noisy-lkup-memory")) {
1216 noisy_lkup_mem_sz = n;
1218 rte_exit(EXIT_FAILURE,
1219 "noisy-lkup-memory must be >= 0\n");
1221 if (!strcmp(lgopts[opt_idx].name,
1222 "noisy-lkup-num-writes")) {
1225 noisy_lkup_num_writes = n;
1227 rte_exit(EXIT_FAILURE,
1228 "noisy-lkup-num-writes must be >= 0\n");
1230 if (!strcmp(lgopts[opt_idx].name,
1231 "noisy-lkup-num-reads")) {
1234 noisy_lkup_num_reads = n;
1236 rte_exit(EXIT_FAILURE,
1237 "noisy-lkup-num-reads must be >= 0\n");
1239 if (!strcmp(lgopts[opt_idx].name,
1240 "noisy-lkup-num-reads-writes")) {
1243 noisy_lkup_num_reads_writes = n;
1245 rte_exit(EXIT_FAILURE,
1246 "noisy-lkup-num-reads-writes must be >= 0\n");
1248 if (!strcmp(lgopts[opt_idx].name, "no-iova-contig"))
1249 mempool_flags = MEMPOOL_F_NO_IOVA_CONTIG;
1253 rte_exit(EXIT_SUCCESS, "Displayed help\n");
1257 rte_exit(EXIT_FAILURE,
1258 "Command line is incomplete or incorrect\n");
1263 /* Set offload configuration from command line parameters. */
1264 rx_mode.offloads = rx_offloads;
1265 tx_mode.offloads = tx_offloads;
1267 if (mempool_flags & MEMPOOL_F_NO_IOVA_CONTIG &&
1268 mp_alloc_type != MP_ALLOC_ANON) {
1269 TESTPMD_LOG(WARNING, "cannot use no-iova-contig without "
1270 "mp-alloc=anon. mempool no-iova-contig is "