2 Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 Running the Application
32 =======================
34 EAL Command-line Options
35 ------------------------
37 The following are the EAL command-line options that can be used in conjunction with the testpmd,
38 or any other DPDK application.
39 See the DPDK Getting Started Guides for more information on these options.
43 Set the hexadecimal bitmask of the cores to run on.
47 List of cores to run on
49 The argument format is ``<c1>[-c2][,c3[-c4],...]``
50 where ``c1``, ``c2``, etc are core indexes between 0 and 128.
52 * ``--lcores COREMAP``
54 Map lcore set to physical cpu set
56 The argument format is::
58 <lcores[@cpus]>[<,lcores[@cpus]>...]
60 Lcore and CPU lists are grouped by ``(`` and ``)`` Within the group.
61 The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
62 The grouping ``()`` can be omitted for single element group.
63 The ``@`` can be omitted if cpus and lcores have the same value.
65 * ``--master-lcore ID``
67 Core ID that is used as master.
71 Set the number of memory channels to use.
73 * ``-b, --pci-blacklist domain:bus:devid.func``
75 Blacklist a PCI device to prevent EAL from using it. Multiple -b options are allowed.
79 Load an external driver. Multiple -d options are allowed.
81 * ``-w, --pci-whitelist domain:bus:devid:func``
83 Add a PCI device in white list.
87 Memory to allocate. See also ``--socket-mem``.
91 Set the number of memory ranks (auto-detected by default).
95 Display the version information on startup.
99 Support application running on Xen Domain0 without hugetlbfs.
103 Set the syslog facility.
107 Set the memory to allocate on specific sockets (use comma separated values).
111 Specify the directory where the hugetlbfs is mounted.
115 Set the type of the current process.
119 Prefix for hugepage filenames.
121 * ``-vmware-tsc-map``
123 Use VMware TSC map instead of native RDTSC.
127 Add a virtual device using the format::
129 <driver><id>[,key=val, ...]
133 --vdev 'net_pcap0,rx_pcap=input.pcap,tx_pcap=output.pcap'
135 * ``--base-virtaddr``
137 Specify base virtual address.
139 * ``--create-uio-dev``
141 Create ``/dev/uioX`` (usually done by hotplug).
145 No shared config (mmap-ed files).
157 Use malloc instead of hugetlbfs.
160 Testpmd Command-line Options
161 ----------------------------
163 The following are the command-line options for the testpmd applications.
164 They must be separated from the EAL options, shown in the previous section, with a ``--`` separator:
166 .. code-block:: console
168 sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
170 The commandline options are:
172 * ``-i, --interactive``
174 Run testpmd in interactive mode.
175 In this mode, the testpmd starts with a prompt that can be used to start and stop forwarding,
176 configure the application and display stats on the current packet processing session.
177 See :ref:`testpmd_runtime` for more details.
179 In non-interactive mode,
180 the application starts with the configuration specified on the command-line and
181 immediately enters forwarding mode.
185 Display a help message and quit.
187 * ``-a, --auto-start``
189 Start forwarding on initialization.
193 Set the number of forwarding cores,
194 where 1 <= N <= "number of cores" or ``CONFIG_RTE_MAX_LCORE`` from the configuration file.
195 The default value is 1.
199 Set the number of forwarding ports,
200 where 1 <= N <= "number of ports" on the board or ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
201 The default value is the number of ports on the board.
203 * ``--coremask=0xXX``
205 Set the hexadecimal bitmask of the cores running the packet forwarding test.
206 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
208 * ``--portmask=0xXX``
210 Set the hexadecimal bitmask of the ports used by the packet forwarding test.
214 Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers
215 (mbufs). [Default setting]
219 Disable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
221 * ``--port-numa-config=(port,socket)[,(port,socket)]``
223 Specify the socket on which the memory pool to be used by the port will be allocated.
225 * ``--ring-numa-config=(port,flag,socket)[,(port,flag,socket)]``
227 Specify the socket on which the TX/RX rings for the port will be allocated.
228 Where flag is 1 for RX, 2 for TX, and 3 for RX and TX.
232 Set the socket from which all memory is allocated in NUMA mode,
233 where 0 <= N < number of sockets on the board.
237 Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
239 * ``--total-num-mbufs=N``
241 Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
243 * ``--max-pkt-len=N``
245 Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
247 * ``--eth-peers-configfile=name``
249 Use a configuration file containing the Ethernet addresses of the peer ports.
250 The configuration file should contain the Ethernet addresses on separate lines::
257 * ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
259 Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
260 where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
262 * ``--pkt-filter-mode=mode``
264 Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
265 See :ref:`testpmd_flow_director` for more details.
267 * ``--pkt-filter-report-hash=mode``
269 Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
271 * ``--pkt-filter-size=N``
273 Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
274 Sizes are in kilobytes. The default is 64.
276 * ``--pkt-filter-flexbytes-offset=N``
278 Set the flexbytes offset.
279 The offset is defined in words (not bytes) counted from the first byte of the destination Ethernet MAC address,
280 where N is 0 <= N <= 32.
281 The default value is 0x6.
283 * ``--pkt-filter-drop-queue=N``
286 In perfect filter mode, when a rule is added with queue = -1, the packet will be enqueued into the RX drop-queue.
287 If the drop-queue does not exist, the packet is dropped. The default value is N=127.
289 * ``--disable-crc-strip``
291 Disable hardware CRC stripping.
295 Enable large receive offload.
297 * ``--enable-rx-cksum``
299 Enable hardware RX checksum offload.
301 * ``--enable-scatter``
303 Enable scatter (multi-segment) RX.
305 * ``--disable-hw-vlan``
307 Disable hardware VLAN.
309 * ``--disable-hw-vlan-filter``
311 Disable hardware VLAN filter.
313 * ``--disable-hw-vlan-strip``
315 Disable hardware VLAN strip.
317 * ``--disable-hw-vlan-extend``
319 Disable hardware VLAN extend.
321 * ``--enable-drop-en``
323 Enable per-queue packet drop for packets with no descriptors.
327 Disable RSS (Receive Side Scaling).
329 * ``--port-topology=mode``
331 Set port topology, where mode is ``paired`` (the default) or ``chained``.
333 In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
335 In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
337 The ordering of the ports can be changed using the portlist testpmd runtime function.
339 * ``--forward-mode=mode``
341 Set the forwarding mode where ``mode`` is one of the following::
355 Set RSS functions for IPv4/IPv6 only.
359 Set RSS functions for IPv4/IPv6 and UDP.
363 Set the number of RX queues per port to N, where 1 <= N <= 65535.
364 The default value is 1.
368 Set the number of descriptors in the RX rings to N, where N > 0.
369 The default value is 128.
373 Set the number of TX queues per port to N, where 1 <= N <= 65535.
374 The default value is 1.
378 Set the number of descriptors in the TX rings to N, where N > 0.
379 The default value is 512.
383 Set the number of packets per burst to N, where 1 <= N <= 512.
384 The default value is 16.
388 Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
389 The default value is 16.
393 Set the prefetch threshold register of RX rings to N, where N >= 0.
394 The default value is 8.
398 Set the host threshold register of RX rings to N, where N >= 0.
399 The default value is 8.
403 Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
404 The default value is 0.
408 Set the write-back threshold register of RX rings to N, where N >= 0.
409 The default value is 4.
413 Set the prefetch threshold register of TX rings to N, where N >= 0.
414 The default value is 36.
418 Set the host threshold register of TX rings to N, where N >= 0.
419 The default value is 0.
423 Set the write-back threshold register of TX rings to N, where N >= 0.
424 The default value is 0.
428 Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
429 The default value is 0.
433 Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
434 The default value is 0.
436 * ``--txqflags=0xXXXXXXXX``
438 Set the hexadecimal bitmask of TX queue flags, where 0 <= N <= 0x7FFFFFFF.
439 The default value is 0.
443 When using hardware offload functions such as vlan or checksum
444 add ``txqflags=0`` to force the full-featured TX code path.
445 In some PMDs this may already be the default.
448 * ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
450 Set the RX queues statistics counters mapping 0 <= mapping <= 15.
452 * ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
454 Set the TX queues statistics counters mapping 0 <= mapping <= 15.
458 Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
462 Set TX segment sizes or total packet length. Valid for ``tx-only``
463 and ``flowgen`` forwarding modes.
465 * ``--disable-link-check``
467 Disable check on link status when starting/stopping ports.
469 * ``--no-lsc-interrupt``
471 Disable LSC interrupts for all ports, even those supporting it.
473 * ``--no-rmv-interrupt``
475 Disable RMV interrupts for all ports, even those supporting it.
477 * ``--bitrate-stats=N``
479 Set the logical core N to perform bitrate calculation.
481 * ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|all>``
483 Enable printing the occurrence of the designated event. Using all will
486 * ``--mask-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|all>``
488 Disable printing the occurrence of the designated event. Using all will