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 *   ``--portlist=X``
  81
  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
  86
  87 *   ``--numa``
  88
  89     Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers
  90     (mbufs). [Default setting]
  91
  92 *   ``--no-numa``
  93
  94     Disable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
  95
  96 *   ``--port-numa-config=(port,socket)[,(port,socket)]``
  97
  98     Specify the socket on which the memory pool to be used by the port will be allocated.
  99
 100 *   ``--ring-numa-config=(port,flag,socket)[,(port,flag,socket)]``
 101
 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.
 104
 105 *   ``--socket-num=N``
 106
 107     Set the socket from which all memory is allocated in NUMA mode,
 108     where 0 <= N < number of sockets on the board.
 109
 110 *   ``--mbuf-size=N``
 111
 112     Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
 113
 114 *   ``--total-num-mbufs=N``
 115
 116     Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
 117
 118 *   ``--max-pkt-len=N``
 119
 120     Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
 121
 122 *   ``--max-lro-pkt-size=N``
 123
 124     Set the maximum LRO aggregated packet size to N bytes, where N >= 64.
 125
 126 *   ``--eth-peers-configfile=name``
 127
 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::
 130
 131        XX:XX:XX:XX:XX:01
 132        XX:XX:XX:XX:XX:02
 133        ...
 134
 135 *   ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
 136
 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.
 139
 140 *   ``--tx-ip=SRC,DST``
 141
 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).
 146
 147 *   ``--tx-udp=SRC[,DST]``
 148
 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
 151     (RFC 863).
 152
 153 *   ``--pkt-filter-mode=mode``
 154
 155     Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
 156     See :ref:`testpmd_flow_director` for more details.
 157
 158 *   ``--pkt-filter-report-hash=mode``
 159
 160     Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
 161
 162 *   ``--pkt-filter-size=N``
 163
 164     Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
 165     Sizes are in kilobytes. The default is 64.
 166
 167 *   ``--pkt-filter-flexbytes-offset=N``
 168
 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.
 173
 174 *   ``--pkt-filter-drop-queue=N``
 175
 176     Set the drop-queue.
 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.
 179
 180 *   ``--disable-crc-strip``
 181
 182     Disable hardware CRC stripping.
 183
 184 *   ``--enable-lro``
 185
 186     Enable large receive offload.
 187
 188 *   ``--enable-rx-cksum``
 189
 190     Enable hardware RX checksum offload.
 191
 192 *   ``--enable-scatter``
 193
 194     Enable scatter (multi-segment) RX.
 195
 196 *   ``--enable-hw-vlan``
 197
 198     Enable hardware VLAN.
 199
 200 *   ``--enable-hw-vlan-filter``
 201
 202     Enable hardware VLAN filter.
 203
 204 *   ``--enable-hw-vlan-strip``
 205
 206     Enable hardware VLAN strip.
 207
 208 *   ``--enable-hw-vlan-extend``
 209
 210     Enable hardware VLAN extend.
 211
 212 *   ``--enable-hw-qinq-strip``
 213
 214     Enable hardware QINQ strip.
 215
 216 *   ``--enable-drop-en``
 217
 218     Enable per-queue packet drop for packets with no descriptors.
 219
 220 *   ``--disable-rss``
 221
 222     Disable RSS (Receive Side Scaling).
 223
 224 *   ``--port-topology=mode``
 225
 226     Set port topology, where mode is ``paired`` (the default), ``chained`` or ``loop``.
 227
 228     In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
 229
 230     In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
 231
 232     The ordering of the ports can be changed using the portlist testpmd runtime function.
 233
 234     In ``loop`` mode, ingress traffic is simply transmitted back on the same interface.
 235
 236 *   ``--forward-mode=mode``
 237
 238     Set the forwarding mode where ``mode`` is one of the following::
 239
 240        io (the default)
 241        mac
 242        macswap
 243        flowgen
 244        rxonly
 245        txonly
 246        csum
 247        icmpecho
 248        ieee1588
 249        tm
 250        noisy
 251
 252 *   ``--rss-ip``
 253
 254     Set RSS functions for IPv4/IPv6 only.
 255
 256 *   ``--rss-udp``
 257
 258     Set RSS functions for IPv4/IPv6 and UDP.
 259
 260 *   ``--rxq=N``
 261
 262     Set the number of RX queues per port to N, where 1 <= N <= 65535.
 263     The default value is 1.
 264
 265 *   ``--rxd=N``
 266
 267     Set the number of descriptors in the RX rings to N, where N > 0.
 268     The default value is 128.
 269
 270 *   ``--txq=N``
 271
 272     Set the number of TX queues per port to N, where 1 <= N <= 65535.
 273     The default value is 1.
 274
 275 *   ``--txd=N``
 276
 277     Set the number of descriptors in the TX rings to N, where N > 0.
 278     The default value is 512.
 279
 280 *   ``--hairpinq=N``
 281
 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.
 290
 291 *   ``--burst=N``
 292
 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.
 297
 298 *   ``--mbcache=N``
 299
 300     Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
 301     The default value is 16.
 302
 303 *   ``--rxpt=N``
 304
 305     Set the prefetch threshold register of RX rings to N, where N >= 0.
 306     The default value is 8.
 307
 308 *   ``--rxht=N``
 309
 310     Set the host threshold register of RX rings to N, where N >= 0.
 311     The default value is 8.
 312
 313 *   ``--rxfreet=N``
 314
 315     Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
 316     The default value is 0.
 317
 318 *   ``--rxwt=N``
 319
 320     Set the write-back threshold register of RX rings to N, where N >= 0.
 321     The default value is 4.
 322
 323 *   ``--txpt=N``
 324
 325     Set the prefetch threshold register of TX rings to N, where N >= 0.
 326     The default value is 36.
 327
 328 *   ``--txht=N``
 329
 330     Set the host threshold register of TX rings to N, where N >= 0.
 331     The default value is 0.
 332
 333 *   ``--txwt=N``
 334
 335     Set the write-back threshold register of TX rings to N, where N >= 0.
 336     The default value is 0.
 337
 338 *   ``--txfreet=N``
 339
 340     Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
 341     The default value is 0.
 342
 343 *   ``--txrst=N``
 344
 345     Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
 346     The default value is 0.
 347
 348 *   ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
 349
 350     Set the RX queues statistics counters mapping 0 <= mapping <= 15.
 351
 352 *   ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
 353
 354     Set the TX queues statistics counters mapping 0 <= mapping <= 15.
 355
 356 *   ``--no-flush-rx``
 357
 358     Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
 359
 360 *   ``--txpkts=X[,Y]``
 361
 362     Set TX segment sizes or total packet length. Valid for ``tx-only``
 363     and ``flowgen`` forwarding modes.
 364
 365 *   ``--txonly-multi-flow``
 366
 367     Generate multiple flows in txonly mode.
 368
 369 *   ``--disable-link-check``
 370
 371     Disable check on link status when starting/stopping ports.
 372
 373 *   ``--disable-device-start``
 374
 375     Do not automatically start all ports. This allows testing
 376     configuration of rx and tx queues before device is started
 377     for the first time.
 378
 379 *   ``--no-lsc-interrupt``
 380
 381     Disable LSC interrupts for all ports, even those supporting it.
 382
 383 *   ``--no-rmv-interrupt``
 384
 385     Disable RMV interrupts for all ports, even those supporting it.
 386
 387 *   ``--bitrate-stats=N``
 388
 389     Set the logical core N to perform bitrate calculation.
 390
 391 *   ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|flow_aged|all>``
 392
 393     Enable printing the occurrence of the designated event. Using all will
 394     enable all of them.
 395
 396 *   ``--mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|flow_aged|all>``
 397
 398     Disable printing the occurrence of the designated event. Using all will
 399     disable all of them.
 400
 401 *   ``--flow-isolate-all``
 402
 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).
 406
 407     Ports that do not support this mode are automatically discarded.
 408
 409 *   ``--tx-offloads=0xXXXXXXXX``
 410
 411     Set the hexadecimal bitmask of TX queue offloads.
 412     The default value is 0.
 413
 414 *   ``--rx-offloads=0xXXXXXXXX``
 415
 416     Set the hexadecimal bitmask of RX queue offloads.
 417     The default value is 0.
 418
 419 *   ``--hot-plug``
 420
 421     Enable device event monitor mechanism for hotplug.
 422
 423 *   ``--vxlan-gpe-port=N``
 424
 425     Set the UDP port number of tunnel VXLAN-GPE to N.
 426     The default value is 4790.
 427
 428 *   ``--mlockall``
 429
 430     Enable locking all memory.
 431
 432 *   ``--no-mlockall``
 433
 434     Disable locking all memory.
 435
 436 *   ``--mp-alloc <native|anon|xmem|xmemhuge>``
 437
 438     Select mempool allocation mode:
 439
 440     * native: create and populate mempool using native DPDK memory
 441     * anon: create mempool using native DPDK memory, but populate using
 442       anonymous memory
 443     * xmem: create and populate mempool using externally and anonymously
 444       allocated area
 445     * xmemhuge: create and populate mempool using externally and anonymously
 446       allocated hugepage area
 447
 448 *   ``--noisy-tx-sw-buffer-size``
 449
 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.
 453
 454 *   ``--noisy-tx-sw-buffer-flushtime=N``
 455
 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.
 458
 459 *   ``--noisy-lkup-memory=N``
 460
 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.
 463
 464
 465 *   ``--noisy-lkup-num-reads=N``
 466
 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.
 469
 470 *   ``--noisy-lkup-num-writes=N``
 471
 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.
 474
 475 *   ``--noisy-lkup-num-reads-writes=N``
 476
 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.
 479
 480 *   ``--no-iova-contig``
 481
 482     Enable to create mempool which is not IOVA contiguous. Valid only with --mp-alloc=anon.
 483     The default value is 0.