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 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
201 strip on, filter on, extend off, qinq strip off
202 Redirection table size: 512
203 Supported flow types:
224 Display the rss redirection table entry indicated by masks on port X::
226 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
228 size is used to indicate the hardware supported reta size
233 Display the RSS hash functions and RSS hash key of a port::
235 testpmd> show port (port_id) rss-hash [key]
240 Clear the port statistics and forward engine statistics for a given port or for all ports::
242 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
246 testpmd> clear port stats all
251 Display information for a given port's RX/TX queue::
253 testpmd> show (rxq|txq) info (port_id) (queue_id)
255 show desc status(rxq|txq)
256 ~~~~~~~~~~~~~~~~~~~~~~~~~
258 Display information for a given port's RX/TX descriptor status::
260 testpmd> show port (port_id) (rxq|txq) (queue_id) desc (desc_id) status
266 Displays the configuration of the application.
267 The configuration comes from the command-line, the runtime or the application defaults::
269 testpmd> show config (rxtx|cores|fwd|txpkts|txtimes)
271 The available information categories are:
273 * ``rxtx``: RX/TX configuration items.
275 * ``cores``: List of forwarding cores.
277 * ``fwd``: Packet forwarding configuration.
279 * ``txpkts``: Packets to TX configuration.
281 * ``txtimes``: Burst time pattern for Tx only mode.
285 .. code-block:: console
287 testpmd> show config rxtx
289 io packet forwarding - CRC stripping disabled - packets/burst=16
290 nb forwarding cores=2 - nb forwarding ports=1
291 RX queues=1 - RX desc=128 - RX free threshold=0
292 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
293 TX queues=1 - TX desc=512 - TX free threshold=0
294 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
295 TX RS bit threshold=0 - TXQ flags=0x0
300 Set the packet forwarding mode::
302 testpmd> set fwd (io|mac|macswap|flowgen| \
303 rxonly|txonly|csum|icmpecho|noisy|5tswap) (""|retry)
305 ``retry`` can be specified for forwarding engines except ``rx_only``.
307 The available information categories are:
309 * ``io``: Forwards packets "as-is" in I/O mode.
310 This is the fastest possible forwarding operation as it does not access packets data.
311 This is the default mode.
313 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
314 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
315 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
316 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
318 * ``macswap``: MAC swap forwarding mode.
319 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
321 * ``flowgen``: Multi-flow generation mode.
322 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
324 * ``rxonly``: Receives packets but doesn't transmit them.
326 * ``txonly``: Generates and transmits packets without receiving any.
328 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
330 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
332 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
334 * ``noisy``: Noisy neighbor simulation.
335 Simulate more realistic behavior of a guest machine engaged in receiving
336 and sending packets performing Virtual Network Function (VNF).
338 * ``5tswap``: Swap the source and destination of L2,L3,L4 if they exist.
340 L2 swaps the source address and destination address of Ethernet, as same as ``macswap``.
342 L3 swaps the source address and destination address of IP (v4 and v6).
344 L4 swaps the source port and destination port of transport layer (TCP and UDP).
348 testpmd> set fwd rxonly
350 Set rxonly packet forwarding mode
356 When running, forwarding engines maintain statistics from the time they have been started.
357 Example for the io forwarding engine, with some packet drops on the tx side::
359 testpmd> show fwd stats all
361 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
362 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
364 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
365 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
367 ---------------------- Forward statistics for port 0 ----------------------
368 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
369 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
370 ----------------------------------------------------------------------------
372 ---------------------- Forward statistics for port 1 ----------------------
373 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
374 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
375 ----------------------------------------------------------------------------
377 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
378 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
379 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
380 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
384 Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES appends "CPU cycles/packet" stats, like:
386 CPU cycles/packet=xx.dd (total cycles=xxxx / total RX packets=xxxx) at xxx MHz clock
391 Clear the forwarding engines statistics::
393 testpmd> clear fwd stats all
398 Display an RX descriptor for a port RX queue::
400 testpmd> read rxd (port_id) (queue_id) (rxd_id)
404 testpmd> read rxd 0 0 4
405 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
410 Display a TX descriptor for a port TX queue::
412 testpmd> read txd (port_id) (queue_id) (txd_id)
416 testpmd> read txd 0 0 4
417 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
422 Get loaded dynamic device personalization (DDP) package info list::
424 testpmd> ddp get list (port_id)
429 Display information about dynamic device personalization (DDP) profile::
431 testpmd> ddp get info (profile_path)
436 Display VF statistics::
438 testpmd> show vf stats (port_id) (vf_id)
443 Reset VF statistics::
445 testpmd> clear vf stats (port_id) (vf_id)
447 show port pctype mapping
448 ~~~~~~~~~~~~~~~~~~~~~~~~
450 List all items from the pctype mapping table::
452 testpmd> show port (port_id) pctype mapping
454 show rx offloading capabilities
455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
457 List all per queue and per port Rx offloading capabilities of a port::
459 testpmd> show port (port_id) rx_offload capabilities
461 show rx offloading configuration
462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
464 List port level and all queue level Rx offloading configuration::
466 testpmd> show port (port_id) rx_offload configuration
468 show tx offloading capabilities
469 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
471 List all per queue and per port Tx offloading capabilities of a port::
473 testpmd> show port (port_id) tx_offload capabilities
475 show tx offloading configuration
476 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
478 List port level and all queue level Tx offloading configuration::
480 testpmd> show port (port_id) tx_offload configuration
482 show tx metadata setting
483 ~~~~~~~~~~~~~~~~~~~~~~~~
485 Show Tx metadata value set for a specific port::
487 testpmd> show port (port_id) tx_metadata
489 show port supported ptypes
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~
492 Show ptypes supported for a specific port::
494 testpmd> show port (port_id) ptypes
496 set port supported ptypes
497 ~~~~~~~~~~~~~~~~~~~~~~~~~
499 set packet types classification for a specific port::
501 testpmd> set port (port_id) ptypes_mask (mask)
503 show port mac addresses info
504 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
506 Show mac addresses added for a specific port::
508 testpmd> show port (port_id) macs
511 show port multicast mac addresses info
512 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
514 Show multicast mac addresses added for a specific port::
516 testpmd> show port (port_id) mcast_macs
521 Show general information about devices probed::
523 testpmd> show device info (<identifier>|all)
527 .. code-block:: console
529 testpmd> show device info net_pcap0
531 ********************* Infos for device net_pcap0 *********************
533 Driver name: net_pcap
534 Devargs: iface=enP2p6s0,phy_mac=1
535 Connect to socket: -1
538 MAC address: 1E:37:93:28:04:B8
539 Device name: net_pcap0
544 Dumps all physical memory segment layouts::
546 testpmd> dump_physmem
551 Dumps the layout of all memory zones::
553 testpmd> dump_memzone
558 Dumps the memory usage of all sockets::
560 testpmd> dump_socket_mem
565 Dumps the size of all memory structures::
567 testpmd> dump_struct_sizes
572 Dumps the status of all or specific element in DPDK rings::
574 testpmd> dump_ring [ring_name]
579 Dumps the statistics of all or specific memory pool::
581 testpmd> dump_mempool [mempool_name]
586 Dumps the user device list::
588 testpmd> dump_devargs
593 Dumps the log level for all the dpdk modules::
595 testpmd> dump_log_types
597 show (raw_encap|raw_decap)
598 ~~~~~~~~~~~~~~~~~~~~~~~~~~
600 Display content of raw_encap/raw_decap buffers in hex::
602 testpmd> show <raw_encap|raw_decap> <index>
603 testpmd> show <raw_encap|raw_decap> all
607 testpmd> show raw_encap 6
609 index: 6 at [0x1c565b0], len=50
610 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
611 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
612 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
616 Configuration Functions
617 -----------------------
619 The testpmd application can be configured from the runtime as well as from the command-line.
621 This section details the available configuration functions that are available.
625 Configuration changes only become active when forwarding is started/restarted.
630 Reset forwarding to the default configuration::
637 Set the debug verbosity level::
639 testpmd> set verbose (level)
641 Available levels are as following:
643 * ``0`` silent except for error.
644 * ``1`` fully verbose except for Tx packets.
645 * ``2`` fully verbose except for Rx packets.
646 * ``> 2`` fully verbose.
651 Set the log level for a log type::
653 testpmd> set log global|(type) (level)
657 * ``type`` is the log name.
659 * ``level`` is the log level.
661 For example, to change the global log level::
663 testpmd> set log global (level)
665 Regexes can also be used for type. To change log level of user1, user2 and user3::
667 testpmd> set log user[1-3] (level)
672 Set the number of ports used by the application:
676 This is equivalent to the ``--nb-ports`` command-line option.
681 Set the number of cores used by the application::
683 testpmd> set nbcore (num)
685 This is equivalent to the ``--nb-cores`` command-line option.
689 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
694 Set the forwarding cores hexadecimal mask::
696 testpmd> set coremask (mask)
698 This is equivalent to the ``--coremask`` command-line option.
702 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
707 Set the forwarding ports hexadecimal mask::
709 testpmd> set portmask (mask)
711 This is equivalent to the ``--portmask`` command-line option.
713 set record-core-cycles
714 ~~~~~~~~~~~~~~~~~~~~~~
716 Set the recording of CPU cycles::
718 testpmd> set record-core-cycles (on|off)
722 * ``on`` enables measurement of CPU cycles per packet.
724 * ``off`` disables measurement of CPU cycles per packet.
726 This is equivalent to the ``--record-core-cycles command-line`` option.
731 Set number of packets per burst::
733 testpmd> set burst (num)
735 This is equivalent to the ``--burst command-line`` option.
737 When retry is enabled, the transmit delay time and number of retries can also be set::
739 testpmd> set burst tx delay (microseconds) retry (num)
744 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
746 testpmd> set txpkts (x[,y]*)
748 Where x[,y]* represents a CSV list of values, without white space.
753 Configure the timing burst pattern for Tx only mode. This command enables
754 the packet send scheduling on dynamic timestamp mbuf field and configures
755 timing pattern in Tx only mode. In this mode, if scheduling is enabled
756 application provides timestamps in the packets being sent. It is possible
757 to configure delay (in unspecified device clock units) between bursts
758 and between the packets within the burst::
760 testpmd> set txtimes (inter),(intra)
764 * ``inter`` is the delay between the bursts in the device clock units.
765 If ``intra`` is zero, this is the time between the beginnings of the
766 first packets in the neighbour bursts, if ``intra`` is not zero,
767 ``inter`` specifies the time between the beginning of the first packet
768 of the current burst and the beginning of the last packet of the
769 previous burst. If ``inter`` parameter is zero the send scheduling
770 on timestamps is disabled (default).
772 * ``intra`` is the delay between the packets within the burst specified
773 in the device clock units. The number of packets in the burst is defined
774 by regular burst setting. If ``intra`` parameter is zero no timestamps
775 provided in the packets excepting the first one in the burst.
777 As the result the bursts of packet will be transmitted with specific
778 delays between the packets within the burst and specific delay between
779 the bursts. The rte_eth_read_clock() must be supported by the device(s)
780 and is supposed to be engaged to get the current device clock value
781 and provide the reference for the timestamps. If there is no supported
782 rte_eth_read_clock() there will be no send scheduling provided on the port.
787 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
789 testpmd> set txsplit (off|on|rand)
793 * ``off`` disable packet copy & split for CSUM mode.
795 * ``on`` split outgoing packet into multiple segments. Size of each segment
796 and number of segments per packet is determined by ``set txpkts`` command
799 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
804 Set the list of forwarding cores::
806 testpmd> set corelist (x[,y]*)
808 For example, to change the forwarding cores:
810 .. code-block:: console
812 testpmd> set corelist 3,1
813 testpmd> show config fwd
815 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
816 Logical Core 3 (socket 0) forwards packets on 1 streams:
817 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
818 Logical Core 1 (socket 0) forwards packets on 1 streams:
819 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
823 The cores are used in the same order as specified on the command line.
828 Set the list of forwarding ports::
830 testpmd> set portlist (x[,y]*)
832 For example, to change the port forwarding:
834 .. code-block:: console
836 testpmd> set portlist 0,2,1,3
837 testpmd> show config fwd
839 io packet forwarding - ports=4 - cores=1 - streams=4
840 Logical Core 3 (socket 0) forwards packets on 4 streams:
841 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
842 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
843 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
844 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
849 Select how to retrieve new ports created after "port attach" command::
851 testpmd> set port setup on (iterator|event)
853 For each new port, a setup is done.
854 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
855 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
860 Enable/disable tx loopback::
862 testpmd> set tx loopback (port_id) (on|off)
867 set drop enable bit for all queues::
869 testpmd> set all queues drop (port_id) (on|off)
871 set split drop enable (for VF)
872 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
874 set split drop enable bit for VF from PF::
876 testpmd> set vf split drop (port_id) (vf_id) (on|off)
878 set mac antispoof (for VF)
879 ~~~~~~~~~~~~~~~~~~~~~~~~~~
881 Set mac antispoof for a VF from the PF::
883 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
888 Enable/disable MACsec offload::
890 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
891 testpmd> set macsec offload (port_id) off
896 Configure MACsec secure connection (SC)::
898 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
902 The pi argument is ignored for tx.
903 Check the NIC Datasheet for hardware limits.
908 Configure MACsec secure association (SA)::
910 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
914 The IDX value must be 0 or 1.
915 Check the NIC Datasheet for hardware limits.
917 set broadcast mode (for VF)
918 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
920 Set broadcast mode for a VF from the PF::
922 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
927 Set the VLAN strip for a queue on a port::
929 testpmd> vlan set stripq (on|off) (port_id,queue_id)
931 vlan set stripq (for VF)
932 ~~~~~~~~~~~~~~~~~~~~~~~~
934 Set VLAN strip for all queues in a pool for a VF from the PF::
936 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
938 vlan set insert (for VF)
939 ~~~~~~~~~~~~~~~~~~~~~~~~
941 Set VLAN insert for a VF from the PF::
943 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
945 vlan set tag (for VF)
946 ~~~~~~~~~~~~~~~~~~~~~
948 Set VLAN tag for a VF from the PF::
950 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
952 vlan set antispoof (for VF)
953 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
955 Set VLAN antispoof for a VF from the PF::
957 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
959 vlan set (strip|filter|qinq_strip|extend)
960 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
961 Set the VLAN strip/filter/QinQ strip/extend on for a port::
963 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
968 Set the inner or outer VLAN TPID for packet filtering on a port::
970 testpmd> vlan set (inner|outer) tpid (value) (port_id)
974 TPID value must be a 16-bit number (value <= 65536).
979 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
981 testpmd> rx_vlan add (vlan_id|all) (port_id)
985 VLAN filter must be set on that port. VLAN ID < 4096.
986 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
987 in VFTA table. This is important if enabling all vlan_ids.
992 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
994 testpmd> rx_vlan rm (vlan_id|all) (port_id)
999 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
1001 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
1006 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
1008 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
1013 Add a tunnel filter on a port::
1015 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
1016 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1017 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1019 The available information categories are:
1021 * ``vxlan``: Set tunnel type as VXLAN.
1023 * ``nvgre``: Set tunnel type as NVGRE.
1025 * ``ipingre``: Set tunnel type as IP-in-GRE.
1027 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
1029 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
1031 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
1033 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
1035 * ``imac``: Set filter type as Inner MAC.
1037 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
1039 * ``oip``: Set filter type as Outer IP.
1041 * ``iip``: Set filter type as Inner IP.
1045 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
1046 192.168.2.2 0 ipingre oip 1 1
1048 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
1050 tunnel_filter remove
1051 ~~~~~~~~~~~~~~~~~~~~
1053 Remove a tunnel filter on a port::
1055 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
1056 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1057 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1062 Add an UDP port for VXLAN packet filter on a port::
1064 testpmd> rx_vxlan_port add (udp_port) (port_id)
1066 rx_vxlan_port remove
1067 ~~~~~~~~~~~~~~~~~~~~
1069 Remove an UDP port for VXLAN packet filter on a port::
1071 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1076 Set hardware insertion of VLAN IDs in packets sent on a port::
1078 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1080 For example, set a single VLAN ID (5) insertion on port 0::
1084 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1092 Set port based hardware insertion of VLAN ID in packets sent on a port::
1094 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1099 Disable hardware insertion of a VLAN header in packets sent on a port::
1101 testpmd> tx_vlan reset (port_id)
1106 Select hardware or software calculation of the checksum when
1107 transmitting a packet using the ``csum`` forwarding engine::
1109 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1113 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1115 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1116 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1117 supported). See also the ``csum parse-tunnel`` command.
1119 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1120 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1121 supported). See also the ``csum parse-tunnel`` command.
1125 Check the NIC Datasheet for hardware limits.
1130 Set RSS queue region span on a port::
1132 testpmd> set port (port_id) queue-region region_id (value) \
1133 queue_start_index (value) queue_num (value)
1135 Set flowtype mapping on a RSS queue region on a port::
1137 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1141 * For the flowtype(pctype) of packet,the specific index for each type has
1142 been defined in file i40e_type.h as enum i40e_filter_pctype.
1144 Set user priority mapping on a RSS queue region on a port::
1146 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1148 Flush all queue region related configuration on a port::
1150 testpmd> set port (port_id) queue-region flush (on|off)
1154 * ``on``: is just an enable function which server for other configuration,
1155 it is for all configuration about queue region from up layer,
1156 at first will only keep in DPDK software stored in driver,
1157 only after "flush on", it commit all configuration to HW.
1159 * ``"off``: is just clean all configuration about queue region just now,
1160 and restore all to DPDK i40e driver default config when start up.
1162 Show all queue region related configuration info on a port::
1164 testpmd> show port (port_id) queue-region
1168 Queue region only support on PF by now, so these command is
1169 only for configuration of queue region on PF port.
1174 Define how tunneled packets should be handled by the csum forward
1177 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1179 If enabled, the csum forward engine will try to recognize supported
1180 tunnel headers (vxlan, gre, ipip).
1182 If disabled, treat tunnel packets as non-tunneled packets (a inner
1183 header is handled as a packet payload).
1187 The port argument is the TX port like in the ``csum set`` command.
1191 Consider a packet in packet like the following::
1193 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1195 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1196 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1197 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1199 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1200 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1205 Display tx checksum offload configuration::
1207 testpmd> csum show (port_id)
1212 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1214 testpmd> tso set (segsize) (port_id)
1218 Check the NIC datasheet for hardware limits.
1223 Display the status of TCP Segmentation Offload::
1225 testpmd> tso show (port_id)
1230 Set tso segment size of tunneled packets for a port in csum engine::
1232 testpmd> tunnel_tso set (tso_segsz) (port_id)
1237 Display the status of tunneled TCP Segmentation Offload for a port::
1239 testpmd> tunnel_tso show (port_id)
1244 Enable or disable GRO in ``csum`` forwarding engine::
1246 testpmd> set port <port_id> gro on|off
1248 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1249 packets received from the given port.
1251 If disabled, packets received from the given port won't be performed
1252 GRO. By default, GRO is disabled for all ports.
1256 When enable GRO for a port, TCP/IPv4 packets received from the port
1257 will be performed GRO. After GRO, all merged packets have bad
1258 checksums, since the GRO library doesn't re-calculate checksums for
1259 the merged packets. Therefore, if users want the merged packets to
1260 have correct checksums, please select HW IP checksum calculation and
1261 HW TCP checksum calculation for the port which the merged packets are
1267 Display GRO configuration for a given port::
1269 testpmd> show port <port_id> gro
1274 Set the cycle to flush the GROed packets from reassembly tables::
1276 testpmd> set gro flush <cycles>
1278 When enable GRO, the csum forwarding engine performs GRO on received
1279 packets, and the GROed packets are stored in reassembly tables. Users
1280 can use this command to determine when the GROed packets are flushed
1281 from the reassembly tables.
1283 The ``cycles`` is measured in GRO operation times. The csum forwarding
1284 engine flushes the GROed packets from the tables every ``cycles`` GRO
1287 By default, the value of ``cycles`` is 1, which means flush GROed packets
1288 from the reassembly tables as soon as one GRO operation finishes. The value
1289 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1291 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1292 stack performance. Because the GROed packets are delayed to arrive the
1293 stack, thus causing more duplicated ACKs and TCP retransmissions.
1298 Toggle per-port GSO support in ``csum`` forwarding engine::
1300 testpmd> set port <port_id> gso on|off
1302 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1303 packets, transmitted on the given port.
1305 If disabled, packets transmitted on the given port will not undergo GSO.
1306 By default, GSO is disabled for all ports.
1310 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1311 port undergo GSO. Afterwards, the segmented packets are represented by
1312 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1313 of checksums for GSO'd segments in SW. As a result, if users want correct
1314 checksums in GSO segments, they should enable HW checksum calculation for
1317 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1318 by setting the following options in the csum forwarding engine:
1320 testpmd> csum set outer_ip hw <port_id>
1322 testpmd> csum set ip hw <port_id>
1324 testpmd> csum set tcp hw <port_id>
1326 UDP GSO is the same as IP fragmentation, which treats the UDP header
1327 as the payload and does not modify it during segmentation. That is,
1328 after UDP GSO, only the first output fragment has the original UDP
1329 header. Therefore, users need to enable HW IP checksum calculation
1330 and SW UDP checksum calculation for GSO-enabled ports, if they want
1331 correct checksums for UDP/IPv4 packets.
1336 Set the maximum GSO segment size (measured in bytes), which includes the
1337 packet header and the packet payload for GSO-enabled ports (global)::
1339 testpmd> set gso segsz <length>
1344 Display the status of Generic Segmentation Offload for a given port::
1346 testpmd> show port <port_id> gso
1351 Add an alternative MAC address to a port::
1353 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1358 Remove a MAC address from a port::
1360 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1365 To add the multicast MAC address to/from the set of multicast addresses
1368 testpmd> mcast_addr add (port_id) (mcast_addr)
1373 To remove the multicast MAC address to/from the set of multicast addresses
1376 testpmd> mcast_addr remove (port_id) (mcast_addr)
1378 mac_addr add (for VF)
1379 ~~~~~~~~~~~~~~~~~~~~~
1381 Add an alternative MAC address for a VF to a port::
1383 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1388 Set the default MAC address for a port::
1390 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1392 mac_addr set (for VF)
1393 ~~~~~~~~~~~~~~~~~~~~~
1395 Set the MAC address for a VF from the PF::
1397 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1402 Set the forwarding peer address for certain port::
1404 testpmd> set eth-peer (port_id) (peer_addr)
1406 This is equivalent to the ``--eth-peer`` command-line option.
1411 Set the unicast hash filter(s) on/off for a port::
1413 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1418 Set the promiscuous mode on for a port or for all ports.
1419 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1421 testpmd> set promisc (port_id|all) (on|off)
1426 Set the allmulti mode for a port or for all ports::
1428 testpmd> set allmulti (port_id|all) (on|off)
1430 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1432 set promisc (for VF)
1433 ~~~~~~~~~~~~~~~~~~~~
1435 Set the unicast promiscuous mode for a VF from PF.
1436 It's supported by Intel i40e NICs now.
1437 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1439 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1441 set allmulticast (for VF)
1442 ~~~~~~~~~~~~~~~~~~~~~~~~~
1444 Set the multicast promiscuous mode for a VF from PF.
1445 It's supported by Intel i40e NICs now.
1446 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1448 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1450 set tx max bandwidth (for VF)
1451 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1453 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1455 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1457 set tc tx min bandwidth (for VF)
1458 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1460 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1462 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1464 set tc tx max bandwidth (for VF)
1465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1467 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1469 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1471 set tc strict link priority mode
1472 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1474 Set some TCs' strict link priority mode on a physical port::
1476 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1478 set tc tx min bandwidth
1479 ~~~~~~~~~~~~~~~~~~~~~~~
1481 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1483 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1488 Set the link flow control parameter on a port::
1490 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1491 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1492 autoneg (on|off) (port_id)
1496 * ``high_water`` (integer): High threshold value to trigger XOFF.
1498 * ``low_water`` (integer): Low threshold value to trigger XON.
1500 * ``pause_time`` (integer): Pause quota in the Pause frame.
1502 * ``send_xon`` (0/1): Send XON frame.
1504 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1506 * ``autoneg``: Change the auto-negotiation parameter.
1511 Set the priority flow control parameter on a port::
1513 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1514 (pause_time) (priority) (port_id)
1518 * ``high_water`` (integer): High threshold value.
1520 * ``low_water`` (integer): Low threshold value.
1522 * ``pause_time`` (integer): Pause quota in the Pause frame.
1524 * ``priority`` (0-7): VLAN User Priority.
1529 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1531 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1533 For example, to set rx queue 2 on port 0 to mapping 5::
1535 testpmd>set stat_qmap rx 0 2 5
1537 set xstats-hide-zero
1538 ~~~~~~~~~~~~~~~~~~~~
1540 Set the option to hide zero values for xstats display::
1542 testpmd> set xstats-hide-zero on|off
1546 By default, the zero values are displayed for xstats.
1548 set port - rx/tx (for VF)
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~
1551 Set VF receive/transmit from a port::
1553 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1555 set port - mac address filter (for VF)
1556 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1558 Add/Remove unicast or multicast MAC addr filter for a VF::
1560 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1561 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1563 set port - rx mode(for VF)
1564 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1566 Set the VF receive mode of a port::
1568 testpmd> set port (port_id) vf (vf_id) \
1569 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1571 The available receive modes are:
1573 * ``AUPE``: Accepts untagged VLAN.
1575 * ``ROPE``: Accepts unicast hash.
1577 * ``BAM``: Accepts broadcast packets.
1579 * ``MPE``: Accepts all multicast packets.
1581 set port - tx_rate (for Queue)
1582 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1584 Set TX rate limitation for a queue on a port::
1586 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1588 set port - tx_rate (for VF)
1589 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1591 Set TX rate limitation for queues in VF on a port::
1593 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1595 set port - mirror rule
1596 ~~~~~~~~~~~~~~~~~~~~~~
1598 Set pool or vlan type mirror rule for a port::
1600 testpmd> set port (port_id) mirror-rule (rule_id) \
1601 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1602 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1604 Set link mirror rule for a port::
1606 testpmd> set port (port_id) mirror-rule (rule_id) \
1607 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1609 For example to enable mirror traffic with vlan 0,1 to pool 0::
1611 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1613 reset port - mirror rule
1614 ~~~~~~~~~~~~~~~~~~~~~~~~
1616 Reset a mirror rule for a port::
1618 testpmd> reset port (port_id) mirror-rule (rule_id)
1623 Set the flush on RX streams before forwarding.
1624 The default is flush ``on``.
1625 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1627 testpmd> set flush_rx off
1632 Set the bypass mode for the lowest port on bypass enabled NIC::
1634 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1639 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1641 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1642 mode (normal|bypass|isolate) (port_id)
1646 * ``timeout``: Enable bypass after watchdog timeout.
1648 * ``os_on``: Enable bypass when OS/board is powered on.
1650 * ``os_off``: Enable bypass when OS/board is powered off.
1652 * ``power_on``: Enable bypass when power supply is turned on.
1654 * ``power_off``: Enable bypass when power supply is turned off.
1660 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1662 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1667 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1669 testpmd> show bypass config (port_id)
1674 Set link up for a port::
1676 testpmd> set link-up port (port id)
1681 Set link down for a port::
1683 testpmd> set link-down port (port id)
1688 Enable E-tag insertion for a VF on a port::
1690 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1692 Disable E-tag insertion for a VF on a port::
1694 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1696 Enable/disable E-tag stripping on a port::
1698 testpmd> E-tag set stripping (on|off) port (port_id)
1700 Enable/disable E-tag based forwarding on a port::
1702 testpmd> E-tag set forwarding (on|off) port (port_id)
1704 Add an E-tag forwarding filter on a port::
1706 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1708 Delete an E-tag forwarding filter on a port::
1709 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1714 Load a dynamic device personalization (DDP) profile and store backup profile::
1716 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1721 Delete a dynamic device personalization profile and restore backup profile::
1723 testpmd> ddp del (port_id) (backup_profile_path)
1728 List all items from the ptype mapping table::
1730 testpmd> ptype mapping get (port_id) (valid_only)
1734 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1736 Replace a specific or a group of software defined ptype with a new one::
1738 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1742 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1744 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1746 * ``pkt_type``: The new software ptype to replace the old ones.
1748 Update hardware defined ptype to software defined packet type mapping table::
1750 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1754 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1756 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1758 Reset ptype mapping table::
1760 testpmd> ptype mapping reset (port_id)
1762 config per port Rx offloading
1763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1765 Enable or disable a per port Rx offloading on all Rx queues of a port::
1767 testpmd> port config (port_id) rx_offload (offloading) on|off
1769 * ``offloading``: can be any of these offloading capability:
1770 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1771 qinq_strip, outer_ipv4_cksum, macsec_strip,
1772 header_split, vlan_filter, vlan_extend, jumbo_frame,
1773 scatter, timestamp, security, keep_crc, rss_hash
1775 This command should be run when the port is stopped, or else it will fail.
1777 config per queue Rx offloading
1778 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1780 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1782 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1784 * ``offloading``: can be any of these offloading capability:
1785 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1786 qinq_strip, outer_ipv4_cksum, macsec_strip,
1787 header_split, vlan_filter, vlan_extend, jumbo_frame,
1788 scatter, timestamp, security, keep_crc
1790 This command should be run when the port is stopped, or else it will fail.
1792 config per port Tx offloading
1793 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1795 Enable or disable a per port Tx offloading on all Tx queues of a port::
1797 testpmd> port config (port_id) tx_offload (offloading) on|off
1799 * ``offloading``: can be any of these offloading capability:
1800 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1801 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1802 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1803 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1804 mt_lockfree, multi_segs, mbuf_fast_free, security
1806 This command should be run when the port is stopped, or else it will fail.
1808 config per queue Tx offloading
1809 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1811 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1813 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1815 * ``offloading``: can be any of these offloading capability:
1816 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1817 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1818 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1819 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1820 mt_lockfree, multi_segs, mbuf_fast_free, security
1822 This command should be run when the port is stopped, or else it will fail.
1824 Config VXLAN Encap outer layers
1825 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1827 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1829 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1830 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1833 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1834 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1835 eth-src (eth-src) eth-dst (eth-dst)
1837 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1838 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1839 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1841 These commands will set an internal configuration inside testpmd, any following
1842 flow rule using the action vxlan_encap will use the last configuration set.
1843 To have a different encapsulation header, one of those commands must be called
1844 before the flow rule creation.
1846 Config NVGRE Encap outer layers
1847 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1849 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1851 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1852 eth-src (eth-src) eth-dst (eth-dst)
1853 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1854 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1856 These commands will set an internal configuration inside testpmd, any following
1857 flow rule using the action nvgre_encap will use the last configuration set.
1858 To have a different encapsulation header, one of those commands must be called
1859 before the flow rule creation.
1864 Configure the l2 to be used when encapsulating a packet with L2::
1866 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1867 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1868 eth-src (eth-src) eth-dst (eth-dst)
1870 Those commands will set an internal configuration inside testpmd, any following
1871 flow rule using the action l2_encap will use the last configuration set.
1872 To have a different encapsulation header, one of those commands must be called
1873 before the flow rule creation.
1878 Configure the l2 to be removed when decapsulating a packet with L2::
1880 set l2_decap ip-version (ipv4|ipv6)
1881 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1883 Those commands will set an internal configuration inside testpmd, any following
1884 flow rule using the action l2_decap will use the last configuration set.
1885 To have a different encapsulation header, one of those commands must be called
1886 before the flow rule creation.
1888 Config MPLSoGRE Encap outer layers
1889 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1891 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1893 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1894 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1895 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1896 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1897 eth-src (eth-src) eth-dst (eth-dst)
1899 These commands will set an internal configuration inside testpmd, any following
1900 flow rule using the action mplsogre_encap will use the last configuration set.
1901 To have a different encapsulation header, one of those commands must be called
1902 before the flow rule creation.
1904 Config MPLSoGRE Decap outer layers
1905 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1907 Configure the outer layer to decapsulate MPLSoGRE packet::
1909 set mplsogre_decap ip-version (ipv4|ipv6)
1910 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1912 These commands will set an internal configuration inside testpmd, any following
1913 flow rule using the action mplsogre_decap will use the last configuration set.
1914 To have a different decapsulation header, one of those commands must be called
1915 before the flow rule creation.
1917 Config MPLSoUDP Encap outer layers
1918 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1920 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1922 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1923 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1924 eth-src (eth-src) eth-dst (eth-dst)
1925 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1926 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1927 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1929 These commands will set an internal configuration inside testpmd, any following
1930 flow rule using the action mplsoudp_encap will use the last configuration set.
1931 To have a different encapsulation header, one of those commands must be called
1932 before the flow rule creation.
1934 Config MPLSoUDP Decap outer layers
1935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1937 Configure the outer layer to decapsulate MPLSoUDP packet::
1939 set mplsoudp_decap ip-version (ipv4|ipv6)
1940 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1942 These commands will set an internal configuration inside testpmd, any following
1943 flow rule using the action mplsoudp_decap will use the last configuration set.
1944 To have a different decapsulation header, one of those commands must be called
1945 before the flow rule creation.
1947 Config Raw Encapsulation
1948 ~~~~~~~~~~~~~~~~~~~~~~~~~
1950 Configure the raw data to be used when encapsulating a packet by
1951 rte_flow_action_raw_encap::
1953 set raw_encap {index} {item} [/ {item} [...]] / end_set
1955 There are multiple global buffers for ``raw_encap``, this command will set one
1956 internal buffer index by ``{index}``.
1957 If there is no ``{index}`` specified::
1959 set raw_encap {item} [/ {item} [...]] / end_set
1961 the default index ``0`` is used.
1962 In order to use different encapsulating header, ``index`` must be specified
1963 during the flow rule creation::
1965 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1966 raw_encap index 2 / end
1968 Otherwise the default index ``0`` is used.
1970 Config Raw Decapsulation
1971 ~~~~~~~~~~~~~~~~~~~~~~~~
1973 Configure the raw data to be used when decapsulating a packet by
1974 rte_flow_action_raw_decap::
1976 set raw_decap {index} {item} [/ {item} [...]] / end_set
1978 There are multiple global buffers for ``raw_decap``, this command will set
1979 one internal buffer index by ``{index}``.
1980 If there is no ``{index}`` specified::
1982 set raw_decap {item} [/ {item} [...]] / end_set
1984 the default index ``0`` is used.
1985 In order to use different decapsulating header, ``index`` must be specified
1986 during the flow rule creation::
1988 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1989 raw_encap index 3 / end
1991 Otherwise the default index ``0`` is used.
1996 The following sections show functions for configuring ports.
2000 Port configuration changes only become active when forwarding is started/restarted.
2005 Attach a port specified by pci address or virtual device args::
2007 testpmd> port attach (identifier)
2009 To attach a new pci device, the device should be recognized by kernel first.
2010 Then it should be moved under DPDK management.
2011 Finally the port can be attached to testpmd.
2013 For example, to move a pci device using ixgbe under DPDK management:
2015 .. code-block:: console
2017 # Check the status of the available devices.
2018 ./usertools/dpdk-devbind.py --status
2020 Network devices using DPDK-compatible driver
2021 ============================================
2024 Network devices using kernel driver
2025 ===================================
2026 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2029 # Bind the device to igb_uio.
2030 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2033 # Recheck the status of the devices.
2034 ./usertools/dpdk-devbind.py --status
2035 Network devices using DPDK-compatible driver
2036 ============================================
2037 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2039 To attach a port created by virtual device, above steps are not needed.
2041 For example, to attach a port whose pci address is 0000:0a:00.0.
2043 .. code-block:: console
2045 testpmd> port attach 0000:0a:00.0
2046 Attaching a new port...
2047 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2048 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2049 EAL: PCI memory mapped at 0x7f83bfa00000
2050 EAL: PCI memory mapped at 0x7f83bfa80000
2051 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2052 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2053 Port 0 is attached. Now total ports is 1
2056 For example, to attach a port created by pcap PMD.
2058 .. code-block:: console
2060 testpmd> port attach net_pcap0
2061 Attaching a new port...
2062 PMD: Initializing pmd_pcap for net_pcap0
2063 PMD: Creating pcap-backed ethdev on numa socket 0
2064 Port 0 is attached. Now total ports is 1
2067 In this case, identifier is ``net_pcap0``.
2068 This identifier format is the same as ``--vdev`` format of DPDK applications.
2070 For example, to re-attach a bonded port which has been previously detached,
2071 the mode and slave parameters must be given.
2073 .. code-block:: console
2075 testpmd> port attach net_bond_0,mode=0,slave=1
2076 Attaching a new port...
2077 EAL: Initializing pmd_bond for net_bond_0
2078 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2079 Port 0 is attached. Now total ports is 1
2086 Detach a specific port::
2088 testpmd> port detach (port_id)
2090 Before detaching a port, the port should be stopped and closed.
2092 For example, to detach a pci device port 0.
2094 .. code-block:: console
2096 testpmd> port stop 0
2099 testpmd> port close 0
2103 testpmd> port detach 0
2105 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2106 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2107 EAL: PCI memory unmapped at 0x7f83bfa00000
2108 EAL: PCI memory unmapped at 0x7f83bfa80000
2112 For example, to detach a virtual device port 0.
2114 .. code-block:: console
2116 testpmd> port stop 0
2119 testpmd> port close 0
2123 testpmd> port detach 0
2125 PMD: Closing pcap ethdev on numa socket 0
2126 Port 'net_pcap0' is detached. Now total ports is 0
2129 To remove a pci device completely from the system, first detach the port from testpmd.
2130 Then the device should be moved under kernel management.
2131 Finally the device can be removed using kernel pci hotplug functionality.
2133 For example, to move a pci device under kernel management:
2135 .. code-block:: console
2137 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2139 ./usertools/dpdk-devbind.py --status
2141 Network devices using DPDK-compatible driver
2142 ============================================
2145 Network devices using kernel driver
2146 ===================================
2147 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2149 To remove a port created by a virtual device, above steps are not needed.
2154 Start all ports or a specific port::
2156 testpmd> port start (port_id|all)
2161 Stop all ports or a specific port::
2163 testpmd> port stop (port_id|all)
2168 Close all ports or a specific port::
2170 testpmd> port close (port_id|all)
2175 Reset all ports or a specific port::
2177 testpmd> port reset (port_id|all)
2179 User should stop port(s) before resetting and (re-)start after reset.
2181 port config - queue ring size
2182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2184 Configure a rx/tx queue ring size::
2186 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2188 Only take effect after command that (re-)start the port or command that setup specific queue.
2190 port start/stop queue
2191 ~~~~~~~~~~~~~~~~~~~~~
2193 Start/stop a rx/tx queue on a specific port::
2195 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2197 port config - queue deferred start
2198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2200 Switch on/off deferred start of a specific port queue::
2202 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2205 ~~~~~~~~~~~~~~~~~~~~~
2207 Setup a rx/tx queue on a specific port::
2209 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2211 Only take effect when port is started.
2216 Set the speed and duplex mode for all ports or a specific port::
2218 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2219 duplex (half|full|auto)
2221 port config - queues/descriptors
2222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2224 Set number of queues/descriptors for rxq, txq, rxd and txd::
2226 testpmd> port config all (rxq|txq|rxd|txd) (value)
2228 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2230 port config - max-pkt-len
2231 ~~~~~~~~~~~~~~~~~~~~~~~~~
2233 Set the maximum packet length::
2235 testpmd> port config all max-pkt-len (value)
2237 This is equivalent to the ``--max-pkt-len`` command-line option.
2239 port config - max-lro-pkt-size
2240 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2242 Set the maximum LRO aggregated packet size::
2244 testpmd> port config all max-lro-pkt-size (value)
2246 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2248 port config - Drop Packets
2249 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2251 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2253 testpmd> port config all drop-en (on|off)
2255 Packet dropping when no receive buffers available is off by default.
2257 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2262 Set the RSS (Receive Side Scaling) mode on or off::
2264 testpmd> port config all rss (all|default|eth|vlan|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|l2tpv3|esp|ah|pfcp|none)
2266 RSS is on by default.
2268 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2270 The ``default`` option enables all supported RSS types reported by device info.
2272 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2274 port config - RSS Reta
2275 ~~~~~~~~~~~~~~~~~~~~~~
2277 Set the RSS (Receive Side Scaling) redirection table::
2279 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2284 Set the DCB mode for an individual port::
2286 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2288 The traffic class should be 4 or 8.
2293 Set the number of packets per burst::
2295 testpmd> port config all burst (value)
2297 This is equivalent to the ``--burst`` command-line option.
2299 port config - Threshold
2300 ~~~~~~~~~~~~~~~~~~~~~~~
2302 Set thresholds for TX/RX queues::
2304 testpmd> port config all (threshold) (value)
2306 Where the threshold type can be:
2308 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2310 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2312 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2314 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2316 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2318 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2320 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2322 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2324 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2326 These threshold options are also available from the command-line.
2331 Set the value of ether-type for E-tag::
2333 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2335 Enable/disable the E-tag support::
2337 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2339 port config pctype mapping
2340 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2342 Reset pctype mapping table::
2344 testpmd> port config (port_id) pctype mapping reset
2346 Update hardware defined pctype to software defined flow type mapping table::
2348 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2352 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2354 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2356 port config input set
2357 ~~~~~~~~~~~~~~~~~~~~~
2359 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2361 testpmd> port config (port_id) pctype (pctype_id) \
2362 (hash_inset|fdir_inset|fdir_flx_inset) \
2363 (get|set|clear) field (field_idx)
2365 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2367 testpmd> port config (port_id) pctype (pctype_id) \
2368 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2372 * ``pctype_id``: hardware packet classification types.
2373 * ``field_idx``: hardware field index.
2375 port config udp_tunnel_port
2376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2378 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2380 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2382 port config tx_metadata
2383 ~~~~~~~~~~~~~~~~~~~~~~~
2385 Set Tx metadata value per port.
2386 testpmd will add this value to any Tx packet sent from this port::
2388 testpmd> port config (port_id) tx_metadata (value)
2393 Set/clear dynamic flag per port.
2394 testpmd will register this flag in the mbuf (same registration
2395 for both Tx and Rx). Then set/clear this flag for each Tx
2396 packet sent from this port. The set bit only works for Tx packet::
2398 testpmd> port config (port_id) dynf (name) (set|clear)
2403 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2405 testpmd> port config mtu (port_id) (value)
2407 port config rss hash key
2408 ~~~~~~~~~~~~~~~~~~~~~~~~
2410 To configure the RSS hash key used to compute the RSS
2411 hash of input [IP] packets received on port::
2413 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2414 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2415 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2416 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2417 ipv6-udp-ex <string of hex digits \
2418 (variable length, NIC dependent)>)
2423 The following sections show functions for device operations.
2428 Detach a device specified by pci address or virtual device args::
2430 testpmd> device detach (identifier)
2432 Before detaching a device associated with ports, the ports should be stopped and closed.
2434 For example, to detach a pci device whose address is 0002:03:00.0.
2436 .. code-block:: console
2438 testpmd> device detach 0002:03:00.0
2439 Removing a device...
2440 Port 1 is now closed
2441 EAL: Releasing pci mapped resource for 0002:03:00.0
2442 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2443 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2444 Device 0002:03:00.0 is detached
2445 Now total ports is 1
2447 For example, to detach a port created by pcap PMD.
2449 .. code-block:: console
2451 testpmd> device detach net_pcap0
2452 Removing a device...
2453 Port 0 is now closed
2454 Device net_pcap0 is detached
2455 Now total ports is 0
2458 In this case, identifier is ``net_pcap0``.
2459 This identifier format is the same as ``--vdev`` format of DPDK applications.
2461 Link Bonding Functions
2462 ----------------------
2464 The Link Bonding functions make it possible to dynamically create and
2465 manage link bonding devices from within testpmd interactive prompt.
2467 create bonded device
2468 ~~~~~~~~~~~~~~~~~~~~
2470 Create a new bonding device::
2472 testpmd> create bonded device (mode) (socket)
2474 For example, to create a bonded device in mode 1 on socket 0::
2476 testpmd> create bonded device 1 0
2477 created new bonded device (port X)
2482 Adds Ethernet device to a Link Bonding device::
2484 testpmd> add bonding slave (slave id) (port id)
2486 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2488 testpmd> add bonding slave 6 10
2491 remove bonding slave
2492 ~~~~~~~~~~~~~~~~~~~~
2494 Removes an Ethernet slave device from a Link Bonding device::
2496 testpmd> remove bonding slave (slave id) (port id)
2498 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2500 testpmd> remove bonding slave 6 10
2505 Set the Link Bonding mode of a Link Bonding device::
2507 testpmd> set bonding mode (value) (port id)
2509 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2511 testpmd> set bonding mode 3 10
2516 Set an Ethernet slave device as the primary device on a Link Bonding device::
2518 testpmd> set bonding primary (slave id) (port id)
2520 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2522 testpmd> set bonding primary 6 10
2527 Set the MAC address of a Link Bonding device::
2529 testpmd> set bonding mac (port id) (mac)
2531 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2533 testpmd> set bonding mac 10 00:00:00:00:00:01
2535 set bonding xmit_balance_policy
2536 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2538 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2540 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2542 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2544 testpmd> set bonding xmit_balance_policy 10 l34
2547 set bonding mon_period
2548 ~~~~~~~~~~~~~~~~~~~~~~
2550 Set the link status monitoring polling period in milliseconds for a bonding device.
2552 This adds support for PMD slave devices which do not support link status interrupts.
2553 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2554 link status ISR will be queried every polling interval to check if their link status has changed::
2556 testpmd> set bonding mon_period (port_id) (value)
2558 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2560 testpmd> set bonding mon_period 5 150
2563 set bonding lacp dedicated_queue
2564 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2566 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2567 when in mode 4 (link-aggregation-802.3ad)::
2569 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2572 set bonding agg_mode
2573 ~~~~~~~~~~~~~~~~~~~~
2575 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2577 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2583 Show the current configuration of a Link Bonding device::
2585 testpmd> show bonding config (port id)
2588 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2589 in balance mode with a transmission policy of layer 2+3::
2591 testpmd> show bonding config 9
2593 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2595 Active Slaves (3): [1 3 4]
2602 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2603 This is mainly useful for debugging purposes.
2604 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2605 and fields that can be accessed.
2610 Display the value of a port register::
2612 testpmd> read reg (port_id) (address)
2614 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2616 testpmd> read reg 0 0xEE00
2617 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2622 Display a port register bit field::
2624 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2626 For example, reading the lowest two bits from the register in the example above::
2628 testpmd> read regfield 0 0xEE00 0 1
2629 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2634 Display a single port register bit::
2636 testpmd> read regbit (port_id) (address) (bit_x)
2638 For example, reading the lowest bit from the register in the example above::
2640 testpmd> read regbit 0 0xEE00 0
2641 port 0 PCI register at offset 0xEE00: bit 0=1
2646 Set the value of a port register::
2648 testpmd> write reg (port_id) (address) (value)
2650 For example, to clear a register::
2652 testpmd> write reg 0 0xEE00 0x0
2653 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2658 Set bit field of a port register::
2660 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2662 For example, writing to the register cleared in the example above::
2664 testpmd> write regfield 0 0xEE00 0 1 2
2665 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2670 Set single bit value of a port register::
2672 testpmd> write regbit (port_id) (address) (bit_x) (value)
2674 For example, to set the high bit in the register from the example above::
2676 testpmd> write regbit 0 0xEE00 31 1
2677 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2679 Traffic Metering and Policing
2680 -----------------------------
2682 The following section shows functions for configuring traffic metering and
2683 policing on the ethernet device through the use of generic ethdev API.
2685 show port traffic management capability
2686 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2688 Show traffic metering and policing capability of the port::
2690 testpmd> show port meter cap (port_id)
2692 add port meter profile (srTCM rfc2967)
2693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2695 Add meter profile (srTCM rfc2697) to the ethernet device::
2697 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2702 * ``profile_id``: ID for the meter profile.
2703 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2704 * ``cbs``: Committed Burst Size (CBS) (bytes).
2705 * ``ebs``: Excess Burst Size (EBS) (bytes).
2707 add port meter profile (trTCM rfc2968)
2708 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2710 Add meter profile (srTCM rfc2698) to the ethernet device::
2712 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2713 (cir) (pir) (cbs) (pbs)
2717 * ``profile_id``: ID for the meter profile.
2718 * ``cir``: Committed information rate (bytes/second).
2719 * ``pir``: Peak information rate (bytes/second).
2720 * ``cbs``: Committed burst size (bytes).
2721 * ``pbs``: Peak burst size (bytes).
2723 add port meter profile (trTCM rfc4115)
2724 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2726 Add meter profile (trTCM rfc4115) to the ethernet device::
2728 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2729 (cir) (eir) (cbs) (ebs)
2733 * ``profile_id``: ID for the meter profile.
2734 * ``cir``: Committed information rate (bytes/second).
2735 * ``eir``: Excess information rate (bytes/second).
2736 * ``cbs``: Committed burst size (bytes).
2737 * ``ebs``: Excess burst size (bytes).
2739 delete port meter profile
2740 ~~~~~~~~~~~~~~~~~~~~~~~~~
2742 Delete meter profile from the ethernet device::
2744 testpmd> del port meter profile (port_id) (profile_id)
2749 Create new meter object for the ethernet device::
2751 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2752 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2753 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2758 * ``mtr_id``: meter object ID.
2759 * ``profile_id``: ID for the meter profile.
2760 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2761 gets enabled at the time of creation, otherwise remains disabled.
2762 * ``g_action``: Policer action for the packet with green color.
2763 * ``y_action``: Policer action for the packet with yellow color.
2764 * ``r_action``: Policer action for the packet with red color.
2765 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2767 * ``shared``: When this parameter has a non-zero value, the meter object is
2768 shared by multiple flows. Otherwise, meter object is used by single flow.
2769 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2770 input color for the current meter object is determined by the latest meter
2771 object in the same flow. Otherwise, the current meter object uses the
2772 *dscp_table* to determine the input color.
2773 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2774 color, 0 <= x <= 63.
2779 Enable meter for the ethernet device::
2781 testpmd> enable port meter (port_id) (mtr_id)
2786 Disable meter for the ethernet device::
2788 testpmd> disable port meter (port_id) (mtr_id)
2793 Delete meter for the ethernet device::
2795 testpmd> del port meter (port_id) (mtr_id)
2797 Set port meter profile
2798 ~~~~~~~~~~~~~~~~~~~~~~
2800 Set meter profile for the ethernet device::
2802 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2804 set port meter dscp table
2805 ~~~~~~~~~~~~~~~~~~~~~~~~~
2807 Set meter dscp table for the ethernet device::
2809 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2810 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2812 set port meter policer action
2813 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2815 Set meter policer action for the ethernet device::
2817 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2818 (action0) [(action1) (action1)]
2822 * ``action_mask``: Bit mask indicating which policer actions need to be
2823 updated. One or more policer actions can be updated in a single function
2824 invocation. To update the policer action associated with color C, bit
2825 (1 << C) needs to be set in *action_mask* and element at position C
2826 in the *actions* array needs to be valid.
2827 * ``actionx``: Policer action for the color x,
2828 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2830 set port meter stats mask
2831 ~~~~~~~~~~~~~~~~~~~~~~~~~
2833 Set meter stats mask for the ethernet device::
2835 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2839 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2841 show port meter stats
2842 ~~~~~~~~~~~~~~~~~~~~~
2844 Show meter stats of the ethernet device::
2846 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2850 * ``clear``: Flag that indicates whether the statistics counters should
2851 be cleared (i.e. set to zero) immediately after they have been read or not.
2856 The following section shows functions for configuring traffic management on
2857 the ethernet device through the use of generic TM API.
2859 show port traffic management capability
2860 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2862 Show traffic management capability of the port::
2864 testpmd> show port tm cap (port_id)
2866 show port traffic management capability (hierarchy level)
2867 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2869 Show traffic management hierarchy level capability of the port::
2871 testpmd> show port tm level cap (port_id) (level_id)
2873 show port traffic management capability (hierarchy node level)
2874 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2876 Show the traffic management hierarchy node capability of the port::
2878 testpmd> show port tm node cap (port_id) (node_id)
2880 show port traffic management hierarchy node type
2881 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2883 Show the port traffic management hierarchy node type::
2885 testpmd> show port tm node type (port_id) (node_id)
2887 show port traffic management hierarchy node stats
2888 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2890 Show the port traffic management hierarchy node statistics::
2892 testpmd> show port tm node stats (port_id) (node_id) (clear)
2896 * ``clear``: When this parameter has a non-zero value, the statistics counters
2897 are cleared (i.e. set to zero) immediately after they have been read,
2898 otherwise the statistics counters are left untouched.
2900 Add port traffic management private shaper profile
2901 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2903 Add the port traffic management private shaper profile::
2905 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2906 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2907 (packet_length_adjust)
2911 * ``shaper_profile id``: Shaper profile ID for the new profile.
2912 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2913 * ``cmit_tb_size``: Committed token bucket size (bytes).
2914 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2915 * ``peak_tb_size``: Peak token bucket size (bytes).
2916 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2917 each packet for the purpose of shaping. This parameter value can be used to
2918 correct the packet length with the framing overhead bytes that are consumed
2921 Delete port traffic management private shaper profile
2922 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2924 Delete the port traffic management private shaper::
2926 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2930 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2932 Add port traffic management shared shaper
2933 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2935 Create the port traffic management shared shaper::
2937 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2942 * ``shared_shaper_id``: Shared shaper ID to be created.
2943 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2945 Set port traffic management shared shaper
2946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2948 Update the port traffic management shared shaper::
2950 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2955 * ``shared_shaper_id``: Shared shaper ID to be update.
2956 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2958 Delete port traffic management shared shaper
2959 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2961 Delete the port traffic management shared shaper::
2963 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2967 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2969 Set port traffic management hierarchy node private shaper
2970 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2972 set the port traffic management hierarchy node private shaper::
2974 testpmd> set port tm node shaper profile (port_id) (node_id) \
2979 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2982 Add port traffic management WRED profile
2983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2985 Create a new WRED profile::
2987 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2988 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2989 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2990 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2994 * ``wred_profile id``: Identifier for the newly create WRED profile
2995 * ``color_g``: Packet color (green)
2996 * ``min_th_g``: Minimum queue threshold for packet with green color
2997 * ``max_th_g``: Minimum queue threshold for packet with green color
2998 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2999 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3000 * ``color_y``: Packet color (yellow)
3001 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3002 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3003 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3004 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3005 * ``color_r``: Packet color (red)
3006 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3007 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3008 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3009 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3011 Delete port traffic management WRED profile
3012 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3014 Delete the WRED profile::
3016 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3018 Add port traffic management hierarchy nonleaf node
3019 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3021 Add nonleaf node to port traffic management hierarchy::
3023 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3024 (priority) (weight) (level_id) (shaper_profile_id) \
3025 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3026 [(shared_shaper_0) (shared_shaper_1) ...] \
3030 * ``parent_node_id``: Node ID of the parent.
3031 * ``priority``: Node priority (highest node priority is zero). This is used by
3032 the SP algorithm running on the parent node for scheduling this node.
3033 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3034 to the weight sum of all siblings that have the same priority. It is used by
3035 the WFQ algorithm running on the parent node for scheduling this node.
3036 * ``level_id``: Hierarchy level of the node.
3037 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3039 * ``n_sp_priorities``: Number of strict priorities.
3040 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3041 * ``n_shared_shapers``: Number of shared shapers.
3042 * ``shared_shaper_id``: Shared shaper id.
3044 Add port traffic management hierarchy leaf node
3045 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3047 Add leaf node to port traffic management hierarchy::
3049 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3050 (priority) (weight) (level_id) (shaper_profile_id) \
3051 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3052 [(shared_shaper_id) (shared_shaper_id) ...] \
3056 * ``parent_node_id``: Node ID of the parent.
3057 * ``priority``: Node priority (highest node priority is zero). This is used by
3058 the SP algorithm running on the parent node for scheduling this node.
3059 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3060 to the weight sum of all siblings that have the same priority. It is used by
3061 the WFQ algorithm running on the parent node for scheduling this node.
3062 * ``level_id``: Hierarchy level of the node.
3063 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3065 * ``cman_mode``: Congestion management mode to be enabled for this node.
3066 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3067 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3068 * ``n_shared_shapers``: Number of shared shapers.
3069 * ``shared_shaper_id``: Shared shaper id.
3071 Delete port traffic management hierarchy node
3072 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3074 Delete node from port traffic management hierarchy::
3076 testpmd> del port tm node (port_id) (node_id)
3078 Update port traffic management hierarchy parent node
3079 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3081 Update port traffic management hierarchy parent node::
3083 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3086 This function can only be called after the hierarchy commit invocation. Its
3087 success depends on the port support for this operation, as advertised through
3088 the port capability set. This function is valid for all nodes of the traffic
3089 management hierarchy except root node.
3091 Suspend port traffic management hierarchy node
3092 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3094 testpmd> suspend port tm node (port_id) (node_id)
3096 Resume port traffic management hierarchy node
3097 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3099 testpmd> resume port tm node (port_id) (node_id)
3101 Commit port traffic management hierarchy
3102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3104 Commit the traffic management hierarchy on the port::
3106 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3110 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3111 call failure. On the other hand, hierarchy is preserved when this parameter
3114 Set port traffic management mark VLAN dei
3115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3117 Enables/Disables the traffic management marking on the port for VLAN packets::
3119 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3123 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3124 ``yellow`` or ``red`` will have dei bit enabled
3126 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3128 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3130 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3132 Set port traffic management mark IP dscp
3133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3135 Enables/Disables the traffic management marking on the port for IP dscp packets::
3137 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3141 * ``port_id``: The port which on which IP packets marked as ``green`` or
3142 ``yellow`` or ``red`` will have IP dscp bits updated
3144 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3146 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3148 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3150 Set port traffic management mark IP ecn
3151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3153 Enables/Disables the traffic management marking on the port for IP ecn packets::
3155 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3159 * ``port_id``: The port which on which IP packets marked as ``green`` or
3160 ``yellow`` or ``red`` will have IP ecn bits updated
3162 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3163 to ecn of 2'b11 when IP is caring TCP or SCTP
3165 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3166 to ecn of 2'b11 when IP is caring TCP or SCTP
3168 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3169 to ecn of 2'b11 when IP is caring TCP or SCTP
3174 This section details the available filter functions that are available.
3176 Note these functions interface the deprecated legacy filtering framework,
3177 superseded by *rte_flow*. See `Flow rules management`_.
3180 ~~~~~~~~~~~~~~~~~~~~
3182 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3184 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3185 ethertype (ether_type) (drop|fwd) queue (queue_id)
3187 The available information parameters are:
3189 * ``port_id``: The port which the Ethertype filter assigned on.
3191 * ``mac_addr``: Compare destination mac address.
3193 * ``mac_ignr``: Ignore destination mac address match.
3195 * ``mac_address``: Destination mac address to match.
3197 * ``ether_type``: The EtherType value want to match,
3198 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3200 * ``queue_id``: The receive queue associated with this EtherType filter.
3201 It is meaningless when deleting or dropping.
3203 Example, to add/remove an ethertype filter rule::
3205 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3206 ethertype 0x0806 fwd queue 3
3208 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3209 ethertype 0x0806 fwd queue 3
3214 Add or delete a 2-tuple filter,
3215 which identifies packets by specific protocol and destination TCP/UDP port
3216 and forwards packets into one of the receive queues::
3218 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3219 protocol (protocol_value) mask (mask_value) \
3220 tcp_flags (tcp_flags_value) priority (prio_value) \
3223 The available information parameters are:
3225 * ``port_id``: The port which the 2-tuple filter assigned on.
3227 * ``dst_port_value``: Destination port in L4.
3229 * ``protocol_value``: IP L4 protocol.
3231 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3233 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3235 * ``prio_value``: Priority of this filter.
3237 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3239 Example, to add/remove an 2tuple filter rule::
3241 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3242 tcp_flags 0x02 priority 3 queue 3
3244 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3245 tcp_flags 0x02 priority 3 queue 3
3250 Add or delete a 5-tuple filter,
3251 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3252 and routes packets into one of the receive queues::
3254 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3255 (src_address) dst_port (dst_port_value) \
3256 src_port (src_port_value) protocol (protocol_value) \
3257 mask (mask_value) tcp_flags (tcp_flags_value) \
3258 priority (prio_value) queue (queue_id)
3260 The available information parameters are:
3262 * ``port_id``: The port which the 5-tuple filter assigned on.
3264 * ``dst_address``: Destination IP address.
3266 * ``src_address``: Source IP address.
3268 * ``dst_port_value``: TCP/UDP destination port.
3270 * ``src_port_value``: TCP/UDP source port.
3272 * ``protocol_value``: L4 protocol.
3274 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3276 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3278 * ``prio_value``: The priority of this filter.
3280 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3282 Example, to add/remove an 5tuple filter rule::
3284 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3285 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3286 flags 0x0 priority 3 queue 3
3288 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3289 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3290 flags 0x0 priority 3 queue 3
3295 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3297 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3299 The available information parameters are:
3301 * ``port_id``: The port which the SYN filter assigned on.
3303 * ``high``: This SYN filter has higher priority than other filters.
3305 * ``low``: This SYN filter has lower priority than other filters.
3307 * ``queue_id``: The receive queue associated with this SYN filter
3311 testpmd> syn_filter 0 add priority high queue 3
3316 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3317 and routed into one of the receive queues::
3319 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3320 mask (mask_value) priority (prio_value) queue (queue_id)
3322 The available information parameters are:
3324 * ``port_id``: The port which the Flex filter is assigned on.
3326 * ``len_value``: Filter length in bytes, no greater than 128.
3328 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3330 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3332 * ``prio_value``: The priority of this filter.
3334 * ``queue_id``: The receive queue associated with this Flex filter.
3338 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3339 mask 000C priority 3 queue 3
3341 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3342 mask 000C priority 3 queue 3
3345 .. _testpmd_flow_director:
3347 flow_director_filter
3348 ~~~~~~~~~~~~~~~~~~~~
3350 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3352 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3353 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3355 * Perfect match filters.
3356 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3357 The masked fields are for IP flow.
3359 * Signature filters.
3360 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3362 * Perfect-mac-vlan match filters.
3363 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3364 The masked fields are for MAC VLAN flow.
3366 * Perfect-tunnel match filters.
3367 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3368 The masked fields are for tunnel flow.
3370 * Perfect-raw-flow-type match filters.
3371 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3372 The masked fields are specified by input sets.
3374 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3375 per flow type and the flexible payload.
3377 The Flow Director can also mask out parts of all of these fields so that filters
3378 are only applied to certain fields or parts of the fields.
3380 Note that for raw flow type mode the source and destination fields in the
3381 raw packet buffer need to be presented in a reversed order with respect
3382 to the expected received packets.
3383 For example: IP source and destination addresses or TCP/UDP/SCTP
3384 source and destination ports
3386 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3388 # Commands to add flow director filters of different flow types::
3390 flow_director_filter (port_id) mode IP (add|del|update) \
3391 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3392 src (src_ip_address) dst (dst_ip_address) \
3393 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3394 vlan (vlan_value) flexbytes (flexbytes_value) \
3395 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3398 flow_director_filter (port_id) mode IP (add|del|update) \
3399 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3400 src (src_ip_address) (src_port) \
3401 dst (dst_ip_address) (dst_port) \
3402 tos (tos_value) ttl (ttl_value) \
3403 vlan (vlan_value) flexbytes (flexbytes_value) \
3404 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3407 flow_director_filter (port_id) mode IP (add|del|update) \
3408 flow (ipv4-sctp|ipv6-sctp) \
3409 src (src_ip_address) (src_port) \
3410 dst (dst_ip_address) (dst_port) \
3411 tos (tos_value) ttl (ttl_value) \
3412 tag (verification_tag) vlan (vlan_value) \
3413 flexbytes (flexbytes_value) (drop|fwd) \
3414 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3416 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3417 ether (ethertype) flexbytes (flexbytes_value) \
3418 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3421 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3422 mac (mac_address) vlan (vlan_value) \
3423 flexbytes (flexbytes_value) (drop|fwd) \
3424 queue (queue_id) fd_id (fd_id_value)
3426 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3427 mac (mac_address) vlan (vlan_value) \
3428 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3429 flexbytes (flexbytes_value) (drop|fwd) \
3430 queue (queue_id) fd_id (fd_id_value)
3432 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3433 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3434 packet (packet file name)
3436 For example, to add an ipv4-udp flow type filter::
3438 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3439 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3440 fwd pf queue 1 fd_id 1
3442 For example, add an ipv4-other flow type filter::
3444 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3445 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3446 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3451 Flush all flow director filters on a device::
3453 testpmd> flush_flow_director (port_id)
3455 Example, to flush all flow director filter on port 0::
3457 testpmd> flush_flow_director 0
3462 Set flow director's input masks::
3464 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3465 src_mask (ipv4_src) (ipv6_src) (src_port) \
3466 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3468 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3470 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3471 mac (mac_value) tunnel-type (tunnel_type_value) \
3472 tunnel-id (tunnel_id_value)
3474 Example, to set flow director mask on port 0::
3476 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3477 src_mask 255.255.255.255 \
3478 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3479 dst_mask 255.255.255.255 \
3480 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3482 flow_director_flex_mask
3483 ~~~~~~~~~~~~~~~~~~~~~~~
3485 set masks of flow director's flexible payload based on certain flow type::
3487 testpmd> flow_director_flex_mask (port_id) \
3488 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3489 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3490 l2_payload|all) (mask)
3492 Example, to set flow director's flex mask for all flow type on port 0::
3494 testpmd> flow_director_flex_mask 0 flow all \
3495 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3498 flow_director_flex_payload
3499 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3501 Configure flexible payload selection::
3503 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3505 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3507 testpmd> flow_director_flex_payload 0 l4 \
3508 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3510 get_sym_hash_ena_per_port
3511 ~~~~~~~~~~~~~~~~~~~~~~~~~
3513 Get symmetric hash enable configuration per port::
3515 get_sym_hash_ena_per_port (port_id)
3517 For example, to get symmetric hash enable configuration of port 1::
3519 testpmd> get_sym_hash_ena_per_port 1
3521 set_sym_hash_ena_per_port
3522 ~~~~~~~~~~~~~~~~~~~~~~~~~
3524 Set symmetric hash enable configuration per port to enable or disable::
3526 set_sym_hash_ena_per_port (port_id) (enable|disable)
3528 For example, to set symmetric hash enable configuration of port 1 to enable::
3530 testpmd> set_sym_hash_ena_per_port 1 enable
3532 get_hash_global_config
3533 ~~~~~~~~~~~~~~~~~~~~~~
3535 Get the global configurations of hash filters::
3537 get_hash_global_config (port_id)
3539 For example, to get the global configurations of hash filters of port 1::
3541 testpmd> get_hash_global_config 1
3543 set_hash_global_config
3544 ~~~~~~~~~~~~~~~~~~~~~~
3546 Set the global configurations of hash filters::
3548 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3549 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3550 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3553 For example, to enable simple_xor for flow type of ipv6 on port 2::
3555 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3560 Set the input set for hash::
3562 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3563 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3564 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3565 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3566 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3567 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3568 fld-8th|none) (select|add)
3570 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3572 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3577 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3578 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3580 Set the input set for flow director::
3582 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3583 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3584 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3585 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3586 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3587 sctp-dst-port|sctp-veri-tag|none) (select|add)
3589 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3591 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3596 Set different GRE key length for input set::
3598 global_config (port_id) gre-key-len (number in bytes)
3600 For example to set GRE key length for input set to 4 bytes on port 0::
3602 testpmd> global_config 0 gre-key-len 4
3605 .. _testpmd_rte_flow:
3607 Flow rules management
3608 ---------------------
3610 Control of the generic flow API (*rte_flow*) is fully exposed through the
3611 ``flow`` command (validation, creation, destruction, queries and operation
3614 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3615 features simultaneously may cause undefined side-effects and is therefore
3621 Because the ``flow`` command uses dynamic tokens to handle the large number
3622 of possible flow rules combinations, its behavior differs slightly from
3623 other commands, in particular:
3625 - Pressing *?* or the *<tab>* key displays contextual help for the current
3626 token, not that of the entire command.
3628 - Optional and repeated parameters are supported (provided they are listed
3629 in the contextual help).
3631 The first parameter stands for the operation mode. Possible operations and
3632 their general syntax are described below. They are covered in detail in the
3635 - Check whether a flow rule can be created::
3637 flow validate {port_id}
3638 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3639 pattern {item} [/ {item} [...]] / end
3640 actions {action} [/ {action} [...]] / end
3642 - Create a flow rule::
3644 flow create {port_id}
3645 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3646 pattern {item} [/ {item} [...]] / end
3647 actions {action} [/ {action} [...]] / end
3649 - Destroy specific flow rules::
3651 flow destroy {port_id} rule {rule_id} [...]
3653 - Destroy all flow rules::
3655 flow flush {port_id}
3657 - Query an existing flow rule::
3659 flow query {port_id} {rule_id} {action}
3661 - List existing flow rules sorted by priority, filtered by group
3664 flow list {port_id} [group {group_id}] [...]
3666 - Restrict ingress traffic to the defined flow rules::
3668 flow isolate {port_id} {boolean}
3670 - Dump internal representation information of all flows in hardware::
3672 flow dump {port_id} {output_file}
3674 - List and destroy aged flow rules::
3676 flow aged {port_id} [destroy]
3678 Validating flow rules
3679 ~~~~~~~~~~~~~~~~~~~~~
3681 ``flow validate`` reports whether a flow rule would be accepted by the
3682 underlying device in its current state but stops short of creating it. It is
3683 bound to ``rte_flow_validate()``::
3685 flow validate {port_id}
3686 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3687 pattern {item} [/ {item} [...]] / end
3688 actions {action} [/ {action} [...]] / end
3690 If successful, it will show::
3694 Otherwise it will show an error message of the form::
3696 Caught error type [...] ([...]): [...]
3698 This command uses the same parameters as ``flow create``, their format is
3699 described in `Creating flow rules`_.
3701 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3702 index 6 is supported::
3704 testpmd> flow validate 0 ingress pattern eth / end
3705 actions queue index 6 / end
3709 Port 0 does not support TCPv6 rules::
3711 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3713 Caught error type 9 (specific pattern item): Invalid argument
3719 ``flow create`` validates and creates the specified flow rule. It is bound
3720 to ``rte_flow_create()``::
3722 flow create {port_id}
3723 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3724 pattern {item} [/ {item} [...]] / end
3725 actions {action} [/ {action} [...]] / end
3727 If successful, it will return a flow rule ID usable with other commands::
3729 Flow rule #[...] created
3731 Otherwise it will show an error message of the form::
3733 Caught error type [...] ([...]): [...]
3735 Parameters describe in the following order:
3737 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3738 - A matching pattern, starting with the *pattern* token and terminated by an
3740 - Actions, starting with the *actions* token and terminated by an *end*
3743 These translate directly to *rte_flow* objects provided as-is to the
3744 underlying functions.
3746 The shortest valid definition only comprises mandatory tokens::
3748 testpmd> flow create 0 pattern end actions end
3750 Note that PMDs may refuse rules that essentially do nothing such as this
3753 **All unspecified object values are automatically initialized to 0.**
3758 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3759 specified before the ``pattern`` token.
3761 - ``group {group id}``: priority group.
3762 - ``priority {level}``: priority level within group.
3763 - ``ingress``: rule applies to ingress traffic.
3764 - ``egress``: rule applies to egress traffic.
3765 - ``transfer``: apply rule directly to endpoints found in pattern.
3767 Each instance of an attribute specified several times overrides the previous
3768 value as shown below (group 4 is used)::
3770 testpmd> flow create 0 group 42 group 24 group 4 [...]
3772 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3774 While not specifying a direction is an error, some rules may allow both
3777 Most rules affect RX therefore contain the ``ingress`` token::
3779 testpmd> flow create 0 ingress pattern [...]
3784 A matching pattern starts after the ``pattern`` token. It is made of pattern
3785 items and is terminated by a mandatory ``end`` item.
3787 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3788 rte_flow_item_type``).
3790 The ``/`` token is used as a separator between pattern items as shown
3793 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3795 Note that protocol items like these must be stacked from lowest to highest
3796 layer to make sense. For instance, the following rule is either invalid or
3797 unlikely to match any packet::
3799 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3801 More information on these restrictions can be found in the *rte_flow*
3804 Several items support additional specification structures, for example
3805 ``ipv4`` allows specifying source and destination addresses as follows::
3807 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3808 dst is 10.2.0.0 / end [...]
3810 This rule matches all IPv4 traffic with the specified properties.
3812 In this example, ``src`` and ``dst`` are field names of the underlying
3813 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3814 in a similar fashion.
3816 The ``is`` token means that the subsequent value must be matched exactly,
3817 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3818 accordingly. Possible assignment tokens are:
3820 - ``is``: match value perfectly (with full bit-mask).
3821 - ``spec``: match value according to configured bit-mask.
3822 - ``last``: specify upper bound to establish a range.
3823 - ``mask``: specify bit-mask with relevant bits set to one.
3824 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3826 These yield identical results::
3828 ipv4 src is 10.1.1.1
3832 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3836 ipv4 src spec 10.1.1.1 src prefix 32
3840 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3844 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3846 Inclusive ranges can be defined with ``last``::
3848 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3850 Note that ``mask`` affects both ``spec`` and ``last``::
3852 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3853 # matches 10.1.0.0 to 10.2.255.255
3855 Properties can be modified multiple times::
3857 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3861 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3866 This section lists supported pattern items and their attributes, if any.
3868 - ``end``: end list of pattern items.
3870 - ``void``: no-op pattern item.
3872 - ``invert``: perform actions when pattern does not match.
3874 - ``any``: match any protocol for the current layer.
3876 - ``num {unsigned}``: number of layers covered.
3878 - ``pf``: match traffic from/to the physical function.
3880 - ``vf``: match traffic from/to a virtual function ID.
3882 - ``id {unsigned}``: VF ID.
3884 - ``phy_port``: match traffic from/to a specific physical port.
3886 - ``index {unsigned}``: physical port index.
3888 - ``port_id``: match traffic from/to a given DPDK port ID.
3890 - ``id {unsigned}``: DPDK port ID.
3892 - ``mark``: match value set in previously matched flow rule using the mark action.
3894 - ``id {unsigned}``: arbitrary integer value.
3896 - ``raw``: match an arbitrary byte string.
3898 - ``relative {boolean}``: look for pattern after the previous item.
3899 - ``search {boolean}``: search pattern from offset (see also limit).
3900 - ``offset {integer}``: absolute or relative offset for pattern.
3901 - ``limit {unsigned}``: search area limit for start of pattern.
3902 - ``pattern {string}``: byte string to look for.
3904 - ``eth``: match Ethernet header.
3906 - ``dst {MAC-48}``: destination MAC.
3907 - ``src {MAC-48}``: source MAC.
3908 - ``type {unsigned}``: EtherType or TPID.
3910 - ``vlan``: match 802.1Q/ad VLAN tag.
3912 - ``tci {unsigned}``: tag control information.
3913 - ``pcp {unsigned}``: priority code point.
3914 - ``dei {unsigned}``: drop eligible indicator.
3915 - ``vid {unsigned}``: VLAN identifier.
3916 - ``inner_type {unsigned}``: inner EtherType or TPID.
3918 - ``ipv4``: match IPv4 header.
3920 - ``tos {unsigned}``: type of service.
3921 - ``ttl {unsigned}``: time to live.
3922 - ``proto {unsigned}``: next protocol ID.
3923 - ``src {ipv4 address}``: source address.
3924 - ``dst {ipv4 address}``: destination address.
3926 - ``ipv6``: match IPv6 header.
3928 - ``tc {unsigned}``: traffic class.
3929 - ``flow {unsigned}``: flow label.
3930 - ``proto {unsigned}``: protocol (next header).
3931 - ``hop {unsigned}``: hop limit.
3932 - ``src {ipv6 address}``: source address.
3933 - ``dst {ipv6 address}``: destination address.
3935 - ``icmp``: match ICMP header.
3937 - ``type {unsigned}``: ICMP packet type.
3938 - ``code {unsigned}``: ICMP packet code.
3940 - ``udp``: match UDP header.
3942 - ``src {unsigned}``: UDP source port.
3943 - ``dst {unsigned}``: UDP destination port.
3945 - ``tcp``: match TCP header.
3947 - ``src {unsigned}``: TCP source port.
3948 - ``dst {unsigned}``: TCP destination port.
3950 - ``sctp``: match SCTP header.
3952 - ``src {unsigned}``: SCTP source port.
3953 - ``dst {unsigned}``: SCTP destination port.
3954 - ``tag {unsigned}``: validation tag.
3955 - ``cksum {unsigned}``: checksum.
3957 - ``vxlan``: match VXLAN header.
3959 - ``vni {unsigned}``: VXLAN identifier.
3961 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3963 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3965 - ``nvgre``: match NVGRE header.
3967 - ``tni {unsigned}``: virtual subnet ID.
3969 - ``mpls``: match MPLS header.
3971 - ``label {unsigned}``: MPLS label.
3973 - ``gre``: match GRE header.
3975 - ``protocol {unsigned}``: protocol type.
3977 - ``gre_key``: match GRE optional key field.
3979 - ``value {unsigned}``: key value.
3981 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3983 - ``thresh {unsigned}``: accuracy threshold.
3985 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3987 - ``teid {unsigned}``: tunnel endpoint identifier.
3989 - ``geneve``: match GENEVE header.
3991 - ``vni {unsigned}``: virtual network identifier.
3992 - ``protocol {unsigned}``: protocol type.
3994 - ``vxlan-gpe``: match VXLAN-GPE header.
3996 - ``vni {unsigned}``: VXLAN-GPE identifier.
3998 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
4000 - ``sha {MAC-48}``: sender hardware address.
4001 - ``spa {ipv4 address}``: sender IPv4 address.
4002 - ``tha {MAC-48}``: target hardware address.
4003 - ``tpa {ipv4 address}``: target IPv4 address.
4005 - ``ipv6_ext``: match presence of any IPv6 extension header.
4007 - ``next_hdr {unsigned}``: next header.
4009 - ``icmp6``: match any ICMPv6 header.
4011 - ``type {unsigned}``: ICMPv6 type.
4012 - ``code {unsigned}``: ICMPv6 code.
4014 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
4016 - ``target_addr {ipv6 address}``: target address.
4018 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
4020 - ``target_addr {ipv6 address}``: target address.
4022 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
4024 - ``type {unsigned}``: ND option type.
4026 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
4027 link-layer address option.
4029 - ``sla {MAC-48}``: source Ethernet LLA.
4031 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
4032 link-layer address option.
4034 - ``tla {MAC-48}``: target Ethernet LLA.
4036 - ``meta``: match application specific metadata.
4038 - ``data {unsigned}``: metadata value.
4040 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
4042 - ``pdu_type {unsigned}``: PDU type.
4043 - ``qfi {unsigned}``: QoS flow identifier.
4045 - ``pppoes``, ``pppoed``: match PPPoE header.
4047 - ``session_id {unsigned}``: session identifier.
4049 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
4051 - ``proto_id {unsigned}``: PPP protocol identifier.
4053 - ``l2tpv3oip``: match L2TPv3 over IP header.
4055 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
4057 - ``ah``: match AH header.
4059 - ``spi {unsigned}``: security parameters index.
4061 - ``pfcp``: match PFCP header.
4063 - ``s_field {unsigned}``: S field.
4064 - ``seid {unsigned}``: session endpoint identifier.
4069 A list of actions starts after the ``actions`` token in the same fashion as
4070 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
4071 terminated by a mandatory ``end`` action.
4073 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
4074 rte_flow_action_type``).
4076 Dropping all incoming UDPv4 packets can be expressed as follows::
4078 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4081 Several actions have configurable properties which must be specified when
4082 there is no valid default value. For example, ``queue`` requires a target
4085 This rule redirects incoming UDPv4 traffic to queue index 6::
4087 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4088 actions queue index 6 / end
4090 While this one could be rejected by PMDs (unspecified queue index)::
4092 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4095 As defined by *rte_flow*, the list is not ordered, all actions of a given
4096 rule are performed simultaneously. These are equivalent::
4098 queue index 6 / void / mark id 42 / end
4102 void / mark id 42 / queue index 6 / end
4104 All actions in a list should have different types, otherwise only the last
4105 action of a given type is taken into account::
4107 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4111 drop / drop / drop / end # drop is performed only once
4115 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4117 Considering they are performed simultaneously, opposite and overlapping
4118 actions can sometimes be combined when the end result is unambiguous::
4120 drop / queue index 6 / end # drop has no effect
4124 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4128 drop / passthru / end # drop has no effect
4130 Note that PMDs may still refuse such combinations.
4135 This section lists supported actions and their attributes, if any.
4137 - ``end``: end list of actions.
4139 - ``void``: no-op action.
4141 - ``passthru``: let subsequent rule process matched packets.
4143 - ``jump``: redirect traffic to group on device.
4145 - ``group {unsigned}``: group to redirect to.
4147 - ``mark``: attach 32 bit value to packets.
4149 - ``id {unsigned}``: 32 bit value to return with packets.
4151 - ``flag``: flag packets.
4153 - ``queue``: assign packets to a given queue index.
4155 - ``index {unsigned}``: queue index to use.
4157 - ``drop``: drop packets (note: passthru has priority).
4159 - ``count``: enable counters for this rule.
4161 - ``rss``: spread packets among several queues.
4163 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4164 the same as `set_hash_global_config`_.
4166 - ``level {unsigned}``: encapsulation level for ``types``.
4168 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4169 tokens are the same as `set_hash_input_set`_, except that an empty list
4170 does not disable RSS but instead requests unspecified "best-effort"
4173 - ``key {string}``: RSS hash key, overrides ``key_len``.
4175 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4176 conjunction with ``key`` to pad or truncate it.
4178 - ``queues [{unsigned} [...]] end``: queue indices to use.
4180 - ``pf``: direct traffic to physical function.
4182 - ``vf``: direct traffic to a virtual function ID.
4184 - ``original {boolean}``: use original VF ID if possible.
4185 - ``id {unsigned}``: VF ID.
4187 - ``phy_port``: direct packets to physical port index.
4189 - ``original {boolean}``: use original port index if possible.
4190 - ``index {unsigned}``: physical port index.
4192 - ``port_id``: direct matching traffic to a given DPDK port ID.
4194 - ``original {boolean}``: use original DPDK port ID if possible.
4195 - ``id {unsigned}``: DPDK port ID.
4197 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4199 - ``mpls_ttl``: MPLS TTL.
4201 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4203 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4205 - ``nw_ttl``: IP TTL.
4207 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4209 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4211 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4213 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4215 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4217 - ``ethertype``: Ethertype.
4219 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4221 - ``vlan_vid``: VLAN id.
4223 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4225 - ``vlan_pcp``: VLAN priority.
4227 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4229 - ``ethertype``: Ethertype.
4231 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4233 - ``ethertype``: Ethertype.
4235 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4236 is done through `Config VXLAN Encap outer layers`_.
4238 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4239 the VXLAN tunnel network overlay from the matched flow.
4241 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4242 is done through `Config NVGRE Encap outer layers`_.
4244 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4245 the NVGRE tunnel network overlay from the matched flow.
4247 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4248 is done through `Config L2 Encap`_.
4250 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4251 is done through `Config L2 Decap`_.
4253 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4254 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4256 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4257 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4259 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4260 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4262 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4263 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4265 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4267 - ``ipv4_addr``: New IPv4 source address.
4269 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4272 - ``ipv4_addr``: New IPv4 destination address.
4274 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4276 - ``ipv6_addr``: New IPv6 source address.
4278 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4281 - ``ipv6_addr``: New IPv6 destination address.
4283 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4286 - ``port``: New TCP/UDP source port number.
4288 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4291 - ``port``: New TCP/UDP destination port number.
4293 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4296 - ``dec_ttl``: Performs a decrease TTL value action
4298 - ``set_ttl``: Set TTL value with specified value
4299 - ``ttl_value {unsigned}``: The new TTL value to be set
4301 - ``set_mac_src``: set source MAC address
4303 - ``mac_addr {MAC-48}``: new source MAC address
4305 - ``set_mac_dst``: set destination MAC address
4307 - ``mac_addr {MAC-48}``: new destination MAC address
4309 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4311 - ``value {unsigned}``: Value to increase TCP sequence number by.
4313 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4315 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4317 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4319 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4321 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4323 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4325 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4327 - ``dscp_value {unsigned}``: The new DSCP value to be set
4329 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4331 - ``dscp_value {unsigned}``: The new DSCP value to be set
4333 Destroying flow rules
4334 ~~~~~~~~~~~~~~~~~~~~~
4336 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4337 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4338 times as necessary::
4340 flow destroy {port_id} rule {rule_id} [...]
4342 If successful, it will show::
4344 Flow rule #[...] destroyed
4346 It does not report anything for rule IDs that do not exist. The usual error
4347 message is shown when a rule cannot be destroyed::
4349 Caught error type [...] ([...]): [...]
4351 ``flow flush`` destroys all rules on a device and does not take extra
4352 arguments. It is bound to ``rte_flow_flush()``::
4354 flow flush {port_id}
4356 Any errors are reported as above.
4358 Creating several rules and destroying them::
4360 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4361 actions queue index 2 / end
4362 Flow rule #0 created
4363 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4364 actions queue index 3 / end
4365 Flow rule #1 created
4366 testpmd> flow destroy 0 rule 0 rule 1
4367 Flow rule #1 destroyed
4368 Flow rule #0 destroyed
4371 The same result can be achieved using ``flow flush``::
4373 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4374 actions queue index 2 / end
4375 Flow rule #0 created
4376 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4377 actions queue index 3 / end
4378 Flow rule #1 created
4379 testpmd> flow flush 0
4382 Non-existent rule IDs are ignored::
4384 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4385 actions queue index 2 / end
4386 Flow rule #0 created
4387 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4388 actions queue index 3 / end
4389 Flow rule #1 created
4390 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4392 testpmd> flow destroy 0 rule 0
4393 Flow rule #0 destroyed
4399 ``flow query`` queries a specific action of a flow rule having that
4400 ability. Such actions collect information that can be reported using this
4401 command. It is bound to ``rte_flow_query()``::
4403 flow query {port_id} {rule_id} {action}
4405 If successful, it will display either the retrieved data for known actions
4406 or the following message::
4408 Cannot display result for action type [...] ([...])
4410 Otherwise, it will complain either that the rule does not exist or that some
4413 Flow rule #[...] not found
4417 Caught error type [...] ([...]): [...]
4419 Currently only the ``count`` action is supported. This action reports the
4420 number of packets that hit the flow rule and the total number of bytes. Its
4421 output has the following format::
4424 hits_set: [...] # whether "hits" contains a valid value
4425 bytes_set: [...] # whether "bytes" contains a valid value
4426 hits: [...] # number of packets
4427 bytes: [...] # number of bytes
4429 Querying counters for TCPv6 packets redirected to queue 6::
4431 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4432 actions queue index 6 / count / end
4433 Flow rule #4 created
4434 testpmd> flow query 0 4 count
4445 ``flow list`` lists existing flow rules sorted by priority and optionally
4446 filtered by group identifiers::
4448 flow list {port_id} [group {group_id}] [...]
4450 This command only fails with the following message if the device does not
4455 Output consists of a header line followed by a short description of each
4456 flow rule, one per line. There is no output at all when no flow rules are
4457 configured on the device::
4459 ID Group Prio Attr Rule
4460 [...] [...] [...] [...] [...]
4462 ``Attr`` column flags:
4464 - ``i`` for ``ingress``.
4465 - ``e`` for ``egress``.
4467 Creating several flow rules and listing them::
4469 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4470 actions queue index 6 / end
4471 Flow rule #0 created
4472 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4473 actions queue index 2 / end
4474 Flow rule #1 created
4475 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4476 actions rss queues 6 7 8 end / end
4477 Flow rule #2 created
4478 testpmd> flow list 0
4479 ID Group Prio Attr Rule
4480 0 0 0 i- ETH IPV4 => QUEUE
4481 1 0 0 i- ETH IPV6 => QUEUE
4482 2 0 5 i- ETH IPV4 UDP => RSS
4485 Rules are sorted by priority (i.e. group ID first, then priority level)::
4487 testpmd> flow list 1
4488 ID Group Prio Attr Rule
4489 0 0 0 i- ETH => COUNT
4490 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4491 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4492 1 24 0 i- ETH IPV4 UDP => QUEUE
4493 4 24 10 i- ETH IPV4 TCP => DROP
4494 3 24 20 i- ETH IPV4 => DROP
4495 2 24 42 i- ETH IPV4 UDP => QUEUE
4496 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4499 Output can be limited to specific groups::
4501 testpmd> flow list 1 group 0 group 63
4502 ID Group Prio Attr Rule
4503 0 0 0 i- ETH => COUNT
4504 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4505 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4506 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4509 Toggling isolated mode
4510 ~~~~~~~~~~~~~~~~~~~~~~
4512 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4513 must only be injected from the defined flow rules; that no default traffic
4514 is expected outside those rules and the driver is free to assign more
4515 resources to handle them. It is bound to ``rte_flow_isolate()``::
4517 flow isolate {port_id} {boolean}
4519 If successful, enabling or disabling isolated mode shows either::
4521 Ingress traffic on port [...]
4522 is now restricted to the defined flow rules
4526 Ingress traffic on port [...]
4527 is not restricted anymore to the defined flow rules
4529 Otherwise, in case of error::
4531 Caught error type [...] ([...]): [...]
4533 Mainly due to its side effects, PMDs supporting this mode may not have the
4534 ability to toggle it more than once without reinitializing affected ports
4535 first (e.g. by exiting testpmd).
4537 Enabling isolated mode::
4539 testpmd> flow isolate 0 true
4540 Ingress traffic on port 0 is now restricted to the defined flow rules
4543 Disabling isolated mode::
4545 testpmd> flow isolate 0 false
4546 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4549 Dumping HW internal information
4550 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4552 ``flow dump`` dumps the hardware's internal representation information of
4553 all flows. It is bound to ``rte_flow_dev_dump()``::
4555 flow dump {port_id} {output_file}
4557 If successful, it will show::
4561 Otherwise, it will complain error occurred::
4563 Caught error type [...] ([...]): [...]
4565 Listing and destroying aged flow rules
4566 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4568 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4569 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4571 flow aged {port_id} [destroy]
4573 Listing current aged flow rules::
4575 testpmd> flow aged 0
4576 Port 0 total aged flows: 0
4577 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4578 actions age timeout 5 / queue index 0 / end
4579 Flow rule #0 created
4580 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4581 actions age timeout 4 / queue index 0 / end
4582 Flow rule #1 created
4583 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4584 actions age timeout 2 / queue index 0 / end
4585 Flow rule #2 created
4586 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4587 actions age timeout 3 / queue index 0 / end
4588 Flow rule #3 created
4591 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4592 information, all the aged flows are sorted by the longest timeout time. For example, if
4593 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4594 will be ID 3, ID 1, ID 0::
4596 testpmd> flow aged 0
4597 Port 0 total aged flows: 4
4604 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4606 testpmd> flow aged 0 destroy
4607 Port 0 total aged flows: 4
4614 Flow rule #2 destroyed
4615 Flow rule #3 destroyed
4616 Flow rule #1 destroyed
4617 Flow rule #0 destroyed
4618 4 flows be destroyed
4619 testpmd> flow aged 0
4620 Port 0 total aged flows: 0
4623 Sample QinQ flow rules
4624 ~~~~~~~~~~~~~~~~~~~~~~
4626 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4628 testpmd> port stop 0
4629 testpmd> vlan set qinq_strip on 0
4631 The above command sets the inner and outer TPID's to 0x8100.
4633 To change the TPID's the following commands should be used::
4635 testpmd> vlan set outer tpid 0xa100 0
4636 testpmd> vlan set inner tpid 0x9100 0
4637 testpmd> port start 0
4639 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4643 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4644 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4645 Flow rule #0 validated
4647 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4648 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4649 Flow rule #0 created
4651 testpmd> flow list 0
4652 ID Group Prio Attr Rule
4653 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4655 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4659 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4660 vlan tci is 654 / end actions pf / queue index 0 / end
4661 Flow rule #1 validated
4663 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4664 vlan tci is 654 / end actions pf / queue index 1 / end
4665 Flow rule #1 created
4667 testpmd> flow list 0
4668 ID Group Prio Attr Rule
4669 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4670 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4672 Sample VXLAN encapsulation rule
4673 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4675 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4676 source code, those can be changed by using the following commands
4678 IPv4 VXLAN outer header::
4680 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4681 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4682 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4685 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4686 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4687 eth-dst 22:22:22:22:22:22
4688 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4691 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4692 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4693 eth-dst 22:22:22:22:22:22
4694 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4697 IPv6 VXLAN outer header::
4699 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4700 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4701 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4704 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4705 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4706 eth-dst 22:22:22:22:22:22
4707 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4710 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4711 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4712 eth-dst 22:22:22:22:22:22
4713 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4716 Sample NVGRE encapsulation rule
4717 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4719 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4720 source code, those can be changed by using the following commands
4722 IPv4 NVGRE outer header::
4724 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4725 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4726 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4729 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4730 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4731 eth-dst 22:22:22:22:22:22
4732 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4735 IPv6 NVGRE outer header::
4737 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4738 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4739 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4742 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4743 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4744 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4747 Sample L2 encapsulation rule
4748 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4750 L2 encapsulation has default value pre-configured in testpmd
4751 source code, those can be changed by using the following commands
4755 testpmd> set l2_encap ip-version ipv4
4756 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4757 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4758 mplsoudp_decap / l2_encap / end
4760 L2 with VXLAN header::
4762 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4763 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4764 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4765 mplsoudp_decap / l2_encap / end
4767 Sample L2 decapsulation rule
4768 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4770 L2 decapsulation has default value pre-configured in testpmd
4771 source code, those can be changed by using the following commands
4775 testpmd> set l2_decap
4776 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4779 L2 with VXLAN header::
4781 testpmd> set l2_encap-with-vlan
4782 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4785 Sample MPLSoGRE encapsulation rule
4786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4788 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4789 source code, those can be changed by using the following commands
4791 IPv4 MPLSoGRE outer header::
4793 testpmd> set mplsogre_encap ip-version ipv4 label 4
4794 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4795 eth-dst 22:22:22:22:22:22
4796 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4797 mplsogre_encap / end
4799 IPv4 MPLSoGRE with VLAN outer header::
4801 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4802 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4803 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4804 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4805 mplsogre_encap / end
4807 IPv6 MPLSoGRE outer header::
4809 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4810 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4811 eth-dst 22:22:22:22:22:22
4812 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4813 mplsogre_encap / end
4815 IPv6 MPLSoGRE with VLAN outer header::
4817 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4818 ip-src ::1 ip-dst ::2222 vlan-tci 34
4819 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4820 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4821 mplsogre_encap / end
4823 Sample MPLSoGRE decapsulation rule
4824 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4826 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4827 source code, those can be changed by using the following commands
4829 IPv4 MPLSoGRE outer header::
4831 testpmd> set mplsogre_decap ip-version ipv4
4832 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4833 mplsogre_decap / l2_encap / end
4835 IPv4 MPLSoGRE with VLAN outer header::
4837 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4838 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4839 actions mplsogre_decap / l2_encap / end
4841 IPv6 MPLSoGRE outer header::
4843 testpmd> set mplsogre_decap ip-version ipv6
4844 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4845 actions mplsogre_decap / l2_encap / end
4847 IPv6 MPLSoGRE with VLAN outer header::
4849 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4850 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4851 actions mplsogre_decap / l2_encap / end
4853 Sample MPLSoUDP encapsulation rule
4854 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4856 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4857 source code, those can be changed by using the following commands
4859 IPv4 MPLSoUDP outer header::
4861 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4862 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4863 eth-dst 22:22:22:22:22:22
4864 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4865 mplsoudp_encap / end
4867 IPv4 MPLSoUDP with VLAN outer header::
4869 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4870 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4871 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4872 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4873 mplsoudp_encap / end
4875 IPv6 MPLSoUDP outer header::
4877 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4878 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4879 eth-dst 22:22:22:22:22:22
4880 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4881 mplsoudp_encap / end
4883 IPv6 MPLSoUDP with VLAN outer header::
4885 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4886 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4887 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4888 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4889 mplsoudp_encap / end
4891 Sample MPLSoUDP decapsulation rule
4892 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4894 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4895 source code, those can be changed by using the following commands
4897 IPv4 MPLSoUDP outer header::
4899 testpmd> set mplsoudp_decap ip-version ipv4
4900 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4901 mplsoudp_decap / l2_encap / end
4903 IPv4 MPLSoUDP with VLAN outer header::
4905 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4906 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4907 actions mplsoudp_decap / l2_encap / end
4909 IPv6 MPLSoUDP outer header::
4911 testpmd> set mplsoudp_decap ip-version ipv6
4912 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4913 actions mplsoudp_decap / l2_encap / end
4915 IPv6 MPLSoUDP with VLAN outer header::
4917 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4918 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4919 actions mplsoudp_decap / l2_encap / end
4921 Sample Raw encapsulation rule
4922 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4924 Raw encapsulation configuration can be set by the following commands
4926 Eecapsulating VxLAN::
4928 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4929 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4931 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4932 raw_encap index 4 / end
4934 Sample Raw decapsulation rule
4935 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4937 Raw decapsulation configuration can be set by the following commands
4939 Decapsulating VxLAN::
4941 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4942 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4943 end actions raw_decap / queue index 0 / end
4948 ESP rules can be created by the following commands::
4950 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4952 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4953 actions queue index 3 / end
4954 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4956 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4957 actions queue index 3 / end
4962 AH rules can be created by the following commands::
4964 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
4966 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
4967 actions queue index 3 / end
4968 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
4970 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
4971 actions queue index 3 / end
4976 PFCP rules can be created by the following commands(s_field need to be 1
4979 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
4980 actions queue index 3 / end
4981 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
4982 seid is 1 / end actions queue index 3 / end
4983 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
4984 actions queue index 3 / end
4985 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
4986 seid is 1 / end actions queue index 3 / end
4991 The following sections show functions to load/unload eBPF based filters.
4996 Load an eBPF program as a callback for particular RX/TX queue::
4998 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
5000 The available load-flags are:
5002 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
5004 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
5010 You'll need clang v3.7 or above to build bpf program you'd like to load
5014 .. code-block:: console
5017 clang -O2 -target bpf -c t1.c
5019 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5021 .. code-block:: console
5023 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5025 To load (not JITed) t1.o at TX queue 0, port 0:
5027 .. code-block:: console
5029 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5034 Unload previously loaded eBPF program for particular RX/TX queue::
5036 testpmd> bpf-unload rx|tx (portid) (queueid)
5038 For example to unload BPF filter from TX queue 0, port 0:
5040 .. code-block:: console
5042 testpmd> bpf-unload tx 0 0