1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2010-2014 Intel Corporation.
4 Running the Application
5 =======================
7 EAL Command-line Options
8 ------------------------
10 Please refer to :doc:`EAL parameters (Linux) <../linux_gsg/linux_eal_parameters>`
11 or :doc:`EAL parameters (FreeBSD) <../freebsd_gsg/freebsd_eal_parameters>` for
12 a list of available EAL command-line options.
15 Testpmd Command-line Options
16 ----------------------------
18 The following are the command-line options for the testpmd applications.
19 They must be separated from the EAL options, shown in the previous section, with a ``--`` separator:
21 .. code-block:: console
23 sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
25 The command line options are:
27 * ``-i, --interactive``
29 Run testpmd in interactive mode.
30 In this mode, the testpmd starts with a prompt that can be used to start and stop forwarding,
31 configure the application and display stats on the current packet processing session.
32 See :ref:`testpmd_runtime` for more details.
34 In non-interactive mode,
35 the application starts with the configuration specified on the command-line and
36 immediately enters forwarding mode.
40 Display a help message and quit.
42 * ``-a, --auto-start``
44 Start forwarding on initialization.
48 Start forwarding, after sending a burst of packets first.
52 This flag should be only used in non-interactive mode.
54 * ``--stats-period PERIOD``
56 Display statistics every PERIOD seconds, if interactive mode is disabled.
57 The default value is 0, which means that the statistics will not be displayed.
61 Set the number of forwarding cores,
62 where 1 <= N <= "number of cores" or ``CONFIG_RTE_MAX_LCORE`` from the configuration file.
63 The default value is 1.
67 Set the number of forwarding ports,
68 where 1 <= N <= "number of ports" on the board or ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
69 The default value is the number of ports on the board.
73 Set the hexadecimal bitmask of the cores running the packet forwarding test.
74 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
78 Set the hexadecimal bitmask of the ports used by the packet forwarding test.
82 Set the forwarding ports based on the user input used by the packet forwarding test.
83 '-' denotes a range of ports to set including the two specified port IDs
84 ',' separates multiple port values.
85 Possible examples like --portlist=0,1 or --portlist=0-2 or --portlist=0,1-2 etc
89 Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers
90 (mbufs). [Default setting]
94 Disable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
96 * ``--port-numa-config=(port,socket)[,(port,socket)]``
98 Specify the socket on which the memory pool to be used by the port will be allocated.
100 * ``--ring-numa-config=(port,flag,socket)[,(port,flag,socket)]``
102 Specify the socket on which the TX/RX rings for the port will be allocated.
103 Where flag is 1 for RX, 2 for TX, and 3 for RX and TX.
107 Set the socket from which all memory is allocated in NUMA mode,
108 where 0 <= N < number of sockets on the board.
112 Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
114 * ``--total-num-mbufs=N``
116 Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
118 * ``--max-pkt-len=N``
120 Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
122 * ``--max-lro-pkt-size=N``
124 Set the maximum LRO aggregated packet size to N bytes, where N >= 64.
126 * ``--eth-peers-configfile=name``
128 Use a configuration file containing the Ethernet addresses of the peer ports.
129 The configuration file should contain the Ethernet addresses on separate lines::
135 * ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
137 Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
138 where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
140 * ``--tx-ip=SRC,DST``
142 Set the source and destination IP address used when doing transmit only test.
143 The defaults address values are source 198.18.0.1 and
144 destination 198.18.0.2. These are special purpose addresses
145 reserved for benchmarking (RFC 5735).
147 * ``--tx-udp=SRC[,DST]``
149 Set the source and destination UDP port number for transmit test only test.
150 The default port is the port 9 which is defined for the discard protocol
153 * ``--pkt-filter-mode=mode``
155 Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
156 See :ref:`testpmd_flow_director` for more details.
158 * ``--pkt-filter-report-hash=mode``
160 Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
162 * ``--pkt-filter-size=N``
164 Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
165 Sizes are in kilobytes. The default is 64.
167 * ``--pkt-filter-flexbytes-offset=N``
169 Set the flexbytes offset.
170 The offset is defined in words (not bytes) counted from the first byte of the destination Ethernet MAC address,
171 where N is 0 <= N <= 32.
172 The default value is 0x6.
174 * ``--pkt-filter-drop-queue=N``
177 In perfect filter mode, when a rule is added with queue = -1, the packet will be enqueued into the RX drop-queue.
178 If the drop-queue does not exist, the packet is dropped. The default value is N=127.
180 * ``--disable-crc-strip``
182 Disable hardware CRC stripping.
186 Enable large receive offload.
188 * ``--enable-rx-cksum``
190 Enable hardware RX checksum offload.
192 * ``--enable-scatter``
194 Enable scatter (multi-segment) RX.
196 * ``--enable-hw-vlan``
198 Enable hardware VLAN.
200 * ``--enable-hw-vlan-filter``
202 Enable hardware VLAN filter.
204 * ``--enable-hw-vlan-strip``
206 Enable hardware VLAN strip.
208 * ``--enable-hw-vlan-extend``
210 Enable hardware VLAN extend.
212 * ``--enable-hw-qinq-strip``
214 Enable hardware QINQ strip.
216 * ``--enable-drop-en``
218 Enable per-queue packet drop for packets with no descriptors.
222 Disable RSS (Receive Side Scaling).
224 * ``--port-topology=mode``
226 Set port topology, where mode is ``paired`` (the default), ``chained`` or ``loop``.
228 In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
230 In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
232 The ordering of the ports can be changed using the portlist testpmd runtime function.
234 In ``loop`` mode, ingress traffic is simply transmitted back on the same interface.
236 * ``--forward-mode=mode``
238 Set the forwarding mode where ``mode`` is one of the following::
254 Set RSS functions for IPv4/IPv6 only.
258 Set RSS functions for IPv4/IPv6 and UDP.
262 Set the number of RX queues per port to N, where 1 <= N <= 65535.
263 The default value is 1.
267 Set the number of descriptors in the RX rings to N, where N > 0.
268 The default value is 128.
272 Set the number of TX queues per port to N, where 1 <= N <= 65535.
273 The default value is 1.
277 Set the number of descriptors in the TX rings to N, where N > 0.
278 The default value is 512.
282 Set the number of hairpin queues per port to N, where 1 <= N <= 65535.
283 The default value is 0. The number of hairpin queues are added to the
284 number of TX queues and to the number of RX queues. then the first
285 RX hairpin is binded to the first TX hairpin, the second RX hairpin is
286 binded to the second TX hairpin and so on. The index of the first
287 RX hairpin queue is the number of RX queues as configured using --rxq.
288 The index of the first TX hairpin queue is the number of TX queues
289 as configured using --txq.
293 Set the number of packets per burst to N, where 1 <= N <= 512.
294 The default value is 32.
295 If set to 0, driver default is used if defined. Else, if driver
296 default is not defined, default of 32 is used.
300 Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
301 The default value is 16.
305 Set the prefetch threshold register of RX rings to N, where N >= 0.
306 The default value is 8.
310 Set the host threshold register of RX rings to N, where N >= 0.
311 The default value is 8.
315 Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
316 The default value is 0.
320 Set the write-back threshold register of RX rings to N, where N >= 0.
321 The default value is 4.
325 Set the prefetch threshold register of TX rings to N, where N >= 0.
326 The default value is 36.
330 Set the host threshold register of TX rings to N, where N >= 0.
331 The default value is 0.
335 Set the write-back threshold register of TX rings to N, where N >= 0.
336 The default value is 0.
340 Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
341 The default value is 0.
345 Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
346 The default value is 0.
348 * ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
350 Set the RX queues statistics counters mapping 0 <= mapping <= 15.
352 * ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
354 Set the TX queues statistics counters mapping 0 <= mapping <= 15.
358 Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
362 Set TX segment sizes or total packet length. Valid for ``tx-only``
363 and ``flowgen`` forwarding modes.
365 * ``--txonly-multi-flow``
367 Generate multiple flows in txonly mode.
369 * ``--disable-link-check``
371 Disable check on link status when starting/stopping ports.
373 * ``--disable-device-start``
375 Do not automatically start all ports. This allows testing
376 configuration of rx and tx queues before device is started
379 * ``--no-lsc-interrupt``
381 Disable LSC interrupts for all ports, even those supporting it.
383 * ``--no-rmv-interrupt``
385 Disable RMV interrupts for all ports, even those supporting it.
387 * ``--bitrate-stats=N``
389 Set the logical core N to perform bitrate calculation.
391 * ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
393 Enable printing the occurrence of the designated event. Using all will
396 * ``--mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
398 Disable printing the occurrence of the designated event. Using all will
401 * ``--flow-isolate-all``
403 Providing this parameter requests flow API isolated mode on all ports at
404 initialization time. It ensures all traffic is received through the
405 configured flow rules only (see flow command).
407 Ports that do not support this mode are automatically discarded.
409 * ``--tx-offloads=0xXXXXXXXX``
411 Set the hexadecimal bitmask of TX queue offloads.
412 The default value is 0.
414 * ``--rx-offloads=0xXXXXXXXX``
416 Set the hexadecimal bitmask of RX queue offloads.
417 The default value is 0.
421 Enable device event monitor mechanism for hotplug.
423 * ``--vxlan-gpe-port=N``
425 Set the UDP port number of tunnel VXLAN-GPE to N.
426 The default value is 4790.
430 Enable locking all memory.
434 Disable locking all memory.
436 * ``--mp-alloc <native|anon|xmem|xmemhuge>``
438 Select mempool allocation mode:
440 * native: create and populate mempool using native DPDK memory
441 * anon: create mempool using native DPDK memory, but populate using
443 * xmem: create and populate mempool using externally and anonymously
445 * xmemhuge: create and populate mempool using externally and anonymously
446 allocated hugepage area
448 * ``--noisy-tx-sw-buffer-size``
450 Set the number of maximum elements of the FIFO queue to be created
451 for buffering packets. Only available with the noisy forwarding mode.
452 The default value is 0.
454 * ``--noisy-tx-sw-buffer-flushtime=N``
456 Set the time before packets in the FIFO queue is flushed.
457 Only available with the noisy forwarding mode. The default value is 0.
459 * ``--noisy-lkup-memory=N``
461 Set the size of the noisy neighbor simulation memory buffer in MB to N.
462 Only available with the noisy forwarding mode. The default value is 0.
465 * ``--noisy-lkup-num-reads=N``
467 Set the number of reads to be done in noisy neighbor simulation memory buffer to N.
468 Only available with the noisy forwarding mode. The default value is 0.
470 * ``--noisy-lkup-num-writes=N``
472 Set the number of writes to be done in noisy neighbor simulation memory buffer to N.
473 Only available with the noisy forwarding mode. The default value is 0.
475 * ``--noisy-lkup-num-reads-writes=N``
477 Set the number of r/w accesses to be done in noisy neighbor simulation memory buffer to N.
478 Only available with the noisy forwarding mode. The default value is 0.
480 * ``--no-iova-contig``
482 Enable to create mempool which is not IOVA contiguous. Valid only with --mp-alloc=anon.
483 The default value is 0.