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 Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers
83 (mbufs). [Default setting]
87 Disable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
89 * ``--port-numa-config=(port,socket)[,(port,socket)]``
91 Specify the socket on which the memory pool to be used by the port will be allocated.
93 * ``--ring-numa-config=(port,flag,socket)[,(port,flag,socket)]``
95 Specify the socket on which the TX/RX rings for the port will be allocated.
96 Where flag is 1 for RX, 2 for TX, and 3 for RX and TX.
100 Set the socket from which all memory is allocated in NUMA mode,
101 where 0 <= N < number of sockets on the board.
105 Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
107 * ``--total-num-mbufs=N``
109 Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
111 * ``--max-pkt-len=N``
113 Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
115 * ``--eth-peers-configfile=name``
117 Use a configuration file containing the Ethernet addresses of the peer ports.
118 The configuration file should contain the Ethernet addresses on separate lines::
124 * ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
126 Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
127 where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
129 * ``--tx-ip=SRC,DST``
131 Set the source and destination IP address used when doing transmit only test.
132 The defaults address values are source 198.18.0.1 and
133 destination 198.18.0.2. These are special purpose addresses
134 reserved for benchmarking (RFC 5735).
136 * ``--tx-udp=SRC[,DST]``
138 Set the source and destination UDP port number for transmit test only test.
139 The default port is the port 9 which is defined for the discard protocol
142 * ``--pkt-filter-mode=mode``
144 Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
145 See :ref:`testpmd_flow_director` for more details.
147 * ``--pkt-filter-report-hash=mode``
149 Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
151 * ``--pkt-filter-size=N``
153 Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
154 Sizes are in kilobytes. The default is 64.
156 * ``--pkt-filter-flexbytes-offset=N``
158 Set the flexbytes offset.
159 The offset is defined in words (not bytes) counted from the first byte of the destination Ethernet MAC address,
160 where N is 0 <= N <= 32.
161 The default value is 0x6.
163 * ``--pkt-filter-drop-queue=N``
166 In perfect filter mode, when a rule is added with queue = -1, the packet will be enqueued into the RX drop-queue.
167 If the drop-queue does not exist, the packet is dropped. The default value is N=127.
169 * ``--disable-crc-strip``
171 Disable hardware CRC stripping.
175 Enable large receive offload.
177 * ``--enable-rx-cksum``
179 Enable hardware RX checksum offload.
181 * ``--enable-scatter``
183 Enable scatter (multi-segment) RX.
185 * ``--enable-hw-vlan``
187 Enable hardware VLAN.
189 * ``--enable-hw-vlan-filter``
191 Enable hardware VLAN filter.
193 * ``--enable-hw-vlan-strip``
195 Enable hardware VLAN strip.
197 * ``--enable-hw-vlan-extend``
199 Enable hardware VLAN extend.
201 * ``--enable-hw-qinq-strip``
203 Enable hardware QINQ strip.
205 * ``--enable-drop-en``
207 Enable per-queue packet drop for packets with no descriptors.
211 Disable RSS (Receive Side Scaling).
213 * ``--port-topology=mode``
215 Set port topology, where mode is ``paired`` (the default), ``chained`` or ``loop``.
217 In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
219 In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
221 The ordering of the ports can be changed using the portlist testpmd runtime function.
223 In ``loop`` mode, ingress traffic is simply transmitted back on the same interface.
225 * ``--forward-mode=mode``
227 Set the forwarding mode where ``mode`` is one of the following::
243 Set RSS functions for IPv4/IPv6 only.
247 Set RSS functions for IPv4/IPv6 and UDP.
251 Set the number of RX queues per port to N, where 1 <= N <= 65535.
252 The default value is 1.
256 Set the number of descriptors in the RX rings to N, where N > 0.
257 The default value is 128.
261 Set the number of TX queues per port to N, where 1 <= N <= 65535.
262 The default value is 1.
266 Set the number of descriptors in the TX rings to N, where N > 0.
267 The default value is 512.
271 Set the number of packets per burst to N, where 1 <= N <= 512.
272 The default value is 32.
273 If set to 0, driver default is used if defined. Else, if driver
274 default is not defined, default of 32 is used.
278 Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
279 The default value is 16.
283 Set the prefetch threshold register of RX rings to N, where N >= 0.
284 The default value is 8.
288 Set the host threshold register of RX rings to N, where N >= 0.
289 The default value is 8.
293 Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
294 The default value is 0.
298 Set the write-back threshold register of RX rings to N, where N >= 0.
299 The default value is 4.
303 Set the prefetch threshold register of TX rings to N, where N >= 0.
304 The default value is 36.
308 Set the host threshold register of TX rings to N, where N >= 0.
309 The default value is 0.
313 Set the write-back threshold register of TX rings to N, where N >= 0.
314 The default value is 0.
318 Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
319 The default value is 0.
323 Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
324 The default value is 0.
326 * ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
328 Set the RX queues statistics counters mapping 0 <= mapping <= 15.
330 * ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
332 Set the TX queues statistics counters mapping 0 <= mapping <= 15.
336 Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
340 Set TX segment sizes or total packet length. Valid for ``tx-only``
341 and ``flowgen`` forwarding modes.
343 * ``--txonly-multi-flow``
345 Generate multiple flows in txonly mode.
347 * ``--disable-link-check``
349 Disable check on link status when starting/stopping ports.
351 * ``--disable-device-start``
353 Do not automatically start all ports. This allows testing
354 configuration of rx and tx queues before device is started
357 * ``--no-lsc-interrupt``
359 Disable LSC interrupts for all ports, even those supporting it.
361 * ``--no-rmv-interrupt``
363 Disable RMV interrupts for all ports, even those supporting it.
365 * ``--bitrate-stats=N``
367 Set the logical core N to perform bitrate calculation.
369 * ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
371 Enable printing the occurrence of the designated event. Using all will
374 * ``--mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
376 Disable printing the occurrence of the designated event. Using all will
379 * ``--flow-isolate-all``
381 Providing this parameter requests flow API isolated mode on all ports at
382 initialization time. It ensures all traffic is received through the
383 configured flow rules only (see flow command).
385 Ports that do not support this mode are automatically discarded.
387 * ``--tx-offloads=0xXXXXXXXX``
389 Set the hexadecimal bitmask of TX queue offloads.
390 The default value is 0.
392 * ``--rx-offloads=0xXXXXXXXX``
394 Set the hexadecimal bitmask of RX queue offloads.
395 The default value is 0.
399 Enable device event monitor mechanism for hotplug.
401 * ``--vxlan-gpe-port=N``
403 Set the UDP port number of tunnel VXLAN-GPE to N.
404 The default value is 4790.
408 Enable locking all memory.
412 Disable locking all memory.
414 * ``--mp-alloc <native|anon|xmem|xmemhuge>``
416 Select mempool allocation mode:
418 * native: create and populate mempool using native DPDK memory
419 * anon: create mempool using native DPDK memory, but populate using
421 * xmem: create and populate mempool using externally and anonymously
423 * xmemhuge: create and populate mempool using externally and anonymously
424 allocated hugepage area
426 * ``--noisy-tx-sw-buffer-size``
428 Set the number of maximum elements of the FIFO queue to be created
429 for buffering packets. Only available with the noisy forwarding mode.
430 The default value is 0.
432 * ``--noisy-tx-sw-buffer-flushtime=N``
434 Set the time before packets in the FIFO queue is flushed.
435 Only available with the noisy forwarding mode. The default value is 0.
437 * ``--noisy-lkup-memory=N``
439 Set the size of the noisy neighbor simulation memory buffer in MB to N.
440 Only available with the noisy forwarding mode. The default value is 0.
443 * ``--noisy-lkup-num-reads=N``
445 Set the number of reads to be done in noisy neighbor simulation memory buffer to N.
446 Only available with the noisy forwarding mode. The default value is 0.
448 * ``--noisy-lkup-num-writes=N``
450 Set the number of writes to be done in noisy neighbor simulation memory buffer to N.
451 Only available with the noisy forwarding mode. The default value is 0.
453 * ``--noisy-lkup-num-reads-writes=N``
455 Set the number of r/w accesses to be done in noisy neighbor simulation memory buffer to N.
456 Only available with the noisy forwarding mode. The default value is 0.
458 * ``--no-iova-contig``
460 Enable to create mempool which is not IOVA contiguous. Valid only with --mp-alloc=anon.
461 The default value is 0.