* [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
@ 2015-09-28 19:45 John McNamara
2015-10-01 16:26 ` De Lara Guarch, Pablo
0 siblings, 1 reply; 4+ messages in thread
From: John McNamara @ 2015-09-28 19:45 UTC (permalink / raw)
To: dev
Fix a number of RST issues in the testpmd user guide and
refactored the structure to:
* Remove redundant roadmap section.
* Merge Overview section into Introduction.
* Move "set fwd" to the start of its section.
Signed-off-by: John McNamara <john.mcnamara@intel.com>
---
doc/guides/testpmd_app_ug/build_app.rst | 4 +-
doc/guides/testpmd_app_ug/index.rst | 1 -
doc/guides/testpmd_app_ug/intro.rst | 39 +-
doc/guides/testpmd_app_ug/overview.rst | 35 -
doc/guides/testpmd_app_ug/run_app.rst | 262 ++---
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 1440 ++++++++++++++-------------
6 files changed, 878 insertions(+), 903 deletions(-)
delete mode 100644 doc/guides/testpmd_app_ug/overview.rst
diff --git a/doc/guides/testpmd_app_ug/build_app.rst b/doc/guides/testpmd_app_ug/build_app.rst
index 8b0a857..7f32a7c 100644
--- a/doc/guides/testpmd_app_ug/build_app.rst
+++ b/doc/guides/testpmd_app_ug/build_app.rst
@@ -31,8 +31,8 @@
Compiling the Application
=========================
-The testpmd application is compiled as part of the main compilation of the DPDK libraries and tools.
-Refer to the DPDK Getting Started Guide for details.
+The ``testpmd`` application is compiled as part of the main compilation of the DPDK libraries and tools.
+Refer to the DPDK Getting Started Guides for details.
The basic compilation steps are:
#. Set the required environmental variables and go to the source directory:
diff --git a/doc/guides/testpmd_app_ug/index.rst b/doc/guides/testpmd_app_ug/index.rst
index 922535c..3b163c1 100644
--- a/doc/guides/testpmd_app_ug/index.rst
+++ b/doc/guides/testpmd_app_ug/index.rst
@@ -40,7 +40,6 @@ Testpmd Application User Guide
:numbered:
intro
- overview
build_app
run_app
testpmd_funcs
diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/testpmd_app_ug/intro.rst
index ccf57ed..8ef32e7 100644
--- a/doc/guides/testpmd_app_ug/intro.rst
+++ b/doc/guides/testpmd_app_ug/intro.rst
@@ -31,42 +31,11 @@
Introduction
============
-This document is a user guide for the testpmd example application that is shipped as part of the Data Plane Development Kit.
+This document is a user guide for the ``testpmd`` example application that is shipped as part of the Data Plane Development Kit.
-The testpmd application can be used to test the DPDK in a packet forwarding mode
+The ``testpmd`` application can be used to test the DPDK in a packet forwarding mode
and also to access NIC hardware features such as Flow Director.
It also serves as a example of how to build a more fully-featured application using the DPDK SDK.
-Documentation Roadmap
----------------------
-
-The following is a list of DPDK documents in the suggested reading order:
-
-* **Release Notes** : Provides release-specific information, including supported features,
- limitations, fixed issues, known issues and so on.
- Also, provides the answers to frequently asked questions in FAQ format.
-
-* **Getting Started Guide** (this document): Describes how to install and configure the DPDK;
- designed to get users up and running quickly with the software.
-
-* **Programmer's Guide** : Describes:
-
- * The software architecture and how to use it (through examples), specifically in a Linux* application (linuxapp) environment
-
- * The content of the DPDK, the build system
- (including the commands that can be used in the root DPDK Makefile to build the development kit and an application)
- and guidelines for porting an application
-
- * Optimizations used in the software and those that should be considered for new development
-
- A glossary of terms is also provided.
-
-* **API Reference** : Provides detailed information about DPDK functions, data structures and other programming constructs.
-
-* **Sample Applications User Guide** : Describes a set of sample applications.
- Each chapter describes a sample application that showcases specific functionality and
- provides instructions on how to compile, run and use the sample application.
-
-.. note::
-
- These documents are available for download as a separate documentation package at the same location as the DPDK code package.
+The guide shows how to build and run the testpmd application and
+how to configure the application from the command line and the run-time environment.
diff --git a/doc/guides/testpmd_app_ug/overview.rst b/doc/guides/testpmd_app_ug/overview.rst
deleted file mode 100644
index 7937aca..0000000
--- a/doc/guides/testpmd_app_ug/overview.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. BSD LICENSE
- Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- All rights reserved.
-
- Redistribution and use in source and binary forms, with or without
- modification, are permitted provided that the following conditions
- are met:
-
- * Redistributions of source code must retain the above copyright
- notice, this list of conditions and the following disclaimer.
- * Redistributions in binary form must reproduce the above copyright
- notice, this list of conditions and the following disclaimer in
- the documentation and/or other materials provided with the
- distribution.
- * Neither the name of Intel Corporation nor the names of its
- contributors may be used to endorse or promote products derived
- from this software without specific prior written permission.
-
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-Overview
-========
-
-The following sections show how to build and run the testpmd application and
-how to configure the application from the command line and the run-time environment.
diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 54ae2b2..f605564 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -36,117 +36,123 @@ EAL Command-line Options
The following are the EAL command-line options that can be used in conjunction with the testpmd,
or any other DPDK application.
-See the DPDK Getting Started Guide for more information on these options.
+See the DPDK Getting Started Guides for more information on these options.
-* -c COREMASK
+* ``-c COREMASK``
Set the hexadecimal bitmask of the cores to run on.
-* -l CORELIST
+* ``-l CORELIST``
List of cores to run on
- The argument format is <c1>[-c2][,c3[-c4],...]
- where c1, c2, etc are core indexes between 0 and 128
+ The argument format is ``<c1>[-c2][,c3[-c4],...]``
+ where ``c1``, ``c2``, etc are core indexes between 0 and 128.
-* --lcores COREMAP
+* ``--lcores COREMAP``
Map lcore set to physical cpu set
- The argument format is
- '<lcores[@cpus]>[<,lcores[@cpus]>...]'
+ The argument format is::
- lcores and cpus list are grouped by '(' and ')'
- Within the group, '-' is used for range separator,
- ',' is used for single number separator.
- '( )' can be omitted for single element group,
- '@' can be omitted if cpus and lcores have the same value
+ <lcores[@cpus]>[<,lcores[@cpus]>...]
-* --master-lcore ID
+ Lcore and CPU lists are grouped by ``(`` and ``)`` Within the group.
+ The ``-`` character is used as a range separator and ``,`` is used as a single number separator.
+ The grouping ``()`` can be omitted for single element group.
+ The ``@`` can be omitted if cpus and lcores have the same value.
- Core ID that is used as master
+* ``--master-lcore ID``
-* -n NUM
+ Core ID that is used as master.
+
+* ``-n NUM``
Set the number of memory channels to use.
-* -b, --pci-blacklist domain:bus:devid.func
+* ``-b, --pci-blacklist domain:bus:devid.func``
Blacklist a PCI devise to prevent EAL from using it. Multiple -b options are allowed.
-* -d LIB.so
+* ``-d LIB.so``
Load an external driver. Multiple -d options are allowed.
-* -w, --pci-whitelist domain:bus:devid:func
+* ``-w, --pci-whitelist domain:bus:devid:func``
Add a PCI device in white list.
-* -m MB
+* ``-m MB``
- Memory to allocate. See also --socket-mem.
+ Memory to allocate. See also ``--socket-mem``.
-* -r NUM
+* ``-r NUM``
Set the number of memory ranks (auto-detected by default).
-* -v
+* ``-v``
Display the version information on startup.
-* --xen-dom0
+* ``--xen-dom0``
Support application running on Xen Domain0 without hugetlbfs.
-* --syslog
+* ``--syslog``
Set the syslog facility.
-* --socket-mem
+* ``--socket-mem``
Set the memory to allocate on specific sockets (use comma separated values).
-* --huge-dir
+* ``--huge-dir``
Specify the directory where the hugetlbfs is mounted.
-* --proc-type
+* ``--proc-type``
Set the type of the current process.
-* --file-prefix
+* ``--file-prefix``
Prefix for hugepage filenames.
-* -vmware-tsc-map
+* ``-vmware-tsc-map``
Use VMware TSC map instead of native RDTSC.
-* --vdev
+* ``--vdev``
+
+ Add a virtual device using the format::
+
+ <driver><id>[,key=val, ...]
- Add a virtual device, with format "<driver><id>[,key=val, ...]", e.g. --vdev=eth_pcap0,iface=eth2.
+ For example::
-* --base-virtaddr
+ --vdev 'eth_pcap0,rx_pcap=input.pcap,tx_pcap=output.pcap'
+
+* ``--base-virtaddr``
Specify base virtual address.
-* --create-uio-dev
+* ``--create-uio-dev``
- Create /dev/uioX (usually done by hotplug).
+ Create ``/dev/uioX`` (usually done by hotplug).
-* --no-shconf
+* ``--no-shconf``
- No shared config (mmap'd files).
+ No shared config (mmap-ed files).
-* --no-pci
+* ``--no-pci``
Disable pci.
-* --no-hpet
+* ``--no-hpet``
Disable hpet.
-* --no-huge
+* ``--no-huge``
Use malloc instead of hugetlbfs.
@@ -155,278 +161,294 @@ Testpmd Command-line Options
----------------------------
The following are the command-line options for the testpmd applications.
-They must be separated from the EAL options, shown in the previous section, with a -- separator:
+They must be separated from the EAL options, shown in the previous section, with a ``--`` separator:
.. code-block:: console
sudo ./testpmd -c 0xF -n 4 -- -i --portmask=0x1 --nb-cores=2
-* -i, --interactive
+The commandline options are:
+
+* ``-i, --interactive``
Run testpmd in interactive mode.
In this mode, the testpmd starts with a prompt that can be used to start and stop forwarding,
configure the application and display stats on the current packet processing session.
- See the Section 5.0, "Test Runtime Functions" section for more details.
+ See :ref:`testpmd_runtime` for more details.
In non-interactive mode,
the application starts with the configuration specified on the command-line and
immediately enters forwarding mode.
-* -h, --help
+* ``-h, --help``
Display a help message and quit.
-* -a, --auto-start
+* ``-a, --auto-start``
- Start forwarding on init.
+ Start forwarding on initialization.
-* --nb-cores=N
+* ``--nb-cores=N``
Set the number of forwarding cores,
- where 1 <= N <= number of cores or RTE_MAX_LCORE from the configuration file.
+ where 1 <= N <= "number of cores" or ``CONFIG_RTE_MAX_LCORE`` from the configuration file.
The default value is 1.
-* --nb-ports=N
+* ``--nb-ports=N``
Set the number of forwarding ports,
- where 1 <= N <= number of ports on the board or RTE_MAX_ETHPORTS from the configuration file.
+ where 1 <= N <= "number of ports" on the board or ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
The default value is the number of ports on the board.
-* --coremask=0xXX
+* ``--coremask=0xXX``
Set the hexadecimal bitmask of the cores running the packet forwarding test.
The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
-* --portmask=0xXX
+* ``--portmask=0xXX``
Set the hexadecimal bitmask of the ports used by the packet forwarding test.
-* --numa
+* ``--numa``
Enable NUMA-aware allocation of RX/TX rings and of RX memory buffers (mbufs).
-* --port-numa-config=(port,socket)[,(port,socket)]
+* ``--port-numa-config=(port,socket)[,(port,socket)]``
Specify the socket on which the memory pool to be used by the port will be allocated.
-* --ring-numa-config=(port,flag,socket)[,(port,flag,socket)]
+* ``--ring-numa-config=(port,flag,socket)[,(port,flag,socket)]``
Specify the socket on which the TX/RX rings for the port will be allocated.
Where flag is 1 for RX, 2 for TX, and 3 for RX and TX.
-* --socket-num=N
+* ``--socket-num=N``
Set the socket from which all memory is allocated in NUMA mode,
where 0 <= N < number of sockets on the board.
-* --mbuf-size=N
+* ``--mbuf-size=N``
Set the data size of the mbufs used to N bytes, where N < 65536. The default value is 2048.
-* --total-num-mbufs=N
+* ``--total-num-mbufs=N``
Set the number of mbufs to be allocated in the mbuf pools, where N > 1024.
-* --max-pkt-len=N
+* ``--max-pkt-len=N``
Set the maximum packet size to N bytes, where N >= 64. The default value is 1518.
-* --eth-peers-configfile=name
+* ``--eth-peers-configfile=name``
Use a configuration file containing the Ethernet addresses of the peer ports.
- The configuration file should contain the Ethernet addresses on separate lines:
-
- XX:XX:XX:XX:XX:01
+ The configuration file should contain the Ethernet addresses on separate lines::
- XX:XX:XX:XX:XX:02
+ XX:XX:XX:XX:XX:01
+ XX:XX:XX:XX:XX:02
+ ...
- ...
-* --eth-peer=N,XX:XX:XX:XX:XX:XX
+* ``--eth-peer=N,XX:XX:XX:XX:XX:XX``
- Set the MAC address XX:XX:XX:XX:XX:XX of the peer port N,
- where 0 <= N < RTE_MAX_ETHPORTS from the configuration file.
+ Set the MAC address ``XX:XX:XX:XX:XX:XX`` of the peer port N,
+ where 0 <= N < ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
-* --pkt-filter-mode=mode
+* ``--pkt-filter-mode=mode``
- Set Flow Director mode where mode is either none (the default), signature or perfect.
- See the Section 5.6, "Flow Director Functions" for more detail.
+ Set Flow Director mode where mode is either ``none`` (the default), ``signature`` or ``perfect``.
+ See :ref:`testpmd_flow_director` for more details.
-* --pkt-filter-report-hash=mode
+* ``--pkt-filter-report-hash=mode``
- Set Flow Director hash match reporting mode where mode is none, match (the default) or always.
+ Set Flow Director hash match reporting mode where mode is ``none``, ``match`` (the default) or ``always``.
-* --pkt-filter-size=N
+* ``--pkt-filter-size=N``
Set Flow Director allocated memory size, where N is 64K, 128K or 256K.
Sizes are in kilobytes. The default is 64.
-* --pkt-filter-flexbytes-offset=N
+* ``--pkt-filter-flexbytes-offset=N``
Set the flexbytes offset.
The offset is defined in words (not bytes) counted from the first byte of the destination Ethernet MAC address,
where N is 0 <= N <= 32.
The default value is 0x6.
-* --pkt-filter-drop-queue=N
+* ``--pkt-filter-drop-queue=N``
Set the drop-queue.
In perfect filter mode, when a rule is added with queue = -1, the packet will be enqueued into the RX drop-queue.
If the drop-queue does not exist, the packet is dropped. The default value is N=127.
-* --crc-strip
+* ``--crc-strip``
Enable hardware CRC stripping.
-* --enable-rx-cksum
+* ``--enable-rx-cksum``
Enable hardware RX checksum offload.
-* --disable-hw-vlan
+* ``--disable-hw-vlan``
Disable hardware VLAN.
-* --disable-hw-vlan-filter
+* ``--disable-hw-vlan-filter``
Disable hardware VLAN filter.
-* --disable-hw-vlan-strip
+* ``--disable-hw-vlan-strip``
Disable hardware VLAN strip.
-* --disable-hw-vlan-extend
+* ``--disable-hw-vlan-extend``
Disable hardware VLAN extend.
-* --enable-drop-en
+* ``--enable-drop-en``
Enable per-queue packet drop for packets with no descriptors.
-* --disable-rss
+* ``--disable-rss``
Disable RSS (Receive Side Scaling).
-* --port-topology=mode
+* ``--port-topology=mode``
+
+ Set port topology, where mode is ``paired`` (the default) or ``chained``.
+
+ In ``paired`` mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
+
+ In ``chained`` mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
- Set port topology, where mode is paired(the default) or chained.
- In paired mode, the forwarding is between pairs of ports, for example: (0,1), (2,3), (4,5).
- In chained mode, the forwarding is to the next available port in the port mask, for example: (0,1), (1,2), (2,0).
The ordering of the ports can be changed using the portlist testpmd runtime function.
-* --forward-mode=N
+* ``--forward-mode=mode``
- Set forwarding mode. (N: io|mac|mac_retry|mac_swap|flowgen|rxonly|txonly|csum|icmpecho|ieee1588)
+ Set the forwarding mode where ``mode`` is one of the following::
-* --rss-ip
+ io (the default)
+ mac
+ mac_retry
+ mac_swap
+ flowgen
+ rxonly
+ txonly
+ csum
+ icmpecho
+ ieee1588
+
+* ``--rss-ip``
Set RSS functions for IPv4/IPv6 only.
-* --rss-udp
+* ``--rss-udp``
Set RSS functions for IPv4/IPv6 and UDP.
-* --rxq=N
+* ``--rxq=N``
Set the number of RX queues per port to N, where 1 <= N <= 65535.
The default value is 1.
-* --rxd=N
+* ``--rxd=N``
Set the number of descriptors in the RX rings to N, where N > 0.
The default value is 128.
-* --txq=N
+* ``--txq=N``
Set the number of TX queues per port to N, where 1 <= N <= 65535.
The default value is 1.
-* --txd=N
+* ``--txd=N``
Set the number of descriptors in the TX rings to N, where N > 0.
The default value is 512.
-* --burst=N
+* ``--burst=N``
Set the number of packets per burst to N, where 1 <= N <= 512.
The default value is 16.
-* --mbcache=N
+* ``--mbcache=N``
Set the cache of mbuf memory pools to N, where 0 <= N <= 512.
The default value is 16.
-* --rxpt=N
+* ``--rxpt=N``
Set the prefetch threshold register of RX rings to N, where N >= 0.
The default value is 8.
-* --rxht=N
+* ``--rxht=N``
Set the host threshold register of RX rings to N, where N >= 0.
The default value is 8.
-* --rxfreet=N
+* ``--rxfreet=N``
Set the free threshold of RX descriptors to N, where 0 <= N < value of --rxd.
The default value is 0.
-* --rxwt=N
+* ``--rxwt=N``
Set the write-back threshold register of RX rings to N, where N >= 0.
The default value is 4.
-* --txpt=N
+* ``--txpt=N``
Set the prefetch threshold register of TX rings to N, where N >= 0.
The default value is 36.
-* --txht=N
+* ``--txht=N``
Set the host threshold register of TX rings to N, where N >= 0.
The default value is 0.
-* --txwt=N
+* ``--txwt=N``
Set the write-back threshold register of TX rings to N, where N >= 0.
The default value is 0.
-* --txfreet=N
+* ``--txfreet=N``
- Set the transmit free threshold of TX rings to N, where 0 <= N <= value of --txd.
+ Set the transmit free threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
The default value is 0.
-* --txrst=N
+* ``--txrst=N``
- Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of --txd.
+ Set the transmit RS bit threshold of TX rings to N, where 0 <= N <= value of ``--txd``.
The default value is 0.
-* --txqflags=0xXXXXXXXX
+* ``--txqflags=0xXXXXXXXX``
Set the hexadecimal bitmask of TX queue flags, where 0 <= N <= 0x7FFFFFFF.
The default value is 0.
- Note::
+ .. note::
+
+ When using hardware offload functions such as vlan or checksum
+ add ``txqflags=0`` to force the full-featured TX code path.
+ In some PMDs this may already be the default.
- When using hardware offload functions such as vlan, checksum...,
- add txqflags=0, since depending on the PMD,
- txqflags might be set to a non-zero value.
-* --rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]
+* ``--rx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
Set the RX queues statistics counters mapping 0 <= mapping <= 15.
-* --tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]
+* ``--tx-queue-stats-mapping=(port,queue,mapping)[,(port,queue,mapping)]``
Set the TX queues statistics counters mapping 0 <= mapping <= 15.
-* --no-flush-rx
+* ``--no-flush-rx``
- Don't flush the RX streams before starting forwarding. Used mainly with PCAP drivers.
+ Don't flush the RX streams before starting forwarding. Used mainly with the PCAP PMD.
-* --txpkts=X[,Y]
+* ``--txpkts=X[,Y]``
Set TX segment sizes.
-* --disable-link-check
+* ``--disable-link-check``
Disable check on link status when starting/stopping ports.
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index aa77a91..71d831b 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -28,33 +28,43 @@
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.. _testpmd_runtime:
+
Testpmd Runtime Functions
=========================
-Where the testpmd application is started in interactive mode, (-i|--interactive),
+Where the testpmd application is started in interactive mode, (``-i|--interactive``),
it displays a prompt that can be used to start and stop forwarding,
-configure the application, display statistics, set the Flow Director and other tasks.
-
-.. code-block:: console
+configure the application, display statistics, set the Flow Director and other tasks::
- testpmd>
+ testpmd>
The testpmd prompt has some, limited, readline support.
-Common bash command- line functions such as Ctrl+a and Ctrl+e to go to the start and end of the prompt line are supported
+Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported
as well as access to the command history via the up-arrow.
There is also support for tab completion.
-If you type a partial command and hit <TAB> you get a list of the available completions:
+If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
.. code-block:: console
- testpmd> show port <TAB>
+ testpmd> show port <TAB>
- info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap X
- info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap all
- stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap X
- stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap all
- ...
+ info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap X
+ info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap all
+ stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap X
+ stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap all
+ ...
+
+
+.. note::
+
+ Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
+
+ testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
+ (pause_time) (send_xon) (port_id)
+
+In the real ``testpmd>`` prompt these commands should be on a single line.
Help Functions
--------------
@@ -64,16 +74,16 @@ These are divided into sections and can be accessed using help, help section or
.. code-block:: console
- testpmd> help
+ testpmd> help
+
+ help control : Start and stop forwarding.
+ help display : Displaying port, stats and config information.
+ help config : Configuration information.
+ help ports : Configuring ports.
+ help registers : Reading and setting port registers.
+ help filters : Filters configuration help.
+ help all : All of the above sections.
- Help is available for the following sections:
- help control : Start and stop forwarding.
- help display : Displaying port, stats and config information.
- help config : Configuration information.
- help ports : Configuring ports.
- help registers : Reading and setting port registers.
- help filters : Filters configuration help.
- help all : All of the above sections.
Control Functions
-----------------
@@ -81,30 +91,31 @@ Control Functions
start
~~~~~
-Start packet forwarding with current configuration:
+Start packet forwarding with current configuration::
-start
+ testpmd> start
start tx_first
~~~~~~~~~~~~~~
-Start packet forwarding with current configuration after sending one burst of packets:
+Start packet forwarding with current configuration after sending one burst of packets::
-start tx_first
+ testpmd> start tx_first
stop
~~~~
-Stop packet forwarding, and display accumulated statistics:
+Stop packet forwarding, and display accumulated statistics::
-stop
+ testpmd> stop
quit
~~~~
-Quit to prompt:
+Quit to prompt::
+
+ testpmd> quit
-quit
Display Functions
-----------------
@@ -115,143 +126,181 @@ testpmd configuration or the NIC status.
show port
~~~~~~~~~
-Display information for a given port or all ports:
+Display information for a given port or all ports::
-show port (info|stats|fdir|stat_qmap) (port_id|all)
+ testpmd> show port (info|stats|fdir|stat_qmap) (port_id|all)
The available information categories are:
-info : General port information such as MAC address.
+* ``info``: General port information such as MAC address.
-stats : RX/TX statistics.
+* ``stats``: RX/TX statistics.
-fdir : Flow Director information and statistics.
+* ``fdir``: Flow Director information and statistics.
-stat_qmap : Queue statistics mapping.
+* ``stat_qmap``: Queue statistics mapping.
For example:
.. code-block:: console
- testpmd> show port info 0
-
- ********************* Infos for port 0 *********************
-
- MAC address: XX:XX:XX:XX:XX:XX
- Connect to socket: 0
- memory allocation on the socket: 0
- Link status: up
- Link speed: 40000 Mbps
- Link duplex: full-duplex
- Promiscuous mode: enabled
- Allmulticast mode: disabled
- Maximum number of MAC addresses: 64
- Maximum number of MAC addresses of hash filtering: 0
- VLAN offload:
- strip on
- filter on
- qinq(extend) off
- Redirection table size: 512
- Supported flow types:
- ipv4-frag
- ipv4-tcp
- ipv4-udp
- ipv4-sctp
- ipv4-other
- ipv6-frag
- ipv6-tcp
- ipv6-udp
- ipv6-sctp
- ipv6-other
- l2_payload
+ testpmd> show port info 0
+
+ ********************* Infos for port 0 *********************
+
+ MAC address: XX:XX:XX:XX:XX:XX
+ Connect to socket: 0
+ memory allocation on the socket: 0
+ Link status: up
+ Link speed: 40000 Mbps
+ Link duplex: full-duplex
+ Promiscuous mode: enabled
+ Allmulticast mode: disabled
+ Maximum number of MAC addresses: 64
+ Maximum number of MAC addresses of hash filtering: 0
+ VLAN offload:
+ strip on
+ filter on
+ qinq(extend) off
+ Redirection table size: 512
+ Supported flow types:
+ ipv4-frag
+ ipv4-tcp
+ ipv4-udp
+ ipv4-sctp
+ ipv4-other
+ ipv6-frag
+ ipv6-tcp
+ ipv6-udp
+ ipv6-sctp
+ ipv6-other
+ l2_payload
show port rss reta
~~~~~~~~~~~~~~~~~~
-Display the rss redirection table entry indicated by masks on port X:
+Display the rss redirection table entry indicated by masks on port X::
-show port (port_id) rss reta (size) (mask0, mask1...)
+ testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
size is used to indicate the hardware supported reta size
show port rss-hash
~~~~~~~~~~~~~~~~~~
-Display the RSS hash functions and RSS hash key of a port:
+Display the RSS hash functions and RSS hash key of a port::
-show port (port_id) rss-hash [key]
+ testpmd> show port (port_id) rss-hash [key]
clear port
~~~~~~~~~~
-Clear the port statistics for a given port or for all ports:
-
-clear port (info|stats|fdir|stat_qmap) (port_id|all)
+Clear the port statistics for a given port or for all ports::
-For example:
+ testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
-.. code-block:: console
+For example::
- testpmd> clear port stats all
+ testpmd> clear port stats all
show config
~~~~~~~~~~~
Displays the configuration of the application.
-The configuration comes from the command-line, the runtime or the application defaults:
+The configuration comes from the command-line, the runtime or the application defaults::
-show config (rxtx|cores|fwd)
+ testpmd> show config (rxtx|cores|fwd)
The available information categories are:
-rxtx : RX/TX configuration items.
+* ``rxtx``: RX/TX configuration items.
-cores : List of forwarding cores.
+* ``cores``: List of forwarding cores.
-fwd : Packet forwarding configuration.
+* ``fwd``: Packet forwarding configuration.
For example:
.. code-block:: console
- testpmd> show config rxtx
+ testpmd> show config rxtx
+
+ io packet forwarding - CRC stripping disabled - packets/burst=16
+ nb forwarding cores=2 - nb forwarding ports=1
+ RX queues=1 - RX desc=128 - RX free threshold=0
+ RX threshold registers: pthresh=8 hthresh=8 wthresh=4
+ TX queues=1 - TX desc=512 - TX free threshold=0
+ TX threshold registers: pthresh=36 hthresh=0 wthresh=0
+ TX RS bit threshold=0 - TXQ flags=0x0
+
+set fwd
+~~~~~~~
+
+Set the packet forwarding mode::
+
+ testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \
+ rxonly|txonly|csum|icmpecho)
+
+The available information categories are:
+
+* ``io``: Forwards packets "as-is" in I/O mode.
+ This is the fastest possible forwarding operation as it does not access packets data.
+ This is the default mode.
+
+* ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
+
+* ``mac_retry``: Same as "mac" forwarding mode, but includes retries if the destination queue is full.
+
+* ``macswap``: MAC swap forwarding mode.
+ Swaps the source and the destination Ethernet addresses of packets before forwarding them.
+
+* ``flowgen``: Multi-flow generation mode.
+ Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
+
+* ``rxonly``: Receives packets but doesn't transmit them.
+
+* ``txonly``: Generates and transmits packets without receiving any.
+
+* ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
+
+* ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
+
+* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
+
+Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
+
+Example::
+
+ testpmd> set fwd rxonly
+
+ Set rxonly packet forwarding mode
- io packet forwarding - CRC stripping disabled - packets/burst=16
- nb forwarding cores=2 - nb forwarding ports=1
- RX queues=1 - RX desc=128 - RX free threshold=0
- RX threshold registers: pthresh=8 hthresh=8 wthresh=4
- TX queues=1 - TX desc=512 - TX free threshold=0
- TX threshold registers: pthresh=36 hthresh=0 wthresh=0
- TX RS bit threshold=0 - TXQ flags=0x0
read rxd
~~~~~~~~
-Display an RX descriptor for a port RX queue:
-
-read rxd (port_id) (queue_id) (rxd_id)
+Display an RX descriptor for a port RX queue::
-For example:
+ testpmd> read rxd (port_id) (queue_id) (rxd_id)
-.. code-block:: console
+For example::
- testpmd> read rxd 0 0 4
+ testpmd> read rxd 0 0 4
0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
read txd
~~~~~~~~
-Display a TX descriptor for a port TX queue:
-
-read txd (port_id) (queue_id) (txd_id)
+Display a TX descriptor for a port TX queue::
-For example:
+ testpmd> read txd (port_id) (queue_id) (txd_id)
-.. code-block:: console
+For example::
- testpmd> read txd 0 0 4
+ testpmd> read txd 0 0 4
0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
+
Configuration Functions
-----------------------
@@ -261,21 +310,21 @@ This section details the available configuration functions that are available.
.. note::
- Configuration changes only become active when forwarding is started/restarted.
+ Configuration changes only become active when forwarding is started/restarted.
set default
~~~~~~~~~~~
-Reset forwarding to the default configuration:
+Reset forwarding to the default configuration::
-set default
+ testpmd> set default
set verbose
~~~~~~~~~~~
-Set the debug verbosity level:
+Set the debug verbosity level::
-set verbose (level)
+ testpmd> set verbose (level)
Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
@@ -286,276 +335,277 @@ Set the number of ports used by the application:
set nbport (num)
-This is equivalent to the --nb-ports command-line option.
+This is equivalent to the ``--nb-ports`` command-line option.
set nbcore
~~~~~~~~~~
-Set the number of cores used by the application:
+Set the number of cores used by the application::
-set nbcore (num)
+ testpmd> set nbcore (num)
-This is equivalent to the --nb-cores command-line option.
+This is equivalent to the ``--nb-cores`` command-line option.
.. note::
- The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
+ The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
set coremask
~~~~~~~~~~~~
-Set the forwarding cores hexadecimal mask:
+Set the forwarding cores hexadecimal mask::
-set coremask (mask)
+ testpmd> set coremask (mask)
-This is equivalent to the --coremask command-line option.
+This is equivalent to the ``--coremask`` command-line option.
.. note::
- The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
+ The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
set portmask
~~~~~~~~~~~~
-Set the forwarding ports hexadecimal mask:
+Set the forwarding ports hexadecimal mask::
-set portmask (mask)
+ testpmd> set portmask (mask)
-This is equivalent to the --portmask command-line option.
+This is equivalent to the ``--portmask`` command-line option.
set burst
~~~~~~~~~
-Set number of packets per burst:
+Set number of packets per burst::
-set burst (num)
+ testpmd> set burst (num)
-This is equivalent to the --burst command-line option.
+This is equivalent to the ``--burst command-line`` option.
-In mac_retry forwarding mode, the transmit delay time and number of retries can also be set.
+In ``mac_retry`` forwarding mode, the transmit delay time and number of retries can also be set::
-set burst tx delay (micrseconds) retry (num)
+ testpmd> set burst tx delay (micrseconds) retry (num)
set txpkts
~~~~~~~~~~
-Set the length of each segment of the TX-ONLY packets:
+Set the length of each segment of the TX-ONLY packets::
-set txpkts (x[,y]*)
+ testpmd> set txpkts (x[,y]*)
Where x[,y]* represents a CSV list of values, without white space.
set corelist
~~~~~~~~~~~~
-Set the list of forwarding cores:
+Set the list of forwarding cores::
-set corelist (x[,y]*)
+ testpmd> set corelist (x[,y]*)
For example, to change the forwarding cores:
.. code-block:: console
- testpmd> set corelist 3,1
- testpmd> show config fwd
+ testpmd> set corelist 3,1
+ testpmd> show config fwd
- io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
- Logical Core 3 (socket 0) forwards packets on 1 streams:
- RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
- Logical Core 1 (socket 0) forwards packets on 1 streams:
- RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
+ io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
+ Logical Core 3 (socket 0) forwards packets on 1 streams:
+ RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
+ Logical Core 1 (socket 0) forwards packets on 1 streams:
+ RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
.. note::
- The cores are used in the same order as specified on the command line.
+ The cores are used in the same order as specified on the command line.
set portlist
~~~~~~~~~~~~
-Set the list of forwarding ports:
+Set the list of forwarding ports::
-set portlist (x[,y]*)
+ testpmd> set portlist (x[,y]*)
For example, to change the port forwarding:
.. code-block:: console
- testpmd> set portlist 0,2,1,3
- testpmd> show config fwd
+ testpmd> set portlist 0,2,1,3
+ testpmd> show config fwd
- io packet forwarding - ports=4 - cores=1 - streams=4
- Logical Core 3 (socket 0) forwards packets on 4 streams:
- RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
- RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
- RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
- RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
+ io packet forwarding - ports=4 - cores=1 - streams=4
+ Logical Core 3 (socket 0) forwards packets on 4 streams:
+ RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
+ RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
+ RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
+ RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
vlan set strip
~~~~~~~~~~~~~~
-Set the VLAN strip on a port:
+Set the VLAN strip on a port::
-vlan set strip (on|off) (port_id)
+ testpmd> vlan set strip (on|off) (port_id)
vlan set stripq
~~~~~~~~~~~~~~~
-Set the VLAN strip for a queue on a port:
+Set the VLAN strip for a queue on a port::
-vlan set stripq (on|off) (port_id,queue_id)
+ testpmd> vlan set stripq (on|off) (port_id,queue_id)
vlan set filter
~~~~~~~~~~~~~~~
-Set the VLAN filter on a port:
+Set the VLAN filter on a port::
-vlan set filter (on|off) (port_id)
+ testpmd> vlan set filter (on|off) (port_id)
vlan set qinq
~~~~~~~~~~~~~
-Set the VLAN QinQ (extended queue in queue) on for a port:
+Set the VLAN QinQ (extended queue in queue) on for a port::
-vlan set qinq (on|off) (port_id)
+ testpmd> vlan set qinq (on|off) (port_id)
vlan set tpid
~~~~~~~~~~~~~
-Set the outer VLAN TPID for packet filtering on a port:
+Set the outer VLAN TPID for packet filtering on a port::
-vlan set tpid (value) (port_id)
+ testpmd> vlan set tpid (value) (port_id)
.. note::
- TPID value must be a 16-bit number (value <= 65536).
+ TPID value must be a 16-bit number (value <= 65536).
rx_vlan add
~~~~~~~~~~~
-Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:
+Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
-rx_vlan add (vlan_id|all) (port_id)
+ testpmd> rx_vlan add (vlan_id|all) (port_id)
.. note::
- VLAN filter must be set on that port. VLAN ID < 4096.
- Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
- in VFTA table. This is important if enabling all vlan_ids.
+ VLAN filter must be set on that port. VLAN ID < 4096.
+ Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
+ in VFTA table. This is important if enabling all vlan_ids.
rx_vlan rm
~~~~~~~~~~
-Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:
+Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
-rx_vlan rm (vlan_id|all) (port_id)
+ testpmd> rx_vlan rm (vlan_id|all) (port_id)
-rx_vlan add(for VF)
-~~~~~~~~~~~~~~~~~~~
+rx_vlan add (for VF)
+~~~~~~~~~~~~~~~~~~~~
-Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:
+Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
-rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
+ testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
-rx_vlan rm(for VF)
-~~~~~~~~~~~~~~~~~~
+rx_vlan rm (for VF)
+~~~~~~~~~~~~~~~~~~~
-Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:
+Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
-rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
+ testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
rx_vlan set tpid
~~~~~~~~~~~~~~~~
-Set the outer VLAN TPID for packet filtering on a port:
+Set the outer VLAN TPID for packet filtering on a port::
-rx_vlan set tpid (value) (port_id)
+ testpmd> rx_vlan set tpid (value) (port_id)
tunnel_filter add
~~~~~~~~~~~~~~~~~
-Add a tunnel filter on a port:
+Add a tunnel filter on a port::
-tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
- (tunnel_type) (filter_type) (tenant_id) (queue_id)
+ testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
+ (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)
tunnel_filter remove
~~~~~~~~~~~~~~~~~~~~
-Remove a tunnel filter on a port:
+Remove a tunnel filter on a port::
-tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
- (tunnel_type) (filter_type) (tenant_id) (queue_id)
+ testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
+ (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)
rx_vxlan_port add
~~~~~~~~~~~~~~~~~
-Add an UDP port for VXLAN packet filter on a port:
+Add an UDP port for VXLAN packet filter on a port::
-rx_vxlan_port add (udp_port) (port_id)
+ testpmd> rx_vxlan_port add (udp_port) (port_id)
rx_vxlan_port remove
~~~~~~~~~~~~~~~~~~~~
-Remove an UDP port for VXLAN packet filter on a port:
+Remove an UDP port for VXLAN packet filter on a port::
-rx_vxlan_port rm (udp_port) (port_id)
+ testpmd> rx_vxlan_port rm (udp_port) (port_id)
tx_vlan set
~~~~~~~~~~~
-Set hardware insertion of VLAN IDs in packets sent on a port:
+Set hardware insertion of VLAN IDs in packets sent on a port::
-tx_vlan set (port_id) vlan_id[, vlan_id_outer]
+ testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
-.. code-block:: console
+For example, set a single VLAN ID (5) insertion on port 0::
- Set a single VLAN ID (5) insertion on port 0.
+ tx_vlan set 0 5
- tx_vlan set 0 5
+Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
- Set double VLAN ID (inner: 2, outer: 3) insertion on port 1.
+ tx_vlan set 1 2 3
- tx_vlan set 1 2 3
tx_vlan set pvid
~~~~~~~~~~~~~~~~
-Set port based hardware insertion of VLAN ID in packets sent on a port:
+Set port based hardware insertion of VLAN ID in packets sent on a port::
-tx_vlan set pvid (port_id) (vlan_id) (on|off)
+ testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
tx_vlan reset
~~~~~~~~~~~~~
-Disable hardware insertion of a VLAN header in packets sent on a port:
+Disable hardware insertion of a VLAN header in packets sent on a port::
-tx_vlan reset (port_id)
+ testpmd> tx_vlan reset (port_id)
csum set
~~~~~~~~
Select hardware or software calculation of the checksum when
-transmitting a packet using the csum forward engine:
+transmitting a packet using the ``csum`` forwarding engine::
+
+ testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
-csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
+Where:
-- ip|udp|tcp|sctp always concern the inner layer.
+* ``ip|udp|tcp|sctp`` always relate to the inner layer.
-- outer-ip concerns the outer IP layer (only for IPv4) in case the packet is recognized
- as a tunnel packet by the forward engine (vxlan, gre and ipip are
- supported). See "csum parse-tunnel" command.
+* ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
+ as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
+ supported). See also the ``csum parse-tunnel`` command.
.. note::
- Check the NIC Datasheet for hardware limits.
+ Check the NIC Datasheet for hardware limits.
csum parse-tunnel
~~~~~~~~~~~~~~~~~
Define how tunneled packets should be handled by the csum forward
-engine.
+engine::
-csum parse-tunnel (on|off) (tx_port_id)
+ testpmd> csum parse-tunnel (on|off) (tx_port_id)
If enabled, the csum forward engine will try to recognize supported
tunnel headers (vxlan, gre, ipip).
@@ -565,305 +615,280 @@ header is handled as a packet payload).
.. note::
- The port argument is the TX port like in the "csum set" command.
+ The port argument is the TX port like in the ``csum set`` command.
Example:
-Consider a packet as following:
-"eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in"
+Consider a packet in packet like the following::
-- If parse-tunnel is enabled, the ip|udp|tcp|sctp parameters of "csum
- set" command are about inner headers (here ipv4_in and tcp_in), and the
- outer-ip parameter is about outer headers (here ipv4_out).
+ eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
-- If parse-tunnel is disabled, the ip|udp|tcp|sctp parameters of "csum
- set" command are about outer headers, here ipv4_out and udp_out.
+* If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
+ command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
+ ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
+
+* If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
+ command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
csum show
~~~~~~~~~
-Display tx checksum offload configuration:
+Display tx checksum offload configuration::
-csum show (port_id)
+ testpmd> csum show (port_id)
tso set
~~~~~~~
-Enable TCP Segmentation Offload in csum forward engine:
+Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
-tso set (segsize) (port_id)
+ testpmd> tso set (segsize) (port_id)
.. note::
- Check the NIC datasheet for hardware limits
+ Check the NIC datasheet for hardware limits.
tso show
~~~~~~~~
-Display the status of TCP Segmentation Offload:
-
-tso show (port_id)
+Display the status of TCP Segmentation Offload::
-set fwd
-~~~~~~~
-
-Set the packet forwarding mode:
-
-set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
-
-The available information categories are:
-
-* io: forwards packets "as-is" in I/O mode.
- This is the fastest possible forwarding operation as it does not access packets data.
- This is the default mode.
-
-* mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
-
-* mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
-
-* macswap: MAC swap forwarding mode.
- Swaps the source and the destination Ethernet addresses of packets before forwarding them.
-
-* flowgen: multi-flow generation mode.
- Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
-
-* rxonly: receives packets but doesn't transmit them.
-
-* txonly: generates and transmits packets without receiving any.
-
-* csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
-
-* icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
-
-* ieee1588: demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
- Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
-
-Example:
-
-.. code-block:: console
-
- testpmd> set fwd rxonly
-
- Set rxonly packet forwarding mode
+ testpmd> tso show (port_id)
mac_addr add
~~~~~~~~~~~~
-Add an alternative MAC address to a port:
+Add an alternative MAC address to a port::
-mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
+ testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
mac_addr remove
~~~~~~~~~~~~~~~
-Remove a MAC address from a port:
+Remove a MAC address from a port::
-mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
+ testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
mac_addr add(for VF)
~~~~~~~~~~~~~~~~~~~~
-Add an alternative MAC address for a VF to a port:
+Add an alternative MAC address for a VF to a port::
-mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
+ testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
set port-uta
~~~~~~~~~~~~
-Set the unicast hash filter(s) on/off for a port X:
+Set the unicast hash filter(s) on/off for a port::
-set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
+ testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
set promisc
~~~~~~~~~~~
Set the promiscuous mode on for a port or for all ports.
-In promiscuous mode packets are not dropped if they aren't for the specified MAC address:
+In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
-set promisc (port_id|all) (on|off)
+ testpmd> set promisc (port_id|all) (on|off)
set allmulti
~~~~~~~~~~~~
-Set the allmulti mode for a port or for all ports:
+Set the allmulti mode for a port or for all ports::
-set allmulti (port_id|all) (on|off)
+ testpmd> set allmulti (port_id|all) (on|off)
Same as the ifconfig (8) option. Controls how multicast packets are handled.
set flow_ctrl rx
~~~~~~~~~~~~~~~~
-Set the link flow control parameter on a port:
+Set the link flow control parameter on a port::
-set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
-(pause_time) (send_xon) (port_id)
+ testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
+ (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
+ autoneg (on|off) (port_id)
Where:
-high_water (integer): High threshold value to trigger XOFF.
+* ``high_water`` (integer): High threshold value to trigger XOFF.
+
+* ``low_water`` (integer): Low threshold value to trigger XON.
-low_water (integer) : Low threshold value to trigger XON.
+* ``pause_time`` (integer): Pause quota in the Pause frame.
-pause_time (integer): Pause quota in the Pause frame.
+* ``send_xon`` (0/1): Send XON frame.
-send_xon (0/1) : Send XON frame.
+* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
-mac_ctrl_frame_fwd : Enable receiving MAC control frames
+* ``autoneg``: Change the auto-negotiation para mete.
set pfc_ctrl rx
~~~~~~~~~~~~~~~
-Set the priority flow control parameter on a port:
+Set the priority flow control parameter on a port::
-set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
+ testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
+ (pause_time) (priority) (port_id)
Where:
-priority (0-7): VLAN User Priority.
+* ``high_water`` (integer): High threshold value.
+
+* ``low_water`` (integer): Low threshold value.
+
+* ``pause_time`` (integer): Pause quota in the Pause frame.
+
+* ``priority`` (0-7): VLAN User Priority.
set stat_qmap
~~~~~~~~~~~~~
-Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
-
-set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
+Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
-For example, to set rx queue 2 on port 0 to mapping 5:
+ testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
-.. code-block:: console
+For example, to set rx queue 2 on port 0 to mapping 5::
- testpmd>set stat_qmap rx 0 2 5
+ testpmd>set stat_qmap rx 0 2 5
-set port - rx/tx(for VF)
-~~~~~~~~~~~~~~~~~~~~~~~~
+set port - rx/tx (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~
-Set VF receive/transmit from a port:
+Set VF receive/transmit from a port::
-set port (port_id) vf (vf_id) (rx|tx) (on|off)
+ testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
set port - mac address filter (for VF)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Add/Remove unicast or multicast MAC addr filter for a VF:
+Add/Remove unicast or multicast MAC addr filter for a VF::
-set port (port_id) vf (vf_id) (mac_addr)
- (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
+ testpmd> set port (port_id) vf (vf_id) (mac_addr) \
+ (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
set port - rx mode(for VF)
~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set the VF receive mode of a port:
+Set the VF receive mode of a port::
-set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
+ testpmd> set port (port_id) vf (vf_id) \
+ rxmode (AUPE|ROPE|BAM|MPE) (on|off)
The available receive modes are:
-* AUPE: accepts untagged VLAN.
+* ``AUPE``: Accepts untagged VLAN.
-* ROPE: accepts unicast hash.
+* ``ROPE``: Accepts unicast hash.
-* BAM: accepts broadcast packets
+* ``BAM``: Accepts broadcast packets.
-* MPE: accepts all multicast packets
+* ``MPE``: Accepts all multicast packets.
set port - tx_rate (for Queue)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set TX rate limitation for queue of a port ID:
+Set TX rate limitation for a queue on a port::
-set port (port_id) queue (queue_id) rate (rate_value)
+ testpmd> set port (port_id) queue (queue_id) rate (rate_value)
set port - tx_rate (for VF)
~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set TX rate limitation for queues in VF of a port ID:
+Set TX rate limitation for queues in VF on a port::
-set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
+ testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
set port - mirror rule
~~~~~~~~~~~~~~~~~~~~~~
-Set pool or vlan type mirror rule for a port:
+Set pool or vlan type mirror rule for a port::
-set port (port_id) mirror-rule (rule_id) (pool-mirror-up|pool-mirror-down|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
+ testpmd> set port (port_id) mirror-rule (rule_id) \
+ (pool-mirror-up|pool-mirror-down|vlan-mirror) \
+ (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
-Set link mirror rule for a port:
+Set link mirror rule for a port::
-set port (port_id) mirror-rule (rule_id) (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
+ testpmd> set port (port_id) mirror-rule (rule_id) \
+ (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
-For example to enable mirror traffic with vlan 0,1 to pool 0:
+For example to enable mirror traffic with vlan 0,1 to pool 0::
-.. code-block:: console
-
- set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
+ set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
reset port - mirror rule
~~~~~~~~~~~~~~~~~~~~~~~~
-Reset a mirror rule for a port.
+Reset a mirror rule for a port::
-reset port (port_id) mirror-rule (rule_id)
+ testpmd> reset port (port_id) mirror-rule (rule_id)
set flush_rx
~~~~~~~~~~~~
-Flush (default) or don't flush RX streams before forwarding.
-Mainly used with PCAP drivers to avoid the default behavior of flushing the first 512 packets on RX streams.
+Set the flush on RX streams before forwarding.
+The default is flush ``on``.
+Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
-set flush_rx off
+ testpmd> set flush_rx off
set bypass mode
~~~~~~~~~~~~~~~
-Set the bypass mode for the lowest port on bypass enabled NIC.
+Set the bypass mode for the lowest port on bypass enabled NIC::
-set bypass mode (normal|bypass|isolate) (port_id)
+ testpmd> set bypass mode (normal|bypass|isolate) (port_id)
set bypass event
~~~~~~~~~~~~~~~~
-Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
+Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
+
+ testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
+ mode (normal|bypass|isolate) (port_id)
-* timeout: enable bypass after watchdog timeout.
+Where:
-* os_on: enable bypass when OS/board is powered on.
+* ``timeout``: Enable bypass after watchdog timeout.
-* os_off: enable bypass when OS/board is powered off.
+* ``os_on``: Enable bypass when OS/board is powered on.
-* power_on: enable bypass when power supply is turned on.
+* ``os_off``: Enable bypass when OS/board is powered off.
-* power_off: enable bypass when power supply is turned off.
+* ``power_on``: Enable bypass when power supply is turned on.
+
+* ``power_off``: Enable bypass when power supply is turned off.
-set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
set bypass timeout
~~~~~~~~~~~~~~~~~~
-Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
+Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
-set bypass timeout (0|1.5|2|3|4|8|16|32)
+ testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
show bypass config
~~~~~~~~~~~~~~~~~~
-Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
+Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
-show bypass config (port_id)
+ testpmd> show bypass config (port_id)
set link up
~~~~~~~~~~~
-Set link up for a port.
+Set link up for a port::
-set link-up port (port id)
+ testpmd> set link-up port (port id)
set link down
~~~~~~~~~~~~~
-Set link down for a port.
+Set link down for a port::
+
+ testpmd> set link-down port (port id)
-set link-down port (port id)
Port Functions
--------------
@@ -872,7 +897,7 @@ The following sections show functions for configuring ports.
.. note::
- Port configuration changes only become active when forwarding is started/restarted.
+ Port configuration changes only become active when forwarding is started/restarted.
port attach
~~~~~~~~~~~
@@ -887,22 +912,27 @@ For example, to move a pci device using ixgbe under DPDK management:
.. code-block:: console
- ./tools/dpdk_nic_bind.py --status
+ # Check the status of the available devices.
+ ./tools/dpdk_nic_bind.py --status
- Network devices using DPDK-compatible driver
- ============================================
- <none>
+ Network devices using DPDK-compatible driver
+ ============================================
+ <none>
- Network devices using kernel driver
- ===================================
- 0000:0a:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection' if=eth2 drv=ixgbe unused=
+ Network devices using kernel driver
+ ===================================
+ 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
- ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
- ./tools/dpdk_nic_bind.py --status
- Network devices using DPDK-compatible driver
- ============================================
- 0000:0a:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection' drv=igb_uio unused=
+ # Bind the device to igb_uio.
+ sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
+
+
+ # Recheck the status of the devices.
+ ./tools/dpdk_nic_bind.py --status
+ Network devices using DPDK-compatible driver
+ ============================================
+ 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
To attach a port created by virtual device, above steps are not needed.
@@ -912,44 +942,42 @@ For example, to attach a port whose pci address is 0000:0a:00.0.
.. code-block:: console
- testpmd> port attach 0000:0a:00.0
- Attaching a new port...
- EAL: PCI device 0000:0a:00.0 on NUMA socket -1
- EAL: probe driver: 8086:10fb rte_ixgbe_pmd
- EAL: PCI memory mapped at 0x7f83bfa00000
- EAL: PCI memory mapped at 0x7f83bfa80000
- PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
- PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
- Port 0 is attached. Now total ports is 1
- Done
- testpmd>
+ testpmd> port attach 0000:0a:00.0
+ Attaching a new port...
+ EAL: PCI device 0000:0a:00.0 on NUMA socket -1
+ EAL: probe driver: 8086:10fb rte_ixgbe_pmd
+ EAL: PCI memory mapped at 0x7f83bfa00000
+ EAL: PCI memory mapped at 0x7f83bfa80000
+ PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
+ PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
+ Port 0 is attached. Now total ports is 1
+ Done
For example, to attach a port created by pcap PMD.
.. code-block:: console
- testpmd> port attach eth_pcap0
- Attaching a new port...
- PMD: Initializing pmd_pcap for eth_pcap0
- PMD: Creating pcap-backed ethdev on numa socket 0
- Port 0 is attached. Now total ports is 1
- Done
- testpmd>
+ testpmd> port attach eth_pcap0
+ Attaching a new port...
+ PMD: Initializing pmd_pcap for eth_pcap0
+ PMD: Creating pcap-backed ethdev on numa socket 0
+ Port 0 is attached. Now total ports is 1
+ Done
-In this case, identifier is "eth_pcap0".
-This identifier format is the same as "--vdev" format of DPDK applications.
+In this case, identifier is ``eth_pcap0``.
+This identifier format is the same as ``--vdev`` format of DPDK applications.
For example, to re-attach a bonded port which has been previously detached,
the mode and slave parameters must be given.
.. code-block:: console
- testpmd> port attach eth_bond_testpmd_0,mode=0,slave=1
- Attaching a new port...
- EAL: Initializing pmd_bond for eth_bond_testpmd_0
- EAL: Create bonded device eth_bond_testpmd_0 on port 0 in mode 0 on socket 0.
- Port 0 is attached. Now total ports is 1
- Done
+ testpmd> port attach eth_bond_0,mode=0,slave=1
+ Attaching a new port...
+ EAL: Initializing pmd_bond for eth_bond_0
+ EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0.
+ Port 0 is attached. Now total ports is 1
+ Done
port detach
@@ -957,39 +985,40 @@ port detach
Detach a specific port.
-Before detaching a port, the port should be closed.
+Before detaching a port, the port should be closed::
-port detach (port_id)
+ testpmd> port detach (port_id)
For example, to detach a pci device port 0.
.. code-block:: console
- testpmd> port close 0
- Closing ports...
- Done
- testpmd> port detach 0
- Detaching a port...
- EAL: PCI device 0000:0a:00.0 on NUMA socket -1
- EAL: remove driver: 8086:10fb rte_ixgbe_pmd
- EAL: PCI memory unmapped at 0x7f83bfa00000
- EAL: PCI memory unmapped at 0x7f83bfa80000
- Done
- testpmd>
+ testpmd> port close 0
+ Closing ports...
+ Done
+
+ testpmd> port detach 0
+ Detaching a port...
+ EAL: PCI device 0000:0a:00.0 on NUMA socket -1
+ EAL: remove driver: 8086:10fb rte_ixgbe_pmd
+ EAL: PCI memory unmapped at 0x7f83bfa00000
+ EAL: PCI memory unmapped at 0x7f83bfa80000
+ Done
+
For example, to detach a virtual device port 0.
.. code-block:: console
- testpmd> port close 0
- Closing ports...
- Done
- testpmd> port detach 0
- Detaching a port...
- PMD: Closing pcap ethdev on numa socket 0
- Port 'eth_pcap0' is detached. Now total ports is 0
- Done
- testpmd>
+ testpmd> port close 0
+ Closing ports...
+ Done
+
+ testpmd> port detach 0
+ Detaching a port...
+ PMD: Closing pcap ethdev on numa socket 0
+ Port 'eth_pcap0' is detached. Now total ports is 0
+ Done
To remove a pci device completely from the system, first detach the port from testpmd.
Then the device should be moved under kernel management.
@@ -999,214 +1028,218 @@ For example, to move a pci device under kernel management:
.. code-block:: console
- ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
- ./tools/dpdk_nic_bind.py --status
+ sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
- Network devices using DPDK-compatible driver
- ============================================
- <none>
+ ./tools/dpdk_nic_bind.py --status
- Network devices using kernel driver
- ===================================
- 0000:0a:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection' if=eth2 drv=ixgbe unused=igb_uio
+ Network devices using DPDK-compatible driver
+ ============================================
+ <none>
+
+ Network devices using kernel driver
+ ===================================
+ 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
To remove a port created by a virtual device, above steps are not needed.
port start
~~~~~~~~~~
-Start all ports or a specific port:
+Start all ports or a specific port::
-port start (port_id|all)
+ testpmd> port start (port_id|all)
port stop
~~~~~~~~~
-Stop all ports or a specific port:
+Stop all ports or a specific port::
-port stop (port_id|all)
+ testpmd> port stop (port_id|all)
port close
~~~~~~~~~~
-Close all ports or a specific port:
+Close all ports or a specific port::
-port close (port_id|all)
+ testpmd> port close (port_id|all)
port start/stop queue
~~~~~~~~~~~~~~~~~~~~~
-Start/stop a rx/tx queue on a specific port:
+Start/stop a rx/tx queue on a specific port::
-port (port_id) (rxq|txq) (queue_id) (start|stop)
+ testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
Only take effect when port is started.
port config - speed
~~~~~~~~~~~~~~~~~~~
-Set the speed and duplex mode for all ports or a specific port:
+Set the speed and duplex mode for all ports or a specific port::
-port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
+ testpmd> port config (port_id|all) speed (10|100|1000|10000|auto) \
+ duplex (half|full|auto)
port config - queues/descriptors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set number of queues/descriptors for rxq, txq, rxd and txd:
+Set number of queues/descriptors for rxq, txq, rxd and txd::
-port config all (rxq|txq|rxd|txd) (value)
+ testpmd> port config all (rxq|txq|rxd|txd) (value)
-This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
+This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
port config - max-pkt-len
~~~~~~~~~~~~~~~~~~~~~~~~~
-Set the maximum packet length:
+Set the maximum packet length::
-port config all max-pkt-len (value)
+ testpmd> port config all max-pkt-len (value)
-This is equivalent to the --max-pkt-len command-line option.
+This is equivalent to the ``--max-pkt-len`` command-line option.
port config - CRC Strip
~~~~~~~~~~~~~~~~~~~~~~~
-Set hardware CRC stripping on or off for all ports:
+Set hardware CRC stripping on or off for all ports::
-port config all crc-strip (on|off)
+ testpmd> port config all crc-strip (on|off)
CRC stripping is off by default.
-The on option is equivalent to the --crc-strip command-line option.
+The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
port config - RX Checksum
~~~~~~~~~~~~~~~~~~~~~~~~~
-Set hardware RX checksum offload to on or off for all ports:
+Set hardware RX checksum offload to on or off for all ports::
-port config all rx-cksum (on|off)
+ testpmd> port config all rx-cksum (on|off)
Checksum offload is off by default.
-The on option is equivalent to the --enable-rx-cksum command-line option.
+The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
port config - VLAN
~~~~~~~~~~~~~~~~~~
-Set hardware VLAN on or off for all ports:
+Set hardware VLAN on or off for all ports::
-port config all hw-vlan (on|off)
+ testpmd> port config all hw-vlan (on|off)
Hardware VLAN is on by default.
-The off option is equivalent to the --disable-hw-vlan command-line option.
+The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
port config - VLAN filter
~~~~~~~~~~~~~~~~~~~~~~~~~
-Set hardware VLAN filter on or off for all ports:
+Set hardware VLAN filter on or off for all ports::
-port config all hw-vlan-filter (on|off)
+ testpmd> port config all hw-vlan-filter (on|off)
Hardware VLAN filter is on by default.
-The off option is equivalent to the --disable-hw-vlan-filter command-line option.
+The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
port config - VLAN strip
~~~~~~~~~~~~~~~~~~~~~~~~
-Set hardware VLAN strip on or off for all ports:
+Set hardware VLAN strip on or off for all ports::
-port config all hw-vlan-strip (on|off)
+ testpmd> port config all hw-vlan-strip (on|off)
Hardware VLAN strip is on by default.
-The off option is equivalent to the --disable-hw-vlan-strip command-line option.
+The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
port config - VLAN extend
~~~~~~~~~~~~~~~~~~~~~~~~~
-Set hardware VLAN extend on or off for all ports:
+Set hardware VLAN extend on or off for all ports::
-port config all hw-vlan-extend (on|off)
+ testpmd> port config all hw-vlan-extend (on|off)
Hardware VLAN extend is off by default.
-The off option is equivalent to the --disable-hw-vlan-extend command-line option.
+The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
port config - Drop Packets
~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set packet drop for packets with no descriptors on or off for all ports:
+Set packet drop for packets with no descriptors on or off for all ports::
-port config all drop-en (on|off)
+ testpmd> port config all drop-en (on|off)
Packet dropping for packets with no descriptors is off by default.
-The on option is equivalent to the --enable-drop-en command-line option.
+The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
port config - RSS
~~~~~~~~~~~~~~~~~
-Set the RSS (Receive Side Scaling) mode on or off:
+Set the RSS (Receive Side Scaling) mode on or off::
-port config all rss (all|ip|tcp|udp|sctp|ether|none)
+ testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none)
RSS is on by default.
-The off option is equivalent to the --disable-rss command-line option.
+The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
port config - RSS Reta
~~~~~~~~~~~~~~~~~~~~~~
-Set the RSS (Receive Side Scaling) redirection table:
+Set the RSS (Receive Side Scaling) redirection table::
-port config all rss reta (hash,queue)[,(hash,queue)]
+ testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
port config - DCB
~~~~~~~~~~~~~~~~~
-Set the DCB mode for an individual port:
+Set the DCB mode for an individual port::
-port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
+ testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
The traffic class should be 4 or 8.
port config - Burst
~~~~~~~~~~~~~~~~~~~
-Set the number of packets per burst:
+Set the number of packets per burst::
-port config all burst (value)
+ testpmd> port config all burst (value)
-This is equivalent to the --burst command-line option.
+This is equivalent to the ``--burst`` command-line option.
port config - Threshold
~~~~~~~~~~~~~~~~~~~~~~~
-Set thresholds for TX/RX queues:
+Set thresholds for TX/RX queues::
-port config all (threshold) (value)
+ testpmd> port config all (threshold) (value)
Where the threshold type can be:
-* txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
+* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
+
+* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
+
+* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
-* txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
+* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
-* txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
+* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
-* rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
+* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
-* rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
+* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
-* rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
+* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
-* txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
+* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
-* rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
+These threshold options are also available from the command-line.
-* txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
- These threshold options are also available from the command-line.
Link Bonding Functions
----------------------
@@ -1217,95 +1250,81 @@ manage link bonding devices from within testpmd interactive prompt.
create bonded device
~~~~~~~~~~~~~~~~~~~~
-Create a new bonding device:
+Create a new bonding device::
-create bonded device (mode) (socket)
+ testpmd> create bonded device (mode) (socket)
-For example, to create a bonded device in mode 1 on socket 0.
-
-.. code-block:: console
+For example, to create a bonded device in mode 1 on socket 0::
- testpmd> create bonded 1 0
- created new bonded device (port X)
+ testpmd> create bonded 1 0
+ created new bonded device (port X)
add bonding slave
~~~~~~~~~~~~~~~~~
-Adds Ethernet device to a Link Bonding device:
+Adds Ethernet device to a Link Bonding device::
-add bonding slave (slave id) (port id)
+ testpmd> add bonding slave (slave id) (port id)
-For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
+For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
-.. code-block:: console
-
- testpmd> add bonding slave 6 10
+ testpmd> add bonding slave 6 10
remove bonding slave
~~~~~~~~~~~~~~~~~~~~
-Removes an Ethernet slave device from a Link Bonding device:
+Removes an Ethernet slave device from a Link Bonding device::
-remove bonding slave (slave id) (port id)
+ testpmd> remove bonding slave (slave id) (port id)
-For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
+For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
-.. code-block:: console
-
- testpmd> remove bonding slave 6 10
+ testpmd> remove bonding slave 6 10
set bonding mode
~~~~~~~~~~~~~~~~
-Set the Link Bonding mode of a Link Bonding device:
-
-set bonding mode (value) (port id)
+Set the Link Bonding mode of a Link Bonding device::
-For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
+ testpmd> set bonding mode (value) (port id)
-.. code-block:: console
+For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
- testpmd> set bonding mode 3 10
+ testpmd> set bonding mode 3 10
set bonding primary
~~~~~~~~~~~~~~~~~~~
-Set an Ethernet slave device as the primary device on a Link Bonding device:
-
-set bonding primary (slave id) (port id)
+Set an Ethernet slave device as the primary device on a Link Bonding device::
-For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
+ testpmd> set bonding primary (slave id) (port id)
-.. code-block:: console
+For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
- testpmd> set bonding primary 6 10
+ testpmd> set bonding primary 6 10
set bonding mac
~~~~~~~~~~~~~~~
-Set the MAC address of a Link Bonding device:
+Set the MAC address of a Link Bonding device::
-set bonding mac (port id) (mac)
+ testpmd> set bonding mac (port id) (mac)
-For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
-
-.. code-block:: console
+For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
- testpmd> set bonding mac 10 00:00:00:00:00:01
+ testpmd> set bonding mac 10 00:00:00:00:00:01
set bonding xmit_balance_policy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
+Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
-set bonding xmit_balance_policy (port_id) (l2|l23|l34)
+ testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
-For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
+For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
-.. code-block:: console
-
- testpmd> set bonding xmit_balance_policy 10 l34
+ testpmd> set bonding xmit_balance_policy 10 l34
set bonding mon_period
@@ -1315,41 +1334,38 @@ Set the link status monitoring polling period in milliseconds for a bonding devi
This adds support for PMD slave devices which do not support link status interrupts.
When the mon_period is set to a value greater than 0 then all PMD's which do not support
-link status ISR will be queried every polling interval to check if their link status has changed.
+link status ISR will be queried every polling interval to check if their link status has changed::
-set bonding mon_period (port_id) (value)
+ testpmd> set bonding mon_period (port_id) (value)
-For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
+For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
-.. code-block:: console
-
- testpmd> set bonding mon_period 5 150
+ testpmd> set bonding mon_period 5 150
show bonding config
~~~~~~~~~~~~~~~~~~~
-Show the current configuration of a Link Bonding device:
+Show the current configuration of a Link Bonding device::
-show bonding config (port id)
+ testpmd> show bonding config (port id)
For example,
to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
-in balance mode with a transmission policy of layer 2+3.
-
-.. code-block:: console
+in balance mode with a transmission policy of layer 2+3::
- testpmd> show bonding config 9
+ testpmd> show bonding config 9
Bonding mode: 2
Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
Slaves (3): [1 3 4]
Active Slaves (3): [1 3 4]
Primary: [3]
+
Register Functions
------------------
-The Register functions can be used to read from and write to registers on the network card referenced by a port number.
+The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
This is mainly useful for debugging purposes.
Reference should be made to the appropriate datasheet for the network card for details on the register addresses
and fields that can be accessed.
@@ -1357,86 +1373,75 @@ and fields that can be accessed.
read reg
~~~~~~~~
-Display the value of a port register:
+Display the value of a port register::
-read reg (port_id) (address)
+ testpmd> read reg (port_id) (address)
-For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel® 82599 10 GbE Controller:
+For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
-.. code-block:: console
-
- testpmd> read reg 0 0xEE00
- port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
+ testpmd> read reg 0 0xEE00
+ port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
read regfield
~~~~~~~~~~~~~
-Display a port register bit field:
-
-read regfield (port_id) (address) (bit_x) (bit_y)
+Display a port register bit field::
-For example, reading the lowest two bits from the register in the example above:
+ testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
-.. code-block:: console
+For example, reading the lowest two bits from the register in the example above::
- testpmd> read regfield 0 0xEE00 0 1
- port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
+ testpmd> read regfield 0 0xEE00 0 1
+ port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
read regbit
~~~~~~~~~~~
-Display a single port register bit:
-
-read regbit (port_id) (address) (bit_x)
+Display a single port register bit::
-For example, reading the lowest bit from the register in the example above:
+ testpmd> read regbit (port_id) (address) (bit_x)
-.. code-block:: console
+For example, reading the lowest bit from the register in the example above::
- testpmd> read regbit 0 0xEE00 0
- port 0 PCI register at offset 0xEE00: bit 0=1
+ testpmd> read regbit 0 0xEE00 0
+ port 0 PCI register at offset 0xEE00: bit 0=1
write reg
~~~~~~~~~
-Set the value of a port register:
+Set the value of a port register::
-write reg (port_id) (address) (value)
+ testpmd> write reg (port_id) (address) (value)
-For example, to clear a register:
+For example, to clear a register::
-.. code-block:: console
-
- testpmd> write reg 0 0xEE00 0x0
- port 0 PCI register at offset 0xEE00: 0x00000000 (0)
+ testpmd> write reg 0 0xEE00 0x0
+ port 0 PCI register at offset 0xEE00: 0x00000000 (0)
write regfield
~~~~~~~~~~~~~~
-Set bit field of a port register:
+Set bit field of a port register::
-write regfield (port_id) (address) (bit_x) (bit_y) (value)
+ testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
-For example, writing to the register cleared in the example above:
+For example, writing to the register cleared in the example above::
-.. code-block:: console
-
- testpmd> write regfield 0 0xEE00 0 1 2
- port 0 PCI register at offset 0xEE00: 0x00000002 (2)
+ testpmd> write regfield 0 0xEE00 0 1 2
+ port 0 PCI register at offset 0xEE00: 0x00000002 (2)
write regbit
~~~~~~~~~~~~
-Set single bit value of a port register:
+Set single bit value of a port register::
-write regbit (port_id) (address) (bit_x) (value)
+ testpmd> write regbit (port_id) (address) (bit_x) (value)
-For example, to set the high bit in the register from the example above:
+For example, to set the high bit in the register from the example above::
-.. code-block:: console
+ testpmd> write regbit 0 0xEE00 31 1
+ port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
- testpmd> write regbit 0 0xEE00 31 1
- port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
Filter Functions
----------------
@@ -1446,159 +1451,170 @@ This section details the available filter functions that are available.
ethertype_filter
~~~~~~~~~~~~~~~~~~~~
-Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
+Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
-ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
+ ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
+ ethertype (ether_type) (drop|fwd) queue (queue_id)
The available information parameters are:
-* port_id: the port which the Ethertype filter assigned on.
+* ``port_id``: The port which the Ethertype filter assigned on.
-* mac_addr: compare destination mac address.
+* ``mac_addr``: Compare destination mac address.
-* mac_ignr: ignore destination mac address match.
+* ``mac_ignr``: Ignore destination mac address match.
-* mac_address: destination mac address to match.
+* ``mac_address``: Destination mac address to match.
-* ether_type: the EtherType value want to match,
- for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
+* ``ether_type``: The EtherType value want to match,
+ for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
-* queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.
+* ``queue_id``: The receive queue associated with this EtherType filter.
+ It is meaningless when deleting or dropping.
-Example, to add/remove an ethertype filter rule:
+Example, to add/remove an ethertype filter rule::
-.. code-block:: console
+ testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
+ ethertype 0x0806 fwd queue 3
- testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 ethertype 0x0806 fwd queue 3
- testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 ethertype 0x0806 fwd queue 3
+ testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
+ ethertype 0x0806 fwd queue 3
2tuple_filter
~~~~~~~~~~~~~~~~~
Add or delete a 2-tuple filter,
-which identify packets by specific protocol and destination TCP/UDP port
-and forwards packets into one of the receive queues.
+which identifies packets by specific protocol and destination TCP/UDP port
+and forwards packets into one of the receive queues::
-2tuple_filter (port_id) (add|del) dst_port (dst_port_value) protocol (protocol_value)
-mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id)
+ 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
+ protocol (protocol_value) mask (mask_value) \
+ tcp_flags (tcp_flags_value) priority (prio_value) \
+ queue (queue_id)
The available information parameters are:
-* port_id: the port which the 2-tuple filter assigned on.
+* ``port_id``: The port which the 2-tuple filter assigned on.
-* dst_port_value: destination port in L4.
+* ``dst_port_value``: Destination port in L4.
-* protocol_value: IP L4 protocol.
+* ``protocol_value``: IP L4 protocol.
-* mask_value: participates in the match or not by bit for field above, 1b means participate.
+* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
-* tcp_flags_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
+* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
-* prio_value: priority of this filter.
+* ``prio_value``: Priority of this filter.
-* queue_id: The receive queue associated with this 2-tuple filter.
+* ``queue_id``: The receive queue associated with this 2-tuple filter.
-Example, to add/remove an 2tuple filter rule:
+Example, to add/remove an 2tuple filter rule::
-.. code-block:: console
+ testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
+ tcp_flags 0x02 priority 3 queue 3
- testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3
- testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3
+ testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
+ tcp_flags 0x02 priority 3 queue 3
5tuple_filter
~~~~~~~~~~~~~~~~~
Add or delete a 5-tuple filter,
which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
-and routes packets into one of the receive queues.
+and routes packets into one of the receive queues::
-5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
-protocol (protocol_value) mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id)
+ 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
+ (src_address) dst_port (dst_port_value) \
+ src_port (src_port_value) protocol (protocol_value) \
+ mask (mask_value) tcp_flags (tcp_flags_value) \
+ priority (prio_value) queue (queue_id)
The available information parameters are:
-* port_id: the port which the 5-tuple filter assigned on.
+* ``port_id``: The port which the 5-tuple filter assigned on.
-* dst_address: destination IP address.
+* ``dst_address``: Destination IP address.
-* src_address: source IP address.
+* ``src_address``: Source IP address.
-* dst_port_value: TCP/UDP destination port.
+* ``dst_port_value``: TCP/UDP destination port.
-* src_port_value: TCP/UDP source port.
+* ``src_port_value``: TCP/UDP source port.
-* protocol_value: L4 protocol.
+* ``protocol_value``: L4 protocol.
-* mask_value: participates in the match or not by bit for field above, 1b means participate
+* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
-* tcp_flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
+* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
-* prio_value: the priority of this filter.
+* ``prio_value``: The priority of this filter.
-* queue_id: The receive queue associated with this 5-tuple filter.
+* ``queue_id``: The receive queue associated with this 5-tuple filter.
-Example, to add/remove an 5tuple filter rule:
+Example, to add/remove an 5tuple filter rule::
-.. code-block:: console
+ testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
+ dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
+ flags 0x0 priority 3 queue 3
- testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3
- testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3
+ testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
+ dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
+ flags 0x0 priority 3 queue 3
syn_filter
-~~~~~~~~~~~~~~
+~~~~~~~~~~
-By SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue.
+Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
-syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
+ syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
The available information parameters are:
-* port_id: the port which the SYN filter assigned on.
+* ``port_id``: The port which the SYN filter assigned on.
-* high: this SYN filter has higher priority than other filters.
+* ``high``: This SYN filter has higher priority than other filters.
-* low: this SYN filter has lower priority than other filters.
+* ``low``: This SYN filter has lower priority than other filters.
-* queue_id: The receive queue associated with this SYN filter
+* ``queue_id``: The receive queue associated with this SYN filter
-Example:
-
-.. code-block:: console
+Example::
- testpmd> syn_filter 0 add priority high queue 3
+ testpmd> syn_filter 0 add priority high queue 3
flex_filter
~~~~~~~~~~~
With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
-and routes packets into one of the receive queues.
+and routed into one of the receive queues::
-flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value)
-mask (mask_value) priority (prio_value) queue (queue_id)
+ flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
+ mask (mask_value) priority (prio_value) queue (queue_id)
The available information parameters are:
-* port_id: the port which the Flex filter is assigned on.
+* ``port_id``: The port which the Flex filter is assigned on.
-* len_value: filter length in bytes, no greater than 128.
+* ``len_value``: Filter length in bytes, no greater than 128.
-* bytes_value: a string in hexadecimal, means the value the flex filter needs to match.
+* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
-* mask_value: a string in hexadecimal, bit 1 means corresponding byte participates in the match.
+* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
-* prio_value: the priority of this filter.
+* ``prio_value``: The priority of this filter.
-* queue_id: the receive queue associated with this Flex filter.
+* ``queue_id``: The receive queue associated with this Flex filter.
-Example:
+Example::
-.. code-block:: console
+ testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
+ mask 000C priority 3 queue 3
+
+ testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
+ mask 000C priority 3 queue 3
- testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000
- mask 000C priority 3 queue 3
- testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000
- mask 000C priority 3 queue 3
+.. _testpmd_flow_director:
flow_director_filter
~~~~~~~~~~~~~~~~~~~~
@@ -1606,154 +1622,158 @@ flow_director_filter
The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
Two types of filtering are supported which are referred to as Perfect Match and Signature filters, the match mode
-is set by the --pkt-filter-mode command-line parameter:
+is set by the ``--pkt-filter-mode`` command-line parameter:
-* Perfect match filters.
- The hardware checks a match between the masked fields of the received packets and the programmed filters.
+* Perfect match filters.
+ The hardware checks a match between the masked fields of the received packets and the programmed filters.
-* Signature filters.
- The hardware checks a match between a hash-based signature of the masked fields of the received packet.
+* Signature filters.
+ The hardware checks a match between a hash-based signature of the masked fields of the received packet.
The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
-per flow type and the flexible payload. The Flow Director can also mask out parts of all of these fields so that filters
+per flow type and the flexible payload.
+
+The Flow Director can also mask out parts of all of these fields so that filters
are only applied to certain fields or parts of the fields.
Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
-# Commands to add flow director filters of different flow types.
+# Commands to add flow director filters of different flow types::
-flow_director_filter (port_id) (add|del|update) flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
-src (src_ip_address) dst (dst_ip_address) vlan (vlan_value) flexbytes (flexbytes_value)
-(drop|fwd) queue (queue_id) fd_id (fd_id_value)
+ flow_director_filter (port_id) (add|del|update) \
+ flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
+ src (src_ip_address) dst (dst_ip_address) \
+ vlan (vlan_value) flexbytes (flexbytes_value) \
+ (drop|fwd) queue (queue_id) fd_id (fd_id_value)
-flow_director_filter (port_id) (add|del|update) flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp)
-src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) vlan (vlan_value)
-flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
+ flow_director_filter (port_id) (add|del|update) \
+ flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
+ src (src_ip_address) (src_port) \
+ dst (dst_ip_address) (dst_port) \
+ vlan (vlan_value) flexbytes (flexbytes_value) \
+ (drop|fwd) queue (queue_id) fd_id (fd_id_value)
-flow_director_filter (port_id) (add|del|update) flow (ipv4-sctp|ipv6-sctp)
-src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) tag (verification_tag)
-vlan (vlan_value) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
+ flow_director_filter (port_id) (add|del|update) \
+ flow (ipv4-sctp|ipv6-sctp) \
+ src (src_ip_address) (src_port) \
+ dst (dst_ip_address) (dst_port)
+ tag (verification_tag) vlan (vlan_value) \
+ flexbytes (flexbytes_value) (drop|fwd) \
+ queue (queue_id) fd_id (fd_id_value)
-flow_director_filter (port_id) (add|del|update) flow l2_payload
-ether (ethertype) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
+ flow_director_filter (port_id) (add|del|update) flow l2_payload \
+ ether (ethertype) flexbytes (flexbytes_value) \
+ (drop|fwd) queue (queue_id) fd_id (fd_id_value)
-For example, to add an ipv4-udp flow type filter:
+For example, to add an ipv4-udp flow type filter::
-.. code-block:: console
+ testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \
+ dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
- testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
+For example, add an ipv4-other flow type filter::
-For example, add an ipv4-other flow type filter:
-
-.. code-block:: console
-
- testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
+ testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \
+ dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
flush_flow_director
~~~~~~~~~~~~~~~~~~~
-flush all flow director filters on a device:
+Flush all flow director filters on a device::
-flush_flow_director (port_id)
+ testpmd> flush_flow_director (port_id)
-Example, to flush all flow director filter on port 0:
-
-.. code-block:: console
+Example, to flush all flow director filter on port 0::
testpmd> flush_flow_director 0
flow_director_mask
~~~~~~~~~~~~~~~~~~
-set flow director's masks on match input set
+Set flow director's input masks::
-flow_director_mask (port_id) vlan (vlan_value) src_mask (ipv4_src) (ipv6_src) (src_port) dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
+ flow_director_mask (port_id) vlan (vlan_value) \
+ src_mask (ipv4_src) (ipv6_src) (src_port) \
+ dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
-Example, to set flow director mask on port 0:
-
-.. code-block:: console
-
- testpmd> flow_director_mask 0 vlan 0xefff src_mask 255.255.255.255 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF dst_mask 255.255.255.255 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
+Example, to set flow director mask on port 0::
+ testpmd> flow_director_mask 0 vlan 0xefff \
+ src_mask 255.255.255.255 \
+ FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
+ dst_mask 255.255.255.255 \
+ FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
flow_director_flex_mask
~~~~~~~~~~~~~~~~~~~~~~~
-set masks of flow director's flexible payload based on certain flow type:
+set masks of flow director's flexible payload based on certain flow type::
-flow_director_flex_mask (port_id) flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|
-ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|l2_payload|all) (mask)
+ testpmd> flow_director_flex_mask (port_id) \
+ flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
+ ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
+ l2_payload|all) (mask)
-Example, to set flow director's flex mask for all flow type on port 0:
-
-.. code-block:: console
+Example, to set flow director's flex mask for all flow type on port 0::
- testpmd> flow_director_flex_mask 0 flow all (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
+ testpmd> flow_director_flex_mask 0 flow all \
+ (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
flow_director_flex_payload
~~~~~~~~~~~~~~~~~~~~~~~~~~
-Configure flexible payload selection.
+Configure flexible payload selection::
-flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
+ flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
-For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload.
+For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
-.. code-block:: console
-
- testpmd> flow_director_flex_payload 0 l4 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
+ testpmd> flow_director_flex_payload 0 l4 \
+ (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
get_sym_hash_ena_per_port
~~~~~~~~~~~~~~~~~~~~~~~~~
-Get symmetric hash enable configuration per port.
+Get symmetric hash enable configuration per port::
-get_sym_hash_ena_per_port (port_id)
+ get_sym_hash_ena_per_port (port_id)
-For example, to get symmetric hash enable configuration of port 1.
+For example, to get symmetric hash enable configuration of port 1::
-.. code-block:: console
-
- testpmd> get_sym_hash_ena_per_port 1
+ testpmd> get_sym_hash_ena_per_port 1
set_sym_hash_ena_per_port
~~~~~~~~~~~~~~~~~~~~~~~~~
-Set symmetric hash enable configuration per port to enable or disable.
-
-set_sym_hash_ena_per_port (port_id) (enable|disable)
+Set symmetric hash enable configuration per port to enable or disable::
-For example, to set symmetric hash enable configuration of port 1 to enable.
+ set_sym_hash_ena_per_port (port_id) (enable|disable)
-.. code-block:: console
+For example, to set symmetric hash enable configuration of port 1 to enable::
- testpmd> set_sym_hash_ena_per_port 1 enable
+ testpmd> set_sym_hash_ena_per_port 1 enable
get_hash_global_config
~~~~~~~~~~~~~~~~~~~~~~
-Get the global configurations of hash filters.
-
-get_hash_global_config (port_id)
+Get the global configurations of hash filters::
-For example, to get the global configurations of hash filters of port 1.
+ get_hash_global_config (port_id)
-.. code-block:: console
+For example, to get the global configurations of hash filters of port 1::
- testpmd> get_hash_global_config 1
+ testpmd> get_hash_global_config 1
set_hash_global_config
~~~~~~~~~~~~~~~~~~~~~~
-Set the global configurations of hash filters.
+Set the global configurations of hash filters::
-set_hash_global_config (port_id) (toeplitz|simple_xor|default)
-(ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload)
-(enable|disable)
+ set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
+ (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
+ ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
+ (enable|disable)
-For example, to enable simple_xor for flow type of ipv6 on port 2.
-
-.. code-block:: console
+For example, to enable simple_xor for flow type of ipv6 on port 2::
- testpmd> set_hash_global_config 2 simple_xor ipv6 enable
+ testpmd> set_hash_global_config 2 simple_xor ipv6 enable
--
1.8.1.4
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
2015-09-28 19:45 [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide John McNamara
@ 2015-10-01 16:26 ` De Lara Guarch, Pablo
2015-10-23 8:36 ` Mcnamara, John
2015-10-26 14:36 ` Thomas Monjalon
0 siblings, 2 replies; 4+ messages in thread
From: De Lara Guarch, Pablo @ 2015-10-01 16:26 UTC (permalink / raw)
To: Mcnamara, John, dev
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> Sent: Monday, September 28, 2015 8:46 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
>
> Fix a number of RST issues in the testpmd user guide and
> refactored the structure to:
>
> * Remove redundant roadmap section.
> * Merge Overview section into Introduction.
> * Move "set fwd" to the start of its section.
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
2015-10-01 16:26 ` De Lara Guarch, Pablo
@ 2015-10-23 8:36 ` Mcnamara, John
2015-10-26 14:36 ` Thomas Monjalon
1 sibling, 0 replies; 4+ messages in thread
From: Mcnamara, John @ 2015-10-23 8:36 UTC (permalink / raw)
To: De Lara Guarch, Pablo, dev
> -----Original Message-----
> From: De Lara Guarch, Pablo
> Sent: Thursday, October 1, 2015 5:27 PM
> To: Mcnamara, John; dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
>
>
>
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara
> > Sent: Monday, September 28, 2015 8:46 PM
> > To: dev@dpdk.org
> > Subject: [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
> >
> > Fix a number of RST issues in the testpmd user guide and refactored
> > the structure to:
> >
> > * Remove redundant roadmap section.
> > * Merge Overview section into Introduction.
> > * Move "set fwd" to the start of its section.
> >
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
>
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Hi,
I know docs are low priority but can we get this one merged since there are other pending software changes to testpmd with flow director and when we add documentation for them it would be better if they were in the updated, clearer, format.
John.
--
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide
2015-10-01 16:26 ` De Lara Guarch, Pablo
2015-10-23 8:36 ` Mcnamara, John
@ 2015-10-26 14:36 ` Thomas Monjalon
1 sibling, 0 replies; 4+ messages in thread
From: Thomas Monjalon @ 2015-10-26 14:36 UTC (permalink / raw)
To: Mcnamara, John; +Cc: dev
> > Fix a number of RST issues in the testpmd user guide and
> > refactored the structure to:
> >
> > * Remove redundant roadmap section.
> > * Merge Overview section into Introduction.
> > * Move "set fwd" to the start of its section.
> >
> > Signed-off-by: John McNamara <john.mcnamara@intel.com>
>
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Applied, thanks
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2015-10-26 14:37 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-09-28 19:45 [dpdk-dev] [PATCH] doc: fix rst issues in testpmd user guide John McNamara
2015-10-01 16:26 ` De Lara Guarch, Pablo
2015-10-23 8:36 ` Mcnamara, John
2015-10-26 14:36 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).