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:`../linux_gsg/linux_eal_parameters` or
  11 :doc:`../freebsd_gsg/freebsd_eal_parameters` for a list of available EAL
  12 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 commandline 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
 125 *   ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
 126
 127     Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
 128     where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
 129
 130 *   ``--pkt-filter-mode=mode``
 131
 132     Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
 133     See :ref:`testpmd_flow_director` for more details.
 134
 135 *   ``--pkt-filter-report-hash=mode``
 136
 137     Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
 138
 139 *   ``--pkt-filter-size=N``
 140
 141     Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
 142     Sizes are in kilobytes. The default is 64.
 143
 144 *   ``--pkt-filter-flexbytes-offset=N``
 145
 146     Set the flexbytes offset.
 147     The offset is defined in words (not bytes) counted from the first byte of the destination Ethernet MAC address,
 148     where N is 0 <= N <= 32.
 149     The default value is 0x6.
 150
 151 *   ``--pkt-filter-drop-queue=N``
 152
 153     Set the drop-queue.
 154     In perfect filter mode, when a rule is added with queue = -1, the packet will be enqueued into the RX drop-queue.
 155     If the drop-queue does not exist, the packet is dropped. The default value is N=127.
 156
 157 *   ``--disable-crc-strip``
 158
 159     Disable hardware CRC stripping.
 160
 161 *   ``--enable-lro``
 162
 163     Enable large receive offload.
 164
 165 *   ``--enable-rx-cksum``
 166
 167     Enable hardware RX checksum offload.
 168
 169 *   ``--enable-scatter``
 170
 171     Enable scatter (multi-segment) RX.
 172
 173 *   ``--enable-hw-vlan``
 174
 175     Enable hardware VLAN.
 176
 177 *   ``--enable-hw-vlan-filter``
 178
 179     Enable hardware VLAN filter.
 180
 181 *   ``--enable-hw-vlan-strip``
 182
 183     Enable hardware VLAN strip.
 184
 185 *   ``--enable-hw-vlan-extend``
 186
 187     Enable hardware VLAN extend.
 188
 189 *   ``--enable-drop-en``
 190
 191     Enable per-queue packet drop for packets with no descriptors.
 192
 193 *   ``--disable-rss``
 194
 195     Disable RSS (Receive Side Scaling).
 196
 197 *   ``--port-topology=mode``
 198
 199     Set port topology, where mode is ``paired`` (the default) or ``chained``.
 200
 201     In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
 202
 203     In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
 204
 205     The ordering of the ports can be changed using the portlist testpmd runtime function.
 206
 207 *   ``--forward-mode=mode``
 208
 209     Set the forwarding mode where ``mode`` is one of the following::
 210
 211        io (the default)
 212        mac
 213        macswap
 214        flowgen
 215        rxonly
 216        txonly
 217        csum
 218        icmpecho
 219        ieee1588
 220        tm
 221        noisy
 222
 223 *   ``--rss-ip``
 224
 225     Set RSS functions for IPv4/IPv6 only.
 226
 227 *   ``--rss-udp``
 228
 229     Set RSS functions for IPv4/IPv6 and UDP.
 230
 231 *   ``--rxq=N``
 232
 233     Set the number of RX queues per port to N, where 1 <= N <= 65535.
 234     The default value is 1.
 235
 236 *   ``--rxd=N``
 237
 238     Set the number of descriptors in the RX rings to N, where N > 0.
 239     The default value is 128.
 240
 241 *   ``--txq=N``
 242
 243     Set the number of TX queues per port to N, where 1 <= N <= 65535.
 244     The default value is 1.
 245
 246 *   ``--txd=N``
 247
 248     Set the number of descriptors in the TX rings to N, where N > 0.
 249     The default value is 512.
 250
 251 *   ``--burst=N``
 252
 253     Set the number of packets per burst to N, where 1 <= N <= 512.
 254     The default value is 32.
 255     If set to 0, driver default is used if defined. Else, if driver
 256     default is not defined, default of 32 is used.
 257
 258 *   ``--mbcache=N``
 259
 260     Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
 261     The default value is 16.
 262
 263 *   ``--rxpt=N``
 264
 265     Set the prefetch threshold register of RX rings to N, where N >= 0.
 266     The default value is 8.
 267
 268 *   ``--rxht=N``
 269
 270     Set the host threshold register of RX rings to N, where N >= 0.
 271     The default value is 8.
 272
 273 *   ``--rxfreet=N``
 274
 275     Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
 276     The default value is 0.
 277
 278 *   ``--rxwt=N``
 279
 280     Set the write-back threshold register of RX rings to N, where N >= 0.
 281     The default value is 4.
 282
 283 *   ``--txpt=N``
 284
 285     Set the prefetch threshold register of TX rings to N, where N >= 0.
 286     The default value is 36.
 287
 288 *   ``--txht=N``
 289
 290     Set the host threshold register of TX rings to N, where N >= 0.
 291     The default value is 0.
 292
 293 *   ``--txwt=N``
 294
 295     Set the write-back threshold register of TX rings to N, where N >= 0.
 296     The default value is 0.
 297
 298 *   ``--txfreet=N``
 299
 300     Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
 301     The default value is 0.
 302
 303 *   ``--txrst=N``
 304
 305     Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
 306     The default value is 0.
 307
 308 *   ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
 309
 310     Set the RX queues statistics counters mapping 0 <= mapping <= 15.
 311
 312 *   ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
 313
 314     Set the TX queues statistics counters mapping 0 <= mapping <= 15.
 315
 316 *   ``--no-flush-rx``
 317
 318     Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
 319
 320 *   ``--txpkts=X[,Y]``
 321
 322     Set TX segment sizes or total packet length. Valid for ``tx-only``
 323     and ``flowgen`` forwarding modes.
 324
 325 *   ``--disable-link-check``
 326
 327     Disable check on link status when starting/stopping ports.
 328
 329 *   ``--no-lsc-interrupt``
 330
 331     Disable LSC interrupts for all ports, even those supporting it.
 332
 333 *   ``--no-rmv-interrupt``
 334
 335     Disable RMV interrupts for all ports, even those supporting it.
 336
 337 *   ``--bitrate-stats=N``
 338
 339     Set the logical core N to perform bitrate calculation.
 340
 341 *   ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
 342
 343     Enable printing the occurrence of the designated event. Using all will
 344     enable all of them.
 345
 346 *   ``--mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|all>``
 347
 348     Disable printing the occurrence of the designated event. Using all will
 349     disable all of them.
 350
 351 *   ``--flow-isolate-all``
 352
 353     Providing this parameter requests flow API isolated mode on all ports at
 354     initialization time. It ensures all traffic is received through the
 355     configured flow rules only (see flow command).
 356
 357     Ports that do not support this mode are automatically discarded.
 358
 359 *   ``--tx-offloads=0xXXXXXXXX``
 360
 361     Set the hexadecimal bitmask of TX queue offloads.
 362     The default value is 0.
 363
 364 *   ``--hot-plug``
 365
 366     Enable device event monitor machenism for hotplug.
 367
 368 *   ``--vxlan-gpe-port=N``
 369
 370     Set the UDP port number of tunnel VXLAN-GPE to N.
 371     The default value is 4790.
 372
 373 *   ``--mlockall``
 374
 375     Enable locking all memory.
 376
 377 *   ``--no-mlockall``
 378
 379     Disable locking all memory.
 380
 381 *   ``--mp-alloc <native|anon|xmem|xmemhuge>``
 382
 383     Select mempool allocation mode:
 384
 385     * native: create and populate mempool using native DPDK memory
 386     * anon: create mempool using native DPDK memory, but populate using
 387       anonymous memory
 388     * xmem: create and populate mempool using externally and anonymously
 389       allocated area
 390     * xmemhuge: create and populate mempool using externally and anonymously
 391       allocated hugepage area
 392
 393 *   ``--noisy-tx-sw-buffer-size``
 394
 395     Set the number of maximum elements  of the FIFO queue to be created
 396     for buffering packets. Only available with the noisy forwarding mode.
 397     The default value is 0.
 398
 399 *   ``--noisy-tx-sw-buffer-flushtime=N``
 400
 401     Set the time before packets in the FIFO queue is flushed.
 402     Only available with the noisy forwarding mode. The default value is 0.
 403
 404 *   ``--noisy-lkup-memory=N``
 405
 406     Set the size of the noisy neighbour simulation memory buffer in MB to N.
 407     Only available with the noisy forwarding mode. The default value is 0.
 408
 409
 410 *   ``--noisy-lkup-num-reads=N``
 411
 412     Set the number of reads to be done in noisy neighbour simulation memory buffer to N.
 413     Only available with the noisy forwarding mode. The default value is 0.
 414
 415 *   ``--noisy-lkup-num-writes=N``
 416
 417     Set the number of writes to be done in noisy neighbour simulation memory buffer to N.
 418     Only available with the noisy forwarding mode. The default value is 0.
 419
 420 *   ``--noisy-lkup-num-reads-writes=N``
 421
 422     Set the number of r/w accesses to be done in noisy neighbour simulation memory buffer to N.
 423     Only available with the noisy forwarding mode. The default value is 0.