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|summary|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 * ``summary``: Brief port summary such as Device Name, Driver Name etc.
170 * ``stats``: RX/TX statistics.
172 * ``xstats``: RX/TX extended NIC statistics.
174 * ``fdir``: Flow Director information and statistics.
176 * ``stat_qmap``: Queue statistics mapping.
178 * ``dcb_tc``: DCB information such as TC mapping.
180 * ``cap``: Supported offload capabilities.
184 .. code-block:: console
186 testpmd> show port info 0
188 ********************* Infos for port 0 *********************
190 MAC address: XX:XX:XX:XX:XX:XX
192 memory allocation on the socket: 0
194 Link speed: 40000 Mbps
195 Link duplex: full-duplex
196 Promiscuous mode: enabled
197 Allmulticast mode: disabled
198 Maximum number of MAC addresses: 64
199 Maximum number of MAC addresses of hash filtering: 0
204 Redirection table size: 512
205 Supported flow types:
226 Display the rss redirection table entry indicated by masks on port X::
228 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
230 size is used to indicate the hardware supported reta size
235 Display the RSS hash functions and RSS hash key of a port::
237 testpmd> show port (port_id) rss-hash [key]
242 Clear the port statistics for a given port or for all ports::
244 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
248 testpmd> clear port stats all
253 Display information for a given port's RX/TX queue::
255 testpmd> show (rxq|txq) info (port_id) (queue_id)
260 Displays the configuration of the application.
261 The configuration comes from the command-line, the runtime or the application defaults::
263 testpmd> show config (rxtx|cores|fwd|txpkts)
265 The available information categories are:
267 * ``rxtx``: RX/TX configuration items.
269 * ``cores``: List of forwarding cores.
271 * ``fwd``: Packet forwarding configuration.
273 * ``txpkts``: Packets to TX configuration.
277 .. code-block:: console
279 testpmd> show config rxtx
281 io packet forwarding - CRC stripping disabled - packets/burst=16
282 nb forwarding cores=2 - nb forwarding ports=1
283 RX queues=1 - RX desc=128 - RX free threshold=0
284 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
285 TX queues=1 - TX desc=512 - TX free threshold=0
286 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
287 TX RS bit threshold=0 - TXQ flags=0x0
292 Set the packet forwarding mode::
294 testpmd> set fwd (io|mac|macswap|flowgen| \
295 rxonly|txonly|csum|icmpecho|noisy) (""|retry)
297 ``retry`` can be specified for forwarding engines except ``rx_only``.
299 The available information categories are:
301 * ``io``: Forwards packets "as-is" in I/O mode.
302 This is the fastest possible forwarding operation as it does not access packets data.
303 This is the default mode.
305 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
306 Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination
307 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
308 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
310 * ``macswap``: MAC swap forwarding mode.
311 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
313 * ``flowgen``: Multi-flow generation mode.
314 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
316 * ``rxonly``: Receives packets but doesn't transmit them.
318 * ``txonly``: Generates and transmits packets without receiving any.
320 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
322 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
324 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
326 * ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is
327 similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialised. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``.
329 * ``noisy``: Noisy neighbour simulation.
330 Simulate more realistic behavior of a guest machine engaged in receiving
331 and sending packets performing Virtual Network Function (VNF).
335 testpmd> set fwd rxonly
337 Set rxonly packet forwarding mode
343 When running, forwarding engines maintain statistics from the time they have been started.
344 Example for the io forwarding engine, with some packet drops on the tx side::
346 testpmd> show fwd stats all
348 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
349 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
351 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
352 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
354 ---------------------- Forward statistics for port 0 ----------------------
355 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
356 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
357 ----------------------------------------------------------------------------
359 ---------------------- Forward statistics for port 1 ----------------------
360 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
361 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
362 ----------------------------------------------------------------------------
364 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
365 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
366 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
367 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
372 Clear the forwarding engines statistics::
374 testpmd> clear fwd stats all
379 Display an RX descriptor for a port RX queue::
381 testpmd> read rxd (port_id) (queue_id) (rxd_id)
385 testpmd> read rxd 0 0 4
386 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
391 Display a TX descriptor for a port TX queue::
393 testpmd> read txd (port_id) (queue_id) (txd_id)
397 testpmd> read txd 0 0 4
398 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
403 Get loaded dynamic device personalization (DDP) package info list::
405 testpmd> ddp get list (port_id)
410 Display information about dynamic device personalization (DDP) profile::
412 testpmd> ddp get info (profile_path)
417 Display VF statistics::
419 testpmd> show vf stats (port_id) (vf_id)
424 Reset VF statistics::
426 testpmd> clear vf stats (port_id) (vf_id)
428 show port pctype mapping
429 ~~~~~~~~~~~~~~~~~~~~~~~~
431 List all items from the pctype mapping table::
433 testpmd> show port (port_id) pctype mapping
435 show rx offloading capabilities
436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
438 List all per queue and per port Rx offloading capabilities of a port::
440 testpmd> show port (port_id) rx_offload capabilities
442 show rx offloading configuration
443 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
445 List port level and all queue level Rx offloading configuration::
447 testpmd> show port (port_id) rx_offload configuration
449 show tx offloading capabilities
450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
452 List all per queue and per port Tx offloading capabilities of a port::
454 testpmd> show port (port_id) tx_offload capabilities
456 show tx offloading configuration
457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
459 List port level and all queue level Tx offloading configuration::
461 testpmd> show port (port_id) tx_offload configuration
463 show tx metadata setting
464 ~~~~~~~~~~~~~~~~~~~~~~~~
466 Show Tx metadata value set for a specific port::
468 testpmd> show port (port_id) tx_metadata
470 Configuration Functions
471 -----------------------
473 The testpmd application can be configured from the runtime as well as from the command-line.
475 This section details the available configuration functions that are available.
479 Configuration changes only become active when forwarding is started/restarted.
484 Reset forwarding to the default configuration::
491 Set the debug verbosity level::
493 testpmd> set verbose (level)
495 Available levels are as following:
497 * ``0`` silent except for error.
498 * ``1`` fully verbose except for Tx packets.
499 * ``2`` fully verbose except for Rx packets.
500 * ``> 2`` fully verbose.
505 Set the log level for a log type::
507 testpmd> set log global|(type) (level)
511 * ``type`` is the log name.
513 * ``level`` is the log level.
515 For example, to change the global log level::
516 testpmd> set log global (level)
518 Regexes can also be used for type. To change log level of user1, user2 and user3::
519 testpmd> set log user[1-3] (level)
524 Set the number of ports used by the application:
528 This is equivalent to the ``--nb-ports`` command-line option.
533 Set the number of cores used by the application::
535 testpmd> set nbcore (num)
537 This is equivalent to the ``--nb-cores`` command-line option.
541 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
546 Set the forwarding cores hexadecimal mask::
548 testpmd> set coremask (mask)
550 This is equivalent to the ``--coremask`` command-line option.
554 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
559 Set the forwarding ports hexadecimal mask::
561 testpmd> set portmask (mask)
563 This is equivalent to the ``--portmask`` command-line option.
568 Set number of packets per burst::
570 testpmd> set burst (num)
572 This is equivalent to the ``--burst command-line`` option.
574 When retry is enabled, the transmit delay time and number of retries can also be set::
576 testpmd> set burst tx delay (microseconds) retry (num)
581 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
583 testpmd> set txpkts (x[,y]*)
585 Where x[,y]* represents a CSV list of values, without white space.
590 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
592 testpmd> set txsplit (off|on|rand)
596 * ``off`` disable packet copy & split for CSUM mode.
598 * ``on`` split outgoing packet into multiple segments. Size of each segment
599 and number of segments per packet is determined by ``set txpkts`` command
602 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
607 Set the list of forwarding cores::
609 testpmd> set corelist (x[,y]*)
611 For example, to change the forwarding cores:
613 .. code-block:: console
615 testpmd> set corelist 3,1
616 testpmd> show config fwd
618 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
619 Logical Core 3 (socket 0) forwards packets on 1 streams:
620 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
621 Logical Core 1 (socket 0) forwards packets on 1 streams:
622 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
626 The cores are used in the same order as specified on the command line.
631 Set the list of forwarding ports::
633 testpmd> set portlist (x[,y]*)
635 For example, to change the port forwarding:
637 .. code-block:: console
639 testpmd> set portlist 0,2,1,3
640 testpmd> show config fwd
642 io packet forwarding - ports=4 - cores=1 - streams=4
643 Logical Core 3 (socket 0) forwards packets on 4 streams:
644 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
645 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
646 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
647 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
652 Select how to retrieve new ports created after "port attach" command::
654 testpmd> set port setup on (iterator|event)
656 For each new port, a setup is done.
657 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
658 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
663 Enable/disable tx loopback::
665 testpmd> set tx loopback (port_id) (on|off)
670 set drop enable bit for all queues::
672 testpmd> set all queues drop (port_id) (on|off)
674 set split drop enable (for VF)
675 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
677 set split drop enable bit for VF from PF::
679 testpmd> set vf split drop (port_id) (vf_id) (on|off)
681 set mac antispoof (for VF)
682 ~~~~~~~~~~~~~~~~~~~~~~~~~~
684 Set mac antispoof for a VF from the PF::
686 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
691 Enable/disable MACsec offload::
693 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
694 testpmd> set macsec offload (port_id) off
699 Configure MACsec secure connection (SC)::
701 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
705 The pi argument is ignored for tx.
706 Check the NIC Datasheet for hardware limits.
711 Configure MACsec secure association (SA)::
713 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
717 The IDX value must be 0 or 1.
718 Check the NIC Datasheet for hardware limits.
720 set broadcast mode (for VF)
721 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
723 Set broadcast mode for a VF from the PF::
725 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
730 Set the VLAN strip on a port::
732 testpmd> vlan set strip (on|off) (port_id)
737 Set the VLAN strip for a queue on a port::
739 testpmd> vlan set stripq (on|off) (port_id,queue_id)
741 vlan set stripq (for VF)
742 ~~~~~~~~~~~~~~~~~~~~~~~~
744 Set VLAN strip for all queues in a pool for a VF from the PF::
746 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
748 vlan set insert (for VF)
749 ~~~~~~~~~~~~~~~~~~~~~~~~
751 Set VLAN insert for a VF from the PF::
753 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
755 vlan set tag (for VF)
756 ~~~~~~~~~~~~~~~~~~~~~
758 Set VLAN tag for a VF from the PF::
760 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
762 vlan set antispoof (for VF)
763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
765 Set VLAN antispoof for a VF from the PF::
767 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
772 Set the VLAN filter on a port::
774 testpmd> vlan set filter (on|off) (port_id)
779 Set the VLAN QinQ (extended queue in queue) on for a port::
781 testpmd> vlan set qinq (on|off) (port_id)
786 Set the inner or outer VLAN TPID for packet filtering on a port::
788 testpmd> vlan set (inner|outer) tpid (value) (port_id)
792 TPID value must be a 16-bit number (value <= 65536).
797 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
799 testpmd> rx_vlan add (vlan_id|all) (port_id)
803 VLAN filter must be set on that port. VLAN ID < 4096.
804 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
805 in VFTA table. This is important if enabling all vlan_ids.
810 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
812 testpmd> rx_vlan rm (vlan_id|all) (port_id)
817 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
819 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
824 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
826 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
831 Add a tunnel filter on a port::
833 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
834 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
835 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
837 The available information categories are:
839 * ``vxlan``: Set tunnel type as VXLAN.
841 * ``nvgre``: Set tunnel type as NVGRE.
843 * ``ipingre``: Set tunnel type as IP-in-GRE.
845 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
847 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
849 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
851 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
853 * ``imac``: Set filter type as Inner MAC.
855 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
857 * ``oip``: Set filter type as Outer IP.
859 * ``iip``: Set filter type as Inner IP.
863 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
864 192.168.2.2 0 ipingre oip 1 1
866 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
871 Remove a tunnel filter on a port::
873 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
874 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
875 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
880 Add an UDP port for VXLAN packet filter on a port::
882 testpmd> rx_vxlan_port add (udp_port) (port_id)
887 Remove an UDP port for VXLAN packet filter on a port::
889 testpmd> rx_vxlan_port rm (udp_port) (port_id)
894 Set hardware insertion of VLAN IDs in packets sent on a port::
896 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
898 For example, set a single VLAN ID (5) insertion on port 0::
902 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
910 Set port based hardware insertion of VLAN ID in packets sent on a port::
912 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
917 Disable hardware insertion of a VLAN header in packets sent on a port::
919 testpmd> tx_vlan reset (port_id)
924 Select hardware or software calculation of the checksum when
925 transmitting a packet using the ``csum`` forwarding engine::
927 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
931 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
933 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
934 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
935 supported). See also the ``csum parse-tunnel`` command.
937 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
938 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
939 supported). See also the ``csum parse-tunnel`` command.
943 Check the NIC Datasheet for hardware limits.
948 Set RSS queue region span on a port::
950 testpmd> set port (port_id) queue-region region_id (value) \
951 queue_start_index (value) queue_num (value)
953 Set flowtype mapping on a RSS queue region on a port::
955 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
959 * For the flowtype(pctype) of packet,the specific index for each type has
960 been defined in file i40e_type.h as enum i40e_filter_pctype.
962 Set user priority mapping on a RSS queue region on a port::
964 testpmd> set port (port_id) queue-region UP (value) region_id (value)
966 Flush all queue region related configuration on a port::
968 testpmd> set port (port_id) queue-region flush (on|off)
972 * "on"is just an enable function which server for other configuration,
973 it is for all configuration about queue region from up layer,
974 at first will only keep in DPDK software stored in driver,
975 only after "flush on", it commit all configuration to HW.
976 "off" is just clean all configuration about queue region just now,
977 and restore all to DPDK i40e driver default config when start up.
979 Show all queue region related configuration info on a port::
981 testpmd> show port (port_id) queue-region
985 Queue region only support on PF by now, so these command is
986 only for configuration of queue region on PF port.
991 Define how tunneled packets should be handled by the csum forward
994 testpmd> csum parse-tunnel (on|off) (tx_port_id)
996 If enabled, the csum forward engine will try to recognize supported
997 tunnel headers (vxlan, gre, ipip).
999 If disabled, treat tunnel packets as non-tunneled packets (a inner
1000 header is handled as a packet payload).
1004 The port argument is the TX port like in the ``csum set`` command.
1008 Consider a packet in packet like the following::
1010 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1012 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1013 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1014 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1016 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1017 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1022 Display tx checksum offload configuration::
1024 testpmd> csum show (port_id)
1029 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1031 testpmd> tso set (segsize) (port_id)
1035 Check the NIC datasheet for hardware limits.
1040 Display the status of TCP Segmentation Offload::
1042 testpmd> tso show (port_id)
1047 Enable or disable GRO in ``csum`` forwarding engine::
1049 testpmd> set port <port_id> gro on|off
1051 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1052 packets received from the given port.
1054 If disabled, packets received from the given port won't be performed
1055 GRO. By default, GRO is disabled for all ports.
1059 When enable GRO for a port, TCP/IPv4 packets received from the port
1060 will be performed GRO. After GRO, all merged packets have bad
1061 checksums, since the GRO library doesn't re-calculate checksums for
1062 the merged packets. Therefore, if users want the merged packets to
1063 have correct checksums, please select HW IP checksum calculation and
1064 HW TCP checksum calculation for the port which the merged packets are
1070 Display GRO configuration for a given port::
1072 testpmd> show port <port_id> gro
1077 Set the cycle to flush the GROed packets from reassembly tables::
1079 testpmd> set gro flush <cycles>
1081 When enable GRO, the csum forwarding engine performs GRO on received
1082 packets, and the GROed packets are stored in reassembly tables. Users
1083 can use this command to determine when the GROed packets are flushed
1084 from the reassembly tables.
1086 The ``cycles`` is measured in GRO operation times. The csum forwarding
1087 engine flushes the GROed packets from the tables every ``cycles`` GRO
1090 By default, the value of ``cycles`` is 1, which means flush GROed packets
1091 from the reassembly tables as soon as one GRO operation finishes. The value
1092 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1094 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1095 stack performance. Because the GROed packets are delayed to arrive the
1096 stack, thus causing more duplicated ACKs and TCP retransmissions.
1101 Toggle per-port GSO support in ``csum`` forwarding engine::
1103 testpmd> set port <port_id> gso on|off
1105 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1106 packets, transmitted on the given port.
1108 If disabled, packets transmitted on the given port will not undergo GSO.
1109 By default, GSO is disabled for all ports.
1113 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1114 port undergo GSO. Afterwards, the segmented packets are represented by
1115 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1116 of checksums for GSO'd segments in SW. As a result, if users want correct
1117 checksums in GSO segments, they should enable HW checksum calculation for
1120 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1121 by setting the following options in the csum forwarding engine:
1123 testpmd> csum set outer_ip hw <port_id>
1125 testpmd> csum set ip hw <port_id>
1127 testpmd> csum set tcp hw <port_id>
1129 UDP GSO is the same as IP fragmentation, which treats the UDP header
1130 as the payload and does not modify it during segmentation. That is,
1131 after UDP GSO, only the first output fragment has the original UDP
1132 header. Therefore, users need to enable HW IP checksum calculation
1133 and SW UDP checksum calculation for GSO-enabled ports, if they want
1134 correct checksums for UDP/IPv4 packets.
1139 Set the maximum GSO segment size (measured in bytes), which includes the
1140 packet header and the packet payload for GSO-enabled ports (global)::
1142 testpmd> set gso segsz <length>
1147 Display the status of Generic Segmentation Offload for a given port::
1149 testpmd> show port <port_id> gso
1154 Add an alternative MAC address to a port::
1156 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1161 Remove a MAC address from a port::
1163 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1165 mac_addr add (for VF)
1166 ~~~~~~~~~~~~~~~~~~~~~
1168 Add an alternative MAC address for a VF to a port::
1170 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1175 Set the default MAC address for a port::
1177 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1179 mac_addr set (for VF)
1180 ~~~~~~~~~~~~~~~~~~~~~
1182 Set the MAC address for a VF from the PF::
1184 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1189 Set the forwarding peer address for certain port::
1191 testpmd> set eth-peer (port_id) (peer_addr)
1193 This is equivalent to the ``--eth-peer`` command-line option.
1198 Set the unicast hash filter(s) on/off for a port::
1200 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1205 Set the promiscuous mode on for a port or for all ports.
1206 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1208 testpmd> set promisc (port_id|all) (on|off)
1213 Set the allmulti mode for a port or for all ports::
1215 testpmd> set allmulti (port_id|all) (on|off)
1217 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1219 set promisc (for VF)
1220 ~~~~~~~~~~~~~~~~~~~~
1222 Set the unicast promiscuous mode for a VF from PF.
1223 It's supported by Intel i40e NICs now.
1224 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1226 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1228 set allmulticast (for VF)
1229 ~~~~~~~~~~~~~~~~~~~~~~~~~
1231 Set the multicast promiscuous mode for a VF from PF.
1232 It's supported by Intel i40e NICs now.
1233 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1235 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1237 set tx max bandwidth (for VF)
1238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1240 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1242 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1244 set tc tx min bandwidth (for VF)
1245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1247 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1249 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1251 set tc tx max bandwidth (for VF)
1252 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1254 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1256 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1258 set tc strict link priority mode
1259 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1261 Set some TCs' strict link priority mode on a physical port::
1263 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1265 set tc tx min bandwidth
1266 ~~~~~~~~~~~~~~~~~~~~~~~
1268 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1270 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1275 Set the link flow control parameter on a port::
1277 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1278 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1279 autoneg (on|off) (port_id)
1283 * ``high_water`` (integer): High threshold value to trigger XOFF.
1285 * ``low_water`` (integer): Low threshold value to trigger XON.
1287 * ``pause_time`` (integer): Pause quota in the Pause frame.
1289 * ``send_xon`` (0/1): Send XON frame.
1291 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1293 * ``autoneg``: Change the auto-negotiation parameter.
1298 Set the priority flow control parameter on a port::
1300 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1301 (pause_time) (priority) (port_id)
1305 * ``high_water`` (integer): High threshold value.
1307 * ``low_water`` (integer): Low threshold value.
1309 * ``pause_time`` (integer): Pause quota in the Pause frame.
1311 * ``priority`` (0-7): VLAN User Priority.
1316 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1318 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1320 For example, to set rx queue 2 on port 0 to mapping 5::
1322 testpmd>set stat_qmap rx 0 2 5
1324 set xstats-hide-zero
1325 ~~~~~~~~~~~~~~~~~~~~
1327 Set the option to hide zero values for xstats display::
1329 testpmd> set xstats-hide-zero on|off
1333 By default, the zero values are displayed for xstats.
1335 set port - rx/tx (for VF)
1336 ~~~~~~~~~~~~~~~~~~~~~~~~~
1338 Set VF receive/transmit from a port::
1340 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1342 set port - mac address filter (for VF)
1343 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1345 Add/Remove unicast or multicast MAC addr filter for a VF::
1347 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1348 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1350 set port - rx mode(for VF)
1351 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1353 Set the VF receive mode of a port::
1355 testpmd> set port (port_id) vf (vf_id) \
1356 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1358 The available receive modes are:
1360 * ``AUPE``: Accepts untagged VLAN.
1362 * ``ROPE``: Accepts unicast hash.
1364 * ``BAM``: Accepts broadcast packets.
1366 * ``MPE``: Accepts all multicast packets.
1368 set port - tx_rate (for Queue)
1369 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1371 Set TX rate limitation for a queue on a port::
1373 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1375 set port - tx_rate (for VF)
1376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1378 Set TX rate limitation for queues in VF on a port::
1380 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1382 set port - mirror rule
1383 ~~~~~~~~~~~~~~~~~~~~~~
1385 Set pool or vlan type mirror rule for a port::
1387 testpmd> set port (port_id) mirror-rule (rule_id) \
1388 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1389 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1391 Set link mirror rule for a port::
1393 testpmd> set port (port_id) mirror-rule (rule_id) \
1394 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1396 For example to enable mirror traffic with vlan 0,1 to pool 0::
1398 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1400 reset port - mirror rule
1401 ~~~~~~~~~~~~~~~~~~~~~~~~
1403 Reset a mirror rule for a port::
1405 testpmd> reset port (port_id) mirror-rule (rule_id)
1410 Set the flush on RX streams before forwarding.
1411 The default is flush ``on``.
1412 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1414 testpmd> set flush_rx off
1419 Set the bypass mode for the lowest port on bypass enabled NIC::
1421 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1426 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1428 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1429 mode (normal|bypass|isolate) (port_id)
1433 * ``timeout``: Enable bypass after watchdog timeout.
1435 * ``os_on``: Enable bypass when OS/board is powered on.
1437 * ``os_off``: Enable bypass when OS/board is powered off.
1439 * ``power_on``: Enable bypass when power supply is turned on.
1441 * ``power_off``: Enable bypass when power supply is turned off.
1447 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1449 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1454 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1456 testpmd> show bypass config (port_id)
1461 Set link up for a port::
1463 testpmd> set link-up port (port id)
1468 Set link down for a port::
1470 testpmd> set link-down port (port id)
1475 Enable E-tag insertion for a VF on a port::
1477 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1479 Disable E-tag insertion for a VF on a port::
1481 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1483 Enable/disable E-tag stripping on a port::
1485 testpmd> E-tag set stripping (on|off) port (port_id)
1487 Enable/disable E-tag based forwarding on a port::
1489 testpmd> E-tag set forwarding (on|off) port (port_id)
1491 Add an E-tag forwarding filter on a port::
1493 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1495 Delete an E-tag forwarding filter on a port::
1496 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1501 Load a dynamic device personalization (DDP) profile and store backup profile::
1503 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1508 Delete a dynamic device personalization profile and restore backup profile::
1510 testpmd> ddp del (port_id) (backup_profile_path)
1515 List all items from the ptype mapping table::
1517 testpmd> ptype mapping get (port_id) (valid_only)
1521 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1523 Replace a specific or a group of software defined ptype with a new one::
1525 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1529 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1531 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1533 * ``pkt_type``: The new software ptype to replace the old ones.
1535 Update hardware defined ptype to software defined packet type mapping table::
1537 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1541 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1543 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1545 Reset ptype mapping table::
1547 testpmd> ptype mapping reset (port_id)
1549 config per port Rx offloading
1550 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1552 Enable or disable a per port Rx offloading on all Rx queues of a port::
1554 testpmd> port config (port_id) rx_offload (offloading) on|off
1556 * ``offloading``: can be any of these offloading capability:
1557 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1558 qinq_strip, outer_ipv4_cksum, macsec_strip,
1559 header_split, vlan_filter, vlan_extend, jumbo_frame,
1560 crc_strip, scatter, timestamp, security, keep_crc
1562 This command should be run when the port is stopped, or else it will fail.
1564 config per queue Rx offloading
1565 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1567 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1569 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1571 * ``offloading``: can be any of these offloading capability:
1572 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1573 qinq_strip, outer_ipv4_cksum, macsec_strip,
1574 header_split, vlan_filter, vlan_extend, jumbo_frame,
1575 crc_strip, scatter, timestamp, security, keep_crc
1577 This command should be run when the port is stopped, or else it will fail.
1579 config per port Tx offloading
1580 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1582 Enable or disable a per port Tx offloading on all Tx queues of a port::
1584 testpmd> port config (port_id) tx_offload (offloading) on|off
1586 * ``offloading``: can be any of these offloading capability:
1587 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1588 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1589 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1590 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1591 mt_lockfree, multi_segs, mbuf_fast_free, security,
1594 This command should be run when the port is stopped, or else it will fail.
1596 config per queue Tx offloading
1597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1599 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1601 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1603 * ``offloading``: can be any of these offloading capability:
1604 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1605 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1606 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1607 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1608 mt_lockfree, multi_segs, mbuf_fast_free, security
1610 This command should be run when the port is stopped, or else it will fail.
1612 Config VXLAN Encap outer layers
1613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1615 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1617 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1618 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1621 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1622 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1623 eth-src (eth-src) eth-dst (eth-dst)
1625 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1626 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1627 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1629 These commands will set an internal configuration inside testpmd, any following
1630 flow rule using the action vxlan_encap will use the last configuration set.
1631 To have a different encapsulation header, one of those commands must be called
1632 before the flow rule creation.
1634 Config NVGRE Encap outer layers
1635 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1637 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1639 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1640 eth-src (eth-src) eth-dst (eth-dst)
1641 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1642 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1644 These commands will set an internal configuration inside testpmd, any following
1645 flow rule using the action nvgre_encap will use the last configuration set.
1646 To have a different encapsulation header, one of those commands must be called
1647 before the flow rule creation.
1652 Configure the l2 to be used when encapsulating a packet with L2::
1654 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1655 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1656 eth-src (eth-src) eth-dst (eth-dst)
1658 Those commands will set an internal configuration inside testpmd, any following
1659 flow rule using the action l2_encap will use the last configuration set.
1660 To have a different encapsulation header, one of those commands must be called
1661 before the flow rule creation.
1666 Configure the l2 to be removed when decapsulating a packet with L2::
1668 set l2_decap ip-version (ipv4|ipv6)
1669 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1671 Those commands will set an internal configuration inside testpmd, any following
1672 flow rule using the action l2_decap will use the last configuration set.
1673 To have a different encapsulation header, one of those commands must be called
1674 before the flow rule creation.
1676 Config MPLSoGRE Encap outer layers
1677 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1679 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1681 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1682 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1683 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1684 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1685 eth-src (eth-src) eth-dst (eth-dst)
1687 These commands will set an internal configuration inside testpmd, any following
1688 flow rule using the action mplsogre_encap will use the last configuration set.
1689 To have a different encapsulation header, one of those commands must be called
1690 before the flow rule creation.
1692 Config MPLSoGRE Decap outer layers
1693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1695 Configure the outer layer to decapsulate MPLSoGRE packet::
1697 set mplsogre_decap ip-version (ipv4|ipv6)
1698 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1700 These commands will set an internal configuration inside testpmd, any following
1701 flow rule using the action mplsogre_decap will use the last configuration set.
1702 To have a different decapsulation header, one of those commands must be called
1703 before the flow rule creation.
1705 Config MPLSoUDP Encap outer layers
1706 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1708 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1710 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1711 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1712 eth-src (eth-src) eth-dst (eth-dst)
1713 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1714 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1715 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1717 These commands will set an internal configuration inside testpmd, any following
1718 flow rule using the action mplsoudp_encap will use the last configuration set.
1719 To have a different encapsulation header, one of those commands must be called
1720 before the flow rule creation.
1722 Config MPLSoUDP Decap outer layers
1723 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1725 Configure the outer layer to decapsulate MPLSoUDP packet::
1727 set mplsoudp_decap ip-version (ipv4|ipv6)
1728 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1730 These commands will set an internal configuration inside testpmd, any following
1731 flow rule using the action mplsoudp_decap will use the last configuration set.
1732 To have a different decapsulation header, one of those commands must be called
1733 before the flow rule creation.
1738 The following sections show functions for configuring ports.
1742 Port configuration changes only become active when forwarding is started/restarted.
1747 Attach a port specified by pci address or virtual device args::
1749 testpmd> port attach (identifier)
1751 To attach a new pci device, the device should be recognized by kernel first.
1752 Then it should be moved under DPDK management.
1753 Finally the port can be attached to testpmd.
1755 For example, to move a pci device using ixgbe under DPDK management:
1757 .. code-block:: console
1759 # Check the status of the available devices.
1760 ./usertools/dpdk-devbind.py --status
1762 Network devices using DPDK-compatible driver
1763 ============================================
1766 Network devices using kernel driver
1767 ===================================
1768 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1771 # Bind the device to igb_uio.
1772 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1775 # Recheck the status of the devices.
1776 ./usertools/dpdk-devbind.py --status
1777 Network devices using DPDK-compatible driver
1778 ============================================
1779 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1781 To attach a port created by virtual device, above steps are not needed.
1783 For example, to attach a port whose pci address is 0000:0a:00.0.
1785 .. code-block:: console
1787 testpmd> port attach 0000:0a:00.0
1788 Attaching a new port...
1789 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1790 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1791 EAL: PCI memory mapped at 0x7f83bfa00000
1792 EAL: PCI memory mapped at 0x7f83bfa80000
1793 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1794 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1795 Port 0 is attached. Now total ports is 1
1798 For example, to attach a port created by pcap PMD.
1800 .. code-block:: console
1802 testpmd> port attach net_pcap0
1803 Attaching a new port...
1804 PMD: Initializing pmd_pcap for net_pcap0
1805 PMD: Creating pcap-backed ethdev on numa socket 0
1806 Port 0 is attached. Now total ports is 1
1809 In this case, identifier is ``net_pcap0``.
1810 This identifier format is the same as ``--vdev`` format of DPDK applications.
1812 For example, to re-attach a bonded port which has been previously detached,
1813 the mode and slave parameters must be given.
1815 .. code-block:: console
1817 testpmd> port attach net_bond_0,mode=0,slave=1
1818 Attaching a new port...
1819 EAL: Initializing pmd_bond for net_bond_0
1820 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1821 Port 0 is attached. Now total ports is 1
1828 Detach a specific port::
1830 testpmd> port detach (port_id)
1832 Before detaching a port, the port should be stopped and closed.
1834 For example, to detach a pci device port 0.
1836 .. code-block:: console
1838 testpmd> port stop 0
1841 testpmd> port close 0
1845 testpmd> port detach 0
1847 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1848 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1849 EAL: PCI memory unmapped at 0x7f83bfa00000
1850 EAL: PCI memory unmapped at 0x7f83bfa80000
1854 For example, to detach a virtual device port 0.
1856 .. code-block:: console
1858 testpmd> port stop 0
1861 testpmd> port close 0
1865 testpmd> port detach 0
1867 PMD: Closing pcap ethdev on numa socket 0
1868 Port 'net_pcap0' is detached. Now total ports is 0
1871 To remove a pci device completely from the system, first detach the port from testpmd.
1872 Then the device should be moved under kernel management.
1873 Finally the device can be removed using kernel pci hotplug functionality.
1875 For example, to move a pci device under kernel management:
1877 .. code-block:: console
1879 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
1881 ./usertools/dpdk-devbind.py --status
1883 Network devices using DPDK-compatible driver
1884 ============================================
1887 Network devices using kernel driver
1888 ===================================
1889 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1891 To remove a port created by a virtual device, above steps are not needed.
1896 Start all ports or a specific port::
1898 testpmd> port start (port_id|all)
1903 Stop all ports or a specific port::
1905 testpmd> port stop (port_id|all)
1910 Close all ports or a specific port::
1912 testpmd> port close (port_id|all)
1914 port config - queue ring size
1915 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1917 Configure a rx/tx queue ring size::
1919 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
1921 Only take effect after command that (re-)start the port or command that setup specific queue.
1923 port start/stop queue
1924 ~~~~~~~~~~~~~~~~~~~~~
1926 Start/stop a rx/tx queue on a specific port::
1928 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1930 port config - queue deferred start
1931 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1933 Switch on/off deferred start of a specific port queue::
1935 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
1938 ~~~~~~~~~~~~~~~~~~~~~
1940 Setup a rx/tx queue on a specific port::
1942 testpmd> port (port_id) (rxq|txq) (queue_id) setup
1944 Only take effect when port is started.
1949 Set the speed and duplex mode for all ports or a specific port::
1951 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
1952 duplex (half|full|auto)
1954 port config - queues/descriptors
1955 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1957 Set number of queues/descriptors for rxq, txq, rxd and txd::
1959 testpmd> port config all (rxq|txq|rxd|txd) (value)
1961 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1963 port config - max-pkt-len
1964 ~~~~~~~~~~~~~~~~~~~~~~~~~
1966 Set the maximum packet length::
1968 testpmd> port config all max-pkt-len (value)
1970 This is equivalent to the ``--max-pkt-len`` command-line option.
1972 port config - CRC Strip
1973 ~~~~~~~~~~~~~~~~~~~~~~~
1975 Set hardware CRC stripping on or off for all ports::
1977 testpmd> port config all crc-strip (on|off)
1979 CRC stripping is on by default.
1981 The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option.
1983 port config - scatter
1984 ~~~~~~~~~~~~~~~~~~~~~~~
1986 Set RX scatter mode on or off for all ports::
1988 testpmd> port config all scatter (on|off)
1990 RX scatter mode is off by default.
1992 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
1994 port config - RX Checksum
1995 ~~~~~~~~~~~~~~~~~~~~~~~~~
1997 Set hardware RX checksum offload to on or off for all ports::
1999 testpmd> port config all rx-cksum (on|off)
2001 Checksum offload is off by default.
2003 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
2008 Set hardware VLAN on or off for all ports::
2010 testpmd> port config all hw-vlan (on|off)
2012 Hardware VLAN is off by default.
2014 The ``on`` option is equivalent to the ``--enable-hw-vlan`` command-line option.
2016 port config - VLAN filter
2017 ~~~~~~~~~~~~~~~~~~~~~~~~~
2019 Set hardware VLAN filter on or off for all ports::
2021 testpmd> port config all hw-vlan-filter (on|off)
2023 Hardware VLAN filter is off by default.
2025 The ``on`` option is equivalent to the ``--enable-hw-vlan-filter`` command-line option.
2027 port config - VLAN strip
2028 ~~~~~~~~~~~~~~~~~~~~~~~~
2030 Set hardware VLAN strip on or off for all ports::
2032 testpmd> port config all hw-vlan-strip (on|off)
2034 Hardware VLAN strip is off by default.
2036 The ``on`` option is equivalent to the ``--enable-hw-vlan-strip`` command-line option.
2038 port config - VLAN extend
2039 ~~~~~~~~~~~~~~~~~~~~~~~~~
2041 Set hardware VLAN extend on or off for all ports::
2043 testpmd> port config all hw-vlan-extend (on|off)
2045 Hardware VLAN extend is off by default.
2047 The ``on`` option is equivalent to the ``--enable-hw-vlan-extend`` command-line option.
2049 port config - Drop Packets
2050 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2052 Set packet drop for packets with no descriptors on or off for all ports::
2054 testpmd> port config all drop-en (on|off)
2056 Packet dropping for packets with no descriptors is off by default.
2058 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2063 Set the RSS (Receive Side Scaling) mode on or off::
2065 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2067 RSS is on by default.
2069 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2070 The ``default`` option enables all supported RSS types reported by device info.
2071 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2073 port config - RSS Reta
2074 ~~~~~~~~~~~~~~~~~~~~~~
2076 Set the RSS (Receive Side Scaling) redirection table::
2078 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2083 Set the DCB mode for an individual port::
2085 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2087 The traffic class should be 4 or 8.
2092 Set the number of packets per burst::
2094 testpmd> port config all burst (value)
2096 This is equivalent to the ``--burst`` command-line option.
2098 port config - Threshold
2099 ~~~~~~~~~~~~~~~~~~~~~~~
2101 Set thresholds for TX/RX queues::
2103 testpmd> port config all (threshold) (value)
2105 Where the threshold type can be:
2107 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2109 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2111 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2113 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2115 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2117 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2119 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2121 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2123 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2125 These threshold options are also available from the command-line.
2130 Set the value of ether-type for E-tag::
2132 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2134 Enable/disable the E-tag support::
2136 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2138 port config pctype mapping
2139 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2141 Reset pctype mapping table::
2143 testpmd> port config (port_id) pctype mapping reset
2145 Update hardware defined pctype to software defined flow type mapping table::
2147 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2151 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2153 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2155 port config input set
2156 ~~~~~~~~~~~~~~~~~~~~~
2158 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2159 testpmd> port config (port_id) pctype (pctype_id) \
2160 (hash_inset|fdir_inset|fdir_flx_inset) \
2161 (get|set|clear) field (field_idx)
2163 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2164 testpmd> port config (port_id) pctype (pctype_id) \
2165 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2169 * ``pctype_id``: hardware packet classification types.
2170 * ``field_idx``: hardware field index.
2172 port config udp_tunnel_port
2173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2175 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2176 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2178 port config tx_metadata
2179 ~~~~~~~~~~~~~~~~~~~~~~~
2181 Set Tx metadata value per port.
2182 testpmd will add this value to any Tx packet sent from this port::
2184 testpmd> port config (port_id) tx_metadata (value)
2186 Link Bonding Functions
2187 ----------------------
2189 The Link Bonding functions make it possible to dynamically create and
2190 manage link bonding devices from within testpmd interactive prompt.
2192 create bonded device
2193 ~~~~~~~~~~~~~~~~~~~~
2195 Create a new bonding device::
2197 testpmd> create bonded device (mode) (socket)
2199 For example, to create a bonded device in mode 1 on socket 0::
2201 testpmd> create bonded device 1 0
2202 created new bonded device (port X)
2207 Adds Ethernet device to a Link Bonding device::
2209 testpmd> add bonding slave (slave id) (port id)
2211 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2213 testpmd> add bonding slave 6 10
2216 remove bonding slave
2217 ~~~~~~~~~~~~~~~~~~~~
2219 Removes an Ethernet slave device from a Link Bonding device::
2221 testpmd> remove bonding slave (slave id) (port id)
2223 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2225 testpmd> remove bonding slave 6 10
2230 Set the Link Bonding mode of a Link Bonding device::
2232 testpmd> set bonding mode (value) (port id)
2234 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2236 testpmd> set bonding mode 3 10
2241 Set an Ethernet slave device as the primary device on a Link Bonding device::
2243 testpmd> set bonding primary (slave id) (port id)
2245 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2247 testpmd> set bonding primary 6 10
2252 Set the MAC address of a Link Bonding device::
2254 testpmd> set bonding mac (port id) (mac)
2256 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2258 testpmd> set bonding mac 10 00:00:00:00:00:01
2260 set bonding xmit_balance_policy
2261 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2263 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2265 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2267 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2269 testpmd> set bonding xmit_balance_policy 10 l34
2272 set bonding mon_period
2273 ~~~~~~~~~~~~~~~~~~~~~~
2275 Set the link status monitoring polling period in milliseconds for a bonding device.
2277 This adds support for PMD slave devices which do not support link status interrupts.
2278 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2279 link status ISR will be queried every polling interval to check if their link status has changed::
2281 testpmd> set bonding mon_period (port_id) (value)
2283 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2285 testpmd> set bonding mon_period 5 150
2288 set bonding lacp dedicated_queue
2289 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2291 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2292 when in mode 4 (link-aggregration-802.3ad)::
2294 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2297 set bonding agg_mode
2298 ~~~~~~~~~~~~~~~~~~~~
2300 Enable one of the specific aggregators mode when in mode 4 (link-aggregration-802.3ad)::
2302 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2308 Show the current configuration of a Link Bonding device::
2310 testpmd> show bonding config (port id)
2313 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2314 in balance mode with a transmission policy of layer 2+3::
2316 testpmd> show bonding config 9
2318 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2320 Active Slaves (3): [1 3 4]
2327 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2328 This is mainly useful for debugging purposes.
2329 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2330 and fields that can be accessed.
2335 Display the value of a port register::
2337 testpmd> read reg (port_id) (address)
2339 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2341 testpmd> read reg 0 0xEE00
2342 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2347 Display a port register bit field::
2349 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2351 For example, reading the lowest two bits from the register in the example above::
2353 testpmd> read regfield 0 0xEE00 0 1
2354 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2359 Display a single port register bit::
2361 testpmd> read regbit (port_id) (address) (bit_x)
2363 For example, reading the lowest bit from the register in the example above::
2365 testpmd> read regbit 0 0xEE00 0
2366 port 0 PCI register at offset 0xEE00: bit 0=1
2371 Set the value of a port register::
2373 testpmd> write reg (port_id) (address) (value)
2375 For example, to clear a register::
2377 testpmd> write reg 0 0xEE00 0x0
2378 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2383 Set bit field of a port register::
2385 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2387 For example, writing to the register cleared in the example above::
2389 testpmd> write regfield 0 0xEE00 0 1 2
2390 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2395 Set single bit value of a port register::
2397 testpmd> write regbit (port_id) (address) (bit_x) (value)
2399 For example, to set the high bit in the register from the example above::
2401 testpmd> write regbit 0 0xEE00 31 1
2402 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2404 Traffic Metering and Policing
2405 -----------------------------
2407 The following section shows functions for configuring traffic metering and
2408 policing on the ethernet device through the use of generic ethdev API.
2410 show port traffic management capability
2411 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2413 Show traffic metering and policing capability of the port::
2415 testpmd> show port meter cap (port_id)
2417 add port meter profile (srTCM rfc2967)
2418 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2420 Add meter profile (srTCM rfc2697) to the ethernet device::
2422 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2427 * ``profile_id``: ID for the meter profile.
2428 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2429 * ``cbs``: Committed Burst Size (CBS) (bytes).
2430 * ``ebs``: Excess Burst Size (EBS) (bytes).
2432 add port meter profile (trTCM rfc2968)
2433 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2435 Add meter profile (srTCM rfc2698) to the ethernet device::
2437 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2438 (cir) (pir) (cbs) (pbs)
2442 * ``profile_id``: ID for the meter profile.
2443 * ``cir``: Committed information rate (bytes/second).
2444 * ``pir``: Peak information rate (bytes/second).
2445 * ``cbs``: Committed burst size (bytes).
2446 * ``pbs``: Peak burst size (bytes).
2448 add port meter profile (trTCM rfc4115)
2449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2451 Add meter profile (trTCM rfc4115) to the ethernet device::
2453 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2454 (cir) (eir) (cbs) (ebs)
2458 * ``profile_id``: ID for the meter profile.
2459 * ``cir``: Committed information rate (bytes/second).
2460 * ``eir``: Excess information rate (bytes/second).
2461 * ``cbs``: Committed burst size (bytes).
2462 * ``ebs``: Excess burst size (bytes).
2464 delete port meter profile
2465 ~~~~~~~~~~~~~~~~~~~~~~~~~
2467 Delete meter profile from the ethernet device::
2469 testpmd> del port meter profile (port_id) (profile_id)
2474 Create new meter object for the ethernet device::
2476 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2477 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2478 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2483 * ``mtr_id``: meter object ID.
2484 * ``profile_id``: ID for the meter profile.
2485 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2486 gets enabled at the time of creation, otherwise remains disabled.
2487 * ``g_action``: Policer action for the packet with green color.
2488 * ``y_action``: Policer action for the packet with yellow color.
2489 * ``r_action``: Policer action for the packet with red color.
2490 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2492 * ``shared``: When this parameter has a non-zero value, the meter object is
2493 shared by multiple flows. Otherwise, meter object is used by single flow.
2494 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2495 input color for the current meter object is determined by the latest meter
2496 object in the same flow. Otherwise, the current meter object uses the
2497 *dscp_table* to determine the input color.
2498 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2499 color, 0 <= x <= 63.
2504 Enable meter for the ethernet device::
2506 testpmd> enable port meter (port_id) (mtr_id)
2511 Disable meter for the ethernet device::
2513 testpmd> disable port meter (port_id) (mtr_id)
2518 Delete meter for the ethernet device::
2520 testpmd> del port meter (port_id) (mtr_id)
2522 Set port meter profile
2523 ~~~~~~~~~~~~~~~~~~~~~~
2525 Set meter profile for the ethernet device::
2527 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2529 set port meter dscp table
2530 ~~~~~~~~~~~~~~~~~~~~~~~~~
2532 Set meter dscp table for the ethernet device::
2534 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2535 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2537 set port meter policer action
2538 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2540 Set meter policer action for the ethernet device::
2542 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2543 (action0) [(action1) (action1)]
2547 * ``action_mask``: Bit mask indicating which policer actions need to be
2548 updated. One or more policer actions can be updated in a single function
2549 invocation. To update the policer action associated with color C, bit
2550 (1 << C) needs to be set in *action_mask* and element at position C
2551 in the *actions* array needs to be valid.
2552 * ``actionx``: Policer action for the color x,
2553 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2555 set port meter stats mask
2556 ~~~~~~~~~~~~~~~~~~~~~~~~~
2558 Set meter stats mask for the ethernet device::
2560 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2564 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2566 show port meter stats
2567 ~~~~~~~~~~~~~~~~~~~~~
2569 Show meter stats of the ethernet device::
2571 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2575 * ``clear``: Flag that indicates whether the statistics counters should
2576 be cleared (i.e. set to zero) immediately after they have been read or not.
2581 The following section shows functions for configuring traffic management on
2582 on the ethernet device through the use of generic TM API.
2584 show port traffic management capability
2585 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2587 Show traffic management capability of the port::
2589 testpmd> show port tm cap (port_id)
2591 show port traffic management capability (hierarchy level)
2592 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2594 Show traffic management hierarchy level capability of the port::
2596 testpmd> show port tm level cap (port_id) (level_id)
2598 show port traffic management capability (hierarchy node level)
2599 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2601 Show the traffic management hierarchy node capability of the port::
2603 testpmd> show port tm node cap (port_id) (node_id)
2605 show port traffic management hierarchy node type
2606 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2608 Show the port traffic management hierarchy node type::
2610 testpmd> show port tm node type (port_id) (node_id)
2612 show port traffic management hierarchy node stats
2613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2615 Show the port traffic management hierarchy node statistics::
2617 testpmd> show port tm node stats (port_id) (node_id) (clear)
2621 * ``clear``: When this parameter has a non-zero value, the statistics counters
2622 are cleared (i.e. set to zero) immediately after they have been read,
2623 otherwise the statistics counters are left untouched.
2625 Add port traffic management private shaper profile
2626 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2628 Add the port traffic management private shaper profile::
2630 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2631 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2632 (packet_length_adjust)
2636 * ``shaper_profile id``: Shaper profile ID for the new profile.
2637 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2638 * ``cmit_tb_size``: Committed token bucket size (bytes).
2639 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2640 * ``peak_tb_size``: Peak token bucket size (bytes).
2641 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2642 each packet for the purpose of shaping. This parameter value can be used to
2643 correct the packet length with the framing overhead bytes that are consumed
2646 Delete port traffic management private shaper profile
2647 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2649 Delete the port traffic management private shaper::
2651 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2655 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2657 Add port traffic management shared shaper
2658 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2660 Create the port traffic management shared shaper::
2662 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2667 * ``shared_shaper_id``: Shared shaper ID to be created.
2668 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2670 Set port traffic management shared shaper
2671 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2673 Update the port traffic management shared shaper::
2675 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2680 * ``shared_shaper_id``: Shared shaper ID to be update.
2681 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2683 Delete port traffic management shared shaper
2684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2686 Delete the port traffic management shared shaper::
2688 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2692 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2694 Set port traffic management hiearchy node private shaper
2695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2697 set the port traffic management hierarchy node private shaper::
2699 testpmd> set port tm node shaper profile (port_id) (node_id) \
2704 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2707 Add port traffic management WRED profile
2708 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2710 Create a new WRED profile::
2712 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2713 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2714 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2715 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2719 * ``wred_profile id``: Identifier for the newly create WRED profile
2720 * ``color_g``: Packet color (green)
2721 * ``min_th_g``: Minimum queue threshold for packet with green color
2722 * ``max_th_g``: Minimum queue threshold for packet with green color
2723 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2724 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2725 * ``color_y``: Packet color (yellow)
2726 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2727 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2728 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2729 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2730 * ``color_r``: Packet color (red)
2731 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2732 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2733 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2734 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2736 Delete port traffic management WRED profile
2737 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2739 Delete the WRED profile::
2741 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2743 Add port traffic management hierarchy nonleaf node
2744 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2746 Add nonleaf node to port traffic management hiearchy::
2748 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2749 (priority) (weight) (level_id) (shaper_profile_id) \
2750 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2751 [(shared_shaper_0) (shared_shaper_1) ...] \
2755 * ``parent_node_id``: Node ID of the parent.
2756 * ``priority``: Node priority (highest node priority is zero). This is used by
2757 the SP algorithm running on the parent node for scheduling this node.
2758 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2759 to the weight sum of all siblings that have the same priority. It is used by
2760 the WFQ algorithm running on the parent node for scheduling this node.
2761 * ``level_id``: Hiearchy level of the node.
2762 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2764 * ``n_sp_priorities``: Number of strict priorities.
2765 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2766 * ``n_shared_shapers``: Number of shared shapers.
2767 * ``shared_shaper_id``: Shared shaper id.
2769 Add port traffic management hierarchy leaf node
2770 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2772 Add leaf node to port traffic management hiearchy::
2774 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2775 (priority) (weight) (level_id) (shaper_profile_id) \
2776 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2777 [(shared_shaper_id) (shared_shaper_id) ...] \
2781 * ``parent_node_id``: Node ID of the parent.
2782 * ``priority``: Node priority (highest node priority is zero). This is used by
2783 the SP algorithm running on the parent node for scheduling this node.
2784 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2785 to the weight sum of all siblings that have the same priority. It is used by
2786 the WFQ algorithm running on the parent node for scheduling this node.
2787 * ``level_id``: Hiearchy level of the node.
2788 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2790 * ``cman_mode``: Congestion management mode to be enabled for this node.
2791 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2792 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2793 * ``n_shared_shapers``: Number of shared shapers.
2794 * ``shared_shaper_id``: Shared shaper id.
2796 Delete port traffic management hierarchy node
2797 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2799 Delete node from port traffic management hiearchy::
2801 testpmd> del port tm node (port_id) (node_id)
2803 Update port traffic management hierarchy parent node
2804 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2806 Update port traffic management hierarchy parent node::
2808 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2811 This function can only be called after the hierarchy commit invocation. Its
2812 success depends on the port support for this operation, as advertised through
2813 the port capability set. This function is valid for all nodes of the traffic
2814 management hierarchy except root node.
2816 Suspend port traffic management hierarchy node
2817 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2819 testpmd> suspend port tm node (port_id) (node_id)
2821 Resume port traffic management hierarchy node
2822 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2824 testpmd> resume port tm node (port_id) (node_id)
2826 Commit port traffic management hierarchy
2827 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2829 Commit the traffic management hierarchy on the port::
2831 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
2835 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
2836 call failure. On the other hand, hierarchy is preserved when this parameter
2839 Set port traffic management mark VLAN dei
2840 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2842 Enables/Disables the traffic management marking on the port for VLAN packets::
2844 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
2848 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
2849 ``yellow`` or ``red`` will have dei bit enabled
2851 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
2853 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
2855 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
2857 Set port traffic management mark IP dscp
2858 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2860 Enables/Disables the traffic management marking on the port for IP dscp packets::
2862 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
2866 * ``port_id``: The port which on which IP packets marked as ``green`` or
2867 ``yellow`` or ``red`` will have IP dscp bits updated
2869 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
2871 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
2873 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
2875 Set port traffic management mark IP ecn
2876 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2878 Enables/Disables the traffic management marking on the port for IP ecn packets::
2880 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
2884 * ``port_id``: The port which on which IP packets marked as ``green`` or
2885 ``yellow`` or ``red`` will have IP ecn bits updated
2887 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
2888 to ecn of 2'b11 when IP is caring TCP or SCTP
2890 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
2891 to ecn of 2'b11 when IP is caring TCP or SCTP
2893 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
2894 to ecn of 2'b11 when IP is caring TCP or SCTP
2896 Set port traffic management default hierarchy (softnic forwarding mode)
2897 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2899 set the traffic management default hierarchy on the port::
2901 testpmd> set port tm hierarchy default (port_id)
2906 This section details the available filter functions that are available.
2908 Note these functions interface the deprecated legacy filtering framework,
2909 superseded by *rte_flow*. See `Flow rules management`_.
2912 ~~~~~~~~~~~~~~~~~~~~
2914 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
2916 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
2917 ethertype (ether_type) (drop|fwd) queue (queue_id)
2919 The available information parameters are:
2921 * ``port_id``: The port which the Ethertype filter assigned on.
2923 * ``mac_addr``: Compare destination mac address.
2925 * ``mac_ignr``: Ignore destination mac address match.
2927 * ``mac_address``: Destination mac address to match.
2929 * ``ether_type``: The EtherType value want to match,
2930 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
2932 * ``queue_id``: The receive queue associated with this EtherType filter.
2933 It is meaningless when deleting or dropping.
2935 Example, to add/remove an ethertype filter rule::
2937 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
2938 ethertype 0x0806 fwd queue 3
2940 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
2941 ethertype 0x0806 fwd queue 3
2946 Add or delete a 2-tuple filter,
2947 which identifies packets by specific protocol and destination TCP/UDP port
2948 and forwards packets into one of the receive queues::
2950 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
2951 protocol (protocol_value) mask (mask_value) \
2952 tcp_flags (tcp_flags_value) priority (prio_value) \
2955 The available information parameters are:
2957 * ``port_id``: The port which the 2-tuple filter assigned on.
2959 * ``dst_port_value``: Destination port in L4.
2961 * ``protocol_value``: IP L4 protocol.
2963 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
2965 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
2967 * ``prio_value``: Priority of this filter.
2969 * ``queue_id``: The receive queue associated with this 2-tuple filter.
2971 Example, to add/remove an 2tuple filter rule::
2973 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
2974 tcp_flags 0x02 priority 3 queue 3
2976 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
2977 tcp_flags 0x02 priority 3 queue 3
2982 Add or delete a 5-tuple filter,
2983 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
2984 and routes packets into one of the receive queues::
2986 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
2987 (src_address) dst_port (dst_port_value) \
2988 src_port (src_port_value) protocol (protocol_value) \
2989 mask (mask_value) tcp_flags (tcp_flags_value) \
2990 priority (prio_value) queue (queue_id)
2992 The available information parameters are:
2994 * ``port_id``: The port which the 5-tuple filter assigned on.
2996 * ``dst_address``: Destination IP address.
2998 * ``src_address``: Source IP address.
3000 * ``dst_port_value``: TCP/UDP destination port.
3002 * ``src_port_value``: TCP/UDP source port.
3004 * ``protocol_value``: L4 protocol.
3006 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3008 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3010 * ``prio_value``: The priority of this filter.
3012 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3014 Example, to add/remove an 5tuple filter rule::
3016 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3017 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3018 flags 0x0 priority 3 queue 3
3020 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3021 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3022 flags 0x0 priority 3 queue 3
3027 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3029 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3031 The available information parameters are:
3033 * ``port_id``: The port which the SYN filter assigned on.
3035 * ``high``: This SYN filter has higher priority than other filters.
3037 * ``low``: This SYN filter has lower priority than other filters.
3039 * ``queue_id``: The receive queue associated with this SYN filter
3043 testpmd> syn_filter 0 add priority high queue 3
3048 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3049 and routed into one of the receive queues::
3051 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3052 mask (mask_value) priority (prio_value) queue (queue_id)
3054 The available information parameters are:
3056 * ``port_id``: The port which the Flex filter is assigned on.
3058 * ``len_value``: Filter length in bytes, no greater than 128.
3060 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3062 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3064 * ``prio_value``: The priority of this filter.
3066 * ``queue_id``: The receive queue associated with this Flex filter.
3070 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3071 mask 000C priority 3 queue 3
3073 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3074 mask 000C priority 3 queue 3
3077 .. _testpmd_flow_director:
3079 flow_director_filter
3080 ~~~~~~~~~~~~~~~~~~~~
3082 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3084 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3085 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3087 * Perfect match filters.
3088 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3089 The masked fields are for IP flow.
3091 * Signature filters.
3092 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3094 * Perfect-mac-vlan match filters.
3095 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3096 The masked fields are for MAC VLAN flow.
3098 * Perfect-tunnel match filters.
3099 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3100 The masked fields are for tunnel flow.
3102 * Perfect-raw-flow-type match filters.
3103 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3104 The masked fields are specified by input sets.
3106 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3107 per flow type and the flexible payload.
3109 The Flow Director can also mask out parts of all of these fields so that filters
3110 are only applied to certain fields or parts of the fields.
3112 Note that for raw flow type mode the source and destination fields in the
3113 raw packet buffer need to be presented in a reversed order with respect
3114 to the expected received packets.
3115 For example: IP source and destination addresses or TCP/UDP/SCTP
3116 source and destination ports
3118 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3120 # Commands to add flow director filters of different flow types::
3122 flow_director_filter (port_id) mode IP (add|del|update) \
3123 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3124 src (src_ip_address) dst (dst_ip_address) \
3125 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3126 vlan (vlan_value) flexbytes (flexbytes_value) \
3127 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3130 flow_director_filter (port_id) mode IP (add|del|update) \
3131 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3132 src (src_ip_address) (src_port) \
3133 dst (dst_ip_address) (dst_port) \
3134 tos (tos_value) ttl (ttl_value) \
3135 vlan (vlan_value) flexbytes (flexbytes_value) \
3136 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3139 flow_director_filter (port_id) mode IP (add|del|update) \
3140 flow (ipv4-sctp|ipv6-sctp) \
3141 src (src_ip_address) (src_port) \
3142 dst (dst_ip_address) (dst_port) \
3143 tos (tos_value) ttl (ttl_value) \
3144 tag (verification_tag) vlan (vlan_value) \
3145 flexbytes (flexbytes_value) (drop|fwd) \
3146 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3148 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3149 ether (ethertype) flexbytes (flexbytes_value) \
3150 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3153 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3154 mac (mac_address) vlan (vlan_value) \
3155 flexbytes (flexbytes_value) (drop|fwd) \
3156 queue (queue_id) fd_id (fd_id_value)
3158 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3159 mac (mac_address) vlan (vlan_value) \
3160 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3161 flexbytes (flexbytes_value) (drop|fwd) \
3162 queue (queue_id) fd_id (fd_id_value)
3164 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3165 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3166 packet (packet file name)
3168 For example, to add an ipv4-udp flow type filter::
3170 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3171 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3172 fwd pf queue 1 fd_id 1
3174 For example, add an ipv4-other flow type filter::
3176 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3177 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3178 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3183 Flush all flow director filters on a device::
3185 testpmd> flush_flow_director (port_id)
3187 Example, to flush all flow director filter on port 0::
3189 testpmd> flush_flow_director 0
3194 Set flow director's input masks::
3196 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3197 src_mask (ipv4_src) (ipv6_src) (src_port) \
3198 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3200 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3202 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3203 mac (mac_value) tunnel-type (tunnel_type_value) \
3204 tunnel-id (tunnel_id_value)
3206 Example, to set flow director mask on port 0::
3208 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3209 src_mask 255.255.255.255 \
3210 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3211 dst_mask 255.255.255.255 \
3212 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3214 flow_director_flex_mask
3215 ~~~~~~~~~~~~~~~~~~~~~~~
3217 set masks of flow director's flexible payload based on certain flow type::
3219 testpmd> flow_director_flex_mask (port_id) \
3220 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3221 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3222 l2_payload|all) (mask)
3224 Example, to set flow director's flex mask for all flow type on port 0::
3226 testpmd> flow_director_flex_mask 0 flow all \
3227 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3230 flow_director_flex_payload
3231 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3233 Configure flexible payload selection::
3235 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3237 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3239 testpmd> flow_director_flex_payload 0 l4 \
3240 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3242 get_sym_hash_ena_per_port
3243 ~~~~~~~~~~~~~~~~~~~~~~~~~
3245 Get symmetric hash enable configuration per port::
3247 get_sym_hash_ena_per_port (port_id)
3249 For example, to get symmetric hash enable configuration of port 1::
3251 testpmd> get_sym_hash_ena_per_port 1
3253 set_sym_hash_ena_per_port
3254 ~~~~~~~~~~~~~~~~~~~~~~~~~
3256 Set symmetric hash enable configuration per port to enable or disable::
3258 set_sym_hash_ena_per_port (port_id) (enable|disable)
3260 For example, to set symmetric hash enable configuration of port 1 to enable::
3262 testpmd> set_sym_hash_ena_per_port 1 enable
3264 get_hash_global_config
3265 ~~~~~~~~~~~~~~~~~~~~~~
3267 Get the global configurations of hash filters::
3269 get_hash_global_config (port_id)
3271 For example, to get the global configurations of hash filters of port 1::
3273 testpmd> get_hash_global_config 1
3275 set_hash_global_config
3276 ~~~~~~~~~~~~~~~~~~~~~~
3278 Set the global configurations of hash filters::
3280 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
3281 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3282 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3285 For example, to enable simple_xor for flow type of ipv6 on port 2::
3287 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3292 Set the input set for hash::
3294 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3295 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3296 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3297 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3298 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3299 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3300 fld-8th|none) (select|add)
3302 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3304 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3309 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3310 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3312 Set the input set for flow director::
3314 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3315 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3316 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3317 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3318 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3319 sctp-dst-port|sctp-veri-tag|none) (select|add)
3321 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3323 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3328 Set different GRE key length for input set::
3330 global_config (port_id) gre-key-len (number in bytes)
3332 For example to set GRE key length for input set to 4 bytes on port 0::
3334 testpmd> global_config 0 gre-key-len 4
3337 .. _testpmd_rte_flow:
3339 Flow rules management
3340 ---------------------
3342 Control of the generic flow API (*rte_flow*) is fully exposed through the
3343 ``flow`` command (validation, creation, destruction, queries and operation
3346 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3347 features simultaneously may cause undefined side-effects and is therefore
3353 Because the ``flow`` command uses dynamic tokens to handle the large number
3354 of possible flow rules combinations, its behavior differs slightly from
3355 other commands, in particular:
3357 - Pressing *?* or the *<tab>* key displays contextual help for the current
3358 token, not that of the entire command.
3360 - Optional and repeated parameters are supported (provided they are listed
3361 in the contextual help).
3363 The first parameter stands for the operation mode. Possible operations and
3364 their general syntax are described below. They are covered in detail in the
3367 - Check whether a flow rule can be created::
3369 flow validate {port_id}
3370 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3371 pattern {item} [/ {item} [...]] / end
3372 actions {action} [/ {action} [...]] / end
3374 - Create a flow rule::
3376 flow create {port_id}
3377 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3378 pattern {item} [/ {item} [...]] / end
3379 actions {action} [/ {action} [...]] / end
3381 - Destroy specific flow rules::
3383 flow destroy {port_id} rule {rule_id} [...]
3385 - Destroy all flow rules::
3387 flow flush {port_id}
3389 - Query an existing flow rule::
3391 flow query {port_id} {rule_id} {action}
3393 - List existing flow rules sorted by priority, filtered by group
3396 flow list {port_id} [group {group_id}] [...]
3398 - Restrict ingress traffic to the defined flow rules::
3400 flow isolate {port_id} {boolean}
3402 Validating flow rules
3403 ~~~~~~~~~~~~~~~~~~~~~
3405 ``flow validate`` reports whether a flow rule would be accepted by the
3406 underlying device in its current state but stops short of creating it. It is
3407 bound to ``rte_flow_validate()``::
3409 flow validate {port_id}
3410 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3411 pattern {item} [/ {item} [...]] / end
3412 actions {action} [/ {action} [...]] / end
3414 If successful, it will show::
3418 Otherwise it will show an error message of the form::
3420 Caught error type [...] ([...]): [...]
3422 This command uses the same parameters as ``flow create``, their format is
3423 described in `Creating flow rules`_.
3425 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3426 index 6 is supported::
3428 testpmd> flow validate 0 ingress pattern eth / end
3429 actions queue index 6 / end
3433 Port 0 does not support TCPv6 rules::
3435 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3437 Caught error type 9 (specific pattern item): Invalid argument
3443 ``flow create`` validates and creates the specified flow rule. It is bound
3444 to ``rte_flow_create()``::
3446 flow create {port_id}
3447 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3448 pattern {item} [/ {item} [...]] / end
3449 actions {action} [/ {action} [...]] / end
3451 If successful, it will return a flow rule ID usable with other commands::
3453 Flow rule #[...] created
3455 Otherwise it will show an error message of the form::
3457 Caught error type [...] ([...]): [...]
3459 Parameters describe in the following order:
3461 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3462 - A matching pattern, starting with the *pattern* token and terminated by an
3464 - Actions, starting with the *actions* token and terminated by an *end*
3467 These translate directly to *rte_flow* objects provided as-is to the
3468 underlying functions.
3470 The shortest valid definition only comprises mandatory tokens::
3472 testpmd> flow create 0 pattern end actions end
3474 Note that PMDs may refuse rules that essentially do nothing such as this
3477 **All unspecified object values are automatically initialized to 0.**
3482 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3483 specified before the ``pattern`` token.
3485 - ``group {group id}``: priority group.
3486 - ``priority {level}``: priority level within group.
3487 - ``ingress``: rule applies to ingress traffic.
3488 - ``egress``: rule applies to egress traffic.
3489 - ``transfer``: apply rule directly to endpoints found in pattern.
3491 Each instance of an attribute specified several times overrides the previous
3492 value as shown below (group 4 is used)::
3494 testpmd> flow create 0 group 42 group 24 group 4 [...]
3496 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3498 While not specifying a direction is an error, some rules may allow both
3501 Most rules affect RX therefore contain the ``ingress`` token::
3503 testpmd> flow create 0 ingress pattern [...]
3508 A matching pattern starts after the ``pattern`` token. It is made of pattern
3509 items and is terminated by a mandatory ``end`` item.
3511 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3512 rte_flow_item_type``).
3514 The ``/`` token is used as a separator between pattern items as shown
3517 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3519 Note that protocol items like these must be stacked from lowest to highest
3520 layer to make sense. For instance, the following rule is either invalid or
3521 unlikely to match any packet::
3523 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3525 More information on these restrictions can be found in the *rte_flow*
3528 Several items support additional specification structures, for example
3529 ``ipv4`` allows specifying source and destination addresses as follows::
3531 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3532 dst is 10.2.0.0 / end [...]
3534 This rule matches all IPv4 traffic with the specified properties.
3536 In this example, ``src`` and ``dst`` are field names of the underlying
3537 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3538 in a similar fashion.
3540 The ``is`` token means that the subsequent value must be matched exactly,
3541 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3542 accordingly. Possible assignment tokens are:
3544 - ``is``: match value perfectly (with full bit-mask).
3545 - ``spec``: match value according to configured bit-mask.
3546 - ``last``: specify upper bound to establish a range.
3547 - ``mask``: specify bit-mask with relevant bits set to one.
3548 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3550 These yield identical results::
3552 ipv4 src is 10.1.1.1
3556 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3560 ipv4 src spec 10.1.1.1 src prefix 32
3564 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3568 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3570 Inclusive ranges can be defined with ``last``::
3572 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3574 Note that ``mask`` affects both ``spec`` and ``last``::
3576 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3577 # matches 10.1.0.0 to 10.2.255.255
3579 Properties can be modified multiple times::
3581 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3585 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3590 This section lists supported pattern items and their attributes, if any.
3592 - ``end``: end list of pattern items.
3594 - ``void``: no-op pattern item.
3596 - ``invert``: perform actions when pattern does not match.
3598 - ``any``: match any protocol for the current layer.
3600 - ``num {unsigned}``: number of layers covered.
3602 - ``pf``: match traffic from/to the physical function.
3604 - ``vf``: match traffic from/to a virtual function ID.
3606 - ``id {unsigned}``: VF ID.
3608 - ``phy_port``: match traffic from/to a specific physical port.
3610 - ``index {unsigned}``: physical port index.
3612 - ``port_id``: match traffic from/to a given DPDK port ID.
3614 - ``id {unsigned}``: DPDK port ID.
3616 - ``mark``: match value set in previously matched flow rule using the mark action.
3618 - ``id {unsigned}``: arbitrary integer value.
3620 - ``raw``: match an arbitrary byte string.
3622 - ``relative {boolean}``: look for pattern after the previous item.
3623 - ``search {boolean}``: search pattern from offset (see also limit).
3624 - ``offset {integer}``: absolute or relative offset for pattern.
3625 - ``limit {unsigned}``: search area limit for start of pattern.
3626 - ``pattern {string}``: byte string to look for.
3628 - ``eth``: match Ethernet header.
3630 - ``dst {MAC-48}``: destination MAC.
3631 - ``src {MAC-48}``: source MAC.
3632 - ``type {unsigned}``: EtherType or TPID.
3634 - ``vlan``: match 802.1Q/ad VLAN tag.
3636 - ``tci {unsigned}``: tag control information.
3637 - ``pcp {unsigned}``: priority code point.
3638 - ``dei {unsigned}``: drop eligible indicator.
3639 - ``vid {unsigned}``: VLAN identifier.
3640 - ``inner_type {unsigned}``: inner EtherType or TPID.
3642 - ``ipv4``: match IPv4 header.
3644 - ``tos {unsigned}``: type of service.
3645 - ``ttl {unsigned}``: time to live.
3646 - ``proto {unsigned}``: next protocol ID.
3647 - ``src {ipv4 address}``: source address.
3648 - ``dst {ipv4 address}``: destination address.
3650 - ``ipv6``: match IPv6 header.
3652 - ``tc {unsigned}``: traffic class.
3653 - ``flow {unsigned}``: flow label.
3654 - ``proto {unsigned}``: protocol (next header).
3655 - ``hop {unsigned}``: hop limit.
3656 - ``src {ipv6 address}``: source address.
3657 - ``dst {ipv6 address}``: destination address.
3659 - ``icmp``: match ICMP header.
3661 - ``type {unsigned}``: ICMP packet type.
3662 - ``code {unsigned}``: ICMP packet code.
3664 - ``udp``: match UDP header.
3666 - ``src {unsigned}``: UDP source port.
3667 - ``dst {unsigned}``: UDP destination port.
3669 - ``tcp``: match TCP header.
3671 - ``src {unsigned}``: TCP source port.
3672 - ``dst {unsigned}``: TCP destination port.
3674 - ``sctp``: match SCTP header.
3676 - ``src {unsigned}``: SCTP source port.
3677 - ``dst {unsigned}``: SCTP destination port.
3678 - ``tag {unsigned}``: validation tag.
3679 - ``cksum {unsigned}``: checksum.
3681 - ``vxlan``: match VXLAN header.
3683 - ``vni {unsigned}``: VXLAN identifier.
3685 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3687 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3689 - ``nvgre``: match NVGRE header.
3691 - ``tni {unsigned}``: virtual subnet ID.
3693 - ``mpls``: match MPLS header.
3695 - ``label {unsigned}``: MPLS label.
3697 - ``gre``: match GRE header.
3699 - ``protocol {unsigned}``: protocol type.
3701 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3703 - ``thresh {unsigned}``: accuracy threshold.
3705 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3707 - ``teid {unsigned}``: tunnel endpoint identifier.
3709 - ``geneve``: match GENEVE header.
3711 - ``vni {unsigned}``: virtual network identifier.
3712 - ``protocol {unsigned}``: protocol type.
3714 - ``vxlan-gpe``: match VXLAN-GPE header.
3716 - ``vni {unsigned}``: VXLAN-GPE identifier.
3718 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3720 - ``sha {MAC-48}``: sender hardware address.
3721 - ``spa {ipv4 address}``: sender IPv4 address.
3722 - ``tha {MAC-48}``: target hardware address.
3723 - ``tpa {ipv4 address}``: target IPv4 address.
3725 - ``ipv6_ext``: match presence of any IPv6 extension header.
3727 - ``next_hdr {unsigned}``: next header.
3729 - ``icmp6``: match any ICMPv6 header.
3731 - ``type {unsigned}``: ICMPv6 type.
3732 - ``code {unsigned}``: ICMPv6 code.
3734 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3736 - ``target_addr {ipv6 address}``: target address.
3738 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3740 - ``target_addr {ipv6 address}``: target address.
3742 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3744 - ``type {unsigned}``: ND option type.
3746 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3747 link-layer address option.
3749 - ``sla {MAC-48}``: source Ethernet LLA.
3751 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3752 link-layer address option.
3754 - ``tla {MAC-48}``: target Ethernet LLA.
3756 - ``meta``: match application specific metadata.
3758 - ``data {unsigned}``: metadata value.
3763 A list of actions starts after the ``actions`` token in the same fashion as
3764 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3765 terminated by a mandatory ``end`` action.
3767 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3768 rte_flow_action_type``).
3770 Dropping all incoming UDPv4 packets can be expressed as follows::
3772 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3775 Several actions have configurable properties which must be specified when
3776 there is no valid default value. For example, ``queue`` requires a target
3779 This rule redirects incoming UDPv4 traffic to queue index 6::
3781 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3782 actions queue index 6 / end
3784 While this one could be rejected by PMDs (unspecified queue index)::
3786 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3789 As defined by *rte_flow*, the list is not ordered, all actions of a given
3790 rule are performed simultaneously. These are equivalent::
3792 queue index 6 / void / mark id 42 / end
3796 void / mark id 42 / queue index 6 / end
3798 All actions in a list should have different types, otherwise only the last
3799 action of a given type is taken into account::
3801 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3805 drop / drop / drop / end # drop is performed only once
3809 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3811 Considering they are performed simultaneously, opposite and overlapping
3812 actions can sometimes be combined when the end result is unambiguous::
3814 drop / queue index 6 / end # drop has no effect
3818 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3822 drop / passthru / end # drop has no effect
3824 Note that PMDs may still refuse such combinations.
3829 This section lists supported actions and their attributes, if any.
3831 - ``end``: end list of actions.
3833 - ``void``: no-op action.
3835 - ``passthru``: let subsequent rule process matched packets.
3837 - ``jump``: redirect traffic to group on device.
3839 - ``group {unsigned}``: group to redirect to.
3841 - ``mark``: attach 32 bit value to packets.
3843 - ``id {unsigned}``: 32 bit value to return with packets.
3845 - ``flag``: flag packets.
3847 - ``queue``: assign packets to a given queue index.
3849 - ``index {unsigned}``: queue index to use.
3851 - ``drop``: drop packets (note: passthru has priority).
3853 - ``count``: enable counters for this rule.
3855 - ``rss``: spread packets among several queues.
3857 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
3858 the same as `set_hash_global_config`_.
3860 - ``level {unsigned}``: encapsulation level for ``types``.
3862 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
3863 tokens are the same as `set_hash_input_set`_, except that an empty list
3864 does not disable RSS but instead requests unspecified "best-effort"
3867 - ``key {string}``: RSS hash key, overrides ``key_len``.
3869 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
3870 conjunction with ``key`` to pad or truncate it.
3872 - ``queues [{unsigned} [...]] end``: queue indices to use.
3874 - ``pf``: direct traffic to physical function.
3876 - ``vf``: direct traffic to a virtual function ID.
3878 - ``original {boolean}``: use original VF ID if possible.
3879 - ``id {unsigned}``: VF ID.
3881 - ``phy_port``: direct packets to physical port index.
3883 - ``original {boolean}``: use original port index if possible.
3884 - ``index {unsigned}``: physical port index.
3886 - ``port_id``: direct matching traffic to a given DPDK port ID.
3888 - ``original {boolean}``: use original DPDK port ID if possible.
3889 - ``id {unsigned}``: DPDK port ID.
3891 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
3893 - ``mpls_ttl``: MPLS TTL.
3895 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
3897 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
3899 - ``nw_ttl``: IP TTL.
3901 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
3903 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
3905 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
3907 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
3909 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
3911 - ``ethertype``: Ethertype.
3913 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
3915 - ``vlan_vid``: VLAN id.
3917 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
3919 - ``vlan_pcp``: VLAN priority.
3921 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
3923 - ``ethertype``: Ethertype.
3925 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
3927 - ``ethertype``: Ethertype.
3929 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
3930 is done through `Config VXLAN Encap outer layers`_.
3932 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
3933 the VXLAN tunnel network overlay from the matched flow.
3935 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
3936 is done through `Config NVGRE Encap outer layers`_.
3938 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
3939 the NVGRE tunnel network overlay from the matched flow.
3941 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
3942 is done through `Config L2 Encap`_.
3944 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
3945 is done through `Config L2 Decap`_.
3947 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
3948 configuration is done through `Config MPLSoGRE Encap outer layers`_.
3950 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
3951 configuration is done through `Config MPLSoGRE Decap outer layers`_.
3953 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
3954 configuration is done through `Config MPLSoUDP Encap outer layers`_.
3956 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
3957 configuration is done through `Config MPLSoUDP Decap outer layers`_.
3959 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
3961 - ``ipv4_addr``: New IPv4 source address.
3963 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
3966 - ``ipv4_addr``: New IPv4 destination address.
3968 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
3970 - ``ipv6_addr``: New IPv6 source address.
3972 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
3975 - ``ipv6_addr``: New IPv6 destination address.
3977 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
3980 - ``port``: New TCP/UDP source port number.
3982 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
3985 - ``port``: New TCP/UDP destination port number.
3987 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
3990 - ``dec_ttl``: Performs a decrease TTL value action
3992 - ``set_ttl``: Set TTL value with specificed value
3993 - ``ttl_value {unsigned}``: The new TTL value to be set
3995 - ``set_mac_src``: set source MAC address
3997 - ``mac_addr {MAC-48}``: new source MAC address
3999 - ``set_mac_dst``: set destination MAC address
4001 - ``mac_addr {MAC-48}``: new destination MAC address
4003 Destroying flow rules
4004 ~~~~~~~~~~~~~~~~~~~~~
4006 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4007 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4008 times as necessary::
4010 flow destroy {port_id} rule {rule_id} [...]
4012 If successful, it will show::
4014 Flow rule #[...] destroyed
4016 It does not report anything for rule IDs that do not exist. The usual error
4017 message is shown when a rule cannot be destroyed::
4019 Caught error type [...] ([...]): [...]
4021 ``flow flush`` destroys all rules on a device and does not take extra
4022 arguments. It is bound to ``rte_flow_flush()``::
4024 flow flush {port_id}
4026 Any errors are reported as above.
4028 Creating several rules and destroying them::
4030 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4031 actions queue index 2 / end
4032 Flow rule #0 created
4033 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4034 actions queue index 3 / end
4035 Flow rule #1 created
4036 testpmd> flow destroy 0 rule 0 rule 1
4037 Flow rule #1 destroyed
4038 Flow rule #0 destroyed
4041 The same result can be achieved using ``flow flush``::
4043 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4044 actions queue index 2 / end
4045 Flow rule #0 created
4046 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4047 actions queue index 3 / end
4048 Flow rule #1 created
4049 testpmd> flow flush 0
4052 Non-existent rule IDs are ignored::
4054 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4055 actions queue index 2 / end
4056 Flow rule #0 created
4057 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4058 actions queue index 3 / end
4059 Flow rule #1 created
4060 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4062 testpmd> flow destroy 0 rule 0
4063 Flow rule #0 destroyed
4069 ``flow query`` queries a specific action of a flow rule having that
4070 ability. Such actions collect information that can be reported using this
4071 command. It is bound to ``rte_flow_query()``::
4073 flow query {port_id} {rule_id} {action}
4075 If successful, it will display either the retrieved data for known actions
4076 or the following message::
4078 Cannot display result for action type [...] ([...])
4080 Otherwise, it will complain either that the rule does not exist or that some
4083 Flow rule #[...] not found
4087 Caught error type [...] ([...]): [...]
4089 Currently only the ``count`` action is supported. This action reports the
4090 number of packets that hit the flow rule and the total number of bytes. Its
4091 output has the following format::
4094 hits_set: [...] # whether "hits" contains a valid value
4095 bytes_set: [...] # whether "bytes" contains a valid value
4096 hits: [...] # number of packets
4097 bytes: [...] # number of bytes
4099 Querying counters for TCPv6 packets redirected to queue 6::
4101 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4102 actions queue index 6 / count / end
4103 Flow rule #4 created
4104 testpmd> flow query 0 4 count
4115 ``flow list`` lists existing flow rules sorted by priority and optionally
4116 filtered by group identifiers::
4118 flow list {port_id} [group {group_id}] [...]
4120 This command only fails with the following message if the device does not
4125 Output consists of a header line followed by a short description of each
4126 flow rule, one per line. There is no output at all when no flow rules are
4127 configured on the device::
4129 ID Group Prio Attr Rule
4130 [...] [...] [...] [...] [...]
4132 ``Attr`` column flags:
4134 - ``i`` for ``ingress``.
4135 - ``e`` for ``egress``.
4137 Creating several flow rules and listing them::
4139 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4140 actions queue index 6 / end
4141 Flow rule #0 created
4142 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4143 actions queue index 2 / end
4144 Flow rule #1 created
4145 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4146 actions rss queues 6 7 8 end / end
4147 Flow rule #2 created
4148 testpmd> flow list 0
4149 ID Group Prio Attr Rule
4150 0 0 0 i- ETH IPV4 => QUEUE
4151 1 0 0 i- ETH IPV6 => QUEUE
4152 2 0 5 i- ETH IPV4 UDP => RSS
4155 Rules are sorted by priority (i.e. group ID first, then priority level)::
4157 testpmd> flow list 1
4158 ID Group Prio Attr Rule
4159 0 0 0 i- ETH => COUNT
4160 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4161 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4162 1 24 0 i- ETH IPV4 UDP => QUEUE
4163 4 24 10 i- ETH IPV4 TCP => DROP
4164 3 24 20 i- ETH IPV4 => DROP
4165 2 24 42 i- ETH IPV4 UDP => QUEUE
4166 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4169 Output can be limited to specific groups::
4171 testpmd> flow list 1 group 0 group 63
4172 ID Group Prio Attr Rule
4173 0 0 0 i- ETH => COUNT
4174 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4175 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4176 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4179 Toggling isolated mode
4180 ~~~~~~~~~~~~~~~~~~~~~~
4182 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4183 must only be injected from the defined flow rules; that no default traffic
4184 is expected outside those rules and the driver is free to assign more
4185 resources to handle them. It is bound to ``rte_flow_isolate()``::
4187 flow isolate {port_id} {boolean}
4189 If successful, enabling or disabling isolated mode shows either::
4191 Ingress traffic on port [...]
4192 is now restricted to the defined flow rules
4196 Ingress traffic on port [...]
4197 is not restricted anymore to the defined flow rules
4199 Otherwise, in case of error::
4201 Caught error type [...] ([...]): [...]
4203 Mainly due to its side effects, PMDs supporting this mode may not have the
4204 ability to toggle it more than once without reinitializing affected ports
4205 first (e.g. by exiting testpmd).
4207 Enabling isolated mode::
4209 testpmd> flow isolate 0 true
4210 Ingress traffic on port 0 is now restricted to the defined flow rules
4213 Disabling isolated mode::
4215 testpmd> flow isolate 0 false
4216 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4219 Sample QinQ flow rules
4220 ~~~~~~~~~~~~~~~~~~~~~~
4222 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4224 testpmd> port stop 0
4225 testpmd> vlan set qinq on 0
4227 The above command sets the inner and outer TPID's to 0x8100.
4229 To change the TPID's the following commands should be used::
4231 testpmd> vlan set outer tpid 0xa100 0
4232 testpmd> vlan set inner tpid 0x9100 0
4233 testpmd> port start 0
4235 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4239 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4240 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4241 Flow rule #0 validated
4243 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4244 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4245 Flow rule #0 created
4247 testpmd> flow list 0
4248 ID Group Prio Attr Rule
4249 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4251 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4255 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4256 vlan tci is 654 / end actions pf / queue index 0 / end
4257 Flow rule #1 validated
4259 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4260 vlan tci is 654 / end actions pf / queue index 1 / end
4261 Flow rule #1 created
4263 testpmd> flow list 0
4264 ID Group Prio Attr Rule
4265 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4266 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4268 Sample VXLAN encapsulation rule
4269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4271 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4272 source code, those can be changed by using the following commands
4274 IPv4 VXLAN outer header::
4276 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4277 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4278 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4281 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4282 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4283 eth-dst 22:22:22:22:22:22
4284 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4287 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4288 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4289 eth-dst 22:22:22:22:22:22
4290 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4293 IPv6 VXLAN outer header::
4295 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4296 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4297 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4300 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4301 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4302 eth-dst 22:22:22:22:22:22
4303 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4306 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4307 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4308 eth-dst 22:22:22:22:22:22
4309 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4312 Sample NVGRE encapsulation rule
4313 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4315 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4316 source code, those can be changed by using the following commands
4318 IPv4 NVGRE outer header::
4320 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4321 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4322 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4325 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4326 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4327 eth-dst 22:22:22:22:22:22
4328 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4331 IPv6 NVGRE outer header::
4333 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4334 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4335 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4338 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4339 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4340 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4343 Sample L2 encapsulation rule
4344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4346 L2 encapsulation has default value pre-configured in testpmd
4347 source code, those can be changed by using the following commands
4351 testpmd> set l2_encap ip-version ipv4
4352 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4353 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4354 mplsoudp_decap / l2_encap / end
4356 L2 with VXLAN header::
4358 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4359 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4360 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4361 mplsoudp_decap / l2_encap / end
4363 Sample L2 decapsulation rule
4364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4366 L2 decapsulation has default value pre-configured in testpmd
4367 source code, those can be changed by using the following commands
4371 testpmd> set l2_decap
4372 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4375 L2 with VXLAN header::
4377 testpmd> set l2_encap-with-vlan
4378 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4381 Sample MPLSoGRE encapsulation rule
4382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4384 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4385 source code, those can be changed by using the following commands
4387 IPv4 MPLSoGRE outer header::
4389 testpmd> set mplsogre_encap ip-version ipv4 label 4
4390 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4391 eth-dst 22:22:22:22:22:22
4392 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4393 mplsogre_encap / end
4395 IPv4 MPLSoGRE with VLAN outer header::
4397 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4398 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4399 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4400 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4401 mplsogre_encap / end
4403 IPv6 MPLSoGRE outer header::
4405 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4406 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4407 eth-dst 22:22:22:22:22:22
4408 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4409 mplsogre_encap / end
4411 IPv6 MPLSoGRE with VLAN outer header::
4413 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4414 ip-src ::1 ip-dst ::2222 vlan-tci 34
4415 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4416 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4417 mplsogre_encap / end
4419 Sample MPLSoGRE decapsulation rule
4420 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4422 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4423 source code, those can be changed by using the following commands
4425 IPv4 MPLSoGRE outer header::
4427 testpmd> set mplsogre_decap ip-version ipv4
4428 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4429 mplsogre_decap / l2_encap / end
4431 IPv4 MPLSoGRE with VLAN outer header::
4433 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4434 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4435 actions mplsogre_decap / l2_encap / end
4437 IPv6 MPLSoGRE outer header::
4439 testpmd> set mplsogre_decap ip-version ipv6
4440 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4441 actions mplsogre_decap / l2_encap / end
4443 IPv6 MPLSoGRE with VLAN outer header::
4445 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4446 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4447 actions mplsogre_decap / l2_encap / end
4449 Sample MPLSoUDP encapsulation rule
4450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4452 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4453 source code, those can be changed by using the following commands
4455 IPv4 MPLSoUDP outer header::
4457 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4458 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4459 eth-dst 22:22:22:22:22:22
4460 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4461 mplsoudp_encap / end
4463 IPv4 MPLSoUDP with VLAN outer header::
4465 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4466 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4467 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4468 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4469 mplsoudp_encap / end
4471 IPv6 MPLSoUDP outer header::
4473 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4474 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4475 eth-dst 22:22:22:22:22:22
4476 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4477 mplsoudp_encap / end
4479 IPv6 MPLSoUDP with VLAN outer header::
4481 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4482 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4483 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4484 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4485 mplsoudp_encap / end
4487 Sample MPLSoUDP decapsulation rule
4488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4490 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4491 source code, those can be changed by using the following commands
4493 IPv4 MPLSoUDP outer header::
4495 testpmd> set mplsoudp_decap ip-version ipv4
4496 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4497 mplsoudp_decap / l2_encap / end
4499 IPv4 MPLSoUDP with VLAN outer header::
4501 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4502 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4503 actions mplsoudp_decap / l2_encap / end
4505 IPv6 MPLSoUDP outer header::
4507 testpmd> set mplsoudp_decap ip-version ipv6
4508 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4509 actions mplsoudp_decap / l2_encap / end
4511 IPv6 MPLSoUDP with VLAN outer header::
4513 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4514 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4515 actions mplsoudp_decap / l2_encap / end
4520 The following sections show functions to load/unload eBPF based filters.
4525 Load an eBPF program as a callback for partciular RX/TX queue::
4527 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4529 The available load-flags are:
4531 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4533 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4539 You'll need clang v3.7 or above to build bpf program you'd like to load
4543 .. code-block:: console
4546 clang -O2 -target bpf -c t1.c
4548 Then to load (and JIT compile) t1.o at RX queue 0, port 1::
4550 .. code-block:: console
4552 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4554 To load (not JITed) t1.o at TX queue 0, port 0::
4556 .. code-block:: console
4558 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4563 Unload previously loaded eBPF program for partciular RX/TX queue::
4565 testpmd> bpf-unload rx|tx (portid) (queueid)
4567 For example to unload BPF filter from TX queue 0, port 0:
4569 .. code-block:: console
4571 testpmd> bpf-unload tx 0 0