.. 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 X
+ info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc all
+ stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc X
+ stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc 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.
- 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) (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.
- 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
- testpmd> clear port stats all
+show (rxq|txq)
+~~~~~~~~~~~~~~
+
+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)
-
-For example:
+ testpmd> read rxd (port_id) (queue_id) (rxd_id)
-.. code-block:: console
+For example::
- testpmd> read rxd 0 0 4
+ testpmd> read rxd 0 0 4
0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
read txd
~~~~~~~~
-Display a TX descriptor for a port TX queue:
-
-read txd (port_id) (queue_id) (txd_id)
+Display a TX descriptor for a port TX queue::
-For example:
+ testpmd> read txd (port_id) (queue_id) (txd_id)
-.. code-block:: console
+For example::
- testpmd> read txd 0 0 4
+ testpmd> read txd 0 0 4
0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
+
Configuration Functions
-----------------------
.. 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::
- 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
+ testpmd> set vf mac antispoof (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 antispoof (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
-vlan set stripq (on|off) (port_id,queue_id)
+Set VLAN antispoof for a VF from the PF::
+
+ 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::
+
+ testpmd> rx_vlan rm (vlan_id|all) (port_id)
+
+rx_vlan add (for VF)
+~~~~~~~~~~~~~~~~~~~~
+
+Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
-rx_vlan rm (vlan_id|all) (port_id)
+ testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
-rx_vlan add(for VF)
+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.
+
+Example::
-Add a tunnel filter on a port:
+ 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
-tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
- (tunnel_type) (filter_type) (tenant_id) (queue_id)
+ 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:
-
-tx_vlan reset (port_id)
-
-tx_checksum set mask
-~~~~~~~~~~~~~~~~~~~~
+Disable hardware insertion of a VLAN header in packets sent on a port::
-Enable hardware insertion of checksum offload with a 4-bit mask, 0x0 - 0xF, in packets sent on a port:
+ testpmd> tx_vlan reset (port_id)
-tx_checksum set (mask) (port_id)
+csum set
+~~~~~~~~
-The bits in the mask are:
+Select hardware or software calculation of the checksum when
+transmitting a packet using the ``csum`` forwarding engine::
-bit 0 - if set insert ip checksum offload
+ testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
-bit 1 - if set insert udp checksum offload
+Where:
-bit 2 - if set insert tcp checksum offload
+* ``ip|udp|tcp|sctp`` always relate to the inner layer.
-bit 3 - if set insert sctp checksum offload
+* ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
+ as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
+ supported). See also the ``csum parse-tunnel`` command.
.. note::
- Check the NIC Datasheet for hardware limits.
-
-tx_checksum show
-~~~~~~~~~~~~~~~~
+ Check the NIC Datasheet for hardware limits.
-Display tx checksum offload configuration:
+csum parse-tunnel
+~~~~~~~~~~~~~~~~~
-tx_checksum show (port_id)
+Define how tunneled packets should be handled by the csum forward
+engine::
-tso set
-~~~~~~~
+ testpmd> csum parse-tunnel (on|off) (tx_port_id)
-Enable TCP Segmentation Offload in csum forward engine:
+If enabled, the csum forward engine will try to recognize supported
+tunnel headers (vxlan, gre, ipip).
-tso set (segsize) (port_id)
+If disabled, treat tunnel packets as non-tunneled packets (a inner
+header is handled as a packet payload).
.. note::
- Please check the NIC datasheet for HW limits
-
-tso show
-~~~~~~~~
-
-Display the status of TCP Segmentation Offload:
-
-tso show (port_id)
-set fwd
-~~~~~~~
+ The port argument is the TX port like in the ``csum set`` command.
-Set the packet forwarding mode:
-
-set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
+Example:
-The available information categories are:
+Consider a packet in packet like the following::
-* 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.
+ eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
-* mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
+* 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``).
-* mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
+* 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``.
-* macswap: MAC swap forwarding mode.
- Swaps the source and the destination Ethernet addresses of packets before forwarding them.
+csum show
+~~~~~~~~~
-* flowgen: multi-flow generation mode.
- Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
+Display tx checksum offload configuration::
-* rxonly: receives packets but doesn't transmit them.
+ testpmd> csum show (port_id)
-* txonly: generates and transmits packets without receiving any.
+tso set
+~~~~~~~
-* csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
+Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
-* icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
+ testpmd> tso set (segsize) (port_id)
+.. note::
-Example:
+ Check the NIC datasheet for hardware limits.
-.. code-block:: console
+tso show
+~~~~~~~~
- testpmd> set fwd rxonly
+Display the status of TCP Segmentation Offload::
- Set rxonly packet forwarding mode
+ testpmd> tso show (port_id)
mac_addr add
~~~~~~~~~~~~
-Add an alternative MAC address to a port:
+Add an alternative MAC address to a port::
-mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
+ testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
mac_addr remove
~~~~~~~~~~~~~~~
-Remove a MAC address from a port:
+Remove a MAC address from a port::
-mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
+ testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
-mac_addr add(for VF)
-~~~~~~~~~~~~~~~~~~~~
+mac_addr add (for VF)
+~~~~~~~~~~~~~~~~~~~~~
+
+Add an alternative MAC address for a VF to a port::
-Add an alternative MAC address for a VF to a port:
+ testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
-mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
+mac_addr set (for VF)
+~~~~~~~~~~~~~~~~~~~~~
+
+Set the MAC address for a VF from the PF::
+
+ 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 the link flow control parameter on a port:
+Set the link flow control parameter on a port::
-set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
-(pause_time) (send_xon) (port_id)
+ testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
+ (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
+ autoneg (on|off) (port_id)
Where:
-high_water (integer): High threshold value to trigger XOFF.
+* ``high_water`` (integer): High threshold value to trigger XOFF.
+
+* ``low_water`` (integer): Low threshold value to trigger XON.
-low_water (integer) : Low threshold value to trigger XON.
+* ``pause_time`` (integer): Pause quota in the Pause frame.
-pause_time (integer): Pause quota in the Pause frame.
+* ``send_xon`` (0/1): Send XON frame.
-send_xon (0/1) : Send XON frame.
+* ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
-mac_ctrl_frame_fwd : Enable receiving MAC control frames
+* ``autoneg``: Change the auto-negotiation para mete.
set pfc_ctrl rx
~~~~~~~~~~~~~~~
-Set the priority flow control parameter on a port:
+Set the priority flow control parameter on a port::
-set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
+ testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
+ (pause_time) (priority) (port_id)
Where:
-priority (0-7): VLAN User Priority.
+* ``high_water`` (integer): High threshold value.
+
+* ``low_water`` (integer): Low threshold value.
+
+* ``pause_time`` (integer): Pause quota in the Pause frame.
+
+* ``priority`` (0-7): VLAN User Priority.
set stat_qmap
~~~~~~~~~~~~~
-Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
-
-set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
+Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
-For example, to set rx queue 2 on port 0 to mapping 5:
+ testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
-.. code-block:: console
+For example, to set rx queue 2 on port 0 to mapping 5::
- testpmd>set stat_qmap rx 0 2 5
+ testpmd>set stat_qmap rx 0 2 5
-set port - rx/tx(for VF)
-~~~~~~~~~~~~~~~~~~~~~~~~
+set port - rx/tx (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~
-Set VF receive/transmit from a port:
+Set VF receive/transmit from a port::
-set port (port_id) vf (vf_id) (rx|tx) (on|off)
+ testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
set port - mac address filter (for VF)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Add/Remove unicast or multicast MAC addr filter for a VF:
+Add/Remove unicast or multicast MAC addr filter for a VF::
-set port (port_id) vf (vf_id) (mac_addr)
- (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
+ testpmd> set port (port_id) vf (vf_id) (mac_addr) \
+ (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
set port - rx mode(for VF)
~~~~~~~~~~~~~~~~~~~~~~~~~~
-Set the VF receive mode of a port:
+Set the VF receive mode of a port::
-set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
+ testpmd> set port (port_id) vf (vf_id) \
+ rxmode (AUPE|ROPE|BAM|MPE) (on|off)
The available receive modes are:
-* AUPE: accepts untagged VLAN.
+* ``AUPE``: Accepts untagged VLAN.
+
+* ``ROPE``: Accepts unicast hash.
+
+* ``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::
-* ROPE: accepts unicast hash.
+ testpmd> set port (port_id) queue (queue_id) rate (rate_value)
-* BAM: accepts broadcast packets
+set port - tx_rate (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* MPE: accepts all multicast packets
+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 port or vlan type mirror rule for a port.
+Set pool or vlan type mirror rule for a port::
-set port (port_id) mirror-rule (rule_id) (pool-mirror|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
+ testpmd> set port (port_id) mirror-rule (rule_id) \
+ (pool-mirror-up|pool-mirror-down|vlan-mirror) \
+ (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
-For example to enable mirror traffic with vlan 0,1 to pool 0:
+Set link mirror rule for a port::
-.. code-block:: console
+ testpmd> set port (port_id) mirror-rule (rule_id) \
+ (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
- set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
+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.
+Reset a mirror rule for a port::
-reset port (port_id) mirror-rule (rule_id)
+ testpmd> reset port (port_id) mirror-rule (rule_id)
set flush_rx
~~~~~~~~~~~~
-Flush (default) or don't flush RX streams before forwarding.
-Mainly used with PCAP drivers to avoid the default behavior of flushing the first 512 packets on RX streams.
+Set the flush on RX streams before forwarding.
+The default is flush ``on``.
+Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
-set flush_rx off
+ testpmd> set flush_rx off
set bypass mode
~~~~~~~~~~~~~~~
-Set the bypass mode for the lowest port on bypass enabled NIC.
+Set the bypass mode for the lowest port on bypass enabled NIC::
-set bypass mode (normal|bypass|isolate) (port_id)
+ testpmd> set bypass mode (normal|bypass|isolate) (port_id)
set bypass event
~~~~~~~~~~~~~~~~
-Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
+Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
+
+ testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
+ mode (normal|bypass|isolate) (port_id)
-* timeout: enable bypass after watchdog timeout.
+Where:
+
+* ``timeout``: Enable bypass after watchdog timeout.
-* os_on: enable bypass when OS/board is powered on.
+* ``os_on``: Enable bypass when OS/board is powered on.
-* os_off: enable bypass when OS/board is powered off.
+* ``os_off``: Enable bypass when OS/board is powered off.
-* power_on: enable bypass when power supply is turned on.
+* ``power_on``: Enable bypass when power supply is turned on.
-* power_off: enable bypass when power supply is turned off.
+* ``power_off``: Enable bypass when power supply is turned off.
-set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
set bypass timeout
~~~~~~~~~~~~~~~~~~
-Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
+Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
-set bypass timeout (0|1.5|2|3|4|8|16|32)
+ testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
show bypass config
~~~~~~~~~~~~~~~~~~
-Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
+Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
-show bypass config (port_id)
+ testpmd> show bypass config (port_id)
-add_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
+set link up
+~~~~~~~~~~~
-Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
+Set link up for a port::
-add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
+ testpmd> set link-up port (port id)
-The available information parameters are:
+set link down
+~~~~~~~~~~~~~
-* port_id: the port which the Ethertype filter assigned on.
+Set link down for a port::
-* eth_value: the EtherType value want to match,
- for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
+ testpmd> set link-down port (port id)
-* enable: user priority participates in the match.
+E-tag set
+~~~~~~~~~
-* disable: user priority doesn't participate in the match.
+Enable E-tag insertion for a VF on a port::
-* pri_value: user priority value that want to match.
+ testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
-* queue_id : The receive queue associated with this EtherType filter
+Disable E-tag insertion for a VF on a port::
-* index: the index of this EtherType filter
+ testpmd> E-tag set insertion off port (port_id) vf (vf_id)
-Example:
+Enable/disable E-tag stripping on a port::
-.. code-block:: console
+ testpmd> E-tag set stripping (on|off) port (port_id)
- testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
- Assign ARP packet to receive queue 3
+Enable/disable E-tag based forwarding on a port::
-remove_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~~~~
+ testpmd> E-tag set forwarding (on|off) port (port_id)
-Remove a L2 Ethertype filter
+Add an E-tag forwarding filter on a port::
-remove_ethertype_filter (port_id) index (idx)
+ testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
-get_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
+Delete an E-tag forwarding filter on a port::
+ testpmd> E-tag set filter del e-tag-id (value) port (port_id)
-Get and display a L2 Ethertype filter
-get_ethertype_filter (port_id) index (idx)
+Port Functions
+--------------
-Example:
+The following sections show functions for configuring ports.
-.. code-block:: console
+.. note::
- testpmd> get_ethertype_filter 0 index 0
+ Port configuration changes only become active when forwarding is started/restarted.
- filter[0]:
- ethertype: 0x0806
- priority: disable, 0
- queue: 3
+port attach
+~~~~~~~~~~~
-add_2tuple_filter
-~~~~~~~~~~~~~~~~~
+Attach a port specified by pci address or virtual device args::
-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.
+ testpmd> port attach (identifier)
-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)
+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.
-The available information parameters are:
+For example, to move a pci device using ixgbe under DPDK management:
-* port_id: the port which the 2-tuple filter assigned on.
+.. code-block:: console
-* pro_value: IP L4 protocol
+ # Check the status of the available devices.
+ ./usertools/dpdk-devbind.py --status
-* pro_mask: protocol participates in the match or not, 1 means participate
+ Network devices using DPDK-compatible driver
+ ============================================
+ <none>
-* port_value: destination port in L4.
+ Network devices using kernel driver
+ ===================================
+ 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
-* port_mask: destination port participates in the match or not, 1 means participate.
-* flg_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
+ # Bind the device to igb_uio.
+ sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
-* prio_value: the priority of this filter.
-* queue_id: The receive queue associated with this 2-tuple filter
+ # 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=
-* index: the index of this 2-tuple filter
+To attach a port created by virtual device, above steps are not needed.
-Example:
+For example, to attach a port whose pci address is 0000:0a:00.0.
.. code-block:: console
- testpmd> add_2tuple_filter 0 protocol 0x06 1 dst_port 32 1 flags 0x02 priority 3 queue 3 index 0
+ 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
-remove_2tuple_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Remove a 2-tuple filter
+For example, to attach a port created by pcap PMD.
-remove_2tuple_filter (port_id) index (idx)
-
-get_2tuple_filter
-~~~~~~~~~~~~~~~~~
+.. code-block:: console
-Get and display a 2-tuple filter
+ 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
-get_2tuple_filter (port_id) index (idx)
+In this case, identifier is ``net_pcap0``.
+This identifier format is the same as ``--vdev`` format of DPDK applications.
-Example:
+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> get_2tuple_filter 0 index 0
+ 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
- filter[0]:
- Destination Port: 0x0020 mask: 1
- protocol: 0x06 mask:1 tcp_flags: 0x02
- priority: 3 queue: 3
-
-add_5tuple_filter
-~~~~~~~~~~~~~~~~~
-Add 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.
+port detach
+~~~~~~~~~~~
-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)
+Detach a specific port::
-The available information parameters are:
+ testpmd> port detach (port_id)
-* port_id: the port which the 5-tuple filter assigned on.
+Before detaching a port, the port should be stopped and closed.
-* dst_address: destination IP address.
+For example, to detach a pci device port 0.
-* src_address: source IP address.
+.. code-block:: console
-* dst_port_value: TCP/UDP destination port.
+ testpmd> port stop 0
+ Stopping ports...
+ Done
+ testpmd> port close 0
+ Closing ports...
+ Done
-* src_port_value: TCP/UDP source port.
+ 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
-* protocol_value: L4 protocol.
-* mask_value: participates in the match or not by bit for field above, 1b means participate
+For example, to detach a virtual device port 0.
-* flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
+.. code-block:: console
-* prio_value: the priority of this filter.
+ testpmd> port stop 0
+ Stopping ports...
+ Done
+ testpmd> port close 0
+ Closing ports...
+ Done
-* queue_id: The receive queue associated with this 5-tuple filter.
+ 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
-* index: the index of this 5-tuple filter
+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.
-Example:
+For example, to move a pci device under kernel management:
.. code-block:: console
- 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
+ sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
-remove_5tuple_filter
-~~~~~~~~~~~~~~~~~~~~
+ ./usertools/dpdk-devbind.py --status
-Remove a 5-tuple filter
+ Network devices using DPDK-compatible driver
+ ============================================
+ <none>
-remove_5tuple_filter (port_id) index (idx)
+ Network devices using kernel driver
+ ===================================
+ 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
-get_5tuple_filter
-~~~~~~~~~~~~~~~~~
+To remove a port created by a virtual device, above steps are not needed.
-Get and display a 5-tuple filter
+port start
+~~~~~~~~~~
-get_5tuple_filter (port_id) index (idx)
+Start all ports or a specific port::
-Example:
+ testpmd> port start (port_id|all)
-.. code-block:: console
+port stop
+~~~~~~~~~
- testpmd> get_5tuple_filter 1 index 0
+Stop all ports or a specific port::
- 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> port stop (port_id|all)
-add_syn_filter
-~~~~~~~~~~~~~~
+port close
+~~~~~~~~~~
-Add SYN filter, which can forward TCP packets whose *SYN* flag is set into a separate queue.
+Close all ports or a specific port::
-add_syn_filter (port_id) priority (high|low) queue (queue_id)
+ testpmd> port close (port_id|all)
-The available information parameters are:
+port start/stop queue
+~~~~~~~~~~~~~~~~~~~~~
-* port_id: the port which the SYN filter assigned on.
+Start/stop a rx/tx queue on a specific port::
-* high: this SYN filter has higher priority than other filters.
+ testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
-* low: this SYN filter has lower priority than other filters.
+Only take effect when port is started.
-* queue_id: The receive queue associated with this SYN filter
+port config - speed
+~~~~~~~~~~~~~~~~~~~
-Example:
+Set the speed and duplex mode for all ports or a specific port::
-.. code-block:: console
+ testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
+ duplex (half|full|auto)
- testpmd> add_syn_filter 0 priority high queue 3,
+port config - queues/descriptors
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-remove_syn_filter
-~~~~~~~~~~~~~~~~~
+Set number of queues/descriptors for rxq, txq, rxd and txd::
-Remove SYN filter
+ testpmd> port config all (rxq|txq|rxd|txd) (value)
-remove_syn_filter (port_id)
+This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
-get_syn_filter
-~~~~~~~~~~~~~~
+port config - max-pkt-len
+~~~~~~~~~~~~~~~~~~~~~~~~~
-Get and display SYN filter
+Set the maximum packet length::
-get_syn_filter (port_id)
+ testpmd> port config all max-pkt-len (value)
-Example:
+This is equivalent to the ``--max-pkt-len`` command-line option.
-.. code-block:: console
+port config - CRC Strip
+~~~~~~~~~~~~~~~~~~~~~~~
- testpmd> get_syn_filter 0
+Set hardware CRC stripping on or off for all ports::
- syn filter: on, priority: high, queue: 3
+ testpmd> port config all crc-strip (on|off)
-add_flex_filter
-~~~~~~~~~~~~~~~
+CRC stripping is off by default.
-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.
+The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
-add_flex_filter (port_id) len (len_value) bytes (bytes_string) mask (mask_value)
-priority (prio_value) queue (queue_id) index (idx)
+port config - scatter
+~~~~~~~~~~~~~~~~~~~~~~~
-The available information parameters are:
+Set RX scatter mode on or off for all ports::
-* port_id: the port which the Flex filter assigned on.
+ testpmd> port config all scatter (on|off)
-* len_value: filter length in byte, no greater than 128.
+RX scatter mode is off by default.
-* bytes_string: a sting in format of octal, means the value the flex filter need to match.
+The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
-* mask_value: a sting in format of octal, bit 1 means corresponding byte in DWORD participates in the match.
+port config - TX queue flags
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-* prio_value: the priority of this filter.
+Set a hexadecimal bitmap of TX queue flags for all ports::
-* queue_id: The receive queue associated with this Flex filter.
+ testpmd> port config all txqflags value
-* index: the index of this Flex filter
+This command is equivalent to the ``--txqflags`` command-line option.
-Example:
+port config - RX Checksum
+~~~~~~~~~~~~~~~~~~~~~~~~~
-.. code-block:: console
+Set hardware RX checksum offload to on or off for all ports::
+
+ testpmd> port config all rx-cksum (on|off)
- testpmd> add_flex_filter 0 len 16 bytes 0x00000000000000000000000008060000 mask 000C priority 3 queue 3 index 0
+Checksum offload is off by default.
-Assign a packet whose 13th and 14th bytes are 0x0806 to queue 3.
+The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
-remove_flex_filter
+port config - VLAN
~~~~~~~~~~~~~~~~~~
-Remove a Flex filter
+Set hardware VLAN on or off for all ports::
-remove_flex_filter (port_id) index (idx)
-
-get_flex_filter
-~~~~~~~~~~~~~~~
+ testpmd> port config all hw-vlan (on|off)
-Get and display a Flex filter
+Hardware VLAN is on by default.
-get_flex_filter (port_id) index (idx)
+The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
-Example:
+port config - VLAN filter
+~~~~~~~~~~~~~~~~~~~~~~~~~
-.. code-block:: console
+Set hardware VLAN filter on or off for all ports::
- testpmd> get_flex_filter 0 index 0
+ testpmd> port config all hw-vlan-filter (on|off)
- filter[0]:
+Hardware VLAN filter is on by default.
- length: 16
+The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
- 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
+port config - VLAN strip
+~~~~~~~~~~~~~~~~~~~~~~~~
- mask[]:
- 0b0000000000001100000000000000000000000000000000000000000000000000000000
- 0000000000000000000000000000000000000000000000000000000000
+Set hardware VLAN strip on or off for all ports::
- priority: 3 queue: 3
+ testpmd> port config all hw-vlan-strip (on|off)
-set link up
-~~~~~~~~~~~
+Hardware VLAN strip is on by default.
-Set link up for a port.
+The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
-set link-up port (port id)
+port config - VLAN extend
+~~~~~~~~~~~~~~~~~~~~~~~~~
-set link down
-~~~~~~~~~~~~~
+Set hardware VLAN extend on or off for all ports::
-Set link down for a port.
+ testpmd> port config all hw-vlan-extend (on|off)
-set link-down port (port id)
+Hardware VLAN extend is off by default.
-Port Functions
---------------
+The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
-The following sections show functions for configuring ports.
+port config - Drop Packets
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. note::
+Set packet drop for packets with no descriptors on or off for all ports::
- Port configuration changes only become active when forwarding is started/restarted.
+ testpmd> port config all drop-en (on|off)
-port start
-~~~~~~~~~~
+Packet dropping for packets with no descriptors is off by default.
-Start all ports or a specific port:
+The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
-port start (port_id|all)
+port config - RSS
+~~~~~~~~~~~~~~~~~
-port stop
-~~~~~~~~~
+Set the RSS (Receive Side Scaling) mode on or off::
-Stop all ports or a specific port:
+ testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none)
-port stop (port_id|all)
+RSS is on by default.
-port close
-~~~~~~~~~~
+The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
+
+port config - RSS Reta
+~~~~~~~~~~~~~~~~~~~~~~
-Close all ports or a specific port:
+Set the RSS (Receive Side Scaling) redirection table::
-port close (port_id|all)
+ testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
-port start/stop queue
-~~~~~~~~~~~~~~~~~~~~~
+port config - DCB
+~~~~~~~~~~~~~~~~~
-Start/stop a rx/tx queue on a specific port:
+Set the DCB mode for an individual port::
-port (port_id) (rxq|txq) (queue_id) (start|stop)
+ testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
-Only take effect when port is started.
+The traffic class should be 4 or 8.
-port config - speed
+port config - Burst
~~~~~~~~~~~~~~~~~~~
-Set the speed and duplex mode for all ports or a specific port:
+Set the number of packets per burst::
-port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
+ testpmd> port config all burst (value)
-port config - queues/descriptors
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+This is equivalent to the ``--burst`` command-line option.
-Set number of queues/descriptors for rxq, txq, rxd and txd:
+port config - Threshold
+~~~~~~~~~~~~~~~~~~~~~~~
-port config all (rxq|txq|rxd|txd) (value)
+Set thresholds for TX/RX queues::
-This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
+ testpmd> port config all (threshold) (value)
-port config - max-pkt-len
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Where the threshold type can be:
-Set the maximum packet length:
+* ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
-port config all max-pkt-len (value)
+* ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
-This is equivalent to the --max-pkt-len command-line option.
+* ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
-port config - CRC Strip
-~~~~~~~~~~~~~~~~~~~~~~~
+* ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
-Set hardware CRC stripping on or off for all ports:
+* ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
-port config all crc-strip (on|off)
+* ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
-CRC stripping is off by default.
+* ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
-The on option is equivalent to the --crc-strip command-line option.
+* ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
-port config - RX Checksum
-~~~~~~~~~~~~~~~~~~~~~~~~~
+* ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
-Set hardware RX checksum offload to on or off for all ports:
+These threshold options are also available from the command-line.
-port config all rx-cksum (on|off)
+port config - E-tag
+~~~~~~~~~~~~~~~~~~~
-Checksum offload is off by default.
+Set the value of ether-type for E-tag::
-The on option is equivalent to the --enable-rx-cksum command-line option.
+ testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
-port config - VLAN
-~~~~~~~~~~~~~~~~~~
+Enable/disable the E-tag support::
-Set hardware VLAN on or off for all ports:
+ testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
-port config all hw-vlan (on|off)
-Hardware VLAN is on by default.
+Link Bonding Functions
+----------------------
-The off option is equivalent to the --disable-hw-vlan command-line option.
+The Link Bonding functions make it possible to dynamically create and
+manage link bonding devices from within testpmd interactive prompt.
-port config - Drop Packets
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+create bonded device
+~~~~~~~~~~~~~~~~~~~~
-Set packet drop for packets with no descriptors on or off for all ports:
+Create a new bonding device::
-port config all drop-en (on|off)
+ testpmd> create bonded device (mode) (socket)
-Packet dropping for packets with no descriptors is off by default.
+For example, to create a bonded device in mode 1 on socket 0::
-The on option is equivalent to the --enable-drop-en command-line option.
+ testpmd> create bonded 1 0
+ created new bonded device (port X)
-port config - RSS
+add bonding slave
~~~~~~~~~~~~~~~~~
-Set the RSS (Receive Side Scaling) mode on or off:
+Adds Ethernet device to a Link Bonding device::
-port config all rss (ip|udp|none)
+ testpmd> add bonding slave (slave id) (port id)
-RSS is on by default.
+For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
-The off option is equivalent to the --disable-rss command-line option.
+ testpmd> add bonding slave 6 10
-port config - RSS Reta
+
+remove bonding slave
+~~~~~~~~~~~~~~~~~~~~
+
+Removes an Ethernet slave device from a Link Bonding device::
+
+ testpmd> remove bonding slave (slave id) (port id)
+
+For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
+
+ testpmd> remove bonding slave 6 10
+
+set bonding mode
+~~~~~~~~~~~~~~~~
+
+Set the Link Bonding mode of a Link Bonding device::
+
+ testpmd> set bonding mode (value) (port id)
+
+For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
+
+ testpmd> set bonding mode 3 10
+
+set bonding primary
+~~~~~~~~~~~~~~~~~~~
+
+Set an Ethernet slave device as the primary device on a Link Bonding device::
+
+ testpmd> set bonding primary (slave id) (port id)
+
+For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
+
+ testpmd> set bonding primary 6 10
+
+set bonding mac
+~~~~~~~~~~~~~~~
+
+Set the MAC address of a Link Bonding device::
+
+ testpmd> set bonding mac (port id) (mac)
+
+For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
+
+ testpmd> set bonding mac 10 00:00:00:00:00:01
+
+set bonding xmit_balance_policy
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
+
+ testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
+
+For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
+
+ testpmd> set bonding xmit_balance_policy 10 l34
+
+
+set bonding mon_period
~~~~~~~~~~~~~~~~~~~~~~
-Set the RSS (Receive Side Scaling) redirection table:
+Set the link status monitoring polling period in milliseconds for a bonding device.
-port config all rss reta (hash,queue)[,(hash,queue)]
+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::
-port config - DCB
-~~~~~~~~~~~~~~~~~
+ testpmd> set bonding mon_period (port_id) (value)
-Set the DCB mode for an individual port:
+For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
-port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
+ testpmd> set bonding mon_period 5 150
-The traffic class should be 4 or 8.
-port config - Burst
+show bonding config
~~~~~~~~~~~~~~~~~~~
-Set the number of packets per burst:
+Show the current configuration of a Link Bonding device::
-port config all burst (value)
+ testpmd> show bonding config (port id)
-This is equivalent to the --burst command-line option.
+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::
-port config - Threshold
-~~~~~~~~~~~~~~~~~~~~~~~
+ 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 thresholds for TX/RX queues:
-port config all (threshold) (value)
+Register Functions
+------------------
-Where the threshold type can be:
+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
+~~~~~~~~
-* txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
+Display the value of a port register::
-* txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
+ testpmd> read reg (port_id) (address)
-* txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
+For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
-* rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
+ testpmd> read reg 0 0xEE00
+ port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
-* rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
+read regfield
+~~~~~~~~~~~~~
-* rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
+Display a port register bit field::
-* txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
+ testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
-* rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
+For example, reading the lowest two bits from the register in the example above::
-* txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
- These threshold options are also available from the command-line.
+ testpmd> read regfield 0 0xEE00 0 1
+ port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
-Flow Director Functions
------------------------
+read regbit
+~~~~~~~~~~~
-The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
+Display a single port register bit::
-Two types of filtering are supported which are referred to as Perfect Match and Signature filters:
+ testpmd> read regbit (port_id) (address) (bit_x)
-* Perfect match filters.
- The hardware checks a match between the masked fields of the received packets and the programmed filters.
+For example, reading the lowest bit from the register in the example above::
-* Signature filters.
- The hardware checks a match between a hash-based signature of the masked fields of the received packet.
+ testpmd> read regbit 0 0xEE00 0
+ port 0 PCI register at offset 0xEE00: bit 0=1
-The Flow Director filters can match the following fields in a packet:
+write reg
+~~~~~~~~~
-* Source IP and destination IP addresses.
+Set the value of a port register::
-* Source port and destination port numbers (for UDP and TCP packets).
+ testpmd> write reg (port_id) (address) (value)
-* IPv4/IPv6 and UDP/ TCP/SCTP protocol match.
+For example, to clear a register::
-* VLAN header.
+ testpmd> write reg 0 0xEE00 0x0
+ port 0 PCI register at offset 0xEE00: 0x00000000 (0)
-* Flexible 2-byte tuple match anywhere in the first 64 bytes of the packet.
+write regfield
+~~~~~~~~~~~~~~
-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.
+Set bit field of a port register::
-In the following sections, several common parameters are used in the Flow Director filters.
-These are explained below:
+ testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
-* src: A pair of source address values. The source IP, in IPv4 or IPv6 format, and the source port:
+For example, writing to the register cleared in the example above::
- src 192.168.0.1 1024
+ testpmd> write regfield 0 0xEE00 0 1 2
+ port 0 PCI register at offset 0xEE00: 0x00000002 (2)
+
+write regbit
+~~~~~~~~~~~~
- src 2001:DB8:85A3:0:0:8A2E:370:7000 1024
+Set single bit value of a port register::
-* dst: A pair of destination address values. The destination IP, in IPv4 or IPv6 format, and the destination port.
+ testpmd> write regbit (port_id) (address) (bit_x) (value)
-* flexbytes: A 2-byte tuple to be matched within the first 64 bytes of a packet.
+For example, to set the high bit in the register from the example above::
-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.
+ testpmd> write regbit 0 0xEE00 31 1
+ port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
-* vlan: The VLAN header to match in the packet.
-* queue: The index of the RX queue to route matched packets to.
+Filter Functions
+----------------
-* soft: The 16-bit value in the MBUF flow director ID field for RX packets matching the filter.
+This section details the available filter functions that are available.
-add_signature_filter
+Note these functions interface the deprecated legacy filtering framework,
+superseded by *rte_flow*. See `Flow rules management`_.
+
+ethertype_filter
~~~~~~~~~~~~~~~~~~~~
-Add a signature filter:
+Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
-# Command is displayed on several lines for clarity.
+ ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
+ ethertype (ether_type) (drop|fwd) queue (queue_id)
-add_signature_filter (port_id) (ip|udp|tcp|sctp)
+The available information parameters are:
- src (src_ip_address) (src_port)
+* ``port_id``: The port which the Ethertype filter assigned on.
- dst (dst_ip_address) (dst_port)
+* ``mac_addr``: Compare destination mac address.
- flexbytes (flexbytes_values)
+* ``mac_ignr``: Ignore destination mac address match.
- vlan (vlan_id) queue (queue_id)
+* ``mac_address``: Destination mac address to match.
-upd_signature_filter
-~~~~~~~~~~~~~~~~~~~~
+* ``ether_type``: The EtherType value want to match,
+ for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
-Update a signature filter:
+* ``queue_id``: The receive queue associated with this EtherType filter.
+ It is meaningless when deleting or dropping.
-# Command is displayed on several lines for clarity.
+Example, to add/remove an ethertype filter rule::
-upd_signature_filter (port_id) (ip|udp|tcp|sctp)
+ testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
+ ethertype 0x0806 fwd queue 3
- src (src_ip_address) (src_port)
+ testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
+ ethertype 0x0806 fwd queue 3
- dst (dst_ip_address) (dst_port)
+2tuple_filter
+~~~~~~~~~~~~~~~~~
- flexbytes (flexbytes_values)
+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::
- vlan (vlan_id) queue (queue_id)
+ 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
+ protocol (protocol_value) mask (mask_value) \
+ tcp_flags (tcp_flags_value) priority (prio_value) \
+ queue (queue_id)
-rm_signature_filter
-~~~~~~~~~~~~~~~~~~~
+The available information parameters are:
-Remove a signature filter:
+* ``port_id``: The port which the 2-tuple filter assigned on.
-# Command is displayed on several lines for clarity.
+* ``dst_port_value``: Destination port in L4.
-rm_signature_filter (port_id) (ip|udp|tcp|sctp)
+* ``protocol_value``: IP L4 protocol.
- src (src_ip_address) (src_port)
+* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
- dst (dst_ip_address) (dst_port)
+* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
- flexbytes (flexbytes_values)
+* ``prio_value``: Priority of this filter.
- vlan (vlan_id)
+* ``queue_id``: The receive queue associated with this 2-tuple filter.
-add_perfect_filter
-~~~~~~~~~~~~~~~~~~
+Example, to add/remove an 2tuple filter rule::
-Add a perfect filter:
+ testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
+ tcp_flags 0x02 priority 3 queue 3
-# Command is displayed on several lines for clarity.
+ testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
+ tcp_flags 0x02 priority 3 queue 3
-add_perfect_filter (port_id) (ip|udp|tcp|sctp)
+5tuple_filter
+~~~~~~~~~~~~~~~~~
- src (src_ip_address) (src_port)
+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::
- dst (dst_ip_address) (dst_port)
+ 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)
- flexbytes (flexbytes_values)
+The available information parameters are:
- vlan (vlan_id) queue (queue_id) soft (soft_id)
+* ``port_id``: The port which the 5-tuple filter assigned on.
-upd_perfect_filter
-~~~~~~~~~~~~~~~~~~
+* ``dst_address``: Destination IP address.
-Update a perfect filter:
+* ``src_address``: Source IP address.
-# Command is displayed on several lines for clarity.
+* ``dst_port_value``: TCP/UDP destination port.
-upd_perfect_filter (port_id) (ip|udp|tcp|sctp)
+* ``src_port_value``: TCP/UDP source port.
- src (src_ip_address) (src_port)
+* ``protocol_value``: L4 protocol.
- dst (dst_ip_address) (dst_port)
+* ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
- flexbytes (flexbytes_values)
+* ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
- vlan (vlan_id) queue (queue_id)
+* ``prio_value``: The priority of this filter.
-rm_perfect_filter
-~~~~~~~~~~~~~~~~~
+* ``queue_id``: The receive queue associated with this 5-tuple filter.
-Remove a perfect filter:
+Example, to add/remove an 5tuple filter rule::
-rm_perfect_filter (port_id) (ip|udp|tcp|sctp)
+ 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
- src (src_ip_address) (src_port)
+ 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
- dst (dst_ip_address) (dst_port)
+syn_filter
+~~~~~~~~~~
- flexbytes (flexbytes_values)
+Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
- vlan (vlan_id) soft (soft_id)
+ syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
-set_masks_filter
-~~~~~~~~~~~~~~~~
+The available information parameters are:
-Set IPv4 filter masks:
+* ``port_id``: The port which the SYN filter assigned on.
-# Command is displayed on several lines for clarity.
+* ``high``: This SYN filter has higher priority than other filters.
-set_masks_filter (port_id) only_ip_flow (0|1)
+* ``low``: This SYN filter has lower priority than other filters.
- src_mask (ip_src_mask) (src_port_mask)
+* ``queue_id``: The receive queue associated with this SYN filter
- dst_mask (ip_dst_mask) (dst_port_mask)
+Example::
- flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
+ testpmd> syn_filter 0 add priority high queue 3
-set_ipv6_masks_filter
-~~~~~~~~~~~~~~~~~~~~~
+flex_filter
+~~~~~~~~~~~
-Set IPv6 filter masks:
+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::
-# Command is displayed on several lines for clarity.
+ flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
+ mask (mask_value) priority (prio_value) queue (queue_id)
-set_ipv6_masks_filter (port_id) only_ip_flow (0|1)
+The available information parameters are:
- src_mask (ip_src_mask) (src_port_mask)
+* ``port_id``: The port which the Flex filter is assigned on.
- dst_mask (ip_dst_mask) (dst_port_mask)
+* ``len_value``: Filter length in bytes, no greater than 128.
- flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
+* ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
- compare_dst (0|1)
+* ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
-Link Bonding Functions
-----------------------
+* ``prio_value``: The priority of this filter.
-The Link Bonding functions make it possible to dynamically create and
-manage link bonding devices from within testpmd interactive prompt.
+* ``queue_id``: The receive queue associated with this Flex filter.
-create bonded device
+Example::
+
+ testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
+ mask 000C priority 3 queue 3
+
+ testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
+ mask 000C priority 3 queue 3
+
+
+.. _testpmd_flow_director:
+
+flow_director_filter
~~~~~~~~~~~~~~~~~~~~
-Create a new bonding device:
+The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
-create bonded device (mode) (socket)
+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
+~~~~~~~~~~~~~~~~~~~
-For example, to create a bonded device in mode 1 on socket 0.
+Flush all flow director filters on a device::
-.. code-block:: console
+ testpmd> flush_flow_director (port_id)
- testpmd> create bonded 1 0
- created new bonded device (port X)
+Example, to flush all flow director filter on port 0::
-add bonding slave
-~~~~~~~~~~~~~~~~~
+ testpmd> flush_flow_director 0
-Adds Ethernet device to a Link Bonding device:
+flow_director_mask
+~~~~~~~~~~~~~~~~~~
-add bonding slave (slave id) (port id)
+Set flow director's input masks::
-For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
+ 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)
-.. code-block:: console
+ flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
- testpmd> add bonding slave 6 10
+ flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
+ mac (mac_value) tunnel-type (tunnel_type_value) \
+ tunnel-id (tunnel_id_value)
+Example, to set flow director mask on port 0::
-remove bonding slave
-~~~~~~~~~~~~~~~~~~~~
+ 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
-Removes an Ethernet slave device from a Link Bonding device:
+flow_director_flex_mask
+~~~~~~~~~~~~~~~~~~~~~~~
-remove bonding slave (slave id) (port id)
+set masks of flow director's flexible payload based on certain flow type::
-For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
+ 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)
-.. code-block:: console
+Example, to set flow director's flex mask for all flow type on port 0::
- testpmd> remove bonding slave 6 10
+ testpmd> flow_director_flex_mask 0 flow all \
+ (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
-set bonding mode
-~~~~~~~~~~~~~~~~
-Set the Link Bonding mode of a Link Bonding device:
+flow_director_flex_payload
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-set bonding mode (value) (port id)
+Configure flexible payload selection::
-For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
+ flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
-.. code-block:: console
+For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
- testpmd> set bonding mode 3 10
+ testpmd> flow_director_flex_payload 0 l4 \
+ (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
-set bonding primary
-~~~~~~~~~~~~~~~~~~~
+get_sym_hash_ena_per_port
+~~~~~~~~~~~~~~~~~~~~~~~~~
-Set an Ethernet slave device as the primary device on a Link Bonding device:
+Get symmetric hash enable configuration per port::
-set bonding primary (slave id) (port id)
+ get_sym_hash_ena_per_port (port_id)
-For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
+For example, to get symmetric hash enable configuration of port 1::
-.. code-block:: console
+ testpmd> get_sym_hash_ena_per_port 1
- testpmd> set bonding primary 6 10
+set_sym_hash_ena_per_port
+~~~~~~~~~~~~~~~~~~~~~~~~~
-set bonding mac
+Set symmetric hash enable configuration per port to enable or disable::
+
+ set_sym_hash_ena_per_port (port_id) (enable|disable)
+
+For example, to set symmetric hash enable configuration of port 1 to enable::
+
+ testpmd> set_sym_hash_ena_per_port 1 enable
+
+get_hash_global_config
+~~~~~~~~~~~~~~~~~~~~~~
+
+Get the global configurations of hash filters::
+
+ get_hash_global_config (port_id)
+
+For example, to get the global configurations of hash filters of port 1::
+
+ testpmd> get_hash_global_config 1
+
+set_hash_global_config
+~~~~~~~~~~~~~~~~~~~~~~
+
+Set the global configurations of hash filters::
+
+ set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
+ (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
+ ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
+ (enable|disable)
+
+For example, to enable simple_xor for flow type of ipv6 on port 2::
+
+ testpmd> set_hash_global_config 2 simple_xor ipv6 enable
+
+set_hash_input_set
+~~~~~~~~~~~~~~~~~~
+
+Set the input set for hash::
+
+ 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)
+
+For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
+
+ testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
+
+set_fdir_input_set
+~~~~~~~~~~~~~~~~~~
+
+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.
+
+Set the input set for flow director::
+
+ 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)
+
+For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
+
+ testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
+
+global_config
+~~~~~~~~~~~~~
+
+Set different GRE key length for input set::
+
+ global_config (port_id) gre-key-len (number in bytes)
+
+For example to set GRE key length for input set to 4 bytes on port 0::
+
+ testpmd> global_config 0 gre-key-len 4
+
+
+.. _testpmd_rte_flow:
+
+Flow rules management
+---------------------
+
+Control of the generic flow API (*rte_flow*) is fully exposed through the
+``flow`` command (validation, creation, destruction and queries).
+
+Considering *rte_flow* overlaps with all `Filter Functions`_, using both
+features simultaneously may cause undefined side-effects and is therefore
+not recommended.
+
+``flow`` syntax
~~~~~~~~~~~~~~~
-Set the MAC address of a Link Bonding device:
+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:
-set bonding mac (port id) (mac)
+- Pressing *?* or the *<tab>* key displays contextual help for the current
+ token, not that of the entire command.
-For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
+- Optional and repeated parameters are supported (provided they are listed
+ in the contextual help).
-.. code-block:: console
+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.
- testpmd> set bonding mac 10 00:00:00:00:00:01
+- Check whether a flow rule can be created::
-set bonding xmit_balance_policy
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ flow validate {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
+- Create a flow rule::
-set bonding xmit_balance_policy (port_id) (l2|l23|l34)
+ flow create {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
+- Destroy specific flow rules::
-.. code-block:: console
+ flow destroy {port_id} rule {rule_id} [...]
- testpmd> set bonding xmit_balance_policy 10 l34
+- Destroy all flow rules::
+ flow flush {port_id}
-set bonding mon_period
-~~~~~~~~~~~~~~~~~~~~~~
+- Query an existing flow rule::
-Set the link status monitoring polling period in milliseconds for a bonding devicie.
+ flow query {port_id} {rule_id} {action}
-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.
+- List existing flow rules sorted by priority, filtered by group
+ identifiers::
-set bonding mon_period (port_id) (value)
+ flow list {port_id} [group {group_id}] [...]
-For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
+Validating flow rules
+~~~~~~~~~~~~~~~~~~~~~
-.. code-block:: console
+``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()``::
- testpmd> set bonding mon_period 5 150
+ flow validate {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
+If successful, it will show::
-show bonding config
+ Flow rule validated
+
+Otherwise it will show an error message of the form::
+
+ Caught error type [...] ([...]): [...]
+
+This command uses the same parameters as ``flow create``, their format is
+described in `Creating flow rules`_.
+
+Check whether redirecting any Ethernet packet received on port 0 to RX queue
+index 6 is supported::
+
+ testpmd> flow validate 0 ingress pattern eth / end
+ actions queue index 6 / end
+ Flow rule validated
+ testpmd>
+
+Port 0 does not support TCPv6 rules::
+
+ testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
+ actions drop / end
+ Caught error type 9 (specific pattern item): Invalid argument
+ testpmd>
+
+Creating flow rules
~~~~~~~~~~~~~~~~~~~
-Show the current configuration of a Link Bonding device:
+``flow create`` validates and creates the specified flow rule. It is bound
+to ``rte_flow_create()``::
-show bonding config (port id)
+ flow create {port_id}
+ [group {group_id}] [priority {level}] [ingress] [egress]
+ pattern {item} [/ {item} [...]] / end
+ actions {action} [/ {action} [...]] / end
-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 return a flow rule ID usable with other commands::
-.. code-block:: console
+ Flow rule #[...] created
- 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 show an error message of the form::
-Register Functions
-------------------
+ Caught error type [...] ([...]): [...]
-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.
+Parameters describe in the following order:
-read reg
-~~~~~~~~
+- 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.
-Display the value of a port register:
+These translate directly to *rte_flow* objects provided as-is to the
+underlying functions.
-read reg (port_id) (address)
+The shortest valid definition only comprises mandatory tokens::
-For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel® 82599 10 GbE Controller:
+ testpmd> flow create 0 pattern end actions end
-.. code-block:: console
+Note that PMDs may refuse rules that essentially do nothing such as this
+one.
- testpmd> read reg 0 0xEE00
- port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
+**All unspecified object values are automatically initialized to 0.**
-read regfield
-~~~~~~~~~~~~~
+Attributes
+^^^^^^^^^^
-Display a port register bit field:
+These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
+specified before the ``pattern`` token.
-read regfield (port_id) (address) (bit_x) (bit_y)
+- ``group {group id}``: priority group.
+- ``priority {level}``: priority level within group.
+- ``ingress``: rule applies to ingress traffic.
+- ``egress``: rule applies to egress traffic.
-For example, reading the lowest two bits from the register in the example above:
+Each instance of an attribute specified several times overrides the previous
+value as shown below (group 4 is used)::
-.. code-block:: console
+ testpmd> flow create 0 group 42 group 24 group 4 [...]
- testpmd> read regfield 0 0xEE00 0 1
- port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
+Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
-read regbit
-~~~~~~~~~~~
+While not specifying a direction is an error, some rules may allow both
+simultaneously.
-Display a single port register bit:
+Most rules affect RX therefore contain the ``ingress`` token::
-read regbit (port_id) (address) (bit_x)
+ testpmd> flow create 0 ingress pattern [...]
-For example, reading the lowest bit from the register in the example above:
+Matching pattern
+^^^^^^^^^^^^^^^^
-.. code-block:: console
+A matching pattern starts after the ``pattern`` token. It is made of pattern
+items and is terminated by a mandatory ``end`` item.
- testpmd> read regbit 0 0xEE00 0
- port 0 PCI register at offset 0xEE00: bit 0=1
+Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
+rte_flow_item_type``).
-write reg
-~~~~~~~~~
+The ``/`` token is used as a separator between pattern items as shown
+below::
-Set the value of a port register:
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
-write reg (port_id) (address) (value)
+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::
-For example, to clear a register:
+ testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
-.. code-block:: console
+More information on these restrictions can be found in the *rte_flow*
+documentation.
- testpmd> write reg 0 0xEE00 0x0
- port 0 PCI register at offset 0xEE00: 0x00000000 (0)
+Several items support additional specification structures, for example
+``ipv4`` allows specifying source and destination addresses as follows::
-write regfield
-~~~~~~~~~~~~~~
+ testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
+ dst is 10.2.0.0 / end [...]
-Set bit field of a port register:
+This rule matches all IPv4 traffic with the specified properties.
-write regfield (port_id) (address) (bit_x) (bit_y) (value)
+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.
-For example, writing to the register cleared in the example above:
+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:
-.. code-block:: console
+- ``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.
- testpmd> write regfield 0 0xEE00 0 1 2
- port 0 PCI register at offset 0xEE00: 0x00000002 (2)
+These yield identical results::
-write regbit
-~~~~~~~~~~~~
+ ipv4 src is 10.1.1.1
-Set single bit value of a port register:
+::
-write regbit (port_id) (address) (bit_x) (value)
+ ipv4 src spec 10.1.1.1 src mask 255.255.255.255
-For example, to set the high bit in the register from the example above:
+::
-.. code-block:: console
+ ipv4 src spec 10.1.1.1 src prefix 32
+
+::
+
+ ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
+
+::
+
+ ipv4 src is 10.1.1.1 src last 0 # 0 disables range
+
+Inclusive ranges can be defined with ``last``::
+
+ ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
+
+Note that ``mask`` affects both ``spec`` and ``last``::
+
+ 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
+
+Properties can be modified multiple times::
+
+ ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
+
+::
+
+ ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
+
+Pattern items
+^^^^^^^^^^^^^
+
+This section lists supported pattern items and their attributes, if any.
+
+- ``end``: end list of pattern items.
+
+- ``void``: no-op pattern item.
+
+- ``invert``: perform actions when pattern does not match.
+
+- ``any``: match any protocol for the current layer.
+
+ - ``num {unsigned}``: number of layers covered.
+
+- ``pf``: match packets addressed to the physical function.
+
+- ``vf``: match packets addressed to a virtual function ID.
+
+ - ``id {unsigned}``: destination VF ID.
+
+- ``port``: device-specific physical port index to use.
+
+ - ``index {unsigned}``: physical port index.
+
+- ``raw``: match an arbitrary byte string.
+
+ - ``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.
+
+- ``eth``: match Ethernet header.
+
+ - ``dst {MAC-48}``: destination MAC.
+ - ``src {MAC-48}``: source MAC.
+ - ``type {unsigned}``: EtherType.
+
+- ``vlan``: match 802.1Q/ad VLAN tag.
+
+ - ``tpid {unsigned}``: tag protocol identifier.
+ - ``tci {unsigned}``: tag control information.
+ - ``pcp {unsigned}``: priority code point.
+ - ``dei {unsigned}``: drop eligible indicator.
+ - ``vid {unsigned}``: VLAN identifier.
+
+- ``ipv4``: match IPv4 header.
+
+ - ``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.
+
+- ``ipv6``: match IPv6 header.
+
+ - ``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.
+
+- ``icmp``: match ICMP header.
+
+ - ``type {unsigned}``: ICMP packet type.
+ - ``code {unsigned}``: ICMP packet code.
+
+- ``udp``: match UDP header.
+
+ - ``src {unsigned}``: UDP source port.
+ - ``dst {unsigned}``: UDP destination port.
+
+- ``tcp``: match TCP header.
+
+ - ``src {unsigned}``: TCP source port.
+ - ``dst {unsigned}``: TCP destination port.
+
+- ``sctp``: match SCTP header.
+
+ - ``src {unsigned}``: SCTP source port.
+ - ``dst {unsigned}``: SCTP destination port.
+ - ``tag {unsigned}``: validation tag.
+ - ``cksum {unsigned}``: checksum.
+
+- ``vxlan``: match VXLAN header.
+
+ - ``vni {unsigned}``: VXLAN identifier.
+
+Actions list
+^^^^^^^^^^^^
+
+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.
+
+Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
+rte_flow_action_type``).
+
+Dropping all incoming UDPv4 packets can be expressed as follows::
+
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
+ actions drop / end
+
+Several actions have configurable properties which must be specified when
+there is no valid default value. For example, ``queue`` requires a target
+queue index.
+
+This rule redirects incoming UDPv4 traffic to queue index 6::
+
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
+ actions queue index 6 / end
+
+While this one could be rejected by PMDs (unspecified queue index)::
+
+ testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
+ actions queue / end
+
+As defined by *rte_flow*, the list is not ordered, all actions of a given
+rule are performed simultaneously. These are equivalent::
+
+ queue index 6 / void / mark id 42 / end
+
+::
+
+ void / mark id 42 / queue index 6 / end
+
+All actions in a list should have different types, otherwise only the last
+action of a given type is taken into account::
+
+ queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
+
+::
+
+ drop / drop / drop / end # drop is performed only once
+
+::
+
+ 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::
+
+ drop / queue index 6 / end # drop has no effect
+
+::
+
+ drop / dup index 6 / end # same as above
+
+::
+
+ queue index 6 / rss queues 6 7 8 / end # queue has no effect
+
+::
+
+ drop / passthru / end # drop has no effect
+
+Note that PMDs may still refuse such combinations.
+
+Actions
+^^^^^^^
+
+This section lists supported actions and their attributes, if any.
+
+- ``end``: end list of actions.
+
+- ``void``: no-op action.
+
+- ``passthru``: let subsequent rule process matched packets.
+
+- ``mark``: attach 32 bit value to packets.
+
+ - ``id {unsigned}``: 32 bit value to return with packets.
+
+- ``flag``: flag packets.
+
+- ``queue``: assign packets to a given queue index.
+
+ - ``index {unsigned}``: queue index to use.
+
+- ``drop``: drop packets (note: passthru has priority).
+
+- ``count``: enable counters for this rule.
+
+- ``dup``: duplicate packets to a given queue index.
+
+ - ``index {unsigned}``: queue index to duplicate packets to.
+
+- ``rss``: spread packets among several queues.
+
+ - ``queues [{unsigned} [...]] end``: queue indices to use.
+
+- ``pf``: redirect packets to physical device function.
+
+- ``vf``: redirect packets to virtual device function.
+
+ - ``original {boolean}``: use original VF ID if possible.
+ - ``id {unsigned}``: VF ID to redirect packets to.
+
+Destroying flow rules
+~~~~~~~~~~~~~~~~~~~~~
+
+``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::
+
+ flow destroy {port_id} rule {rule_id} [...]
+
+If successful, it will show::
+
+ Flow rule #[...] destroyed
+
+It does not report anything for rule IDs that do not exist. The usual error
+message is shown when a rule cannot be destroyed::
+
+ Caught error type [...] ([...]): [...]
+
+``flow flush`` destroys all rules on a device and does not take extra
+arguments. It is bound to ``rte_flow_flush()``::
+
+ flow flush {port_id}
+
+Any errors are reported as above.
+
+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>
+
+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
+~~~~~~~~~~~~~~~~~~~
+
+``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()``::
+
+ flow query {port_id} {rule_id} {action}
+
+If successful, it will display either the retrieved data for known actions
+or the following message::
+
+ Cannot display result for action type [...] ([...])
+
+Otherwise, it will complain either that the rule does not exist or that some
+error occurred::
+
+ Flow rule #[...] not found
+
+::
+
+ Caught error type [...] ([...]): [...]
+
+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::
+
+ 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
+
+Querying counters for TCPv6 packets redirected to queue 6::
+
+ 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>
+
+Listing flow rules
+~~~~~~~~~~~~~~~~~~
- testpmd> write regbit 0 0xEE00 31 1
- port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
+``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>
git.droids-corp.org / dpdk.git / blobdiff