doc/guides/testpmd_app_ug/run_app.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2010-2014 Intel Corporation.
   3
   4 Running the Application
   5 =======================
   6
   7 EAL Command-line Options
   8 ------------------------
   9
  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.
  13
  14
  15 Testpmd Command-line Options
  16 ----------------------------
  17
  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:
  20
  21 .. code-block:: console
  22
  23     sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
  24
  25 The command line options are:
  26
  27 *   ``-i, --interactive``
  28
  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.
  33
  34     In non-interactive mode,
  35     the application starts with the configuration specified on the command-line and
  36     immediately enters forwarding mode.
  37
  38 *   ``-h, --help``
  39
  40     Display a help message and quit.
  41
  42 *   ``-a, --auto-start``
  43
  44     Start forwarding on initialization.
  45
  46 *   ``--tx-first``
  47
  48     Start forwarding, after sending a burst of packets first.
  49
  50 .. Note::
  51
  52    This flag should be only used in non-interactive mode.
  53
  54 *   ``--stats-period PERIOD``
  55
  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.
  58
  59 *   ``--nb-cores=N``
  60
  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.
  64
  65 *   ``--nb-ports=N``
  66
  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.
  70
  71 *   ``--coremask=0xXX``
  72
  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.
  75
  76 *   ``--portmask=0xXX``
  77
  78     Set the hexadecimal bitmask of the ports used by the packet forwarding test.
  79
  80 *   ``--numa``
  81
  82     Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers
  83     (mbufs). [Default setting]
  84
  85 *   ``--no-numa``
  86
  87     Disable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
  88
  89 *   ``--port-numa-config=(port,socket)[,(port,socket)]``
  90
  91     Specify the socket on which the memory pool to be used by the port will be allocated.
  92
  93 *   ``--ring-numa-config=(port,flag,socket)[,(port,flag,socket)]``
  94
  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.
  97
  98 *   ``--socket-num=N``
  99
 100     Set the socket from which all memory is allocated in NUMA mode,
 101     where 0 <= N < number of sockets on the board.
 102
 103 *   ``--mbuf-size=N``
 104
 105     Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
 106
 107 *   ``--total-num-mbufs=N``
 108
 109     Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
 110
 111 *   ``--max-pkt-len=N``
 112
 113     Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
 114
 115 *   ``--eth-peers-configfile=name``
 116
 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::
 119
 120        XX:XX:XX:XX:XX:01
 121        XX:XX:XX:XX:XX:02
 122        ...
 123
 124 *   ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
 125
 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.
 128
 129 *   ``--tx-ip=SRC,DST``
 130
 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).
 135
 136 *   ``--tx-udp=SRC[,DST]``
 137
 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
 140     (RFC 863).
 141
 142 *   ``--pkt-filter-mode=mode``
 143
 144     Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
 145     See :ref:`testpmd_flow_director` for more details.
 146
 147 *   ``--pkt-filter-report-hash=mode``
 148
 149     Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
 150
 151 *   ``--pkt-filter-size=N``
 152
 153     Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
 154     Sizes are in kilobytes. The default is 64.
 155
 156 *   ``--pkt-filter-flexbytes-offset=N``
 157
 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.
 162
 163 *   ``--pkt-filter-drop-queue=N``
 164
 165     Set the drop-queue.
 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.
 168
 169 *   ``--disable-crc-strip``
 170
 171     Disable hardware CRC stripping.
 172
 173 *   ``--enable-lro``
 174
 175     Enable large receive offload.
 176
 177 *   ``--enable-rx-cksum``
 178
 179     Enable hardware RX checksum offload.
 180
 181 *   ``--enable-scatter``
 182
 183     Enable scatter (multi-segment) RX.
 184
 185 *   ``--enable-hw-vlan``
 186
 187     Enable hardware VLAN.
 188
 189 *   ``--enable-hw-vlan-filter``
 190
 191     Enable hardware VLAN filter.
 192
 193 *   ``--enable-hw-vlan-strip``
 194
 195     Enable hardware VLAN strip.
 196
 197 *   ``--enable-hw-vlan-extend``
 198
 199     Enable hardware VLAN extend.
 200
 201 *   ``--enable-hw-qinq-strip``
 202
 203     Enable hardware QINQ strip.
 204
 205 *   ``--enable-drop-en``
 206
 207     Enable per-queue packet drop for packets with no descriptors.
 208
 209 *   ``--disable-rss``
 210
 211     Disable RSS (Receive Side Scaling).
 212
 213 *   ``--port-topology=mode``
 214
 215     Set port topology, where mode is ``paired`` (the default), ``chained`` or ``loop``.
 216
 217     In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
 218
 219     In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
 220
 221     The ordering of the ports can be changed using the portlist testpmd runtime function.
 222
 223     In ``loop`` mode, ingress traffic is simply transmitted back on the same interface.
 224
 225 *   ``--forward-mode=mode``
 226
 227     Set the forwarding mode where ``mode`` is one of the following::
 228
 229        io (the default)
 230        mac
 231        macswap
 232        flowgen
 233        rxonly
 234        txonly
 235        csum
 236        icmpecho
 237        ieee1588
 238        tm
 239        noisy
 240
 241 *   ``--rss-ip``
 242
 243     Set RSS functions for IPv4/IPv6 only.
 244
 245 *   ``--rss-udp``
 246
 247     Set RSS functions for IPv4/IPv6 and UDP.
 248
 249 *   ``--rxq=N``
 250
 251     Set the number of RX queues per port to N, where 1 <= N <= 65535.
 252     The default value is 1.
 253
 254 *   ``--rxd=N``
 255
 256     Set the number of descriptors in the RX rings to N, where N > 0.
 257     The default value is 128.
 258
 259 *   ``--txq=N``
 260
 261     Set the number of TX queues per port to N, where 1 <= N <= 65535.
 262     The default value is 1.
 263
 264 *   ``--txd=N``
 265
 266     Set the number of descriptors in the TX rings to N, where N > 0.
 267     The default value is 512.
 268
 269 *   ``--hairpinq=N``
 270
 271     Set the number of hairpin queues per port to N, where 1 <= N <= 65535.
 272     The default value is 0. The number of hairpin queues are added to the
 273     number of TX queues and to the number of RX queues. then the first
 274     RX hairpin is binded to the first TX hairpin, the second RX hairpin is
 275     binded to the second TX hairpin and so on. The index of the first
 276     RX hairpin queue is the number of RX queues as configured using --rxq.
 277     The index of the first TX hairpin queue is the number of TX queues
 278     as configured using --txq.
 279
 280 *   ``--burst=N``
 281
 282     Set the number of packets per burst to N, where 1 <= N <= 512.
 283     The default value is 32.
 284     If set to 0, driver default is used if defined. Else, if driver
 285     default is not defined, default of 32 is used.
 286
 287 *   ``--mbcache=N``
 288
 289     Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
 290     The default value is 16.
 291
 292 *   ``--rxpt=N``
 293
 294     Set the prefetch threshold register of RX rings to N, where N >= 0.
 295     The default value is 8.
 296
 297 *   ``--rxht=N``
 298
 299     Set the host threshold register of RX rings to N, where N >= 0.
 300     The default value is 8.
 301
 302 *   ``--rxfreet=N``
 303
 304     Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
 305     The default value is 0.
 306
 307 *   ``--rxwt=N``
 308
 309     Set the write-back threshold register of RX rings to N, where N >= 0.
 310     The default value is 4.
 311
 312 *   ``--txpt=N``
 313
 314     Set the prefetch threshold register of TX rings to N, where N >= 0.
 315     The default value is 36.
 316
 317 *   ``--txht=N``
 318
 319     Set the host threshold register of TX rings to N, where N >= 0.
 320     The default value is 0.
 321
 322 *   ``--txwt=N``
 323
 324     Set the write-back threshold register of TX rings to N, where N >= 0.
 325     The default value is 0.
 326
 327 *   ``--txfreet=N``
 328
 329     Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
 330     The default value is 0.
 331
 332 *   ``--txrst=N``
 333
 334     Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
 335     The default value is 0.
 336
 337 *   ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
 338
 339     Set the RX queues statistics counters mapping 0 <= mapping <= 15.
 340
 341 *   ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
 342
 343     Set the TX queues statistics counters mapping 0 <= mapping <= 15.
 344
 345 *   ``--no-flush-rx``
 346
 347     Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
 348
 349 *   ``--txpkts=X[,Y]``
 350
 351     Set TX segment sizes or total packet length. Valid for ``tx-only``
 352     and ``flowgen`` forwarding modes.
 353
 354 *   ``--txonly-multi-flow``
 355
 356     Generate multiple flows in txonly mode.
 357
 358 *   ``--disable-link-check``
 359
 360     Disable check on link status when starting/stopping ports.
 361
 362 *   ``--disable-device-start``
 363
 364     Do not automatically start all ports. This allows testing
 365     configuration of rx and tx queues before device is started
 366     for the first time.
 367
 368 *   ``--no-lsc-interrupt``
 369
 370     Disable LSC interrupts for all ports, even those supporting it.
 371
 372 *   ``--no-rmv-interrupt``
 373
 374     Disable RMV interrupts for all ports, even those supporting it.
 375
 376 *   ``--bitrate-stats=N``
 377
 378     Set the logical core N to perform bitrate calculation.
 379
 380 *   ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
 381
 382     Enable printing the occurrence of the designated event. Using all will
 383     enable all of them.
 384
 385 *   ``--mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
 386
 387     Disable printing the occurrence of the designated event. Using all will
 388     disable all of them.
 389
 390 *   ``--flow-isolate-all``
 391
 392     Providing this parameter requests flow API isolated mode on all ports at
 393     initialization time. It ensures all traffic is received through the
 394     configured flow rules only (see flow command).
 395
 396     Ports that do not support this mode are automatically discarded.
 397
 398 *   ``--tx-offloads=0xXXXXXXXX``
 399
 400     Set the hexadecimal bitmask of TX queue offloads.
 401     The default value is 0.
 402
 403 *   ``--rx-offloads=0xXXXXXXXX``
 404
 405     Set the hexadecimal bitmask of RX queue offloads.
 406     The default value is 0.
 407
 408 *   ``--hot-plug``
 409
 410     Enable device event monitor mechanism for hotplug.
 411
 412 *   ``--vxlan-gpe-port=N``
 413
 414     Set the UDP port number of tunnel VXLAN-GPE to N.
 415     The default value is 4790.
 416
 417 *   ``--mlockall``
 418
 419     Enable locking all memory.
 420
 421 *   ``--no-mlockall``
 422
 423     Disable locking all memory.
 424
 425 *   ``--mp-alloc <native|anon|xmem|xmemhuge>``
 426
 427     Select mempool allocation mode:
 428
 429     * native: create and populate mempool using native DPDK memory
 430     * anon: create mempool using native DPDK memory, but populate using
 431       anonymous memory
 432     * xmem: create and populate mempool using externally and anonymously
 433       allocated area
 434     * xmemhuge: create and populate mempool using externally and anonymously
 435       allocated hugepage area
 436
 437 *   ``--noisy-tx-sw-buffer-size``
 438
 439     Set the number of maximum elements  of the FIFO queue to be created
 440     for buffering packets. Only available with the noisy forwarding mode.
 441     The default value is 0.
 442
 443 *   ``--noisy-tx-sw-buffer-flushtime=N``
 444
 445     Set the time before packets in the FIFO queue is flushed.
 446     Only available with the noisy forwarding mode. The default value is 0.
 447
 448 *   ``--noisy-lkup-memory=N``
 449
 450     Set the size of the noisy neighbor simulation memory buffer in MB to N.
 451     Only available with the noisy forwarding mode. The default value is 0.
 452
 453
 454 *   ``--noisy-lkup-num-reads=N``
 455
 456     Set the number of reads to be done in noisy neighbor simulation memory buffer to N.
 457     Only available with the noisy forwarding mode. The default value is 0.
 458
 459 *   ``--noisy-lkup-num-writes=N``
 460
 461     Set the number of writes to be done in noisy neighbor simulation memory buffer to N.
 462     Only available with the noisy forwarding mode. The default value is 0.
 463
 464 *   ``--noisy-lkup-num-reads-writes=N``
 465
 466     Set the number of r/w accesses to be done in noisy neighbor simulation memory buffer to N.
 467     Only available with the noisy forwarding mode. The default value is 0.
 468
 469 *   ``--no-iova-contig``
 470
 471     Enable to create mempool which is not IOVA contiguous. Valid only with --mp-alloc=anon.
 472     The default value is 0.