.. BSD LICENSE
- Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
+ Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
All rights reserved.
Redistribution and use in source and binary forms, with or without
(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 (including the extended NIC
+statistics aka xstats) , 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|xstats|fdir|stat_qmap|dcb_tc|cap X
+ info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
+ stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
+ stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
+ ...
+
+
+.. note::
+
+ Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
- 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
- ...
+ 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
--------------
.. 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.
+
+
+Command File Functions
+----------------------
+
+To facilitate loading large number of commands or to avoid cutting and pasting where not
+practical or possible testpmd supports alternative methods for executing commands.
+
+* If started with the ``--cmdline-file=FILENAME`` command line argument testpmd
+ will execute all CLI commands contained within the file immediately before
+ starting packet forwarding or entering interactive mode.
+
+.. code-block:: console
+
+ ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
+ Interactive-mode selected
+ CLI commands to be read from /home/ubuntu/flow-create-commands.txt
+ Configuring Port 0 (socket 0)
+ Port 0: 7C:FE:90:CB:74:CE
+ Configuring Port 1 (socket 0)
+ Port 1: 7C:FE:90:CB:74:CA
+ Checking link statuses...
+ Port 0 Link Up - speed 10000 Mbps - full-duplex
+ Port 1 Link Up - speed 10000 Mbps - full-duplex
+ Done
+ Flow rule #0 created
+ Flow rule #1 created
+ ...
+ ...
+ Flow rule #498 created
+ Flow rule #499 created
+ Read all CLI commands from /home/ubuntu/flow-create-commands.txt
+ testpmd>
+
+
+* At run-time additional commands can be loaded in bulk by invoking the ``load FILENAME``
+ command.
+
+.. code-block:: console
+
+ testpmd> load /home/ubuntu/flow-create-commands.txt
+ Flow rule #0 created
+ Flow rule #1 created
+ ...
+ ...
+ Flow rule #498 created
+ Flow rule #499 created
+ Read all CLI commands from /home/ubuntu/flow-create-commands.txt
+ testpmd>
+
+
+In all cases output from any included command will be displayed as standard output.
+Execution will continue until the end of the file is reached regardless of
+whether any errors occur. The end user must examine the output to determine if
+any failures occurred.
- 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 flowdir : Flow Director filter help.
- help registers : Reading and setting port registers.
- help filters : Filters configuration help.
- help all : All of the above sections.
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 specified number of bursts of packets::
-start tx_first
+ testpmd> start tx_first (""|burst_num)
+
+The default burst number is 1 when ``burst_num`` not presented.
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
-----------------
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|xstats|fdir|stat_qmap|dcb_tc|cap) (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.
+* ``xstats``: RX/TX extended NIC statistics.
-stat_qmap : Queue statistics mapping.
+* ``fdir``: Flow Director information and statistics.
-For example:
+* ``stat_qmap``: Queue statistics mapping.
-.. code-block:: console
+* ``dcb_tc``: DCB information such as TC mapping.
+
+* ``cap``: Supported offload capabilities.
- testpmd> show port info 0
+For example:
- ********************* Infos for port 0 *********************
+.. code-block:: console
- MAC address: XX:XX:XX:XX:XX:XX
- Link status: up
- Link speed: 10000 Mbps
- Link duplex: full-duplex
- Promiscuous mode: enabled
- Allmulticast mode: disabled
- Maximum number of MAC addresses: 127
- VLAN offload:
- strip on
- filter on
- qinq(extend) off
+ 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
+ port
+ vxlan
+ geneve
+ nvgre
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 port (port_id).
+Display the RSS hash functions and RSS hash key of a port::
-show port (port_id) rss-hash [key] clear port
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ testpmd> show port (port_id) rss-hash ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex [key]
-Clear the port statistics for a given port or for all ports:
+clear port
+~~~~~~~~~~
-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|xstats|fdir|stat_qmap) (port_id|all)
-.. code-block:: console
+For example::
+
+ testpmd> clear port stats all
+
+show (rxq|txq)
+~~~~~~~~~~~~~~
- testpmd> clear port stats all
+Display information for a given port's RX/TX queue::
+
+ testpmd> show (rxq|txq) info (port_id) (queue_id)
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|txpkts)
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.
+* ``txpkts``: Packets to TX 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|macswap|flowgen| \
+ rxonly|txonly|csum|icmpecho) (""|retry)
+
+``retry`` can be specified for forwarding engines except ``rx_only``.
+
+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.
+ Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination
+ address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
+ 'eth-peer-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
+
+* ``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:
+Display an RX descriptor for a port RX queue::
-read rxd (port_id) (queue_id) (rxd_id)
+ testpmd> read rxd (port_id) (queue_id) (rxd_id)
-For example:
-
-.. 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
+ddp get list
+~~~~~~~~~~~~
+
+Get loaded dynamic device personalization (DDP) package info list::
+
+ testpmd> ddp get list (port_id)
+
+ddp get info
+~~~~~~~~~~~~
+
+Display information about dynamic device personalization (DDP) profile::
+
+ testpmd> ddp get info (profile_path)
+
+show vf stats
+~~~~~~~~~~~~~
+
+Display VF statistics::
+
+ testpmd> show vf stats (port_id) (vf_id)
+
+clear vf stats
+~~~~~~~~~~~~~~
+
+Reset VF statistics::
+
+ testpmd> clear vf stats (port_id) (vf_id)
+
+show port pctype mapping
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+List all items from the pctype mapping table::
+
+ testpmd> show port (port_id) pctype mapping
+
+
Configuration Functions
-----------------------
.. 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).
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.
+When retry is enabled, the transmit delay time and number of retries can also be set::
-set burst tx delay (micrseconds) retry (num)
+ testpmd> set burst tx delay (microseconds) 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 or length of packet for FLOWGEN mode::
-set txpkts (x[,y]*)
+ testpmd> set txpkts (x[,y]*)
Where x[,y]* represents a CSV list of values, without white space.
+set txsplit
+~~~~~~~~~~~
+
+Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
+
+ testpmd> set txsplit (off|on|rand)
+
+Where:
+
+* ``off`` disable packet copy & split for CSUM mode.
+
+* ``on`` split outgoing packet into multiple segments. Size of each segment
+ and number of segments per packet is determined by ``set txpkts`` command
+ (see above).
+
+* ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
+
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
+
+set tx loopback
+~~~~~~~~~~~~~~~
+
+Enable/disable tx loopback::
+
+ testpmd> set tx loopback (port_id) (on|off)
+
+set drop enable
+~~~~~~~~~~~~~~~
+
+set drop enable bit for all queues::
+
+ testpmd> set all queues drop (port_id) (on|off)
+
+set split drop enable (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+set split drop enable bit for VF from PF::
+
+ testpmd> set vf split drop (port_id) (vf_id) (on|off)
+
+set mac antispoof (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set mac antispoof for a VF from the PF::
+
+ testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
+
+set macsec offload
+~~~~~~~~~~~~~~~~~~
+
+Enable/disable MACsec offload::
+
+ testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
+ testpmd> set macsec offload (port_id) off
+
+set macsec sc
+~~~~~~~~~~~~~
+
+Configure MACsec secure connection (SC)::
+
+ testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
+
+.. note::
+
+ The pi argument is ignored for tx.
+ Check the NIC Datasheet for hardware limits.
- 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
+set macsec sa
+~~~~~~~~~~~~~
+
+Configure MACsec secure association (SA)::
+
+ testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
+
+.. note::
+
+ The IDX value must be 0 or 1.
+ Check the NIC Datasheet for hardware limits.
+
+set broadcast mode (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set broadcast mode for a VF from the PF::
+
+ testpmd> set vf broadcast (port_id) (vf_id) (on|off)
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::
+
+ testpmd> vlan set stripq (on|off) (port_id,queue_id)
+
+vlan set stripq (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set VLAN strip for all queues in a pool for a VF from the PF::
+
+ testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
+
+vlan set insert (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set VLAN insert for a VF from the PF::
+
+ testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
+
+vlan set tag (for VF)
+~~~~~~~~~~~~~~~~~~~~~
+
+Set VLAN tag for a VF from the PF::
+
+ testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
+
+vlan set antispoof (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set VLAN antispoof for a VF from the PF::
-vlan set stripq (on|off) (port_id,queue_id)
+ testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
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 inner or outer VLAN TPID for packet filtering on a port::
-vlan set tpid (value) (port_id)
+ testpmd> vlan set (inner|outer) 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.
+ 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::
+
+ testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
+
+rx_vlan rm (for VF)
~~~~~~~~~~~~~~~~~~~
-Add a VLAN ID, to 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 add (vlan_id) port (port_id) vf (vf_mask)
+ testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
-rx_vlan rm(for VF)
-~~~~~~~~~~~~~~~~~~
+tunnel_filter add
+~~~~~~~~~~~~~~~~~
-Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:
+Add a tunnel filter on a port::
-rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
+ testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
+ (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
+ imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
-tx_rate (for Queue)
-~~~~~~~~~~~~~~~~~~~
+The available information categories are:
-Set TX rate limitation for queue of a port ID:
+* ``vxlan``: Set tunnel type as VXLAN.
-set port (port_id) queue (queue_id) rate (rate_value)
+* ``nvgre``: Set tunnel type as NVGRE.
-tx_rate (for VF)
-~~~~~~~~~~~~~~~~
+* ``ipingre``: Set tunnel type as IP-in-GRE.
-Set TX rate limitation for queues in VF of a port ID:
+* ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
-set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
+* ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
-rx_vlan set tpid
-~~~~~~~~~~~~~~~~
+* ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
-Set the outer VLAN TPID for packet filtering on a port:
+* ``imac``: Set filter type as Inner MAC.
-rx_vlan set tpid (value) (port_id)
+* ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
-tunnel_filter add
-~~~~~~~~~~~~~~~~~
+* ``oip``: Set filter type as Outer IP.
+
+* ``iip``: Set filter type as Inner IP.
-Add a tunnel filter on a port:
+Example::
-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 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
+ 192.168.2.2 0 ipingre oip 1 1
+
+ Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
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) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
+ imac-tenid|imac|omac-imac-tenid|oip|iip) (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 ID in packets sent on a port:
+Set hardware insertion of VLAN IDs in packets sent on a port::
+
+ testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
+
+For example, set a single VLAN ID (5) insertion on port 0::
+
+ tx_vlan set 0 5
+
+Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
+
+ tx_vlan set 1 2 3
-tx_vlan set (vlan_id) (port_id)
tx_vlan set pvid
~~~~~~~~~~~~~~~~
-Set port based hardware insertion of VLAN ID in pacekts 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)
-tx_checksum set mask
-~~~~~~~~~~~~~~~~~~~~
+csum set
+~~~~~~~~
+
+Select hardware or software calculation of the checksum when
+transmitting a packet using the ``csum`` forwarding engine::
+
+ testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
-Enable hardware insertion of checksum offload with a 4-bit mask, 0x0 - 0xF, in packets sent on a port:
+Where:
+
+* ``ip|udp|tcp|sctp`` always relate to the inner layer.
+
+* ``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::
-tx_checksum set (mask) (port_id)
+ Check the NIC Datasheet for hardware limits.
-The bits in the mask are:
+csum parse-tunnel
+~~~~~~~~~~~~~~~~~
-bit 0 - if set insert ip checksum offload
+Define how tunneled packets should be handled by the csum forward
+engine::
-bit 1 - if set insert udp checksum offload
+ testpmd> csum parse-tunnel (on|off) (tx_port_id)
-bit 2 - if set insert tcp checksum offload
+If enabled, the csum forward engine will try to recognize supported
+tunnel headers (vxlan, gre, ipip).
-bit 3 - if set insert sctp checksum offload
+If disabled, treat tunnel packets as non-tunneled packets (a inner
+header is handled as a packet payload).
.. note::
- Check the NIC Datasheet for hardware limits.
+ The port argument is the TX port like in the ``csum set`` command.
-tx_checksum show
-~~~~~~~~~~~~~~~~
+Example:
-Display tx checksum offload configuration:
+Consider a packet in packet like the following::
-tx_checksum show (port_id)
+ eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
+
+* 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::
+
+ 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::
- Please check the NIC datasheet for HW limits
+
+ Check the NIC datasheet for hardware limits.
tso show
~~~~~~~~
-Display the status of TCP Segmentation Offload:
+Display the status of TCP Segmentation Offload::
-tso show (port_id)
+ testpmd> tso show (port_id)
-set fwd
-~~~~~~~
+set port - gro
+~~~~~~~~~~~~~~
-Set the packet forwarding mode:
+Enable or disable GRO in ``csum`` forwarding engine::
-set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
+ testpmd> set port <port_id> gro on|off
-The available information categories are:
+If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
+packets received from the given port.
-* 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.
+If disabled, packets received from the given port won't be performed
+GRO. By default, GRO is disabled for all ports.
-* mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
+.. note::
-* mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
+ When enable GRO for a port, TCP/IPv4 packets received from the port
+ will be performed GRO. After GRO, all merged packets have bad
+ checksums, since the GRO library doesn't re-calculate checksums for
+ the merged packets. Therefore, if users want the merged packets to
+ have correct checksums, please select HW IP checksum calculation and
+ HW TCP checksum calculation for the port which the merged packets are
+ transmitted to.
-* macswap: MAC swap forwarding mode.
- Swaps the source and the destination Ethernet addresses of packets before forwarding them.
+show port - gro
+~~~~~~~~~~~~~~~
-* flowgen: multi-flow generation mode.
- Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
+Display GRO configuration for a given port::
-* rxonly: receives packets but doesn't transmit them.
+ testpmd> show port <port_id> gro
-* txonly: generates and transmits packets without receiving any.
+set gro flush
+~~~~~~~~~~~~~
-* csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
+Set the cycle to flush the GROed packets from reassembly tables::
-* icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
+ testpmd> set gro flush <cycles>
+When enable GRO, the csum forwarding engine performs GRO on received
+packets, and the GROed packets are stored in reassembly tables. Users
+can use this command to determine when the GROed packets are flushed
+from the reassembly tables.
-Example:
+The ``cycles`` is measured in GRO operation times. The csum forwarding
+engine flushes the GROed packets from the tables every ``cycles`` GRO
+operations.
-.. code-block:: console
+By default, the value of ``cycles`` is 1, which means flush GROed packets
+from the reassembly tables as soon as one GRO operation finishes. The value
+of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
+
+Please note that the large value of ``cycles`` may cause the poor TCP/IP
+stack performance. Because the GROed packets are delayed to arrive the
+stack, thus causing more duplicated ACKs and TCP retransmissions.
+
+set port - gso
+~~~~~~~~~~~~~~
+
+Toggle per-port GSO support in ``csum`` forwarding engine::
+
+ testpmd> set port <port_id> gso on|off
+
+If enabled, the csum forwarding engine will perform GSO on supported IPv4
+packets, transmitted on the given port.
+
+If disabled, packets transmitted on the given port will not undergo GSO.
+By default, GSO is disabled for all ports.
+
+.. note::
+
+ When GSO is enabled on a port, supported IPv4 packets transmitted on that
+ port undergo GSO. Afterwards, the segmented packets are represented by
+ multi-segment mbufs; however, the csum forwarding engine doesn't calculation
+ of checksums for GSO'd segments in SW. As a result, if users want correct
+ checksums in GSO segments, they should enable HW checksum calculation for
+ GSO-enabled ports.
+
+ For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
+ by setting the following options in the csum forwarding engine:
+
+ testpmd> csum set outer_ip hw <port_id>
+
+ testpmd> csum set ip hw <port_id>
+
+ testpmd> csum set tcp hw <port_id>
+
+set gso segsz
+~~~~~~~~~~~~~
- testpmd> set fwd rxonly
+Set the maximum GSO segment size (measured in bytes), which includes the
+packet header and the packet payload for GSO-enabled ports (global)::
- Set rxonly packet forwarding mode
+ testpmd> set gso segsz <length>
+
+show port - gso
+~~~~~~~~~~~~~~~
+
+Display the status of Generic Segmentation Offload for a given port::
+
+ testpmd> show port <port_id> gso
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)
-~~~~~~~~~~~~~~~~~~~~
+mac_addr add (for VF)
+~~~~~~~~~~~~~~~~~~~~~
+
+Add an alternative MAC address for a VF to a port::
+
+ testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
-Add an alternative MAC address for a VF to a port:
+mac_addr set
+~~~~~~~~~~~~
+
+Set the default MAC address for a port::
+
+ testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
+
+mac_addr set (for VF)
+~~~~~~~~~~~~~~~~~~~~~
+
+Set the MAC address for a VF from the PF::
-mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
+ testpmd> set vf mac addr (port_id) (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 promisc (for VF)
+~~~~~~~~~~~~~~~~~~~~
-Set the link flow control parameter on a port:
+Set the unicast promiscuous mode for a VF from PF.
+It's supported by Intel i40e NICs now.
+In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
-set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
-(pause_time) (send_xon) (port_id)
+ testpmd> set vf promisc (port_id) (vf_id) (on|off)
+
+set allmulticast (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set the multicast promiscuous mode for a VF from PF.
+It's supported by Intel i40e NICs now.
+In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
+
+ testpmd> set vf allmulti (port_id) (vf_id) (on|off)
+
+set tx max bandwidth (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set TX max absolute bandwidth (Mbps) for a VF from PF::
+
+ testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
+
+set tc tx min bandwidth (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set all TCs' TX min relative bandwidth (%) for a VF from PF::
+
+ testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
+
+set tc tx max bandwidth (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
+
+ testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
+
+set tc strict link priority mode
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set some TCs' strict link priority mode on a physical port::
+
+ testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
+
+set tc tx min bandwidth
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
+
+ testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
+
+set flow_ctrl rx
+~~~~~~~~~~~~~~~~
+
+Set the link flow control parameter on a port::
+
+ 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.
+
+* ``low_water`` (integer): Low threshold value to trigger XON.
+
+* ``pause_time`` (integer): Pause quota in the Pause frame.
+
+* ``send_xon`` (0/1): Send XON frame.
+
+* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
+
+* ``autoneg``: Change the auto-negotiation parameter.
+
+set pfc_ctrl rx
+~~~~~~~~~~~~~~~
+
+Set the priority flow control parameter on a port::
+
+ testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
+ (pause_time) (priority) (port_id)
+
+Where:
+
+* ``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::
+
+ testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
+
+For example, to set rx queue 2 on port 0 to mapping 5::
+
+ testpmd>set stat_qmap rx 0 2 5
+
+set port - rx/tx (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set VF receive/transmit from a port::
+
+ 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::
+
+ 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::
+
+ testpmd> set port (port_id) vf (vf_id) \
+ rxmode (AUPE|ROPE|BAM|MPE) (on|off)
+
+The available receive modes are:
+
+* ``AUPE``: Accepts untagged VLAN.
+
+* ``ROPE``: Accepts unicast hash.
+
+* ``BAM``: Accepts broadcast packets.
+
+* ``MPE``: Accepts all multicast packets.
+
+set port - tx_rate (for Queue)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set TX rate limitation for a queue on a port::
+
+ 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 on a port::
+
+ 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::
+
+ 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::
+
+ 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::
+
+ 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::
+
+ testpmd> reset port (port_id) mirror-rule (rule_id)
+
+set flush_rx
+~~~~~~~~~~~~
+
+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::
+
+ testpmd> set flush_rx off
+
+set bypass mode
+~~~~~~~~~~~~~~~
+
+Set the bypass mode for the lowest port on bypass enabled NIC::
+
+ 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::
+
+ testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
+ mode (normal|bypass|isolate) (port_id)
+
+Where:
+
+* ``timeout``: Enable bypass after watchdog timeout.
+
+* ``os_on``: Enable bypass when OS/board is powered on.
+
+* ``os_off``: Enable bypass when OS/board is powered off.
+
+* ``power_on``: Enable bypass when power supply is turned on.
+
+* ``power_off``: Enable bypass when power supply is turned off.
+
+
+set bypass timeout
+~~~~~~~~~~~~~~~~~~
+
+Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
+
+ 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::
+
+ testpmd> show bypass config (port_id)
+
+set link up
+~~~~~~~~~~~
+
+Set link up for a port::
+
+ testpmd> set link-up port (port id)
+
+set link down
+~~~~~~~~~~~~~
+
+Set link down for a port::
+
+ testpmd> set link-down port (port id)
+
+E-tag set
+~~~~~~~~~
+
+Enable E-tag insertion for a VF on a port::
+
+ testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
+
+Disable E-tag insertion for a VF on a port::
+
+ testpmd> E-tag set insertion off port (port_id) vf (vf_id)
+
+Enable/disable E-tag stripping on a port::
+
+ testpmd> E-tag set stripping (on|off) port (port_id)
+
+Enable/disable E-tag based forwarding on a port::
+
+ testpmd> E-tag set forwarding (on|off) port (port_id)
+
+Add an E-tag forwarding filter on a port::
+
+ testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
+
+Delete an E-tag forwarding filter on a port::
+ testpmd> E-tag set filter del e-tag-id (value) port (port_id)
+
+ddp add
+~~~~~~~
+
+Load a dynamic device personalization (DDP) package::
+
+ testpmd> ddp add (port_id) (package_path[,output_path])
+
+ddp del
+~~~~~~~
+
+Delete a dynamic device personalization package::
+
+ testpmd> ddp del (port_id) (package_path)
+
+ptype mapping
+~~~~~~~~~~~~~
+
+List all items from the ptype mapping table::
+
+ testpmd> ptype mapping get (port_id) (valid_only)
+
+Where:
+
+* ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
+
+Replace a specific or a group of software defined ptype with a new one::
+
+ testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
+
+where:
+
+* ``target``: A specific software ptype or a mask to represent a group of software ptypes.
+
+* ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
+
+* ``pkt_type``: The new software ptype to replace the old ones.
+
+Update hardware defined ptype to software defined packet type mapping table::
+
+ testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
+
+where:
+
+* ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
+
+* ``sw_ptype``: software ptype as the value of the ptype mapping table.
+
+Reset ptype mapping table::
+
+ testpmd> ptype mapping reset (port_id)
+
+Port Functions
+--------------
+
+The following sections show functions for configuring ports.
+
+.. note::
+
+ Port configuration changes only become active when forwarding is started/restarted.
+
+port attach
+~~~~~~~~~~~
+
+Attach a port specified by pci address or virtual device args::
+
+ testpmd> port attach (identifier)
+
+To attach a new pci device, the device should be recognized by kernel first.
+Then it should be moved under DPDK management.
+Finally the port can be attached to testpmd.
+
+For example, to move a pci device using ixgbe under DPDK management:
+
+.. code-block:: console
+
+ # Check the status of the available devices.
+ ./usertools/dpdk-devbind.py --status
+
+ Network devices using DPDK-compatible driver
+ ============================================
+ <none>
+
+ Network devices using kernel driver
+ ===================================
+ 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
+
+
+ # Bind the device to igb_uio.
+ sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
+
+
+ # Recheck the status of the devices.
+ ./usertools/dpdk-devbind.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.
+
+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
+
+For example, to attach a port created by pcap PMD.
+
+.. code-block:: console
+
+ testpmd> port attach net_pcap0
+ Attaching a new port...
+ PMD: Initializing pmd_pcap for net_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 ``net_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 net_bond_0,mode=0,slave=1
+ Attaching a new port...
+ EAL: Initializing pmd_bond for net_bond_0
+ EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
+ Port 0 is attached. Now total ports is 1
+ Done
+
+
+port detach
+~~~~~~~~~~~
+
+Detach a specific port::
+
+ testpmd> port detach (port_id)
+
+Before detaching a port, the port should be stopped and closed.
+
+For example, to detach a pci device port 0.
+
+.. code-block:: console
+
+ testpmd> port stop 0
+ Stopping ports...
+ Done
+ 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 stop 0
+ Stopping ports...
+ Done
+ testpmd> port close 0
+ Closing ports...
+ Done
+
+ testpmd> port detach 0
+ Detaching a port...
+ PMD: Closing pcap ethdev on numa socket 0
+ Port 'net_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.
+Finally the device can be removed using kernel pci hotplug functionality.
+
+For example, to move a pci device under kernel management:
+
+.. code-block:: console
+
+ sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
+
+ ./usertools/dpdk-devbind.py --status
+
+ 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::
+
+ testpmd> port start (port_id|all)
+
+port stop
+~~~~~~~~~
+
+Stop all ports or a specific port::
+
+ testpmd> port stop (port_id|all)
+
+port close
+~~~~~~~~~~
+
+Close all ports or a specific port::
+
+ testpmd> port close (port_id|all)
+
+port start/stop queue
+~~~~~~~~~~~~~~~~~~~~~
+
+Start/stop a rx/tx queue on a specific port::
+
+ 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::
+
+ testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
+ duplex (half|full|auto)
+
+port config - queues/descriptors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set number of queues/descriptors for rxq, txq, rxd and txd::
+
+ testpmd> port config all (rxq|txq|rxd|txd) (value)
+
+This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
+
+port config - max-pkt-len
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set the maximum packet length::
+
+ testpmd> port config all max-pkt-len (value)
+
+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::
+
+ testpmd> port config all crc-strip (on|off)
+
+CRC stripping is on by default.
+
+The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option.
+
+port config - scatter
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Set RX scatter mode on or off for all ports::
+
+ testpmd> port config all scatter (on|off)
+
+RX scatter mode is off by default.
+
+The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
+
+port config - TX queue flags
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set a hexadecimal bitmap of TX queue flags for all ports::
+
+ testpmd> port config all txqflags value
+
+This command is equivalent to the ``--txqflags`` command-line option.
+
+port config - RX Checksum
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware RX checksum offload to on or off for all ports::
+
+ 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.
+
+port config - VLAN
+~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN on or off for all ports::
+
+ 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.
+
+port config - VLAN filter
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN filter on or off for all ports::
+
+ 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.
+
+port config - VLAN strip
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN strip on or off for all ports::
+
+ 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.
+
+port config - VLAN extend
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN extend on or off for all ports::
+
+ 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.
+
+port config - Drop Packets
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set packet drop for packets with no descriptors on or off for all ports::
+
+ 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.
+
+port config - RSS
+~~~~~~~~~~~~~~~~~
+
+Set the RSS (Receive Side Scaling) mode on or off::
+
+ testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none)
+
+RSS is on by default.
+
+The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
+
+port config - RSS Reta
+~~~~~~~~~~~~~~~~~~~~~~
+
+Set the RSS (Receive Side Scaling) redirection table::
+
+ testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
+
+port config - DCB
+~~~~~~~~~~~~~~~~~
+
+Set the DCB mode for an individual port::
+
+ 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::
+
+ testpmd> port config all burst (value)
+
+This is equivalent to the ``--burst`` command-line option.
+
+port config - Threshold
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Set thresholds for TX/RX queues::
+
+ 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.
+
+* ``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.
+
+* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
+
+* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
+
+* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
+
+* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
+
+* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
+
+* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
+
+These threshold options are also available from the command-line.
+
+port config - E-tag
+~~~~~~~~~~~~~~~~~~~
+
+Set the value of ether-type for E-tag::
+
+ testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
+
+Enable/disable the E-tag support::
+
+ testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
+
+port config pctype mapping
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Reset pctype mapping table::
+
+ testpmd> port config (port_id) pctype mapping reset
+
+Update hardware defined pctype to software defined flow type mapping table::
+
+ testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
+
+where:
+
+* ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
+
+* ``flow_type_id``: software flow type id as the index of the pctype mapping table.
+
+
+Link Bonding Functions
+----------------------
+
+The Link Bonding functions make it possible to dynamically create and
+manage link bonding devices from within testpmd interactive prompt.
+
+create bonded device
+~~~~~~~~~~~~~~~~~~~~
+
+Create a new bonding device::
+
+ testpmd> create bonded device (mode) (socket)
+
+For example, to create a bonded device in mode 1 on socket 0::
+
+ testpmd> create bonded 1 0
+ created new bonded device (port X)
+
+add bonding slave
+~~~~~~~~~~~~~~~~~
+
+Adds Ethernet device to a Link Bonding device::
+
+ testpmd> add bonding slave (slave id) (port id)
+
+For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
+
+ testpmd> add bonding slave 6 10
-Where:
-high_water (integer): High threshold value to trigger XOFF.
+remove bonding slave
+~~~~~~~~~~~~~~~~~~~~
-low_water (integer) : Low threshold value to trigger XON.
+Removes an Ethernet slave device from a Link Bonding device::
-pause_time (integer): Pause quota in the Pause frame.
+ testpmd> remove bonding slave (slave id) (port id)
-send_xon (0/1) : Send XON frame.
+For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
-mac_ctrl_frame_fwd : Enable receiving MAC control frames
+ testpmd> remove bonding slave 6 10
-set pfc_ctrl rx
-~~~~~~~~~~~~~~~
+set bonding mode
+~~~~~~~~~~~~~~~~
-Set the priority flow control parameter on a port:
+Set the Link Bonding mode of a Link Bonding device::
-set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
+ testpmd> set bonding mode (value) (port id)
-Where:
+For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
-priority (0-7): VLAN User Priority.
+ testpmd> set bonding mode 3 10
-set stat_qmap
-~~~~~~~~~~~~~
+set bonding primary
+~~~~~~~~~~~~~~~~~~~
-Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
+Set an Ethernet slave device as the primary device on a Link Bonding device::
-set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
+ testpmd> set bonding primary (slave id) (port id)
-For example, to set rx queue 2 on port 0 to mapping 5:
+For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
-.. code-block:: console
+ testpmd> set bonding primary 6 10
- testpmd>set stat_qmap rx 0 2 5
+set bonding mac
+~~~~~~~~~~~~~~~
-set port - rx/tx(for VF)
-~~~~~~~~~~~~~~~~~~~~~~~~
+Set the MAC address of a Link Bonding device::
-Set VF receive/transmit from a port:
+ testpmd> set bonding mac (port id) (mac)
-set port (port_id) vf (vf_id) (rx|tx) (on|off)
+For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
-set port - mac address filter (for VF)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ testpmd> set bonding mac 10 00:00:00:00:00:01
-Add/Remove unicast or multicast MAC addr filter for a VF:
+set bonding xmit_balance_policy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-set port (port_id) vf (vf_id) (mac_addr)
- (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
+Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
-set port - rx mode(for VF)
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+ testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
-Set the VF receive mode of a port:
+For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
-set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
+ testpmd> set bonding xmit_balance_policy 10 l34
-The available receive modes are:
-* AUPE: accepts untagged VLAN.
+set bonding mon_period
+~~~~~~~~~~~~~~~~~~~~~~
-* ROPE: accepts unicast hash.
+Set the link status monitoring polling period in milliseconds for a bonding device.
-* BAM: accepts broadcast packets
+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::
-* MPE: accepts all multicast packets
+ testpmd> set bonding mon_period (port_id) (value)
-set port - mirror rule
-~~~~~~~~~~~~~~~~~~~~~~
+For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
-Set port or vlan type mirror rule for a port.
+ testpmd> set bonding mon_period 5 150
-set port (port_id) mirror-rule (rule_id) (pool-mirror|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
-For example to enable mirror traffic with vlan 0,1 to pool 0:
+set bonding lacp dedicated_queue
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. code-block:: console
+Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
+when in mode 4 (link-aggregration-802.3ad)::
- set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
+ testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
-reset port - mirror rule
-~~~~~~~~~~~~~~~~~~~~~~~~
-Reset a mirror rule for a port.
+set bonding agg_mode
+~~~~~~~~~~~~~~~~~~~~
-reset port (port_id) mirror-rule (rule_id)
+Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad)::
-set flush_rx
-~~~~~~~~~~~~
+ testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
-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 flush_rx off
+show bonding config
+~~~~~~~~~~~~~~~~~~~
-set bypass mode
-~~~~~~~~~~~~~~~
+Show the current configuration of a Link Bonding device::
-Set the bypass mode for the lowest port on bypass enabled NIC.
+ testpmd> show bonding config (port id)
-set bypass mode (normal|bypass|isolate) (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::
-set bypass event
-~~~~~~~~~~~~~~~~
+ 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]
-Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
-* timeout: enable bypass after watchdog timeout.
+Register Functions
+------------------
-* os_on: enable bypass when OS/board is powered on.
+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.
-* os_off: enable bypass when OS/board is powered off.
+read reg
+~~~~~~~~
-* power_on: enable bypass when power supply is turned on.
+Display the value of a port register::
-* power_off: enable bypass when power supply is turned off.
+ testpmd> read reg (port_id) (address)
-set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
+For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
-set bypass timeout
-~~~~~~~~~~~~~~~~~~
+ testpmd> read reg 0 0xEE00
+ port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
-Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
+read regfield
+~~~~~~~~~~~~~
-set bypass timeout (0|1.5|2|3|4|8|16|32)
+Display a port register bit field::
-show bypass config
-~~~~~~~~~~~~~~~~~~
+ testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
-Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
+For example, reading the lowest two bits from the register in the example above::
-show bypass config (port_id)
+ testpmd> read regfield 0 0xEE00 0 1
+ port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
-add_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
+read regbit
+~~~~~~~~~~~
-Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
+Display a single port register bit::
-add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
+ testpmd> read regbit (port_id) (address) (bit_x)
-The available information parameters are:
+For example, reading the lowest bit from the register in the example above::
-* port_id: the port which the Ethertype filter assigned on.
+ testpmd> read regbit 0 0xEE00 0
+ port 0 PCI register at offset 0xEE00: bit 0=1
-* eth_value: the EtherType value want to match,
- for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
+write reg
+~~~~~~~~~
-* enable: user priority participates in the match.
+Set the value of a port register::
-* disable: user priority doesn't participate in the match.
+ testpmd> write reg (port_id) (address) (value)
-* pri_value: user priority value that want to match.
+For example, to clear a register::
-* queue_id : The receive queue associated with this EtherType filter
+ testpmd> write reg 0 0xEE00 0x0
+ port 0 PCI register at offset 0xEE00: 0x00000000 (0)
-* index: the index of this EtherType filter
+write regfield
+~~~~~~~~~~~~~~
-Example:
+Set bit field of a port register::
-.. code-block:: console
+ testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
- testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
- Assign ARP packet to receive queue 3
+For example, writing to the register cleared in the example above::
-remove_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~~~~
+ testpmd> write regfield 0 0xEE00 0 1 2
+ port 0 PCI register at offset 0xEE00: 0x00000002 (2)
-Remove a L2 Ethertype filter
+write regbit
+~~~~~~~~~~~~
-remove_ethertype_filter (port_id) index (idx)
+Set single bit value of a port register::
-get_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
+ testpmd> write regbit (port_id) (address) (bit_x) (value)
-Get and display a L2 Ethertype filter
+For example, to set the high bit in the register from the example above::
-get_ethertype_filter (port_id) index (idx)
+ testpmd> write regbit 0 0xEE00 31 1
+ port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
-Example:
-.. code-block:: console
+Filter Functions
+----------------
- testpmd> get_ethertype_filter 0 index 0
+This section details the available filter functions that are available.
- filter[0]:
- ethertype: 0x0806
- priority: disable, 0
- queue: 3
+Note these functions interface the deprecated legacy filtering framework,
+superseded by *rte_flow*. See `Flow rules management`_.
-add_2tuple_filter
-~~~~~~~~~~~~~~~~~
+ethertype_filter
+~~~~~~~~~~~~~~~~~~~~
-Add a 2-tuple filter,
-which identify packets by specific protocol and destination TCP/UDP port
-and forwards packets into one of the receive queues.
+Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
-add_2tuple_filter (port_id) protocol (pro_value) (pro_mask) dst_port (port_value) (port_mask)
-flags (flg_value) priority (prio_value) queue (queue_id) index (idx)
+ 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 2-tuple filter assigned on.
+* ``port_id``: The port which the Ethertype filter assigned on.
-* pro_value: IP L4 protocol
+* ``mac_addr``: Compare destination mac address.
-* pro_mask: protocol participates in the match or not, 1 means participate
+* ``mac_ignr``: Ignore destination mac address match.
-* port_value: destination port in L4.
+* ``mac_address``: Destination mac address to match.
-* port_mask: destination port participates in the match or not, 1 means participate.
+* ``ether_type``: The EtherType value want to match,
+ for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
-* flg_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
+* ``queue_id``: The receive queue associated with this EtherType filter.
+ It is meaningless when deleting or dropping.
-* prio_value: the priority of this filter.
+Example, to add/remove an ethertype filter rule::
-* queue_id: The receive queue associated with this 2-tuple filter
+ testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
+ ethertype 0x0806 fwd queue 3
-* index: the index of this 2-tuple filter
+ testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
+ ethertype 0x0806 fwd queue 3
-Example:
+2tuple_filter
+~~~~~~~~~~~~~~~~~
-.. code-block:: console
+Add or delete a 2-tuple filter,
+which identifies packets by specific protocol and destination TCP/UDP port
+and forwards packets into one of the receive queues::
- testpmd> add_2tuple_filter 0 protocol 0x06 1 dst_port 32 1 flags 0x02 priority 3 queue 3 index 0
+ 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)
-remove_2tuple_filter
-~~~~~~~~~~~~~~~~~~~~
+The available information parameters are:
-Remove a 2-tuple filter
+* ``port_id``: The port which the 2-tuple filter assigned on.
-remove_2tuple_filter (port_id) index (idx)
+* ``dst_port_value``: Destination port in L4.
-get_2tuple_filter
-~~~~~~~~~~~~~~~~~
+* ``protocol_value``: IP L4 protocol.
-Get and display a 2-tuple filter
+* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
-get_2tuple_filter (port_id) index (idx)
+* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
-Example:
+* ``prio_value``: Priority of this filter.
-.. code-block:: console
+* ``queue_id``: The receive queue associated with this 2-tuple filter.
+
+Example, to add/remove an 2tuple filter rule::
- testpmd> get_2tuple_filter 0 index 0
+ testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
+ tcp_flags 0x02 priority 3 queue 3
- filter[0]:
- Destination Port: 0x0020 mask: 1
- protocol: 0x06 mask:1 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
-add_5tuple_filter
+5tuple_filter
~~~~~~~~~~~~~~~~~
-Add a 5-tuple 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::
-add_5tuple_filter (port_id) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
-protocol (protocol_value) mask (mask_value) flags (flags_value) priority (prio_value) queue (queue_id) index (idx)
+ 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
-* 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.
-* index: the index of this 5-tuple filter
+Example, to add/remove an 5tuple filter rule::
-Example:
-
-.. 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> add_5tuple_filter 1 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 index 0
+ 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
-remove_5tuple_filter
-~~~~~~~~~~~~~~~~~~~~
+syn_filter
+~~~~~~~~~~
-Remove a 5-tuple filter
+Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
-remove_5tuple_filter (port_id) index (idx)
+ syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
-get_5tuple_filter
-~~~~~~~~~~~~~~~~~
+The available information parameters are:
-Get and display a 5-tuple filter
+* ``port_id``: The port which the SYN filter assigned on.
-get_5tuple_filter (port_id) index (idx)
+* ``high``: This SYN filter has higher priority than other filters.
-Example:
+* ``low``: This SYN filter has lower priority than other filters.
-.. code-block:: console
+* ``queue_id``: The receive queue associated with this SYN filter
- testpmd> get_5tuple_filter 1 index 0
+Example::
- filter[0]:
- Destination IP: 0x02020205 mask: 1
- Source IP: 0x02020204 mask: 1
- Destination Port: 0x0040 mask: 1
- Source Port: 0x0020 mask: 1
- protocol: 0x06 mask: 1
- priority: 3 flags: 0x00 queue: 3
+ testpmd> syn_filter 0 add priority high queue 3
-add_syn_filter
-~~~~~~~~~~~~~~
+flex_filter
+~~~~~~~~~~~
-Add SYN filter, which can forward TCP packets whose *SYN* flag is set into a separate queue.
+With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
+and routed into one of the receive queues::
-add_syn_filter (port_id) priority (high|low) 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 SYN filter assigned on.
+* ``port_id``: The port which the Flex filter is assigned on.
-* high: this SYN filter has higher priority than other filters.
+* ``len_value``: Filter length in bytes, no greater than 128.
-* low: this SYN filter has lower priority than other filters.
+* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
-* queue_id: The receive queue associated with this SYN filter
+* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
-Example:
+* ``prio_value``: The priority of this filter.
-.. code-block:: console
+* ``queue_id``: The receive queue associated with this Flex filter.
- testpmd> add_syn_filter 0 priority high queue 3,
+Example::
-remove_syn_filter
-~~~~~~~~~~~~~~~~~
+ testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
+ mask 000C priority 3 queue 3
-Remove SYN filter
+ testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
+ mask 000C priority 3 queue 3
-remove_syn_filter (port_id)
-get_syn_filter
-~~~~~~~~~~~~~~
+.. _testpmd_flow_director:
-Get and display SYN filter
+flow_director_filter
+~~~~~~~~~~~~~~~~~~~~
-get_syn_filter (port_id)
+The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
-Example:
+Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
+Perfect-tunnel filters, the match mode 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.
+ The masked fields are for IP flow.
+
+* Signature filters.
+ The hardware checks a match between a hash-based signature of the masked fields of the received packet.
+
+* Perfect-mac-vlan match filters.
+ The hardware checks a match between the masked fields of the received packets and the programmed filters.
+ The masked fields are for MAC VLAN flow.
+
+* Perfect-tunnel match filters.
+ The hardware checks a match between the masked fields of the received packets and the programmed filters.
+ The masked fields are for tunnel flow.
+
+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
+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::
+
+ flow_director_filter (port_id) mode IP (add|del|update) \
+ flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
+ src (src_ip_address) dst (dst_ip_address) \
+ tos (tos_value) proto (proto_value) ttl (ttl_value) \
+ vlan (vlan_value) flexbytes (flexbytes_value) \
+ (drop|fwd) pf|vf(vf_id) queue (queue_id) \
+ fd_id (fd_id_value)
+
+ flow_director_filter (port_id) mode IP (add|del|update) \
+ flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
+ src (src_ip_address) (src_port) \
+ dst (dst_ip_address) (dst_port) \
+ tos (tos_value) ttl (ttl_value) \
+ vlan (vlan_value) flexbytes (flexbytes_value) \
+ (drop|fwd) queue pf|vf(vf_id) (queue_id) \
+ fd_id (fd_id_value)
+
+ flow_director_filter (port_id) mode IP (add|del|update) \
+ flow (ipv4-sctp|ipv6-sctp) \
+ src (src_ip_address) (src_port) \
+ dst (dst_ip_address) (dst_port) \
+ tos (tos_value) ttl (ttl_value) \
+ tag (verification_tag) vlan (vlan_value) \
+ flexbytes (flexbytes_value) (drop|fwd) \
+ pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
+
+ flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
+ ether (ethertype) flexbytes (flexbytes_value) \
+ (drop|fwd) pf|vf(vf_id) queue (queue_id)
+ fd_id (fd_id_value)
+
+ flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
+ mac (mac_address) vlan (vlan_value) \
+ flexbytes (flexbytes_value) (drop|fwd) \
+ queue (queue_id) fd_id (fd_id_value)
+
+ flow_director_filter (port_id) mode Tunnel (add|del|update) \
+ mac (mac_address) vlan (vlan_value) \
+ tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
+ flexbytes (flexbytes_value) (drop|fwd) \
+ queue (queue_id) fd_id (fd_id_value)
+
+For example, to add an ipv4-udp flow type filter::
+
+ testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
+ dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
+ fwd pf queue 1 fd_id 1
+
+For example, add an ipv4-other flow type filter::
+
+ testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
+ dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
+ flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
+
+flush_flow_director
+~~~~~~~~~~~~~~~~~~~
-.. code-block:: console
+Flush all flow director filters on a device::
- testpmd> get_syn_filter 0
+ testpmd> flush_flow_director (port_id)
- syn filter: on, priority: high, queue: 3
+Example, to flush all flow director filter on port 0::
-add_flex_filter
-~~~~~~~~~~~~~~~
+ testpmd> flush_flow_director 0
-Add a Flex filter,
-which recognizes any arbitrary pattern within the first 128 bytes of the packet
-and routes packets into one of the receive queues.
+flow_director_mask
+~~~~~~~~~~~~~~~~~~
-add_flex_filter (port_id) len (len_value) bytes (bytes_string) mask (mask_value)
-priority (prio_value) queue (queue_id) index (idx)
+Set flow director's input masks::
-The available information parameters are:
+ flow_director_mask (port_id) mode IP vlan (vlan_value) \
+ src_mask (ipv4_src) (ipv6_src) (src_port) \
+ dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
-* port_id: the port which the Flex filter assigned on.
+ flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
-* len_value: filter length in byte, no greater than 128.
+ flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
+ mac (mac_value) tunnel-type (tunnel_type_value) \
+ tunnel-id (tunnel_id_value)
-* bytes_string: a sting in format of octal, means the value the flex filter need to match.
+Example, to set flow director mask on port 0::
-* mask_value: a sting in format of octal, bit 1 means corresponding byte in DWORD participates in the match.
+ testpmd> flow_director_mask 0 mode IP 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
-* prio_value: the priority of this filter.
+flow_director_flex_mask
+~~~~~~~~~~~~~~~~~~~~~~~
-* queue_id: The receive queue associated with this Flex filter.
+set masks of flow director's flexible payload based on certain flow type::
-* index: the index of this Flex filter
+ 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:
+Example, to set flow director's flex mask for all flow type on port 0::
-.. code-block:: console
+ 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> add_flex_filter 0 len 16 bytes 0x00000000000000000000000008060000 mask 000C priority 3 queue 3 index 0
-Assign a packet whose 13th and 14th bytes are 0x0806 to queue 3.
+flow_director_flex_payload
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-remove_flex_filter
-~~~~~~~~~~~~~~~~~~
+Configure flexible payload selection::
-Remove a Flex filter
+ flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
-remove_flex_filter (port_id) index (idx)
+For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
-get_flex_filter
-~~~~~~~~~~~~~~~
+ testpmd> flow_director_flex_payload 0 l4 \
+ (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
-Get and display a Flex filter
+get_sym_hash_ena_per_port
+~~~~~~~~~~~~~~~~~~~~~~~~~
-get_flex_filter (port_id) index (idx)
+Get symmetric hash enable configuration per port::
-Example:
+ get_sym_hash_ena_per_port (port_id)
-.. code-block:: console
+For example, to get symmetric hash enable configuration of port 1::
- testpmd> get_flex_filter 0 index 0
+ testpmd> get_sym_hash_ena_per_port 1
- filter[0]:
+set_sym_hash_ena_per_port
+~~~~~~~~~~~~~~~~~~~~~~~~~
- length: 16
+Set symmetric hash enable configuration per port to enable or disable::
- dword[]: 0x00000000 00000000 00000000 08060000 00000000 00000000 00000000
- 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
- 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
- 00000000 00000000 00000000 00000000 00000000 00000000 00000000
+ set_sym_hash_ena_per_port (port_id) (enable|disable)
- mask[]:
- 0b0000000000001100000000000000000000000000000000000000000000000000000000
- 0000000000000000000000000000000000000000000000000000000000
+For example, to set symmetric hash enable configuration of port 1 to enable::
- priority: 3 queue: 3
+ testpmd> set_sym_hash_ena_per_port 1 enable
-set link up
-~~~~~~~~~~~
+get_hash_global_config
+~~~~~~~~~~~~~~~~~~~~~~
-Set link up for a port.
+Get the global configurations of hash filters::
-set link-up port (port id)
+ get_hash_global_config (port_id)
-set link down
-~~~~~~~~~~~~~
+For example, to get the global configurations of hash filters of port 1::
-Set link down for a port.
+ testpmd> get_hash_global_config 1
-set link-down port (port id)
+set_hash_global_config
+~~~~~~~~~~~~~~~~~~~~~~
-Port Functions
---------------
+Set the global configurations of hash filters::
-The following sections show functions for configuring ports.
+ 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)
-.. note::
+For example, to enable simple_xor for flow type of ipv6 on port 2::
- Port configuration changes only become active when forwarding is started/restarted.
+ testpmd> set_hash_global_config 2 simple_xor ipv6 enable
-port start
-~~~~~~~~~~
+set_hash_input_set
+~~~~~~~~~~~~~~~~~~
-Start all ports or a specific port:
+Set the input set for hash::
-port start (port_id|all)
+ set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
+ ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
+ l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
+ ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
+ tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
+ udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
+ fld-8th|none) (select|add)
-port stop
-~~~~~~~~~
+For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
-Stop all ports or a specific port:
+ testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
-port stop (port_id|all)
+set_fdir_input_set
+~~~~~~~~~~~~~~~~~~
-port close
-~~~~~~~~~~
+The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
+on per flow type and the flexible payload. This command can be used to change input set for each flow type.
-Close all ports or a specific port:
+Set the input set for flow director::
-port close (port_id|all)
+ set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
+ ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
+ l2_payload) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
+ ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
+ tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
+ sctp-dst-port|sctp-veri-tag|none) (select|add)
-port start/stop queue
-~~~~~~~~~~~~~~~~~~~~~
+For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
-Start/stop a rx/tx queue on a specific port:
+ testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
-port (port_id) (rxq|txq) (queue_id) (start|stop)
+global_config
+~~~~~~~~~~~~~
-Only take effect when port is started.
+Set different GRE key length for input set::
-port config - speed
-~~~~~~~~~~~~~~~~~~~
+ global_config (port_id) gre-key-len (number in bytes)
-Set the speed and duplex mode for all ports or a specific port:
+For example to set GRE key length for input set to 4 bytes on port 0::
-port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
+ testpmd> global_config 0 gre-key-len 4
-port config - queues/descriptors
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set number of queues/descriptors for rxq, txq, rxd and txd:
+.. _testpmd_rte_flow:
-port config all (rxq|txq|rxd|txd) (value)
+Flow rules management
+---------------------
-This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
+Control of the generic flow API (*rte_flow*) is fully exposed through the
+``flow`` command (validation, creation, destruction, queries and operation
+modes).
-port config - max-pkt-len
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Considering *rte_flow* overlaps with all `Filter Functions`_, using both
+features simultaneously may cause undefined side-effects and is therefore
+not recommended.
-Set the maximum packet length:
+``flow`` syntax
+~~~~~~~~~~~~~~~
-port config all max-pkt-len (value)
+Because the ``flow`` command uses dynamic tokens to handle the large number
+of possible flow rules combinations, its behavior differs slightly from
+other commands, in particular:
-This is equivalent to the --max-pkt-len command-line option.
+- Pressing *?* or the *<tab>* key displays contextual help for the current
+ token, not that of the entire command.
-port config - CRC Strip
-~~~~~~~~~~~~~~~~~~~~~~~
+- Optional and repeated parameters are supported (provided they are listed
+ in the contextual help).
-Set hardware CRC stripping on or off for all ports:
+The first parameter stands for the operation mode. Possible operations and
+their general syntax are described below. They are covered in detail in the
+following sections.
-port config all crc-strip (on|off)
+- Check whether a flow rule can be created::
-CRC stripping is off by default.
+ flow validate {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-The on option is equivalent to the --crc-strip command-line option.
+- Create a flow rule::
-port config - RX Checksum
-~~~~~~~~~~~~~~~~~~~~~~~~~
+ flow create {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-Set hardware RX checksum offload to on or off for all ports:
+- Destroy specific flow rules::
-port config all rx-cksum (on|off)
+ flow destroy {port_id} rule {rule_id} [...]
-Checksum offload is off by default.
+- Destroy all flow rules::
-The on option is equivalent to the --enable-rx-cksum command-line option.
+ flow flush {port_id}
-port config - VLAN
-~~~~~~~~~~~~~~~~~~
+- Query an existing flow rule::
-Set hardware VLAN on or off for all ports:
+ flow query {port_id} {rule_id} {action}
-port config all hw-vlan (on|off)
+- List existing flow rules sorted by priority, filtered by group
+ identifiers::
-Hardware VLAN is on by default.
+ flow list {port_id} [group {group_id}] [...]
-The off option is equivalent to the --disable-hw-vlan command-line option.
+- Restrict ingress traffic to the defined flow rules::
-port config - Drop Packets
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+ flow isolate {port_id} {boolean}
-Set packet drop for packets with no descriptors on or off for all ports:
+Validating flow rules
+~~~~~~~~~~~~~~~~~~~~~
-port config all drop-en (on|off)
+``flow validate`` reports whether a flow rule would be accepted by the
+underlying device in its current state but stops short of creating it. It is
+bound to ``rte_flow_validate()``::
-Packet dropping for packets with no descriptors is off by default.
+ flow validate {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-The on option is equivalent to the --enable-drop-en command-line option.
+If successful, it will show::
-port config - RSS
-~~~~~~~~~~~~~~~~~
+ Flow rule validated
-Set the RSS (Receive Side Scaling) mode on or off:
+Otherwise it will show an error message of the form::
-port config all rss (ip|udp|none)
+ Caught error type [...] ([...]): [...]
-RSS is on by default.
+This command uses the same parameters as ``flow create``, their format is
+described in `Creating flow rules`_.
-The off option is equivalent to the --disable-rss command-line option.
+Check whether redirecting any Ethernet packet received on port 0 to RX queue
+index 6 is supported::
-port config - RSS Reta
-~~~~~~~~~~~~~~~~~~~~~~
+ testpmd> flow validate 0 ingress pattern eth / end
+ actions queue index 6 / end
+ Flow rule validated
+ testpmd>
-Set the RSS (Receive Side Scaling) redirection table:
+Port 0 does not support TCPv6 rules::
-port config all rss reta (hash,queue)[,(hash,queue)]
+ testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
+ actions drop / end
+ Caught error type 9 (specific pattern item): Invalid argument
+ testpmd>
-port config - DCB
-~~~~~~~~~~~~~~~~~
+Creating flow rules
+~~~~~~~~~~~~~~~~~~~
-Set the DCB mode for an individual port:
+``flow create`` validates and creates the specified flow rule. It is bound
+to ``rte_flow_create()``::
-port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
+ flow create {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-The traffic class should be 4 or 8.
+If successful, it will return a flow rule ID usable with other commands::
-port config - Burst
-~~~~~~~~~~~~~~~~~~~
+ Flow rule #[...] created
-Set the number of packets per burst:
+Otherwise it will show an error message of the form::
-port config all burst (value)
+ Caught error type [...] ([...]): [...]
-This is equivalent to the --burst command-line option.
+Parameters describe in the following order:
-port config - Threshold
-~~~~~~~~~~~~~~~~~~~~~~~
+- Attributes (*group*, *priority*, *ingress*, *egress* tokens).
+- A matching pattern, starting with the *pattern* token and terminated by an
+ *end* pattern item.
+- Actions, starting with the *actions* token and terminated by an *end*
+ action.
-Set thresholds for TX/RX queues:
+These translate directly to *rte_flow* objects provided as-is to the
+underlying functions.
-port config all (threshold) (value)
+The shortest valid definition only comprises mandatory tokens::
-Where the threshold type can be:
+ testpmd> flow create 0 pattern end actions end
-* txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
+Note that PMDs may refuse rules that essentially do nothing such as this
+one.
-* txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
+**All unspecified object values are automatically initialized to 0.**
-* txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
+Attributes
+^^^^^^^^^^
-* rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
+These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
+specified before the ``pattern`` token.
-* rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
+- ``group {group id}``: priority group.
+- ``priority {level}``: priority level within group.
+- ``ingress``: rule applies to ingress traffic.
+- ``egress``: rule applies to egress traffic.
-* rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
+Each instance of an attribute specified several times overrides the previous
+value as shown below (group 4 is used)::
-* txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
+ testpmd> flow create 0 group 42 group 24 group 4 [...]
-* rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
+Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
-* txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
- These threshold options are also available from the command-line.
+While not specifying a direction is an error, some rules may allow both
+simultaneously.
-Flow Director Functions
------------------------
+Most rules affect RX therefore contain the ``ingress`` token::
-The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
+ testpmd> flow create 0 ingress pattern [...]
-Two types of filtering are supported which are referred to as Perfect Match and Signature filters:
+Matching pattern
+^^^^^^^^^^^^^^^^
-* Perfect match filters.
- The hardware checks a match between the masked fields of the received packets and the programmed filters.
+A matching pattern starts after the ``pattern`` token. It is made of pattern
+items and is terminated by a mandatory ``end`` item.
-* Signature filters.
- The hardware checks a match between a hash-based signature of the masked fields of the received packet.
+Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
+rte_flow_item_type``).
-The Flow Director filters can match the following fields in a packet:
+The ``/`` token is used as a separator between pattern items as shown
+below::
-* Source IP and destination IP addresses.
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
-* Source port and destination port numbers (for UDP and TCP packets).
+Note that protocol items like these must be stacked from lowest to highest
+layer to make sense. For instance, the following rule is either invalid or
+unlikely to match any packet::
-* IPv4/IPv6 and UDP/ TCP/SCTP protocol match.
+ testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
-* VLAN header.
+More information on these restrictions can be found in the *rte_flow*
+documentation.
-* Flexible 2-byte tuple match anywhere in the first 64 bytes of the packet.
+Several items support additional specification structures, for example
+``ipv4`` allows specifying source and destination addresses as follows::
-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.
-For example it is possible to mask out sub-nets of IP addresses or to ignore VLAN headers.
+ testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
+ dst is 10.2.0.0 / end [...]
-In the following sections, several common parameters are used in the Flow Director filters.
-These are explained below:
+This rule matches all IPv4 traffic with the specified properties.
-* src: A pair of source address values. The source IP, in IPv4 or IPv6 format, and the source port:
+In this example, ``src`` and ``dst`` are field names of the underlying
+``struct rte_flow_item_ipv4`` object. All item properties can be specified
+in a similar fashion.
- src 192.168.0.1 1024
+The ``is`` token means that the subsequent value must be matched exactly,
+and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
+accordingly. Possible assignment tokens are:
- src 2001:DB8:85A3:0:0:8A2E:370:7000 1024
+- ``is``: match value perfectly (with full bit-mask).
+- ``spec``: match value according to configured bit-mask.
+- ``last``: specify upper bound to establish a range.
+- ``mask``: specify bit-mask with relevant bits set to one.
+- ``prefix``: generate bit-mask from a prefix length.
-* dst: A pair of destination address values. The destination IP, in IPv4 or IPv6 format, and the destination port.
+These yield identical results::
-* flexbytes: A 2-byte tuple to be matched within the first 64 bytes of a packet.
+ ipv4 src is 10.1.1.1
-The offset where the match occurs is set by the --pkt-filter-flexbytes-offset command-line parameter
-and is counted from the first byte of the destination Ethernet MAC address.
-The default offset is 0xC bytes, which is the "Type" word in the MAC header.
-Typically, the flexbyte value is set to 0x0800 to match the IPv4 MAC type or 0x86DD to match IPv6.
-These values change when a VLAN tag is added.
+::
-* vlan: The VLAN header to match in the packet.
+ ipv4 src spec 10.1.1.1 src mask 255.255.255.255
-* queue: The index of the RX queue to route matched packets to.
+::
-* soft: The 16-bit value in the MBUF flow director ID field for RX packets matching the filter.
+ ipv4 src spec 10.1.1.1 src prefix 32
-add_signature_filter
-~~~~~~~~~~~~~~~~~~~~
+::
-Add a signature filter:
+ ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
-# Command is displayed on several lines for clarity.
+::
-add_signature_filter (port_id) (ip|udp|tcp|sctp)
+ ipv4 src is 10.1.1.1 src last 0 # 0 disables range
- src (src_ip_address) (src_port)
+Inclusive ranges can be defined with ``last``::
- dst (dst_ip_address) (dst_port)
+ ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
- flexbytes (flexbytes_values)
+Note that ``mask`` affects both ``spec`` and ``last``::
- vlan (vlan_id) queue (queue_id)
+ ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
+ # matches 10.1.0.0 to 10.2.255.255
-upd_signature_filter
-~~~~~~~~~~~~~~~~~~~~
+Properties can be modified multiple times::
-Update a signature filter:
+ ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
-# Command is displayed on several lines for clarity.
+::
-upd_signature_filter (port_id) (ip|udp|tcp|sctp)
+ ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
- src (src_ip_address) (src_port)
+Pattern items
+^^^^^^^^^^^^^
- dst (dst_ip_address) (dst_port)
+This section lists supported pattern items and their attributes, if any.
- flexbytes (flexbytes_values)
+- ``end``: end list of pattern items.
- vlan (vlan_id) queue (queue_id)
+- ``void``: no-op pattern item.
-rm_signature_filter
-~~~~~~~~~~~~~~~~~~~
+- ``invert``: perform actions when pattern does not match.
-Remove a signature filter:
+- ``any``: match any protocol for the current layer.
-# Command is displayed on several lines for clarity.
+ - ``num {unsigned}``: number of layers covered.
-rm_signature_filter (port_id) (ip|udp|tcp|sctp)
+- ``pf``: match packets addressed to the physical function.
- src (src_ip_address) (src_port)
+- ``vf``: match packets addressed to a virtual function ID.
- dst (dst_ip_address) (dst_port)
+ - ``id {unsigned}``: destination VF ID.
- flexbytes (flexbytes_values)
+- ``port``: device-specific physical port index to use.
- vlan (vlan_id)
+ - ``index {unsigned}``: physical port index.
-add_perfect_filter
-~~~~~~~~~~~~~~~~~~
+- ``raw``: match an arbitrary byte string.
-Add a perfect filter:
+ - ``relative {boolean}``: look for pattern after the previous item.
+ - ``search {boolean}``: search pattern from offset (see also limit).
+ - ``offset {integer}``: absolute or relative offset for pattern.
+ - ``limit {unsigned}``: search area limit for start of pattern.
+ - ``pattern {string}``: byte string to look for.
-# Command is displayed on several lines for clarity.
+- ``eth``: match Ethernet header.
-add_perfect_filter (port_id) (ip|udp|tcp|sctp)
+ - ``dst {MAC-48}``: destination MAC.
+ - ``src {MAC-48}``: source MAC.
+ - ``type {unsigned}``: EtherType.
- src (src_ip_address) (src_port)
+- ``vlan``: match 802.1Q/ad VLAN tag.
- dst (dst_ip_address) (dst_port)
+ - ``tpid {unsigned}``: tag protocol identifier.
+ - ``tci {unsigned}``: tag control information.
+ - ``pcp {unsigned}``: priority code point.
+ - ``dei {unsigned}``: drop eligible indicator.
+ - ``vid {unsigned}``: VLAN identifier.
- flexbytes (flexbytes_values)
+- ``ipv4``: match IPv4 header.
- vlan (vlan_id) queue (queue_id) soft (soft_id)
+ - ``tos {unsigned}``: type of service.
+ - ``ttl {unsigned}``: time to live.
+ - ``proto {unsigned}``: next protocol ID.
+ - ``src {ipv4 address}``: source address.
+ - ``dst {ipv4 address}``: destination address.
-upd_perfect_filter
-~~~~~~~~~~~~~~~~~~
+- ``ipv6``: match IPv6 header.
-Update a perfect filter:
+ - ``tc {unsigned}``: traffic class.
+ - ``flow {unsigned}``: flow label.
+ - ``proto {unsigned}``: protocol (next header).
+ - ``hop {unsigned}``: hop limit.
+ - ``src {ipv6 address}``: source address.
+ - ``dst {ipv6 address}``: destination address.
-# Command is displayed on several lines for clarity.
+- ``icmp``: match ICMP header.
-upd_perfect_filter (port_id) (ip|udp|tcp|sctp)
+ - ``type {unsigned}``: ICMP packet type.
+ - ``code {unsigned}``: ICMP packet code.
- src (src_ip_address) (src_port)
+- ``udp``: match UDP header.
- dst (dst_ip_address) (dst_port)
+ - ``src {unsigned}``: UDP source port.
+ - ``dst {unsigned}``: UDP destination port.
- flexbytes (flexbytes_values)
+- ``tcp``: match TCP header.
- vlan (vlan_id) queue (queue_id)
+ - ``src {unsigned}``: TCP source port.
+ - ``dst {unsigned}``: TCP destination port.
-rm_perfect_filter
-~~~~~~~~~~~~~~~~~
+- ``sctp``: match SCTP header.
-Remove a perfect filter:
+ - ``src {unsigned}``: SCTP source port.
+ - ``dst {unsigned}``: SCTP destination port.
+ - ``tag {unsigned}``: validation tag.
+ - ``cksum {unsigned}``: checksum.
-rm_perfect_filter (port_id) (ip|udp|tcp|sctp)
+- ``vxlan``: match VXLAN header.
- src (src_ip_address) (src_port)
+ - ``vni {unsigned}``: VXLAN identifier.
- dst (dst_ip_address) (dst_port)
+- ``e_tag``: match IEEE 802.1BR E-Tag header.
- flexbytes (flexbytes_values)
+ - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
- vlan (vlan_id) soft (soft_id)
+- ``nvgre``: match NVGRE header.
-set_masks_filter
-~~~~~~~~~~~~~~~~
+ - ``tni {unsigned}``: virtual subnet ID.
-Set IPv4 filter masks:
+- ``mpls``: match MPLS header.
-# Command is displayed on several lines for clarity.
+ - ``label {unsigned}``: MPLS label.
-set_masks_filter (port_id) only_ip_flow (0|1)
+- ``gre``: match GRE header.
- src_mask (ip_src_mask) (src_port_mask)
+ - ``protocol {unsigned}``: protocol type.
- dst_mask (ip_dst_mask) (dst_port_mask)
+- ``fuzzy``: fuzzy pattern match, expect faster than default.
- flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
+ - ``thresh {unsigned}``: accuracy threshold.
-set_ipv6_masks_filter
-~~~~~~~~~~~~~~~~~~~~~
+- ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
-Set IPv6 filter masks:
+ - ``teid {unsigned}``: tunnel endpoint identifier.
-# Command is displayed on several lines for clarity.
+Actions list
+^^^^^^^^^^^^
-set_ipv6_masks_filter (port_id) only_ip_flow (0|1)
+A list of actions starts after the ``actions`` token in the same fashion as
+`Matching pattern`_; actions are separated by ``/`` tokens and the list is
+terminated by a mandatory ``end`` action.
- src_mask (ip_src_mask) (src_port_mask)
+Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
+rte_flow_action_type``).
- dst_mask (ip_dst_mask) (dst_port_mask)
+Dropping all incoming UDPv4 packets can be expressed as follows::
- flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
+ actions drop / end
- compare_dst (0|1)
+Several actions have configurable properties which must be specified when
+there is no valid default value. For example, ``queue`` requires a target
+queue index.
-Link Bonding Functions
-----------------------
+This rule redirects incoming UDPv4 traffic to queue index 6::
-The Link Bonding functions make it possible to dynamically create and
-manage link bonding devices from within testpmd interactive prompt.
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
+ actions queue index 6 / end
-create bonded device
-~~~~~~~~~~~~~~~~~~~~
+While this one could be rejected by PMDs (unspecified queue index)::
-Create a new bonding device:
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
+ actions queue / end
-create bonded device (mode) (socket)
+As defined by *rte_flow*, the list is not ordered, all actions of a given
+rule are performed simultaneously. These are equivalent::
-For example, to create a bonded device in mode 1 on socket 0.
+ queue index 6 / void / mark id 42 / end
-.. code-block:: console
+::
- testpmd> create bonded 1 0
- created new bonded device (port X)
+ void / mark id 42 / queue index 6 / end
-add bonding slave
-~~~~~~~~~~~~~~~~~
+All actions in a list should have different types, otherwise only the last
+action of a given type is taken into account::
-Adds Ethernet device to a Link Bonding device:
+ queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
-add bonding slave (slave id) (port id)
+::
-For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
+ drop / drop / drop / end # drop is performed only once
-.. code-block:: console
+::
- testpmd> add bonding slave 6 10
+ mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
+Considering they are performed simultaneously, opposite and overlapping
+actions can sometimes be combined when the end result is unambiguous::
-remove bonding slave
-~~~~~~~~~~~~~~~~~~~~
+ drop / queue index 6 / end # drop has no effect
-Removes an Ethernet slave device from a Link Bonding device:
+::
-remove bonding slave (slave id) (port id)
+ drop / dup index 6 / end # same as above
-For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
+::
-.. code-block:: console
+ queue index 6 / rss queues 6 7 8 / end # queue has no effect
- testpmd> remove bonding slave 6 10
+::
-set bonding mode
-~~~~~~~~~~~~~~~~
+ drop / passthru / end # drop has no effect
-Set the Link Bonding mode of a Link Bonding device:
+Note that PMDs may still refuse such combinations.
-set bonding mode (value) (port id)
+Actions
+^^^^^^^
-For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
+This section lists supported actions and their attributes, if any.
-.. code-block:: console
+- ``end``: end list of actions.
- testpmd> set bonding mode 3 10
+- ``void``: no-op action.
-set bonding primary
-~~~~~~~~~~~~~~~~~~~
+- ``passthru``: let subsequent rule process matched packets.
-Set an Ethernet slave device as the primary device on a Link Bonding device:
+- ``mark``: attach 32 bit value to packets.
-set bonding primary (slave id) (port id)
+ - ``id {unsigned}``: 32 bit value to return with packets.
-For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
+- ``flag``: flag packets.
-.. code-block:: console
+- ``queue``: assign packets to a given queue index.
- testpmd> set bonding primary 6 10
+ - ``index {unsigned}``: queue index to use.
-set bonding mac
-~~~~~~~~~~~~~~~
+- ``drop``: drop packets (note: passthru has priority).
-Set the MAC address of a Link Bonding device:
+- ``count``: enable counters for this rule.
-set bonding mac (port id) (mac)
+- ``dup``: duplicate packets to a given queue index.
-For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
+ - ``index {unsigned}``: queue index to duplicate packets to.
-.. code-block:: console
+- ``rss``: spread packets among several queues.
- testpmd> set bonding mac 10 00:00:00:00:00:01
+ - ``queues [{unsigned} [...]] end``: queue indices to use.
-set bonding xmit_balance_policy
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+- ``pf``: redirect packets to physical device function.
-Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
+- ``vf``: redirect packets to virtual device function.
-set bonding xmit_balance_policy (port_id) (l2|l23|l34)
+ - ``original {boolean}``: use original VF ID if possible.
+ - ``id {unsigned}``: VF ID to redirect packets to.
-For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
+Destroying flow rules
+~~~~~~~~~~~~~~~~~~~~~
-.. code-block:: console
+``flow destroy`` destroys one or more rules from their rule ID (as returned
+by ``flow create``), this command calls ``rte_flow_destroy()`` as many
+times as necessary::
- testpmd> set bonding xmit_balance_policy 10 l34
+ flow destroy {port_id} rule {rule_id} [...]
+If successful, it will show::
-set bonding mon_period
-~~~~~~~~~~~~~~~~~~~~~~
+ Flow rule #[...] destroyed
-Set the link status monitoring polling period in milliseconds for a bonding devicie.
+It does not report anything for rule IDs that do not exist. The usual error
+message is shown when a rule cannot be destroyed::
-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.
+ Caught error type [...] ([...]): [...]
-set bonding mon_period (port_id) (value)
+``flow flush`` destroys all rules on a device and does not take extra
+arguments. It is bound to ``rte_flow_flush()``::
-For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
+ flow flush {port_id}
-.. code-block:: console
+Any errors are reported as above.
- testpmd> set bonding mon_period 5 150
+Creating several rules and destroying them::
+ testpmd> flow create 0 ingress pattern eth / ipv6 / end
+ actions queue index 2 / end
+ Flow rule #0 created
+ testpmd> flow create 0 ingress pattern eth / ipv4 / end
+ actions queue index 3 / end
+ Flow rule #1 created
+ testpmd> flow destroy 0 rule 0 rule 1
+ Flow rule #1 destroyed
+ Flow rule #0 destroyed
+ testpmd>
-show bonding config
+The same result can be achieved using ``flow flush``::
+
+ testpmd> flow create 0 ingress pattern eth / ipv6 / end
+ actions queue index 2 / end
+ Flow rule #0 created
+ testpmd> flow create 0 ingress pattern eth / ipv4 / end
+ actions queue index 3 / end
+ Flow rule #1 created
+ testpmd> flow flush 0
+ testpmd>
+
+Non-existent rule IDs are ignored::
+
+ testpmd> flow create 0 ingress pattern eth / ipv6 / end
+ actions queue index 2 / end
+ Flow rule #0 created
+ testpmd> flow create 0 ingress pattern eth / ipv4 / end
+ actions queue index 3 / end
+ Flow rule #1 created
+ testpmd> flow destroy 0 rule 42 rule 10 rule 2
+ testpmd>
+ testpmd> flow destroy 0 rule 0
+ Flow rule #0 destroyed
+ testpmd>
+
+Querying flow rules
~~~~~~~~~~~~~~~~~~~
-Show the current configuration of a Link Bonding device:
+``flow query`` queries a specific action of a flow rule having that
+ability. Such actions collect information that can be reported using this
+command. It is bound to ``rte_flow_query()``::
-show bonding config (port id)
+ flow query {port_id} {rule_id} {action}
-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.
+If successful, it will display either the retrieved data for known actions
+or the following message::
-.. code-block:: console
+ Cannot display result for action type [...] ([...])
- 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]
+Otherwise, it will complain either that the rule does not exist or that some
+error occurred::
-Register Functions
-------------------
+ Flow rule #[...] not found
-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.
+::
-read reg
-~~~~~~~~
+ Caught error type [...] ([...]): [...]
-Display the value of a port register:
+Currently only the ``count`` action is supported. This action reports the
+number of packets that hit the flow rule and the total number of bytes. Its
+output has the following format::
-read reg (port_id) (address)
+ count:
+ hits_set: [...] # whether "hits" contains a valid value
+ bytes_set: [...] # whether "bytes" contains a valid value
+ hits: [...] # number of packets
+ bytes: [...] # number of bytes
-For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel® 82599 10 GbE Controller:
+Querying counters for TCPv6 packets redirected to queue 6::
-.. code-block:: console
+ testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
+ actions queue index 6 / count / end
+ Flow rule #4 created
+ testpmd> flow query 0 4 count
+ count:
+ hits_set: 1
+ bytes_set: 0
+ hits: 386446
+ bytes: 0
+ testpmd>
- testpmd> read reg 0 0xEE00
- port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
+Listing flow rules
+~~~~~~~~~~~~~~~~~~
-read regfield
-~~~~~~~~~~~~~
+``flow list`` lists existing flow rules sorted by priority and optionally
+filtered by group identifiers::
+
+ flow list {port_id} [group {group_id}] [...]
+
+This command only fails with the following message if the device does not
+exist::
+
+ Invalid port [...]
+
+Output consists of a header line followed by a short description of each
+flow rule, one per line. There is no output at all when no flow rules are
+configured on the device::
+
+ ID Group Prio Attr Rule
+ [...] [...] [...] [...] [...]
+
+``Attr`` column flags:
+
+- ``i`` for ``ingress``.
+- ``e`` for ``egress``.
+
+Creating several flow rules and listing them::
+
+ testpmd> flow create 0 ingress pattern eth / ipv4 / end
+ actions queue index 6 / end
+ Flow rule #0 created
+ testpmd> flow create 0 ingress pattern eth / ipv6 / end
+ actions queue index 2 / end
+ Flow rule #1 created
+ testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
+ actions rss queues 6 7 8 end / end
+ Flow rule #2 created
+ testpmd> flow list 0
+ ID Group Prio Attr Rule
+ 0 0 0 i- ETH IPV4 => QUEUE
+ 1 0 0 i- ETH IPV6 => QUEUE
+ 2 0 5 i- ETH IPV4 UDP => RSS
+ testpmd>
+
+Rules are sorted by priority (i.e. group ID first, then priority level)::
+
+ testpmd> flow list 1
+ ID Group Prio Attr Rule
+ 0 0 0 i- ETH => COUNT
+ 6 0 500 i- ETH IPV6 TCP => DROP COUNT
+ 5 0 1000 i- ETH IPV6 ICMP => QUEUE
+ 1 24 0 i- ETH IPV4 UDP => QUEUE
+ 4 24 10 i- ETH IPV4 TCP => DROP
+ 3 24 20 i- ETH IPV4 => DROP
+ 2 24 42 i- ETH IPV4 UDP => QUEUE
+ 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
+ testpmd>
+
+Output can be limited to specific groups::
+
+ testpmd> flow list 1 group 0 group 63
+ ID Group Prio Attr Rule
+ 0 0 0 i- ETH => COUNT
+ 6 0 500 i- ETH IPV6 TCP => DROP COUNT
+ 5 0 1000 i- ETH IPV6 ICMP => QUEUE
+ 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
+ testpmd>
+
+Toggling isolated mode
+~~~~~~~~~~~~~~~~~~~~~~
-Display a port register bit field:
+``flow isolate`` can be used to tell the underlying PMD that ingress traffic
+must only be injected from the defined flow rules; that no default traffic
+is expected outside those rules and the driver is free to assign more
+resources to handle them. It is bound to ``rte_flow_isolate()``::
-read regfield (port_id) (address) (bit_x) (bit_y)
+ flow isolate {port_id} {boolean}
-For example, reading the lowest two bits from the register in the example above:
+If successful, enabling or disabling isolated mode shows either::
-.. code-block:: console
+ Ingress traffic on port [...]
+ is now restricted to the defined flow rules
- testpmd> read regfield 0 0xEE00 0 1
- port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
+Or::
-read regbit
-~~~~~~~~~~~
+ Ingress traffic on port [...]
+ is not restricted anymore to the defined flow rules
-Display a single port register bit:
+Otherwise, in case of error::
-read regbit (port_id) (address) (bit_x)
+ Caught error type [...] ([...]): [...]
-For example, reading the lowest bit from the register in the example above:
+Mainly due to its side effects, PMDs supporting this mode may not have the
+ability to toggle it more than once without reinitializing affected ports
+first (e.g. by exiting testpmd).
-.. code-block:: console
+Enabling isolated mode::
- testpmd> read regbit 0 0xEE00 0
- port 0 PCI register at offset 0xEE00: bit 0=1
+ testpmd> flow isolate 0 true
+ Ingress traffic on port 0 is now restricted to the defined flow rules
+ testpmd>
-write reg
-~~~~~~~~~
+Disabling isolated mode::
-Set the value of a port register:
+ testpmd> flow isolate 0 false
+ Ingress traffic on port 0 is not restricted anymore to the defined flow rules
+ testpmd>
-write reg (port_id) (address) (value)
+Sample QinQ flow rules
+~~~~~~~~~~~~~~~~~~~~~~
-For example, to clear a register:
+Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
-.. code-block:: console
+ testpmd> port stop 0
+ testpmd> vlan set qinq on 0
- testpmd> write reg 0 0xEE00 0x0
- port 0 PCI register at offset 0xEE00: 0x00000000 (0)
+The above command sets the inner and outer TPID's to 0x8100.
-write regfield
-~~~~~~~~~~~~~~
+To change the TPID's the following commands should be used::
-Set bit field of a port register:
+ testpmd> vlan set outer tpid 0xa100 0
+ testpmd> vlan set inner tpid 0x9100 0
+ testpmd> port start 0
-write regfield (port_id) (address) (bit_x) (bit_y) (value)
+Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
-For example, writing to the register cleared in the example above:
+::
-.. code-block:: console
+ testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
+ vlan tci is 456 / end actions vf id 1 / queue index 0 / end
+ Flow rule #0 validated
- testpmd> write regfield 0 0xEE00 0 1 2
- port 0 PCI register at offset 0xEE00: 0x00000002 (2)
+ testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
+ vlan tci is 456 / end actions vf id 123 / queue index 0 / end
+ Flow rule #0 created
-write regbit
-~~~~~~~~~~~~
+ testpmd> flow list 0
+ ID Group Prio Attr Rule
+ 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
-Set single bit value of a port register:
+Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
-write regbit (port_id) (address) (bit_x) (value)
+::
-For example, to set the high bit in the register from the example above:
+ testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
+ vlan tci is 654 / end actions pf / queue index 0 / end
+ Flow rule #1 validated
-.. code-block:: console
+ testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
+ vlan tci is 654 / end actions pf / queue index 1 / end
+ Flow rule #1 created
- testpmd> write regbit 0 0xEE00 31 1
- port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
+ testpmd> flow list 0
+ ID Group Prio Attr Rule
+ 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
+ 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
git.droids-corp.org / dpdk.git / blobdiff