1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2010-2016 Intel Corporation.
6 Testpmd Runtime Functions
7 =========================
9 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
10 it displays a prompt that can be used to start and stop forwarding,
11 configure the application, display statistics (including the extended NIC
12 statistics aka xstats) , set the Flow Director and other tasks::
16 The testpmd prompt has some, limited, readline support.
17 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
18 as well as access to the command history via the up-arrow.
20 There is also support for tab completion.
21 If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
23 .. code-block:: console
25 testpmd> show port <TAB>
27 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
28 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
29 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
30 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
36 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
38 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
39 (pause_time) (send_xon) (port_id)
41 In the real ``testpmd>`` prompt these commands should be on a single line.
46 The testpmd has on-line help for the functions that are available at runtime.
47 These are divided into sections and can be accessed using help, help section or help all:
49 .. code-block:: console
53 help control : Start and stop forwarding.
54 help display : Displaying port, stats and config information.
55 help config : Configuration information.
56 help ports : Configuring ports.
57 help registers : Reading and setting port registers.
58 help filters : Filters configuration help.
59 help all : All of the above sections.
62 Command File Functions
63 ----------------------
65 To facilitate loading large number of commands or to avoid cutting and pasting where not
66 practical or possible testpmd supports alternative methods for executing commands.
68 * If started with the ``--cmdline-file=FILENAME`` command line argument testpmd
69 will execute all CLI commands contained within the file immediately before
70 starting packet forwarding or entering interactive mode.
72 .. code-block:: console
74 ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
75 Interactive-mode selected
76 CLI commands to be read from /home/ubuntu/flow-create-commands.txt
77 Configuring Port 0 (socket 0)
78 Port 0: 7C:FE:90:CB:74:CE
79 Configuring Port 1 (socket 0)
80 Port 1: 7C:FE:90:CB:74:CA
81 Checking link statuses...
82 Port 0 Link Up - speed 10000 Mbps - full-duplex
83 Port 1 Link Up - speed 10000 Mbps - full-duplex
89 Flow rule #498 created
90 Flow rule #499 created
91 Read all CLI commands from /home/ubuntu/flow-create-commands.txt
95 * At run-time additional commands can be loaded in bulk by invoking the ``load FILENAME``
98 .. code-block:: console
100 testpmd> load /home/ubuntu/flow-create-commands.txt
105 Flow rule #498 created
106 Flow rule #499 created
107 Read all CLI commands from /home/ubuntu/flow-create-commands.txt
111 In all cases output from any included command will be displayed as standard output.
112 Execution will continue until the end of the file is reached regardless of
113 whether any errors occur. The end user must examine the output to determine if
114 any failures occurred.
123 Start packet forwarding with current configuration::
130 Start packet forwarding with current configuration after sending specified number of bursts of packets::
132 testpmd> start tx_first (""|burst_num)
134 The default burst number is 1 when ``burst_num`` not presented.
139 Stop packet forwarding, and display accumulated statistics::
154 The functions in the following sections are used to display information about the
155 testpmd configuration or the NIC status.
160 Display information for a given port or all ports::
162 testpmd> show port (info|stats|xstats|fdir|stat_qmap|dcb_tc|cap) (port_id|all)
164 The available information categories are:
166 * ``info``: General port information such as MAC address.
168 * ``stats``: RX/TX statistics.
170 * ``xstats``: RX/TX extended NIC statistics.
172 * ``fdir``: Flow Director information and statistics.
174 * ``stat_qmap``: Queue statistics mapping.
176 * ``dcb_tc``: DCB information such as TC mapping.
178 * ``cap``: Supported offload capabilities.
182 .. code-block:: console
184 testpmd> show port info 0
186 ********************* Infos for port 0 *********************
188 MAC address: XX:XX:XX:XX:XX:XX
190 memory allocation on the socket: 0
192 Link speed: 40000 Mbps
193 Link duplex: full-duplex
194 Promiscuous mode: enabled
195 Allmulticast mode: disabled
196 Maximum number of MAC addresses: 64
197 Maximum number of MAC addresses of hash filtering: 0
202 Redirection table size: 512
203 Supported flow types:
223 Display the rss redirection table entry indicated by masks on port X::
225 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
227 size is used to indicate the hardware supported reta size
232 Display the RSS hash functions and RSS hash key of a port::
234 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]
239 Clear the port statistics for a given port or for all ports::
241 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
245 testpmd> clear port stats all
250 Display information for a given port's RX/TX queue::
252 testpmd> show (rxq|txq) info (port_id) (queue_id)
257 Displays the configuration of the application.
258 The configuration comes from the command-line, the runtime or the application defaults::
260 testpmd> show config (rxtx|cores|fwd|txpkts)
262 The available information categories are:
264 * ``rxtx``: RX/TX configuration items.
266 * ``cores``: List of forwarding cores.
268 * ``fwd``: Packet forwarding configuration.
270 * ``txpkts``: Packets to TX configuration.
274 .. code-block:: console
276 testpmd> show config rxtx
278 io packet forwarding - CRC stripping disabled - packets/burst=16
279 nb forwarding cores=2 - nb forwarding ports=1
280 RX queues=1 - RX desc=128 - RX free threshold=0
281 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
282 TX queues=1 - TX desc=512 - TX free threshold=0
283 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
284 TX RS bit threshold=0 - TXQ flags=0x0
289 Set the packet forwarding mode::
291 testpmd> set fwd (io|mac|macswap|flowgen| \
292 rxonly|txonly|csum|icmpecho) (""|retry)
294 ``retry`` can be specified for forwarding engines except ``rx_only``.
296 The available information categories are:
298 * ``io``: Forwards packets "as-is" in I/O mode.
299 This is the fastest possible forwarding operation as it does not access packets data.
300 This is the default mode.
302 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
303 Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination
304 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
305 'eth-peer-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
307 * ``macswap``: MAC swap forwarding mode.
308 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
310 * ``flowgen``: Multi-flow generation mode.
311 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
313 * ``rxonly``: Receives packets but doesn't transmit them.
315 * ``txonly``: Generates and transmits packets without receiving any.
317 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
319 * ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
321 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
323 * ``tm``: Traffic Management forwarding mode
324 Demonstrates the use of ethdev traffic management APIs and softnic PMD for
325 QoS traffic management. In this mode, 5-level hierarchical QoS scheduler is
326 available as an default option that can be enabled through CLI. The user can
327 also modify the default hierarchy or specify the new hierarchy through CLI for
328 implementing QoS scheduler. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y`` ``CONFIG_RTE_LIBRTE_SCHED=y``.
332 testpmd> set fwd rxonly
334 Set rxonly packet forwarding mode
340 Display an RX descriptor for a port RX queue::
342 testpmd> read rxd (port_id) (queue_id) (rxd_id)
346 testpmd> read rxd 0 0 4
347 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
352 Display a TX descriptor for a port TX queue::
354 testpmd> read txd (port_id) (queue_id) (txd_id)
358 testpmd> read txd 0 0 4
359 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
364 Get loaded dynamic device personalization (DDP) package info list::
366 testpmd> ddp get list (port_id)
371 Display information about dynamic device personalization (DDP) profile::
373 testpmd> ddp get info (profile_path)
378 Display VF statistics::
380 testpmd> show vf stats (port_id) (vf_id)
385 Reset VF statistics::
387 testpmd> clear vf stats (port_id) (vf_id)
389 show port pctype mapping
390 ~~~~~~~~~~~~~~~~~~~~~~~~
392 List all items from the pctype mapping table::
394 testpmd> show port (port_id) pctype mapping
397 Configuration Functions
398 -----------------------
400 The testpmd application can be configured from the runtime as well as from the command-line.
402 This section details the available configuration functions that are available.
406 Configuration changes only become active when forwarding is started/restarted.
411 Reset forwarding to the default configuration::
418 Set the debug verbosity level::
420 testpmd> set verbose (level)
422 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
427 Set the log level for a log type::
429 testpmd> set log global|(type) (level)
433 * ``type`` is the log name.
435 * ``level`` is the log level.
437 For example, to change the global log level::
438 testpmd> set log global (level)
440 Regexes can also be used for type. To change log level of user1, user2 and user3::
441 testpmd> set log user[1-3] (level)
446 Set the number of ports used by the application:
450 This is equivalent to the ``--nb-ports`` command-line option.
455 Set the number of cores used by the application::
457 testpmd> set nbcore (num)
459 This is equivalent to the ``--nb-cores`` command-line option.
463 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
468 Set the forwarding cores hexadecimal mask::
470 testpmd> set coremask (mask)
472 This is equivalent to the ``--coremask`` command-line option.
476 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
481 Set the forwarding ports hexadecimal mask::
483 testpmd> set portmask (mask)
485 This is equivalent to the ``--portmask`` command-line option.
490 Set number of packets per burst::
492 testpmd> set burst (num)
494 This is equivalent to the ``--burst command-line`` option.
496 When retry is enabled, the transmit delay time and number of retries can also be set::
498 testpmd> set burst tx delay (microseconds) retry (num)
503 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
505 testpmd> set txpkts (x[,y]*)
507 Where x[,y]* represents a CSV list of values, without white space.
512 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
514 testpmd> set txsplit (off|on|rand)
518 * ``off`` disable packet copy & split for CSUM mode.
520 * ``on`` split outgoing packet into multiple segments. Size of each segment
521 and number of segments per packet is determined by ``set txpkts`` command
524 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
529 Set the list of forwarding cores::
531 testpmd> set corelist (x[,y]*)
533 For example, to change the forwarding cores:
535 .. code-block:: console
537 testpmd> set corelist 3,1
538 testpmd> show config fwd
540 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
541 Logical Core 3 (socket 0) forwards packets on 1 streams:
542 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
543 Logical Core 1 (socket 0) forwards packets on 1 streams:
544 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
548 The cores are used in the same order as specified on the command line.
553 Set the list of forwarding ports::
555 testpmd> set portlist (x[,y]*)
557 For example, to change the port forwarding:
559 .. code-block:: console
561 testpmd> set portlist 0,2,1,3
562 testpmd> show config fwd
564 io packet forwarding - ports=4 - cores=1 - streams=4
565 Logical Core 3 (socket 0) forwards packets on 4 streams:
566 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
567 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
568 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
569 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
574 Enable/disable tx loopback::
576 testpmd> set tx loopback (port_id) (on|off)
581 set drop enable bit for all queues::
583 testpmd> set all queues drop (port_id) (on|off)
585 set split drop enable (for VF)
586 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
588 set split drop enable bit for VF from PF::
590 testpmd> set vf split drop (port_id) (vf_id) (on|off)
592 set mac antispoof (for VF)
593 ~~~~~~~~~~~~~~~~~~~~~~~~~~
595 Set mac antispoof for a VF from the PF::
597 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
602 Enable/disable MACsec offload::
604 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
605 testpmd> set macsec offload (port_id) off
610 Configure MACsec secure connection (SC)::
612 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
616 The pi argument is ignored for tx.
617 Check the NIC Datasheet for hardware limits.
622 Configure MACsec secure association (SA)::
624 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
628 The IDX value must be 0 or 1.
629 Check the NIC Datasheet for hardware limits.
631 set broadcast mode (for VF)
632 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
634 Set broadcast mode for a VF from the PF::
636 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
641 Set the VLAN strip on a port::
643 testpmd> vlan set strip (on|off) (port_id)
648 Set the VLAN strip for a queue on a port::
650 testpmd> vlan set stripq (on|off) (port_id,queue_id)
652 vlan set stripq (for VF)
653 ~~~~~~~~~~~~~~~~~~~~~~~~
655 Set VLAN strip for all queues in a pool for a VF from the PF::
657 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
659 vlan set insert (for VF)
660 ~~~~~~~~~~~~~~~~~~~~~~~~
662 Set VLAN insert for a VF from the PF::
664 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
666 vlan set tag (for VF)
667 ~~~~~~~~~~~~~~~~~~~~~
669 Set VLAN tag for a VF from the PF::
671 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
673 vlan set antispoof (for VF)
674 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
676 Set VLAN antispoof for a VF from the PF::
678 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
683 Set the VLAN filter on a port::
685 testpmd> vlan set filter (on|off) (port_id)
690 Set the VLAN QinQ (extended queue in queue) on for a port::
692 testpmd> vlan set qinq (on|off) (port_id)
697 Set the inner or outer VLAN TPID for packet filtering on a port::
699 testpmd> vlan set (inner|outer) tpid (value) (port_id)
703 TPID value must be a 16-bit number (value <= 65536).
708 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
710 testpmd> rx_vlan add (vlan_id|all) (port_id)
714 VLAN filter must be set on that port. VLAN ID < 4096.
715 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
716 in VFTA table. This is important if enabling all vlan_ids.
721 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
723 testpmd> rx_vlan rm (vlan_id|all) (port_id)
728 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
730 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
735 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
737 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
742 Add a tunnel filter on a port::
744 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
745 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
746 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
748 The available information categories are:
750 * ``vxlan``: Set tunnel type as VXLAN.
752 * ``nvgre``: Set tunnel type as NVGRE.
754 * ``ipingre``: Set tunnel type as IP-in-GRE.
756 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
758 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
760 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
762 * ``imac``: Set filter type as Inner MAC.
764 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
766 * ``oip``: Set filter type as Outer IP.
768 * ``iip``: Set filter type as Inner IP.
772 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
773 192.168.2.2 0 ipingre oip 1 1
775 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
780 Remove a tunnel filter on a port::
782 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
783 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
784 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
789 Add an UDP port for VXLAN packet filter on a port::
791 testpmd> rx_vxlan_port add (udp_port) (port_id)
796 Remove an UDP port for VXLAN packet filter on a port::
798 testpmd> rx_vxlan_port rm (udp_port) (port_id)
803 Set hardware insertion of VLAN IDs in packets sent on a port::
805 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
807 For example, set a single VLAN ID (5) insertion on port 0::
811 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
819 Set port based hardware insertion of VLAN ID in packets sent on a port::
821 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
826 Disable hardware insertion of a VLAN header in packets sent on a port::
828 testpmd> tx_vlan reset (port_id)
833 Select hardware or software calculation of the checksum when
834 transmitting a packet using the ``csum`` forwarding engine::
836 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
840 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
842 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
843 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
844 supported). See also the ``csum parse-tunnel`` command.
848 Check the NIC Datasheet for hardware limits.
853 Set RSS queue region span on a port::
855 testpmd> set port (port_id) queue-region region_id (value) \
856 queue_start_index (value) queue_num (value)
858 Set flowtype mapping on a RSS queue region on a port::
860 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
864 * For the flowtype(pctype) of packet,the specific index for each type has
865 been defined in file i40e_type.h as enum i40e_filter_pctype.
867 Set user priority mapping on a RSS queue region on a port::
869 testpmd> set port (port_id) queue-region UP (value) region_id (value)
871 Flush all queue region related configuration on a port::
873 testpmd> set port (port_id) queue-region flush (on|off)
877 * "on"is just an enable function which server for other configuration,
878 it is for all configuration about queue region from up layer,
879 at first will only keep in DPDK softwarestored in driver,
880 only after "flush on", it commit all configuration to HW.
881 "off" is just clean all configuration about queue region just now,
882 and restore all to DPDK i40e driver default config when start up.
884 Show all queue region related configuration info on a port::
886 testpmd> show port (port_id) queue-region
890 Queue region only support on PF by now, so these command is
891 only for configuration of queue region on PF port.
896 Define how tunneled packets should be handled by the csum forward
899 testpmd> csum parse-tunnel (on|off) (tx_port_id)
901 If enabled, the csum forward engine will try to recognize supported
902 tunnel headers (vxlan, gre, ipip).
904 If disabled, treat tunnel packets as non-tunneled packets (a inner
905 header is handled as a packet payload).
909 The port argument is the TX port like in the ``csum set`` command.
913 Consider a packet in packet like the following::
915 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
917 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
918 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
919 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
921 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
922 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
927 Display tx checksum offload configuration::
929 testpmd> csum show (port_id)
934 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
936 testpmd> tso set (segsize) (port_id)
940 Check the NIC datasheet for hardware limits.
945 Display the status of TCP Segmentation Offload::
947 testpmd> tso show (port_id)
952 Enable or disable GRO in ``csum`` forwarding engine::
954 testpmd> set port <port_id> gro on|off
956 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
957 packets received from the given port.
959 If disabled, packets received from the given port won't be performed
960 GRO. By default, GRO is disabled for all ports.
964 When enable GRO for a port, TCP/IPv4 packets received from the port
965 will be performed GRO. After GRO, all merged packets have bad
966 checksums, since the GRO library doesn't re-calculate checksums for
967 the merged packets. Therefore, if users want the merged packets to
968 have correct checksums, please select HW IP checksum calculation and
969 HW TCP checksum calculation for the port which the merged packets are
975 Display GRO configuration for a given port::
977 testpmd> show port <port_id> gro
982 Set the cycle to flush the GROed packets from reassembly tables::
984 testpmd> set gro flush <cycles>
986 When enable GRO, the csum forwarding engine performs GRO on received
987 packets, and the GROed packets are stored in reassembly tables. Users
988 can use this command to determine when the GROed packets are flushed
989 from the reassembly tables.
991 The ``cycles`` is measured in GRO operation times. The csum forwarding
992 engine flushes the GROed packets from the tables every ``cycles`` GRO
995 By default, the value of ``cycles`` is 1, which means flush GROed packets
996 from the reassembly tables as soon as one GRO operation finishes. The value
997 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
999 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1000 stack performance. Because the GROed packets are delayed to arrive the
1001 stack, thus causing more duplicated ACKs and TCP retransmissions.
1006 Toggle per-port GSO support in ``csum`` forwarding engine::
1008 testpmd> set port <port_id> gso on|off
1010 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1011 packets, transmitted on the given port.
1013 If disabled, packets transmitted on the given port will not undergo GSO.
1014 By default, GSO is disabled for all ports.
1018 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1019 port undergo GSO. Afterwards, the segmented packets are represented by
1020 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1021 of checksums for GSO'd segments in SW. As a result, if users want correct
1022 checksums in GSO segments, they should enable HW checksum calculation for
1025 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1026 by setting the following options in the csum forwarding engine:
1028 testpmd> csum set outer_ip hw <port_id>
1030 testpmd> csum set ip hw <port_id>
1032 testpmd> csum set tcp hw <port_id>
1037 Set the maximum GSO segment size (measured in bytes), which includes the
1038 packet header and the packet payload for GSO-enabled ports (global)::
1040 testpmd> set gso segsz <length>
1045 Display the status of Generic Segmentation Offload for a given port::
1047 testpmd> show port <port_id> gso
1052 Add an alternative MAC address to a port::
1054 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1059 Remove a MAC address from a port::
1061 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1063 mac_addr add (for VF)
1064 ~~~~~~~~~~~~~~~~~~~~~
1066 Add an alternative MAC address for a VF to a port::
1068 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1073 Set the default MAC address for a port::
1075 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1077 mac_addr set (for VF)
1078 ~~~~~~~~~~~~~~~~~~~~~
1080 Set the MAC address for a VF from the PF::
1082 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1087 Set the forwarding peer address for certain port::
1089 testpmd> set eth-peer (port_id) (perr_addr)
1091 This is equivalent to the ``--eth-peer`` command-line option.
1096 Set the unicast hash filter(s) on/off for a port::
1098 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1103 Set the promiscuous mode on for a port or for all ports.
1104 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1106 testpmd> set promisc (port_id|all) (on|off)
1111 Set the allmulti mode for a port or for all ports::
1113 testpmd> set allmulti (port_id|all) (on|off)
1115 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1117 set promisc (for VF)
1118 ~~~~~~~~~~~~~~~~~~~~
1120 Set the unicast promiscuous mode for a VF from PF.
1121 It's supported by Intel i40e NICs now.
1122 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1124 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1126 set allmulticast (for VF)
1127 ~~~~~~~~~~~~~~~~~~~~~~~~~
1129 Set the multicast promiscuous mode for a VF from PF.
1130 It's supported by Intel i40e NICs now.
1131 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1133 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1135 set tx max bandwidth (for VF)
1136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1138 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1140 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1142 set tc tx min bandwidth (for VF)
1143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1145 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1147 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1149 set tc tx max bandwidth (for VF)
1150 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1152 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1154 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1156 set tc strict link priority mode
1157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1159 Set some TCs' strict link priority mode on a physical port::
1161 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1163 set tc tx min bandwidth
1164 ~~~~~~~~~~~~~~~~~~~~~~~
1166 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1168 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1173 Set the link flow control parameter on a port::
1175 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1176 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1177 autoneg (on|off) (port_id)
1181 * ``high_water`` (integer): High threshold value to trigger XOFF.
1183 * ``low_water`` (integer): Low threshold value to trigger XON.
1185 * ``pause_time`` (integer): Pause quota in the Pause frame.
1187 * ``send_xon`` (0/1): Send XON frame.
1189 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1191 * ``autoneg``: Change the auto-negotiation parameter.
1196 Set the priority flow control parameter on a port::
1198 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1199 (pause_time) (priority) (port_id)
1203 * ``high_water`` (integer): High threshold value.
1205 * ``low_water`` (integer): Low threshold value.
1207 * ``pause_time`` (integer): Pause quota in the Pause frame.
1209 * ``priority`` (0-7): VLAN User Priority.
1214 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1216 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1218 For example, to set rx queue 2 on port 0 to mapping 5::
1220 testpmd>set stat_qmap rx 0 2 5
1222 set xstats-hide-zero
1223 ~~~~~~~~~~~~~~~~~~~~
1225 Set the option to hide zero values for xstats display::
1227 testpmd> set xstats-hide-zero on|off
1231 By default, the zero values are displayed for xstats.
1233 set port - rx/tx (for VF)
1234 ~~~~~~~~~~~~~~~~~~~~~~~~~
1236 Set VF receive/transmit from a port::
1238 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1240 set port - mac address filter (for VF)
1241 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1243 Add/Remove unicast or multicast MAC addr filter for a VF::
1245 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1246 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1248 set port - rx mode(for VF)
1249 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1251 Set the VF receive mode of a port::
1253 testpmd> set port (port_id) vf (vf_id) \
1254 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1256 The available receive modes are:
1258 * ``AUPE``: Accepts untagged VLAN.
1260 * ``ROPE``: Accepts unicast hash.
1262 * ``BAM``: Accepts broadcast packets.
1264 * ``MPE``: Accepts all multicast packets.
1266 set port - tx_rate (for Queue)
1267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1269 Set TX rate limitation for a queue on a port::
1271 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1273 set port - tx_rate (for VF)
1274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1276 Set TX rate limitation for queues in VF on a port::
1278 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1280 set port - mirror rule
1281 ~~~~~~~~~~~~~~~~~~~~~~
1283 Set pool or vlan type mirror rule for a port::
1285 testpmd> set port (port_id) mirror-rule (rule_id) \
1286 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1287 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1289 Set link mirror rule for a port::
1291 testpmd> set port (port_id) mirror-rule (rule_id) \
1292 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1294 For example to enable mirror traffic with vlan 0,1 to pool 0::
1296 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1298 reset port - mirror rule
1299 ~~~~~~~~~~~~~~~~~~~~~~~~
1301 Reset a mirror rule for a port::
1303 testpmd> reset port (port_id) mirror-rule (rule_id)
1308 Set the flush on RX streams before forwarding.
1309 The default is flush ``on``.
1310 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1312 testpmd> set flush_rx off
1317 Set the bypass mode for the lowest port on bypass enabled NIC::
1319 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1324 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1326 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1327 mode (normal|bypass|isolate) (port_id)
1331 * ``timeout``: Enable bypass after watchdog timeout.
1333 * ``os_on``: Enable bypass when OS/board is powered on.
1335 * ``os_off``: Enable bypass when OS/board is powered off.
1337 * ``power_on``: Enable bypass when power supply is turned on.
1339 * ``power_off``: Enable bypass when power supply is turned off.
1345 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1347 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1352 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1354 testpmd> show bypass config (port_id)
1359 Set link up for a port::
1361 testpmd> set link-up port (port id)
1366 Set link down for a port::
1368 testpmd> set link-down port (port id)
1373 Enable E-tag insertion for a VF on a port::
1375 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1377 Disable E-tag insertion for a VF on a port::
1379 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1381 Enable/disable E-tag stripping on a port::
1383 testpmd> E-tag set stripping (on|off) port (port_id)
1385 Enable/disable E-tag based forwarding on a port::
1387 testpmd> E-tag set forwarding (on|off) port (port_id)
1389 Add an E-tag forwarding filter on a port::
1391 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1393 Delete an E-tag forwarding filter on a port::
1394 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1399 Load a dynamic device personalization (DDP) profile and store backup profile::
1401 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1406 Delete a dynamic device personalization profile and restore backup profile::
1408 testpmd> ddp del (port_id) (backup_profile_path)
1413 List all items from the ptype mapping table::
1415 testpmd> ptype mapping get (port_id) (valid_only)
1419 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1421 Replace a specific or a group of software defined ptype with a new one::
1423 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1427 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1429 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1431 * ``pkt_type``: The new software ptype to replace the old ones.
1433 Update hardware defined ptype to software defined packet type mapping table::
1435 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1439 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1441 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1443 Reset ptype mapping table::
1445 testpmd> ptype mapping reset (port_id)
1450 The following sections show functions for configuring ports.
1454 Port configuration changes only become active when forwarding is started/restarted.
1459 Attach a port specified by pci address or virtual device args::
1461 testpmd> port attach (identifier)
1463 To attach a new pci device, the device should be recognized by kernel first.
1464 Then it should be moved under DPDK management.
1465 Finally the port can be attached to testpmd.
1467 For example, to move a pci device using ixgbe under DPDK management:
1469 .. code-block:: console
1471 # Check the status of the available devices.
1472 ./usertools/dpdk-devbind.py --status
1474 Network devices using DPDK-compatible driver
1475 ============================================
1478 Network devices using kernel driver
1479 ===================================
1480 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1483 # Bind the device to igb_uio.
1484 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1487 # Recheck the status of the devices.
1488 ./usertools/dpdk-devbind.py --status
1489 Network devices using DPDK-compatible driver
1490 ============================================
1491 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1493 To attach a port created by virtual device, above steps are not needed.
1495 For example, to attach a port whose pci address is 0000:0a:00.0.
1497 .. code-block:: console
1499 testpmd> port attach 0000:0a:00.0
1500 Attaching a new port...
1501 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1502 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1503 EAL: PCI memory mapped at 0x7f83bfa00000
1504 EAL: PCI memory mapped at 0x7f83bfa80000
1505 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1506 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1507 Port 0 is attached. Now total ports is 1
1510 For example, to attach a port created by pcap PMD.
1512 .. code-block:: console
1514 testpmd> port attach net_pcap0
1515 Attaching a new port...
1516 PMD: Initializing pmd_pcap for net_pcap0
1517 PMD: Creating pcap-backed ethdev on numa socket 0
1518 Port 0 is attached. Now total ports is 1
1521 In this case, identifier is ``net_pcap0``.
1522 This identifier format is the same as ``--vdev`` format of DPDK applications.
1524 For example, to re-attach a bonded port which has been previously detached,
1525 the mode and slave parameters must be given.
1527 .. code-block:: console
1529 testpmd> port attach net_bond_0,mode=0,slave=1
1530 Attaching a new port...
1531 EAL: Initializing pmd_bond for net_bond_0
1532 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1533 Port 0 is attached. Now total ports is 1
1540 Detach a specific port::
1542 testpmd> port detach (port_id)
1544 Before detaching a port, the port should be stopped and closed.
1546 For example, to detach a pci device port 0.
1548 .. code-block:: console
1550 testpmd> port stop 0
1553 testpmd> port close 0
1557 testpmd> port detach 0
1559 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1560 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1561 EAL: PCI memory unmapped at 0x7f83bfa00000
1562 EAL: PCI memory unmapped at 0x7f83bfa80000
1566 For example, to detach a virtual device port 0.
1568 .. code-block:: console
1570 testpmd> port stop 0
1573 testpmd> port close 0
1577 testpmd> port detach 0
1579 PMD: Closing pcap ethdev on numa socket 0
1580 Port 'net_pcap0' is detached. Now total ports is 0
1583 To remove a pci device completely from the system, first detach the port from testpmd.
1584 Then the device should be moved under kernel management.
1585 Finally the device can be removed using kernel pci hotplug functionality.
1587 For example, to move a pci device under kernel management:
1589 .. code-block:: console
1591 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
1593 ./usertools/dpdk-devbind.py --status
1595 Network devices using DPDK-compatible driver
1596 ============================================
1599 Network devices using kernel driver
1600 ===================================
1601 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1603 To remove a port created by a virtual device, above steps are not needed.
1608 Start all ports or a specific port::
1610 testpmd> port start (port_id|all)
1615 Stop all ports or a specific port::
1617 testpmd> port stop (port_id|all)
1622 Close all ports or a specific port::
1624 testpmd> port close (port_id|all)
1626 port start/stop queue
1627 ~~~~~~~~~~~~~~~~~~~~~
1629 Start/stop a rx/tx queue on a specific port::
1631 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1634 ~~~~~~~~~~~~~~~~~~~~~
1636 Setup a rx/tx queue on a specific port::
1638 testpmd> port (port_id) (rxq|txq) (queue_id) setup
1640 Only take effect when port is started.
1645 Set the speed and duplex mode for all ports or a specific port::
1647 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
1648 duplex (half|full|auto)
1650 port config - queues/descriptors
1651 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1653 Set number of queues/descriptors for rxq, txq, rxd and txd::
1655 testpmd> port config all (rxq|txq|rxd|txd) (value)
1657 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1659 port config - max-pkt-len
1660 ~~~~~~~~~~~~~~~~~~~~~~~~~
1662 Set the maximum packet length::
1664 testpmd> port config all max-pkt-len (value)
1666 This is equivalent to the ``--max-pkt-len`` command-line option.
1668 port config - CRC Strip
1669 ~~~~~~~~~~~~~~~~~~~~~~~
1671 Set hardware CRC stripping on or off for all ports::
1673 testpmd> port config all crc-strip (on|off)
1675 CRC stripping is on by default.
1677 The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option.
1679 port config - scatter
1680 ~~~~~~~~~~~~~~~~~~~~~~~
1682 Set RX scatter mode on or off for all ports::
1684 testpmd> port config all scatter (on|off)
1686 RX scatter mode is off by default.
1688 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
1690 port config - RX Checksum
1691 ~~~~~~~~~~~~~~~~~~~~~~~~~
1693 Set hardware RX checksum offload to on or off for all ports::
1695 testpmd> port config all rx-cksum (on|off)
1697 Checksum offload is off by default.
1699 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
1704 Set hardware VLAN on or off for all ports::
1706 testpmd> port config all hw-vlan (on|off)
1708 Hardware VLAN is off by default.
1710 The ``on`` option is equivalent to the ``--enable-hw-vlan`` command-line option.
1712 port config - VLAN filter
1713 ~~~~~~~~~~~~~~~~~~~~~~~~~
1715 Set hardware VLAN filter on or off for all ports::
1717 testpmd> port config all hw-vlan-filter (on|off)
1719 Hardware VLAN filter is off by default.
1721 The ``on`` option is equivalent to the ``--enable-hw-vlan-filter`` command-line option.
1723 port config - VLAN strip
1724 ~~~~~~~~~~~~~~~~~~~~~~~~
1726 Set hardware VLAN strip on or off for all ports::
1728 testpmd> port config all hw-vlan-strip (on|off)
1730 Hardware VLAN strip is off by default.
1732 The ``on`` option is equivalent to the ``--enable-hw-vlan-strip`` command-line option.
1734 port config - VLAN extend
1735 ~~~~~~~~~~~~~~~~~~~~~~~~~
1737 Set hardware VLAN extend on or off for all ports::
1739 testpmd> port config all hw-vlan-extend (on|off)
1741 Hardware VLAN extend is off by default.
1743 The ``on`` option is equivalent to the ``--enable-hw-vlan-extend`` command-line option.
1745 port config - Drop Packets
1746 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1748 Set packet drop for packets with no descriptors on or off for all ports::
1750 testpmd> port config all drop-en (on|off)
1752 Packet dropping for packets with no descriptors is off by default.
1754 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
1759 Set the RSS (Receive Side Scaling) mode on or off::
1761 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none)
1763 RSS is on by default.
1765 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
1766 The ``default`` option enables all supported RSS types reported by device info.
1767 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
1769 port config - RSS Reta
1770 ~~~~~~~~~~~~~~~~~~~~~~
1772 Set the RSS (Receive Side Scaling) redirection table::
1774 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
1779 Set the DCB mode for an individual port::
1781 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1783 The traffic class should be 4 or 8.
1788 Set the number of packets per burst::
1790 testpmd> port config all burst (value)
1792 This is equivalent to the ``--burst`` command-line option.
1794 port config - Threshold
1795 ~~~~~~~~~~~~~~~~~~~~~~~
1797 Set thresholds for TX/RX queues::
1799 testpmd> port config all (threshold) (value)
1801 Where the threshold type can be:
1803 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1805 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
1807 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1809 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1811 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
1813 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1815 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1817 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1819 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1821 These threshold options are also available from the command-line.
1826 Set the value of ether-type for E-tag::
1828 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
1830 Enable/disable the E-tag support::
1832 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
1834 port config pctype mapping
1835 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1837 Reset pctype mapping table::
1839 testpmd> port config (port_id) pctype mapping reset
1841 Update hardware defined pctype to software defined flow type mapping table::
1843 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
1847 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
1849 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
1851 port config input set
1852 ~~~~~~~~~~~~~~~~~~~~~
1854 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
1855 testpmd> port config (port_id) pctype (pctype_id) \
1856 (hash_inset|fdir_inset|fdir_flx_inset) \
1857 (get|set|clear) field (field_idx)
1859 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
1860 testpmd> port config (port_id) pctype (pctype_id) \
1861 (hash_inset|fdir_inset|fdir_flx_inset) clear all
1865 * ``pctype_id``: hardware packet classification types.
1866 * ``field_idx``: hardware field index.
1868 Link Bonding Functions
1869 ----------------------
1871 The Link Bonding functions make it possible to dynamically create and
1872 manage link bonding devices from within testpmd interactive prompt.
1874 create bonded device
1875 ~~~~~~~~~~~~~~~~~~~~
1877 Create a new bonding device::
1879 testpmd> create bonded device (mode) (socket)
1881 For example, to create a bonded device in mode 1 on socket 0::
1883 testpmd> create bonded 1 0
1884 created new bonded device (port X)
1889 Adds Ethernet device to a Link Bonding device::
1891 testpmd> add bonding slave (slave id) (port id)
1893 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
1895 testpmd> add bonding slave 6 10
1898 remove bonding slave
1899 ~~~~~~~~~~~~~~~~~~~~
1901 Removes an Ethernet slave device from a Link Bonding device::
1903 testpmd> remove bonding slave (slave id) (port id)
1905 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
1907 testpmd> remove bonding slave 6 10
1912 Set the Link Bonding mode of a Link Bonding device::
1914 testpmd> set bonding mode (value) (port id)
1916 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
1918 testpmd> set bonding mode 3 10
1923 Set an Ethernet slave device as the primary device on a Link Bonding device::
1925 testpmd> set bonding primary (slave id) (port id)
1927 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
1929 testpmd> set bonding primary 6 10
1934 Set the MAC address of a Link Bonding device::
1936 testpmd> set bonding mac (port id) (mac)
1938 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
1940 testpmd> set bonding mac 10 00:00:00:00:00:01
1942 set bonding xmit_balance_policy
1943 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1945 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
1947 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1949 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
1951 testpmd> set bonding xmit_balance_policy 10 l34
1954 set bonding mon_period
1955 ~~~~~~~~~~~~~~~~~~~~~~
1957 Set the link status monitoring polling period in milliseconds for a bonding device.
1959 This adds support for PMD slave devices which do not support link status interrupts.
1960 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1961 link status ISR will be queried every polling interval to check if their link status has changed::
1963 testpmd> set bonding mon_period (port_id) (value)
1965 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
1967 testpmd> set bonding mon_period 5 150
1970 set bonding lacp dedicated_queue
1971 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1973 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
1974 when in mode 4 (link-aggregration-802.3ad)::
1976 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
1979 set bonding agg_mode
1980 ~~~~~~~~~~~~~~~~~~~~
1982 Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad)::
1984 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
1990 Show the current configuration of a Link Bonding device::
1992 testpmd> show bonding config (port id)
1995 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1996 in balance mode with a transmission policy of layer 2+3::
1998 testpmd> show bonding config 9
2000 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2002 Active Slaves (3): [1 3 4]
2009 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2010 This is mainly useful for debugging purposes.
2011 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2012 and fields that can be accessed.
2017 Display the value of a port register::
2019 testpmd> read reg (port_id) (address)
2021 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2023 testpmd> read reg 0 0xEE00
2024 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2029 Display a port register bit field::
2031 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2033 For example, reading the lowest two bits from the register in the example above::
2035 testpmd> read regfield 0 0xEE00 0 1
2036 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2041 Display a single port register bit::
2043 testpmd> read regbit (port_id) (address) (bit_x)
2045 For example, reading the lowest bit from the register in the example above::
2047 testpmd> read regbit 0 0xEE00 0
2048 port 0 PCI register at offset 0xEE00: bit 0=1
2053 Set the value of a port register::
2055 testpmd> write reg (port_id) (address) (value)
2057 For example, to clear a register::
2059 testpmd> write reg 0 0xEE00 0x0
2060 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2065 Set bit field of a port register::
2067 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2069 For example, writing to the register cleared in the example above::
2071 testpmd> write regfield 0 0xEE00 0 1 2
2072 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2077 Set single bit value of a port register::
2079 testpmd> write regbit (port_id) (address) (bit_x) (value)
2081 For example, to set the high bit in the register from the example above::
2083 testpmd> write regbit 0 0xEE00 31 1
2084 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2086 Traffic Metering and Policing
2087 -----------------------------
2089 The following section shows functions for configuring traffic metering and
2090 policing on the ethernet device through the use of generic ethdev API.
2092 show port traffic management capability
2093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2095 Show traffic metering and policing capability of the port::
2097 testpmd> show port meter cap (port_id)
2099 add port meter profile (srTCM rfc2967)
2100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2102 Add meter profile (srTCM rfc2697) to the ethernet device::
2104 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2109 * ``profile_id``: ID for the meter profile.
2110 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2111 * ``cbs``: Committed Burst Size (CBS) (bytes).
2112 * ``ebs``: Excess Burst Size (EBS) (bytes).
2114 add port meter profile (trTCM rfc2968)
2115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2117 Add meter profile (srTCM rfc2698) to the ethernet device::
2119 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2120 (cir) (pir) (cbs) (pbs)
2124 * ``profile_id``: ID for the meter profile.
2125 * ``cir``: Committed information rate (bytes/second).
2126 * ``pir``: Peak information rate (bytes/second).
2127 * ``cbs``: Committed burst size (bytes).
2128 * ``pbs``: Peak burst size (bytes).
2130 add port meter profile (trTCM rfc4115)
2131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2133 Add meter profile (trTCM rfc4115) to the ethernet device::
2135 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2136 (cir) (eir) (cbs) (ebs)
2140 * ``profile_id``: ID for the meter profile.
2141 * ``cir``: Committed information rate (bytes/second).
2142 * ``eir``: Excess information rate (bytes/second).
2143 * ``cbs``: Committed burst size (bytes).
2144 * ``ebs``: Excess burst size (bytes).
2146 delete port meter profile
2147 ~~~~~~~~~~~~~~~~~~~~~~~~~
2149 Delete meter profile from the ethernet device::
2151 testpmd> del port meter profile (port_id) (profile_id)
2156 Create new meter object for the ethernet device::
2158 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2159 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2160 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2165 * ``mtr_id``: meter object ID.
2166 * ``profile_id``: ID for the meter profile.
2167 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2168 gets enabled at the time of creation, otherwise remains disabled.
2169 * ``g_action``: Policer action for the packet with green color.
2170 * ``y_action``: Policer action for the packet with yellow color.
2171 * ``r_action``: Policer action for the packet with red color.
2172 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2174 * ``shared``: When this parameter has a non-zero value, the meter object is
2175 shared by multiple flows. Otherwise, meter object is used by single flow.
2176 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2177 input color for the current meter object is determined by the latest meter
2178 object in the same flow. Otherwise, the current meter object uses the
2179 *dscp_table* to determine the input color.
2180 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2181 color, 0 <= x <= 63.
2186 Enable meter for the ethernet device::
2188 testpmd> enable port meter (port_id) (mtr_id)
2193 Disable meter for the ethernet device::
2195 testpmd> disable port meter (port_id) (mtr_id)
2200 Delete meter for the ethernet device::
2202 testpmd> del port meter (port_id) (mtr_id)
2204 Set port meter profile
2205 ~~~~~~~~~~~~~~~~~~~~~~
2207 Set meter profile for the ethernet device::
2209 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2211 set port meter dscp table
2212 ~~~~~~~~~~~~~~~~~~~~~~~~~
2214 Set meter dscp table for the ethernet device::
2216 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2217 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2219 set port meter policer action
2220 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2222 Set meter policer action for the ethernet device::
2224 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2225 (action0) [(action1) (action1)]
2229 * ``action_mask``: Bit mask indicating which policer actions need to be
2230 updated. One or more policer actions can be updated in a single function
2231 invocation. To update the policer action associated with color C, bit
2232 (1 << C) needs to be set in *action_mask* and element at position C
2233 in the *actions* array needs to be valid.
2234 * ``actionx``: Policer action for the color x,
2235 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2237 set port meter stats mask
2238 ~~~~~~~~~~~~~~~~~~~~~~~~~
2240 Set meter stats mask for the ethernet device::
2242 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2246 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2248 show port meter stats
2249 ~~~~~~~~~~~~~~~~~~~~~
2251 Show meter stats of the ethernet device::
2253 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2257 * ``clear``: Flag that indicates whether the statistics counters should
2258 be cleared (i.e. set to zero) immediately after they have been read or not.
2263 The following section shows functions for configuring traffic management on
2264 on the ethernet device through the use of generic TM API.
2266 show port traffic management capability
2267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2269 Show traffic management capability of the port::
2271 testpmd> show port tm cap (port_id)
2273 show port traffic management capability (hierarchy level)
2274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2276 Show traffic management hierarchy level capability of the port::
2278 testpmd> show port tm level cap (port_id) (level_id)
2280 show port traffic management capability (hierarchy node level)
2281 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2283 Show the traffic management hierarchy node capability of the port::
2285 testpmd> show port tm node cap (port_id) (node_id)
2287 show port traffic management hierarchy node type
2288 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2290 Show the port traffic management hierarchy node type::
2292 testpmd> show port tm node type (port_id) (node_id)
2294 show port traffic management hierarchy node stats
2295 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2297 Show the port traffic management hierarchy node statistics::
2299 testpmd> show port tm node stats (port_id) (node_id) (clear)
2303 * ``clear``: When this parameter has a non-zero value, the statistics counters
2304 are cleared (i.e. set to zero) immediately after they have been read,
2305 otherwise the statistics counters are left untouched.
2307 Add port traffic management private shaper profile
2308 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2310 Add the port traffic management private shaper profile::
2312 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2313 (tb_rate) (tb_size) (packet_length_adjust)
2317 * ``shaper_profile id``: Shaper profile ID for the new profile.
2318 * ``tb_rate``: Token bucket rate (bytes per second).
2319 * ``tb_size``: Token bucket size (bytes).
2320 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2321 each packet for the purpose of shaping. This parameter value can be used to
2322 correct the packet length with the framing overhead bytes that are consumed
2325 Delete port traffic management private shaper profile
2326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2328 Delete the port traffic management private shaper::
2330 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2334 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2336 Add port traffic management shared shaper
2337 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2339 Create the port traffic management shared shaper::
2341 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2346 * ``shared_shaper_id``: Shared shaper ID to be created.
2347 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2349 Set port traffic management shared shaper
2350 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2352 Update the port traffic management shared shaper::
2354 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2359 * ``shared_shaper_id``: Shared shaper ID to be update.
2360 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2362 Delete port traffic management shared shaper
2363 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2365 Delete the port traffic management shared shaper::
2367 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2371 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2373 Set port traffic management hiearchy node private shaper
2374 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2376 set the port traffic management hierarchy node private shaper::
2378 testpmd> set port tm node shaper profile (port_id) (node_id) \
2383 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2386 Add port traffic management WRED profile
2387 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2389 Create a new WRED profile::
2391 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2392 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2393 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2394 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2398 * ``wred_profile id``: Identifier for the newly create WRED profile
2399 * ``color_g``: Packet color (green)
2400 * ``min_th_g``: Minimum queue threshold for packet with green color
2401 * ``max_th_g``: Minimum queue threshold for packet with green color
2402 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2403 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2404 * ``color_y``: Packet color (yellow)
2405 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2406 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2407 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2408 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2409 * ``color_r``: Packet color (red)
2410 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2411 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2412 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2413 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2415 Delete port traffic management WRED profile
2416 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2418 Delete the WRED profile::
2420 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2422 Add port traffic management hierarchy nonleaf node
2423 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2425 Add nonleaf node to port traffic management hiearchy::
2427 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2428 (priority) (weight) (level_id) (shaper_profile_id) \
2429 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2430 [(shared_shaper_0) (shared_shaper_1) ...] \
2434 * ``parent_node_id``: Node ID of the parent.
2435 * ``priority``: Node priority (highest node priority is zero). This is used by
2436 the SP algorithm running on the parent node for scheduling this node.
2437 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2438 to the weight sum of all siblings that have the same priority. It is used by
2439 the WFQ algorithm running on the parent node for scheduling this node.
2440 * ``level_id``: Hiearchy level of the node.
2441 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2443 * ``n_sp_priorities``: Number of strict priorities.
2444 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2445 * ``n_shared_shapers``: Number of shared shapers.
2446 * ``shared_shaper_id``: Shared shaper id.
2448 Add port traffic management hierarchy leaf node
2449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2451 Add leaf node to port traffic management hiearchy::
2453 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2454 (priority) (weight) (level_id) (shaper_profile_id) \
2455 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2456 [(shared_shaper_id) (shared_shaper_id) ...] \
2460 * ``parent_node_id``: Node ID of the parent.
2461 * ``priority``: Node priority (highest node priority is zero). This is used by
2462 the SP algorithm running on the parent node for scheduling this node.
2463 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2464 to the weight sum of all siblings that have the same priority. It is used by
2465 the WFQ algorithm running on the parent node for scheduling this node.
2466 * ``level_id``: Hiearchy level of the node.
2467 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2469 * ``cman_mode``: Congestion management mode to be enabled for this node.
2470 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2471 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2472 * ``n_shared_shapers``: Number of shared shapers.
2473 * ``shared_shaper_id``: Shared shaper id.
2475 Delete port traffic management hierarchy node
2476 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2478 Delete node from port traffic management hiearchy::
2480 testpmd> del port tm node (port_id) (node_id)
2482 Update port traffic management hierarchy parent node
2483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2485 Update port traffic management hierarchy parent node::
2487 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2490 This function can only be called after the hierarchy commit invocation. Its
2491 success depends on the port support for this operation, as advertised through
2492 the port capability set. This function is valid for all nodes of the traffic
2493 management hierarchy except root node.
2495 Commit port traffic management hierarchy
2496 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2498 Commit the traffic management hierarchy on the port::
2500 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
2504 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
2505 call failure. On the other hand, hierarchy is preserved when this parameter
2508 Set port traffic management default hierarchy (tm forwarding mode)
2509 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2511 set the traffic management default hierarchy on the port::
2513 testpmd> set port tm hierarchy default (port_id)
2518 This section details the available filter functions that are available.
2520 Note these functions interface the deprecated legacy filtering framework,
2521 superseded by *rte_flow*. See `Flow rules management`_.
2524 ~~~~~~~~~~~~~~~~~~~~
2526 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
2528 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
2529 ethertype (ether_type) (drop|fwd) queue (queue_id)
2531 The available information parameters are:
2533 * ``port_id``: The port which the Ethertype filter assigned on.
2535 * ``mac_addr``: Compare destination mac address.
2537 * ``mac_ignr``: Ignore destination mac address match.
2539 * ``mac_address``: Destination mac address to match.
2541 * ``ether_type``: The EtherType value want to match,
2542 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
2544 * ``queue_id``: The receive queue associated with this EtherType filter.
2545 It is meaningless when deleting or dropping.
2547 Example, to add/remove an ethertype filter rule::
2549 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
2550 ethertype 0x0806 fwd queue 3
2552 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
2553 ethertype 0x0806 fwd queue 3
2558 Add or delete a 2-tuple filter,
2559 which identifies packets by specific protocol and destination TCP/UDP port
2560 and forwards packets into one of the receive queues::
2562 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
2563 protocol (protocol_value) mask (mask_value) \
2564 tcp_flags (tcp_flags_value) priority (prio_value) \
2567 The available information parameters are:
2569 * ``port_id``: The port which the 2-tuple filter assigned on.
2571 * ``dst_port_value``: Destination port in L4.
2573 * ``protocol_value``: IP L4 protocol.
2575 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
2577 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
2579 * ``prio_value``: Priority of this filter.
2581 * ``queue_id``: The receive queue associated with this 2-tuple filter.
2583 Example, to add/remove an 2tuple filter rule::
2585 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
2586 tcp_flags 0x02 priority 3 queue 3
2588 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
2589 tcp_flags 0x02 priority 3 queue 3
2594 Add or delete a 5-tuple filter,
2595 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
2596 and routes packets into one of the receive queues::
2598 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
2599 (src_address) dst_port (dst_port_value) \
2600 src_port (src_port_value) protocol (protocol_value) \
2601 mask (mask_value) tcp_flags (tcp_flags_value) \
2602 priority (prio_value) queue (queue_id)
2604 The available information parameters are:
2606 * ``port_id``: The port which the 5-tuple filter assigned on.
2608 * ``dst_address``: Destination IP address.
2610 * ``src_address``: Source IP address.
2612 * ``dst_port_value``: TCP/UDP destination port.
2614 * ``src_port_value``: TCP/UDP source port.
2616 * ``protocol_value``: L4 protocol.
2618 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
2620 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
2622 * ``prio_value``: The priority of this filter.
2624 * ``queue_id``: The receive queue associated with this 5-tuple filter.
2626 Example, to add/remove an 5tuple filter rule::
2628 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
2629 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
2630 flags 0x0 priority 3 queue 3
2632 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
2633 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
2634 flags 0x0 priority 3 queue 3
2639 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
2641 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
2643 The available information parameters are:
2645 * ``port_id``: The port which the SYN filter assigned on.
2647 * ``high``: This SYN filter has higher priority than other filters.
2649 * ``low``: This SYN filter has lower priority than other filters.
2651 * ``queue_id``: The receive queue associated with this SYN filter
2655 testpmd> syn_filter 0 add priority high queue 3
2660 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
2661 and routed into one of the receive queues::
2663 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
2664 mask (mask_value) priority (prio_value) queue (queue_id)
2666 The available information parameters are:
2668 * ``port_id``: The port which the Flex filter is assigned on.
2670 * ``len_value``: Filter length in bytes, no greater than 128.
2672 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
2674 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
2676 * ``prio_value``: The priority of this filter.
2678 * ``queue_id``: The receive queue associated with this Flex filter.
2682 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
2683 mask 000C priority 3 queue 3
2685 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
2686 mask 000C priority 3 queue 3
2689 .. _testpmd_flow_director:
2691 flow_director_filter
2692 ~~~~~~~~~~~~~~~~~~~~
2694 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
2696 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
2697 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
2699 * Perfect match filters.
2700 The hardware checks a match between the masked fields of the received packets and the programmed filters.
2701 The masked fields are for IP flow.
2703 * Signature filters.
2704 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
2706 * Perfect-mac-vlan match filters.
2707 The hardware checks a match between the masked fields of the received packets and the programmed filters.
2708 The masked fields are for MAC VLAN flow.
2710 * Perfect-tunnel match filters.
2711 The hardware checks a match between the masked fields of the received packets and the programmed filters.
2712 The masked fields are for tunnel flow.
2714 * Perfect-raw-flow-type match filters.
2715 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
2716 The masked fields are specified by input sets.
2718 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
2719 per flow type and the flexible payload.
2721 The Flow Director can also mask out parts of all of these fields so that filters
2722 are only applied to certain fields or parts of the fields.
2724 Note that for raw flow type mode the source and destination fields in the
2725 raw packet buffer need to be presented in a reversed order with respect
2726 to the expected received packets.
2727 For example: IP source and destination addresses or TCP/UDP/SCTP
2728 source and destination ports
2730 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
2732 # Commands to add flow director filters of different flow types::
2734 flow_director_filter (port_id) mode IP (add|del|update) \
2735 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
2736 src (src_ip_address) dst (dst_ip_address) \
2737 tos (tos_value) proto (proto_value) ttl (ttl_value) \
2738 vlan (vlan_value) flexbytes (flexbytes_value) \
2739 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
2742 flow_director_filter (port_id) mode IP (add|del|update) \
2743 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
2744 src (src_ip_address) (src_port) \
2745 dst (dst_ip_address) (dst_port) \
2746 tos (tos_value) ttl (ttl_value) \
2747 vlan (vlan_value) flexbytes (flexbytes_value) \
2748 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
2751 flow_director_filter (port_id) mode IP (add|del|update) \
2752 flow (ipv4-sctp|ipv6-sctp) \
2753 src (src_ip_address) (src_port) \
2754 dst (dst_ip_address) (dst_port) \
2755 tos (tos_value) ttl (ttl_value) \
2756 tag (verification_tag) vlan (vlan_value) \
2757 flexbytes (flexbytes_value) (drop|fwd) \
2758 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
2760 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
2761 ether (ethertype) flexbytes (flexbytes_value) \
2762 (drop|fwd) pf|vf(vf_id) queue (queue_id)
2765 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
2766 mac (mac_address) vlan (vlan_value) \
2767 flexbytes (flexbytes_value) (drop|fwd) \
2768 queue (queue_id) fd_id (fd_id_value)
2770 flow_director_filter (port_id) mode Tunnel (add|del|update) \
2771 mac (mac_address) vlan (vlan_value) \
2772 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
2773 flexbytes (flexbytes_value) (drop|fwd) \
2774 queue (queue_id) fd_id (fd_id_value)
2776 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
2777 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
2778 packet (packet file name)
2780 For example, to add an ipv4-udp flow type filter::
2782 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
2783 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
2784 fwd pf queue 1 fd_id 1
2786 For example, add an ipv4-other flow type filter::
2788 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
2789 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
2790 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
2795 Flush all flow director filters on a device::
2797 testpmd> flush_flow_director (port_id)
2799 Example, to flush all flow director filter on port 0::
2801 testpmd> flush_flow_director 0
2806 Set flow director's input masks::
2808 flow_director_mask (port_id) mode IP vlan (vlan_value) \
2809 src_mask (ipv4_src) (ipv6_src) (src_port) \
2810 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
2812 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
2814 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
2815 mac (mac_value) tunnel-type (tunnel_type_value) \
2816 tunnel-id (tunnel_id_value)
2818 Example, to set flow director mask on port 0::
2820 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
2821 src_mask 255.255.255.255 \
2822 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
2823 dst_mask 255.255.255.255 \
2824 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
2826 flow_director_flex_mask
2827 ~~~~~~~~~~~~~~~~~~~~~~~
2829 set masks of flow director's flexible payload based on certain flow type::
2831 testpmd> flow_director_flex_mask (port_id) \
2832 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
2833 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
2834 l2_payload|all) (mask)
2836 Example, to set flow director's flex mask for all flow type on port 0::
2838 testpmd> flow_director_flex_mask 0 flow all \
2839 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
2842 flow_director_flex_payload
2843 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2845 Configure flexible payload selection::
2847 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
2849 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
2851 testpmd> flow_director_flex_payload 0 l4 \
2852 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
2854 get_sym_hash_ena_per_port
2855 ~~~~~~~~~~~~~~~~~~~~~~~~~
2857 Get symmetric hash enable configuration per port::
2859 get_sym_hash_ena_per_port (port_id)
2861 For example, to get symmetric hash enable configuration of port 1::
2863 testpmd> get_sym_hash_ena_per_port 1
2865 set_sym_hash_ena_per_port
2866 ~~~~~~~~~~~~~~~~~~~~~~~~~
2868 Set symmetric hash enable configuration per port to enable or disable::
2870 set_sym_hash_ena_per_port (port_id) (enable|disable)
2872 For example, to set symmetric hash enable configuration of port 1 to enable::
2874 testpmd> set_sym_hash_ena_per_port 1 enable
2876 get_hash_global_config
2877 ~~~~~~~~~~~~~~~~~~~~~~
2879 Get the global configurations of hash filters::
2881 get_hash_global_config (port_id)
2883 For example, to get the global configurations of hash filters of port 1::
2885 testpmd> get_hash_global_config 1
2887 set_hash_global_config
2888 ~~~~~~~~~~~~~~~~~~~~~~
2890 Set the global configurations of hash filters::
2892 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
2893 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
2894 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
2897 For example, to enable simple_xor for flow type of ipv6 on port 2::
2899 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
2904 Set the input set for hash::
2906 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
2907 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
2908 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
2909 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
2910 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
2911 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
2912 fld-8th|none) (select|add)
2914 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
2916 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
2921 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
2922 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
2924 Set the input set for flow director::
2926 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
2927 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
2928 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
2929 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
2930 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
2931 sctp-dst-port|sctp-veri-tag|none) (select|add)
2933 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
2935 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
2940 Set different GRE key length for input set::
2942 global_config (port_id) gre-key-len (number in bytes)
2944 For example to set GRE key length for input set to 4 bytes on port 0::
2946 testpmd> global_config 0 gre-key-len 4
2949 .. _testpmd_rte_flow:
2951 Flow rules management
2952 ---------------------
2954 Control of the generic flow API (*rte_flow*) is fully exposed through the
2955 ``flow`` command (validation, creation, destruction, queries and operation
2958 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
2959 features simultaneously may cause undefined side-effects and is therefore
2965 Because the ``flow`` command uses dynamic tokens to handle the large number
2966 of possible flow rules combinations, its behavior differs slightly from
2967 other commands, in particular:
2969 - Pressing *?* or the *<tab>* key displays contextual help for the current
2970 token, not that of the entire command.
2972 - Optional and repeated parameters are supported (provided they are listed
2973 in the contextual help).
2975 The first parameter stands for the operation mode. Possible operations and
2976 their general syntax are described below. They are covered in detail in the
2979 - Check whether a flow rule can be created::
2981 flow validate {port_id}
2982 [group {group_id}] [priority {level}] [ingress] [egress]
2983 pattern {item} [/ {item} [...]] / end
2984 actions {action} [/ {action} [...]] / end
2986 - Create a flow rule::
2988 flow create {port_id}
2989 [group {group_id}] [priority {level}] [ingress] [egress]
2990 pattern {item} [/ {item} [...]] / end
2991 actions {action} [/ {action} [...]] / end
2993 - Destroy specific flow rules::
2995 flow destroy {port_id} rule {rule_id} [...]
2997 - Destroy all flow rules::
2999 flow flush {port_id}
3001 - Query an existing flow rule::
3003 flow query {port_id} {rule_id} {action}
3005 - List existing flow rules sorted by priority, filtered by group
3008 flow list {port_id} [group {group_id}] [...]
3010 - Restrict ingress traffic to the defined flow rules::
3012 flow isolate {port_id} {boolean}
3014 Validating flow rules
3015 ~~~~~~~~~~~~~~~~~~~~~
3017 ``flow validate`` reports whether a flow rule would be accepted by the
3018 underlying device in its current state but stops short of creating it. It is
3019 bound to ``rte_flow_validate()``::
3021 flow validate {port_id}
3022 [group {group_id}] [priority {level}] [ingress] [egress]
3023 pattern {item} [/ {item} [...]] / end
3024 actions {action} [/ {action} [...]] / end
3026 If successful, it will show::
3030 Otherwise it will show an error message of the form::
3032 Caught error type [...] ([...]): [...]
3034 This command uses the same parameters as ``flow create``, their format is
3035 described in `Creating flow rules`_.
3037 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3038 index 6 is supported::
3040 testpmd> flow validate 0 ingress pattern eth / end
3041 actions queue index 6 / end
3045 Port 0 does not support TCPv6 rules::
3047 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3049 Caught error type 9 (specific pattern item): Invalid argument
3055 ``flow create`` validates and creates the specified flow rule. It is bound
3056 to ``rte_flow_create()``::
3058 flow create {port_id}
3059 [group {group_id}] [priority {level}] [ingress] [egress]
3060 pattern {item} [/ {item} [...]] / end
3061 actions {action} [/ {action} [...]] / end
3063 If successful, it will return a flow rule ID usable with other commands::
3065 Flow rule #[...] created
3067 Otherwise it will show an error message of the form::
3069 Caught error type [...] ([...]): [...]
3071 Parameters describe in the following order:
3073 - Attributes (*group*, *priority*, *ingress*, *egress* tokens).
3074 - A matching pattern, starting with the *pattern* token and terminated by an
3076 - Actions, starting with the *actions* token and terminated by an *end*
3079 These translate directly to *rte_flow* objects provided as-is to the
3080 underlying functions.
3082 The shortest valid definition only comprises mandatory tokens::
3084 testpmd> flow create 0 pattern end actions end
3086 Note that PMDs may refuse rules that essentially do nothing such as this
3089 **All unspecified object values are automatically initialized to 0.**
3094 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3095 specified before the ``pattern`` token.
3097 - ``group {group id}``: priority group.
3098 - ``priority {level}``: priority level within group.
3099 - ``ingress``: rule applies to ingress traffic.
3100 - ``egress``: rule applies to egress traffic.
3102 Each instance of an attribute specified several times overrides the previous
3103 value as shown below (group 4 is used)::
3105 testpmd> flow create 0 group 42 group 24 group 4 [...]
3107 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3109 While not specifying a direction is an error, some rules may allow both
3112 Most rules affect RX therefore contain the ``ingress`` token::
3114 testpmd> flow create 0 ingress pattern [...]
3119 A matching pattern starts after the ``pattern`` token. It is made of pattern
3120 items and is terminated by a mandatory ``end`` item.
3122 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3123 rte_flow_item_type``).
3125 The ``/`` token is used as a separator between pattern items as shown
3128 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3130 Note that protocol items like these must be stacked from lowest to highest
3131 layer to make sense. For instance, the following rule is either invalid or
3132 unlikely to match any packet::
3134 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3136 More information on these restrictions can be found in the *rte_flow*
3139 Several items support additional specification structures, for example
3140 ``ipv4`` allows specifying source and destination addresses as follows::
3142 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3143 dst is 10.2.0.0 / end [...]
3145 This rule matches all IPv4 traffic with the specified properties.
3147 In this example, ``src`` and ``dst`` are field names of the underlying
3148 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3149 in a similar fashion.
3151 The ``is`` token means that the subsequent value must be matched exactly,
3152 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3153 accordingly. Possible assignment tokens are:
3155 - ``is``: match value perfectly (with full bit-mask).
3156 - ``spec``: match value according to configured bit-mask.
3157 - ``last``: specify upper bound to establish a range.
3158 - ``mask``: specify bit-mask with relevant bits set to one.
3159 - ``prefix``: generate bit-mask from a prefix length.
3161 These yield identical results::
3163 ipv4 src is 10.1.1.1
3167 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3171 ipv4 src spec 10.1.1.1 src prefix 32
3175 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3179 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3181 Inclusive ranges can be defined with ``last``::
3183 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3185 Note that ``mask`` affects both ``spec`` and ``last``::
3187 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3188 # matches 10.1.0.0 to 10.2.255.255
3190 Properties can be modified multiple times::
3192 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3196 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3201 This section lists supported pattern items and their attributes, if any.
3203 - ``end``: end list of pattern items.
3205 - ``void``: no-op pattern item.
3207 - ``invert``: perform actions when pattern does not match.
3209 - ``any``: match any protocol for the current layer.
3211 - ``num {unsigned}``: number of layers covered.
3213 - ``pf``: match packets addressed to the physical function.
3215 - ``vf``: match packets addressed to a virtual function ID.
3217 - ``id {unsigned}``: destination VF ID.
3219 - ``port``: device-specific physical port index to use.
3221 - ``index {unsigned}``: physical port index.
3223 - ``raw``: match an arbitrary byte string.
3225 - ``relative {boolean}``: look for pattern after the previous item.
3226 - ``search {boolean}``: search pattern from offset (see also limit).
3227 - ``offset {integer}``: absolute or relative offset for pattern.
3228 - ``limit {unsigned}``: search area limit for start of pattern.
3229 - ``pattern {string}``: byte string to look for.
3231 - ``eth``: match Ethernet header.
3233 - ``dst {MAC-48}``: destination MAC.
3234 - ``src {MAC-48}``: source MAC.
3235 - ``type {unsigned}``: EtherType.
3237 - ``vlan``: match 802.1Q/ad VLAN tag.
3239 - ``tpid {unsigned}``: tag protocol identifier.
3240 - ``tci {unsigned}``: tag control information.
3241 - ``pcp {unsigned}``: priority code point.
3242 - ``dei {unsigned}``: drop eligible indicator.
3243 - ``vid {unsigned}``: VLAN identifier.
3245 - ``ipv4``: match IPv4 header.
3247 - ``tos {unsigned}``: type of service.
3248 - ``ttl {unsigned}``: time to live.
3249 - ``proto {unsigned}``: next protocol ID.
3250 - ``src {ipv4 address}``: source address.
3251 - ``dst {ipv4 address}``: destination address.
3253 - ``ipv6``: match IPv6 header.
3255 - ``tc {unsigned}``: traffic class.
3256 - ``flow {unsigned}``: flow label.
3257 - ``proto {unsigned}``: protocol (next header).
3258 - ``hop {unsigned}``: hop limit.
3259 - ``src {ipv6 address}``: source address.
3260 - ``dst {ipv6 address}``: destination address.
3262 - ``icmp``: match ICMP header.
3264 - ``type {unsigned}``: ICMP packet type.
3265 - ``code {unsigned}``: ICMP packet code.
3267 - ``udp``: match UDP header.
3269 - ``src {unsigned}``: UDP source port.
3270 - ``dst {unsigned}``: UDP destination port.
3272 - ``tcp``: match TCP header.
3274 - ``src {unsigned}``: TCP source port.
3275 - ``dst {unsigned}``: TCP destination port.
3277 - ``sctp``: match SCTP header.
3279 - ``src {unsigned}``: SCTP source port.
3280 - ``dst {unsigned}``: SCTP destination port.
3281 - ``tag {unsigned}``: validation tag.
3282 - ``cksum {unsigned}``: checksum.
3284 - ``vxlan``: match VXLAN header.
3286 - ``vni {unsigned}``: VXLAN identifier.
3288 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3290 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3292 - ``nvgre``: match NVGRE header.
3294 - ``tni {unsigned}``: virtual subnet ID.
3296 - ``mpls``: match MPLS header.
3298 - ``label {unsigned}``: MPLS label.
3300 - ``gre``: match GRE header.
3302 - ``protocol {unsigned}``: protocol type.
3304 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3306 - ``thresh {unsigned}``: accuracy threshold.
3308 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3310 - ``teid {unsigned}``: tunnel endpoint identifier.
3312 - ``geneve``: match GENEVE header.
3314 - ``vni {unsigned}``: virtual network identifier.
3315 - ``protocol {unsigned}``: protocol type.
3320 A list of actions starts after the ``actions`` token in the same fashion as
3321 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3322 terminated by a mandatory ``end`` action.
3324 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3325 rte_flow_action_type``).
3327 Dropping all incoming UDPv4 packets can be expressed as follows::
3329 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3332 Several actions have configurable properties which must be specified when
3333 there is no valid default value. For example, ``queue`` requires a target
3336 This rule redirects incoming UDPv4 traffic to queue index 6::
3338 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3339 actions queue index 6 / end
3341 While this one could be rejected by PMDs (unspecified queue index)::
3343 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3346 As defined by *rte_flow*, the list is not ordered, all actions of a given
3347 rule are performed simultaneously. These are equivalent::
3349 queue index 6 / void / mark id 42 / end
3353 void / mark id 42 / queue index 6 / end
3355 All actions in a list should have different types, otherwise only the last
3356 action of a given type is taken into account::
3358 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3362 drop / drop / drop / end # drop is performed only once
3366 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3368 Considering they are performed simultaneously, opposite and overlapping
3369 actions can sometimes be combined when the end result is unambiguous::
3371 drop / queue index 6 / end # drop has no effect
3375 drop / dup index 6 / end # same as above
3379 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3383 drop / passthru / end # drop has no effect
3385 Note that PMDs may still refuse such combinations.
3390 This section lists supported actions and their attributes, if any.
3392 - ``end``: end list of actions.
3394 - ``void``: no-op action.
3396 - ``passthru``: let subsequent rule process matched packets.
3398 - ``mark``: attach 32 bit value to packets.
3400 - ``id {unsigned}``: 32 bit value to return with packets.
3402 - ``flag``: flag packets.
3404 - ``queue``: assign packets to a given queue index.
3406 - ``index {unsigned}``: queue index to use.
3408 - ``drop``: drop packets (note: passthru has priority).
3410 - ``count``: enable counters for this rule.
3412 - ``dup``: duplicate packets to a given queue index.
3414 - ``index {unsigned}``: queue index to duplicate packets to.
3416 - ``rss``: spread packets among several queues.
3418 - ``types [{RSS hash type} [...]] end``: RSS hash types, allowed tokens
3419 are the same as `set_hash_input_set`_, an empty list means none (0).
3421 - ``key {string}``: RSS hash key, overrides ``key_len``.
3423 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
3424 conjunction with ``key`` to pad or truncate it.
3426 - ``queues [{unsigned} [...]] end``: queue indices to use.
3428 - ``pf``: redirect packets to physical device function.
3430 - ``vf``: redirect packets to virtual device function.
3432 - ``original {boolean}``: use original VF ID if possible.
3433 - ``id {unsigned}``: VF ID to redirect packets to.
3435 Destroying flow rules
3436 ~~~~~~~~~~~~~~~~~~~~~
3438 ``flow destroy`` destroys one or more rules from their rule ID (as returned
3439 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
3440 times as necessary::
3442 flow destroy {port_id} rule {rule_id} [...]
3444 If successful, it will show::
3446 Flow rule #[...] destroyed
3448 It does not report anything for rule IDs that do not exist. The usual error
3449 message is shown when a rule cannot be destroyed::
3451 Caught error type [...] ([...]): [...]
3453 ``flow flush`` destroys all rules on a device and does not take extra
3454 arguments. It is bound to ``rte_flow_flush()``::
3456 flow flush {port_id}
3458 Any errors are reported as above.
3460 Creating several rules and destroying them::
3462 testpmd> flow create 0 ingress pattern eth / ipv6 / end
3463 actions queue index 2 / end
3464 Flow rule #0 created
3465 testpmd> flow create 0 ingress pattern eth / ipv4 / end
3466 actions queue index 3 / end
3467 Flow rule #1 created
3468 testpmd> flow destroy 0 rule 0 rule 1
3469 Flow rule #1 destroyed
3470 Flow rule #0 destroyed
3473 The same result can be achieved using ``flow flush``::
3475 testpmd> flow create 0 ingress pattern eth / ipv6 / end
3476 actions queue index 2 / end
3477 Flow rule #0 created
3478 testpmd> flow create 0 ingress pattern eth / ipv4 / end
3479 actions queue index 3 / end
3480 Flow rule #1 created
3481 testpmd> flow flush 0
3484 Non-existent rule IDs are ignored::
3486 testpmd> flow create 0 ingress pattern eth / ipv6 / end
3487 actions queue index 2 / end
3488 Flow rule #0 created
3489 testpmd> flow create 0 ingress pattern eth / ipv4 / end
3490 actions queue index 3 / end
3491 Flow rule #1 created
3492 testpmd> flow destroy 0 rule 42 rule 10 rule 2
3494 testpmd> flow destroy 0 rule 0
3495 Flow rule #0 destroyed
3501 ``flow query`` queries a specific action of a flow rule having that
3502 ability. Such actions collect information that can be reported using this
3503 command. It is bound to ``rte_flow_query()``::
3505 flow query {port_id} {rule_id} {action}
3507 If successful, it will display either the retrieved data for known actions
3508 or the following message::
3510 Cannot display result for action type [...] ([...])
3512 Otherwise, it will complain either that the rule does not exist or that some
3515 Flow rule #[...] not found
3519 Caught error type [...] ([...]): [...]
3521 Currently only the ``count`` action is supported. This action reports the
3522 number of packets that hit the flow rule and the total number of bytes. Its
3523 output has the following format::
3526 hits_set: [...] # whether "hits" contains a valid value
3527 bytes_set: [...] # whether "bytes" contains a valid value
3528 hits: [...] # number of packets
3529 bytes: [...] # number of bytes
3531 Querying counters for TCPv6 packets redirected to queue 6::
3533 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
3534 actions queue index 6 / count / end
3535 Flow rule #4 created
3536 testpmd> flow query 0 4 count
3547 ``flow list`` lists existing flow rules sorted by priority and optionally
3548 filtered by group identifiers::
3550 flow list {port_id} [group {group_id}] [...]
3552 This command only fails with the following message if the device does not
3557 Output consists of a header line followed by a short description of each
3558 flow rule, one per line. There is no output at all when no flow rules are
3559 configured on the device::
3561 ID Group Prio Attr Rule
3562 [...] [...] [...] [...] [...]
3564 ``Attr`` column flags:
3566 - ``i`` for ``ingress``.
3567 - ``e`` for ``egress``.
3569 Creating several flow rules and listing them::
3571 testpmd> flow create 0 ingress pattern eth / ipv4 / end
3572 actions queue index 6 / end
3573 Flow rule #0 created
3574 testpmd> flow create 0 ingress pattern eth / ipv6 / end
3575 actions queue index 2 / end
3576 Flow rule #1 created
3577 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
3578 actions rss queues 6 7 8 end / end
3579 Flow rule #2 created
3580 testpmd> flow list 0
3581 ID Group Prio Attr Rule
3582 0 0 0 i- ETH IPV4 => QUEUE
3583 1 0 0 i- ETH IPV6 => QUEUE
3584 2 0 5 i- ETH IPV4 UDP => RSS
3587 Rules are sorted by priority (i.e. group ID first, then priority level)::
3589 testpmd> flow list 1
3590 ID Group Prio Attr Rule
3591 0 0 0 i- ETH => COUNT
3592 6 0 500 i- ETH IPV6 TCP => DROP COUNT
3593 5 0 1000 i- ETH IPV6 ICMP => QUEUE
3594 1 24 0 i- ETH IPV4 UDP => QUEUE
3595 4 24 10 i- ETH IPV4 TCP => DROP
3596 3 24 20 i- ETH IPV4 => DROP
3597 2 24 42 i- ETH IPV4 UDP => QUEUE
3598 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
3601 Output can be limited to specific groups::
3603 testpmd> flow list 1 group 0 group 63
3604 ID Group Prio Attr Rule
3605 0 0 0 i- ETH => COUNT
3606 6 0 500 i- ETH IPV6 TCP => DROP COUNT
3607 5 0 1000 i- ETH IPV6 ICMP => QUEUE
3608 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
3611 Toggling isolated mode
3612 ~~~~~~~~~~~~~~~~~~~~~~
3614 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
3615 must only be injected from the defined flow rules; that no default traffic
3616 is expected outside those rules and the driver is free to assign more
3617 resources to handle them. It is bound to ``rte_flow_isolate()``::
3619 flow isolate {port_id} {boolean}
3621 If successful, enabling or disabling isolated mode shows either::
3623 Ingress traffic on port [...]
3624 is now restricted to the defined flow rules
3628 Ingress traffic on port [...]
3629 is not restricted anymore to the defined flow rules
3631 Otherwise, in case of error::
3633 Caught error type [...] ([...]): [...]
3635 Mainly due to its side effects, PMDs supporting this mode may not have the
3636 ability to toggle it more than once without reinitializing affected ports
3637 first (e.g. by exiting testpmd).
3639 Enabling isolated mode::
3641 testpmd> flow isolate 0 true
3642 Ingress traffic on port 0 is now restricted to the defined flow rules
3645 Disabling isolated mode::
3647 testpmd> flow isolate 0 false
3648 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
3651 Sample QinQ flow rules
3652 ~~~~~~~~~~~~~~~~~~~~~~
3654 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
3656 testpmd> port stop 0
3657 testpmd> vlan set qinq on 0
3659 The above command sets the inner and outer TPID's to 0x8100.
3661 To change the TPID's the following commands should be used::
3663 testpmd> vlan set outer tpid 0xa100 0
3664 testpmd> vlan set inner tpid 0x9100 0
3665 testpmd> port start 0
3667 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
3671 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
3672 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
3673 Flow rule #0 validated
3675 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
3676 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
3677 Flow rule #0 created
3679 testpmd> flow list 0
3680 ID Group Prio Attr Rule
3681 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
3683 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
3687 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
3688 vlan tci is 654 / end actions pf / queue index 0 / end
3689 Flow rule #1 validated
3691 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
3692 vlan tci is 654 / end actions pf / queue index 1 / end
3693 Flow rule #1 created
3695 testpmd> flow list 0
3696 ID Group Prio Attr Rule
3697 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
3698 1 0 0 i- ETH VLAN VLAN=>PF QUEUE