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");
207 #ifdef RTE_LIBRTE_CMDLINE
209 init_peer_eth_addrs(char *config_filename)
215 config_file = fopen(config_filename, "r");
216 if (config_file == NULL) {
217 perror("Failed to open eth config file\n");
221 for (i = 0; i < RTE_MAX_ETHPORTS; i++) {
223 if (fgets(buf, sizeof(buf), config_file) == NULL)
226 if (cmdline_parse_etheraddr(NULL, buf, &peer_eth_addrs[i],
227 sizeof(peer_eth_addrs[i])) < 0) {
228 printf("Bad MAC address format on line %d\n", i+1);
234 nb_peer_eth_addrs = (portid_t) i;
240 * Parse the coremask given as argument (hexadecimal string) and set
241 * the global configuration of forwarding cores.
244 parse_fwd_coremask(const char *coremask)
247 unsigned long long int cm;
249 /* parse hexadecimal string */
251 cm = strtoull(coremask, &end, 16);
252 if ((coremask[0] == '\0') || (end == NULL) || (*end != '\0'))
253 rte_exit(EXIT_FAILURE, "Invalid fwd core mask\n");
254 else if (set_fwd_lcores_mask((uint64_t) cm) < 0)
255 rte_exit(EXIT_FAILURE, "coremask is not valid\n");
259 * Parse the coremask given as argument (hexadecimal string) and set
260 * the global configuration of forwarding cores.
263 parse_fwd_portmask(const char *portmask)
266 unsigned long long int pm;
268 /* parse hexadecimal string */
270 pm = strtoull(portmask, &end, 16);
271 if ((portmask[0] == '\0') || (end == NULL) || (*end != '\0'))
272 rte_exit(EXIT_FAILURE, "Invalid fwd port mask\n");
274 set_fwd_ports_mask((uint64_t) pm);
279 parse_queue_stats_mapping_config(const char *q_arg, int is_rx)
282 const char *p, *p0 = q_arg;
290 unsigned long int_fld[_NUM_FLD];
291 char *str_fld[_NUM_FLD];
295 /* reset from value set at definition */
296 is_rx ? (nb_rx_queue_stats_mappings = 0) : (nb_tx_queue_stats_mappings = 0);
298 while ((p = strchr(p0,'(')) != NULL) {
300 if((p0 = strchr(p,')')) == NULL)
304 if(size >= sizeof(s))
307 snprintf(s, sizeof(s), "%.*s", size, p);
308 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
310 for (i = 0; i < _NUM_FLD; i++){
312 int_fld[i] = strtoul(str_fld[i], &end, 0);
313 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
316 /* Check mapping field is in correct range (0..RTE_ETHDEV_QUEUE_STAT_CNTRS-1) */
317 if (int_fld[FLD_STATS_COUNTER] >= RTE_ETHDEV_QUEUE_STAT_CNTRS) {
318 printf("Stats counter not in the correct range 0..%d\n",
319 RTE_ETHDEV_QUEUE_STAT_CNTRS - 1);
324 if ((nb_tx_queue_stats_mappings >=
325 MAX_TX_QUEUE_STATS_MAPPINGS)) {
326 printf("exceeded max number of TX queue "
327 "statistics mappings: %hu\n",
328 nb_tx_queue_stats_mappings);
331 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].port_id =
332 (uint8_t)int_fld[FLD_PORT];
333 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].queue_id =
334 (uint8_t)int_fld[FLD_QUEUE];
335 tx_queue_stats_mappings_array[nb_tx_queue_stats_mappings].stats_counter_id =
336 (uint8_t)int_fld[FLD_STATS_COUNTER];
337 ++nb_tx_queue_stats_mappings;
340 if ((nb_rx_queue_stats_mappings >=
341 MAX_RX_QUEUE_STATS_MAPPINGS)) {
342 printf("exceeded max number of RX queue "
343 "statistics mappings: %hu\n",
344 nb_rx_queue_stats_mappings);
347 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].port_id =
348 (uint8_t)int_fld[FLD_PORT];
349 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].queue_id =
350 (uint8_t)int_fld[FLD_QUEUE];
351 rx_queue_stats_mappings_array[nb_rx_queue_stats_mappings].stats_counter_id =
352 (uint8_t)int_fld[FLD_STATS_COUNTER];
353 ++nb_rx_queue_stats_mappings;
357 /* Reassign the rx/tx_queue_stats_mappings pointer to point to this newly populated array rather */
358 /* than to the default array (that was set at its definition) */
359 is_rx ? (rx_queue_stats_mappings = rx_queue_stats_mappings_array) :
360 (tx_queue_stats_mappings = tx_queue_stats_mappings_array);
365 print_invalid_socket_id_error(void)
369 printf("Invalid socket id, options are: ");
370 for (i = 0; i < num_sockets; i++) {
371 printf("%u%s", socket_ids[i],
372 (i == num_sockets - 1) ? "\n" : ",");
377 parse_portnuma_config(const char *q_arg)
380 const char *p, *p0 = q_arg;
382 uint8_t i, socket_id;
390 unsigned long int_fld[_NUM_FLD];
391 char *str_fld[_NUM_FLD];
393 /* reset from value set at definition */
394 while ((p = strchr(p0,'(')) != NULL) {
396 if((p0 = strchr(p,')')) == NULL)
400 if(size >= sizeof(s))
403 snprintf(s, sizeof(s), "%.*s", size, p);
404 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
406 for (i = 0; i < _NUM_FLD; i++) {
408 int_fld[i] = strtoul(str_fld[i], &end, 0);
409 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
412 port_id = (portid_t)int_fld[FLD_PORT];
413 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
414 port_id == (portid_t)RTE_PORT_ALL) {
418 socket_id = (uint8_t)int_fld[FLD_SOCKET];
419 if (new_socket_id(socket_id)) {
420 if (num_sockets >= RTE_MAX_NUMA_NODES) {
421 print_invalid_socket_id_error();
424 socket_ids[num_sockets++] = socket_id;
426 port_numa[port_id] = socket_id;
433 parse_ringnuma_config(const char *q_arg)
436 const char *p, *p0 = q_arg;
438 uint8_t i, ring_flag, socket_id;
447 unsigned long int_fld[_NUM_FLD];
448 char *str_fld[_NUM_FLD];
449 #define RX_RING_ONLY 0x1
450 #define TX_RING_ONLY 0x2
451 #define RXTX_RING 0x3
453 /* reset from value set at definition */
454 while ((p = strchr(p0,'(')) != NULL) {
456 if((p0 = strchr(p,')')) == NULL)
460 if(size >= sizeof(s))
463 snprintf(s, sizeof(s), "%.*s", size, p);
464 if (rte_strsplit(s, sizeof(s), str_fld, _NUM_FLD, ',') != _NUM_FLD)
466 for (i = 0; i < _NUM_FLD; i++) {
468 int_fld[i] = strtoul(str_fld[i], &end, 0);
469 if (errno != 0 || end == str_fld[i] || int_fld[i] > 255)
472 port_id = (portid_t)int_fld[FLD_PORT];
473 if (port_id_is_invalid(port_id, ENABLED_WARN) ||
474 port_id == (portid_t)RTE_PORT_ALL) {
478 socket_id = (uint8_t)int_fld[FLD_SOCKET];
479 if (new_socket_id(socket_id)) {
480 if (num_sockets >= RTE_MAX_NUMA_NODES) {
481 print_invalid_socket_id_error();
484 socket_ids[num_sockets++] = socket_id;
486 ring_flag = (uint8_t)int_fld[FLD_FLAG];
487 if ((ring_flag < RX_RING_ONLY) || (ring_flag > RXTX_RING)) {
488 printf("Invalid ring-flag=%d config for port =%d\n",
493 switch (ring_flag & RXTX_RING) {
495 rxring_numa[port_id] = socket_id;
498 txring_numa[port_id] = socket_id;
501 rxring_numa[port_id] = socket_id;
502 txring_numa[port_id] = socket_id;
505 printf("Invalid ring-flag=%d config for port=%d\n",
515 parse_event_printing_config(const char *optarg, int enable)
519 if (!strcmp(optarg, "unknown"))
520 mask = UINT32_C(1) << RTE_ETH_EVENT_UNKNOWN;
521 else if (!strcmp(optarg, "intr_lsc"))
522 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_LSC;
523 else if (!strcmp(optarg, "queue_state"))
524 mask = UINT32_C(1) << RTE_ETH_EVENT_QUEUE_STATE;
525 else if (!strcmp(optarg, "intr_reset"))
526 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RESET;
527 else if (!strcmp(optarg, "vf_mbox"))
528 mask = UINT32_C(1) << RTE_ETH_EVENT_VF_MBOX;
529 else if (!strcmp(optarg, "ipsec"))
530 mask = UINT32_C(1) << RTE_ETH_EVENT_IPSEC;
531 else if (!strcmp(optarg, "macsec"))
532 mask = UINT32_C(1) << RTE_ETH_EVENT_MACSEC;
533 else if (!strcmp(optarg, "intr_rmv"))
534 mask = UINT32_C(1) << RTE_ETH_EVENT_INTR_RMV;
535 else if (!strcmp(optarg, "dev_probed"))
536 mask = UINT32_C(1) << RTE_ETH_EVENT_NEW;
537 else if (!strcmp(optarg, "dev_released"))
538 mask = UINT32_C(1) << RTE_ETH_EVENT_DESTROY;
539 else if (!strcmp(optarg, "all"))
542 fprintf(stderr, "Invalid event: %s\n", optarg);
546 event_print_mask |= mask;
548 event_print_mask &= ~mask;
553 launch_args_parse(int argc, char** argv)
560 /* Default offloads for all ports. */
561 uint64_t rx_offloads = rx_mode.offloads;
562 uint64_t tx_offloads = tx_mode.offloads;
563 struct rte_eth_dev_info dev_info;
564 uint16_t rec_nb_pkts;
566 static struct option lgopts[] = {
568 #ifdef RTE_LIBRTE_CMDLINE
569 { "interactive", 0, 0, 0 },
570 { "cmdline-file", 1, 0, 0 },
571 { "auto-start", 0, 0, 0 },
572 { "eth-peers-configfile", 1, 0, 0 },
573 { "eth-peer", 1, 0, 0 },
575 { "tx-first", 0, 0, 0 },
576 { "stats-period", 1, 0, 0 },
577 { "ports", 1, 0, 0 },
578 { "nb-cores", 1, 0, 0 },
579 { "nb-ports", 1, 0, 0 },
580 { "coremask", 1, 0, 0 },
581 { "portmask", 1, 0, 0 },
583 { "no-numa", 0, 0, 0 },
584 { "mp-anon", 0, 0, 0 },
585 { "port-numa-config", 1, 0, 0 },
586 { "ring-numa-config", 1, 0, 0 },
587 { "socket-num", 1, 0, 0 },
588 { "mbuf-size", 1, 0, 0 },
589 { "total-num-mbufs", 1, 0, 0 },
590 { "max-pkt-len", 1, 0, 0 },
591 { "pkt-filter-mode", 1, 0, 0 },
592 { "pkt-filter-report-hash", 1, 0, 0 },
593 { "pkt-filter-size", 1, 0, 0 },
594 { "pkt-filter-drop-queue", 1, 0, 0 },
595 #ifdef RTE_LIBRTE_LATENCY_STATS
596 { "latencystats", 1, 0, 0 },
598 #ifdef RTE_LIBRTE_BITRATE
599 { "bitrate-stats", 1, 0, 0 },
601 { "disable-crc-strip", 0, 0, 0 },
602 { "enable-lro", 0, 0, 0 },
603 { "enable-rx-cksum", 0, 0, 0 },
604 { "enable-rx-timestamp", 0, 0, 0 },
605 { "enable-scatter", 0, 0, 0 },
606 { "enable-hw-vlan", 0, 0, 0 },
607 { "enable-hw-vlan-filter", 0, 0, 0 },
608 { "enable-hw-vlan-strip", 0, 0, 0 },
609 { "enable-hw-vlan-extend", 0, 0, 0 },
610 { "enable-drop-en", 0, 0, 0 },
611 { "disable-rss", 0, 0, 0 },
612 { "port-topology", 1, 0, 0 },
613 { "forward-mode", 1, 0, 0 },
614 { "rss-ip", 0, 0, 0 },
615 { "rss-udp", 0, 0, 0 },
620 { "burst", 1, 0, 0 },
621 { "mbcache", 1, 0, 0 },
625 { "txfreet", 1, 0, 0 },
626 { "txrst", 1, 0, 0 },
630 { "rxfreet", 1, 0, 0 },
631 { "tx-queue-stats-mapping", 1, 0, 0 },
632 { "rx-queue-stats-mapping", 1, 0, 0 },
633 { "no-flush-rx", 0, 0, 0 },
634 { "flow-isolate-all", 0, 0, 0 },
635 { "txpkts", 1, 0, 0 },
636 { "txonly-multi-flow", 0, 0, 0 },
637 { "disable-link-check", 0, 0, 0 },
638 { "no-lsc-interrupt", 0, 0, 0 },
639 { "no-rmv-interrupt", 0, 0, 0 },
640 { "print-event", 1, 0, 0 },
641 { "mask-event", 1, 0, 0 },
642 { "tx-offloads", 1, 0, 0 },
643 { "hot-plug", 0, 0, 0 },
644 { "vxlan-gpe-port", 1, 0, 0 },
645 { "mlockall", 0, 0, 0 },
646 { "no-mlockall", 0, 0, 0 },
647 { "mp-alloc", 1, 0, 0 },
648 { "noisy-tx-sw-buffer-size", 1, 0, 0 },
649 { "noisy-tx-sw-buffer-flushtime", 1, 0, 0 },
650 { "noisy-lkup-memory", 1, 0, 0 },
651 { "noisy-lkup-num-writes", 1, 0, 0 },
652 { "noisy-lkup-num-reads", 1, 0, 0 },
653 { "noisy-lkup-num-reads-writes", 1, 0, 0 },
659 #ifdef RTE_LIBRTE_CMDLINE
660 #define SHORTOPTS "i"
664 while ((opt = getopt_long(argc, argvopt, SHORTOPTS "ah",
665 lgopts, &opt_idx)) != EOF) {
667 #ifdef RTE_LIBRTE_CMDLINE
669 printf("Interactive-mode selected\n");
674 printf("Auto-start selected\n");
678 case 0: /*long options */
679 if (!strcmp(lgopts[opt_idx].name, "help")) {
681 rte_exit(EXIT_SUCCESS, "Displayed help\n");
683 #ifdef RTE_LIBRTE_CMDLINE
684 if (!strcmp(lgopts[opt_idx].name, "interactive")) {
685 printf("Interactive-mode selected\n");
688 if (!strcmp(lgopts[opt_idx].name, "cmdline-file")) {
689 printf("CLI commands to be read from %s\n",
691 strlcpy(cmdline_filename, optarg,
692 sizeof(cmdline_filename));
694 if (!strcmp(lgopts[opt_idx].name, "auto-start")) {
695 printf("Auto-start selected\n");
698 if (!strcmp(lgopts[opt_idx].name, "tx-first")) {
699 printf("Ports to start sending a burst of "
703 if (!strcmp(lgopts[opt_idx].name, "stats-period")) {
707 n = strtoul(optarg, &end, 10);
708 if ((optarg[0] == '\0') || (end == NULL) ||
715 if (!strcmp(lgopts[opt_idx].name,
716 "eth-peers-configfile")) {
717 if (init_peer_eth_addrs(optarg) != 0)
718 rte_exit(EXIT_FAILURE,
719 "Cannot open logfile\n");
721 if (!strcmp(lgopts[opt_idx].name, "eth-peer")) {
723 uint8_t c, peer_addr[6];
726 n = strtoul(optarg, &port_end, 10);
727 if (errno != 0 || port_end == optarg || *port_end++ != ',')
728 rte_exit(EXIT_FAILURE,
729 "Invalid eth-peer: %s", optarg);
730 if (n >= RTE_MAX_ETHPORTS)
731 rte_exit(EXIT_FAILURE,
732 "eth-peer: port %d >= RTE_MAX_ETHPORTS(%d)\n",
733 n, RTE_MAX_ETHPORTS);
735 if (cmdline_parse_etheraddr(NULL, port_end,
736 &peer_addr, sizeof(peer_addr)) < 0)
737 rte_exit(EXIT_FAILURE,
738 "Invalid ethernet address: %s\n",
740 for (c = 0; c < 6; c++)
741 peer_eth_addrs[n].addr_bytes[c] =
746 if (!strcmp(lgopts[opt_idx].name, "nb-ports")) {
748 if (n > 0 && n <= nb_ports)
751 rte_exit(EXIT_FAILURE,
752 "Invalid port %d\n", n);
754 if (!strcmp(lgopts[opt_idx].name, "nb-cores")) {
756 if (n > 0 && n <= nb_lcores)
757 nb_fwd_lcores = (uint8_t) n;
759 rte_exit(EXIT_FAILURE,
760 "nb-cores should be > 0 and <= %d\n",
763 if (!strcmp(lgopts[opt_idx].name, "coremask"))
764 parse_fwd_coremask(optarg);
765 if (!strcmp(lgopts[opt_idx].name, "portmask"))
766 parse_fwd_portmask(optarg);
767 if (!strcmp(lgopts[opt_idx].name, "no-numa"))
769 if (!strcmp(lgopts[opt_idx].name, "numa"))
771 if (!strcmp(lgopts[opt_idx].name, "mp-anon")) {
772 mp_alloc_type = MP_ALLOC_ANON;
774 if (!strcmp(lgopts[opt_idx].name, "mp-alloc")) {
775 if (!strcmp(optarg, "native"))
776 mp_alloc_type = MP_ALLOC_NATIVE;
777 else if (!strcmp(optarg, "anon"))
778 mp_alloc_type = MP_ALLOC_ANON;
779 else if (!strcmp(optarg, "xmem"))
780 mp_alloc_type = MP_ALLOC_XMEM;
781 else if (!strcmp(optarg, "xmemhuge"))
782 mp_alloc_type = MP_ALLOC_XMEM_HUGE;
784 rte_exit(EXIT_FAILURE,
785 "mp-alloc %s invalid - must be: "
786 "native, anon, xmem or xmemhuge\n",
789 if (!strcmp(lgopts[opt_idx].name, "port-numa-config")) {
790 if (parse_portnuma_config(optarg))
791 rte_exit(EXIT_FAILURE,
792 "invalid port-numa configuration\n");
794 if (!strcmp(lgopts[opt_idx].name, "ring-numa-config"))
795 if (parse_ringnuma_config(optarg))
796 rte_exit(EXIT_FAILURE,
797 "invalid ring-numa configuration\n");
798 if (!strcmp(lgopts[opt_idx].name, "socket-num")) {
800 if (!new_socket_id((uint8_t)n)) {
801 socket_num = (uint8_t)n;
803 print_invalid_socket_id_error();
804 rte_exit(EXIT_FAILURE,
805 "Invalid socket id");
808 if (!strcmp(lgopts[opt_idx].name, "mbuf-size")) {
810 if (n > 0 && n <= 0xFFFF)
811 mbuf_data_size = (uint16_t) n;
813 rte_exit(EXIT_FAILURE,
814 "mbuf-size should be > 0 and < 65536\n");
816 if (!strcmp(lgopts[opt_idx].name, "total-num-mbufs")) {
819 param_total_num_mbufs = (unsigned)n;
821 rte_exit(EXIT_FAILURE,
822 "total-num-mbufs should be > 1024\n");
824 if (!strcmp(lgopts[opt_idx].name, "max-pkt-len")) {
826 if (n >= ETHER_MIN_LEN) {
827 rx_mode.max_rx_pkt_len = (uint32_t) n;
828 if (n > ETHER_MAX_LEN)
830 DEV_RX_OFFLOAD_JUMBO_FRAME;
832 rte_exit(EXIT_FAILURE,
833 "Invalid max-pkt-len=%d - should be > %d\n",
836 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-mode")) {
837 if (!strcmp(optarg, "signature"))
839 RTE_FDIR_MODE_SIGNATURE;
840 else if (!strcmp(optarg, "perfect"))
841 fdir_conf.mode = RTE_FDIR_MODE_PERFECT;
842 else if (!strcmp(optarg, "perfect-mac-vlan"))
843 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_MAC_VLAN;
844 else if (!strcmp(optarg, "perfect-tunnel"))
845 fdir_conf.mode = RTE_FDIR_MODE_PERFECT_TUNNEL;
846 else if (!strcmp(optarg, "none"))
847 fdir_conf.mode = RTE_FDIR_MODE_NONE;
849 rte_exit(EXIT_FAILURE,
850 "pkt-mode-invalid %s invalid - must be: "
851 "none, signature, perfect, perfect-mac-vlan"
852 " or perfect-tunnel\n",
855 if (!strcmp(lgopts[opt_idx].name,
856 "pkt-filter-report-hash")) {
857 if (!strcmp(optarg, "none"))
859 RTE_FDIR_NO_REPORT_STATUS;
860 else if (!strcmp(optarg, "match"))
862 RTE_FDIR_REPORT_STATUS;
863 else if (!strcmp(optarg, "always"))
865 RTE_FDIR_REPORT_STATUS_ALWAYS;
867 rte_exit(EXIT_FAILURE,
868 "pkt-filter-report-hash %s invalid "
869 "- must be: none or match or always\n",
872 if (!strcmp(lgopts[opt_idx].name, "pkt-filter-size")) {
873 if (!strcmp(optarg, "64K"))
875 RTE_FDIR_PBALLOC_64K;
876 else if (!strcmp(optarg, "128K"))
878 RTE_FDIR_PBALLOC_128K;
879 else if (!strcmp(optarg, "256K"))
881 RTE_FDIR_PBALLOC_256K;
883 rte_exit(EXIT_FAILURE, "pkt-filter-size %s invalid -"
884 " must be: 64K or 128K or 256K\n",
887 if (!strcmp(lgopts[opt_idx].name,
888 "pkt-filter-drop-queue")) {
891 fdir_conf.drop_queue = (uint8_t) n;
893 rte_exit(EXIT_FAILURE,
894 "drop queue %d invalid - must"
897 #ifdef RTE_LIBRTE_LATENCY_STATS
898 if (!strcmp(lgopts[opt_idx].name,
902 latencystats_lcore_id = (lcoreid_t) n;
903 latencystats_enabled = 1;
905 rte_exit(EXIT_FAILURE,
906 "invalid lcore id %d for latencystats"
907 " must be >= 0\n", n);
910 #ifdef RTE_LIBRTE_BITRATE
911 if (!strcmp(lgopts[opt_idx].name, "bitrate-stats")) {
914 bitrate_lcore_id = (lcoreid_t) n;
917 rte_exit(EXIT_FAILURE,
918 "invalid lcore id %d for bitrate stats"
919 " must be >= 0\n", n);
922 if (!strcmp(lgopts[opt_idx].name, "disable-crc-strip"))
923 rx_offloads |= DEV_RX_OFFLOAD_KEEP_CRC;
924 if (!strcmp(lgopts[opt_idx].name, "enable-lro"))
925 rx_offloads |= DEV_RX_OFFLOAD_TCP_LRO;
926 if (!strcmp(lgopts[opt_idx].name, "enable-scatter"))
927 rx_offloads |= DEV_RX_OFFLOAD_SCATTER;
928 if (!strcmp(lgopts[opt_idx].name, "enable-rx-cksum"))
929 rx_offloads |= DEV_RX_OFFLOAD_CHECKSUM;
930 if (!strcmp(lgopts[opt_idx].name,
931 "enable-rx-timestamp"))
932 rx_offloads |= DEV_RX_OFFLOAD_TIMESTAMP;
933 if (!strcmp(lgopts[opt_idx].name, "enable-hw-vlan"))
934 rx_offloads |= DEV_RX_OFFLOAD_VLAN;
936 if (!strcmp(lgopts[opt_idx].name,
937 "enable-hw-vlan-filter"))
938 rx_offloads |= DEV_RX_OFFLOAD_VLAN_FILTER;
940 if (!strcmp(lgopts[opt_idx].name,
941 "enable-hw-vlan-strip"))
942 rx_offloads |= DEV_RX_OFFLOAD_VLAN_STRIP;
944 if (!strcmp(lgopts[opt_idx].name,
945 "enable-hw-vlan-extend"))
946 rx_offloads |= DEV_RX_OFFLOAD_VLAN_EXTEND;
948 if (!strcmp(lgopts[opt_idx].name, "enable-drop-en"))
951 if (!strcmp(lgopts[opt_idx].name, "disable-rss"))
953 if (!strcmp(lgopts[opt_idx].name, "port-topology")) {
954 if (!strcmp(optarg, "paired"))
955 port_topology = PORT_TOPOLOGY_PAIRED;
956 else if (!strcmp(optarg, "chained"))
957 port_topology = PORT_TOPOLOGY_CHAINED;
958 else if (!strcmp(optarg, "loop"))
959 port_topology = PORT_TOPOLOGY_LOOP;
961 rte_exit(EXIT_FAILURE, "port-topology %s invalid -"
962 " must be: paired, chained or loop\n",
965 if (!strcmp(lgopts[opt_idx].name, "forward-mode"))
966 set_pkt_forwarding_mode(optarg);
967 if (!strcmp(lgopts[opt_idx].name, "rss-ip"))
969 if (!strcmp(lgopts[opt_idx].name, "rss-udp"))
970 rss_hf = ETH_RSS_UDP;
971 if (!strcmp(lgopts[opt_idx].name, "rxq")) {
973 if (n >= 0 && check_nb_rxq((queueid_t)n) == 0)
974 nb_rxq = (queueid_t) n;
976 rte_exit(EXIT_FAILURE, "rxq %d invalid - must be"
977 " >= 0 && <= %u\n", n,
978 get_allowed_max_nb_rxq(&pid));
980 if (!strcmp(lgopts[opt_idx].name, "txq")) {
982 if (n >= 0 && check_nb_txq((queueid_t)n) == 0)
983 nb_txq = (queueid_t) n;
985 rte_exit(EXIT_FAILURE, "txq %d invalid - must be"
986 " >= 0 && <= %u\n", n,
987 get_allowed_max_nb_txq(&pid));
989 if (!nb_rxq && !nb_txq) {
990 rte_exit(EXIT_FAILURE, "Either rx or tx queues should "
993 if (!strcmp(lgopts[opt_idx].name, "burst")) {
996 /* A burst size of zero means that the
997 * PMD should be queried for
998 * recommended Rx burst size. Since
999 * testpmd uses a single size for all
1000 * ports, port 0 is queried for the
1001 * value, on the assumption that all
1002 * ports are of the same NIC model.
1004 rte_eth_dev_info_get(0, &dev_info);
1005 rec_nb_pkts = dev_info
1006 .default_rxportconf.burst_size;
1008 if (rec_nb_pkts == 0)
1009 rte_exit(EXIT_FAILURE,
1010 "PMD does not recommend a burst size. "
1011 "Provided value must be between "
1012 "1 and %d\n", MAX_PKT_BURST);
1013 else if (rec_nb_pkts > MAX_PKT_BURST)
1014 rte_exit(EXIT_FAILURE,
1015 "PMD recommended burst size of %d"
1016 " exceeds maximum value of %d\n",
1017 rec_nb_pkts, MAX_PKT_BURST);
1018 printf("Using PMD-provided burst value of %d\n",
1020 nb_pkt_per_burst = rec_nb_pkts;
1021 } else if (n > MAX_PKT_BURST)
1022 rte_exit(EXIT_FAILURE,
1023 "burst must be between1 and %d\n",
1026 nb_pkt_per_burst = (uint16_t) n;
1028 if (!strcmp(lgopts[opt_idx].name, "mbcache")) {
1031 (n <= RTE_MEMPOOL_CACHE_MAX_SIZE))
1032 mb_mempool_cache = (uint16_t) n;
1034 rte_exit(EXIT_FAILURE,
1035 "mbcache must be >= 0 and <= %d\n",
1036 RTE_MEMPOOL_CACHE_MAX_SIZE);
1038 if (!strcmp(lgopts[opt_idx].name, "txfreet")) {
1041 tx_free_thresh = (int16_t)n;
1043 rte_exit(EXIT_FAILURE, "txfreet must be >= 0\n");
1045 if (!strcmp(lgopts[opt_idx].name, "txrst")) {
1048 tx_rs_thresh = (int16_t)n;
1050 rte_exit(EXIT_FAILURE, "txrst must be >= 0\n");
1052 if (!strcmp(lgopts[opt_idx].name, "rxd")) {
1055 if (rx_free_thresh >= n)
1056 rte_exit(EXIT_FAILURE,
1058 "rx_free_thresh(%d)\n",
1059 (int)rx_free_thresh);
1061 nb_rxd = (uint16_t) n;
1063 rte_exit(EXIT_FAILURE,
1064 "rxd(%d) invalid - must be > 0\n",
1067 if (!strcmp(lgopts[opt_idx].name, "txd")) {
1070 nb_txd = (uint16_t) n;
1072 rte_exit(EXIT_FAILURE, "txd must be in > 0\n");
1074 if (!strcmp(lgopts[opt_idx].name, "txpt")) {
1077 tx_pthresh = (int8_t)n;
1079 rte_exit(EXIT_FAILURE, "txpt must be >= 0\n");
1081 if (!strcmp(lgopts[opt_idx].name, "txht")) {
1084 tx_hthresh = (int8_t)n;
1086 rte_exit(EXIT_FAILURE, "txht must be >= 0\n");
1088 if (!strcmp(lgopts[opt_idx].name, "txwt")) {
1091 tx_wthresh = (int8_t)n;
1093 rte_exit(EXIT_FAILURE, "txwt must be >= 0\n");
1095 if (!strcmp(lgopts[opt_idx].name, "rxpt")) {
1098 rx_pthresh = (int8_t)n;
1100 rte_exit(EXIT_FAILURE, "rxpt must be >= 0\n");
1102 if (!strcmp(lgopts[opt_idx].name, "rxht")) {
1105 rx_hthresh = (int8_t)n;
1107 rte_exit(EXIT_FAILURE, "rxht must be >= 0\n");
1109 if (!strcmp(lgopts[opt_idx].name, "rxwt")) {
1112 rx_wthresh = (int8_t)n;
1114 rte_exit(EXIT_FAILURE, "rxwt must be >= 0\n");
1116 if (!strcmp(lgopts[opt_idx].name, "rxfreet")) {
1119 rx_free_thresh = (int16_t)n;
1121 rte_exit(EXIT_FAILURE, "rxfreet must be >= 0\n");
1123 if (!strcmp(lgopts[opt_idx].name, "tx-queue-stats-mapping")) {
1124 if (parse_queue_stats_mapping_config(optarg, TX)) {
1125 rte_exit(EXIT_FAILURE,
1126 "invalid TX queue statistics mapping config entered\n");
1129 if (!strcmp(lgopts[opt_idx].name, "rx-queue-stats-mapping")) {
1130 if (parse_queue_stats_mapping_config(optarg, RX)) {
1131 rte_exit(EXIT_FAILURE,
1132 "invalid RX queue statistics mapping config entered\n");
1135 if (!strcmp(lgopts[opt_idx].name, "txpkts")) {
1136 unsigned seg_lengths[RTE_MAX_SEGS_PER_PKT];
1137 unsigned int nb_segs;
1139 nb_segs = parse_item_list(optarg, "txpkt segments",
1140 RTE_MAX_SEGS_PER_PKT, seg_lengths, 0);
1142 set_tx_pkt_segments(seg_lengths, nb_segs);
1144 rte_exit(EXIT_FAILURE, "bad txpkts\n");
1146 if (!strcmp(lgopts[opt_idx].name, "txonly-multi-flow"))
1147 txonly_multi_flow = 1;
1148 if (!strcmp(lgopts[opt_idx].name, "no-flush-rx"))
1150 if (!strcmp(lgopts[opt_idx].name, "disable-link-check"))
1152 if (!strcmp(lgopts[opt_idx].name, "no-lsc-interrupt"))
1154 if (!strcmp(lgopts[opt_idx].name, "no-rmv-interrupt"))
1156 if (!strcmp(lgopts[opt_idx].name, "flow-isolate-all"))
1157 flow_isolate_all = 1;
1158 if (!strcmp(lgopts[opt_idx].name, "tx-offloads")) {
1160 n = strtoull(optarg, &end, 16);
1162 tx_offloads = (uint64_t)n;
1164 rte_exit(EXIT_FAILURE,
1165 "tx-offloads must be >= 0\n");
1167 if (!strcmp(lgopts[opt_idx].name, "vxlan-gpe-port")) {
1170 vxlan_gpe_udp_port = (uint16_t)n;
1172 rte_exit(EXIT_FAILURE,
1173 "vxlan-gpe-port must be >= 0\n");
1175 if (!strcmp(lgopts[opt_idx].name, "print-event"))
1176 if (parse_event_printing_config(optarg, 1)) {
1177 rte_exit(EXIT_FAILURE,
1178 "invalid print-event argument\n");
1180 if (!strcmp(lgopts[opt_idx].name, "mask-event"))
1181 if (parse_event_printing_config(optarg, 0)) {
1182 rte_exit(EXIT_FAILURE,
1183 "invalid mask-event argument\n");
1185 if (!strcmp(lgopts[opt_idx].name, "hot-plug"))
1187 if (!strcmp(lgopts[opt_idx].name, "mlockall"))
1189 if (!strcmp(lgopts[opt_idx].name, "no-mlockall"))
1191 if (!strcmp(lgopts[opt_idx].name,
1192 "noisy-tx-sw-buffer-size")) {
1195 noisy_tx_sw_bufsz = n;
1197 rte_exit(EXIT_FAILURE,
1198 "noisy-tx-sw-buffer-size must be >= 0\n");
1200 if (!strcmp(lgopts[opt_idx].name,
1201 "noisy-tx-sw-buffer-flushtime")) {
1204 noisy_tx_sw_buf_flush_time = n;
1206 rte_exit(EXIT_FAILURE,
1207 "noisy-tx-sw-buffer-flushtime must be >= 0\n");
1209 if (!strcmp(lgopts[opt_idx].name,
1210 "noisy-lkup-memory")) {
1213 noisy_lkup_mem_sz = n;
1215 rte_exit(EXIT_FAILURE,
1216 "noisy-lkup-memory must be >= 0\n");
1218 if (!strcmp(lgopts[opt_idx].name,
1219 "noisy-lkup-num-writes")) {
1222 noisy_lkup_num_writes = n;
1224 rte_exit(EXIT_FAILURE,
1225 "noisy-lkup-num-writes must be >= 0\n");
1227 if (!strcmp(lgopts[opt_idx].name,
1228 "noisy-lkup-num-reads")) {
1231 noisy_lkup_num_reads = n;
1233 rte_exit(EXIT_FAILURE,
1234 "noisy-lkup-num-reads must be >= 0\n");
1236 if (!strcmp(lgopts[opt_idx].name,
1237 "noisy-lkup-num-reads-writes")) {
1240 noisy_lkup_num_reads_writes = n;
1242 rte_exit(EXIT_FAILURE,
1243 "noisy-lkup-num-reads-writes must be >= 0\n");
1248 rte_exit(EXIT_SUCCESS, "Displayed help\n");
1252 rte_exit(EXIT_FAILURE,
1253 "Command line is incomplete or incorrect\n");
1258 /* Set offload configuration from command line parameters. */
1259 rx_mode.offloads = rx_offloads;
1260 tx_mode.offloads = tx_offloads;