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 behavior 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 neighbor 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
473 Show general information about devices probed::
475 testpmd> show device info (<identifier>|all)
479 .. code-block:: console
481 testpmd> show device info net_pcap0
483 ********************* Infos for device net_pcap0 *********************
485 Driver name: net_pcap
486 Devargs: iface=enP2p6s0,phy_mac=1
487 Connect to socket: -1
490 MAC address: 1E:37:93:28:04:B8
491 Device name: net_pcap0
496 Dumps all physical memory segment layouts::
498 testpmd> dump_physmem
503 Dumps the layout of all memory zones::
505 testpmd> dump_memzone
511 Dumps the size of all memory structures::
513 testpmd> dump_struct_sizes
518 Dumps the status of all or specific element in DPDK rings::
520 testpmd> dump_ring [ring_name]
525 Dumps the statistics of all or specific memory pool::
527 testpmd> dump_mempool [mempool_name]
532 Dumps the user device list::
534 testpmd> dump_devargs
539 Dumps the log level for all the dpdk modules::
541 testpmd> dump_log_types
543 Configuration Functions
544 -----------------------
546 The testpmd application can be configured from the runtime as well as from the command-line.
548 This section details the available configuration functions that are available.
552 Configuration changes only become active when forwarding is started/restarted.
557 Reset forwarding to the default configuration::
564 Set the debug verbosity level::
566 testpmd> set verbose (level)
568 Available levels are as following:
570 * ``0`` silent except for error.
571 * ``1`` fully verbose except for Tx packets.
572 * ``2`` fully verbose except for Rx packets.
573 * ``> 2`` fully verbose.
578 Set the log level for a log type::
580 testpmd> set log global|(type) (level)
584 * ``type`` is the log name.
586 * ``level`` is the log level.
588 For example, to change the global log level::
590 testpmd> set log global (level)
592 Regexes can also be used for type. To change log level of user1, user2 and user3::
594 testpmd> set log user[1-3] (level)
599 Set the number of ports used by the application:
603 This is equivalent to the ``--nb-ports`` command-line option.
608 Set the number of cores used by the application::
610 testpmd> set nbcore (num)
612 This is equivalent to the ``--nb-cores`` command-line option.
616 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
621 Set the forwarding cores hexadecimal mask::
623 testpmd> set coremask (mask)
625 This is equivalent to the ``--coremask`` command-line option.
629 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
634 Set the forwarding ports hexadecimal mask::
636 testpmd> set portmask (mask)
638 This is equivalent to the ``--portmask`` command-line option.
643 Set number of packets per burst::
645 testpmd> set burst (num)
647 This is equivalent to the ``--burst command-line`` option.
649 When retry is enabled, the transmit delay time and number of retries can also be set::
651 testpmd> set burst tx delay (microseconds) retry (num)
656 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
658 testpmd> set txpkts (x[,y]*)
660 Where x[,y]* represents a CSV list of values, without white space.
665 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
667 testpmd> set txsplit (off|on|rand)
671 * ``off`` disable packet copy & split for CSUM mode.
673 * ``on`` split outgoing packet into multiple segments. Size of each segment
674 and number of segments per packet is determined by ``set txpkts`` command
677 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
682 Set the list of forwarding cores::
684 testpmd> set corelist (x[,y]*)
686 For example, to change the forwarding cores:
688 .. code-block:: console
690 testpmd> set corelist 3,1
691 testpmd> show config fwd
693 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
694 Logical Core 3 (socket 0) forwards packets on 1 streams:
695 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
696 Logical Core 1 (socket 0) forwards packets on 1 streams:
697 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
701 The cores are used in the same order as specified on the command line.
706 Set the list of forwarding ports::
708 testpmd> set portlist (x[,y]*)
710 For example, to change the port forwarding:
712 .. code-block:: console
714 testpmd> set portlist 0,2,1,3
715 testpmd> show config fwd
717 io packet forwarding - ports=4 - cores=1 - streams=4
718 Logical Core 3 (socket 0) forwards packets on 4 streams:
719 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
720 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
721 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
722 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
727 Select how to retrieve new ports created after "port attach" command::
729 testpmd> set port setup on (iterator|event)
731 For each new port, a setup is done.
732 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
733 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
738 Enable/disable tx loopback::
740 testpmd> set tx loopback (port_id) (on|off)
745 set drop enable bit for all queues::
747 testpmd> set all queues drop (port_id) (on|off)
749 set split drop enable (for VF)
750 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
752 set split drop enable bit for VF from PF::
754 testpmd> set vf split drop (port_id) (vf_id) (on|off)
756 set mac antispoof (for VF)
757 ~~~~~~~~~~~~~~~~~~~~~~~~~~
759 Set mac antispoof for a VF from the PF::
761 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
766 Enable/disable MACsec offload::
768 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
769 testpmd> set macsec offload (port_id) off
774 Configure MACsec secure connection (SC)::
776 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
780 The pi argument is ignored for tx.
781 Check the NIC Datasheet for hardware limits.
786 Configure MACsec secure association (SA)::
788 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
792 The IDX value must be 0 or 1.
793 Check the NIC Datasheet for hardware limits.
795 set broadcast mode (for VF)
796 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
798 Set broadcast mode for a VF from the PF::
800 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
805 Set the VLAN strip on a port::
807 testpmd> vlan set strip (on|off) (port_id)
812 Set the VLAN strip for a queue on a port::
814 testpmd> vlan set stripq (on|off) (port_id,queue_id)
816 vlan set stripq (for VF)
817 ~~~~~~~~~~~~~~~~~~~~~~~~
819 Set VLAN strip for all queues in a pool for a VF from the PF::
821 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
823 vlan set insert (for VF)
824 ~~~~~~~~~~~~~~~~~~~~~~~~
826 Set VLAN insert for a VF from the PF::
828 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
830 vlan set tag (for VF)
831 ~~~~~~~~~~~~~~~~~~~~~
833 Set VLAN tag for a VF from the PF::
835 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
837 vlan set antispoof (for VF)
838 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
840 Set VLAN antispoof for a VF from the PF::
842 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
847 Set the VLAN filter on a port::
849 testpmd> vlan set filter (on|off) (port_id)
854 Set the VLAN QinQ (extended queue in queue) on for a port::
856 testpmd> vlan set qinq (on|off) (port_id)
861 Set the inner or outer VLAN TPID for packet filtering on a port::
863 testpmd> vlan set (inner|outer) tpid (value) (port_id)
867 TPID value must be a 16-bit number (value <= 65536).
872 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
874 testpmd> rx_vlan add (vlan_id|all) (port_id)
878 VLAN filter must be set on that port. VLAN ID < 4096.
879 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
880 in VFTA table. This is important if enabling all vlan_ids.
885 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
887 testpmd> rx_vlan rm (vlan_id|all) (port_id)
892 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
894 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
899 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
901 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
906 Add a tunnel filter on a port::
908 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
909 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
910 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
912 The available information categories are:
914 * ``vxlan``: Set tunnel type as VXLAN.
916 * ``nvgre``: Set tunnel type as NVGRE.
918 * ``ipingre``: Set tunnel type as IP-in-GRE.
920 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
922 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
924 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
926 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
928 * ``imac``: Set filter type as Inner MAC.
930 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
932 * ``oip``: Set filter type as Outer IP.
934 * ``iip``: Set filter type as Inner IP.
938 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
939 192.168.2.2 0 ipingre oip 1 1
941 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
946 Remove a tunnel filter on a port::
948 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
949 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
950 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
955 Add an UDP port for VXLAN packet filter on a port::
957 testpmd> rx_vxlan_port add (udp_port) (port_id)
962 Remove an UDP port for VXLAN packet filter on a port::
964 testpmd> rx_vxlan_port rm (udp_port) (port_id)
969 Set hardware insertion of VLAN IDs in packets sent on a port::
971 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
973 For example, set a single VLAN ID (5) insertion on port 0::
977 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
985 Set port based hardware insertion of VLAN ID in packets sent on a port::
987 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
992 Disable hardware insertion of a VLAN header in packets sent on a port::
994 testpmd> tx_vlan reset (port_id)
999 Select hardware or software calculation of the checksum when
1000 transmitting a packet using the ``csum`` forwarding engine::
1002 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1006 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1008 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1009 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1010 supported). See also the ``csum parse-tunnel`` command.
1012 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1013 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1014 supported). See also the ``csum parse-tunnel`` command.
1018 Check the NIC Datasheet for hardware limits.
1023 Set RSS queue region span on a port::
1025 testpmd> set port (port_id) queue-region region_id (value) \
1026 queue_start_index (value) queue_num (value)
1028 Set flowtype mapping on a RSS queue region on a port::
1030 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1034 * For the flowtype(pctype) of packet,the specific index for each type has
1035 been defined in file i40e_type.h as enum i40e_filter_pctype.
1037 Set user priority mapping on a RSS queue region on a port::
1039 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1041 Flush all queue region related configuration on a port::
1043 testpmd> set port (port_id) queue-region flush (on|off)
1047 * ``on``: is just an enable function which server for other configuration,
1048 it is for all configuration about queue region from up layer,
1049 at first will only keep in DPDK software stored in driver,
1050 only after "flush on", it commit all configuration to HW.
1052 * ``"off``: is just clean all configuration about queue region just now,
1053 and restore all to DPDK i40e driver default config when start up.
1055 Show all queue region related configuration info on a port::
1057 testpmd> show port (port_id) queue-region
1061 Queue region only support on PF by now, so these command is
1062 only for configuration of queue region on PF port.
1067 Define how tunneled packets should be handled by the csum forward
1070 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1072 If enabled, the csum forward engine will try to recognize supported
1073 tunnel headers (vxlan, gre, ipip).
1075 If disabled, treat tunnel packets as non-tunneled packets (a inner
1076 header is handled as a packet payload).
1080 The port argument is the TX port like in the ``csum set`` command.
1084 Consider a packet in packet like the following::
1086 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1088 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1089 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1090 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1092 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1093 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1098 Display tx checksum offload configuration::
1100 testpmd> csum show (port_id)
1105 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1107 testpmd> tso set (segsize) (port_id)
1111 Check the NIC datasheet for hardware limits.
1116 Display the status of TCP Segmentation Offload::
1118 testpmd> tso show (port_id)
1123 Set tso segment size of tunneled packets for a port in csum engine::
1125 testpmd> tunnel_tso set (tso_segsz) (port_id)
1130 Display the status of tunneled TCP Segmentation Offload for a port::
1132 testpmd> tunnel_tso show (port_id)
1137 Enable or disable GRO in ``csum`` forwarding engine::
1139 testpmd> set port <port_id> gro on|off
1141 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1142 packets received from the given port.
1144 If disabled, packets received from the given port won't be performed
1145 GRO. By default, GRO is disabled for all ports.
1149 When enable GRO for a port, TCP/IPv4 packets received from the port
1150 will be performed GRO. After GRO, all merged packets have bad
1151 checksums, since the GRO library doesn't re-calculate checksums for
1152 the merged packets. Therefore, if users want the merged packets to
1153 have correct checksums, please select HW IP checksum calculation and
1154 HW TCP checksum calculation for the port which the merged packets are
1160 Display GRO configuration for a given port::
1162 testpmd> show port <port_id> gro
1167 Set the cycle to flush the GROed packets from reassembly tables::
1169 testpmd> set gro flush <cycles>
1171 When enable GRO, the csum forwarding engine performs GRO on received
1172 packets, and the GROed packets are stored in reassembly tables. Users
1173 can use this command to determine when the GROed packets are flushed
1174 from the reassembly tables.
1176 The ``cycles`` is measured in GRO operation times. The csum forwarding
1177 engine flushes the GROed packets from the tables every ``cycles`` GRO
1180 By default, the value of ``cycles`` is 1, which means flush GROed packets
1181 from the reassembly tables as soon as one GRO operation finishes. The value
1182 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1184 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1185 stack performance. Because the GROed packets are delayed to arrive the
1186 stack, thus causing more duplicated ACKs and TCP retransmissions.
1191 Toggle per-port GSO support in ``csum`` forwarding engine::
1193 testpmd> set port <port_id> gso on|off
1195 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1196 packets, transmitted on the given port.
1198 If disabled, packets transmitted on the given port will not undergo GSO.
1199 By default, GSO is disabled for all ports.
1203 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1204 port undergo GSO. Afterwards, the segmented packets are represented by
1205 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1206 of checksums for GSO'd segments in SW. As a result, if users want correct
1207 checksums in GSO segments, they should enable HW checksum calculation for
1210 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1211 by setting the following options in the csum forwarding engine:
1213 testpmd> csum set outer_ip hw <port_id>
1215 testpmd> csum set ip hw <port_id>
1217 testpmd> csum set tcp hw <port_id>
1219 UDP GSO is the same as IP fragmentation, which treats the UDP header
1220 as the payload and does not modify it during segmentation. That is,
1221 after UDP GSO, only the first output fragment has the original UDP
1222 header. Therefore, users need to enable HW IP checksum calculation
1223 and SW UDP checksum calculation for GSO-enabled ports, if they want
1224 correct checksums for UDP/IPv4 packets.
1229 Set the maximum GSO segment size (measured in bytes), which includes the
1230 packet header and the packet payload for GSO-enabled ports (global)::
1232 testpmd> set gso segsz <length>
1237 Display the status of Generic Segmentation Offload for a given port::
1239 testpmd> show port <port_id> gso
1244 Add an alternative MAC address to a port::
1246 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1251 Remove a MAC address from a port::
1253 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1258 To add the multicast MAC address to/from the set of multicast addresses
1261 testpmd> mcast_addr add (port_id) (mcast_addr)
1266 To remove the multicast MAC address to/from the set of multicast addresses
1269 testpmd> mcast_addr remove (port_id) (mcast_addr)
1271 mac_addr add (for VF)
1272 ~~~~~~~~~~~~~~~~~~~~~
1274 Add an alternative MAC address for a VF to a port::
1276 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1281 Set the default MAC address for a port::
1283 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1285 mac_addr set (for VF)
1286 ~~~~~~~~~~~~~~~~~~~~~
1288 Set the MAC address for a VF from the PF::
1290 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1295 Set the forwarding peer address for certain port::
1297 testpmd> set eth-peer (port_id) (peer_addr)
1299 This is equivalent to the ``--eth-peer`` command-line option.
1304 Set the unicast hash filter(s) on/off for a port::
1306 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1311 Set the promiscuous mode on for a port or for all ports.
1312 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1314 testpmd> set promisc (port_id|all) (on|off)
1319 Set the allmulti mode for a port or for all ports::
1321 testpmd> set allmulti (port_id|all) (on|off)
1323 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1325 set promisc (for VF)
1326 ~~~~~~~~~~~~~~~~~~~~
1328 Set the unicast promiscuous mode for a VF from PF.
1329 It's supported by Intel i40e NICs now.
1330 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1332 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1334 set allmulticast (for VF)
1335 ~~~~~~~~~~~~~~~~~~~~~~~~~
1337 Set the multicast promiscuous mode for a VF from PF.
1338 It's supported by Intel i40e NICs now.
1339 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1341 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1343 set tx max bandwidth (for VF)
1344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1346 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1348 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1350 set tc tx min bandwidth (for VF)
1351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1353 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1355 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1357 set tc tx max bandwidth (for VF)
1358 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1360 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1362 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1364 set tc strict link priority mode
1365 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1367 Set some TCs' strict link priority mode on a physical port::
1369 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1371 set tc tx min bandwidth
1372 ~~~~~~~~~~~~~~~~~~~~~~~
1374 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1376 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1381 Set the link flow control parameter on a port::
1383 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1384 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1385 autoneg (on|off) (port_id)
1389 * ``high_water`` (integer): High threshold value to trigger XOFF.
1391 * ``low_water`` (integer): Low threshold value to trigger XON.
1393 * ``pause_time`` (integer): Pause quota in the Pause frame.
1395 * ``send_xon`` (0/1): Send XON frame.
1397 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1399 * ``autoneg``: Change the auto-negotiation parameter.
1404 Set the priority flow control parameter on a port::
1406 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1407 (pause_time) (priority) (port_id)
1411 * ``high_water`` (integer): High threshold value.
1413 * ``low_water`` (integer): Low threshold value.
1415 * ``pause_time`` (integer): Pause quota in the Pause frame.
1417 * ``priority`` (0-7): VLAN User Priority.
1422 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1424 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1426 For example, to set rx queue 2 on port 0 to mapping 5::
1428 testpmd>set stat_qmap rx 0 2 5
1430 set xstats-hide-zero
1431 ~~~~~~~~~~~~~~~~~~~~
1433 Set the option to hide zero values for xstats display::
1435 testpmd> set xstats-hide-zero on|off
1439 By default, the zero values are displayed for xstats.
1441 set port - rx/tx (for VF)
1442 ~~~~~~~~~~~~~~~~~~~~~~~~~
1444 Set VF receive/transmit from a port::
1446 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1448 set port - mac address filter (for VF)
1449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1451 Add/Remove unicast or multicast MAC addr filter for a VF::
1453 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1454 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1456 set port - rx mode(for VF)
1457 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1459 Set the VF receive mode of a port::
1461 testpmd> set port (port_id) vf (vf_id) \
1462 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1464 The available receive modes are:
1466 * ``AUPE``: Accepts untagged VLAN.
1468 * ``ROPE``: Accepts unicast hash.
1470 * ``BAM``: Accepts broadcast packets.
1472 * ``MPE``: Accepts all multicast packets.
1474 set port - tx_rate (for Queue)
1475 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1477 Set TX rate limitation for a queue on a port::
1479 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1481 set port - tx_rate (for VF)
1482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1484 Set TX rate limitation for queues in VF on a port::
1486 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1488 set port - mirror rule
1489 ~~~~~~~~~~~~~~~~~~~~~~
1491 Set pool or vlan type mirror rule for a port::
1493 testpmd> set port (port_id) mirror-rule (rule_id) \
1494 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1495 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1497 Set link mirror rule for a port::
1499 testpmd> set port (port_id) mirror-rule (rule_id) \
1500 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1502 For example to enable mirror traffic with vlan 0,1 to pool 0::
1504 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1506 reset port - mirror rule
1507 ~~~~~~~~~~~~~~~~~~~~~~~~
1509 Reset a mirror rule for a port::
1511 testpmd> reset port (port_id) mirror-rule (rule_id)
1516 Set the flush on RX streams before forwarding.
1517 The default is flush ``on``.
1518 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1520 testpmd> set flush_rx off
1525 Set the bypass mode for the lowest port on bypass enabled NIC::
1527 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1532 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1534 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1535 mode (normal|bypass|isolate) (port_id)
1539 * ``timeout``: Enable bypass after watchdog timeout.
1541 * ``os_on``: Enable bypass when OS/board is powered on.
1543 * ``os_off``: Enable bypass when OS/board is powered off.
1545 * ``power_on``: Enable bypass when power supply is turned on.
1547 * ``power_off``: Enable bypass when power supply is turned off.
1553 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1555 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1560 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1562 testpmd> show bypass config (port_id)
1567 Set link up for a port::
1569 testpmd> set link-up port (port id)
1574 Set link down for a port::
1576 testpmd> set link-down port (port id)
1581 Enable E-tag insertion for a VF on a port::
1583 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1585 Disable E-tag insertion for a VF on a port::
1587 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1589 Enable/disable E-tag stripping on a port::
1591 testpmd> E-tag set stripping (on|off) port (port_id)
1593 Enable/disable E-tag based forwarding on a port::
1595 testpmd> E-tag set forwarding (on|off) port (port_id)
1597 Add an E-tag forwarding filter on a port::
1599 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1601 Delete an E-tag forwarding filter on a port::
1602 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1607 Load a dynamic device personalization (DDP) profile and store backup profile::
1609 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1614 Delete a dynamic device personalization profile and restore backup profile::
1616 testpmd> ddp del (port_id) (backup_profile_path)
1621 List all items from the ptype mapping table::
1623 testpmd> ptype mapping get (port_id) (valid_only)
1627 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1629 Replace a specific or a group of software defined ptype with a new one::
1631 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1635 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1637 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1639 * ``pkt_type``: The new software ptype to replace the old ones.
1641 Update hardware defined ptype to software defined packet type mapping table::
1643 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1647 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1649 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1651 Reset ptype mapping table::
1653 testpmd> ptype mapping reset (port_id)
1655 config per port Rx offloading
1656 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1658 Enable or disable a per port Rx offloading on all Rx queues of a port::
1660 testpmd> port config (port_id) rx_offload (offloading) on|off
1662 * ``offloading``: can be any of these offloading capability:
1663 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1664 qinq_strip, outer_ipv4_cksum, macsec_strip,
1665 header_split, vlan_filter, vlan_extend, jumbo_frame,
1666 crc_strip, scatter, timestamp, security, keep_crc
1668 This command should be run when the port is stopped, or else it will fail.
1670 config per queue Rx offloading
1671 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1673 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1675 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1677 * ``offloading``: can be any of these offloading capability:
1678 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1679 qinq_strip, outer_ipv4_cksum, macsec_strip,
1680 header_split, vlan_filter, vlan_extend, jumbo_frame,
1681 crc_strip, scatter, timestamp, security, keep_crc
1683 This command should be run when the port is stopped, or else it will fail.
1685 config per port Tx offloading
1686 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1688 Enable or disable a per port Tx offloading on all Tx queues of a port::
1690 testpmd> port config (port_id) tx_offload (offloading) on|off
1692 * ``offloading``: can be any of these offloading capability:
1693 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1694 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1695 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1696 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1697 mt_lockfree, multi_segs, mbuf_fast_free, security,
1700 This command should be run when the port is stopped, or else it will fail.
1702 config per queue Tx offloading
1703 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1705 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1707 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1709 * ``offloading``: can be any of these offloading capability:
1710 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1711 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1712 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1713 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1714 mt_lockfree, multi_segs, mbuf_fast_free, security
1716 This command should be run when the port is stopped, or else it will fail.
1718 Config VXLAN Encap outer layers
1719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1721 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1723 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1724 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1727 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1728 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1729 eth-src (eth-src) eth-dst (eth-dst)
1731 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1732 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1733 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1735 These commands will set an internal configuration inside testpmd, any following
1736 flow rule using the action vxlan_encap will use the last configuration set.
1737 To have a different encapsulation header, one of those commands must be called
1738 before the flow rule creation.
1740 Config NVGRE Encap outer layers
1741 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1743 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1745 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1746 eth-src (eth-src) eth-dst (eth-dst)
1747 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1748 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1750 These commands will set an internal configuration inside testpmd, any following
1751 flow rule using the action nvgre_encap will use the last configuration set.
1752 To have a different encapsulation header, one of those commands must be called
1753 before the flow rule creation.
1758 Configure the l2 to be used when encapsulating a packet with L2::
1760 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1761 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1762 eth-src (eth-src) eth-dst (eth-dst)
1764 Those commands will set an internal configuration inside testpmd, any following
1765 flow rule using the action l2_encap will use the last configuration set.
1766 To have a different encapsulation header, one of those commands must be called
1767 before the flow rule creation.
1772 Configure the l2 to be removed when decapsulating a packet with L2::
1774 set l2_decap ip-version (ipv4|ipv6)
1775 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1777 Those commands will set an internal configuration inside testpmd, any following
1778 flow rule using the action l2_decap will use the last configuration set.
1779 To have a different encapsulation header, one of those commands must be called
1780 before the flow rule creation.
1782 Config MPLSoGRE Encap outer layers
1783 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1785 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1787 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1788 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1789 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1790 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1791 eth-src (eth-src) eth-dst (eth-dst)
1793 These commands will set an internal configuration inside testpmd, any following
1794 flow rule using the action mplsogre_encap will use the last configuration set.
1795 To have a different encapsulation header, one of those commands must be called
1796 before the flow rule creation.
1798 Config MPLSoGRE Decap outer layers
1799 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1801 Configure the outer layer to decapsulate MPLSoGRE packet::
1803 set mplsogre_decap ip-version (ipv4|ipv6)
1804 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1806 These commands will set an internal configuration inside testpmd, any following
1807 flow rule using the action mplsogre_decap will use the last configuration set.
1808 To have a different decapsulation header, one of those commands must be called
1809 before the flow rule creation.
1811 Config MPLSoUDP Encap outer layers
1812 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1814 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1816 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1817 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1818 eth-src (eth-src) eth-dst (eth-dst)
1819 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1820 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1821 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1823 These commands will set an internal configuration inside testpmd, any following
1824 flow rule using the action mplsoudp_encap will use the last configuration set.
1825 To have a different encapsulation header, one of those commands must be called
1826 before the flow rule creation.
1828 Config MPLSoUDP Decap outer layers
1829 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1831 Configure the outer layer to decapsulate MPLSoUDP packet::
1833 set mplsoudp_decap ip-version (ipv4|ipv6)
1834 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1836 These commands will set an internal configuration inside testpmd, any following
1837 flow rule using the action mplsoudp_decap will use the last configuration set.
1838 To have a different decapsulation header, one of those commands must be called
1839 before the flow rule creation.
1841 Config Raw Encapsulation
1842 ~~~~~~~~~~~~~~~~~~~~~~~~~
1844 Configure the raw data to be used when encapsulating a packet by
1845 rte_flow_action_raw_encap::
1847 set raw_encap {item} [/ {item} [...]] / end_set
1849 This command will set an internal buffer inside testpmd, any following flow rule
1850 using the action raw_encap will use the last configuration set.
1851 To have a different encapsulation header, this command must be called before the
1854 Config Raw Decapsulation
1855 ~~~~~~~~~~~~~~~~~~~~~~~~
1857 Configure the raw data to be used when decapsulating a packet by
1858 rte_flow_action_raw_decap::
1860 set raw_decap {item} [/ {item} [...]] / end_set
1862 This command will set an internal buffer inside testpmd, any following flow rule
1863 using the action raw_decap will use the last configuration set.
1868 The following sections show functions for configuring ports.
1872 Port configuration changes only become active when forwarding is started/restarted.
1877 Attach a port specified by pci address or virtual device args::
1879 testpmd> port attach (identifier)
1881 To attach a new pci device, the device should be recognized by kernel first.
1882 Then it should be moved under DPDK management.
1883 Finally the port can be attached to testpmd.
1885 For example, to move a pci device using ixgbe under DPDK management:
1887 .. code-block:: console
1889 # Check the status of the available devices.
1890 ./usertools/dpdk-devbind.py --status
1892 Network devices using DPDK-compatible driver
1893 ============================================
1896 Network devices using kernel driver
1897 ===================================
1898 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1901 # Bind the device to igb_uio.
1902 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1905 # Recheck the status of the devices.
1906 ./usertools/dpdk-devbind.py --status
1907 Network devices using DPDK-compatible driver
1908 ============================================
1909 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1911 To attach a port created by virtual device, above steps are not needed.
1913 For example, to attach a port whose pci address is 0000:0a:00.0.
1915 .. code-block:: console
1917 testpmd> port attach 0000:0a:00.0
1918 Attaching a new port...
1919 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1920 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1921 EAL: PCI memory mapped at 0x7f83bfa00000
1922 EAL: PCI memory mapped at 0x7f83bfa80000
1923 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1924 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1925 Port 0 is attached. Now total ports is 1
1928 For example, to attach a port created by pcap PMD.
1930 .. code-block:: console
1932 testpmd> port attach net_pcap0
1933 Attaching a new port...
1934 PMD: Initializing pmd_pcap for net_pcap0
1935 PMD: Creating pcap-backed ethdev on numa socket 0
1936 Port 0 is attached. Now total ports is 1
1939 In this case, identifier is ``net_pcap0``.
1940 This identifier format is the same as ``--vdev`` format of DPDK applications.
1942 For example, to re-attach a bonded port which has been previously detached,
1943 the mode and slave parameters must be given.
1945 .. code-block:: console
1947 testpmd> port attach net_bond_0,mode=0,slave=1
1948 Attaching a new port...
1949 EAL: Initializing pmd_bond for net_bond_0
1950 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1951 Port 0 is attached. Now total ports is 1
1958 Detach a specific port::
1960 testpmd> port detach (port_id)
1962 Before detaching a port, the port should be stopped and closed.
1964 For example, to detach a pci device port 0.
1966 .. code-block:: console
1968 testpmd> port stop 0
1971 testpmd> port close 0
1975 testpmd> port detach 0
1977 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1978 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1979 EAL: PCI memory unmapped at 0x7f83bfa00000
1980 EAL: PCI memory unmapped at 0x7f83bfa80000
1984 For example, to detach a virtual device port 0.
1986 .. code-block:: console
1988 testpmd> port stop 0
1991 testpmd> port close 0
1995 testpmd> port detach 0
1997 PMD: Closing pcap ethdev on numa socket 0
1998 Port 'net_pcap0' is detached. Now total ports is 0
2001 To remove a pci device completely from the system, first detach the port from testpmd.
2002 Then the device should be moved under kernel management.
2003 Finally the device can be removed using kernel pci hotplug functionality.
2005 For example, to move a pci device under kernel management:
2007 .. code-block:: console
2009 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2011 ./usertools/dpdk-devbind.py --status
2013 Network devices using DPDK-compatible driver
2014 ============================================
2017 Network devices using kernel driver
2018 ===================================
2019 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2021 To remove a port created by a virtual device, above steps are not needed.
2026 Start all ports or a specific port::
2028 testpmd> port start (port_id|all)
2033 Stop all ports or a specific port::
2035 testpmd> port stop (port_id|all)
2040 Close all ports or a specific port::
2042 testpmd> port close (port_id|all)
2044 port config - queue ring size
2045 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2047 Configure a rx/tx queue ring size::
2049 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2051 Only take effect after command that (re-)start the port or command that setup specific queue.
2053 port start/stop queue
2054 ~~~~~~~~~~~~~~~~~~~~~
2056 Start/stop a rx/tx queue on a specific port::
2058 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2060 port config - queue deferred start
2061 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2063 Switch on/off deferred start of a specific port queue::
2065 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2068 ~~~~~~~~~~~~~~~~~~~~~
2070 Setup a rx/tx queue on a specific port::
2072 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2074 Only take effect when port is started.
2079 Set the speed and duplex mode for all ports or a specific port::
2081 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2082 duplex (half|full|auto)
2084 port config - queues/descriptors
2085 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2087 Set number of queues/descriptors for rxq, txq, rxd and txd::
2089 testpmd> port config all (rxq|txq|rxd|txd) (value)
2091 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2093 port config - max-pkt-len
2094 ~~~~~~~~~~~~~~~~~~~~~~~~~
2096 Set the maximum packet length::
2098 testpmd> port config all max-pkt-len (value)
2100 This is equivalent to the ``--max-pkt-len`` command-line option.
2102 port config - CRC Strip
2103 ~~~~~~~~~~~~~~~~~~~~~~~
2105 Set hardware CRC stripping on or off for all ports::
2107 testpmd> port config all crc-strip (on|off)
2109 CRC stripping is on by default.
2111 The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option.
2113 port config - scatter
2114 ~~~~~~~~~~~~~~~~~~~~~~~
2116 Set RX scatter mode on or off for all ports::
2118 testpmd> port config all scatter (on|off)
2120 RX scatter mode is off by default.
2122 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
2124 port config - RX Checksum
2125 ~~~~~~~~~~~~~~~~~~~~~~~~~
2127 Set hardware RX checksum offload to on or off for all ports::
2129 testpmd> port config all rx-cksum (on|off)
2131 Checksum offload is off by default.
2133 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
2138 Set hardware VLAN on or off for all ports::
2140 testpmd> port config all hw-vlan (on|off)
2142 Hardware VLAN is off by default.
2144 The ``on`` option is equivalent to the ``--enable-hw-vlan`` command-line option.
2146 port config - VLAN filter
2147 ~~~~~~~~~~~~~~~~~~~~~~~~~
2149 Set hardware VLAN filter on or off for all ports::
2151 testpmd> port config all hw-vlan-filter (on|off)
2153 Hardware VLAN filter is off by default.
2155 The ``on`` option is equivalent to the ``--enable-hw-vlan-filter`` command-line option.
2157 port config - VLAN strip
2158 ~~~~~~~~~~~~~~~~~~~~~~~~
2160 Set hardware VLAN strip on or off for all ports::
2162 testpmd> port config all hw-vlan-strip (on|off)
2164 Hardware VLAN strip is off by default.
2166 The ``on`` option is equivalent to the ``--enable-hw-vlan-strip`` command-line option.
2168 port config - VLAN extend
2169 ~~~~~~~~~~~~~~~~~~~~~~~~~
2171 Set hardware VLAN extend on or off for all ports::
2173 testpmd> port config all hw-vlan-extend (on|off)
2175 Hardware VLAN extend is off by default.
2177 The ``on`` option is equivalent to the ``--enable-hw-vlan-extend`` command-line option.
2179 port config - Drop Packets
2180 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2182 Set packet drop for packets with no descriptors on or off for all ports::
2184 testpmd> port config all drop-en (on|off)
2186 Packet dropping for packets with no descriptors is off by default.
2188 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2193 Set the RSS (Receive Side Scaling) mode on or off::
2195 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2197 RSS is on by default.
2199 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2200 The ``default`` option enables all supported RSS types reported by device info.
2201 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2203 port config - RSS Reta
2204 ~~~~~~~~~~~~~~~~~~~~~~
2206 Set the RSS (Receive Side Scaling) redirection table::
2208 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2213 Set the DCB mode for an individual port::
2215 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2217 The traffic class should be 4 or 8.
2222 Set the number of packets per burst::
2224 testpmd> port config all burst (value)
2226 This is equivalent to the ``--burst`` command-line option.
2228 port config - Threshold
2229 ~~~~~~~~~~~~~~~~~~~~~~~
2231 Set thresholds for TX/RX queues::
2233 testpmd> port config all (threshold) (value)
2235 Where the threshold type can be:
2237 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2239 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2241 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2243 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2245 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2247 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2249 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2251 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2253 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2255 These threshold options are also available from the command-line.
2260 Set the value of ether-type for E-tag::
2262 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2264 Enable/disable the E-tag support::
2266 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2268 port config pctype mapping
2269 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2271 Reset pctype mapping table::
2273 testpmd> port config (port_id) pctype mapping reset
2275 Update hardware defined pctype to software defined flow type mapping table::
2277 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2281 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2283 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2285 port config input set
2286 ~~~~~~~~~~~~~~~~~~~~~
2288 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2290 testpmd> port config (port_id) pctype (pctype_id) \
2291 (hash_inset|fdir_inset|fdir_flx_inset) \
2292 (get|set|clear) field (field_idx)
2294 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2296 testpmd> port config (port_id) pctype (pctype_id) \
2297 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2301 * ``pctype_id``: hardware packet classification types.
2302 * ``field_idx``: hardware field index.
2304 port config udp_tunnel_port
2305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2307 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2309 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2311 port config tx_metadata
2312 ~~~~~~~~~~~~~~~~~~~~~~~
2314 Set Tx metadata value per port.
2315 testpmd will add this value to any Tx packet sent from this port::
2317 testpmd> port config (port_id) tx_metadata (value)
2322 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2324 testpmd> port config mtu (port_id) (value)
2326 port config rss hash key
2327 ~~~~~~~~~~~~~~~~~~~~~~~~
2329 To configure the RSS hash key used to compute the RSS
2330 hash of input [IP] packets received on port::
2332 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2333 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2334 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2335 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2336 ipv6-udp-ex <string of hex digits \
2337 (variable length, NIC dependent)>)
2342 The following sections show functions for device operations.
2347 Detach a device specified by pci address or virtual device args::
2349 testpmd> device detach (identifier)
2351 Before detaching a device associated with ports, the ports should be stopped and closed.
2353 For example, to detach a pci device whose address is 0002:03:00.0.
2355 .. code-block:: console
2357 testpmd> device detach 0002:03:00.0
2358 Removing a device...
2359 Port 1 is now closed
2360 EAL: Releasing pci mapped resource for 0002:03:00.0
2361 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2362 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2363 Device 0002:03:00.0 is detached
2364 Now total ports is 1
2366 For example, to detach a port created by pcap PMD.
2368 .. code-block:: console
2370 testpmd> device detach net_pcap0
2371 Removing a device...
2372 Port 0 is now closed
2373 Device net_pcap0 is detached
2374 Now total ports is 0
2377 In this case, identifier is ``net_pcap0``.
2378 This identifier format is the same as ``--vdev`` format of DPDK applications.
2380 Link Bonding Functions
2381 ----------------------
2383 The Link Bonding functions make it possible to dynamically create and
2384 manage link bonding devices from within testpmd interactive prompt.
2386 create bonded device
2387 ~~~~~~~~~~~~~~~~~~~~
2389 Create a new bonding device::
2391 testpmd> create bonded device (mode) (socket)
2393 For example, to create a bonded device in mode 1 on socket 0::
2395 testpmd> create bonded device 1 0
2396 created new bonded device (port X)
2401 Adds Ethernet device to a Link Bonding device::
2403 testpmd> add bonding slave (slave id) (port id)
2405 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2407 testpmd> add bonding slave 6 10
2410 remove bonding slave
2411 ~~~~~~~~~~~~~~~~~~~~
2413 Removes an Ethernet slave device from a Link Bonding device::
2415 testpmd> remove bonding slave (slave id) (port id)
2417 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2419 testpmd> remove bonding slave 6 10
2424 Set the Link Bonding mode of a Link Bonding device::
2426 testpmd> set bonding mode (value) (port id)
2428 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2430 testpmd> set bonding mode 3 10
2435 Set an Ethernet slave device as the primary device on a Link Bonding device::
2437 testpmd> set bonding primary (slave id) (port id)
2439 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2441 testpmd> set bonding primary 6 10
2446 Set the MAC address of a Link Bonding device::
2448 testpmd> set bonding mac (port id) (mac)
2450 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2452 testpmd> set bonding mac 10 00:00:00:00:00:01
2454 set bonding xmit_balance_policy
2455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2457 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2459 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2461 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2463 testpmd> set bonding xmit_balance_policy 10 l34
2466 set bonding mon_period
2467 ~~~~~~~~~~~~~~~~~~~~~~
2469 Set the link status monitoring polling period in milliseconds for a bonding device.
2471 This adds support for PMD slave devices which do not support link status interrupts.
2472 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2473 link status ISR will be queried every polling interval to check if their link status has changed::
2475 testpmd> set bonding mon_period (port_id) (value)
2477 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2479 testpmd> set bonding mon_period 5 150
2482 set bonding lacp dedicated_queue
2483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2485 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2486 when in mode 4 (link-aggregation-802.3ad)::
2488 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2491 set bonding agg_mode
2492 ~~~~~~~~~~~~~~~~~~~~
2494 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2496 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2502 Show the current configuration of a Link Bonding device::
2504 testpmd> show bonding config (port id)
2507 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2508 in balance mode with a transmission policy of layer 2+3::
2510 testpmd> show bonding config 9
2512 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2514 Active Slaves (3): [1 3 4]
2521 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2522 This is mainly useful for debugging purposes.
2523 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2524 and fields that can be accessed.
2529 Display the value of a port register::
2531 testpmd> read reg (port_id) (address)
2533 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2535 testpmd> read reg 0 0xEE00
2536 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2541 Display a port register bit field::
2543 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2545 For example, reading the lowest two bits from the register in the example above::
2547 testpmd> read regfield 0 0xEE00 0 1
2548 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2553 Display a single port register bit::
2555 testpmd> read regbit (port_id) (address) (bit_x)
2557 For example, reading the lowest bit from the register in the example above::
2559 testpmd> read regbit 0 0xEE00 0
2560 port 0 PCI register at offset 0xEE00: bit 0=1
2565 Set the value of a port register::
2567 testpmd> write reg (port_id) (address) (value)
2569 For example, to clear a register::
2571 testpmd> write reg 0 0xEE00 0x0
2572 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2577 Set bit field of a port register::
2579 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2581 For example, writing to the register cleared in the example above::
2583 testpmd> write regfield 0 0xEE00 0 1 2
2584 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2589 Set single bit value of a port register::
2591 testpmd> write regbit (port_id) (address) (bit_x) (value)
2593 For example, to set the high bit in the register from the example above::
2595 testpmd> write regbit 0 0xEE00 31 1
2596 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2598 Traffic Metering and Policing
2599 -----------------------------
2601 The following section shows functions for configuring traffic metering and
2602 policing on the ethernet device through the use of generic ethdev API.
2604 show port traffic management capability
2605 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2607 Show traffic metering and policing capability of the port::
2609 testpmd> show port meter cap (port_id)
2611 add port meter profile (srTCM rfc2967)
2612 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2614 Add meter profile (srTCM rfc2697) to the ethernet device::
2616 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2621 * ``profile_id``: ID for the meter profile.
2622 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2623 * ``cbs``: Committed Burst Size (CBS) (bytes).
2624 * ``ebs``: Excess Burst Size (EBS) (bytes).
2626 add port meter profile (trTCM rfc2968)
2627 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2629 Add meter profile (srTCM rfc2698) to the ethernet device::
2631 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2632 (cir) (pir) (cbs) (pbs)
2636 * ``profile_id``: ID for the meter profile.
2637 * ``cir``: Committed information rate (bytes/second).
2638 * ``pir``: Peak information rate (bytes/second).
2639 * ``cbs``: Committed burst size (bytes).
2640 * ``pbs``: Peak burst size (bytes).
2642 add port meter profile (trTCM rfc4115)
2643 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2645 Add meter profile (trTCM rfc4115) to the ethernet device::
2647 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2648 (cir) (eir) (cbs) (ebs)
2652 * ``profile_id``: ID for the meter profile.
2653 * ``cir``: Committed information rate (bytes/second).
2654 * ``eir``: Excess information rate (bytes/second).
2655 * ``cbs``: Committed burst size (bytes).
2656 * ``ebs``: Excess burst size (bytes).
2658 delete port meter profile
2659 ~~~~~~~~~~~~~~~~~~~~~~~~~
2661 Delete meter profile from the ethernet device::
2663 testpmd> del port meter profile (port_id) (profile_id)
2668 Create new meter object for the ethernet device::
2670 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2671 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2672 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2677 * ``mtr_id``: meter object ID.
2678 * ``profile_id``: ID for the meter profile.
2679 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2680 gets enabled at the time of creation, otherwise remains disabled.
2681 * ``g_action``: Policer action for the packet with green color.
2682 * ``y_action``: Policer action for the packet with yellow color.
2683 * ``r_action``: Policer action for the packet with red color.
2684 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2686 * ``shared``: When this parameter has a non-zero value, the meter object is
2687 shared by multiple flows. Otherwise, meter object is used by single flow.
2688 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2689 input color for the current meter object is determined by the latest meter
2690 object in the same flow. Otherwise, the current meter object uses the
2691 *dscp_table* to determine the input color.
2692 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2693 color, 0 <= x <= 63.
2698 Enable meter for the ethernet device::
2700 testpmd> enable port meter (port_id) (mtr_id)
2705 Disable meter for the ethernet device::
2707 testpmd> disable port meter (port_id) (mtr_id)
2712 Delete meter for the ethernet device::
2714 testpmd> del port meter (port_id) (mtr_id)
2716 Set port meter profile
2717 ~~~~~~~~~~~~~~~~~~~~~~
2719 Set meter profile for the ethernet device::
2721 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2723 set port meter dscp table
2724 ~~~~~~~~~~~~~~~~~~~~~~~~~
2726 Set meter dscp table for the ethernet device::
2728 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2729 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2731 set port meter policer action
2732 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2734 Set meter policer action for the ethernet device::
2736 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2737 (action0) [(action1) (action1)]
2741 * ``action_mask``: Bit mask indicating which policer actions need to be
2742 updated. One or more policer actions can be updated in a single function
2743 invocation. To update the policer action associated with color C, bit
2744 (1 << C) needs to be set in *action_mask* and element at position C
2745 in the *actions* array needs to be valid.
2746 * ``actionx``: Policer action for the color x,
2747 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2749 set port meter stats mask
2750 ~~~~~~~~~~~~~~~~~~~~~~~~~
2752 Set meter stats mask for the ethernet device::
2754 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2758 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2760 show port meter stats
2761 ~~~~~~~~~~~~~~~~~~~~~
2763 Show meter stats of the ethernet device::
2765 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2769 * ``clear``: Flag that indicates whether the statistics counters should
2770 be cleared (i.e. set to zero) immediately after they have been read or not.
2775 The following section shows functions for configuring traffic management on
2776 on the ethernet device through the use of generic TM API.
2778 show port traffic management capability
2779 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2781 Show traffic management capability of the port::
2783 testpmd> show port tm cap (port_id)
2785 show port traffic management capability (hierarchy level)
2786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2788 Show traffic management hierarchy level capability of the port::
2790 testpmd> show port tm level cap (port_id) (level_id)
2792 show port traffic management capability (hierarchy node level)
2793 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2795 Show the traffic management hierarchy node capability of the port::
2797 testpmd> show port tm node cap (port_id) (node_id)
2799 show port traffic management hierarchy node type
2800 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2802 Show the port traffic management hierarchy node type::
2804 testpmd> show port tm node type (port_id) (node_id)
2806 show port traffic management hierarchy node stats
2807 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2809 Show the port traffic management hierarchy node statistics::
2811 testpmd> show port tm node stats (port_id) (node_id) (clear)
2815 * ``clear``: When this parameter has a non-zero value, the statistics counters
2816 are cleared (i.e. set to zero) immediately after they have been read,
2817 otherwise the statistics counters are left untouched.
2819 Add port traffic management private shaper profile
2820 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2822 Add the port traffic management private shaper profile::
2824 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2825 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2826 (packet_length_adjust)
2830 * ``shaper_profile id``: Shaper profile ID for the new profile.
2831 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2832 * ``cmit_tb_size``: Committed token bucket size (bytes).
2833 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2834 * ``peak_tb_size``: Peak token bucket size (bytes).
2835 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2836 each packet for the purpose of shaping. This parameter value can be used to
2837 correct the packet length with the framing overhead bytes that are consumed
2840 Delete port traffic management private shaper profile
2841 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2843 Delete the port traffic management private shaper::
2845 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2849 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2851 Add port traffic management shared shaper
2852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2854 Create the port traffic management shared shaper::
2856 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2861 * ``shared_shaper_id``: Shared shaper ID to be created.
2862 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2864 Set port traffic management shared shaper
2865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2867 Update the port traffic management shared shaper::
2869 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2874 * ``shared_shaper_id``: Shared shaper ID to be update.
2875 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2877 Delete port traffic management shared shaper
2878 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2880 Delete the port traffic management shared shaper::
2882 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2886 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2888 Set port traffic management hierarchy node private shaper
2889 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2891 set the port traffic management hierarchy node private shaper::
2893 testpmd> set port tm node shaper profile (port_id) (node_id) \
2898 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2901 Add port traffic management WRED profile
2902 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2904 Create a new WRED profile::
2906 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2907 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2908 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2909 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2913 * ``wred_profile id``: Identifier for the newly create WRED profile
2914 * ``color_g``: Packet color (green)
2915 * ``min_th_g``: Minimum queue threshold for packet with green color
2916 * ``max_th_g``: Minimum queue threshold for packet with green color
2917 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2918 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2919 * ``color_y``: Packet color (yellow)
2920 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2921 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2922 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2923 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2924 * ``color_r``: Packet color (red)
2925 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2926 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2927 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2928 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2930 Delete port traffic management WRED profile
2931 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2933 Delete the WRED profile::
2935 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2937 Add port traffic management hierarchy nonleaf node
2938 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2940 Add nonleaf node to port traffic management hierarchy::
2942 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2943 (priority) (weight) (level_id) (shaper_profile_id) \
2944 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2945 [(shared_shaper_0) (shared_shaper_1) ...] \
2949 * ``parent_node_id``: Node ID of the parent.
2950 * ``priority``: Node priority (highest node priority is zero). This is used by
2951 the SP algorithm running on the parent node for scheduling this node.
2952 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2953 to the weight sum of all siblings that have the same priority. It is used by
2954 the WFQ algorithm running on the parent node for scheduling this node.
2955 * ``level_id``: Hierarchy level of the node.
2956 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2958 * ``n_sp_priorities``: Number of strict priorities.
2959 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2960 * ``n_shared_shapers``: Number of shared shapers.
2961 * ``shared_shaper_id``: Shared shaper id.
2963 Add port traffic management hierarchy leaf node
2964 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2966 Add leaf node to port traffic management hierarchy::
2968 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2969 (priority) (weight) (level_id) (shaper_profile_id) \
2970 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2971 [(shared_shaper_id) (shared_shaper_id) ...] \
2975 * ``parent_node_id``: Node ID of the parent.
2976 * ``priority``: Node priority (highest node priority is zero). This is used by
2977 the SP algorithm running on the parent node for scheduling this node.
2978 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2979 to the weight sum of all siblings that have the same priority. It is used by
2980 the WFQ algorithm running on the parent node for scheduling this node.
2981 * ``level_id``: Hierarchy level of the node.
2982 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2984 * ``cman_mode``: Congestion management mode to be enabled for this node.
2985 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2986 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2987 * ``n_shared_shapers``: Number of shared shapers.
2988 * ``shared_shaper_id``: Shared shaper id.
2990 Delete port traffic management hierarchy node
2991 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2993 Delete node from port traffic management hierarchy::
2995 testpmd> del port tm node (port_id) (node_id)
2997 Update port traffic management hierarchy parent node
2998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3000 Update port traffic management hierarchy parent node::
3002 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3005 This function can only be called after the hierarchy commit invocation. Its
3006 success depends on the port support for this operation, as advertised through
3007 the port capability set. This function is valid for all nodes of the traffic
3008 management hierarchy except root node.
3010 Suspend port traffic management hierarchy node
3011 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3013 testpmd> suspend port tm node (port_id) (node_id)
3015 Resume port traffic management hierarchy node
3016 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3018 testpmd> resume port tm node (port_id) (node_id)
3020 Commit port traffic management hierarchy
3021 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3023 Commit the traffic management hierarchy on the port::
3025 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3029 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3030 call failure. On the other hand, hierarchy is preserved when this parameter
3033 Set port traffic management mark VLAN dei
3034 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3036 Enables/Disables the traffic management marking on the port for VLAN packets::
3038 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3042 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3043 ``yellow`` or ``red`` will have dei bit enabled
3045 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3047 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3049 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3051 Set port traffic management mark IP dscp
3052 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3054 Enables/Disables the traffic management marking on the port for IP dscp packets::
3056 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3060 * ``port_id``: The port which on which IP packets marked as ``green`` or
3061 ``yellow`` or ``red`` will have IP dscp bits updated
3063 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3065 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3067 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3069 Set port traffic management mark IP ecn
3070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3072 Enables/Disables the traffic management marking on the port for IP ecn packets::
3074 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3078 * ``port_id``: The port which on which IP packets marked as ``green`` or
3079 ``yellow`` or ``red`` will have IP ecn bits updated
3081 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3082 to ecn of 2'b11 when IP is caring TCP or SCTP
3084 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3085 to ecn of 2'b11 when IP is caring TCP or SCTP
3087 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3088 to ecn of 2'b11 when IP is caring TCP or SCTP
3090 Set port traffic management default hierarchy (softnic forwarding mode)
3091 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3093 set the traffic management default hierarchy on the port::
3095 testpmd> set port tm hierarchy default (port_id)
3100 This section details the available filter functions that are available.
3102 Note these functions interface the deprecated legacy filtering framework,
3103 superseded by *rte_flow*. See `Flow rules management`_.
3106 ~~~~~~~~~~~~~~~~~~~~
3108 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3110 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3111 ethertype (ether_type) (drop|fwd) queue (queue_id)
3113 The available information parameters are:
3115 * ``port_id``: The port which the Ethertype filter assigned on.
3117 * ``mac_addr``: Compare destination mac address.
3119 * ``mac_ignr``: Ignore destination mac address match.
3121 * ``mac_address``: Destination mac address to match.
3123 * ``ether_type``: The EtherType value want to match,
3124 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3126 * ``queue_id``: The receive queue associated with this EtherType filter.
3127 It is meaningless when deleting or dropping.
3129 Example, to add/remove an ethertype filter rule::
3131 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3132 ethertype 0x0806 fwd queue 3
3134 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3135 ethertype 0x0806 fwd queue 3
3140 Add or delete a 2-tuple filter,
3141 which identifies packets by specific protocol and destination TCP/UDP port
3142 and forwards packets into one of the receive queues::
3144 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3145 protocol (protocol_value) mask (mask_value) \
3146 tcp_flags (tcp_flags_value) priority (prio_value) \
3149 The available information parameters are:
3151 * ``port_id``: The port which the 2-tuple filter assigned on.
3153 * ``dst_port_value``: Destination port in L4.
3155 * ``protocol_value``: IP L4 protocol.
3157 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3159 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3161 * ``prio_value``: Priority of this filter.
3163 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3165 Example, to add/remove an 2tuple filter rule::
3167 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3168 tcp_flags 0x02 priority 3 queue 3
3170 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3171 tcp_flags 0x02 priority 3 queue 3
3176 Add or delete a 5-tuple filter,
3177 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3178 and routes packets into one of the receive queues::
3180 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3181 (src_address) dst_port (dst_port_value) \
3182 src_port (src_port_value) protocol (protocol_value) \
3183 mask (mask_value) tcp_flags (tcp_flags_value) \
3184 priority (prio_value) queue (queue_id)
3186 The available information parameters are:
3188 * ``port_id``: The port which the 5-tuple filter assigned on.
3190 * ``dst_address``: Destination IP address.
3192 * ``src_address``: Source IP address.
3194 * ``dst_port_value``: TCP/UDP destination port.
3196 * ``src_port_value``: TCP/UDP source port.
3198 * ``protocol_value``: L4 protocol.
3200 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3202 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3204 * ``prio_value``: The priority of this filter.
3206 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3208 Example, to add/remove an 5tuple filter rule::
3210 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3211 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3212 flags 0x0 priority 3 queue 3
3214 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3215 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3216 flags 0x0 priority 3 queue 3
3221 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3223 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3225 The available information parameters are:
3227 * ``port_id``: The port which the SYN filter assigned on.
3229 * ``high``: This SYN filter has higher priority than other filters.
3231 * ``low``: This SYN filter has lower priority than other filters.
3233 * ``queue_id``: The receive queue associated with this SYN filter
3237 testpmd> syn_filter 0 add priority high queue 3
3242 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3243 and routed into one of the receive queues::
3245 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3246 mask (mask_value) priority (prio_value) queue (queue_id)
3248 The available information parameters are:
3250 * ``port_id``: The port which the Flex filter is assigned on.
3252 * ``len_value``: Filter length in bytes, no greater than 128.
3254 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3256 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3258 * ``prio_value``: The priority of this filter.
3260 * ``queue_id``: The receive queue associated with this Flex filter.
3264 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3265 mask 000C priority 3 queue 3
3267 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3268 mask 000C priority 3 queue 3
3271 .. _testpmd_flow_director:
3273 flow_director_filter
3274 ~~~~~~~~~~~~~~~~~~~~
3276 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3278 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3279 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3281 * Perfect match filters.
3282 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3283 The masked fields are for IP flow.
3285 * Signature filters.
3286 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3288 * Perfect-mac-vlan match filters.
3289 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3290 The masked fields are for MAC VLAN flow.
3292 * Perfect-tunnel match filters.
3293 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3294 The masked fields are for tunnel flow.
3296 * Perfect-raw-flow-type match filters.
3297 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3298 The masked fields are specified by input sets.
3300 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3301 per flow type and the flexible payload.
3303 The Flow Director can also mask out parts of all of these fields so that filters
3304 are only applied to certain fields or parts of the fields.
3306 Note that for raw flow type mode the source and destination fields in the
3307 raw packet buffer need to be presented in a reversed order with respect
3308 to the expected received packets.
3309 For example: IP source and destination addresses or TCP/UDP/SCTP
3310 source and destination ports
3312 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3314 # Commands to add flow director filters of different flow types::
3316 flow_director_filter (port_id) mode IP (add|del|update) \
3317 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3318 src (src_ip_address) dst (dst_ip_address) \
3319 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3320 vlan (vlan_value) flexbytes (flexbytes_value) \
3321 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3324 flow_director_filter (port_id) mode IP (add|del|update) \
3325 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3326 src (src_ip_address) (src_port) \
3327 dst (dst_ip_address) (dst_port) \
3328 tos (tos_value) ttl (ttl_value) \
3329 vlan (vlan_value) flexbytes (flexbytes_value) \
3330 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3333 flow_director_filter (port_id) mode IP (add|del|update) \
3334 flow (ipv4-sctp|ipv6-sctp) \
3335 src (src_ip_address) (src_port) \
3336 dst (dst_ip_address) (dst_port) \
3337 tos (tos_value) ttl (ttl_value) \
3338 tag (verification_tag) vlan (vlan_value) \
3339 flexbytes (flexbytes_value) (drop|fwd) \
3340 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3342 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3343 ether (ethertype) flexbytes (flexbytes_value) \
3344 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3347 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3348 mac (mac_address) vlan (vlan_value) \
3349 flexbytes (flexbytes_value) (drop|fwd) \
3350 queue (queue_id) fd_id (fd_id_value)
3352 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3353 mac (mac_address) vlan (vlan_value) \
3354 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3355 flexbytes (flexbytes_value) (drop|fwd) \
3356 queue (queue_id) fd_id (fd_id_value)
3358 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3359 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3360 packet (packet file name)
3362 For example, to add an ipv4-udp flow type filter::
3364 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3365 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3366 fwd pf queue 1 fd_id 1
3368 For example, add an ipv4-other flow type filter::
3370 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3371 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3372 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3377 Flush all flow director filters on a device::
3379 testpmd> flush_flow_director (port_id)
3381 Example, to flush all flow director filter on port 0::
3383 testpmd> flush_flow_director 0
3388 Set flow director's input masks::
3390 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3391 src_mask (ipv4_src) (ipv6_src) (src_port) \
3392 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3394 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3396 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3397 mac (mac_value) tunnel-type (tunnel_type_value) \
3398 tunnel-id (tunnel_id_value)
3400 Example, to set flow director mask on port 0::
3402 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3403 src_mask 255.255.255.255 \
3404 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3405 dst_mask 255.255.255.255 \
3406 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3408 flow_director_flex_mask
3409 ~~~~~~~~~~~~~~~~~~~~~~~
3411 set masks of flow director's flexible payload based on certain flow type::
3413 testpmd> flow_director_flex_mask (port_id) \
3414 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3415 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3416 l2_payload|all) (mask)
3418 Example, to set flow director's flex mask for all flow type on port 0::
3420 testpmd> flow_director_flex_mask 0 flow all \
3421 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3424 flow_director_flex_payload
3425 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3427 Configure flexible payload selection::
3429 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3431 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3433 testpmd> flow_director_flex_payload 0 l4 \
3434 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3436 get_sym_hash_ena_per_port
3437 ~~~~~~~~~~~~~~~~~~~~~~~~~
3439 Get symmetric hash enable configuration per port::
3441 get_sym_hash_ena_per_port (port_id)
3443 For example, to get symmetric hash enable configuration of port 1::
3445 testpmd> get_sym_hash_ena_per_port 1
3447 set_sym_hash_ena_per_port
3448 ~~~~~~~~~~~~~~~~~~~~~~~~~
3450 Set symmetric hash enable configuration per port to enable or disable::
3452 set_sym_hash_ena_per_port (port_id) (enable|disable)
3454 For example, to set symmetric hash enable configuration of port 1 to enable::
3456 testpmd> set_sym_hash_ena_per_port 1 enable
3458 get_hash_global_config
3459 ~~~~~~~~~~~~~~~~~~~~~~
3461 Get the global configurations of hash filters::
3463 get_hash_global_config (port_id)
3465 For example, to get the global configurations of hash filters of port 1::
3467 testpmd> get_hash_global_config 1
3469 set_hash_global_config
3470 ~~~~~~~~~~~~~~~~~~~~~~
3472 Set the global configurations of hash filters::
3474 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
3475 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3476 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3479 For example, to enable simple_xor for flow type of ipv6 on port 2::
3481 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3486 Set the input set for hash::
3488 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3489 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3490 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3491 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3492 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3493 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3494 fld-8th|none) (select|add)
3496 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3498 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3503 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3504 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3506 Set the input set for flow director::
3508 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3509 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3510 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3511 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3512 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3513 sctp-dst-port|sctp-veri-tag|none) (select|add)
3515 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3517 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3522 Set different GRE key length for input set::
3524 global_config (port_id) gre-key-len (number in bytes)
3526 For example to set GRE key length for input set to 4 bytes on port 0::
3528 testpmd> global_config 0 gre-key-len 4
3531 .. _testpmd_rte_flow:
3533 Flow rules management
3534 ---------------------
3536 Control of the generic flow API (*rte_flow*) is fully exposed through the
3537 ``flow`` command (validation, creation, destruction, queries and operation
3540 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3541 features simultaneously may cause undefined side-effects and is therefore
3547 Because the ``flow`` command uses dynamic tokens to handle the large number
3548 of possible flow rules combinations, its behavior differs slightly from
3549 other commands, in particular:
3551 - Pressing *?* or the *<tab>* key displays contextual help for the current
3552 token, not that of the entire command.
3554 - Optional and repeated parameters are supported (provided they are listed
3555 in the contextual help).
3557 The first parameter stands for the operation mode. Possible operations and
3558 their general syntax are described below. They are covered in detail in the
3561 - Check whether a flow rule can be created::
3563 flow validate {port_id}
3564 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3565 pattern {item} [/ {item} [...]] / end
3566 actions {action} [/ {action} [...]] / end
3568 - Create a flow rule::
3570 flow create {port_id}
3571 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3572 pattern {item} [/ {item} [...]] / end
3573 actions {action} [/ {action} [...]] / end
3575 - Destroy specific flow rules::
3577 flow destroy {port_id} rule {rule_id} [...]
3579 - Destroy all flow rules::
3581 flow flush {port_id}
3583 - Query an existing flow rule::
3585 flow query {port_id} {rule_id} {action}
3587 - List existing flow rules sorted by priority, filtered by group
3590 flow list {port_id} [group {group_id}] [...]
3592 - Restrict ingress traffic to the defined flow rules::
3594 flow isolate {port_id} {boolean}
3596 Validating flow rules
3597 ~~~~~~~~~~~~~~~~~~~~~
3599 ``flow validate`` reports whether a flow rule would be accepted by the
3600 underlying device in its current state but stops short of creating it. It is
3601 bound to ``rte_flow_validate()``::
3603 flow validate {port_id}
3604 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3605 pattern {item} [/ {item} [...]] / end
3606 actions {action} [/ {action} [...]] / end
3608 If successful, it will show::
3612 Otherwise it will show an error message of the form::
3614 Caught error type [...] ([...]): [...]
3616 This command uses the same parameters as ``flow create``, their format is
3617 described in `Creating flow rules`_.
3619 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3620 index 6 is supported::
3622 testpmd> flow validate 0 ingress pattern eth / end
3623 actions queue index 6 / end
3627 Port 0 does not support TCPv6 rules::
3629 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3631 Caught error type 9 (specific pattern item): Invalid argument
3637 ``flow create`` validates and creates the specified flow rule. It is bound
3638 to ``rte_flow_create()``::
3640 flow create {port_id}
3641 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3642 pattern {item} [/ {item} [...]] / end
3643 actions {action} [/ {action} [...]] / end
3645 If successful, it will return a flow rule ID usable with other commands::
3647 Flow rule #[...] created
3649 Otherwise it will show an error message of the form::
3651 Caught error type [...] ([...]): [...]
3653 Parameters describe in the following order:
3655 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3656 - A matching pattern, starting with the *pattern* token and terminated by an
3658 - Actions, starting with the *actions* token and terminated by an *end*
3661 These translate directly to *rte_flow* objects provided as-is to the
3662 underlying functions.
3664 The shortest valid definition only comprises mandatory tokens::
3666 testpmd> flow create 0 pattern end actions end
3668 Note that PMDs may refuse rules that essentially do nothing such as this
3671 **All unspecified object values are automatically initialized to 0.**
3676 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3677 specified before the ``pattern`` token.
3679 - ``group {group id}``: priority group.
3680 - ``priority {level}``: priority level within group.
3681 - ``ingress``: rule applies to ingress traffic.
3682 - ``egress``: rule applies to egress traffic.
3683 - ``transfer``: apply rule directly to endpoints found in pattern.
3685 Each instance of an attribute specified several times overrides the previous
3686 value as shown below (group 4 is used)::
3688 testpmd> flow create 0 group 42 group 24 group 4 [...]
3690 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3692 While not specifying a direction is an error, some rules may allow both
3695 Most rules affect RX therefore contain the ``ingress`` token::
3697 testpmd> flow create 0 ingress pattern [...]
3702 A matching pattern starts after the ``pattern`` token. It is made of pattern
3703 items and is terminated by a mandatory ``end`` item.
3705 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3706 rte_flow_item_type``).
3708 The ``/`` token is used as a separator between pattern items as shown
3711 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3713 Note that protocol items like these must be stacked from lowest to highest
3714 layer to make sense. For instance, the following rule is either invalid or
3715 unlikely to match any packet::
3717 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3719 More information on these restrictions can be found in the *rte_flow*
3722 Several items support additional specification structures, for example
3723 ``ipv4`` allows specifying source and destination addresses as follows::
3725 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3726 dst is 10.2.0.0 / end [...]
3728 This rule matches all IPv4 traffic with the specified properties.
3730 In this example, ``src`` and ``dst`` are field names of the underlying
3731 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3732 in a similar fashion.
3734 The ``is`` token means that the subsequent value must be matched exactly,
3735 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3736 accordingly. Possible assignment tokens are:
3738 - ``is``: match value perfectly (with full bit-mask).
3739 - ``spec``: match value according to configured bit-mask.
3740 - ``last``: specify upper bound to establish a range.
3741 - ``mask``: specify bit-mask with relevant bits set to one.
3742 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3744 These yield identical results::
3746 ipv4 src is 10.1.1.1
3750 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3754 ipv4 src spec 10.1.1.1 src prefix 32
3758 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3762 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3764 Inclusive ranges can be defined with ``last``::
3766 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3768 Note that ``mask`` affects both ``spec`` and ``last``::
3770 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3771 # matches 10.1.0.0 to 10.2.255.255
3773 Properties can be modified multiple times::
3775 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3779 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3784 This section lists supported pattern items and their attributes, if any.
3786 - ``end``: end list of pattern items.
3788 - ``void``: no-op pattern item.
3790 - ``invert``: perform actions when pattern does not match.
3792 - ``any``: match any protocol for the current layer.
3794 - ``num {unsigned}``: number of layers covered.
3796 - ``pf``: match traffic from/to the physical function.
3798 - ``vf``: match traffic from/to a virtual function ID.
3800 - ``id {unsigned}``: VF ID.
3802 - ``phy_port``: match traffic from/to a specific physical port.
3804 - ``index {unsigned}``: physical port index.
3806 - ``port_id``: match traffic from/to a given DPDK port ID.
3808 - ``id {unsigned}``: DPDK port ID.
3810 - ``mark``: match value set in previously matched flow rule using the mark action.
3812 - ``id {unsigned}``: arbitrary integer value.
3814 - ``raw``: match an arbitrary byte string.
3816 - ``relative {boolean}``: look for pattern after the previous item.
3817 - ``search {boolean}``: search pattern from offset (see also limit).
3818 - ``offset {integer}``: absolute or relative offset for pattern.
3819 - ``limit {unsigned}``: search area limit for start of pattern.
3820 - ``pattern {string}``: byte string to look for.
3822 - ``eth``: match Ethernet header.
3824 - ``dst {MAC-48}``: destination MAC.
3825 - ``src {MAC-48}``: source MAC.
3826 - ``type {unsigned}``: EtherType or TPID.
3828 - ``vlan``: match 802.1Q/ad VLAN tag.
3830 - ``tci {unsigned}``: tag control information.
3831 - ``pcp {unsigned}``: priority code point.
3832 - ``dei {unsigned}``: drop eligible indicator.
3833 - ``vid {unsigned}``: VLAN identifier.
3834 - ``inner_type {unsigned}``: inner EtherType or TPID.
3836 - ``ipv4``: match IPv4 header.
3838 - ``tos {unsigned}``: type of service.
3839 - ``ttl {unsigned}``: time to live.
3840 - ``proto {unsigned}``: next protocol ID.
3841 - ``src {ipv4 address}``: source address.
3842 - ``dst {ipv4 address}``: destination address.
3844 - ``ipv6``: match IPv6 header.
3846 - ``tc {unsigned}``: traffic class.
3847 - ``flow {unsigned}``: flow label.
3848 - ``proto {unsigned}``: protocol (next header).
3849 - ``hop {unsigned}``: hop limit.
3850 - ``src {ipv6 address}``: source address.
3851 - ``dst {ipv6 address}``: destination address.
3853 - ``icmp``: match ICMP header.
3855 - ``type {unsigned}``: ICMP packet type.
3856 - ``code {unsigned}``: ICMP packet code.
3858 - ``udp``: match UDP header.
3860 - ``src {unsigned}``: UDP source port.
3861 - ``dst {unsigned}``: UDP destination port.
3863 - ``tcp``: match TCP header.
3865 - ``src {unsigned}``: TCP source port.
3866 - ``dst {unsigned}``: TCP destination port.
3868 - ``sctp``: match SCTP header.
3870 - ``src {unsigned}``: SCTP source port.
3871 - ``dst {unsigned}``: SCTP destination port.
3872 - ``tag {unsigned}``: validation tag.
3873 - ``cksum {unsigned}``: checksum.
3875 - ``vxlan``: match VXLAN header.
3877 - ``vni {unsigned}``: VXLAN identifier.
3879 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3881 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3883 - ``nvgre``: match NVGRE header.
3885 - ``tni {unsigned}``: virtual subnet ID.
3887 - ``mpls``: match MPLS header.
3889 - ``label {unsigned}``: MPLS label.
3891 - ``gre``: match GRE header.
3893 - ``protocol {unsigned}``: protocol type.
3895 - ``gre_key``: match GRE optional key field.
3897 - ``value {unsigned}``: key value.
3899 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3901 - ``thresh {unsigned}``: accuracy threshold.
3903 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3905 - ``teid {unsigned}``: tunnel endpoint identifier.
3907 - ``geneve``: match GENEVE header.
3909 - ``vni {unsigned}``: virtual network identifier.
3910 - ``protocol {unsigned}``: protocol type.
3912 - ``vxlan-gpe``: match VXLAN-GPE header.
3914 - ``vni {unsigned}``: VXLAN-GPE identifier.
3916 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3918 - ``sha {MAC-48}``: sender hardware address.
3919 - ``spa {ipv4 address}``: sender IPv4 address.
3920 - ``tha {MAC-48}``: target hardware address.
3921 - ``tpa {ipv4 address}``: target IPv4 address.
3923 - ``ipv6_ext``: match presence of any IPv6 extension header.
3925 - ``next_hdr {unsigned}``: next header.
3927 - ``icmp6``: match any ICMPv6 header.
3929 - ``type {unsigned}``: ICMPv6 type.
3930 - ``code {unsigned}``: ICMPv6 code.
3932 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3934 - ``target_addr {ipv6 address}``: target address.
3936 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3938 - ``target_addr {ipv6 address}``: target address.
3940 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3942 - ``type {unsigned}``: ND option type.
3944 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3945 link-layer address option.
3947 - ``sla {MAC-48}``: source Ethernet LLA.
3949 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3950 link-layer address option.
3952 - ``tla {MAC-48}``: target Ethernet LLA.
3954 - ``meta``: match application specific metadata.
3956 - ``data {unsigned}``: metadata value.
3961 A list of actions starts after the ``actions`` token in the same fashion as
3962 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3963 terminated by a mandatory ``end`` action.
3965 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3966 rte_flow_action_type``).
3968 Dropping all incoming UDPv4 packets can be expressed as follows::
3970 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3973 Several actions have configurable properties which must be specified when
3974 there is no valid default value. For example, ``queue`` requires a target
3977 This rule redirects incoming UDPv4 traffic to queue index 6::
3979 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3980 actions queue index 6 / end
3982 While this one could be rejected by PMDs (unspecified queue index)::
3984 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3987 As defined by *rte_flow*, the list is not ordered, all actions of a given
3988 rule are performed simultaneously. These are equivalent::
3990 queue index 6 / void / mark id 42 / end
3994 void / mark id 42 / queue index 6 / end
3996 All actions in a list should have different types, otherwise only the last
3997 action of a given type is taken into account::
3999 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4003 drop / drop / drop / end # drop is performed only once
4007 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4009 Considering they are performed simultaneously, opposite and overlapping
4010 actions can sometimes be combined when the end result is unambiguous::
4012 drop / queue index 6 / end # drop has no effect
4016 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4020 drop / passthru / end # drop has no effect
4022 Note that PMDs may still refuse such combinations.
4027 This section lists supported actions and their attributes, if any.
4029 - ``end``: end list of actions.
4031 - ``void``: no-op action.
4033 - ``passthru``: let subsequent rule process matched packets.
4035 - ``jump``: redirect traffic to group on device.
4037 - ``group {unsigned}``: group to redirect to.
4039 - ``mark``: attach 32 bit value to packets.
4041 - ``id {unsigned}``: 32 bit value to return with packets.
4043 - ``flag``: flag packets.
4045 - ``queue``: assign packets to a given queue index.
4047 - ``index {unsigned}``: queue index to use.
4049 - ``drop``: drop packets (note: passthru has priority).
4051 - ``count``: enable counters for this rule.
4053 - ``rss``: spread packets among several queues.
4055 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4056 the same as `set_hash_global_config`_.
4058 - ``level {unsigned}``: encapsulation level for ``types``.
4060 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4061 tokens are the same as `set_hash_input_set`_, except that an empty list
4062 does not disable RSS but instead requests unspecified "best-effort"
4065 - ``key {string}``: RSS hash key, overrides ``key_len``.
4067 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4068 conjunction with ``key`` to pad or truncate it.
4070 - ``queues [{unsigned} [...]] end``: queue indices to use.
4072 - ``pf``: direct traffic to physical function.
4074 - ``vf``: direct traffic to a virtual function ID.
4076 - ``original {boolean}``: use original VF ID if possible.
4077 - ``id {unsigned}``: VF ID.
4079 - ``phy_port``: direct packets to physical port index.
4081 - ``original {boolean}``: use original port index if possible.
4082 - ``index {unsigned}``: physical port index.
4084 - ``port_id``: direct matching traffic to a given DPDK port ID.
4086 - ``original {boolean}``: use original DPDK port ID if possible.
4087 - ``id {unsigned}``: DPDK port ID.
4089 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4091 - ``mpls_ttl``: MPLS TTL.
4093 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4095 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4097 - ``nw_ttl``: IP TTL.
4099 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4101 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4103 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4105 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4107 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4109 - ``ethertype``: Ethertype.
4111 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4113 - ``vlan_vid``: VLAN id.
4115 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4117 - ``vlan_pcp``: VLAN priority.
4119 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4121 - ``ethertype``: Ethertype.
4123 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4125 - ``ethertype``: Ethertype.
4127 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4128 is done through `Config VXLAN Encap outer layers`_.
4130 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4131 the VXLAN tunnel network overlay from the matched flow.
4133 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4134 is done through `Config NVGRE Encap outer layers`_.
4136 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4137 the NVGRE tunnel network overlay from the matched flow.
4139 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4140 is done through `Config L2 Encap`_.
4142 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4143 is done through `Config L2 Decap`_.
4145 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4146 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4148 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4149 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4151 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4152 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4154 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4155 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4157 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4159 - ``ipv4_addr``: New IPv4 source address.
4161 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4164 - ``ipv4_addr``: New IPv4 destination address.
4166 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4168 - ``ipv6_addr``: New IPv6 source address.
4170 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4173 - ``ipv6_addr``: New IPv6 destination address.
4175 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4178 - ``port``: New TCP/UDP source port number.
4180 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4183 - ``port``: New TCP/UDP destination port number.
4185 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4188 - ``dec_ttl``: Performs a decrease TTL value action
4190 - ``set_ttl``: Set TTL value with specified value
4191 - ``ttl_value {unsigned}``: The new TTL value to be set
4193 - ``set_mac_src``: set source MAC address
4195 - ``mac_addr {MAC-48}``: new source MAC address
4197 - ``set_mac_dst``: set destination MAC address
4199 - ``mac_addr {MAC-48}``: new destination MAC address
4201 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4203 - ``value {unsigned}``: Value to increase TCP sequence number by.
4205 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4207 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4209 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4211 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4213 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4215 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4217 Destroying flow rules
4218 ~~~~~~~~~~~~~~~~~~~~~
4220 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4221 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4222 times as necessary::
4224 flow destroy {port_id} rule {rule_id} [...]
4226 If successful, it will show::
4228 Flow rule #[...] destroyed
4230 It does not report anything for rule IDs that do not exist. The usual error
4231 message is shown when a rule cannot be destroyed::
4233 Caught error type [...] ([...]): [...]
4235 ``flow flush`` destroys all rules on a device and does not take extra
4236 arguments. It is bound to ``rte_flow_flush()``::
4238 flow flush {port_id}
4240 Any errors are reported as above.
4242 Creating several rules and destroying them::
4244 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4245 actions queue index 2 / end
4246 Flow rule #0 created
4247 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4248 actions queue index 3 / end
4249 Flow rule #1 created
4250 testpmd> flow destroy 0 rule 0 rule 1
4251 Flow rule #1 destroyed
4252 Flow rule #0 destroyed
4255 The same result can be achieved using ``flow flush``::
4257 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4258 actions queue index 2 / end
4259 Flow rule #0 created
4260 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4261 actions queue index 3 / end
4262 Flow rule #1 created
4263 testpmd> flow flush 0
4266 Non-existent rule IDs are ignored::
4268 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4269 actions queue index 2 / end
4270 Flow rule #0 created
4271 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4272 actions queue index 3 / end
4273 Flow rule #1 created
4274 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4276 testpmd> flow destroy 0 rule 0
4277 Flow rule #0 destroyed
4283 ``flow query`` queries a specific action of a flow rule having that
4284 ability. Such actions collect information that can be reported using this
4285 command. It is bound to ``rte_flow_query()``::
4287 flow query {port_id} {rule_id} {action}
4289 If successful, it will display either the retrieved data for known actions
4290 or the following message::
4292 Cannot display result for action type [...] ([...])
4294 Otherwise, it will complain either that the rule does not exist or that some
4297 Flow rule #[...] not found
4301 Caught error type [...] ([...]): [...]
4303 Currently only the ``count`` action is supported. This action reports the
4304 number of packets that hit the flow rule and the total number of bytes. Its
4305 output has the following format::
4308 hits_set: [...] # whether "hits" contains a valid value
4309 bytes_set: [...] # whether "bytes" contains a valid value
4310 hits: [...] # number of packets
4311 bytes: [...] # number of bytes
4313 Querying counters for TCPv6 packets redirected to queue 6::
4315 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4316 actions queue index 6 / count / end
4317 Flow rule #4 created
4318 testpmd> flow query 0 4 count
4329 ``flow list`` lists existing flow rules sorted by priority and optionally
4330 filtered by group identifiers::
4332 flow list {port_id} [group {group_id}] [...]
4334 This command only fails with the following message if the device does not
4339 Output consists of a header line followed by a short description of each
4340 flow rule, one per line. There is no output at all when no flow rules are
4341 configured on the device::
4343 ID Group Prio Attr Rule
4344 [...] [...] [...] [...] [...]
4346 ``Attr`` column flags:
4348 - ``i`` for ``ingress``.
4349 - ``e`` for ``egress``.
4351 Creating several flow rules and listing them::
4353 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4354 actions queue index 6 / end
4355 Flow rule #0 created
4356 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4357 actions queue index 2 / end
4358 Flow rule #1 created
4359 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4360 actions rss queues 6 7 8 end / end
4361 Flow rule #2 created
4362 testpmd> flow list 0
4363 ID Group Prio Attr Rule
4364 0 0 0 i- ETH IPV4 => QUEUE
4365 1 0 0 i- ETH IPV6 => QUEUE
4366 2 0 5 i- ETH IPV4 UDP => RSS
4369 Rules are sorted by priority (i.e. group ID first, then priority level)::
4371 testpmd> flow list 1
4372 ID Group Prio Attr Rule
4373 0 0 0 i- ETH => COUNT
4374 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4375 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4376 1 24 0 i- ETH IPV4 UDP => QUEUE
4377 4 24 10 i- ETH IPV4 TCP => DROP
4378 3 24 20 i- ETH IPV4 => DROP
4379 2 24 42 i- ETH IPV4 UDP => QUEUE
4380 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4383 Output can be limited to specific groups::
4385 testpmd> flow list 1 group 0 group 63
4386 ID Group Prio Attr Rule
4387 0 0 0 i- ETH => COUNT
4388 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4389 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4390 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4393 Toggling isolated mode
4394 ~~~~~~~~~~~~~~~~~~~~~~
4396 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4397 must only be injected from the defined flow rules; that no default traffic
4398 is expected outside those rules and the driver is free to assign more
4399 resources to handle them. It is bound to ``rte_flow_isolate()``::
4401 flow isolate {port_id} {boolean}
4403 If successful, enabling or disabling isolated mode shows either::
4405 Ingress traffic on port [...]
4406 is now restricted to the defined flow rules
4410 Ingress traffic on port [...]
4411 is not restricted anymore to the defined flow rules
4413 Otherwise, in case of error::
4415 Caught error type [...] ([...]): [...]
4417 Mainly due to its side effects, PMDs supporting this mode may not have the
4418 ability to toggle it more than once without reinitializing affected ports
4419 first (e.g. by exiting testpmd).
4421 Enabling isolated mode::
4423 testpmd> flow isolate 0 true
4424 Ingress traffic on port 0 is now restricted to the defined flow rules
4427 Disabling isolated mode::
4429 testpmd> flow isolate 0 false
4430 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4433 Sample QinQ flow rules
4434 ~~~~~~~~~~~~~~~~~~~~~~
4436 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4438 testpmd> port stop 0
4439 testpmd> vlan set qinq on 0
4441 The above command sets the inner and outer TPID's to 0x8100.
4443 To change the TPID's the following commands should be used::
4445 testpmd> vlan set outer tpid 0xa100 0
4446 testpmd> vlan set inner tpid 0x9100 0
4447 testpmd> port start 0
4449 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4453 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4454 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4455 Flow rule #0 validated
4457 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4458 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4459 Flow rule #0 created
4461 testpmd> flow list 0
4462 ID Group Prio Attr Rule
4463 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4465 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4469 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4470 vlan tci is 654 / end actions pf / queue index 0 / end
4471 Flow rule #1 validated
4473 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4474 vlan tci is 654 / end actions pf / queue index 1 / end
4475 Flow rule #1 created
4477 testpmd> flow list 0
4478 ID Group Prio Attr Rule
4479 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4480 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4482 Sample VXLAN encapsulation rule
4483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4485 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4486 source code, those can be changed by using the following commands
4488 IPv4 VXLAN outer header::
4490 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4491 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4492 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4495 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4496 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4497 eth-dst 22:22:22:22:22:22
4498 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4501 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4502 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4503 eth-dst 22:22:22:22:22:22
4504 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4507 IPv6 VXLAN outer header::
4509 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4510 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4511 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4514 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4515 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4516 eth-dst 22:22:22:22:22:22
4517 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4520 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4521 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4522 eth-dst 22:22:22:22:22:22
4523 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4526 Sample NVGRE encapsulation rule
4527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4529 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4530 source code, those can be changed by using the following commands
4532 IPv4 NVGRE outer header::
4534 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4535 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4536 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4539 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4540 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4541 eth-dst 22:22:22:22:22:22
4542 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4545 IPv6 NVGRE outer header::
4547 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4548 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4549 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4552 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4553 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4554 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4557 Sample L2 encapsulation rule
4558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4560 L2 encapsulation has default value pre-configured in testpmd
4561 source code, those can be changed by using the following commands
4565 testpmd> set l2_encap ip-version ipv4
4566 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4567 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4568 mplsoudp_decap / l2_encap / end
4570 L2 with VXLAN header::
4572 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4573 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4574 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4575 mplsoudp_decap / l2_encap / end
4577 Sample L2 decapsulation rule
4578 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4580 L2 decapsulation has default value pre-configured in testpmd
4581 source code, those can be changed by using the following commands
4585 testpmd> set l2_decap
4586 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4589 L2 with VXLAN header::
4591 testpmd> set l2_encap-with-vlan
4592 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4595 Sample MPLSoGRE encapsulation rule
4596 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4598 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4599 source code, those can be changed by using the following commands
4601 IPv4 MPLSoGRE outer header::
4603 testpmd> set mplsogre_encap ip-version ipv4 label 4
4604 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4605 eth-dst 22:22:22:22:22:22
4606 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4607 mplsogre_encap / end
4609 IPv4 MPLSoGRE with VLAN outer header::
4611 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4612 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4613 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4614 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4615 mplsogre_encap / end
4617 IPv6 MPLSoGRE outer header::
4619 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4620 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4621 eth-dst 22:22:22:22:22:22
4622 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4623 mplsogre_encap / end
4625 IPv6 MPLSoGRE with VLAN outer header::
4627 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4628 ip-src ::1 ip-dst ::2222 vlan-tci 34
4629 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4630 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4631 mplsogre_encap / end
4633 Sample MPLSoGRE decapsulation rule
4634 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4636 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4637 source code, those can be changed by using the following commands
4639 IPv4 MPLSoGRE outer header::
4641 testpmd> set mplsogre_decap ip-version ipv4
4642 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4643 mplsogre_decap / l2_encap / end
4645 IPv4 MPLSoGRE with VLAN outer header::
4647 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4648 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4649 actions mplsogre_decap / l2_encap / end
4651 IPv6 MPLSoGRE outer header::
4653 testpmd> set mplsogre_decap ip-version ipv6
4654 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4655 actions mplsogre_decap / l2_encap / end
4657 IPv6 MPLSoGRE with VLAN outer header::
4659 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4660 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4661 actions mplsogre_decap / l2_encap / end
4663 Sample MPLSoUDP encapsulation rule
4664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4666 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4667 source code, those can be changed by using the following commands
4669 IPv4 MPLSoUDP outer header::
4671 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4672 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4673 eth-dst 22:22:22:22:22:22
4674 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4675 mplsoudp_encap / end
4677 IPv4 MPLSoUDP with VLAN outer header::
4679 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4680 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4681 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4682 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4683 mplsoudp_encap / end
4685 IPv6 MPLSoUDP outer header::
4687 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4688 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4689 eth-dst 22:22:22:22:22:22
4690 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4691 mplsoudp_encap / end
4693 IPv6 MPLSoUDP with VLAN outer header::
4695 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4696 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4697 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4698 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4699 mplsoudp_encap / end
4701 Sample MPLSoUDP decapsulation rule
4702 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4704 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4705 source code, those can be changed by using the following commands
4707 IPv4 MPLSoUDP outer header::
4709 testpmd> set mplsoudp_decap ip-version ipv4
4710 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4711 mplsoudp_decap / l2_encap / end
4713 IPv4 MPLSoUDP with VLAN outer header::
4715 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4716 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4717 actions mplsoudp_decap / l2_encap / end
4719 IPv6 MPLSoUDP outer header::
4721 testpmd> set mplsoudp_decap ip-version ipv6
4722 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4723 actions mplsoudp_decap / l2_encap / end
4725 IPv6 MPLSoUDP with VLAN outer header::
4727 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4728 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4729 actions mplsoudp_decap / l2_encap / end
4731 Sample Raw encapsulation rule
4732 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4734 Raw encapsulation configuration can be set by the following commands
4736 Eecapsulating VxLAN::
4738 testpmd> set raw_encap eth src is 10:11:22:33:44:55 / vlan tci is 1
4739 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4741 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4744 Sample Raw decapsulation rule
4745 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4747 Raw decapsulation configuration can be set by the following commands
4749 Decapsulating VxLAN::
4751 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4752 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4753 end actions raw_decap / queue index 0 / end
4758 The following sections show functions to load/unload eBPF based filters.
4763 Load an eBPF program as a callback for particular RX/TX queue::
4765 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4767 The available load-flags are:
4769 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4771 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4777 You'll need clang v3.7 or above to build bpf program you'd like to load
4781 .. code-block:: console
4784 clang -O2 -target bpf -c t1.c
4786 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4788 .. code-block:: console
4790 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4792 To load (not JITed) t1.o at TX queue 0, port 0:
4794 .. code-block:: console
4796 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4801 Unload previously loaded eBPF program for particular RX/TX queue::
4803 testpmd> bpf-unload rx|tx (portid) (queueid)
4805 For example to unload BPF filter from TX queue 0, port 0:
4807 .. code-block:: console
4809 testpmd> bpf-unload tx 0 0