1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2017 Intel Corporation
14 #include <sys/types.h>
16 #include <sys/queue.h>
22 #include <arpa/inet.h>
24 #include <rte_common.h>
25 #include <rte_byteorder.h>
27 #include <rte_debug.h>
28 #include <rte_cycles.h>
29 #include <rte_memory.h>
30 #include <rte_launch.h>
32 #include <rte_per_lcore.h>
33 #include <rte_lcore.h>
34 #include <rte_atomic.h>
35 #include <rte_branch_prediction.h>
36 #include <rte_mempool.h>
37 #include <rte_interrupts.h>
39 #include <rte_ether.h>
40 #include <rte_ethdev.h>
41 #include <rte_string_fns.h>
42 #ifdef RTE_LIBRTE_PMD_BOND
43 #include <rte_eth_bond.h>
53 #ifdef RTE_LIBRTE_CMDLINE
55 "[--cmdline-file=FILENAME] "
57 "[--help|-h] | [--auto-start|-a] | ["
58 "--tx-first | --stats-period=PERIOD | "
59 "--coremask=COREMASK --portmask=PORTMASK --numa "
60 "--mbuf-size= | --total-num-mbufs= | "
61 "--nb-cores= | --nb-ports= | "
62 #ifdef RTE_LIBRTE_CMDLINE
63 "--eth-peers-configfile= | "
64 "--eth-peer=X,M:M:M:M:M:M | "
65 "--tx-ip=SRC,DST | --tx-udp=PORT | "
67 "--pkt-filter-mode= |"
68 "--rss-ip | --rss-udp | "
69 "--rxpt= | --rxht= | --rxwt= | --rxfreet= | "
70 "--txpt= | --txht= | --txwt= | --txfreet= | "
71 "--txrst= | --tx-offloads= | --vxlan-gpe-port= ]\n",
73 #ifdef RTE_LIBRTE_CMDLINE
74 printf(" --interactive: run in interactive mode.\n");
75 printf(" --cmdline-file: execute cli commands before startup.\n");
77 printf(" --auto-start: start forwarding on init "
78 "[always when non-interactive].\n");
79 printf(" --help: display this message and quit.\n");
80 printf(" --tx-first: start forwarding sending a burst first "
81 "(only if interactive is disabled).\n");
82 printf(" --stats-period=PERIOD: statistics will be shown "
83 "every PERIOD seconds (only if interactive is disabled).\n");
84 printf(" --nb-cores=N: set the number of forwarding cores "
85 "(1 <= N <= %d).\n", nb_lcores);
86 printf(" --nb-ports=N: set the number of forwarding ports "
87 "(1 <= N <= %d).\n", nb_ports);
88 printf(" --coremask=COREMASK: hexadecimal bitmask of cores running "
89 "the packet forwarding test. The master lcore is reserved for "
90 "command line parsing only, and cannot be masked on for "
91 "packet forwarding.\n");
92 printf(" --portmask=PORTMASK: hexadecimal bitmask of ports used "
93 "by the packet forwarding test.\n");
94 printf(" --numa: enable NUMA-aware allocation of RX/TX rings and of "
95 "RX memory buffers (mbufs).\n");
96 printf(" --port-numa-config=(port,socket)[,(port,socket)]: "
97 "specify the socket on which the memory pool "
98 "used by the port will be allocated.\n");
99 printf(" --ring-numa-config=(port,flag,socket)[,(port,flag,socket)]: "
100 "specify the socket on which the TX/RX rings for "
101 "the port will be allocated "
102 "(flag: 1 for RX; 2 for TX; 3 for RX and TX).\n");
103 printf(" --socket-num=N: set socket from which all memory is allocated "
105 printf(" --mbuf-size=N: set the data size of mbuf to N bytes.\n");
106 printf(" --total-num-mbufs=N: set the number of mbufs to be allocated "
108 printf(" --max-pkt-len=N: set the maximum size of packet to N bytes.\n");
109 #ifdef RTE_LIBRTE_CMDLINE
110 printf(" --eth-peers-configfile=name: config file with ethernet addresses "
112 printf(" --eth-peer=X,M:M:M:M:M:M: set the MAC address of the X peer "
113 "port (0 <= X < %d).\n", RTE_MAX_ETHPORTS);
115 printf(" --pkt-filter-mode=N: set Flow Director mode "
116 "(N: none (default mode) or signature or perfect).\n");
117 printf(" --pkt-filter-report-hash=N: set Flow Director report mode "
118 "(N: none or match (default) or always).\n");
119 printf(" --pkt-filter-size=N: set Flow Director mode "
120 "(N: 64K (default mode) or 128K or 256K).\n");
121 printf(" --pkt-filter-drop-queue=N: set drop-queue. "
122 "In perfect mode, when you add a rule with queue = -1 "
123 "the packet will be enqueued into the rx drop-queue. "
124 "If the drop-queue doesn't exist, the packet is dropped. "
125 "By default drop-queue=127.\n");
126 #ifdef RTE_LIBRTE_LATENCY_STATS
127 printf(" --latencystats=N: enable latency and jitter statistcs "
128 "monitoring on forwarding lcore id N.\n");
130 printf(" --disable-crc-strip: disable CRC stripping by hardware.\n");
131 printf(" --enable-lro: enable large receive offload.\n");
132 printf(" --enable-rx-cksum: enable rx hardware checksum offload.\n");
133 printf(" --enable-rx-timestamp: enable rx hardware timestamp offload.\n");
134 printf(" --enable-hw-vlan: enable hardware vlan.\n");
135 printf(" --enable-hw-vlan-filter: enable hardware vlan filter.\n");
136 printf(" --enable-hw-vlan-strip: enable hardware vlan strip.\n");
137 printf(" --enable-hw-vlan-extend: enable hardware vlan extend.\n");
138 printf(" --enable-hw-qinq-strip: enable hardware qinq strip.\n");
139 printf(" --enable-drop-en: enable per queue packet drop.\n");
140 printf(" --disable-rss: disable rss.\n");
141 printf(" --port-topology=N: set port topology (N: paired (default) or "
143 printf(" --forward-mode=N: set forwarding mode (N: %s).\n",
144 list_pkt_forwarding_modes());
145 printf(" --rss-ip: set RSS functions to IPv4/IPv6 only .\n");
146 printf(" --rss-udp: set RSS functions to IPv4/IPv6 + UDP.\n");
147 printf(" --rxq=N: set the number of RX queues per port to N.\n");
148 printf(" --rxd=N: set the number of descriptors in RX rings to N.\n");
149 printf(" --txq=N: set the number of TX queues per port to N.\n");
150 printf(" --txd=N: set the number of descriptors in TX rings to N.\n");
151 printf(" --burst=N: set the number of packets per burst to N.\n");
152 printf(" --mbcache=N: set the cache of mbuf memory pool to N.\n");
153 printf(" --rxpt=N: set prefetch threshold register of RX rings to N.\n");
154 printf(" --rxht=N: set the host threshold register of RX rings to N.\n");
155 printf(" --rxfreet=N: set the free threshold of RX descriptors to N "
156 "(0 <= N < value of rxd).\n");
157 printf(" --rxwt=N: set the write-back threshold register of RX rings to N.\n");
158 printf(" --txpt=N: set the prefetch threshold register of TX rings to N.\n");
159 printf(" --txht=N: set the nhost threshold register of TX rings to N.\n");
160 printf(" --txwt=N: set the write-back threshold register of TX rings to N.\n");
161 printf(" --txfreet=N: set the transmit free threshold of TX rings to N "
162 "(0 <= N <= value of txd).\n");
163 printf(" --txrst=N: set the transmit RS bit threshold of TX rings to N "
164 "(0 <= N <= value of txd).\n");
165 printf(" --tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping]: "
166 "tx queues statistics counters mapping "
167 "(0 <= mapping <= %d).\n", RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
168 printf(" --rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping]: "
169 "rx queues statistics counters mapping "
170 "(0 <= mapping <= %d).\n", RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
171 printf(" --no-flush-rx: Don't flush RX streams before forwarding."
172 " Used mainly with PCAP drivers.\n");
173 printf(" --txpkts=X[,Y]*: set TX segment sizes"
174 " or total packet length.\n");
175 printf(" --txonly-multi-flow: generate multiple flows in txonly mode\n");
176 printf(" --disable-link-check: disable check on link status when "
177 "starting/stopping ports.\n");
178 printf(" --disable-device-start: do not automatically start port\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 (rte_ether_unformat_addr(buf, &peer_eth_addrs[i]) < 0) {
229 printf("Bad MAC address format on line %d\n", i+1);
235 nb_peer_eth_addrs = (portid_t) i;
241 * Parse the coremask given as argument (hexadecimal string) and set
242 * the global configuration of forwarding cores.
245 parse_fwd_coremask(const char *coremask)
248 unsigned long long int cm;
250 /* parse hexadecimal string */
252 cm = strtoull(coremask, &end, 16);
253 if ((coremask[0] == '\0') || (end == NULL) || (*end != '\0'))
254 rte_exit(EXIT_FAILURE, "Invalid fwd core mask\n");
255 else if (set_fwd_lcores_mask((uint64_t) cm) < 0)
256 rte_exit(EXIT_FAILURE, "coremask is not valid\n");
260 * Parse the coremask given as argument (hexadecimal string) and set
261 * the global configuration of forwarding cores.
264 parse_fwd_portmask(const char *portmask)
267 unsigned long long int pm;
269 /* parse hexadecimal string */
271 pm = strtoull(portmask, &end, 16);
272 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
273 rte_exit(EXIT_FAILURE, "Invalid fwd port mask\n");
275 set_fwd_ports_mask((uint64_t) pm);
280 parse_queue_stats_mapping_config(const char *q_arg, int is_rx)
283 const char *p, *p0 = q_arg;
291 unsigned long int_fld[_NUM_FLD];
292 char *str_fld[_NUM_FLD];
296 /* reset from value set at definition */
297 is_rx ? (nb_rx_queue_stats_mappings = 0) : (nb_tx_queue_stats_mappings = 0);
299 while ((p = strchr(p0,'(')) != NULL) {
301 if((p0 = strchr(p,')')) == NULL)
305 if(size >= sizeof(s))
308 snprintf(s, sizeof(s), "%.*s", size, p);
309 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
311 for (i = 0; i < _NUM_FLD; i++){
313 int_fld[i] = strtoul(str_fld[i], &end, 0);
314 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
317 /* Check mapping field is in correct range (0..RTE_ETHDEV_QUEUE_STAT_CNTRS-1) */
318 if (int_fld[FLD_STATS_COUNTER] >= RTE_ETHDEV_QUEUE_STAT_CNTRS) {
319 printf("Stats counter not in the correct range 0..%d\n",
320 RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
325 if ((nb_tx_queue_stats_mappings >=
326 MAX_TX_QUEUE_STATS_MAPPINGS)) {
327 printf("exceeded max number of TX queue "
328 "statistics mappings: %hu\n",
329 nb_tx_queue_stats_mappings);
332 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].port_id =
333 (uint8_t)int_fld[FLD_PORT];
334 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].queue_id =
335 (uint8_t)int_fld[FLD_QUEUE];
336 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].stats_counter_id =
337 (uint8_t)int_fld[FLD_STATS_COUNTER];
338 ++nb_tx_queue_stats_mappings;
341 if ((nb_rx_queue_stats_mappings >=
342 MAX_RX_QUEUE_STATS_MAPPINGS)) {
343 printf("exceeded max number of RX queue "
344 "statistics mappings: %hu\n",
345 nb_rx_queue_stats_mappings);
348 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].port_id =
349 (uint8_t)int_fld[FLD_PORT];
350 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].queue_id =
351 (uint8_t)int_fld[FLD_QUEUE];
352 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].stats_counter_id =
353 (uint8_t)int_fld[FLD_STATS_COUNTER];
354 ++nb_rx_queue_stats_mappings;
358 /* Reassign the rx/tx_queue_stats_mappings pointer to point to this newly populated array rather */
359 /* than to the default array (that was set at its definition) */
360 is_rx ? (rx_queue_stats_mappings = rx_queue_stats_mappings_array) :
361 (tx_queue_stats_mappings = tx_queue_stats_mappings_array);
366 print_invalid_socket_id_error(void)
370 printf("Invalid socket id, options are: ");
371 for (i = 0; i < num_sockets; i++) {
372 printf("%u%s", socket_ids[i],
373 (i == num_sockets - 1) ? "\n" : ",");
378 parse_portnuma_config(const char *q_arg)
381 const char *p, *p0 = q_arg;
383 uint8_t i, socket_id;
391 unsigned long int_fld[_NUM_FLD];
392 char *str_fld[_NUM_FLD];
394 /* reset from value set at definition */
395 while ((p = strchr(p0,'(')) != NULL) {
397 if((p0 = strchr(p,')')) == NULL)
401 if(size >= sizeof(s))
404 snprintf(s, sizeof(s), "%.*s", size, p);
405 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
407 for (i = 0; i < _NUM_FLD; i++) {
409 int_fld[i] = strtoul(str_fld[i], &end, 0);
410 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
413 port_id = (portid_t)int_fld[FLD_PORT];
414 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
415 port_id == (portid_t)RTE_PORT_ALL) {
419 socket_id = (uint8_t)int_fld[FLD_SOCKET];
420 if (new_socket_id(socket_id)) {
421 if (num_sockets >= RTE_MAX_NUMA_NODES) {
422 print_invalid_socket_id_error();
425 socket_ids[num_sockets++] = socket_id;
427 port_numa[port_id] = socket_id;
434 parse_ringnuma_config(const char *q_arg)
437 const char *p, *p0 = q_arg;
439 uint8_t i, ring_flag, socket_id;
448 unsigned long int_fld[_NUM_FLD];
449 char *str_fld[_NUM_FLD];
450 #define RX_RING_ONLY 0x1
451 #define TX_RING_ONLY 0x2
452 #define RXTX_RING 0x3
454 /* reset from value set at definition */
455 while ((p = strchr(p0,'(')) != NULL) {
457 if((p0 = strchr(p,')')) == NULL)
461 if(size >= sizeof(s))
464 snprintf(s, sizeof(s), "%.*s", size, p);
465 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
467 for (i = 0; i < _NUM_FLD; i++) {
469 int_fld[i] = strtoul(str_fld[i], &end, 0);
470 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
473 port_id = (portid_t)int_fld[FLD_PORT];
474 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
475 port_id == (portid_t)RTE_PORT_ALL) {
479 socket_id = (uint8_t)int_fld[FLD_SOCKET];
480 if (new_socket_id(socket_id)) {
481 if (num_sockets >= RTE_MAX_NUMA_NODES) {
482 print_invalid_socket_id_error();
485 socket_ids[num_sockets++] = socket_id;
487 ring_flag = (uint8_t)int_fld[FLD_FLAG];
488 if ((ring_flag < RX_RING_ONLY) || (ring_flag > RXTX_RING)) {
489 printf("Invalid ring-flag=%d config for port =%d\n",
494 switch (ring_flag & RXTX_RING) {
496 rxring_numa[port_id] = socket_id;
499 txring_numa[port_id] = socket_id;
502 rxring_numa[port_id] = socket_id;
503 txring_numa[port_id] = socket_id;
506 printf("Invalid ring-flag=%d config for port=%d\n",
516 parse_event_printing_config(const char *optarg, int enable)
520 if (!strcmp(optarg, "unknown"))
521 mask = UINT32_C(1) << RTE_ETH_EVENT_UNKNOWN;
522 else if (!strcmp(optarg, "intr_lsc"))
523 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_LSC;
524 else if (!strcmp(optarg, "queue_state"))
525 mask = UINT32_C(1) << RTE_ETH_EVENT_QUEUE_STATE;
526 else if (!strcmp(optarg, "intr_reset"))
527 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RESET;
528 else if (!strcmp(optarg, "vf_mbox"))
529 mask = UINT32_C(1) << RTE_ETH_EVENT_VF_MBOX;
530 else if (!strcmp(optarg, "ipsec"))
531 mask = UINT32_C(1) << RTE_ETH_EVENT_IPSEC;
532 else if (!strcmp(optarg, "macsec"))
533 mask = UINT32_C(1) << RTE_ETH_EVENT_MACSEC;
534 else if (!strcmp(optarg, "intr_rmv"))
535 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RMV;
536 else if (!strcmp(optarg, "dev_probed"))
537 mask = UINT32_C(1) << RTE_ETH_EVENT_NEW;
538 else if (!strcmp(optarg, "dev_released"))
539 mask = UINT32_C(1) << RTE_ETH_EVENT_DESTROY;
540 else if (!strcmp(optarg, "all"))
543 fprintf(stderr, "Invalid event: %s\n", optarg);
547 event_print_mask |= mask;
549 event_print_mask &= ~mask;
554 launch_args_parse(int argc, char** argv)
561 /* Default offloads for all ports. */
562 uint64_t rx_offloads = rx_mode.offloads;
563 uint64_t tx_offloads = tx_mode.offloads;
564 struct rte_eth_dev_info dev_info;
565 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-hw-qinq-strip", 0, 0, 0 },
613 { "enable-drop-en", 0, 0, 0 },
614 { "disable-rss", 0, 0, 0 },
615 { "port-topology", 1, 0, 0 },
616 { "forward-mode", 1, 0, 0 },
617 { "rss-ip", 0, 0, 0 },
618 { "rss-udp", 0, 0, 0 },
623 { "burst", 1, 0, 0 },
624 { "mbcache", 1, 0, 0 },
628 { "txfreet", 1, 0, 0 },
629 { "txrst", 1, 0, 0 },
633 { "rxfreet", 1, 0, 0 },
634 { "tx-queue-stats-mapping", 1, 0, 0 },
635 { "rx-queue-stats-mapping", 1, 0, 0 },
636 { "no-flush-rx", 0, 0, 0 },
637 { "flow-isolate-all", 0, 0, 0 },
638 { "txpkts", 1, 0, 0 },
639 { "txonly-multi-flow", 0, 0, 0 },
640 { "disable-link-check", 0, 0, 0 },
641 { "disable-device-start", 0, 0, 0 },
642 { "no-lsc-interrupt", 0, 0, 0 },
643 { "no-rmv-interrupt", 0, 0, 0 },
644 { "print-event", 1, 0, 0 },
645 { "mask-event", 1, 0, 0 },
646 { "tx-offloads", 1, 0, 0 },
647 { "hot-plug", 0, 0, 0 },
648 { "vxlan-gpe-port", 1, 0, 0 },
649 { "mlockall", 0, 0, 0 },
650 { "no-mlockall", 0, 0, 0 },
651 { "mp-alloc", 1, 0, 0 },
652 { "tx-ip", 1, 0, 0 },
653 { "tx-udp", 1, 0, 0 },
654 { "noisy-tx-sw-buffer-size", 1, 0, 0 },
655 { "noisy-tx-sw-buffer-flushtime", 1, 0, 0 },
656 { "noisy-lkup-memory", 1, 0, 0 },
657 { "noisy-lkup-num-writes", 1, 0, 0 },
658 { "noisy-lkup-num-reads", 1, 0, 0 },
659 { "noisy-lkup-num-reads-writes", 1, 0, 0 },
660 { "no-iova-contig", 0, 0, 0 },
666 #ifdef RTE_LIBRTE_CMDLINE
667 #define SHORTOPTS "i"
671 while ((opt = getopt_long(argc, argvopt, SHORTOPTS "ah",
672 lgopts, &opt_idx)) != EOF) {
674 #ifdef RTE_LIBRTE_CMDLINE
676 printf("Interactive-mode selected\n");
681 printf("Auto-start selected\n");
685 case 0: /*long options */
686 if (!strcmp(lgopts[opt_idx].name, "help")) {
688 rte_exit(EXIT_SUCCESS, "Displayed help\n");
690 #ifdef RTE_LIBRTE_CMDLINE
691 if (!strcmp(lgopts[opt_idx].name, "interactive")) {
692 printf("Interactive-mode selected\n");
695 if (!strcmp(lgopts[opt_idx].name, "cmdline-file")) {
696 printf("CLI commands to be read from %s\n",
698 strlcpy(cmdline_filename, optarg,
699 sizeof(cmdline_filename));
701 if (!strcmp(lgopts[opt_idx].name, "auto-start")) {
702 printf("Auto-start selected\n");
705 if (!strcmp(lgopts[opt_idx].name, "tx-first")) {
706 printf("Ports to start sending a burst of "
710 if (!strcmp(lgopts[opt_idx].name, "stats-period")) {
714 n = strtoul(optarg, &end, 10);
715 if ((optarg[0] == '\0') || (end == NULL) ||
722 if (!strcmp(lgopts[opt_idx].name,
723 "eth-peers-configfile")) {
724 if (init_peer_eth_addrs(optarg) != 0)
725 rte_exit(EXIT_FAILURE,
726 "Cannot open logfile\n");
728 if (!strcmp(lgopts[opt_idx].name, "eth-peer")) {
732 n = strtoul(optarg, &port_end, 10);
733 if (errno != 0 || port_end == optarg || *port_end++ != ',')
734 rte_exit(EXIT_FAILURE,
735 "Invalid eth-peer: %s", optarg);
736 if (n >= RTE_MAX_ETHPORTS)
737 rte_exit(EXIT_FAILURE,
738 "eth-peer: port %d >= RTE_MAX_ETHPORTS(%d)\n",
739 n, RTE_MAX_ETHPORTS);
741 if (rte_ether_unformat_addr(port_end,
742 &peer_eth_addrs[n]) < 0)
743 rte_exit(EXIT_FAILURE,
744 "Invalid ethernet address: %s\n",
749 if (!strcmp(lgopts[opt_idx].name, "tx-ip")) {
753 end = strchr(optarg, ',');
754 if (end == optarg || !end)
755 rte_exit(EXIT_FAILURE,
756 "Invalid tx-ip: %s", optarg);
759 if (inet_aton(optarg, &in) == 0)
760 rte_exit(EXIT_FAILURE,
761 "Invalid source IP address: %s\n",
763 tx_ip_src_addr = rte_be_to_cpu_32(in.s_addr);
765 if (inet_aton(end, &in) == 0)
766 rte_exit(EXIT_FAILURE,
767 "Invalid destination IP address: %s\n",
769 tx_ip_dst_addr = rte_be_to_cpu_32(in.s_addr);
771 if (!strcmp(lgopts[opt_idx].name, "tx-udp")) {
775 n = strtoul(optarg, &end, 10);
776 if (errno != 0 || end == optarg ||
778 !(*end == '\0' || *end == ','))
779 rte_exit(EXIT_FAILURE,
780 "Invalid UDP port: %s\n",
786 n = strtoul(dst, &end, 10);
787 if (errno != 0 || end == dst ||
788 n > UINT16_MAX || *end)
789 rte_exit(EXIT_FAILURE,
790 "Invalid destination UDP port: %s\n",
798 if (!strcmp(lgopts[opt_idx].name, "nb-ports")) {
800 if (n > 0 && n <= nb_ports)
803 rte_exit(EXIT_FAILURE,
804 "Invalid port %d\n", n);
806 if (!strcmp(lgopts[opt_idx].name, "nb-cores")) {
808 if (n > 0 && n <= nb_lcores)
809 nb_fwd_lcores = (uint8_t) n;
811 rte_exit(EXIT_FAILURE,
812 "nb-cores should be > 0 and <= %d\n",
815 if (!strcmp(lgopts[opt_idx].name, "coremask"))
816 parse_fwd_coremask(optarg);
817 if (!strcmp(lgopts[opt_idx].name, "portmask"))
818 parse_fwd_portmask(optarg);
819 if (!strcmp(lgopts[opt_idx].name, "no-numa"))
821 if (!strcmp(lgopts[opt_idx].name, "numa"))
823 if (!strcmp(lgopts[opt_idx].name, "mp-anon")) {
824 mp_alloc_type = MP_ALLOC_ANON;
826 if (!strcmp(lgopts[opt_idx].name, "mp-alloc")) {
827 if (!strcmp(optarg, "native"))
828 mp_alloc_type = MP_ALLOC_NATIVE;
829 else if (!strcmp(optarg, "anon"))
830 mp_alloc_type = MP_ALLOC_ANON;
831 else if (!strcmp(optarg, "xmem"))
832 mp_alloc_type = MP_ALLOC_XMEM;
833 else if (!strcmp(optarg, "xmemhuge"))
834 mp_alloc_type = MP_ALLOC_XMEM_HUGE;
836 rte_exit(EXIT_FAILURE,
837 "mp-alloc %s invalid - must be: "
838 "native, anon, xmem or xmemhuge\n",
841 if (!strcmp(lgopts[opt_idx].name, "port-numa-config")) {
842 if (parse_portnuma_config(optarg))
843 rte_exit(EXIT_FAILURE,
844 "invalid port-numa configuration\n");
846 if (!strcmp(lgopts[opt_idx].name, "ring-numa-config"))
847 if (parse_ringnuma_config(optarg))
848 rte_exit(EXIT_FAILURE,
849 "invalid ring-numa configuration\n");
850 if (!strcmp(lgopts[opt_idx].name, "socket-num")) {
852 if (!new_socket_id((uint8_t)n)) {
853 socket_num = (uint8_t)n;
855 print_invalid_socket_id_error();
856 rte_exit(EXIT_FAILURE,
857 "Invalid socket id");
860 if (!strcmp(lgopts[opt_idx].name, "mbuf-size")) {
862 if (n > 0 && n <= 0xFFFF)
863 mbuf_data_size = (uint16_t) n;
865 rte_exit(EXIT_FAILURE,
866 "mbuf-size should be > 0 and < 65536\n");
868 if (!strcmp(lgopts[opt_idx].name, "total-num-mbufs")) {
871 param_total_num_mbufs = (unsigned)n;
873 rte_exit(EXIT_FAILURE,
874 "total-num-mbufs should be > 1024\n");
876 if (!strcmp(lgopts[opt_idx].name, "max-pkt-len")) {
878 if (n >= RTE_ETHER_MIN_LEN) {
879 rx_mode.max_rx_pkt_len = (uint32_t) n;
880 if (n > RTE_ETHER_MAX_LEN)
882 DEV_RX_OFFLOAD_JUMBO_FRAME;
884 rte_exit(EXIT_FAILURE,
885 "Invalid max-pkt-len=%d - should be > %d\n",
886 n, RTE_ETHER_MIN_LEN);
888 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-mode")) {
889 if (!strcmp(optarg, "signature"))
891 RTE_FDIR_MODE_SIGNATURE;
892 else if (!strcmp(optarg, "perfect"))
893 fdir_conf.mode = RTE_FDIR_MODE_PERFECT;
894 else if (!strcmp(optarg, "perfect-mac-vlan"))
895 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_MAC_VLAN;
896 else if (!strcmp(optarg, "perfect-tunnel"))
897 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_TUNNEL;
898 else if (!strcmp(optarg, "none"))
899 fdir_conf.mode = RTE_FDIR_MODE_NONE;
901 rte_exit(EXIT_FAILURE,
902 "pkt-mode-invalid %s invalid - must be: "
903 "none, signature, perfect, perfect-mac-vlan"
904 " or perfect-tunnel\n",
907 if (!strcmp(lgopts[opt_idx].name,
908 "pkt-filter-report-hash")) {
909 if (!strcmp(optarg, "none"))
911 RTE_FDIR_NO_REPORT_STATUS;
912 else if (!strcmp(optarg, "match"))
914 RTE_FDIR_REPORT_STATUS;
915 else if (!strcmp(optarg, "always"))
917 RTE_FDIR_REPORT_STATUS_ALWAYS;
919 rte_exit(EXIT_FAILURE,
920 "pkt-filter-report-hash %s invalid "
921 "- must be: none or match or always\n",
924 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-size")) {
925 if (!strcmp(optarg, "64K"))
927 RTE_FDIR_PBALLOC_64K;
928 else if (!strcmp(optarg, "128K"))
930 RTE_FDIR_PBALLOC_128K;
931 else if (!strcmp(optarg, "256K"))
933 RTE_FDIR_PBALLOC_256K;
935 rte_exit(EXIT_FAILURE, "pkt-filter-size %s invalid -"
936 " must be: 64K or 128K or 256K\n",
939 if (!strcmp(lgopts[opt_idx].name,
940 "pkt-filter-drop-queue")) {
943 fdir_conf.drop_queue = (uint8_t) n;
945 rte_exit(EXIT_FAILURE,
946 "drop queue %d invalid - must"
949 #ifdef RTE_LIBRTE_LATENCY_STATS
950 if (!strcmp(lgopts[opt_idx].name,
954 latencystats_lcore_id = (lcoreid_t) n;
955 latencystats_enabled = 1;
957 rte_exit(EXIT_FAILURE,
958 "invalid lcore id %d for latencystats"
959 " must be >= 0\n", n);
962 #ifdef RTE_LIBRTE_BITRATE
963 if (!strcmp(lgopts[opt_idx].name, "bitrate-stats")) {
966 bitrate_lcore_id = (lcoreid_t) n;
969 rte_exit(EXIT_FAILURE,
970 "invalid lcore id %d for bitrate stats"
971 " must be >= 0\n", n);
974 if (!strcmp(lgopts[opt_idx].name, "disable-crc-strip"))
975 rx_offloads |= DEV_RX_OFFLOAD_KEEP_CRC;
976 if (!strcmp(lgopts[opt_idx].name, "enable-lro"))
977 rx_offloads |= DEV_RX_OFFLOAD_TCP_LRO;
978 if (!strcmp(lgopts[opt_idx].name, "enable-scatter"))
979 rx_offloads |= DEV_RX_OFFLOAD_SCATTER;
980 if (!strcmp(lgopts[opt_idx].name, "enable-rx-cksum"))
981 rx_offloads |= DEV_RX_OFFLOAD_CHECKSUM;
982 if (!strcmp(lgopts[opt_idx].name,
983 "enable-rx-timestamp"))
984 rx_offloads |= DEV_RX_OFFLOAD_TIMESTAMP;
985 if (!strcmp(lgopts[opt_idx].name, "enable-hw-vlan"))
986 rx_offloads |= DEV_RX_OFFLOAD_VLAN;
988 if (!strcmp(lgopts[opt_idx].name,
989 "enable-hw-vlan-filter"))
990 rx_offloads |= DEV_RX_OFFLOAD_VLAN_FILTER;
992 if (!strcmp(lgopts[opt_idx].name,
993 "enable-hw-vlan-strip"))
994 rx_offloads |= DEV_RX_OFFLOAD_VLAN_STRIP;
996 if (!strcmp(lgopts[opt_idx].name,
997 "enable-hw-vlan-extend"))
998 rx_offloads |= DEV_RX_OFFLOAD_VLAN_EXTEND;
1000 if (!strcmp(lgopts[opt_idx].name,
1001 "enable-hw-qinq-strip"))
1002 rx_offloads |= DEV_RX_OFFLOAD_QINQ_STRIP;
1004 if (!strcmp(lgopts[opt_idx].name, "enable-drop-en"))
1007 if (!strcmp(lgopts[opt_idx].name, "disable-rss"))
1009 if (!strcmp(lgopts[opt_idx].name, "port-topology")) {
1010 if (!strcmp(optarg, "paired"))
1011 port_topology = PORT_TOPOLOGY_PAIRED;
1012 else if (!strcmp(optarg, "chained"))
1013 port_topology = PORT_TOPOLOGY_CHAINED;
1014 else if (!strcmp(optarg, "loop"))
1015 port_topology = PORT_TOPOLOGY_LOOP;
1017 rte_exit(EXIT_FAILURE, "port-topology %s invalid -"
1018 " must be: paired, chained or loop\n",
1021 if (!strcmp(lgopts[opt_idx].name, "forward-mode"))
1022 set_pkt_forwarding_mode(optarg);
1023 if (!strcmp(lgopts[opt_idx].name, "rss-ip"))
1024 rss_hf = ETH_RSS_IP;
1025 if (!strcmp(lgopts[opt_idx].name, "rss-udp"))
1026 rss_hf = ETH_RSS_UDP;
1027 if (!strcmp(lgopts[opt_idx].name, "rxq")) {
1029 if (n >= 0 && check_nb_rxq((queueid_t)n) == 0)
1030 nb_rxq = (queueid_t) n;
1032 rte_exit(EXIT_FAILURE, "rxq %d invalid - must be"
1033 " >= 0 && <= %u\n", n,
1034 get_allowed_max_nb_rxq(&pid));
1036 if (!strcmp(lgopts[opt_idx].name, "txq")) {
1038 if (n >= 0 && check_nb_txq((queueid_t)n) == 0)
1039 nb_txq = (queueid_t) n;
1041 rte_exit(EXIT_FAILURE, "txq %d invalid - must be"
1042 " >= 0 && <= %u\n", n,
1043 get_allowed_max_nb_txq(&pid));
1045 if (!nb_rxq && !nb_txq) {
1046 rte_exit(EXIT_FAILURE, "Either rx or tx queues should "
1049 if (!strcmp(lgopts[opt_idx].name, "burst")) {
1052 /* A burst size of zero means that the
1053 * PMD should be queried for
1054 * recommended Rx burst size. Since
1055 * testpmd uses a single size for all
1056 * ports, port 0 is queried for the
1057 * value, on the assumption that all
1058 * ports are of the same NIC model.
1060 ret = eth_dev_info_get_print_err(
1066 rec_nb_pkts = dev_info
1067 .default_rxportconf.burst_size;
1069 if (rec_nb_pkts == 0)
1070 rte_exit(EXIT_FAILURE,
1071 "PMD does not recommend a burst size. "
1072 "Provided value must be between "
1073 "1 and %d\n", MAX_PKT_BURST);
1074 else if (rec_nb_pkts > MAX_PKT_BURST)
1075 rte_exit(EXIT_FAILURE,
1076 "PMD recommended burst size of %d"
1077 " exceeds maximum value of %d\n",
1078 rec_nb_pkts, MAX_PKT_BURST);
1079 printf("Using PMD-provided burst value of %d\n",
1081 nb_pkt_per_burst = rec_nb_pkts;
1082 } else if (n > MAX_PKT_BURST)
1083 rte_exit(EXIT_FAILURE,
1084 "burst must be between1 and %d\n",
1087 nb_pkt_per_burst = (uint16_t) n;
1089 if (!strcmp(lgopts[opt_idx].name, "mbcache")) {
1092 (n <= RTE_MEMPOOL_CACHE_MAX_SIZE))
1093 mb_mempool_cache = (uint16_t) n;
1095 rte_exit(EXIT_FAILURE,
1096 "mbcache must be >= 0 and <= %d\n",
1097 RTE_MEMPOOL_CACHE_MAX_SIZE);
1099 if (!strcmp(lgopts[opt_idx].name, "txfreet")) {
1102 tx_free_thresh = (int16_t)n;
1104 rte_exit(EXIT_FAILURE, "txfreet must be >= 0\n");
1106 if (!strcmp(lgopts[opt_idx].name, "txrst")) {
1109 tx_rs_thresh = (int16_t)n;
1111 rte_exit(EXIT_FAILURE, "txrst must be >= 0\n");
1113 if (!strcmp(lgopts[opt_idx].name, "rxd")) {
1116 if (rx_free_thresh >= n)
1117 rte_exit(EXIT_FAILURE,
1119 "rx_free_thresh(%d)\n",
1120 (int)rx_free_thresh);
1122 nb_rxd = (uint16_t) n;
1124 rte_exit(EXIT_FAILURE,
1125 "rxd(%d) invalid - must be > 0\n",
1128 if (!strcmp(lgopts[opt_idx].name, "txd")) {
1131 nb_txd = (uint16_t) n;
1133 rte_exit(EXIT_FAILURE, "txd must be in > 0\n");
1135 if (!strcmp(lgopts[opt_idx].name, "txpt")) {
1138 tx_pthresh = (int8_t)n;
1140 rte_exit(EXIT_FAILURE, "txpt must be >= 0\n");
1142 if (!strcmp(lgopts[opt_idx].name, "txht")) {
1145 tx_hthresh = (int8_t)n;
1147 rte_exit(EXIT_FAILURE, "txht must be >= 0\n");
1149 if (!strcmp(lgopts[opt_idx].name, "txwt")) {
1152 tx_wthresh = (int8_t)n;
1154 rte_exit(EXIT_FAILURE, "txwt must be >= 0\n");
1156 if (!strcmp(lgopts[opt_idx].name, "rxpt")) {
1159 rx_pthresh = (int8_t)n;
1161 rte_exit(EXIT_FAILURE, "rxpt must be >= 0\n");
1163 if (!strcmp(lgopts[opt_idx].name, "rxht")) {
1166 rx_hthresh = (int8_t)n;
1168 rte_exit(EXIT_FAILURE, "rxht must be >= 0\n");
1170 if (!strcmp(lgopts[opt_idx].name, "rxwt")) {
1173 rx_wthresh = (int8_t)n;
1175 rte_exit(EXIT_FAILURE, "rxwt must be >= 0\n");
1177 if (!strcmp(lgopts[opt_idx].name, "rxfreet")) {
1180 rx_free_thresh = (int16_t)n;
1182 rte_exit(EXIT_FAILURE, "rxfreet must be >= 0\n");
1184 if (!strcmp(lgopts[opt_idx].name, "tx-queue-stats-mapping")) {
1185 if (parse_queue_stats_mapping_config(optarg, TX)) {
1186 rte_exit(EXIT_FAILURE,
1187 "invalid TX queue statistics mapping config entered\n");
1190 if (!strcmp(lgopts[opt_idx].name, "rx-queue-stats-mapping")) {
1191 if (parse_queue_stats_mapping_config(optarg, RX)) {
1192 rte_exit(EXIT_FAILURE,
1193 "invalid RX queue statistics mapping config entered\n");
1196 if (!strcmp(lgopts[opt_idx].name, "txpkts")) {
1197 unsigned seg_lengths[RTE_MAX_SEGS_PER_PKT];
1198 unsigned int nb_segs;
1200 nb_segs = parse_item_list(optarg, "txpkt segments",
1201 RTE_MAX_SEGS_PER_PKT, seg_lengths, 0);
1203 set_tx_pkt_segments(seg_lengths, nb_segs);
1205 rte_exit(EXIT_FAILURE, "bad txpkts\n");
1207 if (!strcmp(lgopts[opt_idx].name, "txonly-multi-flow"))
1208 txonly_multi_flow = 1;
1209 if (!strcmp(lgopts[opt_idx].name, "no-flush-rx"))
1211 if (!strcmp(lgopts[opt_idx].name, "disable-link-check"))
1213 if (!strcmp(lgopts[opt_idx].name, "disable-device-start"))
1214 no_device_start = 1;
1215 if (!strcmp(lgopts[opt_idx].name, "no-lsc-interrupt"))
1217 if (!strcmp(lgopts[opt_idx].name, "no-rmv-interrupt"))
1219 if (!strcmp(lgopts[opt_idx].name, "flow-isolate-all"))
1220 flow_isolate_all = 1;
1221 if (!strcmp(lgopts[opt_idx].name, "tx-offloads")) {
1223 n = strtoull(optarg, &end, 16);
1225 tx_offloads = (uint64_t)n;
1227 rte_exit(EXIT_FAILURE,
1228 "tx-offloads must be >= 0\n");
1230 if (!strcmp(lgopts[opt_idx].name, "vxlan-gpe-port")) {
1233 vxlan_gpe_udp_port = (uint16_t)n;
1235 rte_exit(EXIT_FAILURE,
1236 "vxlan-gpe-port must be >= 0\n");
1238 if (!strcmp(lgopts[opt_idx].name, "print-event"))
1239 if (parse_event_printing_config(optarg, 1)) {
1240 rte_exit(EXIT_FAILURE,
1241 "invalid print-event argument\n");
1243 if (!strcmp(lgopts[opt_idx].name, "mask-event"))
1244 if (parse_event_printing_config(optarg, 0)) {
1245 rte_exit(EXIT_FAILURE,
1246 "invalid mask-event argument\n");
1248 if (!strcmp(lgopts[opt_idx].name, "hot-plug"))
1250 if (!strcmp(lgopts[opt_idx].name, "mlockall"))
1252 if (!strcmp(lgopts[opt_idx].name, "no-mlockall"))
1254 if (!strcmp(lgopts[opt_idx].name,
1255 "noisy-tx-sw-buffer-size")) {
1258 noisy_tx_sw_bufsz = n;
1260 rte_exit(EXIT_FAILURE,
1261 "noisy-tx-sw-buffer-size must be >= 0\n");
1263 if (!strcmp(lgopts[opt_idx].name,
1264 "noisy-tx-sw-buffer-flushtime")) {
1267 noisy_tx_sw_buf_flush_time = n;
1269 rte_exit(EXIT_FAILURE,
1270 "noisy-tx-sw-buffer-flushtime must be >= 0\n");
1272 if (!strcmp(lgopts[opt_idx].name,
1273 "noisy-lkup-memory")) {
1276 noisy_lkup_mem_sz = n;
1278 rte_exit(EXIT_FAILURE,
1279 "noisy-lkup-memory must be >= 0\n");
1281 if (!strcmp(lgopts[opt_idx].name,
1282 "noisy-lkup-num-writes")) {
1285 noisy_lkup_num_writes = n;
1287 rte_exit(EXIT_FAILURE,
1288 "noisy-lkup-num-writes must be >= 0\n");
1290 if (!strcmp(lgopts[opt_idx].name,
1291 "noisy-lkup-num-reads")) {
1294 noisy_lkup_num_reads = n;
1296 rte_exit(EXIT_FAILURE,
1297 "noisy-lkup-num-reads must be >= 0\n");
1299 if (!strcmp(lgopts[opt_idx].name,
1300 "noisy-lkup-num-reads-writes")) {
1303 noisy_lkup_num_reads_writes = n;
1305 rte_exit(EXIT_FAILURE,
1306 "noisy-lkup-num-reads-writes must be >= 0\n");
1308 if (!strcmp(lgopts[opt_idx].name, "no-iova-contig"))
1309 mempool_flags = MEMPOOL_F_NO_IOVA_CONTIG;
1313 rte_exit(EXIT_SUCCESS, "Displayed help\n");
1317 rte_exit(EXIT_FAILURE,
1318 "Command line is incomplete or incorrect\n");
1323 /* Set offload configuration from command line parameters. */
1324 rx_mode.offloads = rx_offloads;
1325 tx_mode.offloads = tx_offloads;
1327 if (mempool_flags & MEMPOOL_F_NO_IOVA_CONTIG &&
1328 mp_alloc_type != MP_ALLOC_ANON) {
1329 TESTPMD_LOG(WARNING, "cannot use no-iova-contig without "
1330 "mp-alloc=anon. mempool no-iova-contig is "