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_CMDLINE
43 #include <cmdline_parse.h>
44 #include <cmdline_parse_etheraddr.h>
46 #ifdef RTE_LIBRTE_PMD_BOND
47 #include <rte_eth_bond.h>
57 #ifdef RTE_LIBRTE_CMDLINE
59 "[--cmdline-file=FILENAME] "
61 "[--help|-h] | [--auto-start|-a] | ["
62 "--tx-first | --stats-period=PERIOD | "
63 "--coremask=COREMASK --portmask=PORTMASK --numa "
64 "--mbuf-size= | --total-num-mbufs= | "
65 "--nb-cores= | --nb-ports= | "
66 #ifdef RTE_LIBRTE_CMDLINE
67 "--eth-peers-configfile= | "
68 "--eth-peer=X,M:M:M:M:M:M | "
69 "--tx-ip=SRC,DST | --tx-udp=PORT | "
71 "--pkt-filter-mode= |"
72 "--rss-ip | --rss-udp | "
73 "--rxpt= | --rxht= | --rxwt= | --rxfreet= | "
74 "--txpt= | --txht= | --txwt= | --txfreet= | "
75 "--txrst= | --tx-offloads= | --vxlan-gpe-port= ]\n",
77 #ifdef RTE_LIBRTE_CMDLINE
78 printf(" --interactive: run in interactive mode.\n");
79 printf(" --cmdline-file: execute cli commands before startup.\n");
81 printf(" --auto-start: start forwarding on init "
82 "[always when non-interactive].\n");
83 printf(" --help: display this message and quit.\n");
84 printf(" --tx-first: start forwarding sending a burst first "
85 "(only if interactive is disabled).\n");
86 printf(" --stats-period=PERIOD: statistics will be shown "
87 "every PERIOD seconds (only if interactive is disabled).\n");
88 printf(" --nb-cores=N: set the number of forwarding cores "
89 "(1 <= N <= %d).\n", nb_lcores);
90 printf(" --nb-ports=N: set the number of forwarding ports "
91 "(1 <= N <= %d).\n", nb_ports);
92 printf(" --coremask=COREMASK: hexadecimal bitmask of cores running "
93 "the packet forwarding test. The master lcore is reserved for "
94 "command line parsing only, and cannot be masked on for "
95 "packet forwarding.\n");
96 printf(" --portmask=PORTMASK: hexadecimal bitmask of ports used "
97 "by the packet forwarding test.\n");
98 printf(" --numa: enable NUMA-aware allocation of RX/TX rings and of "
99 "RX memory buffers (mbufs).\n");
100 printf(" --port-numa-config=(port,socket)[,(port,socket)]: "
101 "specify the socket on which the memory pool "
102 "used by the port will be allocated.\n");
103 printf(" --ring-numa-config=(port,flag,socket)[,(port,flag,socket)]: "
104 "specify the socket on which the TX/RX rings for "
105 "the port will be allocated "
106 "(flag: 1 for RX; 2 for TX; 3 for RX and TX).\n");
107 printf(" --socket-num=N: set socket from which all memory is allocated "
109 printf(" --mbuf-size=N: set the data size of mbuf to N bytes.\n");
110 printf(" --total-num-mbufs=N: set the number of mbufs to be allocated "
112 printf(" --max-pkt-len=N: set the maximum size of packet to N bytes.\n");
113 #ifdef RTE_LIBRTE_CMDLINE
114 printf(" --eth-peers-configfile=name: config file with ethernet addresses "
116 printf(" --eth-peer=X,M:M:M:M:M:M: set the MAC address of the X peer "
117 "port (0 <= X < %d).\n", RTE_MAX_ETHPORTS);
119 printf(" --pkt-filter-mode=N: set Flow Director mode "
120 "(N: none (default mode) or signature or perfect).\n");
121 printf(" --pkt-filter-report-hash=N: set Flow Director report mode "
122 "(N: none or match (default) or always).\n");
123 printf(" --pkt-filter-size=N: set Flow Director mode "
124 "(N: 64K (default mode) or 128K or 256K).\n");
125 printf(" --pkt-filter-drop-queue=N: set drop-queue. "
126 "In perfect mode, when you add a rule with queue = -1 "
127 "the packet will be enqueued into the rx drop-queue. "
128 "If the drop-queue doesn't exist, the packet is dropped. "
129 "By default drop-queue=127.\n");
130 #ifdef RTE_LIBRTE_LATENCY_STATS
131 printf(" --latencystats=N: enable latency and jitter statistcs "
132 "monitoring on forwarding lcore id N.\n");
134 printf(" --disable-crc-strip: disable CRC stripping by hardware.\n");
135 printf(" --enable-lro: enable large receive offload.\n");
136 printf(" --enable-rx-cksum: enable rx hardware checksum offload.\n");
137 printf(" --enable-rx-timestamp: enable rx hardware timestamp offload.\n");
138 printf(" --enable-hw-vlan: enable hardware vlan.\n");
139 printf(" --enable-hw-vlan-filter: enable hardware vlan filter.\n");
140 printf(" --enable-hw-vlan-strip: enable hardware vlan strip.\n");
141 printf(" --enable-hw-vlan-extend: enable hardware vlan extend.\n");
142 printf(" --enable-drop-en: enable per queue packet drop.\n");
143 printf(" --disable-rss: disable rss.\n");
144 printf(" --port-topology=N: set port topology (N: paired (default) or "
146 printf(" --forward-mode=N: set forwarding mode (N: %s).\n",
147 list_pkt_forwarding_modes());
148 printf(" --rss-ip: set RSS functions to IPv4/IPv6 only .\n");
149 printf(" --rss-udp: set RSS functions to IPv4/IPv6 + UDP.\n");
150 printf(" --rxq=N: set the number of RX queues per port to N.\n");
151 printf(" --rxd=N: set the number of descriptors in RX rings to N.\n");
152 printf(" --txq=N: set the number of TX queues per port to N.\n");
153 printf(" --txd=N: set the number of descriptors in TX rings to N.\n");
154 printf(" --burst=N: set the number of packets per burst to N.\n");
155 printf(" --mbcache=N: set the cache of mbuf memory pool to N.\n");
156 printf(" --rxpt=N: set prefetch threshold register of RX rings to N.\n");
157 printf(" --rxht=N: set the host threshold register of RX rings to N.\n");
158 printf(" --rxfreet=N: set the free threshold of RX descriptors to N "
159 "(0 <= N < value of rxd).\n");
160 printf(" --rxwt=N: set the write-back threshold register of RX rings to N.\n");
161 printf(" --txpt=N: set the prefetch threshold register of TX rings to N.\n");
162 printf(" --txht=N: set the nhost threshold register of TX rings to N.\n");
163 printf(" --txwt=N: set the write-back threshold register of TX rings to N.\n");
164 printf(" --txfreet=N: set the transmit free threshold of TX rings to N "
165 "(0 <= N <= value of txd).\n");
166 printf(" --txrst=N: set the transmit RS bit threshold of TX rings to N "
167 "(0 <= N <= value of txd).\n");
168 printf(" --tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping]: "
169 "tx queues statistics counters mapping "
170 "(0 <= mapping <= %d).\n", RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
171 printf(" --rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping]: "
172 "rx queues statistics counters mapping "
173 "(0 <= mapping <= %d).\n", RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
174 printf(" --no-flush-rx: Don't flush RX streams before forwarding."
175 " Used mainly with PCAP drivers.\n");
176 printf(" --txpkts=X[,Y]*: set TX segment sizes"
177 " or total packet length.\n");
178 printf(" --txonly-multi-flow: generate multiple flows in txonly mode\n");
179 printf(" --disable-link-check: disable check on link status when "
180 "starting/stopping ports.\n");
181 printf(" --no-lsc-interrupt: disable link status change interrupt.\n");
182 printf(" --no-rmv-interrupt: disable device removal interrupt.\n");
183 printf(" --bitrate-stats=N: set the logical core N to perform "
184 "bit-rate calculation.\n");
185 printf(" --print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|all>: "
186 "enable print of designated event or all of them.\n");
187 printf(" --mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|all>: "
188 "disable print of designated event or all of them.\n");
189 printf(" --flow-isolate-all: "
190 "requests flow API isolated mode on all ports at initialization time.\n");
191 printf(" --tx-offloads=0xXXXXXXXX: hexadecimal bitmask of TX queue offloads\n");
192 printf(" --hot-plug: enable hot plug for device.\n");
193 printf(" --vxlan-gpe-port=N: UPD port of tunnel VXLAN-GPE\n");
194 printf(" --mlockall: lock all memory\n");
195 printf(" --no-mlockall: do not lock all memory\n");
196 printf(" --mp-alloc <native|anon|xmem|xmemhuge>: mempool allocation method.\n"
197 " native: use regular DPDK memory to create and populate mempool\n"
198 " anon: use regular DPDK memory to create and anonymous memory to populate mempool\n"
199 " xmem: use anonymous memory to create and populate mempool\n"
200 " xmemhuge: use anonymous hugepage memory to create and populate mempool\n");
201 printf(" --noisy-tx-sw-buffer-size=N: size of FIFO buffer\n");
202 printf(" --noisy-tx-sw-buffer-flushtime=N: flush FIFO after N ms\n");
203 printf(" --noisy-lkup-memory=N: allocate N MB of VNF memory\n");
204 printf(" --noisy-lkup-num-writes=N: do N random writes per packet\n");
205 printf(" --noisy-lkup-num-reads=N: do N random reads per packet\n");
206 printf(" --noisy-lkup-num-writes=N: do N random reads and writes per packet\n");
207 printf(" --no-iova-contig: mempool memory can be IOVA non contiguous. "
208 "valid only with --mp-alloc=anon\n");
211 #ifdef RTE_LIBRTE_CMDLINE
213 init_peer_eth_addrs(char *config_filename)
219 config_file = fopen(config_filename, "r");
220 if (config_file == NULL) {
221 perror("Failed to open eth config file\n");
225 for (i = 0; i < RTE_MAX_ETHPORTS; i++) {
227 if (fgets(buf, sizeof(buf), config_file) == NULL)
230 if (cmdline_parse_etheraddr(NULL, buf, &peer_eth_addrs[i],
231 sizeof(peer_eth_addrs[i])) < 0) {
232 printf("Bad MAC address format on line %d\n", i+1);
238 nb_peer_eth_addrs = (portid_t) i;
244 * Parse the coremask given as argument (hexadecimal string) and set
245 * the global configuration of forwarding cores.
248 parse_fwd_coremask(const char *coremask)
251 unsigned long long int cm;
253 /* parse hexadecimal string */
255 cm = strtoull(coremask, &end, 16);
256 if ((coremask[0] == '\0') || (end == NULL) || (*end != '\0'))
257 rte_exit(EXIT_FAILURE, "Invalid fwd core mask\n");
258 else if (set_fwd_lcores_mask((uint64_t) cm) < 0)
259 rte_exit(EXIT_FAILURE, "coremask is not valid\n");
263 * Parse the coremask given as argument (hexadecimal string) and set
264 * the global configuration of forwarding cores.
267 parse_fwd_portmask(const char *portmask)
270 unsigned long long int pm;
272 /* parse hexadecimal string */
274 pm = strtoull(portmask, &end, 16);
275 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
276 rte_exit(EXIT_FAILURE, "Invalid fwd port mask\n");
278 set_fwd_ports_mask((uint64_t) pm);
283 parse_queue_stats_mapping_config(const char *q_arg, int is_rx)
286 const char *p, *p0 = q_arg;
294 unsigned long int_fld[_NUM_FLD];
295 char *str_fld[_NUM_FLD];
299 /* reset from value set at definition */
300 is_rx ? (nb_rx_queue_stats_mappings = 0) : (nb_tx_queue_stats_mappings = 0);
302 while ((p = strchr(p0,'(')) != NULL) {
304 if((p0 = strchr(p,')')) == NULL)
308 if(size >= sizeof(s))
311 snprintf(s, sizeof(s), "%.*s", size, p);
312 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
314 for (i = 0; i < _NUM_FLD; i++){
316 int_fld[i] = strtoul(str_fld[i], &end, 0);
317 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
320 /* Check mapping field is in correct range (0..RTE_ETHDEV_QUEUE_STAT_CNTRS-1) */
321 if (int_fld[FLD_STATS_COUNTER] >= RTE_ETHDEV_QUEUE_STAT_CNTRS) {
322 printf("Stats counter not in the correct range 0..%d\n",
323 RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
328 if ((nb_tx_queue_stats_mappings >=
329 MAX_TX_QUEUE_STATS_MAPPINGS)) {
330 printf("exceeded max number of TX queue "
331 "statistics mappings: %hu\n",
332 nb_tx_queue_stats_mappings);
335 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].port_id =
336 (uint8_t)int_fld[FLD_PORT];
337 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].queue_id =
338 (uint8_t)int_fld[FLD_QUEUE];
339 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].stats_counter_id =
340 (uint8_t)int_fld[FLD_STATS_COUNTER];
341 ++nb_tx_queue_stats_mappings;
344 if ((nb_rx_queue_stats_mappings >=
345 MAX_RX_QUEUE_STATS_MAPPINGS)) {
346 printf("exceeded max number of RX queue "
347 "statistics mappings: %hu\n",
348 nb_rx_queue_stats_mappings);
351 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].port_id =
352 (uint8_t)int_fld[FLD_PORT];
353 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].queue_id =
354 (uint8_t)int_fld[FLD_QUEUE];
355 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].stats_counter_id =
356 (uint8_t)int_fld[FLD_STATS_COUNTER];
357 ++nb_rx_queue_stats_mappings;
361 /* Reassign the rx/tx_queue_stats_mappings pointer to point to this newly populated array rather */
362 /* than to the default array (that was set at its definition) */
363 is_rx ? (rx_queue_stats_mappings = rx_queue_stats_mappings_array) :
364 (tx_queue_stats_mappings = tx_queue_stats_mappings_array);
369 print_invalid_socket_id_error(void)
373 printf("Invalid socket id, options are: ");
374 for (i = 0; i < num_sockets; i++) {
375 printf("%u%s", socket_ids[i],
376 (i == num_sockets - 1) ? "\n" : ",");
381 parse_portnuma_config(const char *q_arg)
384 const char *p, *p0 = q_arg;
386 uint8_t i, socket_id;
394 unsigned long int_fld[_NUM_FLD];
395 char *str_fld[_NUM_FLD];
397 /* reset from value set at definition */
398 while ((p = strchr(p0,'(')) != NULL) {
400 if((p0 = strchr(p,')')) == NULL)
404 if(size >= sizeof(s))
407 snprintf(s, sizeof(s), "%.*s", size, p);
408 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
410 for (i = 0; i < _NUM_FLD; i++) {
412 int_fld[i] = strtoul(str_fld[i], &end, 0);
413 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
416 port_id = (portid_t)int_fld[FLD_PORT];
417 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
418 port_id == (portid_t)RTE_PORT_ALL) {
422 socket_id = (uint8_t)int_fld[FLD_SOCKET];
423 if (new_socket_id(socket_id)) {
424 if (num_sockets >= RTE_MAX_NUMA_NODES) {
425 print_invalid_socket_id_error();
428 socket_ids[num_sockets++] = socket_id;
430 port_numa[port_id] = socket_id;
437 parse_ringnuma_config(const char *q_arg)
440 const char *p, *p0 = q_arg;
442 uint8_t i, ring_flag, socket_id;
451 unsigned long int_fld[_NUM_FLD];
452 char *str_fld[_NUM_FLD];
453 #define RX_RING_ONLY 0x1
454 #define TX_RING_ONLY 0x2
455 #define RXTX_RING 0x3
457 /* reset from value set at definition */
458 while ((p = strchr(p0,'(')) != NULL) {
460 if((p0 = strchr(p,')')) == NULL)
464 if(size >= sizeof(s))
467 snprintf(s, sizeof(s), "%.*s", size, p);
468 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
470 for (i = 0; i < _NUM_FLD; i++) {
472 int_fld[i] = strtoul(str_fld[i], &end, 0);
473 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
476 port_id = (portid_t)int_fld[FLD_PORT];
477 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
478 port_id == (portid_t)RTE_PORT_ALL) {
482 socket_id = (uint8_t)int_fld[FLD_SOCKET];
483 if (new_socket_id(socket_id)) {
484 if (num_sockets >= RTE_MAX_NUMA_NODES) {
485 print_invalid_socket_id_error();
488 socket_ids[num_sockets++] = socket_id;
490 ring_flag = (uint8_t)int_fld[FLD_FLAG];
491 if ((ring_flag < RX_RING_ONLY) || (ring_flag > RXTX_RING)) {
492 printf("Invalid ring-flag=%d config for port =%d\n",
497 switch (ring_flag & RXTX_RING) {
499 rxring_numa[port_id] = socket_id;
502 txring_numa[port_id] = socket_id;
505 rxring_numa[port_id] = socket_id;
506 txring_numa[port_id] = socket_id;
509 printf("Invalid ring-flag=%d config for port=%d\n",
519 parse_event_printing_config(const char *optarg, int enable)
523 if (!strcmp(optarg, "unknown"))
524 mask = UINT32_C(1) << RTE_ETH_EVENT_UNKNOWN;
525 else if (!strcmp(optarg, "intr_lsc"))
526 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_LSC;
527 else if (!strcmp(optarg, "queue_state"))
528 mask = UINT32_C(1) << RTE_ETH_EVENT_QUEUE_STATE;
529 else if (!strcmp(optarg, "intr_reset"))
530 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RESET;
531 else if (!strcmp(optarg, "vf_mbox"))
532 mask = UINT32_C(1) << RTE_ETH_EVENT_VF_MBOX;
533 else if (!strcmp(optarg, "ipsec"))
534 mask = UINT32_C(1) << RTE_ETH_EVENT_IPSEC;
535 else if (!strcmp(optarg, "macsec"))
536 mask = UINT32_C(1) << RTE_ETH_EVENT_MACSEC;
537 else if (!strcmp(optarg, "intr_rmv"))
538 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RMV;
539 else if (!strcmp(optarg, "dev_probed"))
540 mask = UINT32_C(1) << RTE_ETH_EVENT_NEW;
541 else if (!strcmp(optarg, "dev_released"))
542 mask = UINT32_C(1) << RTE_ETH_EVENT_DESTROY;
543 else if (!strcmp(optarg, "all"))
546 fprintf(stderr, "Invalid event: %s\n", optarg);
550 event_print_mask |= mask;
552 event_print_mask &= ~mask;
557 launch_args_parse(int argc, char** argv)
564 /* Default offloads for all ports. */
565 uint64_t rx_offloads = rx_mode.offloads;
566 uint64_t tx_offloads = tx_mode.offloads;
567 struct rte_eth_dev_info dev_info;
568 uint16_t rec_nb_pkts;
570 static struct option lgopts[] = {
572 #ifdef RTE_LIBRTE_CMDLINE
573 { "interactive", 0, 0, 0 },
574 { "cmdline-file", 1, 0, 0 },
575 { "auto-start", 0, 0, 0 },
576 { "eth-peers-configfile", 1, 0, 0 },
577 { "eth-peer", 1, 0, 0 },
579 { "tx-first", 0, 0, 0 },
580 { "stats-period", 1, 0, 0 },
581 { "ports", 1, 0, 0 },
582 { "nb-cores", 1, 0, 0 },
583 { "nb-ports", 1, 0, 0 },
584 { "coremask", 1, 0, 0 },
585 { "portmask", 1, 0, 0 },
587 { "no-numa", 0, 0, 0 },
588 { "mp-anon", 0, 0, 0 },
589 { "port-numa-config", 1, 0, 0 },
590 { "ring-numa-config", 1, 0, 0 },
591 { "socket-num", 1, 0, 0 },
592 { "mbuf-size", 1, 0, 0 },
593 { "total-num-mbufs", 1, 0, 0 },
594 { "max-pkt-len", 1, 0, 0 },
595 { "pkt-filter-mode", 1, 0, 0 },
596 { "pkt-filter-report-hash", 1, 0, 0 },
597 { "pkt-filter-size", 1, 0, 0 },
598 { "pkt-filter-drop-queue", 1, 0, 0 },
599 #ifdef RTE_LIBRTE_LATENCY_STATS
600 { "latencystats", 1, 0, 0 },
602 #ifdef RTE_LIBRTE_BITRATE
603 { "bitrate-stats", 1, 0, 0 },
605 { "disable-crc-strip", 0, 0, 0 },
606 { "enable-lro", 0, 0, 0 },
607 { "enable-rx-cksum", 0, 0, 0 },
608 { "enable-rx-timestamp", 0, 0, 0 },
609 { "enable-scatter", 0, 0, 0 },
610 { "enable-hw-vlan", 0, 0, 0 },
611 { "enable-hw-vlan-filter", 0, 0, 0 },
612 { "enable-hw-vlan-strip", 0, 0, 0 },
613 { "enable-hw-vlan-extend", 0, 0, 0 },
614 { "enable-drop-en", 0, 0, 0 },
615 { "disable-rss", 0, 0, 0 },
616 { "port-topology", 1, 0, 0 },
617 { "forward-mode", 1, 0, 0 },
618 { "rss-ip", 0, 0, 0 },
619 { "rss-udp", 0, 0, 0 },
624 { "burst", 1, 0, 0 },
625 { "mbcache", 1, 0, 0 },
629 { "txfreet", 1, 0, 0 },
630 { "txrst", 1, 0, 0 },
634 { "rxfreet", 1, 0, 0 },
635 { "tx-queue-stats-mapping", 1, 0, 0 },
636 { "rx-queue-stats-mapping", 1, 0, 0 },
637 { "no-flush-rx", 0, 0, 0 },
638 { "flow-isolate-all", 0, 0, 0 },
639 { "txpkts", 1, 0, 0 },
640 { "txonly-multi-flow", 0, 0, 0 },
641 { "disable-link-check", 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")) {
730 uint8_t c, peer_addr[6];
733 n = strtoul(optarg, &port_end, 10);
734 if (errno != 0 || port_end == optarg || *port_end++ != ',')
735 rte_exit(EXIT_FAILURE,
736 "Invalid eth-peer: %s", optarg);
737 if (n >= RTE_MAX_ETHPORTS)
738 rte_exit(EXIT_FAILURE,
739 "eth-peer: port %d >= RTE_MAX_ETHPORTS(%d)\n",
740 n, RTE_MAX_ETHPORTS);
742 if (cmdline_parse_etheraddr(NULL, port_end,
743 &peer_addr, sizeof(peer_addr)) < 0)
744 rte_exit(EXIT_FAILURE,
745 "Invalid ethernet address: %s\n",
747 for (c = 0; c < 6; c++)
748 peer_eth_addrs[n].addr_bytes[c] =
753 if (!strcmp(lgopts[opt_idx].name, "tx-ip")) {
757 end = strchr(optarg, ',');
758 if (end == optarg || !end)
759 rte_exit(EXIT_FAILURE,
760 "Invalid tx-ip: %s", optarg);
763 if (inet_aton(optarg, &in) == 0)
764 rte_exit(EXIT_FAILURE,
765 "Invalid source IP address: %s\n",
767 tx_ip_src_addr = rte_be_to_cpu_32(in.s_addr);
769 if (inet_aton(end, &in) == 0)
770 rte_exit(EXIT_FAILURE,
771 "Invalid destination IP address: %s\n",
773 tx_ip_dst_addr = rte_be_to_cpu_32(in.s_addr);
775 if (!strcmp(lgopts[opt_idx].name, "tx-udp")) {
779 n = strtoul(optarg, &end, 10);
780 if (errno != 0 || end == optarg ||
782 !(*end == '\0' || *end == ','))
783 rte_exit(EXIT_FAILURE,
784 "Invalid UDP port: %s\n",
790 n = strtoul(dst, &end, 10);
791 if (errno != 0 || end == dst ||
792 n > UINT16_MAX || *end)
793 rte_exit(EXIT_FAILURE,
794 "Invalid destination UDP port: %s\n",
802 if (!strcmp(lgopts[opt_idx].name, "nb-ports")) {
804 if (n > 0 && n <= nb_ports)
807 rte_exit(EXIT_FAILURE,
808 "Invalid port %d\n", n);
810 if (!strcmp(lgopts[opt_idx].name, "nb-cores")) {
812 if (n > 0 && n <= nb_lcores)
813 nb_fwd_lcores = (uint8_t) n;
815 rte_exit(EXIT_FAILURE,
816 "nb-cores should be > 0 and <= %d\n",
819 if (!strcmp(lgopts[opt_idx].name, "coremask"))
820 parse_fwd_coremask(optarg);
821 if (!strcmp(lgopts[opt_idx].name, "portmask"))
822 parse_fwd_portmask(optarg);
823 if (!strcmp(lgopts[opt_idx].name, "no-numa"))
825 if (!strcmp(lgopts[opt_idx].name, "numa"))
827 if (!strcmp(lgopts[opt_idx].name, "mp-anon")) {
828 mp_alloc_type = MP_ALLOC_ANON;
830 if (!strcmp(lgopts[opt_idx].name, "mp-alloc")) {
831 if (!strcmp(optarg, "native"))
832 mp_alloc_type = MP_ALLOC_NATIVE;
833 else if (!strcmp(optarg, "anon"))
834 mp_alloc_type = MP_ALLOC_ANON;
835 else if (!strcmp(optarg, "xmem"))
836 mp_alloc_type = MP_ALLOC_XMEM;
837 else if (!strcmp(optarg, "xmemhuge"))
838 mp_alloc_type = MP_ALLOC_XMEM_HUGE;
840 rte_exit(EXIT_FAILURE,
841 "mp-alloc %s invalid - must be: "
842 "native, anon, xmem or xmemhuge\n",
845 if (!strcmp(lgopts[opt_idx].name, "port-numa-config")) {
846 if (parse_portnuma_config(optarg))
847 rte_exit(EXIT_FAILURE,
848 "invalid port-numa configuration\n");
850 if (!strcmp(lgopts[opt_idx].name, "ring-numa-config"))
851 if (parse_ringnuma_config(optarg))
852 rte_exit(EXIT_FAILURE,
853 "invalid ring-numa configuration\n");
854 if (!strcmp(lgopts[opt_idx].name, "socket-num")) {
856 if (!new_socket_id((uint8_t)n)) {
857 socket_num = (uint8_t)n;
859 print_invalid_socket_id_error();
860 rte_exit(EXIT_FAILURE,
861 "Invalid socket id");
864 if (!strcmp(lgopts[opt_idx].name, "mbuf-size")) {
866 if (n > 0 && n <= 0xFFFF)
867 mbuf_data_size = (uint16_t) n;
869 rte_exit(EXIT_FAILURE,
870 "mbuf-size should be > 0 and < 65536\n");
872 if (!strcmp(lgopts[opt_idx].name, "total-num-mbufs")) {
875 param_total_num_mbufs = (unsigned)n;
877 rte_exit(EXIT_FAILURE,
878 "total-num-mbufs should be > 1024\n");
880 if (!strcmp(lgopts[opt_idx].name, "max-pkt-len")) {
882 if (n >= ETHER_MIN_LEN) {
883 rx_mode.max_rx_pkt_len = (uint32_t) n;
884 if (n > ETHER_MAX_LEN)
886 DEV_RX_OFFLOAD_JUMBO_FRAME;
888 rte_exit(EXIT_FAILURE,
889 "Invalid max-pkt-len=%d - should be > %d\n",
892 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-mode")) {
893 if (!strcmp(optarg, "signature"))
895 RTE_FDIR_MODE_SIGNATURE;
896 else if (!strcmp(optarg, "perfect"))
897 fdir_conf.mode = RTE_FDIR_MODE_PERFECT;
898 else if (!strcmp(optarg, "perfect-mac-vlan"))
899 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_MAC_VLAN;
900 else if (!strcmp(optarg, "perfect-tunnel"))
901 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_TUNNEL;
902 else if (!strcmp(optarg, "none"))
903 fdir_conf.mode = RTE_FDIR_MODE_NONE;
905 rte_exit(EXIT_FAILURE,
906 "pkt-mode-invalid %s invalid - must be: "
907 "none, signature, perfect, perfect-mac-vlan"
908 " or perfect-tunnel\n",
911 if (!strcmp(lgopts[opt_idx].name,
912 "pkt-filter-report-hash")) {
913 if (!strcmp(optarg, "none"))
915 RTE_FDIR_NO_REPORT_STATUS;
916 else if (!strcmp(optarg, "match"))
918 RTE_FDIR_REPORT_STATUS;
919 else if (!strcmp(optarg, "always"))
921 RTE_FDIR_REPORT_STATUS_ALWAYS;
923 rte_exit(EXIT_FAILURE,
924 "pkt-filter-report-hash %s invalid "
925 "- must be: none or match or always\n",
928 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-size")) {
929 if (!strcmp(optarg, "64K"))
931 RTE_FDIR_PBALLOC_64K;
932 else if (!strcmp(optarg, "128K"))
934 RTE_FDIR_PBALLOC_128K;
935 else if (!strcmp(optarg, "256K"))
937 RTE_FDIR_PBALLOC_256K;
939 rte_exit(EXIT_FAILURE, "pkt-filter-size %s invalid -"
940 " must be: 64K or 128K or 256K\n",
943 if (!strcmp(lgopts[opt_idx].name,
944 "pkt-filter-drop-queue")) {
947 fdir_conf.drop_queue = (uint8_t) n;
949 rte_exit(EXIT_FAILURE,
950 "drop queue %d invalid - must"
953 #ifdef RTE_LIBRTE_LATENCY_STATS
954 if (!strcmp(lgopts[opt_idx].name,
958 latencystats_lcore_id = (lcoreid_t) n;
959 latencystats_enabled = 1;
961 rte_exit(EXIT_FAILURE,
962 "invalid lcore id %d for latencystats"
963 " must be >= 0\n", n);
966 #ifdef RTE_LIBRTE_BITRATE
967 if (!strcmp(lgopts[opt_idx].name, "bitrate-stats")) {
970 bitrate_lcore_id = (lcoreid_t) n;
973 rte_exit(EXIT_FAILURE,
974 "invalid lcore id %d for bitrate stats"
975 " must be >= 0\n", n);
978 if (!strcmp(lgopts[opt_idx].name, "disable-crc-strip"))
979 rx_offloads |= DEV_RX_OFFLOAD_KEEP_CRC;
980 if (!strcmp(lgopts[opt_idx].name, "enable-lro"))
981 rx_offloads |= DEV_RX_OFFLOAD_TCP_LRO;
982 if (!strcmp(lgopts[opt_idx].name, "enable-scatter"))
983 rx_offloads |= DEV_RX_OFFLOAD_SCATTER;
984 if (!strcmp(lgopts[opt_idx].name, "enable-rx-cksum"))
985 rx_offloads |= DEV_RX_OFFLOAD_CHECKSUM;
986 if (!strcmp(lgopts[opt_idx].name,
987 "enable-rx-timestamp"))
988 rx_offloads |= DEV_RX_OFFLOAD_TIMESTAMP;
989 if (!strcmp(lgopts[opt_idx].name, "enable-hw-vlan"))
990 rx_offloads |= DEV_RX_OFFLOAD_VLAN;
992 if (!strcmp(lgopts[opt_idx].name,
993 "enable-hw-vlan-filter"))
994 rx_offloads |= DEV_RX_OFFLOAD_VLAN_FILTER;
996 if (!strcmp(lgopts[opt_idx].name,
997 "enable-hw-vlan-strip"))
998 rx_offloads |= DEV_RX_OFFLOAD_VLAN_STRIP;
1000 if (!strcmp(lgopts[opt_idx].name,
1001 "enable-hw-vlan-extend"))
1002 rx_offloads |= DEV_RX_OFFLOAD_VLAN_EXTEND;
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 rte_eth_dev_info_get(0, &dev_info);
1061 rec_nb_pkts = dev_info
1062 .default_rxportconf.burst_size;
1064 if (rec_nb_pkts == 0)
1065 rte_exit(EXIT_FAILURE,
1066 "PMD does not recommend a burst size. "
1067 "Provided value must be between "
1068 "1 and %d\n", MAX_PKT_BURST);
1069 else if (rec_nb_pkts > MAX_PKT_BURST)
1070 rte_exit(EXIT_FAILURE,
1071 "PMD recommended burst size of %d"
1072 " exceeds maximum value of %d\n",
1073 rec_nb_pkts, MAX_PKT_BURST);
1074 printf("Using PMD-provided burst value of %d\n",
1076 nb_pkt_per_burst = rec_nb_pkts;
1077 } else if (n > MAX_PKT_BURST)
1078 rte_exit(EXIT_FAILURE,
1079 "burst must be between1 and %d\n",
1082 nb_pkt_per_burst = (uint16_t) n;
1084 if (!strcmp(lgopts[opt_idx].name, "mbcache")) {
1087 (n <= RTE_MEMPOOL_CACHE_MAX_SIZE))
1088 mb_mempool_cache = (uint16_t) n;
1090 rte_exit(EXIT_FAILURE,
1091 "mbcache must be >= 0 and <= %d\n",
1092 RTE_MEMPOOL_CACHE_MAX_SIZE);
1094 if (!strcmp(lgopts[opt_idx].name, "txfreet")) {
1097 tx_free_thresh = (int16_t)n;
1099 rte_exit(EXIT_FAILURE, "txfreet must be >= 0\n");
1101 if (!strcmp(lgopts[opt_idx].name, "txrst")) {
1104 tx_rs_thresh = (int16_t)n;
1106 rte_exit(EXIT_FAILURE, "txrst must be >= 0\n");
1108 if (!strcmp(lgopts[opt_idx].name, "rxd")) {
1111 if (rx_free_thresh >= n)
1112 rte_exit(EXIT_FAILURE,
1114 "rx_free_thresh(%d)\n",
1115 (int)rx_free_thresh);
1117 nb_rxd = (uint16_t) n;
1119 rte_exit(EXIT_FAILURE,
1120 "rxd(%d) invalid - must be > 0\n",
1123 if (!strcmp(lgopts[opt_idx].name, "txd")) {
1126 nb_txd = (uint16_t) n;
1128 rte_exit(EXIT_FAILURE, "txd must be in > 0\n");
1130 if (!strcmp(lgopts[opt_idx].name, "txpt")) {
1133 tx_pthresh = (int8_t)n;
1135 rte_exit(EXIT_FAILURE, "txpt must be >= 0\n");
1137 if (!strcmp(lgopts[opt_idx].name, "txht")) {
1140 tx_hthresh = (int8_t)n;
1142 rte_exit(EXIT_FAILURE, "txht must be >= 0\n");
1144 if (!strcmp(lgopts[opt_idx].name, "txwt")) {
1147 tx_wthresh = (int8_t)n;
1149 rte_exit(EXIT_FAILURE, "txwt must be >= 0\n");
1151 if (!strcmp(lgopts[opt_idx].name, "rxpt")) {
1154 rx_pthresh = (int8_t)n;
1156 rte_exit(EXIT_FAILURE, "rxpt must be >= 0\n");
1158 if (!strcmp(lgopts[opt_idx].name, "rxht")) {
1161 rx_hthresh = (int8_t)n;
1163 rte_exit(EXIT_FAILURE, "rxht must be >= 0\n");
1165 if (!strcmp(lgopts[opt_idx].name, "rxwt")) {
1168 rx_wthresh = (int8_t)n;
1170 rte_exit(EXIT_FAILURE, "rxwt must be >= 0\n");
1172 if (!strcmp(lgopts[opt_idx].name, "rxfreet")) {
1175 rx_free_thresh = (int16_t)n;
1177 rte_exit(EXIT_FAILURE, "rxfreet must be >= 0\n");
1179 if (!strcmp(lgopts[opt_idx].name, "tx-queue-stats-mapping")) {
1180 if (parse_queue_stats_mapping_config(optarg, TX)) {
1181 rte_exit(EXIT_FAILURE,
1182 "invalid TX queue statistics mapping config entered\n");
1185 if (!strcmp(lgopts[opt_idx].name, "rx-queue-stats-mapping")) {
1186 if (parse_queue_stats_mapping_config(optarg, RX)) {
1187 rte_exit(EXIT_FAILURE,
1188 "invalid RX queue statistics mapping config entered\n");
1191 if (!strcmp(lgopts[opt_idx].name, "txpkts")) {
1192 unsigned seg_lengths[RTE_MAX_SEGS_PER_PKT];
1193 unsigned int nb_segs;
1195 nb_segs = parse_item_list(optarg, "txpkt segments",
1196 RTE_MAX_SEGS_PER_PKT, seg_lengths, 0);
1198 set_tx_pkt_segments(seg_lengths, nb_segs);
1200 rte_exit(EXIT_FAILURE, "bad txpkts\n");
1202 if (!strcmp(lgopts[opt_idx].name, "txonly-multi-flow"))
1203 txonly_multi_flow = 1;
1204 if (!strcmp(lgopts[opt_idx].name, "no-flush-rx"))
1206 if (!strcmp(lgopts[opt_idx].name, "disable-link-check"))
1208 if (!strcmp(lgopts[opt_idx].name, "no-lsc-interrupt"))
1210 if (!strcmp(lgopts[opt_idx].name, "no-rmv-interrupt"))
1212 if (!strcmp(lgopts[opt_idx].name, "flow-isolate-all"))
1213 flow_isolate_all = 1;
1214 if (!strcmp(lgopts[opt_idx].name, "tx-offloads")) {
1216 n = strtoull(optarg, &end, 16);
1218 tx_offloads = (uint64_t)n;
1220 rte_exit(EXIT_FAILURE,
1221 "tx-offloads must be >= 0\n");
1223 if (!strcmp(lgopts[opt_idx].name, "vxlan-gpe-port")) {
1226 vxlan_gpe_udp_port = (uint16_t)n;
1228 rte_exit(EXIT_FAILURE,
1229 "vxlan-gpe-port must be >= 0\n");
1231 if (!strcmp(lgopts[opt_idx].name, "print-event"))
1232 if (parse_event_printing_config(optarg, 1)) {
1233 rte_exit(EXIT_FAILURE,
1234 "invalid print-event argument\n");
1236 if (!strcmp(lgopts[opt_idx].name, "mask-event"))
1237 if (parse_event_printing_config(optarg, 0)) {
1238 rte_exit(EXIT_FAILURE,
1239 "invalid mask-event argument\n");
1241 if (!strcmp(lgopts[opt_idx].name, "hot-plug"))
1243 if (!strcmp(lgopts[opt_idx].name, "mlockall"))
1245 if (!strcmp(lgopts[opt_idx].name, "no-mlockall"))
1247 if (!strcmp(lgopts[opt_idx].name,
1248 "noisy-tx-sw-buffer-size")) {
1251 noisy_tx_sw_bufsz = n;
1253 rte_exit(EXIT_FAILURE,
1254 "noisy-tx-sw-buffer-size must be >= 0\n");
1256 if (!strcmp(lgopts[opt_idx].name,
1257 "noisy-tx-sw-buffer-flushtime")) {
1260 noisy_tx_sw_buf_flush_time = n;
1262 rte_exit(EXIT_FAILURE,
1263 "noisy-tx-sw-buffer-flushtime must be >= 0\n");
1265 if (!strcmp(lgopts[opt_idx].name,
1266 "noisy-lkup-memory")) {
1269 noisy_lkup_mem_sz = n;
1271 rte_exit(EXIT_FAILURE,
1272 "noisy-lkup-memory must be >= 0\n");
1274 if (!strcmp(lgopts[opt_idx].name,
1275 "noisy-lkup-num-writes")) {
1278 noisy_lkup_num_writes = n;
1280 rte_exit(EXIT_FAILURE,
1281 "noisy-lkup-num-writes must be >= 0\n");
1283 if (!strcmp(lgopts[opt_idx].name,
1284 "noisy-lkup-num-reads")) {
1287 noisy_lkup_num_reads = n;
1289 rte_exit(EXIT_FAILURE,
1290 "noisy-lkup-num-reads must be >= 0\n");
1292 if (!strcmp(lgopts[opt_idx].name,
1293 "noisy-lkup-num-reads-writes")) {
1296 noisy_lkup_num_reads_writes = n;
1298 rte_exit(EXIT_FAILURE,
1299 "noisy-lkup-num-reads-writes must be >= 0\n");
1301 if (!strcmp(lgopts[opt_idx].name, "no-iova-contig"))
1302 mempool_flags = MEMPOOL_F_NO_IOVA_CONTIG;
1306 rte_exit(EXIT_SUCCESS, "Displayed help\n");
1310 rte_exit(EXIT_FAILURE,
1311 "Command line is incomplete or incorrect\n");
1316 /* Set offload configuration from command line parameters. */
1317 rx_mode.offloads = rx_offloads;
1318 tx_mode.offloads = tx_offloads;
1320 if (mempool_flags & MEMPOOL_F_NO_IOVA_CONTIG &&
1321 mp_alloc_type != MP_ALLOC_ANON) {
1322 TESTPMD_LOG(WARNING, "cannot use no-iova-contig without "
1323 "mp-alloc=anon. mempool no-iova-contig is "